docs/doc/source/cli_ref/dcmanager.rst

=========
dcmanager
=========

.. include:: /shared/_includes/cli-ref-intro-dcmanager.rest

.. contents::
   :local:
   :depth: 2

---------------
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 :command:`dcmanager` subcommands and options, enter:

::

  dcmanager help

-----------
Subcommands
-----------

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

::

  dcmanager help COMMAND

************************************
Distributed cloud centralized alarms
************************************

Displays the aggregated counts of critical, major, minor, and warning alarms
across all subclouds.

``alarm summary``
  List alarm summaries of subclouds.

*******************************
Distributed subcloud management
*******************************

This set of commands provides subcloud management, including basic add, delete,
list, show, and update operations on a subcloud.

``subcloud add``
  Add a new subcloud.

  Note that this command will create the subcloud in the central cloud's
  database, run the Ansible bootstrap playbook on the new subcloud, and
  optionally run a deployment playbook.

``subcloud delete``
  Delete subcloud details from the database.

``subcloud deploy show``
    Show the uploaded deployment files.

``subcloud deploy upload``
    Upload the subcloud deployment files.

``subcloud-group add``
   Add a new subcloud group.

``subcloud-group delete``
   Delete subcloud group details from the database.

``subcloud-group list``
   List subcloud groups.

``subcloud-group list-subclouds``
   List subclouds referencing a subcloud group.

``subcloud-group show``
   Show the details of a subcloud group.

``subcloud-group update``
   Update attributes of a subcloud group.

``subcloud list``
  List subclouds.

``subcloud manage``
  Manage a subcloud. Enables the active synchronization of data between the
  central cloud and the subcloud.

``subcloud deploy config``
  Re-run the deployment playbook on a subcloud using an updated configuration
  file.

``subcloud redeploy``
    Redeploy a subcloud.

``subcloud restore``
    Restore a subcloud.

``subcloud show``
  Show the details of a subcloud.

``subcloud unmanage``
  Unmanage a subcloud. Disables the active synchronization of data between the
  central cloud and the subcloud.

``subcloud update``
  Update attributes of a subcloud.

***********************************
Distributed cloud patching/updating
***********************************

.. important::

   The following commands are not supported upstream.

The :command:`patch-strategy` commands create, apply, and monitor the
orchestration of software patch application (or updates) across all subclouds
and all hosts of subclouds. :command:`patch-strategy` commands orchestrate
software updates across an entire distributed cloud solution.

``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.

***********************************
Distributed cloud firmware updating
***********************************

The following set of commands create, apply, and monitor the orchestration of
N3000 |FPGA| firmware load updating across all subclouds and all hosts of
subclouds.

``fw-update-strategy abort``
    Abort a firmware update strategy.

``fw-update-strategy apply``
    Apply a firmware update strategy.

``fw-update-strategy create``
    Create a firmware update strategy.

``fw-update-strategy delete``
    Delete firmware update strategy from the database.

``fw-update-strategy show``
    Show the details of a firmware update strategy for a subcloud.

**********************************************
Distributed cloud Kubernetes version upgrading
**********************************************

The following set of commands create, apply, and monitor the orchestration of
Kubernetes version upgrading across all subclouds and all hosts of subclouds.

``kube-upgrade-strategy abort``
    Abort a Kubernetes upgrade strategy.

``kube-upgrade-strategy apply``
    Apply a Kubernetes upgrade strategy.

``kube-upgrade-strategy create``
    Create a Kubernetes upgrade strategy.

``kube-upgrade-strategy delete``
    Delete Kubernetes upgrade strategy from the database.

``kube-upgrade-strategy show``
    Show the details of a Kubernetes upgrade strategy for a subcloud.