(DOCSP-12724)(DOCSP-12741)(DOCSP-12753)(DOCSP-12754)(DOCSP-12755) om admin backup s3 commands (#386)

* (DOCSP-12724)(DOCSP-12741)(DOCSP-12753)(DOCSP-12754)(DOCSP-12755) om admin backup s3 commands

Author: zach-carr

source/reference/ops-manager/admin-backup-s3-create.txt

@@ -0,0 +1,298 @@
+.. _mcli-om-admin-backup-s3-create-cmd:
+
+===========================================
+mongocli ops-manager admin backup s3 create
+===========================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+.. include:: /includes/admonitions/admin-requires-global-owner.rst
+
+The ``admin backup s3 create`` command creates a new backup 
+:opsmgr:`S3 blockstore </reference/glossary/#term-s3-snapshot-store>` 
+configuration for your |onprem| deployment. You can also create an 
+|s3| configuration using the :opsmgr:`UI </tutorial/manage-s3-blockstore-storage/#add-one-s3-snapshot-store>` and the
+:opsmgr:`API </reference/api/admin/backup/snapshot/s3Configs/create-one-s3-blockstore-configuration/>`.
+
+.. _mcli-om-admin-backup-s3-create-syntax:
+
+Syntax 
+------
+
+.. code-block:: shell
+
+   mongocli ops-manager|om admin backup s3 create
+        --acceptedTos
+        [ --assignment ]
+        [ --awsAccessKey <access-key-id> ]
+        [ --awsSecretKey <secret-access-key> ]
+        [ --disableProxyS3 ]
+        [ --encryptedCredentials ]
+        [ --label <tags> ]
+        [ --loadFactor <number-of-backup-jobs> ]
+        --name <s3-name>
+        [ --output|-o ]
+        [ --pathStyleAccessEnabled ]
+        [ --profile|-P <profile-name> ]
+        --s3AuthMethod <KEYS|IAM_ROLE>
+        --s3BucketEndpoint <bucket-url>
+        --s3BucketName <bucket-name>
+        --s3MaxConnections <number-of-connections>
+        [ --sseEnabled ]
+        --uri <hosts>
+        [ --writeConcern <write-concern> ]
+
+.. _mcli-om-admin-backup-s3-create-options: 
+
+Options
+-------
+
+.. list-table::
+   :widths: 20 10 60 10
+   :header-rows: 1
+
+   * - Option
+     - Type
+     - Description
+     - Required?
+
+   * - ``--acceptedTos``
+     - 
+     - Flag indicating that you accept the terms of service 
+       for using S3-compatible stores with |mms|.
+     - yes
+
+   * - ``--assignment``
+     - 
+     - Flag that indicates this :opsmgr:`S3 blockstore 
+       </reference/glossary/#term-s3-snapshot-store>` can be assigned 
+       backup jobs.
+     - no
+
+   * - ``--awsAccessKey``
+     - string
+     - AWS Access Key ID that can access the S3 bucket. 
+     
+       If ``s3AuthMethod`` is ``IAM_ROLE``, you do not need to include 
+       ``awsAccessKey``.
+     - no
+
+   * - ``--awsSecretKey``
+     - string
+     - AWS Secret Access Key that can access the S3 bucket. 
+     
+       If ``s3AuthMethod`` is ``IAM_ROLE``, you do not need to include 
+       ``awsSecretKey``.
+     - no
+
+   * - ``--disableProxyS3``
+     -
+     - Flag indicating whether the |http| proxy should be used when 
+       connecting to S3.
+     - no
+
+   * - ``--encryptedCredentials``
+     - 
+     - Flag that indicates whether the username and password for this 
+       |s3| were encrypted using the :opsmgr:`credentialstool 
+       </tutorial/encrypt-user-credentials/>`.
+     - no
+
+   * - ``--label``
+     - array of strings
+     - Array of tags that specify which :opsmgr:`backup jobs 
+       </reference/glossary/#term-backup-job>` |onprem| can assign 
+       to which :opsmgr:`S3s 
+       </reference/glossary/#term-s3-snapshot-store>`. If omitted, this 
+       |s3| can only process the backup jobs for projects that 
+       don't use labels to filter their jobs.
+     - no
+
+   * - ``--loadFactor``
+     - number
+     - Required if more than one snapshot store is in use.
+     
+       Number that expresses how much backup work this 
+       :opsmgr:`snapshot store </reference/glossary/#term-snapshot-store>` should perform compared to another 
+       snapshot store. Value must be a positive, non-zero integer.
+
+       .. seealso::
+       
+          To learn more about **Load Factor**, see 
+          :opsmgr:`Edit an Existing S3 </tutorial/manage-s3-blockstore-storage/#update-any-values-that-need-to-be-changed>`.
+     - no
+
+   * - ``--name``
+     - string
+     - Name of the |s3| blockstore configuration.
+     - yes
+
+   * - ``--output``, ``-o``
+     - string 
+     - .. include:: /includes/extracts/fact-basic-options-output.rst
+     - no
+
+   * - ``--pathStyleAccessEnabled``
+     - 
+     - Flag indicating that ``s3BucketEndpoint`` uses a path-style URL.
+     - no
+
+   * - ``--profile``, ``-P``
+     - string
+     - Name of the profile where the public and private 
+       keys for accessing |onprem| are saved. If omitted, uses the 
+       {+default-profile+}. To learn more about creating a 
+       profile, see :ref:`mcli-configure`.
+     - no
+
+   * - ``--s3AuthMethod``
+     - string
+     - Method used to authorize access to the |s3| bucket specified 
+       with ``s3BucketName``. Accepted values for this option are: 
+       
+       - ``KEYS`` 
+       - ``IAM_ROLE``
+     - yes
+
+   * - ``--s3BucketEndpoint``
+     - string
+     - URL used to access this |aws| |s3| or S3-compatible bucket.
+     - yes
+
+   * - ``--s3BucketName``
+     - string
+     - Name of this |aws| |s3| or S3-compatible bucket.
+     - yes
+
+   * - ``--s3MaxConnections``
+     - integer
+     - Positive integer indicating the maximum number of connections to 
+       this |s3| blockstore.
+     - yes
+
+   * - ``--sseEnabled``
+     -
+     - Flag indicating whether this |s3| blockstore enables server-side 
+       encryption.
+     - no
+
+   * - ``--uri``
+     - string
+     - Comma-separated list of hosts in the ``<hostname:port>`` 
+       format to use to access this :opsmgr:`S3 
+       </reference/glossary/#term-s3-snapshot-store>`.
+     - yes
+
+   * - ``--writeConcern``
+     - string
+     - :manual:`Write concern </reference/write-concern/>` to use for 
+       this :opsmgr:`S3 
+       </reference/glossary/#term-s3-snapshot-store>`. Valid values are: 
+
+       - ``ACKNOWLEDGED``
+       - ``W2``
+       - ``JOURNALED``
+       - ``MAJORITY``
+
+     - no
+
+.. _mcli-om-admin-backup-s3-create-output: 
+
+Output 
+------
+
+.. include:: /includes/command-output-intro.rst
+
+.. code-block:: sh 
+   :copyable: false 
+
+   s3 configuration '<s3-name>' created.
+
+If you request output in |json| format, the command returns the fields 
+described in the 
+:opsmgr:`API reference </reference/api/admin/backup/snapshot/s3Configs/create-one-s3-blockstore-configuration/#response>`.
+
+.. _mcli-om-admin-backup-s3-create-egs:
+
+Examples 
+--------
+
+.. tabs:: 
+
+   .. tab:: Default Output 
+      :tabid: default 
+
+      The following ``mongocli om admin backup s3 create`` command 
+      creates the ``s3BackupExample`` |s3| blockstore configuration 
+      using the {+default-profile+}, which contains the 
+      :authrole:`Global Owner` credentials for accessing |mms|.
+
+      .. code-block:: shell
+     
+         mongocli om admin backup s3 create s3BackupExample \
+         --acceptedTos \
+         --s3AuthMethod KEYS \
+         --awsAccessKey access \
+         --awsSecretKey secret \
+         --s3BucketEndpoint https://s3.us-east-1.amazonaws.com/bucketExample/ \
+         --s3BucketName bucketExample \
+         --uri mongodb://127.0.0.1:27017 \
+         --s3MaxConnections 50
+
+      The previous command returns the following:
+
+      .. code-block:: shell
+         :copyable: false
+
+         s3 configuration 's3BackupExample' created.
+      
+   .. tab:: JSON Output 
+      :tabid: json 
+
+      The following ``mongocli om admin backup s3 create`` command 
+      creates the ``s3BackupExample`` |s3| blockstore configuration 
+      using the {+default-profile+}, which contains the 
+      :authrole:`Global Owner` credentials for accessing |mms|. The 
+      output is returned in |json| format.
+
+      .. code-block:: shell
+     
+         mongocli om admin backup s3 create s3BackupExample \
+         --acceptedTos \
+         --s3AuthMethod KEYS \
+         --awsAccessKey access \
+         --awsSecretKey secret \
+         --s3BucketEndpoint https://s3.us-east-1.amazonaws.com/bucketExample/ \
+         --s3BucketName bucketExample \
+         --uri mongodb://127.0.0.1:27017 \
+         --s3MaxConnections 50 \
+         --output json
+
+      The previous command returns the following:
+
+      .. code-block:: json
+         :copyable: false
+
+         {
+           "id": "s3BackupExample",
+           "uri": "mongodb://127.0.0.1:27017",
+           "ssl": false,
+           "assignmentEnabled": true,
+           "encryptedCredentials": false,
+           "loadFactor": 1,
+           "awsAccessKey": "access",
+           "awsSecretKey": "secret",
+           "s3BucketEndpoint": "https://s3.us-east-1.amazonaws.com/bucketExample/",
+           "s3BucketName": "bucketExample",
+           "s3MaxConnections": 50,
+           "disableProxyS3": false,
+           "acceptedTos": true,
+           "sseEnabled": false,
+           "pathStyleAccessEnabled": false
+         }