The Identity Synchronization for Windows command line utilities share the following features:
This section describes the arguments (options) that are common to most of the command line utilities. The information is organized into the following tables:
Common Arguments to the Idsync Subcommands: Describes the following arguments, which are common to all of the idsync subcommands (except prepds) and migration tools.
-D bind-DN -w bind-password | - [-h Configuration Directory-hostname] [-p Configuration Directory-port-no] [-s rootsuffix] [-Z] [-P cert-db-path] [-m secmod-db-path] |
Brackets [ ] indicate optional arguments.
The Identity Synchronization for Windows installation program automatically writes default values to the -h, -p, -D, and -s arguments based on the information you provide during installation. However, you can specify a different value on the command line to override a defaulted value.
To support multibyte characters, Identity Synchronization for Windows base64-encodes the default values for -s rootsuffixand -D bind-DN in the command line interface (CLI) environment file. The rootsuffix default should not be changed. The bind DN default can be overridden on the command line or updated with the appropriate base64-encoded value in the CLI environment file.
Common Arguments for Accessing the Configuration Directory Server using SSL: Describes optional arguments that provide information about securely accessing the Configuration Directory Server using Secure Socket Layer (SSL). These arguments are also common to all of the idsync subcommands and the migration tools.
Common Arguments Related to Configuration Directory: Describes arguments related to the configuration directory. These arguments are common to two or more idsync subcommands and migration tools.
Argument |
Description |
---|---|
-h Configuration Directory-hostname |
Specifies the configuration directory hostname. This argument defaults to the values specified during Core installation. |
-p Configuration Directory-port |
Specifies the configuration directory LDAP port number. |
-D bind-DN |
Specifies the configuration directory bind distinguished name (DN). This argument defaults to the values specified during Core installation. |
-w bind-password | - |
Specifies the configuration directory bind password. The - value reads the password from standard input (STDIN). |
-s rootsuffix |
Specifies the configuration directory rootsuffix. Where rootsuffix is a distinguished name such as dc=example,dc=com. This argument defaults to the values specified during Core installation. |
-q configuration_password | - |
Specifies the configuration password. The - value means the password will be read from standard input (STDIN). This argument is mandatory for all subcommands except prepds. |
Table A–2 SSL-Related Arguments Common to All Subcommands
Table A–3 Configuration Directory Arguments
Wherever a password argument is required (such as -w bind-password or -q configuration_password), you can use the “ -” argument to tell the password program to read the password from STDIN.
If you use the “-” value for multiple password options, idsync will prompt you for passwords based on the arguments’ order.
In this case, the program would expect the bind-password first, and then for the configuration-password.
You can use one of the following commands to display usage information about idsync or any of its subcommands in the command Console:
-help
--help
-?
For usage information
About idsync (including a list of valid subcommands), type one of the preceding help options at a command prompt and click Return.
About a subcommand, type the subcommand followed by a help option at a command prompt and click Return.