Skip to content

Commit ce96dab

Browse files
JuliaMongoJuliaMongo
committed
(DOCSP-12765) (DOCSP-12766) (DOCSP-12767) (DOCSP-12768) (DOCSP-12769) Backup sync store commands
1 parent 5cf28a1 commit ce96dab

11 files changed

+835
-4
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Options
7676
* - ``--encryptedCredentials``
7777
-
7878
- Flag that indicates whether the username and password for this
79-
blockstore were encrypted using the :opsmgr:`credentialstool
79+
blockstore were encrypted using the :opsmgr:`credentials tool
8080
</tutorial/encrypt-user-credentials/>`.
8181
- no
8282

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Options
8181
* - ``--encryptedCredentials``
8282
-
8383
- Flag that indicates whether the username and password for this
84-
blockstore were encrypted using the :opsmgr:`credentialstool
84+
blockstore were encrypted using the :opsmgr:`credentials tool
8585
</tutorial/encrypt-user-credentials/>`.
8686
- no
8787

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Options
6565
-
6666
- Flag that indicates whether the username and password for this
6767
oplog store were encrypted using the
68-
:opsmgr:`credentialstool </tutorial/encrypt-user-credentials/>`.
68+
:opsmgr:`credentials tool </tutorial/encrypt-user-credentials/>`.
6969
- no
7070

7171
* - ``--label``

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Options
8686
-
8787
- Flag that indicates whether the username and password for this
8888
oplog store were encrypted using the
89-
:opsmgr:`credentialstool </tutorial/encrypt-user-credentials/>`.
89+
:opsmgr:`credentials tool </tutorial/encrypt-user-credentials/>`.
9090
- no
9191

9292
* - ``--label``

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

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

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

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

0 commit comments

Comments
 (0)