agentupdate utility reference

The utility offers several command-line options and environment variables to control its behavior.

This table presents the command-line options in alphabetical order.


Option	Required	Description
`–debug`	No	Enables extended debugging output. You can also enable debugging by setting the DEBUG environment variable to any value. For information about precedence, see Precedence of XML file parameters, command-line options, and environment variables.
`–encrypt`	No	Replaces the cleartext passwords in the XML file with encrypted forms of the passwords.
`–genkey <key_file>`	No	Generates a secret key for encryption and decryption of passwords. When you specify the `–genkey` option, you must also specify the `–keyfile <key_file>` option to store the key in the specified file.
`–keyfile <key_file>`	No	Holds the key for encryption and decryption of passwords. You can also specify this file by setting the `KeyFile` XML file parameter. For information about precedence, see Precedence of XML file parameters, command-line options, and environment variables.
`–logFile <log_file>`	No	Specifies the file where the utility logs messages. By default, the name is RemoteAgentDeployerUpdater_Log.txt.
`–maxThreads`	No	Sets the maximum number of threads that the utility uses when running. By default, it is set to two times the number of processor cores in the host hardware.
`–preview`	No	Lists, without running, the commands the utility would run for each target.
`–sourceDir <path>`	No	Specifies the directory where the agent installers (in the .exe, .rpm, and .gz forms) for the various platforms are saved. The `agentupdate` utility determines the operating system for each target and then uses the corresponding agent installer from this directory. Note: This utility uses the agent installer programs. It does not use the agent source code. You can also specify this directory by setting the `SourceDirectory` XML file parameter or the SOURCEDIR environment variable. For information about precedence, see Precedence of XML file parameters, command-line options, and environment variables.
`–targets <XML_file>`	Yes	Specifies the path and file name for the XML file that you created to indicate the target computers on which to update or install IBM Rational Build Forge agents.

This table describes the environment variables.


Environment variable	Required	Description
DEBUG	No	Enables extended debugging output. You can also enable debugging by specifying the `–debug` command-line option. For information about precedence, see Precedence of XML file parameters, command-line options, and environment variables.
SOURCEDIR	No	Specifies the directory where the agent installers (in the .exe, .rpm, and .gz forms) for the various platforms are saved. The `agentupdate` utility determines the operating system for each target and then uses the corresponding agent installer from this directory. Note: This utility uses the agent installer programs. It does not use the agent source code. You can also specify this directory by setting the `SourceDirectory` XML file parameter or the `–sourceDir` command-line option. For information about precedence, see Precedence of XML file parameters, command-line options, and environment variables.