Skip to content

Commit 7446e2c

Browse files
kanchana-mongodbkanchana-mongodb
authored
DOCSP-12628 doc for mongocli om backup blockstore commands (#303)
1 parent 23fca93 commit 7446e2c

File tree

3 files changed

+336
-0
lines changed

3 files changed

+336
-0
lines changed

‎source/reference/ops-manager/admin-backup-blockstore-delete.txt

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
.. _mcli-om-admin-backup-blockstore-delete-cmd:
2+
3+
===================================================
4+
mongocli ops-manager admin backup blockstore delete
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+
.. include:: /includes/styles/corrections.rst
16+
17+
The ``admin backup blockstore delete`` command deletes one
18+
backup blockstore configuration. You can also delete the
19+
one blockstore configuration using the :opsmgr:`API
20+
</reference/api/admin/backup/snapshot/mongoConfigs/delete-one-blockstore-configuration/>`.
21+
22+
.. _mcli-om-admin-backup-blockstore-delete-syntax:
23+
24+
Syntax
25+
------
26+
27+
.. code-block:: shell
28+
29+
mongocli ops-manager|om admin backup blockstore delete|rm <blockstore-ID>
30+
[ --force ]
31+
[ --output|-o <output-format> ]
32+
[ --profile|-p <profile-name> ]
33+
34+
.. _mcli-om-admin-backup-blockstore-update-args:
35+
36+
Arguments
37+
---------
38+
39+
.. list-table::
40+
:widths: 20 10 60 10
41+
:header-rows: 1
42+
43+
* - Option
44+
- Type
45+
- Description
46+
- Required?
47+
48+
* - ``<blockstore-ID>``
49+
- string
50+
- Unique name of the blockstore configuration to delete.
51+
- yes
52+
53+
.. _mcli-om-admin-backup-blockstore-delete-options:
54+
55+
Options
56+
-------
57+
58+
.. list-table::
59+
:header-rows: 1
60+
:widths: 20 10 60 10
61+
62+
* - Option
63+
- Type
64+
- Description
65+
- Required?
66+
67+
* - ``--force``
68+
-
69+
- Flag that indicates that the alert configuration can
70+
be deleted without requiring confirmation.
71+
- no
72+
73+
* - ``--output``, ``-o``
74+
- string
75+
- .. include:: /includes/extracts/fact-basic-options-output.rst
76+
- no
77+
78+
* - ``--profile``, ``-p``
79+
- string
80+
- Name of the profile where the public and private
81+
keys for the project are saved. If omitted, uses the
82+
{+default-profile+}. To learn more about creating a
83+
profile, see :ref:`mcli-configure`.
84+
- no
85+
86+
.. _mcli-om-admin-backup-blockstore-delete-output:
87+
88+
Output
89+
------
90+
91+
If successful, the command returns the following message:
92+
93+
.. code-block:: shell
94+
:copyable: false
95+
96+
Blockstore configuration '<blockstore-ID>' deleted
97+
98+
.. _mcli-om-admin-backup-blockstore-delete-egs:
99+
100+
Example
101+
-------
102+
103+
The following example uses the ``mongocli om admin backup blockstore
104+
delete`` command to delete the blockstore configuration
105+
``egblockstore``. The command uses the ``--force`` option to bypass the
106+
confirmation prompt and the {+default-profile+} to access |onprem|.
107+
108+
.. code-block:: sh
109+
110+
mongocli om admin backup blockstore delete egblockstore --force
111+
112+
The previous command returns the following:
113+
114+
.. code-block:: shell
115+
:copyable: false
116+
117+
Blockstore configuration 'test' deleted

‎source/reference/ops-manager/admin-backup-blockstore-update.txt

Lines changed: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
1+
.. _mcli-om-admin-backup-blockstore-update-cmd:
2+
3+
===================================================
4+
mongocli ops-manager admin backup blockstore update
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+
.. include:: /includes/styles/corrections.rst
16+
17+
The ``admin backup blockstore update`` command updates one
18+
backup blockstore configuration. You can also update the
19+
configuration using the :opsmgr:`API
20+
</reference/api/admin/backup/snapshot/mongoConfigs/update-one-blockstore-configuration/>`.
21+
22+
.. _mcli-om-admin-backup-blockstore-update-syntax:
23+
24+
Syntax
25+
------
26+
27+
.. code-block:: shell
28+
29+
mongocli ops-manager|om admin backup blockstore update <blockstore-ID>
30+
[ --assignment ]
31+
[ --encryptedCredentials ]
32+
[ --label <tags> ]
33+
[ --loadFactor <number-of-backup-jobs> ]
34+
[ --maxCapacityGB <amount-of-data> ]
35+
[ --output|-o <output-format> ]
36+
[ --profile|-P <profile-name> ]
37+
[ --ssl ]
38+
[ --uri <hosts> ]
39+
[ --writeConcern <write-concern> ]
40+
41+
.. _mcli-om-admin-backup-blockstore-update-args:
42+
43+
Arguments
44+
---------
45+
46+
.. list-table::
47+
:widths: 20 10 60 10
48+
:header-rows: 1
49+
50+
* - Option
51+
- Type
52+
- Description
53+
- Required?
54+
55+
* - ``<blockstore-ID>``
56+
- string
57+
- Unique name for this blockstore configuration.
58+
- yes
59+
60+
.. _mcli-om-admin-backup-blockstore-update-options:
61+
62+
Options
63+
-------
64+
65+
.. list-table::
66+
:widths: 20 10 60 10
67+
:header-rows: 1
68+
69+
* - Option
70+
- Type
71+
- Description
72+
- Required?
73+
74+
* - ``--assignment``
75+
-
76+
- Flag that indicates whether this :opsmgr:`blockstore
77+
</reference/glossary/#term-blockstore>` can be assigned backup
78+
jobs.
79+
- no
80+
81+
* - ``--encryptedCredentials``
82+
-
83+
- Flag that indicates whether the username and password for this
84+
blockstore were encrypted using the :opsmgr:`credentialstool
85+
</tutorial/encrypt-user-credentials/>`.
86+
- no
87+
88+
* - ``--label``
89+
- array of strings
90+
- Array of tags that specify which :opsmgr:`backup jobs
91+
</reference/glossary/#term-backup-job>` |onprem| can assign
92+
to which :opsmgr:`blockstores
93+
</reference/glossary/#term-blockstore>`. If omitted, this
94+
blockstore can only process the backup jobs for projects that
95+
do not use labels to filter their jobs.
96+
- no
97+
98+
* - ``--loadFactor``
99+
- number
100+
- Required if more than one snapshot store is in use.
101+
102+
Number of backup work this :opsmgr:`snapshot store
103+
</reference/glossary/#term-snapshot-store>` should perform
104+
compared to another snapshot store. Value must be a positive,
105+
non-zero integer.
106+
- no
107+
108+
* - ``--maxCapacityGB``
109+
- number
110+
- Maximum amount of data in GB that this :opsmgr:`blockstore
111+
</reference/glossary/#term-blockstore>` can store.
112+
- no
113+
114+
* - ``--output``, ``-o``
115+
- string
116+
- .. include:: /includes/extracts/fact-basic-options-output.rst
117+
- no
118+
119+
* - ``--profile``, ``-P``
120+
- string
121+
- Name of the profile where the public and private
122+
keys for the project are saved. If omitted, uses the
123+
{+default-profile+}. To learn more about creating a
124+
profile, see :ref:`mcli-configure`.
125+
- no
126+
127+
* - ``--ssl``
128+
-
129+
- Flag that indicates whether this :opsmgr:`blockstore
130+
</reference/glossary/#term-blockstore>` only accepts
131+
connections encrypted using |tls|.
132+
- no
133+
134+
* - ``--uri``
135+
- string
136+
- Comma-separated list of hosts in the ``<hostname:port>``
137+
format to use to access this :opsmgr:`blockstore
138+
</reference/glossary/#term-blockstore>`.
139+
- no
140+
141+
* - ``--writeConcern``
142+
- string
143+
- :manual:`Write concern </reference/write-concern/>` to use for
144+
this :opsmgr:`blockstore
145+
</reference/glossary/#term-blockstore>`. Valid values are:
146+
147+
- ``ACKNOWLEDGED``
148+
- ``W2``
149+
- ``JOURNALED``
150+
- ``MAJORITY``
151+
152+
- no
153+
154+
.. _mcli-om-admin-backup-blockstore-update-output:
155+
156+
Output
157+
------
158+
159+
If the command succeeds, it returns the following message in the default
160+
format. If the command returns errors, see
161+
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended solutions.
162+
163+
.. code-block:: sh
164+
:copyable: false
165+
166+
Blockstore configuration '<blockstore-ID>' updated.
167+
168+
If you request output in |json| format, the command returns the fields
169+
described in the :opsmgr:`API reference
170+
</reference/api/admin/backup/snapshot/mongoConfigs/update-one-blockstore-configuration/#response>`.
171+
172+
.. _mcli-om-admin-backup-blockstore-update-egs:
173+
174+
Examples
175+
--------
176+
177+
The following ``mongocli om admin backup blockstore update`` command
178+
updates the ``test`` blockstore using the {+default-profile+}, which contains the credentials for accessing |onprem|.
179+
180+
.. tabs::
181+
182+
.. tab:: Default Output
183+
:tabid: default
184+
185+
.. code-block:: shell
186+
187+
mongocli om admin backup blockstore update test --assignment --uri mongodb://localhost:29022
188+
189+
The previous command returns the following:
190+
191+
.. code-block:: shell
192+
:copyable: false
193+
194+
Blockstore configuration 'test' updated.
195+
196+
.. tab:: JSON Output
197+
:tabid: json
198+
199+
.. code-block:: shell
200+
201+
mongocli om admin backup blockstore update test --assignment --uri mongodb://localhost:29022 --output json
202+
203+
The previous command returns the following:
204+
205+
.. code-block:: shell
206+
:copyable: false
207+
208+
{
209+
"id": "test",
210+
"uri": "mongodb://localhost:29022",
211+
"ssl": false,
212+
"assignmentEnabled": true,
213+
"encryptedCredentials": false,
214+
"usedSize": 204800,
215+
"loadFactor": 1
216+
}

‎source/reference/ops-manager/admin-commands.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,6 @@ Ops Manager ``admin`` commands
1111

1212
List Backup Blockstore Configurations </reference/ops-manager/admin-backup-blockstore-list>
1313
Describe a Backup Blockstore Configuration </reference/ops-manager/admin-backup-blockstore-describe>
14+
Update One Backup Blockstore Configuration </reference/ops-manager/admin-backup-blockstore-update>
15+
Delete One Backup Blockstore Configuration </reference/ops-manager/admin-backup-blockstore-delete>
16+

0 commit comments

Comments
 (0)