Files

Kristal Dale 859c02a692 Add initial CLI ref content

Add initial content for CLI commands: system, fm,
dcmanager

Story: 2006888
Task: 37501

Change-Id: I334bd4e9657abcfc7928b8706bc4aedee02a97da
Signed-off-by: Kristal Dale <kristal.dale@intel.com>

2019-12-06 11:54:51 -08:00

3.0 KiB

Raw Blame History

dcmanager

dcmanager is the command-line interface for the Distributed Cloud Manager APIs.

This page documents the dcmanager command in StarlingX R3.0.

dcmanager usage

dcmanager [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug]
              [--dcmanager-url DCMANAGER_URL]
              [--dcmanager-api-version DCMANAGER_VERSION]
              [--dcmanager-service-type SERVICE_TYPE]
              [--os-endpoint-type ENDPOINT_TYPE] [--os-username USERNAME]
              [--os-password PASSWORD] [--os-tenant-id TENANT_ID]
              [--os-project-id PROJECT_ID] [--os-tenant-name TENANT_NAME]
              [--os-project-name PROJECT_NAME] [--os-auth-token TOKEN]
              [--os-project-domain-name PROJECT_DOMAIN_NAME]
              [--os-project-domain-id PROJECT_DOMAIN_ID]
              [--os-user-domain-name USER_DOMAIN_NAME]
              [--os-user-domain-id USER_DOMAIN_ID] [--os-auth-url AUTH_URL]
              [--os-cacert CACERT] [--insecure] [--profile HMAC_KEY]
              <subcommand> ...

For a list of all dcmanager subcommands and options, enter:

dcmanager help

Subcommands

For a full description of usage and optional arguments for a specific dcmanager command, enter:

dcmanager help COMMAND

Distributed cloud centralized alarms

alarm summary: List alarm summaries of subclouds.

Distributed cloud subcloud installation

subcloud add: Add a new subcloud.
subcloud delete: Delete subcloud details from the database.
subcloud list: List subclouds.
subcloud manage: Manage a subcloud.
subcloud show: Show the details of a subcloud.
subcloud unmanage: Unmanage a subcloud.
subcloud update: Update attributes of a subcloud.

Distributed cloud patching and updating

Important

The following commands are not supported upstream.

patch-strategy abort: Abort a patch strategy.
patch-strategy apply: Apply a patch strategy.
patch-strategy create: Create a patch strategy.
patch-strategy delete: Delete patch strategy from the database.
patch-strategy show: Show the details of a patch strategy for a subcloud.
patch-strategy-config delete: Delete per subcloud patch options.
patch-strategy-config list: List patch options.
patch-strategy-config show: Show patch options, defaults or per subcloud.
patch-strategy-config update: Update patch options, defaults or per subcloud.
strategy-step list: List strategy steps.
strategy-step show: Show the details of a strategy step.

3.0 KiB Raw Blame History