Skip to content

Commit b2a3350

Browse files
zach-carrzach-carr
authored
(DOCSP-12610) om admin backup blockstore create (#321)
* (DOCSP-12610) om admin backup blockstore create
1 parent 64addbb commit b2a3350

File tree

4 files changed

+216
-0
lines changed

4 files changed

+216
-0
lines changed

‎source/includes/admonitions/admin-requires-global-owner.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. note::
2+
3+
You must be a :authrole:`Global Owner` to run ``admin`` commands.

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

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Ops Manager ``admin`` commands
66

77
.. default-domain:: mongodb
88

9+
.. include:: /includes/admonitions/admin-requires-global-owner.rst
10+
911
.. toctree::
1012
:titlesonly:
1113

‎source/reference/ops-manager/blockstore-configuration-commands.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Ops Manager ``blockstore configuration`` commands
1010
:titlesonly:
1111

1212
List Backup Blockstore Configurations </reference/ops-manager/admin-backup-blockstore-list>
13+
Create a Backup Blockstore Configuration </reference/ops-manager/admin-backup-blockstore-create>
1314
Describe a Backup Blockstore Configuration </reference/ops-manager/admin-backup-blockstore-describe>
1415
Update One Backup Blockstore Configuration </reference/ops-manager/admin-backup-blockstore-update>
1516
Delete One Backup Blockstore Configuration </reference/ops-manager/admin-backup-blockstore-delete>

0 commit comments

Comments
 (0)