docs: Migrate remaining block storage commands to autocommand · openstack/python-openstackclient@3eb063d · GitHub
Skip to content

Commit 3eb063d

Browse files
committed
docs: Migrate remaining block storage commands to autocommand
Change-Id: I6924f7053e14e843420deea1a023201fad7d4999 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
1 parent 0b9c998 commit 3eb063d

5 files changed

Lines changed: 50 additions & 780 deletions

File tree

doc/source/cli/command-objects/access-rules.rst

Lines changed: 6 additions & 48 deletions

doc/source/cli/command-objects/consistency-group-snapshot.rst

Lines changed: 9 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -2,95 +2,16 @@
22
consistency group snapshot
33
==========================
44

5-
Block Storage v2
5+
Block Storage v2, v3
66

7-
consistency group snapshot create
8-
---------------------------------
7+
.. autoprogram-cliff:: openstack.volume.v3
8+
:command: consistency group snapshot create
99

10-
Create new consistency group snapshot.
10+
.. autoprogram-cliff:: openstack.volume.v3
11+
:command: consistency group snapshot delete
1112

12-
.. program:: consistency group snapshot create
13-
.. code:: bash
13+
.. autoprogram-cliff:: openstack.volume.v3
14+
:command: consistency group snapshot list
1415

15-
openstack consistency group snapshot create
16-
[--consistency-group <consistency-group>]
17-
[--description <description>]
18-
[<snapshot-name>]
19-
20-
.. option:: --consistency-group <consistency-group>
21-
22-
Consistency group to snapshot (name or ID)
23-
(default to be the same as <snapshot-name>)
24-
25-
.. option:: --description <description>
26-
27-
Description of this consistency group snapshot
28-
29-
.. _consistency_group_snapshot_create-snapshot-name:
30-
.. describe:: <snapshot-name>
31-
32-
Name of new consistency group snapshot (default to None)
33-
34-
consistency group snapshot delete
35-
---------------------------------
36-
37-
Delete consistency group snapshot(s)
38-
39-
.. program:: consistency group snapshot delete
40-
.. code:: bash
41-
42-
openstack consistency group snapshot delete
43-
<consistency-group-snapshot> [<consistency-group-snapshot> ...]
44-
45-
.. _consistency_group_snapshot_delete-consistency-group-snapshot:
46-
.. describe:: <consistency-group-snapshot>
47-
48-
Consistency group snapshot(s) to delete (name or ID)
49-
50-
consistency group snapshot list
51-
-------------------------------
52-
53-
List consistency group snapshots.
54-
55-
.. program:: consistency group snapshot list
56-
.. code:: bash
57-
58-
openstack consistency group snapshot list
59-
[--all-projects]
60-
[--long]
61-
[--status <status>]
62-
[--consistency-group <consistency-group>]
63-
64-
.. option:: --all-projects
65-
66-
Show detail for all projects. Admin only.
67-
(defaults to False)
68-
69-
.. option:: --long
70-
71-
List additional fields in output
72-
73-
.. option:: --status <status>
74-
75-
Filters results by a status
76-
("available", "error", "creating", "deleting" or "error_deleting")
77-
78-
.. option:: --consistency-group <consistency-group>
79-
80-
Filters results by a consistency group (name or ID)
81-
82-
consistency group snapshot show
83-
-------------------------------
84-
85-
Display consistency group snapshot details.
86-
87-
.. program:: consistency group snapshot show
88-
.. code:: bash
89-
90-
openstack consistency group snapshot show
91-
<consistency-group-snapshot>
92-
93-
.. _consistency_group_snapshot_show-consistency-group-snapshot:
94-
.. describe:: <consistency-group-snapshot>
95-
96-
Consistency group snapshot to display (name or ID)
16+
.. autoprogram-cliff:: openstack.volume.v3
17+
:command: consistency group snapshot show

doc/source/cli/command-objects/consistency-group.rst

Lines changed: 15 additions & 162 deletions

0 commit comments

Comments
 (0)