Skip to content

Commit f994ca7

Browse files
committed
(DOCSP-12765), (DOCSP-12766), (DOCSP-12767), (DOCSP-12768), (DOCSP-12769) backup sync store commands -- Zach's copy review
1 parent cae84bb commit f994ca7

File tree

5 files changed

+39
-30
lines changed

5 files changed

+39
-30
lines changed

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Syntax
3131
[ --encryptedCredentials ]
3232
[ --label <tags> ]
3333
[ --loadFactor <number-of-backup-jobs> ]
34-
--name <sync-store-name>
3534
[ --maxCapacityGB <amount-of-data> ]
35+
--name <sync-store-name>
3636
[ --output|-o <output-format> ]
3737
[ --profile|-P <profile-name> ]
3838
[ --ssl ]
@@ -138,9 +138,7 @@ Options
138138
Output
139139
------
140140

141-
If the command succeeds, it returns the following message in the default
142-
format. If the command returns errors, see
143-
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended solutions.
141+
.. include:: /includes/command-output-intro.rst
144142

145143
.. code-block:: sh
146144
:copyable: false

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,20 @@ specified :opsmgr:`sync store </reference/glossary/#term-sync-store>`.
1919
You can also delete the sync store
2020
using the :opsmgr:`API </reference/api/admin/backup/sync/mongoConfigs/delete-one-sync-store-configuration/>`.
2121

22-
.. _mcli-om-admin-backup-sync-syntax:
22+
.. _mcli-om-admin-backup-sync-syntax:
2323

2424
Syntax
2525
------
2626

2727
.. code-block:: shell
2828

2929
mongocli ops-manager|om admin backup sync delete|rm <name>
30-
[ --force ]
31-
[ --profile|-P <profile-name> ]
30+
[ --force ]
31+
[ --profile|-P <profile-name> ]
3232

3333
.. include:: /includes/fact-command-line-help.rst
3434

35-
.. _mcli-om-admin-backup-sync-delete-args:
35+
.. _mcli-om-admin-backup-sync-delete-args:
3636

3737
Arguments
3838
---------
@@ -51,7 +51,7 @@ Arguments
5151
- Unique name for this sync store. This is also the sync store ID.
5252
- yes
5353

54-
.. _mcli-om-admin-backup-sync-delete-options:
54+
.. _mcli-om-admin-backup-sync-delete-options:
5555

5656
Options
5757
-------
@@ -84,7 +84,7 @@ Options
8484
Output
8585
------
8686

87-
If the command succeeds, it returns the following message.
87+
.. include:: /includes/command-output-intro.rst
8888

8989
.. code-block:: sh
9090
:copyable: false
@@ -110,5 +110,5 @@ The previous command returns the following:
110110
.. code-block:: shell
111111
:copyable: false
112112

113-
Sync store 'test' deleted
113+
Sync store configuration 'test' deleted
114114

source/reference/ops-manager/admin-backup-sync-describe.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ the :opsmgr:`API </reference/api/admin/backup/sync/mongoConfigs/get-one-sync-sto
2121

2222
.. _mcli-om-admin-backup-sync-describe-syntax:
2323

24-
Syntax
24+
Syntax
2525
------
2626

2727
.. code-block:: shell
@@ -84,16 +84,15 @@ Options
8484
Output
8585
------
8686

87-
If the command succeeds, it returns the following output in the default format.
88-
If the command returns errors, see :ref:`Troubleshooting <mcli-troubleshooting>`
89-
for recommendedsolutions.
87+
.. include:: /includes/command-output-intro.rst
9088

9189
.. code-block:: sh
9290
:copyable: false
9391

9492
NAME URI SSL LOAD FACTOR
9593
test mongodb://localhost:27017 false 1
9694

95+
.. include:: /includes/command-output-intro.rst
9796

9897
The default output contains a subset of the fields returned by this
9998
command. For the complete list of |json| fields returned by the

source/reference/ops-manager/admin-backup-sync-list.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,7 @@ Options
7878
Output
7979
------
8080

81-
If the command succeeds, it returns the following output in the default
82-
format. If the command returns errors, see
83-
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended solutions.
81+
.. include:: /includes/command-output-intro.rst
8482

8583
.. code-block:: sh
8684
:copyable: false

source/reference/ops-manager/admin-backup-sync-update.txt

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,14 @@ The ``admin backup sync update`` command updates one
1919
configuration. You can also update a sync store configuration
2020
using the :opsmgr:`API </reference/api/admin/backup/sync/mongoConfigs/update-one-sync-store-configuration/>`
2121

22-
.. _mcli-om-admin-backup-sync-update-syntax:
22+
.. _mcli-om-admin-backup-sync-update-syntax:
2323

2424
Syntax
2525
------
2626

2727
.. code-block:: shell
2828

29-
mongocli ops-manager|om admin backup sync update
30-
<name>
29+
mongocli ops-manager|om admin backup sync update <name>
3130
[ --assignment ]
3231
[ --encryptedCredentials ]
3332
[ --label <tags> ]
@@ -39,6 +38,26 @@ Syntax
3938
--uri <hosts>
4039
[ --writeConcern <write-concern> ]
4140

41+
Arguments
42+
---------
43+
44+
.. list-table::
45+
:widths: 20 10 60 10
46+
:header-rows: 1
47+
48+
* - Option
49+
- Type
50+
- Description
51+
- Required?
52+
53+
* - ``name``
54+
- string
55+
- Unique name for the sync store you want to update. This is also
56+
the sync store ID. You can retrieve a list of sync store names for
57+
a project with the
58+
:ref:`List Backup Sync Store Configurations <mcli-om-admin-backup-sync-list-cmd>` command.
59+
- yes
60+
4261

4362
.. _mcli-om-admin-backup-sync-update-options:
4463

@@ -132,9 +151,7 @@ Options
132151
Output
133152
------
134153

135-
If the command succeeds, it returns the following output in the default
136-
format. If the command returns errors, see
137-
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended solutions.
154+
.. include:: /includes/command-output-intro.rst
138155

139156
.. code-block:: sh
140157
:copyable: false
@@ -144,7 +161,7 @@ format. If the command returns errors, see
144161
The default output contains a subset of the fields returned by this
145162
command. For the complete list of |json| fields returned by the
146163
command, see the :opsmgr:`API reference
147-
</reference/api/admin/backup/sync/mongoConfigs/update-one-sync-store-configuration-by/#response>`.
164+
</reference/api/admin/backup/sync/mongoConfigs/update-one-sync-store-configuration/#response>`.
148165

149166
.. _mcli-om-admin-backup-sync-update-egs:
150167

@@ -176,14 +193,11 @@ contains the credentials for accessing |onprem|.
176193

177194
.. code-block:: shell
178195

179-
mongocli om admin backup sync log update test --uri mongodb://localhost:27017 --output json
196+
mongocli om admin backup sync update test --uri mongodb://localhost:27017 --output json
180197

181198
The previous command returns the following:
182199

183-
.. code-block:: shell
184-
:copyable: false
185-
186-
.. code-block:: shell
200+
.. code-block:: shell
187201
:copyable: false
188202

189203
{

0 commit comments

Comments
 (0)