summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorStephen Finucane <sfinucan@redhat.com>2021-03-19 11:34:31 +0000
committerStephen Finucane <sfinucan@redhat.com>2021-06-03 15:52:18 +0100
commit0eddab36e52e813e2329ac10044fa4f67830efec (patch)
tree8133b20828ba1b3ed135c6ac0abef0b41dfe5a5d /doc/source
parent6dc94e1fb85595653dcdd24185c914b9df1741df (diff)
downloadpython-openstackclient-0eddab36e52e813e2329ac10044fa4f67830efec.tar.gz
volume: Add 'volume message *' commands
This patch implements the necessary commands to utilize the Messages API introduced in Cinder API version 3.3. Version 3.5 built upon this by implementing pagination support for these commands which is present in this patch as well. volume message get volume message list volume message delete Change-Id: I64aa0b4a8d4468baa8c63e5e30ee31de68df999d
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/cli/command-objects/volume-message.rst8
-rw-r--r--doc/source/cli/commands.rst1
-rw-r--r--doc/source/cli/data/cinder.csv6
3 files changed, 12 insertions, 3 deletions
diff --git a/doc/source/cli/command-objects/volume-message.rst b/doc/source/cli/command-objects/volume-message.rst
new file mode 100644
index 00000000..5b1a8ace
--- /dev/null
+++ b/doc/source/cli/command-objects/volume-message.rst
@@ -0,0 +1,8 @@
+==============
+volume message
+==============
+
+Block Storage v3
+
+.. autoprogram-cliff:: openstack.volume.v3
+ :command: volume message *
diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst
index 00f6b23a..cc95b3d1 100644
--- a/doc/source/cli/commands.rst
+++ b/doc/source/cli/commands.rst
@@ -160,6 +160,7 @@ referring to both Compute and Volume quotas.
* ``volume backup record``: (**Volume**) volume record that can be imported or exported
* ``volume backend``: (**Volume**) volume backend storage
* ``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
* ``volume snapshot``: (**Volume**) a point-in-time copy of a volume
* ``volume type``: (**Volume**) deployment-specific types of volumes available
diff --git a/doc/source/cli/data/cinder.csv b/doc/source/cli/data/cinder.csv
index dc43ab5b..f94552ea 100644
--- a/doc/source/cli/data/cinder.csv
+++ b/doc/source/cli/data/cinder.csv
@@ -72,9 +72,9 @@ list,volume list,Lists all volumes.
list-filters,,List enabled filters. (Supported by API versions 3.33 - 3.latest)
manage,volume create --remote-source k=v,Manage an existing volume.
manageable-list,,Lists all manageable volumes. (Supported by API versions 3.8 - 3.latest)
-message-delete,,Removes one or more messages. (Supported by API versions 3.3 - 3.latest)
-message-list,,Lists all messages. (Supported by API versions 3.3 - 3.latest)
-message-show,,Shows message details. (Supported by API versions 3.3 - 3.latest)
+message-delete,volume message delete,Removes one or more messages. (Supported by API versions 3.3 - 3.latest)
+message-list,volume message list,Lists all messages. (Supported by API versions 3.3 - 3.latest)
+message-show,volume message show,Shows message details. (Supported by API versions 3.3 - 3.latest)
metadata,volume set --property k=v / volume unset --property k,Sets or deletes volume metadata.
metadata-show,volume show,Shows volume metadata.
metadata-update-all,volume set --property k=v,Updates volume metadata.