Skip to content

Commit 6c2a4a3

Browse files
jwilliams-mongojwilliams-mongo
committed
(DOCSP-12780): backup snapshots schedule describe|update
(DOCSP-12780): tech review feedback (DOCSP-12780): copy review feedback (DOCSP-12780): copy review feedback pt 2 (DOCSP-12780): fix warnings (DOCSP-12870): highlight correct line
1 parent 182cc05 commit 6c2a4a3

8 files changed

+890
-1
lines changed

‎snooty.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ Epoch-time-ms = "Timestamp in the number of milliseconds that have elapsed since
4141
epoch-time-ms = "timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
4242
Epoch-time = "Timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
4343
epoch-time = "timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
44+
fcv = ":abbr:`FCV (Feature Compatibility Version)`"
45+
fcv-fulllink = ":dbcommand:`Feature Compatibility Version <setFeatureCompatibilityVersion>`"
4446
fqdn = ":abbr:`FQDN (fully qualified domain name)`"
4547
fts = "Atlas Search"
4648
gcp = ":abbr:`GCP (Google Cloud Platform)`"
@@ -50,6 +52,7 @@ iana = ":abbr:`IANA (Internet Assigned Numbers Authority)`"
5052
iops = ":abbr:`IOPS (Input/Output Operations per Second)`"
5153
ipaddr = ":abbr:`IP (Internet Protocol)`"
5254
iso8601-time = "Timestamp in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__ date and time format in |utc|"
55+
iso8601-tzoffset = ":wikipedia:`ISO-8601 timezone offset </ISO_8601?oldid=960381594#Time_offsets_from_UTC>`"
5356
iso8601 = "`ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__"
5457
ipv4 = ":abbr:`IPv4 (Internet Protocol version 4)`"
5558
ipv6 = ":abbr:`IPv6 (Internet Protocol version 6)`"

‎source/includes/extracts-basic-options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ content: |
1919
ref: fact-basic-options-project-id
2020
content: |
2121
Unique identifier of the project. If omitted, uses the project ID in the
22-
profile or :ref:`environment variable <mcli-env-var>`.
22+
:ref:`profile <mcli-profiles>` or :ref:`environment variable <mcli-env-var>`.
2323
...

‎source/reference/cloud-manager/backup-commands.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ Cloud Manager ``backup`` Commands
1616
List Backup Configurations for One Project </reference/cloud-manager/backup-config-list>
1717
Update One Backup Configuration </reference/cloud-manager/backup-config-update>
1818
Describe One Backup Configuration </reference/cloud-manager/backup-config-describe>
19+
Describe One Backup Snapshot Schedule </reference/cloud-manager/backup-snapshots-schedule-describe>
20+
Update One Backup Snapshot Schedule </reference/cloud-manager/backup-snapshots-schedule-update>

