.. _mongocli-ops-manager-backups-config-update:

==========================================
mongocli ops-manager backups config update
==========================================

.. default-domain:: mongodb

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

Update a backup configuration.

Syntax
------

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

   mongocli ops-manager backups config update <clusterId> [options]

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

Arguments
---------

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

   * - Name
     - Type
     - Required
     - Description
   * - clusterId
     - string
     - true
     - ID of the cluster.

Options
-------

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

   * - Name
     - Type
     - Required
     - Description
   * - --authMechanism
     - string
     - false
     - Authentication mechanism needed to connect to the sync source database.
   * - --encryption
     - 
     - false
     - Flag that indicates if encryption is enabled for the backup configuration.
   * - --excludedNamespace
     - strings
     - false
     - List of database names and collection names to omit from the backup. Passing this flag replaces preexisting data.
   * - -h, --help
     - 
     - false
     - help for update
   * - --includedNamespace
     - strings
     - false
     - List of database names and collection names to include in the backup. Passing this flag replaces preexisting data.
   * - -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.
   * - --password
     - string
     - false
     - Password for the user.
   * - --projectId
     - string
     - false
     - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
   * - --provisioned
     - 
     - false
     - Flag that indicates if Ops Manager has provisioned the resources needed to store a backup.
   * - --ssl
     - 
     - false
     - Flag that indicates if TLS is enabled for the sync source database.
   * - --status
     - string
     - false
     - Status of the backup configuration.
   * - --storageEngine
     - string
     - false
     - Storage engine for the backup.
   * - --syncSource
     - string
     - false
     - mongod instance from which you retrieve backup data.
   * - --username
     - string
     - false
     - Name that identifies the user. You must specify a valid email address.

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.

