Skip to content

Commit 70d794c

Browse files
committed
(DOCSP-12765), (DOCSP-12766), (DOCSP-12767), (DOCSP-12768), (DOCSP-12769) backup sync store commands: first round of copy review
1 parent ce96dab commit 70d794c

13 files changed

+215
-209
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:`credentials tool
79+
blockstore were encrypted using the :opsmgr:`credentialstool
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:`credentials tool
84+
blockstore were encrypted using the :opsmgr:`credentialstool
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:`credentials tool </tutorial/encrypt-user-credentials/>`.
68+
:opsmgr:`credentialstool </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:`credentials tool </tutorial/encrypt-user-credentials/>`.
89+
:opsmgr:`credentialstool </tutorial/encrypt-user-credentials/>`.
9090
- no
9191

9292
* - ``--label``

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

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _mcli-om-admin-backup-sync-store-create-cmd:
1+
.. _mcli-om-admin-backup-sync-create-cmd:
22

3-
===================================================
4-
mongocli ops-manager admin backup sync store create
5-
===================================================
3+
=============================================
4+
mongocli ops-manager admin backup sync create
5+
=============================================
66

77
.. default-domain:: mongodb
88

@@ -14,25 +14,25 @@ mongocli ops-manager admin backup sync store create
1414

1515
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1616

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/>`.
17+
The ``admin backup sync create`` command creates a new
18+
:opsmgr:`sync store </reference/glossary/#term-sync-store>`.
19+
You can also create a sync store using the
20+
:opsmgr:`API </reference/api/admin/backup/sync/mongoConfigs/create-one-sync-store-configuration/>`.
2221

23-
.. _mcli-om-admin-backup-sync-store-create-syntax:
22+
.. _mcli-om-admin-backup-sync-create-syntax:
2423

2524
Syntax
2625
------
2726

2827
.. code-block:: shell
2928

30-
mongocli ops-manager|om admin backup sync store(s) create
31-
[ --assignment ]
29+
mongocli ops-manager|om admin backup sync create
30+
[ --assignment ]
3231
[ --encryptedCredentials ]
3332
[ --label <tags> ]
34-
--name <sync-store-name>
33+
[ --loadFactor <number-of-backup-jobs> ]
3534
[ --maxCapacityGB <amount-of-data> ]
35+
--name <sync-store-name>
3636
[ --output|-o <output-format> ]
3737
[ --profile|-P <profile-name> ]
3838
[ --ssl ]
@@ -41,7 +41,7 @@ Syntax
4141

4242
.. include:: /includes/fact-command-line-help.rst
4343

44-
.. _mcli-om-admin-backup-sync-store-create-options:
44+
.. _mcli-om-admin-backup-sync-create-options:
4545

4646
Options
4747
-------
@@ -66,7 +66,7 @@ Options
6666
-
6767
- Flag that indicates whether the username and password for this
6868
sync store were encrypted using the
69-
:opsmgr:`credentials tool </tutorial/encrypt-user-credentials/>`.
69+
:opsmgr:`credentialstool </tutorial/encrypt-user-credentials/>`.
7070
- no
7171

7272
* - ``--label``
@@ -78,16 +78,25 @@ Options
7878
don't use labels to filter their jobs.
7979
- no
8080

81-
* - ``--name``
82-
- string
83-
- Name of the sync store.
84-
- yes
81+
* - ``--loadFactor``
82+
- number
83+
- Required if more than one snapshot store is in use.
84+
85+
Number that expresses how much backup work this snapshot store
86+
should perform compared to another snapshot store. Value must be
87+
a positive, non-zero integer.
88+
- no
8589

8690
* - ``--maxCapacityGB``
8791
- number
8892
- Maximum amount of data in GB that this sync store can store.
8993
- no
9094

95+
* - ``--name``
96+
- string
97+
- Unique name for this sync store. This is also the sync store ID.
98+
- yes
99+
91100
* - ``--output``, ``-o``
92101
- string
93102
- .. include:: /includes/extracts/fact-basic-options-output.rst
@@ -125,7 +134,7 @@ Options
125134

126135
- no
127136

128-
.. _mcli-om-admin-backup-sync-store-create-output:
137+
.. _mcli-om-admin-backup-sync-create-output:
129138

130139
Output
131140
------
@@ -137,19 +146,19 @@ format. If the command returns errors, see
137146
.. code-block:: sh
138147
:copyable: false
139148

140-
Sync store configuration '<sync-store-ID>' created.
149+
Sync store '<sync-store-ID>' created.
141150

142151
The default output contains a subset of the fields returned by this
143152
command. For the complete list of |json| fields returned by the
144153
command, see the :opsmgr:`API reference
145154
</reference/api/admin/backup/sync/mongoConfigs/create-one-sync-store-configuration/#response>`.
146155

147-
.. _mcli-om-admin-backup-sync-store-create-egs:
156+
.. _mcli-om-admin-backup-sync-create-egs:
148157

149158
Example
150159
-------
151160

152-
The following ``mongocli om admin backup sync store create`` command
161+
The following ``mongocli om admin backup sync create`` command
153162
creates the Sync store named ``test``. The command uses the
154163
{+default-profile+}, which contains the credentials to access |onprem|.
155164

@@ -160,22 +169,22 @@ creates the Sync store named ``test``. The command uses the
160169

161170
.. code-block:: shell
162171

163-
mongocli om admin backup sync store create --name test
172+
mongocli om admin backup sync create --name test
164173
--uri mongodb://localhost:27017
165174

166175
The previous command returns the following:
167176

168177
.. code-block:: shell
169178
:copyable: false
170179

171-
Sync store configuration 'test' created.
180+
Sync store 'test' created.
172181

173182
.. tab:: JSON Output
174183
:tabid: json
175184

176185
.. code-block:: shell
177186

178-
mongocli om admin backup sync store create --name test --uri mongodb://localhost:27017 --output json
187+
mongocli om admin backup sync create --name test --uri mongodb://localhost:27017 --output json
179188

180189
The previous command returns the following:
181190

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

0 commit comments

Comments
 (0)