Active Directory Target CLI Configuration
This topic includes CLI commands and parameters for adding Active Directory target applications and target accounts.
capam32
This topic includes CLI commands and parameters for adding Active Directory target applications and target accounts.
2
Active Directory Target Connector CLI Parameters
To add an Active Directory target application and connector using the CLI, use the addTargetApplication command and the following command parameters:
TargetApplication.type
The target application connector type.
Required | Default Value | Valid Values |
yes | N/A | windowsDomainService |
Attribute.disableAutoConnectTargetAccount
Disable automatic connections to the remote target server for all target accounts using this application type.
Required | Default Value | Valid Values |
no | false |
|
Attribute.domainName
The Windows domain that is managed by the Active Directory Server.
Required | Default Value | Valid Values |
yes | N/A | Domain name (text string) |
Attribute.useDNS
Determines the level to which DNS is used.
Required | Default Value | Valid Values |
yes | none |
|
Attribute.dnsServer
The host names of the DNS servers to use.
Required | Default Value | Valid Values |
Required if Attribute.useDNS is set to specifiedDNS
| none | Comma separated list of DNS server host names. |
Attribute.dcPort
The port that is used to connect to the Active Directory server.
Required | Default Value | Valid Values |
no | 636 | Numeric |
Attribute.adSite
The Active Directory site. This parameter is only used if
Attribute.useDNS
is set to retrieveDNS
or specifiedDNS
. If a value is given, Credential Manager uses the value to narrow the search for domain controllers based on the specified name.Required | Default Value | Valid Values |
no | N/A | String |
Active Directory Target Account CLI Parameters
To add an Active Directory target account that uses the target connector, use the addTargetAccount command and the following command parameters:
Attribute.extensionType
Specifies the type of account to be used.
Required | Default Value | Valid Values |
yes | N/A | windowsDomainService |
Attribute.userDN
The user s distinguished name on the Active Directory Server.
Required | Default Value | Valid Values |
yes | N/A | String. |
Attribute.useOtherAccountToChangePassword
Specifies whether to use the target account or a different account to perform password change requests.
Required | Default Value | Valid Values |
yes | N/A | true, false |
Attribute.otherAccount
Specifies which other account to use to perform password change requests.
Required | Default Value | Valid Values |
Required if Attribute.useOtherAccountToChangePassword is true. | N/A | String. A valid target account ID. |
Attribute.serviceInfo
List of services.
Required | Default Value | Valid Values |
No | N/A | <empty string> no servicesAdd one of the following entries for each service:
Multiple services are delimited by the | character.< is the name of the server running the proxy.proxy_hostname >< is the name of the server where the service is hosted.hostname > |
Attribute.tasks
List of scheduled tasks.
Required | Default Value | Valid Values |
No | none | <empty string> no tasksAdd the following for each task: < proxy_hostname >:<hostname >:<task_name >Multiple tasks are delimited by the | character.< is the name of the server running the proxy.proxy_hostname >< is the name of the server where the scheduled task is hosted.hostname > |
Active Directory CLI Example
cmdName=addTargetApplication TargetServer.hostName=myhostname.mydomain.comTargetApplication.name=myAD TargetApplication.type=windowsDomainService Attribute.domainName=cspm2Attribute.useDNS= specifiedDNS Attribute.dnsServer=dns1.cloakware.com,dns2.cloakware.comAttribute.dcPort=636 Attribute.adSite=LondoncmdName=addTargetAccount TargetServer.hostName=myhostname.mydomain.com TargetApplication.name=mywindowsTargetAccount.userName=admin TargetAccount.password=P@ssw0rd TargetAccount.cacheAllow=trueTargetAccount.cacheDuration=19 Attribute.extensionType=windowsDomainService Attribute.useOtherAccountToChangePassword=falseAttribute.forcePasswordChange=false Attribute.userDN=cn=admin,dc=cspm2Attribute.serviceInfo=proxyhostA:HostA:serviceName:restart|proxyhostB:HostB:serviceName:norestartAttribute.tasks=proxyHostA:HostA:taskName|proxyHostB:HostB:taskName