AAC Docs

aac tenant update-workload

AAC CLI 0.2.8MarkdownDocs 6b7d8268ba78

Set or clear a workload's display name.

Synopsis

aac tenant update-workload
  [-h]
  [--profile PROFILE]
  [--admin-url ADMIN_URL]
  [--data-plane-url DATA_PLANE_URL]
  [--output {json,table}]
  [--tenant-id TENANT_ID]
  --workload-id WORKLOAD_ID (--display-name DISPLAY_NAME | --clear-display-name)

Arguments

Argument Type Required Default Description
-h, --help flag no — show this help message and exit
--profile value no — Profile to run under (selection: --profile > AAC_PROFILE > reserved baseline main). aac profile list shows what exists.
--admin-url value no — Admin-surface base URL (overrides profile).
--data-plane-url value no — Data-plane-surface base URL (overrides profile).
--output json | table no json Output mode: json (the default) or table.
--tenant-id value no — Owning tenant (defaults to the selected profile identity).
--workload-id value yes — Opaque workload id from add/list output.
--display-name value no — Set the label to this 1-256 character value.
--clear-display-name flag no — Clear the label (sends JSON null).

Exactly one of --display-name, --clear-display-name may be given.

Output

--output json (the default) prints one JSON document to standard output; --output table prints a readable table instead. Progress notes and diagnostics go to standard error, so the JSON stays parseable.

Exit codes

Code Meaning
0 Success.
1 The control plane or the identity provider rejected the request.
2 Usage error: an invalid flag, value or flag combination.
3 A local configuration or state problem: profile, credential file, cached session or agent.
4 Transport failure: an endpoint could not be reached.

Notes

Only display_name is mutable, including after deactivation. Exactly one of --display-name or --clear-display-name is required.