summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2021-06-18 18:05:39 +0000
committerGerrit Code Review <review@openstack.org>2021-06-18 18:05:39 +0000
commit87369984d1afcd4e7bee280621d43b5023f60eda (patch)
tree82c44866f9f5bc6b81d5fd0c5dc23dd5728b162c /doc
parent779c39f6163c6aebb2c6e7523a21f96c9d642044 (diff)
parent4c2e8523a98a0dd33e0203c47e94384420c14f9c (diff)
downloadpython-openstackclient-87369984d1afcd4e7bee280621d43b5023f60eda.tar.gz
Merge "volume: Add 'volume group *' commands"
Diffstat (limited to 'doc')
-rw-r--r--doc/source/cli/command-objects/volume-group.rst23
-rw-r--r--doc/source/cli/commands.rst1
-rw-r--r--doc/source/cli/data/cinder.csv18
3 files changed, 33 insertions, 9 deletions
diff --git a/doc/source/cli/command-objects/volume-group.rst b/doc/source/cli/command-objects/volume-group.rst
new file mode 100644
index 00000000..50bc830f
--- /dev/null
+++ b/doc/source/cli/command-objects/volume-group.rst
@@ -0,0 +1,23 @@
+============
+volume group
+============
+
+Block Storage v3
+
+.. autoprogram-cliff:: openstack.volume.v3
+ :command: volume group create
+
+.. autoprogram-cliff:: openstack.volume.v3
+ :command: volume group delete
+
+.. autoprogram-cliff:: openstack.volume.v3
+ :command: volume group list
+
+.. autoprogram-cliff:: openstack.volume.v3
+ :command: volume group failover
+
+.. autoprogram-cliff:: openstack.volume.v3
+ :command: volume group set
+
+.. autoprogram-cliff:: openstack.volume.v3
+ :command: volume group show
diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst
index cc95b3d1..b91a896f 100644
--- a/doc/source/cli/commands.rst
+++ b/doc/source/cli/commands.rst
@@ -159,6 +159,7 @@ referring to both Compute and Volume quotas.
* ``volume backend pool``: (**Volume**) volume backend storage pools
* ``volume backup record``: (**Volume**) volume record that can be imported or exported
* ``volume backend``: (**Volume**) volume backend storage
+* ``volume group``: (**Volume**) group of volumes
* ``volume host``: (**Volume**) the physical computer for volumes
* ``volume message``: (**Volume**) volume API internal messages detailing volume failure messages
* ``volume qos``: (**Volume**) quality-of-service (QoS) specification for volumes
diff --git a/doc/source/cli/data/cinder.csv b/doc/source/cli/data/cinder.csv
index 649cd8f5..031aa439 100644
--- a/doc/source/cli/data/cinder.csv
+++ b/doc/source/cli/data/cinder.csv
@@ -44,15 +44,15 @@ force-delete,volume delete --force,"Attempts force-delete of volume regardless o
freeze-host,volume host set --disable,Freeze and disable the specified cinder-volume host.
get-capabilities,volume backend capability show,Show capabilities of a volume backend. Admin only.
get-pools,volume backend pool list,Show pool information for backends. Admin only.
-group-create,,Creates a group. (Supported by API versions 3.13 - 3.latest)
+group-create,volume group create,Creates a group. (Supported by API versions 3.13 - 3.latest)
group-create-from-src,,Creates a group from a group snapshot or a source group. (Supported by API versions 3.14 - 3.latest)
-group-delete,,Removes one or more groups. (Supported by API versions 3.13 - 3.latest)
-group-disable-replication,,Disables replication for group. (Supported by API versions 3.38 - 3.latest)
-group-enable-replication,,Enables replication for group. (Supported by API versions 3.38 - 3.latest)
-group-failover-replication,,Fails over replication for group. (Supported by API versions 3.38 - 3.latest)
-group-list,,Lists all groups. (Supported by API versions 3.13 - 3.latest)
-group-list-replication-targets,,Lists replication targets for group. (Supported by API versions 3.38 - 3.latest)
-group-show,,Shows details of a group. (Supported by API versions 3.13 - 3.latest)
+group-delete,volume group delete,Removes one or more groups. (Supported by API versions 3.13 - 3.latest)
+group-disable-replication,volume group set --disable-replication,Disables replication for group. (Supported by API versions 3.38 - 3.latest)
+group-enable-replication,volume group set --enable-replication,Enables replication for group. (Supported by API versions 3.38 - 3.latest)
+group-failover-replication,volume group failover,Fails over replication for group. (Supported by API versions 3.38 - 3.latest)
+group-list,volume group list,Lists all groups. (Supported by API versions 3.13 - 3.latest)
+group-list-replication-targets,volume group list --replication-targets,Lists replication targets for group. (Supported by API versions 3.38 - 3.latest)
+group-show,volume group show,Shows details of a group. (Supported by API versions 3.13 - 3.latest)
group-snapshot-create,,Creates a group snapshot. (Supported by API versions 3.14 - 3.latest)
group-snapshot-delete,,Removes one or more group snapshots. (Supported by API versions 3.14 - 3.latest)
group-snapshot-list,,Lists all group snapshots. (Supported by API versions 3.14 - 3.latest)
@@ -65,7 +65,7 @@ group-type-key,,Sets or unsets group_spec for a group type. (Supported by API ve
group-type-list,,Lists available 'group types'. (Admin only will see private types) (Supported by API versions 3.11 - 3.latest)
group-type-show,,Show group type details. (Supported by API versions 3.11 - 3.latest)
group-type-update,,Updates group type name description and/or is_public. (Supported by API versions 3.11 - 3.latest)
-group-update,,Updates a group. (Supported by API versions 3.13 - 3.latest)
+group-update,volume group set,Updates a group. (Supported by API versions 3.13 - 3.latest)
image-metadata,volume set --image-property,Sets or deletes volume image metadata.
image-metadata-show,volume show,Shows volume image metadata.
list,volume list,Lists all volumes.