‎source/reference/cloud-manager/backup-snapshots-schedule-describe.txt

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
.. _mcli-cm-backup-snapshots-schedule-describe-cmd:
2+
3+
=========================================================
4+
mongocli cloud-manager backup snapshots schedule describe
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+
The ``backup snapshots schedule describe`` command retrieves the backup
16+
snapshot schedule for the specified cluster. You can also view the
17+
backup snapshot schedule through the |cloud-short| :cloudmgr:`UI
18+
</tutorial/edit-backup/#edit-snapshot-schedule-and-retention-policy>`
19+
or :cloudmgr:`API </reference/api/backup/get-snapshot-schedule>`.
20+
21+
.. _mcli-cm-backup-snapshots-schedule-describe-syntax:
22+
23+
Syntax
24+
------
25+
26+
.. code-block:: sh
27+
28+
mongocli cloud-manager|cm backup(s) snapshot(s) schedule describe|get
29+
--clusterId <cluster-id>
30+
[ --output|-o <output-format> ]
31+
[ --profile|-P <profile-name> ]
32+
[ --projectId <project-ID> ]
33+
34+
.. include:: /includes/fact-command-line-help.rst
35+
36+
.. _mcli-cm-backup-snapshots-schedule-describe-options:
37+
38+
Options
39+
-------
40+
41+
.. list-table::
42+
:header-rows: 1
43+
:widths: 20 10 60 10
44+
45+
* - Option
46+
- Type
47+
- Description
48+
- Required?
49+
50+
* - ``--clusterId``
51+
- string
52+
- Unique identifier of the cluster for which you want to retrieve
53+
its backup snapshot schedule.
54+
- yes
55+
56+
* - ``--output``, ``-o``
57+
- string
58+
- .. include:: /includes/extracts/fact-basic-options-output.rst
59+
- no
60+
61+
* - ``--profile``, ``-P``
62+
- string
63+
- Name of the profile where the project ID and the |svc-api-key|\s
64+
for the project are saved. If omitted, uses the {+default-profile+}.
65+
To learn more about creating a profile, see :ref:`mcli-configure`.
66+
- no
67+
68+
* - ``--projectId``
69+
- string
70+
- .. include:: /includes/extracts/fact-basic-options-project-id.rst
71+
- no
72+
73+
.. _mcli-cm-backup-snapshots-schedule-describe-output:
74+
75+
Output
76+
------
77+
78+
.. include:: /includes/command-output-intro.rst
79+
80+
.. code-block:: sh
81+
:copyable: false
82+
83+
PROJECT ID CLUSTER ID MONTHLY SNAPSHOT RETENTION MONTHS POINT IN TIME WINDOW HOURS
84+
5f1f39ffc902201990f53873 5f457bd5c90220199051210c 1 24
85+
86+
.. include:: /includes/fact-default-output.rst
87+
88+
- :cloudmgr:`Cloud Manager API </reference/api/backup/get-snapshot-schedule/>`
89+
90+
.. _mcli-cm-backup-snapshots-schedule-describe-eg:
91+
92+
Examples
93+
--------
94+
95+
.. tabs::
96+
97+
.. tab:: Default Output
98+
:tabid: default-output
99+
100+
The following command retrieves the backup snapshot schedule for
101+
the specified cluster. The command uses the {+default-profile+},
102+
which contains |cloud-short| credentials. The {+mcli+} returns the
103+
output in the default format.
104+
105+
.. code-block:: sh
106+
:copyable: false
107+
108+
mongocli cm backup snapshot schedule describe \
109+
--clusterId 5f457bd5c90220199051210c
110+
111+
The previous command prints the following to the terminal.
112+
113+
.. code-block:: sh
114+
:copyable: false
115+
116+
PROJECT ID CLUSTER ID MONTHLY SNAPSHOT RETENTION MONTHS POINT IN TIME WINDOW HOURS
117+
5f1f39ffc902201990f53873 5f457bd5c90220199051210c 1 24
118+
119+
.. tab:: JSON Output
120+
:tabid: json-output
121+
122+
The following command retrieves the backup snapshot schedule for
123+
the specified cluster. The command uses the {+default-profile+},
124+
which contains |cloud-short| credentials. The {+mcli+} returns the
125+
output in |json| format.
126+
127+
.. code-block:: sh
128+
:copyable: false
129+
130+
mongocli cm backup snapshot schedule describe \
131+
--clusterId 5f457bd5c90220199051210c -o json
132+
133+
The previous command prints the following to the terminal in
134+
|json| format.
135+
136+
.. code-block:: json
137+
:copyable: false
138+
:linenos:
139+
140+
{
141+
"clusterId": "5f457bd5c90220199051210c",
142+
"groupId": "5f1f39ffc902201990f53873",
143+
"links": [
144+
{
145+
"rel": "self",
146+
"href": "http://cloud.mongodb.com/api/public/v1.0/groups/5f1f39ffc902201990f53873/backupConfigs/5f457bd5c90220199051210c/snapshotSchedule"
147+
},
148+
{
149+
"rel": "http://mms.mongodb.com/cluster",
150+
"href": "http://cloud.mongodb.com/api/public/v1.0/groups/5f1f39ffc902201990f53873/clusters/5f457bd5c90220199051210c"
151+
},
152+
{
153+
"rel": "http://mms.mongodb.com/backupConfig",
154+
"href": "http://cloud.mongodb.com/api/public/v1.0/groups/5f1f39ffc902201990f53873/backupConfigs/5f457bd5c90220199051210c"
155+
},
156+
{
157+
"rel": "http://mms.mongodb.com/group",
158+
"href": "http://cloud.mongodb.com/api/public/v1.0/groups/5f1f39ffc902201990f53873"
159+
}
160+
],
161+
"monthlySnapshotRetentionMonths": 1,
162+
"pointInTimeWindowHours": 24,
163+
"snapshotIntervalHours": 24,
164+
"snapshotRetentionDays": 2,
165+
"weeklySnapshotRetentionWeeks": 2
166+
}

0 commit comments

Comments
 (0)