This project has moved. For the latest updates, please go here.

<command> element (synchronous command)

Synchronous commands are commands that are sent to the server for execution, and the execution of the MA halts until the command returns.

Synchronous commands support the follwing behaviours:
  • The MA can read the standard output (stdout) of a synchronous commands and use that information to extract objects for import into FIM
  • Synchronous commands can use exit or return codes to determine the success or failure of a command
Synchronous commands do not support:
  • Providing additional input to the standard input (stdin) after a command has been executed. If the program being executed requests user input, use an asynchronous command instead
<command> elements may contain the following attributes;
XML Attribute Description Allowed Values
success-codes Defines the integer values used to determine if the command executed successfully A comma seperated list of integer values. This attribute is optional, and if it is not present, the success code of '0' is assumed

The inner text of the XML element defines the command line to be executed. Export and password operations support value declarations in the command line. Global and import operations do not support the use of value declarations in the command text.

Command Behaviour

The <command> element may expose additional functionality depending on the context of the operation it is executing in.

Example

<command success-codes="0,2">cp /etc/passwd /usr/tmp/passwd</command>
The example above executes a copy command, which is deemed successful if the command exits with a return code of either 0 or 2.

Last edited Sep 21, 2013 at 4:11 AM by ryannewington, version 4