Command format

To run a command, open a command window and start the udclient 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. These global parameters are listed as [global-args...] in code examples.

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

The following table shows the global flags. These global flags are listed as [global-flags...] in code examples.

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 the specified 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.

When you specify objects such as applications, components, agents, and resources on the command line, you can use the name of the object or the object ID. The ID of an object is part of the URL that is displayed when you inspect the object in IBM UrbanCode Deploy. For example, if you browse to a specific component and the URL is https://ucdeploy.example.com:8443/#component/2f153e93-00c3-44ef-a7fd-87e544e698d4, then the ID of the component is 2f153e93-00c3-44ef-a7fd-87e544e698d4.

This example shows the getResources command:
udclient -weburl http://localhost:8080 -username admin -password admin getResources

Feedback