Skip to content

Commit 23fca93

Browse files
kanchana-mongodbkanchana-mongodb
authored
DOCSP-12529 doc for mongocli backup config commands (#299)
* DOCSP-12529 doc for mongocli backup config commands * DOCSP-12529 updates for copy review feedback
1 parent c67c1d8 commit 23fca93

File tree

8 files changed

+1236
-0
lines changed

8 files changed

+1236
-0
lines changed

‎source/reference/cloud-manager/backup-commands.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,6 @@ Cloud Manager ``backup`` Commands
1313
List Backup Snapshots </reference/cloud-manager/backup-snapshots-list>
1414
List Backup Checkpoints </reference/cloud-manager/backup-checkpoints-list>
1515
List Backup Restore Jobs </reference/cloud-manager/backup-restore-list>
16+
List Backup Configurations for One Project </reference/cloud-manager/backup-config-list>
17+
Update One Backup Configuration </reference/cloud-manager/backup-config-update>
18+
Describe One Backup Configuration </reference/cloud-manager/backup-config-describe>

‎source/reference/cloud-manager/backup-config-describe.txt

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
.. _mcli-cm-backup-config-describe-cmd:
2+
3+
=============================================
4+
mongocli cloud-manager backup config describe
5+
=============================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
The ``backup config describe`` command retrieves the backup
16+
configuration details for the specified cluster. You can also retrieve
17+
the backup configuration details for a cluster using the :cloudmgr:`API
18+
</reference/api/backup/get-one-backup-config-by-cluster-id/>`.
19+
20+
.. _mcli-cm-backup-config-describe-syntax:
21+
22+
Syntax
23+
------
24+
25+
.. code-block:: shell
26+
27+
mongocli cloud-manager|cm backup config describe|get <cluster-ID>
28+
[ --output|-o <output-format> ]
29+
[ --profile|-P <profile-name> ]
30+
[ --projectId <project-ID> ]
31+
32+
.. _mcli-cm-backup-config-describe-args:
33+
34+
Arguments
35+
---------
36+
37+
.. list-table::
38+
:header-rows: 1
39+
:widths: 20 10 60 10
40+
41+
* - Argument
42+
- Type
43+
- Description
44+
- Required?
45+
46+
* - ``<cluser-ID>``
47+
- string
48+
- Unique identifier of the cluster whose backup
49+
configuration you want to retrieve. You can use the
50+
:ref:`mcli-om-cluster-list-command` to retrieve the
51+
ID of a cluster.
52+
- yes
53+
54+
55+
.. _mcli-cm-backup-config-describe-options:
56+
57+
Options
58+
-------
59+
60+
.. list-table::
61+
:header-rows: 1
62+
:widths: 20 10 60 10
63+
64+
* - Option
65+
- Type
66+
- Description
67+
- Required?
68+
69+
* - ``--output``, ``-o``
70+
- string
71+
- .. include:: /includes/extracts/fact-basic-options-output.rst
72+
- no
73+
74+
* - ``--profile``, ``-P``
75+
- string
76+
- Name of the profile where the project ID and the |svc-api-key|\s
77+
for the project are saved. If omitted, uses the
78+
{+default-profile+}. To learn more about creating a profile, see
79+
:ref:`mcli-configure`.
80+
- no
81+
82+
* - ``--projectId``
83+
- string
84+
- Unique identifier of the project. If omitted, uses the project
85+
ID in the profile or :ref:`environment variable <mcli-env-var>`.
86+
- no
87+
88+
.. _mcli-cm-backup-config-describe-output:
89+
90+
Output
91+
------
92+
93+
If the command succeeds, it returns the following output in the default
94+
format. If the command returns errors, see :ref:`Troubleshooting
95+
<mcli-troubleshooting>` for recommended solutions.
96+
97+
.. code-block:: sh
98+
:copyable: false
99+
100+
PROJECT ID CLUSTER ID STATUS STORAGE ENGINE
101+
<project-ID> <cluster-ID> <status> <storage-engine>
102+
103+
The default output contains a subset of the fields returned by this
104+
command. For the complete list of |json| fields returned by the
105+
command, see the :atlas:`API reference
106+
</reference/api/backup/get-one-backup-config-by-cluster-id/#response>`.
107+
108+
.. _mcli-cm-backup-config-describe-egs:
109+
110+
Example
111+
-------
112+
113+
The following example uses the ``mongocli cloud-manager backups config
114+
describe`` command to retrieve the backup configuration details for the
115+
specified cluster. The command uses the {+default-profile+} to access
116+
the project.
117+
118+
.. tabs::
119+
120+
.. tab:: Default Output
121+
:tabid: default
122+
123+
.. code-block:: shell
124+
125+
mongocli cloud-manager backup config describe 5faadea78f65437924572d63
126+
127+
The previous command returns the following:
128+
129+
.. code-block:: shell
130+
:copyable: false
131+
132+
PROJECT ID CLUSTER ID STATUS STORAGE ENGINE
133+
5e84b94c003f2d6370004f4e 5faadea78f65437924572d63 STARTED WIRED_TIGER
134+
135+
.. tab:: JSON Output
136+
:tabid: json
137+
138+
.. code-block:: shell
139+
140+
mongocli cloud-manager backup config describe 5faadea78f65437924572d63 --output json
141+
142+
The previous command returns the following:
143+
144+
.. code-block:: shell
145+
:copyable: false
146+
147+
{
148+
"groupId": "5e84b94c003f2d6370004f4e",
149+
"clusterId": "5faadea78f65437924572d63",
150+
"statusName": "STARTED",
151+
"storageEngineName": "WIRED_TIGER",
152+
"authMechanismName": "NONE",
153+
"encryptionEnabled": false,
154+
"sslEnabled": false
155+
}

‎source/reference/cloud-manager/backup-config-list.txt

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
.. _mcli-cm-backup-config-list-cmd:
2+
3+
=========================================
4+
mongocli cloud-manager backup config list
5+
=========================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
The ``backup config list`` command lists all the backup
16+
configurations for a project. You can also retrieve the
17+
backup configurations for a project using the :cloudmgr:`API
18+
</reference/api/backup/get-all-backup-configs-for-group/>`.
19+
20+
.. _mcli-cm-backup-config-list-syntax:
21+
22+
Syntax
23+
------
24+
25+
.. code-block:: shell
26+
27+
mongocli cloud-manager|cm backup config list|ls
28+
[ --limit <items-per-page>]
29+
[ --output|-o <output-format> ]
30+
[ --page <page-num> ]
31+
[ --profile|-P <profile-name> ]
32+
[ --projectId <project-ID> ]
33+
34+
.. _mcli-cm-backup-config-list-options:
35+
36+
Options
37+
-------
38+
39+
.. list-table::
40+
:header-rows: 1
41+
:widths: 20 10 60 10
42+
43+
* - Option
44+
- Type
45+
- Description
46+
- Required?
47+
48+
* - ``--limit``
49+
- integer
50+
- Number of items to return per page, up to a maximum of 500.
51+
Defaults to ``100`` if not specified.
52+
- no
53+
54+
* - ``--output``, ``-o``
55+
- string
56+
- .. include:: /includes/extracts/fact-basic-options-output.rst
57+
- no
58+
59+
* - ``--profile``, ``-P``
60+
- string
61+
- Name of the profile where the project ID and the |svc-api-key|\s
62+
for the project are saved. If omitted, uses the
63+
{+default-profile+}. To learn more about creating a profile, see
64+
:ref:`mcli-configure`.
65+
- no
66+
67+
* - ``--projectId``
68+
- string
69+
- Unique identifier of the project. If omitted, uses the project
70+
ID in the profile or :ref:`environment variable <mcli-env-var>`.
71+
- no
72+
73+
* - ``--page``
74+
- integer
75+
- Page number (1-based). Defaults to ``1`` if not specified.
76+
- no
77+
78+
.. _mcli-cm-backup-config-list-output:
79+
80+
Output
81+
------
82+
83+
If the command succeeds, it returns the following output in the default
84+
format. If the command returns errors, see :ref:`Troubleshooting
85+
<mcli-troubleshooting>` for recommended solutions.
86+
87+
.. code-block:: sh
88+
:copyable: false
89+
90+
PROJECT ID CLUSTER ID STATUS STORAGE ENGINE
91+
<project-ID> <cluster-ID> <status> <storage-engine>
92+
93+
The default output contains a subset of the fields returned by this
94+
command. For the complete list of |json| fields returned by the
95+
command, see the :atlas:`API reference
96+
</reference/api/backup/get-all-backup-configs-for-group/#response>`.
97+
98+
.. _mcli-cm-backup-config-list-egs:
99+
100+
Example
101+
-------
102+
103+
The following example uses the ``mongocli cloud-manager backups config
104+
list`` command to retrieve the backup configurations for the project
105+
specified through the {+default-profile+}.
106+
107+
.. tabs::
108+
109+
.. tab:: Default Output
110+
:tabid: default
111+
112+
.. code-block:: shell
113+
114+
mongocli cloud-manager backup config list
115+
116+
The previous command returns the following:
117+
118+
.. code-block:: shell
119+
:copyable: false
120+
121+
PROJECT ID CLUSTER ID STATUS STORAGE ENGINE
122+
5e84b94c003f2d6370004f4e 5faadea78f65437924572d63 STARTED WIRED_TIGER
123+
124+
.. tab:: JSON Output
125+
:tabid: json
126+
127+
.. code-block:: shell
128+
129+
mongocli cloud-manager backup config list --output json
130+
131+
The previous command returns the following:
132+
133+
.. code-block:: shell
134+
:copyable: false
135+
136+
{
137+
"links": [
138+
{
139+
"rel": "self",
140+
"href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/backupConfigs?pageNum=1\u0026itemsPerPage=100"
141+
}
142+
],
143+
"results": [
144+
{
145+
"groupId": "5e84b94c003f2d6370004f4e",
146+
"clusterId": "5faadea78f65437924572d63",
147+
"statusName": "STARTED",
148+
"storageEngineName": "WIRED_TIGER",
149+
"authMechanismName": "NONE",
150+
"encryptionEnabled": false,
151+
"sslEnabled": false
152+
}
153+
],
154+
"totalCount": 1
155+
}

0 commit comments

Comments
 (0)