Command Format

To perform a command, open a command window and invoke udclient along with the command and parameters. Command's have the following format:

udclient [global-args...] [global-flags...] <command> [args...]

The global arguments are:

Table 76. 

Argument Description
-authtoken, --authtoken Optional. Can be set via the environment variable DS_AUTH_TOKEN. An authentication token generated by the server. Either an authtoken or a username and password is required.
-password, --password Optional. Can be set via the environment variable DS_PASSWORD. A password to authenticate with the server. Either an authtoken or a username and password is required.
-username, --username Optional. Can be set via the environment variable DS_USERNAME. A username to authenticate with the server. Either an authtoken or a username and password is required.
-weburl, --weburl Required. Can be set via the environment variable DS_WEB_URL. The base URL of the Serena Release Automation server— http://ds.domain.com:8585.

The global flags are:

Table 77. 

Flag Description
-t, --getTemplate Show the JSON template for the command instead of running the command. If a file argument is provided, the template will be output to that file.
-h, --help Print the full description and help of the given command instead of running the command.
-v, --verbose Print extra information during execution.

Note

CLI commands and parameters are case sensitive.

Here is an example using the getResources command:

udclient -weburl http://localhost:8080 -username admin -password admin getResources

loading table of contents...