Command format

To run a command, open a command window and start udclient along with the command and parameters.
Commands have the following format:
udclient [global-args...] [global-flags...] <command> [args...]

The following table lists the global parameters for the commands:

Table 1. Global parameters
Argument Description
-authtoken, --authtoken Optional. Can be set with the environment variable DS_AUTH_TOKEN. An authentication token that is generated by the server. Either an authtoken or a user name and password is required.
-password, --password Optional. Can be set with the environment variable DS_PASSWORD. A password to authenticate with the server. Either an authtoken or a user name and password is required.
-username, --username Optional. Can be set with the environment variable DS_USERNAME. A user name to authenticate with the server. Either an authtoken or a user name and password is required.
-weburl, --weburl Required. Can be set with the environment variable DS_WEB_URL. The base URL of the IBM® UrbanCode Deploy server: http://ds.domain.com:8585.

The following table shows the global flags:

Table 2. Global flags
Flag Description
-t, --getTemplate Show the JSON template for the command instead of running the command. If a file argument is provided, the template is output to that file.
-h, --help Print the full description and help of the command instead of running the command.
-v, --verbose Print extra information.
Note: CLI commands and parameters are case-sensitive.
Here is an example that shows the getResources command:
udclient -weburl http://localhost:8080 -username admin -password admin getResources

Feedback