...
h1. Commadmin Command-Line Description
This page provides general information about how to use the {{commadmin}} command. It includes the following topics:
{toc:minLevel=2|maxLevel=2}
h2. {anchor:ACFDV} Execution Modes
The command line execution has three possible modes:
* Execute with options specified in a file
{noformat}
commadmin <object> <task> -i <inputfile>
{noformat}
Analyzes _inputfile_ and executes it. The input file should be in the format [#Command File Format]
* Immediate or shell execution
{noformat}
commadmin <object> <task> [<options>]
{noformat}
If all needed information is provided, the command will execute immediately.
* Interactive
{noformat}
commadmin <object> <task>
{noformat}
The command contains some, but not all of the required options for command execution. The administrator is queried for the remainder of the options and attributes.
h2. Command results
When an operation succeeds, the following message appears:
{{OK}}
If a failure occurs, the following message appears:
{{FAIL}}
*_<message>_*
Where *_<message>_* displays the error text.
h2. {anchor:ACFDW} Command File Format
The options can be specified within a file, using the {{-i}} option.
Within the file, option names are separated from option values by white space. The option value begins with the first non-white space character and extends to the end-of-line character. Option sets are separated by blank lines.
The general syntax is:
{noformat}
<option name><white space>[option value, if any]
<option name><white space>[option value, if any]
...
<option name><white space>[option value, if any]
<blank line>
<option name><white space>[option value, if any]
<option name><white space>[option value, if any]
...
<option name><white space>[option value, if any]
{noformat}
The option value given in the command line becomes the default for each option set. Alternatively, these options can be specified for each option set. The value then overrides any default specified on the command line.
Following is an example of the format and syntax for the file specified by the {{-i}} option for the {{commadmin user create}} command.
{panel}
{{l newuser1}}
{{F new}}
{{L user1}}
{{W secret}}
{{l newuser2}}
{{F new}}
{{L user2}}
{{W secret}}
{{l newuser3}}
{{F new}}
{{L user3}}
{{W secret}}
{{<and so forth...>}}
{panel}
h2. {anchor:ACFDY} Mandatory commadmin Options
The following are the mandatory options used for authenticating the administrator or the user.
||Options ||Description ||
|{{-D}} _userid_|User ID used to bind to the directory.|
|{{-w}} _password_|Password used to authenticate the user ID to the directory.\\
\\You may also specify _password_ via a text file, _password_{{.txt}}.\\
\\For example, if you specify {{-w}} {{mypassword.txt}}, and the content of the {{mypassword.txt}} file is {{secret}}, the {{commadmin}} utility takes the string {{secret}} as the password.\\
\\Note that if you specify {{-w}} {{mypassword.txt}}, and the {{mypassword.txt}} file does not exist, the {{commadmin}} utility takes the string {{mypassword.txt}} itself as the password.|
|{{-n}} _domain_|The domain the administrator belongs to. (For more information, see the *Note* shown below this table.)|
{info:title=Configuring Delegated Administrator for Directory Access Through Access Manager (Legacy Mode)}
This note applies only if you choose to access the directory using Access Manager in Legacy mode when you first configure Delegated Administrator after installation.