Parameters for ARSXML add, update, delete

add
This is the default action. It adds all of the objects in the input XML file into the specified IBM® Content Manager OnDemand system. For objects that contain child objects, such as a list of users or a set of permissions, each child object that is found in the XML file is added to the current list of objects.
update
All the fields that are specified in the input XML file are updated for the object. For example, if the XML file contains a user with a name of harry and a description of The New Description specified, then only the description field of the user harry is updated. All other fields remain unchanged.
Restriction: Not all fields of all objects can be updated.
For objects which contain child objects, such as a list of users or a set of permissions, each child object that is found in the XML file are added to the list of objects. A special attribute on each child object can be set to delete for the cases where a member of a list need to be removed. For example, if you want to add the user newUser to a group, and delete the user oldUser, the following XML code can be used during an update: 
...
<group name="MyGroup">
<user name="newUser" />
<user name="oldUser" task="delete" />
</group>
...
delete

All of the objects that are specified in the input XML file are deleted from the system. The only attribute that is examined in the XML file is the name attribute. While all other fields might be present in the XML file, they are ignored.

-d
Specifies the directory that contains the XML file. If you do not use this parameter, ARSXML looks for the input XML file specified by the -i flag in the current working directory where the command is run.
-e error_handling
Controls how the import process handles any Content Manager OnDemand errors.
Important: The XML file syntax errors and other XML-specific errors are detected by the parsing code, and no objects are processed.
The error_handling parameter can take three values:
a
Abort. This is the default value.
c
Continue. If an error occurs because of problems in the objects or the Content Manager OnDemand system (for example, you attempt to add an object but that object already exists, or you attempt to delete an object that does not exist), the object containing the error is skipped, and the process continues. However, if an XML parsing error occurs, ARSXML stops regardless of whether or not this option is specified.
u
Update. This value should only be used during an add action.
During an add action:
Abort
If an error occurs during an add (for example, an invalid parameter, or the object already exists), the error is logged, the entire import process is stopped, and no further objects are added.
Continue
If an error occurs during an add action, the object containing the error is skipped and an error message is logged. However, the import process continues.
Update
If an object already exists, perform an update action instead of an add action.
During a delete action:
Abort
If an error occurs during a delete (for example, there is an invalid object or the object does not exist), the error is logged, the entire delete process is stopped, and no further objects are deleted.
Continue
If an error occurs during an delete action, the object containing the error is skipped and an error message is logged. However, the import process continues.
During an update action:
Abort
If an error occurs during a update (for example, there is an invalid object or the object does not exist), the error is logged, the entire update process is stopped, and no further objects are updated.
Continue
If an error occurs during an update action, the object containing the error is skipped and an error message is logged. However, the import process continues.
-h instance
The name of the Content Manager OnDemand instance to process. By default, the ARCHIVE instance is used. You must specify the -h or -I parameter and name the instance if you are running more than one instance on the same system and you want to process an instance other than the default instance.
Tip: The ARSXML program also supports the -I parameter. You can use either parameter to specify the name of the instance to process. If you specify both, the value of the last parameter that is specified is used.
-i
Specifies the input XML file.
-I instance
The name of the Content Manager OnDemand instance to process. By default, the ARCHIVE instance is used. You must specify the -h or -I parameter and name the instance if you are running more than one instance on the same system and you want to process an instance other than the default instance.
Tip: The ARSXML program also supports the -h parameter. You can use either parameter to specify the name of the instance to process. If you specify both, the value of the last parameter that is specified is used.
-p password
Specify one of the following options for password:
  • The name of the stash (encrypted password) file that contains the password for the user ID specified with the -u parameter.
  • The password for the Content Manager OnDemand user ID specified with the -u parameter.
    If the user ID is not assigned a password, you can do either of the following:
    • Press the Enter key when prompted for the password.
    • Specify a blank password with the following syntax: -p ""

If you do not specify the -p parameter while you specify the -u parameter, then the ARSXML program retrieves the password for the user ID from the stash file specified in ARS.INI file for that instance. You specify the path and file name of the stash file in the ARS.INI file for that instance.

If you omit both the -u and the -p parameters, the system attempts a unified logon. If the unified logon fails, you are prompted to enter a user ID and password.

-u userid
The user ID is optional. The following list describes how the ARSXML program retrieves the user ID and password if you omit or specify this parameter:
  • If you omit this parameter, the ARSXML program prompts you for it before running the program.
  • If you specify the -u parameter and omit the -p parameter, the ARSXML program retrieves the password for the user ID from the stash file defined for that instance. You specify the path and file name of the stash file in the ARS.INI file for that instance.
  • If you omit both the -u and the -p parameters, the system attempts a unified logon. If the unified logon fails, you are prompted to enter a user ID and password.
-v
Enables verbose mode, which displays all messages (informational and error). By default, the ARSXML program displays error messages.
-x
Used to prevent prompting from occurring. If you do not use this option, during a delete operation, you are prompted whether you really want to complete the operation, for example: 
The printer object named 'LabPrinter' is about to be deleted.
Do you want to delete this object? (Y/N)
You need to respond with a y or Y to confirm the delete operation. Any other response terminates the operation. If you use this option, you do not get the prompt during an operation.
-1 trace_file
Specify a fully qualified trace file name as directed by IBM Software Support.
-2 level
Specify a value as directed by IBM Software Support.
Important: While importing objects, if an object references another object in its definition but the referenced object cannot be found, and the import command uses the -e c parameter, an error message is issued, and the default value is used. For example, if a user is defined with a default printer and the default printer cannot be found, the user is added with a default printer of *NONE. If the -e c parameter is not used, the above action will not occur.