PayloadKit

Active Directory

com.apple.DirectoryService.managed

The payload that configures an Active Directory (AD) domain.

macOS 10.8+
Apple schemaexclusive

macOS: device channel only

Configuration Keys (39)

Showing 39 of 39 keys

KeyTypeDescriptionDefaultRange
HostNamestring

HostName

required
stringThe Active Directory domain to join.Default: —Range: —
UserNamestring

UserName

stringThe user name of the account for the domain.Default: —Range: —
Passwordstring

Password

stringThe password of the account for the domain.Default: —Range: —
ClientIDstring

Client ID

stringThe client's identifier.Default: —Range: —

ADOrganizationalUnit

stringThe organizational unit to add the joining computer object to.Default: —Range: —

Enable ADCreateMobileAccountAtLogin Flag

macOS 10.9+

booleanIf 'true', the system enables the 'ADCreateMobileAccountAtLogin' key.Default: falseRange: —

Create mobile account at login

booleanIf 'true', the system creates a mobile account at login.

Depends on: ADCreateMobileAccountAtLoginFlag ∈ [true]

Default: falseRange: —

Enable ADWarnUserBeforeCreatingMA Flag

macOS 10.9+

booleanIf 'true', the system enables the 'ADWarnUserBeforeCreatingMA' key.Default: falseRange: —

Require confirmation before creating mobile account

booleanIf 'true', the system enables the warning before creating the mobile account.

Depends on: ADWarnUserBeforeCreatingMAFlag ∈ [true]

Default: falseRange: —

Enable ADForceHomeLocal Flag

macOS 10.9+

booleanIf 'true', the system enables the 'ADForceHomeLocal' key.Default: falseRange: —

Force local home directory on startup disk

booleanIf 'true', the system forces a local home directory.

Depends on: ADForceHomeLocalFlag ∈ [true]

Default: falseRange: —

Enable ADUseWindowsUNCPath Flag

macOS 10.9+

booleanIf 'true', the system enables the 'ADUseWindowsUNCPath' key.Default: falseRange: —

Use UNC path for network home location

booleanIf 'true', the system uses the UNC path from Active Directory to derive the network home location.

Depends on: ADUseWindowsUNCPathFlag ∈ [true]

Default: falseRange: —

Mount Style

stringThe network home protocol to use: 'afp' or 'smb'.Default: "smb"Range: AFP (afp), SMB (smb)

Enable ADDefaultUserShell Key

booleanIf 'true', the system enables the 'ADDefaultUserShell' key.Default: falseRange: —

Default user shell

stringThe default user shell.

Depends on: ADDefaultUserShellFlag ∈ [true]

Default: "/bin/bash"Range: —

Enable ADMapUIDAttribute Key

booleanIf 'true', the system enables the 'ADMapUIDAttribute' key.Default: falseRange: —

Map UID to attribute

stringThe map UID to attribute.

Depends on: ADMapUIDAttributeFlag ∈ [true]

Default: —Range: —

Enable ADMapGIDAttribute Key

booleanIf 'true', the system enables the 'ADMapGIDAttribute' key.Default: falseRange: —

Map user GID to attribute

stringThe map GID to attribute.

Depends on: ADMapGIDAttributeFlag ∈ [true]

Default: —Range: —

Enable ADMapGGIDAttribute Key

booleanIf 'true', the system enables the 'ADMapGGIDAttributeFlag' key.Default: falseRange: —

Map group GID to attribute

stringThe map group GID to attribute.

Depends on: ADMapGGIDAttributeFlag ∈ [true]

Default: —Range: —

Enable ADPreferredDCServer Key

booleanIf 'true', the system enables the 'ADPreferredDCServer' key.Default: falseRange: —

Preferred domain server

stringThe preferred domain server.

Depends on: ADPreferredDCServerFlag ∈ [true]

Default: —Range: —

Enable ADDomainAdminGroupList Key

booleanIf 'true', the system enables the 'ADDomainAdminGroupList' key.Default: falseRange: —

Allow administration by specified Active Directory groups.

arrayThe list of Active Directory groups with admin access.

Depends on: ADDomainAdminGroupListFlag ∈ [true]

Default: —Range: —

Domain Admin Group Item

required
stringAn active directory groupDefault: —Range: —

Enable ADAllowMultiDomainAuth Key

macOS 10.9+

booleanIf 'true', the system enables the 'ADAllowMultiDomainAuth' key.Default: falseRange: —

Allow authentication from any domain in the forest

booleanIf 'true', the system allows authentication from any domain in the namespace.

Depends on: ADAllowMultiDomainAuthFlag ∈ [true]

Default: falseRange: —

Enable ADNamespace Key

booleanIf 'true', the system enables the 'ADNamespace' key.Default: falseRange: —

Set primary user account naming convention: "forest" or "domain"

stringThe primary user account naming convention; either 'forest' or 'domain'.

Depends on: ADNamespaceFlag ∈ [true]

Default: "domain"Range: domain, forest

Enable ADPacketSign Key

macOS 10.8+

booleanIf 'true', the system enables the 'ADPacketSign' key.Default: falseRange: —

Packet signing

stringThe packet signing policy.

Depends on: ADPacketSignFlag ∈ [true]

Default: "allow"Range: allow, disable, require

Enable ADPacketEncrypt Key

booleanIf 'true', the system enables the 'ADPacketEncrypt' key.Default: falseRange: —

Packet encryption

stringThe packet encryption policy.

Depends on: ADPacketEncryptFlag ∈ [true]

Default: "allow"Range: allow, disable, require, ssl

Enable ADRestrictDDNS Key

booleanIf 'true', the system enables the 'ADRestrictDDNS' key.Default: falseRange: —

Restrict DDNS on interfaces

macOS 10.8+

arrayAn array of strings that represent the interfaces allowed for dynamic DNS updates, such as en0 and en1.

Depends on: ADRestrictDDNSFlag ∈ [true]

Default: —Range: —

Allowed DDNS Interface Item

required
stringAn interface name which is allowed to make DDNS updatesDefault: —Range: —

Enable ADTrustChangePassIntervalDays Key

booleanIf 'true', the system enables the 'ADTrustChangePassIntervalDays' key.Default: falseRange: —

Password trust interval

integerThe number of days before requiring a change of the computer trust account password. Set to '0' to disable the feature.

Depends on: ADTrustChangePassIntervalDaysFlag ∈ [true]

Default: 14Range: —

Description

stringThe directory service description.Default: —Range: —