Skip to content

Commit 8a7e9a4

Browse files
jwilliams-mongojwilliams-mongo
authored
* (DOCSP-12757)(DOCSP-12758)(DOCSP-12759)(DOCSP-12760)(DOCSP-12761): mongocli om admin backup oplog commands * (DOCSP-12757): copy review feedback * (DOCSP-12757): copy review feedback pt 2 * (DOCSP-12757): tech review feedback
1 parent 8b894c9 commit 8a7e9a4

15 files changed

+833
-8
lines changed

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ mongocli ops-manager admin backup blockstore create
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/styles/corrections.rst
16-
1715
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1816

1917
The ``admin backup blockstore create`` command creates a new backup

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli ops-manager admin backup blockstore delete
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/styles/corrections.rst
15+
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1616

1717
The ``admin backup blockstore delete`` command deletes one
1818
backup blockstore configuration. You can also delete the

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ mongocli ops-manager admin backup blockstore describe
1212
:depth: 1
1313
:class: singlecol
1414

15+
.. include:: /includes/admonitions/admin-requires-global-owner.rst
16+
1517
The ``admin backup blockstore describe`` command retrieves
1618
configuration information for the specified backup blockstore.
1719

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli ops-manager admin backup blockstore list
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/styles/corrections.rst
15+
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1616

1717
The ``admin backup blockstore list`` command retrieves the list of
1818
backup blockstore configurations for your |onprem| deployment.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli ops-manager admin backup blockstore update
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/styles/corrections.rst
15+
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1616

1717
The ``admin backup blockstore update`` command updates one
1818
backup blockstore configuration. You can also update the

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli ops-manager admin backup filesystem delete
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/styles/corrections.rst
15+
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1616

1717
The ``admin backup filesystem delete`` command deletes the
1818
configuration of the specified file system store. You can also delete

‎source/reference/ops-manager/admin-backup-filesystem-describe.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli ops-manager admin backup filesystem describe
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/styles/corrections.rst
15+
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1616

1717
The ``admin backup filesystem describe`` command retrieves the
1818
configuration of the specified file system store. You can also

‎source/reference/ops-manager/admin-backup-filesystem-list.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mongocli ops-manager admin backup filesystem list
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/styles/corrections.rst
15+
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1616

1717
The ``admin backup filesystem list`` command retrieves the
1818
configurations of all file system stores. You can also

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

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

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

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

0 commit comments

Comments
 (0)