.. _mongocli-ops-manager-standby-clusters-describe:

==============================================
mongocli ops-manager standby-clusters describe
==============================================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Return the current disaster recovery state of your standby cluster.

Reads the DR state file directly from Amazon S3 and prints it. Use
'-o json' for the full document.

Syntax
------

.. code-block::
   :caption: Command Syntax

   mongocli ops-manager standby-clusters describe [options]

.. Code end marker, please don't delete this comment

Options
-------

.. list-table::
   :header-rows: 1
   :widths: 20 10 10 60

   * - Name
     - Type
     - Required
     - Description
   * - --awsAccessKey
     - string
     - false
     - AWS Access Key ID that can access the Amazon S3 bucket specified in s3BucketName.
   * - --awsAuthMode
     - string
     - false
     - AWS authentication mode for standby cluster commands. Valid values are staticCredentials, assumeRole, or credentialsChain.
   * - --awsProfile
     - string
     - false
     - Named AWS profile from the shared AWS config files to use with the default credentials chain, including AWS SSO profiles after aws sso login.
   * - --awsRegion
     - string
     - false
     - AWS region of the Amazon S3 bucket that holds the standby cluster DR state file. Defaults to us-east-1; any value works for S3-compatible stores.
   * - --awsRoleArn
     - string
     - false
     - AWS IAM role ARN to assume for standby cluster commands. Required when awsAuthMode is assumeRole.
   * - --awsSecretKey
     - string
     - false
     - AWS Secret Access Key that can access the Amazon S3 bucket specified in s3BucketName.
   * - -h, --help
     - 
     - false
     - help for describe
   * - -o, --output
     - string
     - false
     - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
   * - --s3BucketEndpoint
     - string
     - false
     - URL of an S3-compatible endpoint for the standby cluster DR state file. Use only for S3-compatible stores.
   * - --s3BucketName
     - string
     - false
     - Name of the Amazon S3 bucket that holds the standby cluster DR state file.
   * - --s3Key
     - string
     - false
     - Object key of the standby cluster DR state file, for example <clusterPrefix>/dr_status_<componentId>.json.

Inherited Options
-----------------

.. list-table::
   :header-rows: 1
   :widths: 20 10 10 60

   * - Name
     - Type
     - Required
     - Description
   * - -P, --profile
     - string
     - false
     - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Examples
--------

.. code-block::
   :copyable: false

   # Return the current DR state of the standby cluster:
   mongocli ops-manager standby-clusters describe

   
.. code-block::
   :copyable: false

   # Return the full DR state document as JSON:
   mongocli ops-manager standby-clusters describe -o json
