Administrative command invocation syntax

Administrative command invocation syntax

The administrative command uses a specific syntax to invoke operations.

We can use an administrative command in batch mode or in interactive mode. The following syntax is used for an administrative command:
Jacl:
$AdminTask cmdName [targetObject] [options]
where options include:
{
  [-paramName paramValue] [-paramName] ...    [-stepName {{stepParamValue ...} ...} ...]    [-delete {-stepName {{stepKeyParamValue ...} ...} ...} ...]    [-interactive]
}
or
{
  [-paramName paramValue] [-paramName] ...    [-stepName {{stepParamName stepParamValue} {stepParamName stepParamValue} ...]    [-delete {-stepName {{stepKeyParamValue ...} ...} ...} ...]    [-interactive]
}
Jython:
AdminTask.cmdName(['targetObject'], [options])
where options include:
'[
[-paramName paramValue] [-paramName ...]  [-stepName [[stepParamValue ...] ...] ...]  [-delete [-collectionStepName [[stepKeyParamValue ...] ...] ...] ...]  [-interactive]
]'
or
'[
[-paramName paramValue] [-paramName ...]  [-stepName [[stepParamName stepParamValue] [stepParamName stepParamValue] ...]  [-delete [-collectionStepName [[stepKeyParamValue ...] ...] ...] ...]  [-interactive]
]'
where:

command parameter descriptions. Run commands with parameters
Parameter Description
cmdName represents the name of an administrative command to run.
targetObject represents the target object on which the command operates. Depending on the administrative command, this input can be required, optional, or nonexistent. This input corresponds to the Target object that is displayed in the command-specific help.
paramName represents the parameter name of the command that was run. Depending on the administrative command, this input can be required, optional, or nonexistent. Each parameter name corresponds to an argument name that is displayed in the Arguments area of the command-specific help.
paramValue represents the parameter value to set for the preceding parameter name. Parameters are specified as name-value pairs. The parameter value is not required if a parameter has Boolean as its value type. If we specify the parameter name only, without specifying a value for a Boolean type parameter, the value is set to true.
stepName represents the step name of the command. This input corresponds to a step name that is displayed in the Steps area of the command-specific help.
stepParamName represents the parameter name for a step. Depending on the administrative command, this input can be required, optional, or nonexistent. Each parameter name corresponds to an argument name that displays in the step area of the command-specific help.
stepParamValue ... represents the values of the parameters for a step. Provide all the parameter values of a step in the correct order, as displayed in the step-specific help. For any optional parameters that we do not want to specify a value, put "" instead of the value. If a command step is a collection type, for example, it contains multiple objects where each object has the same set of parameters. We can specify multiple objects with each object enclosed by a pair of braces. For collection type steps, each step parameter is a key or a non-key. Key parameters in a step are used to uniquely identify an object in the collection. If data exists in the step, key parameter values provided in the input are compared with key parameter values in the existing data. If a match is found, the existing data is updated. Otherwise, if the specified step supports the addition of new objects, the input values are added.
delete represents the option to delete existing data from a specified step that supports collection.
collectionStepName represents the collection step name.
stepKeyParamValue ... represents the values of key parameters to uniquely identify an object to delete from a collection step. Provide the key parameter values of an object in the order that they are displayed in the step specific help.
interactive represents the option to enter interactive mode.
[ ] represents a Jython list bracket.
[ ] indicates that the parameters or options inside the brackets are optional. Do not type these brackets as part of the syntax.

Related tasks

Obtaining online help

Parameter	Description
cmdName	represents the name of an administrative command to run.
targetObject	represents the target object on which the command operates. Depending on the administrative command, this input can be required, optional, or nonexistent. This input corresponds to the Target object that is displayed in the command-specific help.
paramName	represents the parameter name of the command that was run. Depending on the administrative command, this input can be required, optional, or nonexistent. Each parameter name corresponds to an argument name that is displayed in the Arguments area of the command-specific help.
paramValue	represents the parameter value to set for the preceding parameter name. Parameters are specified as name-value pairs. The parameter value is not required if a parameter has Boolean as its value type. If we specify the parameter name only, without specifying a value for a Boolean type parameter, the value is set to true.
stepName	represents the step name of the command. This input corresponds to a step name that is displayed in the Steps area of the command-specific help.
stepParamName	represents the parameter name for a step. Depending on the administrative command, this input can be required, optional, or nonexistent. Each parameter name corresponds to an argument name that displays in the step area of the command-specific help.
stepParamValue ...	represents the values of the parameters for a step. Provide all the parameter values of a step in the correct order, as displayed in the step-specific help. For any optional parameters that we do not want to specify a value, put "" instead of the value. If a command step is a collection type, for example, it contains multiple objects where each object has the same set of parameters. We can specify multiple objects with each object enclosed by a pair of braces. For collection type steps, each step parameter is a key or a non-key. Key parameters in a step are used to uniquely identify an object in the collection. If data exists in the step, key parameter values provided in the input are compared with key parameter values in the existing data. If a match is found, the existing data is updated. Otherwise, if the specified step supports the addition of new objects, the input values are added.
delete	represents the option to delete existing data from a specified step that supports collection.
collectionStepName	represents the collection step name.
stepKeyParamValue ...	represents the values of key parameters to uniquely identify an object to delete from a collection step. Provide the key parameter values of an object in the order that they are displayed in the step specific help.
interactive	represents the option to enter interactive mode.
[ ]	represents a Jython list bracket.
[ ]	indicates that the parameters or options inside the brackets are optional. Do not type these brackets as part of the syntax.