Windows Remote Target Connector CLI Configuration
Windows Remote Target Connector CLI Configuration
capam32
This topic contains the parameters for adding a Windows Remote target application and target account:
Windows Remote Target Connector CLI Parameters
To add a Windows Remote target application and connector using the CLI, use the command and the following command parameters:
Attribute.extensionType
Specify the type of account to use.
Required | Default Value | Valid Values |
yes | N/A | windowsRemoteAgent |
Attribute.accountType
The type of account being managed.
Required | Default Value | Valid Values |
yes | domain | domain, local |
Attribute.domainName
The Windows domain for the managed accounts.
Required | Default Value | Valid Values |
Required if Attribute.accountType is set to domain (the default). | none | Domain name (a text string) |
Attribute.domain
The Windows domain for the managed accounts. This attribute exists only for backwards compatibility. We recommend using
Attribute.domainName
instead.Required | Default Value | Valid Values |
Required if Attribute.accountType is set to domain (the default). | none | Domain name (a text string) |
Attribute.useDNS
Determine the level to which DNS is used.
Required | Default Value | Valid Values |
Required if Attribute.accountType is set to domain (the default). | 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.specifiedServersList
Provide a comma separated list of domain controllers.
Required | Default Value | Valid Values |
Required if Attribute.useDNS is set to specifiedServers . | none | Comma separated list of valid domain controllers |
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, using the specified name.Required | Default Value | Valid Values |
no | none | String |
Windows Remote Target Account CLI Parameters
To add a Windows Remote target account that uses the target connector, use the command and the following parameters:
Attribute.extensionType
Specify the extension type to use.
Required | Default Value | Valid Values |
yes | N/A | windowsRemoteAgent |
Attribute.accountType
Specify the type of account to use.
Required | Default Value | Valid Values |
yes | user | user, admin |
Attribute.useOtherAccountToChangePassword
Specify 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
Specify which other account to use to perform password change requests.
Required | Default Value | Valid Values |
Required if Attribute.useOtherAccountToChangePassword is true. | N/A | A valid target account ID. |
Note:
The Target Account ID can be found using the command.Attribute.serviceInfo
List of services.
Required | Default Value | Valid Values |
no | N/A | Add the following code for each service: hostname :servicename :restarthostname :servicename :norestarthostname Delimit multiple services with the | (pipe) character. An empty string means no services. |
Attribute.tasks
List of scheduled tasks.
Required | Default Value | Valid Values |
no | none | For each task, add the string: hostname :taskname Delimit multiple services with the | (pipe) character.hostname is the name of the server where the scheduled task is hostedAn empty string means no tasks. |
Attribute.forcePasswordChange
This parameter specifies whether Credential Manager updates passwords that fail verification during an initial synchronization. The default value is false. To update passwords that fail initial synchronization, set the attribute value to true.
Required | Default Value | Valid Values |
no | false | true, false |
Windows Remote CLI Example
cmdName=addTargetApplication TargetServer.hostName=myhostname.mydomain.comTargetApplication.name=myWindowsRemote TargetApplication.type=windowsRemoteAgentAttribute.extensionType=windowsRemoteAgent Attribute.accountType=domain Attribute.domainName=testDomaincmdName=addTargetAccount TargetServer.hostName=myhostname.mydomain.com TargetApplication.name=myWindowsRemoteTargetAccount.userName=admin TargetAccount.password=P@ssw0rd TargetAccount.privileged=trueAttribute.extensionType=windowsRemoteAgent Attribute.accountType=adminAttribute.useOtherAccountToChangePassword=false Attribute.forcePasswordChange=falseAttribute.serviceInfo=HostA:serviceName:restart|HostB:ServiceName:norestartAttribute.tasks=HostA:taskName|HostB:taskName