udclient [global-args...] [global-flags...] <command> [args...]
以下の表に、コマンドのグローバル・パラメーターのリストを示します。これらのグローバル・パラメーターは、コード例では [global-args...] のようにリストされます。
| 引数 | 説明 |
|---|---|
| -authtoken、--authtoken | これはオプションです。DS_AUTH_TOKEN 環境変数を使用して設定できます。サーバーが生成する認証トークン (authtoken)。authtoken、またはユーザー名とパスワードのいずれかが必要です。 |
| -password、--password | これはオプションです。DS_PASSWORD 環境変数を使用して設定できます。サーバーで認証するパスワード。authtoken、またはユーザー名とパスワードのいずれかが必要です。 |
| -username、--username | これはオプションです。DS_USERNAME 環境変数を使用して設定できます。サーバーで認証するユーザー名。authtoken、またはユーザー名とパスワードのいずれかが必要です。 |
| -weburl、--weburl | これは必須です。DS_WEB_URL 環境変数を使用して設定できます。IBM® UrbanCode Deploy サーバーのベース URL。 例えば http://ds.example.com:8585 などです。 |
以下の表にグローバル・フラグを示します。これらのグローバル・フラグは、コード例では [global-flags...] のようにリストされます。
| フラグ | 説明 |
|---|---|
| -t、--getTemplate | コマンドを実行する代わりに、そのコマンド用の JSON テンプレートを表示します。ファイル引数が提供されている場合、テンプレートは指定されたファイルに出力されます。 |
| -h、--help | コマンドを実行する代わりに、そのコマンドの完全な説明とヘルプを表示します。 |
| -v、--verbose | 追加の情報を表示します。 |
アプリケーション、コンポーネント、エージェント、およびリソースといったオブジェクトをコマンド行で指定するときは、そのオブジェクトの名前もしくはオブジェクト ID を使用できます。オブジェクトの ID は、IBM UrbanCode Deploy でオブジェクトをインスペクションする際に表示される URL の一部です。例えば特定のコンポーネントを参照し、その URL が https://ucdeploy.example.com:8443/#component/2f153e93-00c3-44ef-a7fd-87e544e698d4 であったとすれば、そのコンポーネントの ID は 2f153e93-00c3-44ef-a7fd-87e544e698d4 です。
udclient -weburl http://localhost:8080 -username admin -password admin getResources