DirectoryServiceAttributes.7 [plain text]
.\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
.\"See Also:
.\"man mdoc.samples for a complete listing of options
.\"man mdoc for the short list of editing options
.\"/usr/share/misc/mdoc.template
.Dd Feb 21, 2003 \" DATE
.Dt DirectoryServiceAttributes 7 \" Program name and manual section number
.Os MacOSX
.Sh NAME \" Section Header - required - don't modify
.Nm DirectoryServiceAttributes
.\" The following lines are read in generating the apropos(man -k) database. Use only key
.\" words here as the database is built based on the words here and in the .ND line.
.\" Use .Nm macro to designate other names for the documented program.
The following standard attribute types are defined in <DirectoryServices/DirServicesConst.h>
.\" .Sh SYNOPSIS \" Section Header - required - don't modify
.Sh DESCRIPTION \" Section Header - required - don't modify
.Pp
This document contains well known attribute and record type constants.
.Pp
They can be used with dsDataNodeAllocateString() to create a data node to pass to a Directory Services API call.
.Pp
Legend:
.Pp
eDS1xxxxxx Single Valued Attribute
.Pp
eDSNxxxxxx Multi-Valued Attribute
.Pp
NOTE: Access controls may prevent any particular client from reading/writting various attributes. In addition some attributes may not be stored at all and could represent "real-time" data generated by the directory node plug-in.
.Pp
NOTE #2: Attributes in the model are available for records & directory nodes.
.Pp
.Nm Type String
.Pp
.Nm All Records
.Pp
kDSRecordsAll "dsRecordsAll"
.Pp
kDSRecordsStandardAll "dsRecordsStandardAll"
.Pp
kDSRecordsNativeAll "dsRecordsNativeAll"
.Pp
.Nm All Attributes
.Pp
kDSAttributesAll "dsAttributesAll"
.Pp
kDSAttributesStandardAll "dsAttributesStandardAll"
.Pp
kDSAttributesNativeAll "dsAttributesNativeAll"
.Pp
.Nm Well Known Record Types
.Pp
kDSStdRecordTypePrefix "dsRecTypeStandard:"
.Pp
kDSNativeRecordTypePrefix "dsRecTypeNative:"
.Pp
.Pp
kDSStdRecordTypeUsers "dsRecTypeStandard:Users"
.Pp
kDSStdRecordTypeUserAliases "dsRecTypeStandard:UserAliases"
.Pp
kDSStdRecordTypeGroups "dsRecTypeStandard:Groups"
.Pp
kDSStdRecordTypeGroupAliases "dsRecTypeStandard:GroupAliases"
.Pp
kDSStdRecordTypeMachines "dsRecTypeStandard:Machines"
.Pp
kDSStdRecordTypeAliases "dsRecTypeStandard:Aliases"
.Pp
kDSStdRecordTypeHosts "dsRecTypeStandard:Hosts"
.Pp
kDSStdRecordTypePrinters "dsRecTypeStandard:Printers"
.Pp
kDSStdRecordTypeNetworks "dsRecTypeStandard:Networks"
.Pp
kDSStdRecordTypeServices "dsRecTypeStandard:Services"
.Pp
kDSStdRecordTypeServer "dsRecTypeStandard:Server"
.Pp
kDSStdRecordTypProtocols "dsRecTypeStandard:Protocols"
.Pp
kDSStdRecordTypeProtocols "dsRecTypeStandard:Protocols"
.Pp
kDSStdRecordTypRPC "dsRecTypeStandard:RPC"
.Pp
kDSStdRecordTypeRPC "dsRecTypeStandard:RPC"
.Pp
kDSStdRecordTypePrintService "dsRecTypeStandard:PrintService"
.Pp
kDSStdRecordTypeConfig "dsRecTypeStandard:Config"
.Pp
kDSStdRecordTypeAFPServer "dsRecTypeStandard:AFPServer"
.Pp
kDSStdRecordTypeSMBServer "dsRecTypeStandard:SMBServer"
.Pp
kDSStdRecordTypeFTPServer "dsRecTypeStandard:FTPServer"
.Pp
kDSStdRecordTypeNFS "dsRecTypeStandard:NFS"
.Pp
kDSStdRecordTypeWebServer "dsRecTypeStandard:WebServer"
.Pp
kDSStdRecordTypeLDAPServer "dsRecTypeStandard:LDAPServer"
.Pp
kDSStdRecordTypeQTSServer "dsRecTypeStandard:QTSServer"
.Pp
kDSStdRecordTypMounts "dsRecTypeStandard:Mounts"
.Pp
kDSStdRecordTypeMounts "dsRecTypeStandard:Mounts"
.Pp
.Pp
kDSStdRecordTypeComputers "dsRecTypeStandard:Computers"
.Pp
kDSStdRecordTypeComputerLists "dsRecTypeStandard:ComputerLists"
.Pp
.Pp
kDSStdRecordTypePresetUsers "dsRecTypeStandard:PresetUsers"
.Pp
kDSStdRecordTypePresetGroups "dsRecTypeStandard:PresetGroups"
.Pp
kDSStdRecordTypePresetComputerLists "dsRecTypeStandard:PresetComputerLists"
.Pp
.Nm kDSStdRecordTypeAutoServerSetup Discussion:
.Pp
Used to discover automated server setup information.
.Pp
kDSStdRecordTypeAutoServerSetup "dsRecTypeStandard:AutoServerSetup"
.Pp
.Nm kDSStdRecordTypePasswordServer Discussion:
.Pp
Used to discover password servers via Rendezvous.
.Pp
kDSStdRecordTypePasswordServer "dsRecTypeStandard:PasswordServer"
.Pp
.Nm kDSStdRecordTypePeople Discussion:
.Pp
Record type that contains "People" records used for contact information.
.Pp
kDSStdRecordTypePeople "dsRecTypeStandard:People"
.Pp
.Nm kDSStdRecordTypeSharePoints Discussion:
.Pp
Share point record type.
.Pp
kDSStdRecordTypeSharePoints "dsRecTypeStandard:SharePoints"
.Pp
.Nm kDSStdRecordTypePrintServiceUser Discussion:
.Pp
Record in the local node for storing quota usage for a user.
.Pp
kDSStdRecordTypePrintServiceUser "dsRecTypeStandard:PrintServiceUser"
.Pp
.Pp
kDSStdRecordTypeAFPUserAliases "dsRecTypeStandard:AFPUserAliases"
.Pp
.Nm kDSStdRecordTypeBootp Discussion:
.Pp
Record in the local node for storing bootp info.
.Pp
kDSStdRecordTypeBootp "dsRecTypeStandard:Bootp"
.Pp
.Nm kDSStdRecordTypeNetDomains Discussion:
.Pp
Record in the local node for storing net domains.
.Pp
kDSStdRecordTypeNetDomains "dsRecTypeStandard:NetDomains"
.Pp
.Nm kDSStdRecordTypeEthernets Discussion:
.Pp
Record in the local node for storing ethernets.
.Pp
kDSStdRecordTypeEthernets "dsRecTypeStandard:Ethernets"
.Pp
.Nm kDSStdRecordTypeNetGroups Discussion:
.Pp
Record in the local node for storing net groups.
.Pp
kDSStdRecordTypeNetGroups "dsRecTypeStandard:NetGroups"
.Pp
.Nm kDSStdRecordTypeHostServices Discussion:
.Pp
Record in the local node for storing host services.
.Pp
kDSStdRecordTypeHostServices "dsRecTypeStandard:HostServices"
.Pp
.Pp
kDSStdUserNamesMeta "dsRecTypeStandard:MetaUserNames"
.Pp
kDSStdRecordTypeMeta "dsRecTypeStandard:AppleMetaRecord"
.Pp
Location record type.
.Pp
kDSStdRecordTypeLocations "dsRecTypeStandard:Locations"
.Pp
.Nm Well Known Attribute Types...
.Pp
kDSStdAttrTypePrefix "dsAttrTypeStandard:"
.Pp
kDSNativeAttrTypePrefix "dsAttrTypeNative:"
.Pp
.Pp
kDSAttrNone "dsNone"
.Pp
.Nm Authentication Methods
.Pp
kDSStdAuthMethodPrefix "dsAuthMethodStandard:"
.Pp
kDSNativeAuthMethodPrefix "dsAuthMethodNative:"
.Pp
.Pp
kDSStdAuthClearText "dsAuthMethodStandard:dsAuthClearText"
.Pp
.Nm kDSStdAuthCrypt Discussion:
.Pp
Use a crypt password stored in the user record if available to do the authentication. The buffer is packed as follows:
.Pp
4 byte length of username,
.Pp
username in UTF8 encoding,
.Pp
4 byte length of password,
.Pp
password in UTF8 encoding
.Pp
This method may not be supported by all plug-ins or for all users.
.Pp
kDSStdAuthCrypt "dsAuthMethodStandard:dsAuthCrypt"
.Pp
.Pp
kDSStdAuthSetPasswd "dsAuthMethodStandard:dsAuthSetPasswd"
.Pp
.Nm kDSStdAuthChangePasswd Discussion:
.Pp
Change the password for a user. Does not require prior authentication.
.Pp
The buffer is packed as follows:
.Pp
4 byte length of username,
.Pp
username in UTF8 encoding,
.Pp
4 byte length of old password,
.Pp
old password in UTF8 encoding,
.Pp
4 byte length of new password,
.Pp
new password in UTF8 encoding
.Pp
kDSStdAuthChangePasswd "dsAuthMethodStandard:dsAuthChangePasswd"
.Pp
.Pp
kDSStdAuthSetPasswdAsRoot "dsAuthMethodStandard:dsAuthSetPasswdAsRoot"
.Pp
.Nm kDSStdAuth2WayRandomChangePasswd Discussion:
.Pp
Change the password for a user using the two-way random method.
.Pp
Does not require prior authentication.
.Pp
The buffer is packed as follows:
.Pp
4 byte length of username,
.Pp
username in UTF8 encoding,
.Pp
4 byte length of old password encrypted with new (should be 8),
.Pp
old password encrypted with new,
.Pp
4 byte length of new password encrypted with old (should be 8),
.Pp
new password encrypted with old
.Pp
kDSStdAuth2WayRandomChangePasswd "dsAuthMethodStandard:dsAuth2WayRandomChangePasswd"
.Pp
.Pp
kDSStdAuthAPOP "dsAuthMethodStandard:dsAuthAPOP"
.Pp
kDSStdAuth2WayRandom "dsAuthMethodStandard:dsAuth2WayRandom"
.Pp
.Nm kDSStdAuthNodeNativeClearTextOK Discussion:
.Pp
The plug-in should determine which specific authentication method to use.
.Pp
The buffer is packed as follows:
.Pp
4 byte length of username,
.Pp
username in UTF8 encoding,
.Pp
4 byte length of password,
.Pp
password in UTF8 encoding
.Pp
The plug-in may choose to use a cleartext authentication method if necessary.
.Pp
kDSStdAuthNodeNativeClearTextOK "dsAuthMethodStandard:dsAuthNodeNativeCanUseClearText"
.Pp
.Nm kDSStdAuthNodeNativeNoClearText Discussion:
.Pp
The plug-in should determine which specific authentication method to use.
.Pp
The buffer is packed as follows:
.Pp
4 byte length of username,
.Pp
username in UTF8 encoding,
.Pp
4 byte length of password,
.Pp
password in UTF8 encoding
.Pp
The plug-in must not use an authentication method that sends the password in cleartext.
.Pp
kDSStdAuthNodeNativeNoClearText "dsAuthMethodStandard:dsAuthNodeNativeCannotUseClearText"
.Pp
.Pp
kDSStdAuthSMB_NT_Key "dsAuthMethodStandard:dsAuthSMBNTKey"
.Pp
kDSStdAuthSMB_LM_Key "dsAuthMethodStandard:dsAuthSMBLMKey"
.Pp
kDSStdAuthCRAM_MD5 "dsAuthMethodStandard:dsAuthNodeCRAM-MD5"
.Pp
kDSStdAuthDIGEST_MD5 "dsAuthMethodStandard:dsAuthNodeDIGEST-MD5"
.Pp
.Nm PDC_SMB_Constants Discussion:
.Pp
Related constants for supporting PDC SMB interaction with DS.
.Pp
.Pp
kDSStdAuthSMB_NT_UserSessionKey "dsAuthMethodStandard:dsAuthSMBNTUserSessionKey"
.Pp
kDSStdAuthSMBWorkstationCredentialSessionKey "dsAuthMethodStandard:dsAuthSMBWorkstationCredentialSessionKey"
.Pp
kDSStdAuthSetWorkstationPasswd "dsAuthMethodStandard:dsAuthSetWorkstationPasswd"
.Pp
kDS1AttrSMBRID "dsAttrTypeStandard:smb_rid"
.Pp
kDS1AttrSMBGroupRID "dsAttrTypeStandard:smb_group_rid"
.Pp
.Nm kDS1AttrSMBHomeDrive Discussion:
.Pp
Drive letter for homedirectory mount point.
.Pp
kDS1AttrSMBHomeDrive "dsAttrTypeStandard:smb_home_drive"
.Pp
.Nm kDS1AttrSMBHome Discussion:
.Pp
UNC address of Windows homedirectory mount point (\\server\\sharepoint).
.Pp
kDS1AttrSMBHome "dsAttrTypeStandard:smb_home"
.Pp
.Nm kDS1AttrSMBScriptPath Discussion:
.Pp
Login script path.
.Pp
kDS1AttrSMBScriptPath "dsAttrTypeStandard:smb_script_path"
.Pp
.Nm kDS1AttrSMBProfilePath Discussion:
.Pp
Desktop management info (dock, desktop links, etc).
.Pp
kDS1AttrSMBProfilePath "dsAttrTypeStandard:smb_profile_path"
.Pp
.Nm kDS1AttrSMBUserWorkstations Discussion:
.Pp
List of workstations user can login from (machine account names).
.Pp
kDS1AttrSMBUserWorkstations "dsAttrTypeStandard:smb_user_workstations"
.Pp
.Nm Account_Control_Flags Discussion:
.Pp
Set of account control flags.
.Pp
kDS1AttrSMBAcctFlags "dsAttrTypeStandard:smb_acctFlags"
.Pp
kDS1AttrSMBPWDLastSet "dsAttrTypeStandard:smb_pwd_last_set"
.Pp
kDS1AttrSMBLogonTime "dsAttrTypeStandard:smb_logon_time"
.Pp
kDS1AttrSMBLogoffTime "dsAttrTypeStandard:smb_logoff_time"
.Pp
kDS1AttrSMBKickoffTime "dsAttrTypeStandard:smb_kickoff_time"
.Pp
.Nm kDS1AttrPasswordServerList Discussion:
.Pp
Represents the attribute for storing the password server's replication information.
.Pp
kDS1AttrPasswordServerList "dsAttrTypeStandard:PasswordServerList"
.Pp
.Nm kDS1AttrAlternateDatastoreLocation Discussion:
.Pp
Unix path used for determining where a user's email is stored.
.Pp
kDS1AttrAlternateDatastoreLocation "dsAttrTypeStandard:AlternateDatastoreLocation"
.Pp
.Nm kDSStdAuthMSCHAP2 Discussion:
.Pp
MS-CHAP2 is a mutual authentication method. The plug-in will generate the data to send back to the client and put it in the step buffer.
.Pp
The input buffer format:
.Pp
4 byte length,
.Pp
username,
.Pp
4 byte length,
.Pp
server challenge,
.Pp
4 byte length,
.Pp
peer challenge,
.Pp
4 byte length,
.Pp
client's digest,
.Pp
The output buffer format:
.Pp
4 byte length,
.Pp
return digest for the client's challenge
.Pp
kDSStdAuthMSCHAP2 "dsAuthMethodStandard:dsAuthMSCHAP2"
.Pp
kDSStdAuthMASKE_A "dsAuthMethodStandard:dsAuthMASKE-A"
.Pp
kDSStdAuthMASKE_B "dsAuthMethodStandard:dsAuthMASKE-B"
.Pp
.Nm kDSStdAuthWithAuthorizationRef Discussion:
.Pp
Allows access to local directories as root with a valid AuthorizationRef.
.Pp
The input buffer format:
.Pp
externalized AuthorizationRef
.Pp
kDSStdAuthWithAuthorizationRef "dsAuthMethodStandard:dsAuthWithAuthorizationRef"
.Pp
.Nm kDSStdAuthNewUser Discussion:
.Pp
Create a new user record with the authentication authority
.Pp
The buffer is packed as follows:
.Pp
4 byte length of authenticator's UserID,
.Pp
authenticator's UserID in UTF8 encoding,
.Pp
4 byte length of authenticator's password,
.Pp
authenticator's password in UTF8 encoding
.Pp
4 byte length of new user's short-name,
.Pp
user's short-name,
.Pp
4 byte length of new user's password,
.Pp
user's password
.Pp
kDSStdAuthNewUser "dsAuthMethodStandard:dsAuthNewUser"
.Pp
.Nm kDSStdAuthGetPolicy Discussion:
.Pp
The plug-in should determine which specific authentication method to use.
.Pp
The buffer is packed as follows:
.Pp
4 byte length of authenticator's UserID,
.Pp
authenticator's UserID in UTF8 encoding,
.Pp
4 byte length of authenticator's password,
.Pp
authenticator's password in UTF8 encoding
.Pp
4 byte length of UserID of the account to get policies,
.Pp
UserID of the account to get policies in UTF8 encoding
.Pp
The Password Server does not require authentication for this auth method. The first two fields are to cover us for future policy changes and to keep the buffer format as standardized as possible.
.Pp
kDSStdAuthGetPolicy "dsAuthMethodStandard:dsAuthGetPolicy"
.Pp
.Nm kDSStdAuthSetPolicy Discussion:
.Pp
The plug-in should determine which specific authentication method to use.
.Pp
The buffer is packed as follows:
.Pp
4 byte length of authenticator's UserID,
.Pp
authenticator's UserID in UTF8 encoding,
.Pp
4 byte length of authenticator's password,
.Pp
authenticator's password in UTF8 encoding
.Pp
4 byte length of UserID of the account to set policies,
.Pp
UserID of the account to set policies in UTF8 encoding
.Pp
4 byte length of policy data,
.Pp
policy data
.Pp
kDSStdAuthSetPolicy "dsAuthMethodStandard:dsAuthSetPolicy"
.Pp
.Pp
kDSStdAuthGetGlobalPolicy "dsAuthMethodStandard:dsAuthGetGlobalPolicy"
.Pp
kDSStdAuthSetGlobalPolicy "dsAuthMethodStandard:dsAuthSetGlobalPolicy"
.Pp
kDSStdAuthGetUserName "dsAuthMethodStandard:dsAuthGetUserName"
.Pp
kDSStdAuthSetUserName "dsAuthMethodStandard:dsAuthSetUserName"
.Pp
kDSStdAuthGetUserData "dsAuthMethodStandard:dsAuthGetUserData"
.Pp
kDSStdAuthSetUserData "dsAuthMethodStandard:dsAuthSetUserData"
.Pp
kDSStdAuthDeleteUser "dsAuthMethodStandard:dsAuthDeleteUser"
.Pp
.Nm Users Distinguished or Real Name
.Pp
kDS1AttrDistinguishedName "dsAttrTypeStandard:RealName"
.Pp
.Pp
kDS1AttrFirstName "dsAttrTypeStandard:FirstName"
.Pp
kDS1AttrMiddleName "dsAttrTypeStandard:MiddleName"
.Pp
kDS1AttrLastName "dsAttrTypeStandard:LastName"
.Pp
.Nm All possible names for a record
.Pp
kDSNAttrAllNames "dsAttrTypeStandard:AllNames"
.Pp
.Nm Set password methods
.Pp
kDSSetPasswdBestOf "dsSetPasswdBestOf"
.Pp
.Nm kDSNAttrAuthenticationAuthority Discussion:
.Pp
Determines what mechanism is used to verify or set a user's password. If multiple values are present, the first attributes returned take precedence. Typically found in User records (kDSStdRecordTypeUsers).
.Pp
kDSNAttrAuthenticationAuthority "dsAttrTypeStandard:AuthenticationAuthority"
.Pp
.Nm kDS1AttrPasswordPolicyOptions Discussion:
.Pp
Collection of password policy options in single attribute. Used in user presets record.
.Pp
kDS1AttrPasswordPolicyOptions "dsAttrTypeStandard:PasswordPolicyOptions"
.Pp
.Nm kDSValueDefaultAuthAuthority Discussion:
.Pp
The default value to use for the kDSNAttrAuthenticationAuthority attribute. When creating a user record, set this value for authentication authority before setting the password with dsDoDirNodeAuth.
.Pp
kDSValueAuthAuthorityDefault kDSValueAuthAuthorityShadowHash
.Pp
kDSValueAuthAuthorityBasic ";basic;"
.Pp
kDSTagAuthAuthorityBasic "basic"
.Pp
kDSValueAuthAuthorityLocalWindowsHash ";LocalWindowsHash;"
.Pp
kDSTagAuthAuthorityLocalWindowsHash "LocalWindowsHash"
.Pp
kDSValueAuthAuthorityShadowHash ";ShadowHash;"
.Pp
kDSTagAuthAuthorityShadowHash "ShadowHash"
.Pp
kDSTagAuthAuthorityBetterHashOnly "BetterHashOnly"
.Pp
kDSValueAuthAuthorityPasswordServerPrefix ";ApplePasswordServer;"
.Pp
kDSTagAuthAuthorityPasswordServer "ApplePasswordServer"
.Pp
kDSValueAuthAuthorityKerberosv5 ";Kerberosv5;"
.Pp
kDSTagAuthAuthorityKerberosv5 "Kerberosv5"
.Pp
kDSValueAuthAuthorityLocalCachedUser ";LocalCachedUser;"
.Pp
kDSTagAuthAuthorityLocalCachedUser "LocalCachedUser"
.Pp
Single Valued Attribute
.Pp
kDS1AttrPassword "dsAttrTypeStandard:Password"
.Pp
kDS1AttrPasswordPlus "dsAttrTypeStandard:PasswordPlus"
.Pp
kDS1AttrAuthenticationHint "dsAttrTypeStandard:AuthenticationHint"
.Pp
kDS1AttrInternetAlias "dsAttrTypeStandard:InetAlias"
.Pp
kDS1AttrNFSHomeDirectory "dsAttrTypeStandard:NFSHomeDirectory"
.Pp
kDS1AttrUniqueID "dsAttrTypeStandard:UniqueID"
.Pp
kDS1AttrPrimaryGroupID "dsAttrTypeStandard:PrimaryGroupID"
.Pp
kDS1AttrMailAttribute "dsAttrTypeStandard:MailAttribute"
.Pp
kDS1AttrComment "dsAttrTypeStandard:Comment"
.Pp
kDS1AttrRARA "dsAttrTypeStandard:RARA"
.Pp
kDS1AttrGeneratedUID "dsAttrTypeStandard:GeneratedUID"
.Pp
kDS1AttrAdminStatus "dsAttrTypeStandard:AdminStatus"
.Pp
kDS1AttrPwdAgingPolicy "dsAttrTypeStandard:PwdAgingPolicy"
.Pp
kDS1AttrUserShell "dsAttrTypeStandard:UserShell"
.Pp
kDS1AttrVFSType "dsAttrTypeStandard:VFSType"
.Pp
kDS1AttrVFSPassNo "dsAttrTypeStandard:VFSPassNo"
.Pp
kDS1AttrVFSDumpFreq "dsAttrTypeStandard:VFSDumpFreq"
.Pp
kDS1AttrVFSLinkDir "dsAttrTypeStandard:VFSLinkDir"
.Pp
kDS1AttrChange "dsAttrTypeStandard:Change"
.Pp
kDS1AttrExpire "dsAttrTypeStandard:Expire"
.Pp
.Pp
kDSNAttrRecordAlias "dsAttrTypeStandard:RecordAlias"
.Pp
kDSNAttrGroupMembership "dsAttrTypeStandard:GroupMembership"
.Pp
kDSNAttrHomeDirectory "dsAttrTypeStandard:HomeDirectory"
.Pp
kDSNAttrKeywords "dsAttrTypeStandard:Keywords"
.Pp
.Nm kDS1AttrXMLPlist Discussion:
SA config settings plist.
.Pp
kDS1AttrXMLPlist "dsAttrTypeStandard:XMLPlist"
.Pp
.Nm kDS1AttrHomeDirectoryQuota Discussion:
.Pp
Represents the allowed usage for a user's home directory in bytes. Found in user records (kDSStdRecordTypeUsers).
.Pp
kDS1AttrHomeDirectoryQuota "dsAttrTypeStandard:HomeDirectoryQuota"
.Pp
kDS1AttrHomeDirectorySoftQuota "dsAttrTypeStandard:HomeDirectorySoftQuota"
.Pp
.Nm kDS1AttrAdminLimits Discussion:
.Pp
XML plist indicating what an admin user can edit. Found in kDSStdRecordTypeUsers records.
.Pp
kDS1AttrAdminLimits "dsAttrTypeStandard:AdminLimits"
.Pp
.Nm kDS1AttrPresetUserIsAdmin Discussion:
.Pp
Flag to indicate whether users created from this preset are administrators by default. Found in kDSStdRecordTypePresetUsers records.
.Pp
kDS1AttrPresetUserIsAdmin "dsAttrTypeStandard:PresetUserIsAdmin"
.Pp
.Pp
kDS1StandardAttrHomeLocOwnerkDS1AttrHomeLocOwner
.Pp
.Nm kDS1AttrHomeLocOwner Discussion:
.Pp
Represents the owner of a workgroup's shared home directory. Typically found in kDSStdRecordTypeGroups records.
.Pp
kDS1AttrHomeLocOwner "dsAttrTypeStandard:HomeLocOwner"
.Pp
.Pp
kDSNAttrProtocols "dsAttrTypeStandard:Protocols"
.Pp
kDSNAttrVFSOpts "dsAttrTypeStandard:VFSOpts"
.Pp
.Nm kDS1AttrPasswordServerLocation Discussion:
.Pp
Specifies the IP address or domain name of the Password Server associated with a given directory node. Found in a config record named PasswordServer.
.Pp
kDS1AttrPasswordServerLocation "dsAttrTypeStandard:PasswordServerLocation"
.Pp
.Nm kDS1AttrPort Discussion:
.Pp
Represents the port number a service is available on. Typically found in service record types including kDSStdRecordTypeAFPServer, kDSStdRecordTypeLDAPServer, and kDSStdRecordTypeWebServer.
.Pp
kDS1AttrPort "dsAttrTypeStandard:Port"
.Pp
.Nm kDS1AttrLocation Discussion:
.Pp
Represents the location a service is available from (usually domain name). Typically found in service record types including kDSStdRecordTypeAFPServer, kDSStdRecordTypeLDAPServer, and kDSStdRecordTypeWebServer.
.Pp
kDS1AttrLocation "dsAttrTypeStandard:Location"
.Pp
.Nm kDS1AttrServiceType Discussion:
.Pp
Represents the service type for the service. This is the raw service type of the service. For example a service record type of kDSStdRecordTypeWebServer might have a service type of "http" or "https".
.Pp
kDS1AttrServiceType "dsAttrTypeStandard:ServiceType"
.Pp
.Nm kDS1AttrPicture Discussion:
.Pp
Represents the path of the picture for each user displayed in the login window. Found in user records (kDSStdRecordTypeUsers).
.Pp
kDS1AttrPicture "dsAttrTypeStandard:Picture"
.Pp
.Nm Mutivalued meta attribute data
.Pp
kDSNAttrMetaNodeLocation "dsAttrTypeStandard:AppleMetaNodeLocation"
.Pp
kStandardTargetAlias "dsAttrTypeStandard:AppleMetaAliasTarget"
.Pp
kStandardSourceAlias "dsAttrTypeStandard:AppleMetaAliasSource"
.Pp
.Pp
kDS1AttrAliasData "dsAttrTypeStandard:AppleAliasData"
.Pp
Single Valued - checksum/meta data
.Pp
kDS1AttrDataStamp "dsAttrTypeStandard:DataStamp"
.Pp
kDS1AttrTotalSize "dsAttrTypeStandard:TotalSize"
.Pp
Single Valued - data of Create, Modify, Backup time in UTC
.Pp
kDS1AttrTimePackage "dsAttrTypeStandard:TimePackage"
.Pp
Single Valued - alias attribute, contain pointer to another node/record/attribute
.Pp
kDS1AttrAlias "dsAttrTypeStandard:Alias"
.Pp
Single valued - used to get a "auth" credential, to be used to authenticate to other Directory nodes.
.Pp
kDS1AttrAuthCredential "dsAttrTypeStandard:AuthCredential"
.Pp
Single valued - Note attribute. Commonly used in printer records.
.Pp
kDS1AttrNote "dsAttrTypeStandard:Note"
.Pp
Single-valued attribute for definition of the Printer Make and Model. An example
Value would be "HP LaserJet 2200". This would be used to determine the proper PPD
file to be used when configuring a printer from the Directory. This attribute
is based on the IPP Printing Specification RFC and IETF IPP-LDAP Printer Record.
.Pp
kDS1AttrPrinterMakeAndModel "dsAttrTypeStandard:PrinterMakeAndModel"
.Pp
Single-valued attribute that defines the URI of a printer "ipp://address" or
"smb://server/queue". This is used when configuring a printer. This attribute
is based on the IPP Printing Specification RFC and IETF IPP-LDAP Printer Record.
.Pp
kDS1AttrPrinterURI "dsAttrTypeStandard:PrinterURI"
.Pp
Multi-valued attribute that defines additional URIs supported by a printer.
This is used when configuring a printer. This attribute is based on the IPP
Printing Specification RFC and IETF IPP-LDAP Printer Record.
.Pp
kDSNAttrPrinterXRISupported "dsAttrTypeStandard:PrinterXRISupported"
.Pp
Single-valued attribute that defines the IEEE 1284 DeviceID of a printer.
This is used when configuring a printer.
.Pp
kDS1AttrPrinter1284DeviceID "dsAttrTypeStandard:Printer1284DeviceID"
.Pp
Single valued - DNS Resolver domain attribute.
.Pp
kDS1AttrDNSDomain "dsAttrTypeStandard:DNSDomain"
.Pp
Single valued - DNS Resolver nameserver attribute.
.Pp
kDS1AttrDNSNameServer "dsAttrTypeStandard:DNSNameServer"
.Pp
.Nm KDC master key RSA encrypted with realm public key.
.Pp
kDSNAttrKDCAuthKey "dsAttrTypeStandard:KDCAuthKey"
.Pp
.Nm Contents of the kdc.conf file.
.Pp
kDS1AttrKDCConfigData "dsAttrTypeStandard:KDCConfigData"
.Pp
.Nm Used with directory nodes so that clients can "discover" the API capabilities for this Directory Node.
.Pp
kDS1AttrCapabilities "dsAttrTypeStandard:Capabilities"
.Pp
can be found using dsGetDirNodeInfo and will return one of ReadOnly, ReadWrite, or WriteOnly strings note that ReadWrite does not imply fully readable or writable
.Pp
kDS1AttrReadOnlyNode "dsAttrTypeStandard:ReadOnlyNode"
.Pp
used with Search Node to "discover" the search path for this node
.Pp
kDS1AttrSearchPath "dsAttrTypeStandard:SearchPath"
.Pp
kDSNAttrSearchPath "dsAttrTypeStandard:SearchPath"
used with Search Node to "discover" the search policy for this node
.Pp
kDS1AttrSearchPolicy "dsAttrTypeStandard:SearchPolicy"
used with Search Node to "discover" the possible search paths for this node
.Pp
kDS1AttrNSPSearchPath "dsAttrTypeStandard:NSPSearchPath"
.Pp
kDSNAttrNSPSearchPath "dsAttrTypeStandard:NSPSearchPath"
.Pp
kDS1AttrLSPSearchPath "dsAttrTypeStandard:LSPSearchPath"
.Pp
kDSNAttrLSPSearchPath "dsAttrTypeStandard:LSPSearchPath"
.Pp
kDS1AttrCSPSearchPath "dsAttrTypeStandard:CSPSearchPath"
.Pp
kDSNAttrCSPSearchPath "dsAttrTypeStandard:CSPSearchPath"
.Pp
.Nm force the directory service to generate a binary image of the record and all it's attributes.
.Pp
kDS1AttrRecordImage "dsAttrTypeStandard:RecordImage"
.Pp
Information (version, signature, about, credits..ect.) about the plug-in that is actually servicing a particular directory node.
.Pp
kDSNAttrPlugInInfo "dsAttrTypeStandard:PlugInInfo"
.Pp
Multivalued Attribute, list of names/keys for this record
.Pp
kDSNAttrRecordName "dsAttrTypeStandard:RecordName"
.Pp
Multivalued - list of attribute types
.Pp
kDSNAttrSchema "dsAttrTypeStandard:Scheama"
.Pp
Single Valued for a Record, Multi-valued for a Directory Node
.Pp
kDSNAttrRecordType "dsAttrTypeStandard:RecordType"
.Pp
.Pp
kDSNAttrNodePath "dsAttrTypeStandard:NodePath"
.Pp
.Pp
kDSNAttrAuthMethod "dsAttrTypeStandard:AuthMethod"
.Pp
kDSNAttrSetPasswdMethod "dsAttrTypeStandard:SetPasswdMethod"
.Pp
// Multivalued - list of group records
.Pp
kDSNAttrGroup "dsAttrTypeStandard:Group"
.Pp
Multivalued - list of member records
.Pp
kDSNAttrMember "dsAttrTypeStandard:Member"
.Pp
kDSNAttrURL "dsAttrTypeStandard:URL"
.Pp
data contained in this attribute type is a fully qualified MIME Type.
.Pp
kDSNAttrMIME "dsAttrTypeStandard:MIME"
.Pp
kDSNAttrHTML "dsAttrTypeStandard:HTML"
.Pp
.Pp
kDSNAttrNBPEntry "dsAttrTypeStandard:NBPEntry"
.Pp
kDSNAttrDNSName "dsAttrTypeStandard:DNSName"
.Pp
kDSNAttrIPAddress "dsAttrTypeStandard:IPAddress"
.Pp
.Nm kDS1AttrENetAddress Discussion:
.Pp
Single-valued attribute for hardware Ethernet address (MAC address). Found in machine records (kDSStdRecordTypeMachines) and computer records (kDSStdRecordTypeComputers).
.Pp
kDS1AttrENetAddress "dsAttrTypeStandard:ENetAddress"
.Pp
.Nm kDSNAttrBootParams Discussion:
.Pp
Attribute type in host or machine records for storing boot params.
.Pp
kDSNAttrBootParams "dsAttrTypeStandard:BootParams"
.Pp
.Nm kDSNAttrNetGroups Discussion:
.Pp
Attribute type that indicates which netgroups its record is a member of. Found in user, host, and netdomain records.
.Pp
kDSNAttrNetGroups "dsAttrTypeStandard:NetGroups".Pp
.Pp
kDSNAttrPGPPublicKey "dsAttrTypeStandard:PGPPublicKey"
.Pp
kDSNAttrEMailAddress "dsAttrTypeStandard:EMailAddress"
.Pp
.Pp
kDSNAttrAreaCode "dsAttrTypeStandard:AreaCode"
.Pp
kDSNAttrPhoneNumber "dsAttrTypeStandard:PhoneNumber"
.Pp
kDSNAttrPostalAddress "dsAttrTypeStandard:PostalAddress"
.Pp
.Pp
kDSNAttrOrganizationName "dsAttrTypeStandard:OrganizationName"
.Pp
kDSNAttrAddressLine1 "dsAttrTypeStandard:AddressLine1"
.Pp
kDSNAttrAddressLine2 "dsAttrTypeStandard:AddressLine2"
.Pp
kDSNAttrAddressLine3 "dsAttrTypeStandard:AddressLine3"
.Pp
kDSNAttrCity "dsAttrTypeStandard:City"
.Pp
kDSNAttrState "dsAttrTypeStandard:State"
.Pp
kDSNAttrPostalCode "dsAttrTypeStandard:PostalCode"
.Pp
used for Setup Assistant automatic population
.Pp
kDS1AttrSetupOccupation "dsAttrTypeStandard:Occupation"
.Pp
kDS1AttrSetupLocation "dsAttrTypeStandard:SetupAssistantLocation"
.Pp
kDS1AttrSetupAdvertising "dsAttrTypeStandard:SetupAssistantAdvertising"
.Pp
kDS1AttrSetupAutoRegister "dsAttrTypeStandard:SetupAssistantAutoRegister"
.Pp
.Pp
kDS1AttrMCXSettings "dsAttrTypeStandard:MCXSettings"
.Pp
kDSNAttrMCXSettings "dsAttrTypeStandard:MCXSettings"
.Pp
kDS1AttrMCXFlags "dsAttrTypeStandard:MCXFlags"
.Pp
kDSNAttrComputers "dsAttrTypeStandard:Computers"
.Pp
Print
.Pp
kDS1AttrPrintServiceInfoXML "dsAttrTypeStandard:PrintServiceInfoXML"
.Pp
kDS1AttrPrintServiceInfoText "dsAttrTypeStandard:PrintServiceInfoText"
.Pp
.Nm kDS1AttrPrintServiceUserData Discussion:
.Pp
Single-valued attribute for print quota configuration or statistics (XML data). Found in user records (kDSStdRecordTypeUsers) or print service statistics records (kDSStdRecordTypePrintServiceUser).
.Pp
kDS1AttrPrintServiceUserData "dsAttrTypeStandard:PrintServiceUserData"
.Pp
.Nm kDSStdNotifyxxxxx Discussion:
Notification tags that can be registered for with SystemConfiguration
to receive notifications of events occuring in the DirectoryService daemon on the
local machine.
.Pp
.Pp
kDSStdNotifyTypePrefix "com.apple.DirectoryService.NotifyTypeStandard:"
.Pp
kDSStdNotifySearchPolicyChanged "com.apple.DirectoryService.NotifyTypeStandard:SearchPolicyChanged"
.Pp
kDSStdNotifyDirectoryNodeAdded "com.apple.DirectoryService.NotifyTypeStandard:DirectoryNodeAdded"
.Pp
kDSStdNotifyDirectoryNodeDeleted "com.apple.DirectoryService.NotifyTypeStandard:DirectoryNodeDeleted"
.Pp
.Sh SEE ALSO
.\" List links in ascending order by section, alphabetically within a section.
.\" Please do not reference files that do not exist without filing a bug report
.Xr DirectoryService 8
.Xr dscl 1
.\" .Sh BUGS
.\" .Sh HISTORY