summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorStephen Finucane <sfinucan@redhat.com>2021-05-26 15:04:28 +0100
committerStephen Finucane <sfinucan@redhat.com>2022-05-13 12:42:16 +0100
commit53a7e67b4132281c9e217061aac03429a77f869c (patch)
tree0da45168002016e3e40f89e4cff863072a927d5f /doc/source
parentd727a6502369a6a7244ef1c07c1c483dbe0a8dab (diff)
downloadpython-openstackclient-53a7e67b4132281c9e217061aac03429a77f869c.tar.gz
volume: Add 'block storage resource filter list' command
These are based on the 'cinder list-filters' command, which accepts an optional '--resource {resource}' option to limit the listed filters to a single resource type. block storage resource filter list block storage resource filter show We used the 'block storage resource filter' terminology rather than simply 'resource filter' to highlight the fact that this is specific to the block storage service. Note that while this feature is a bit weird, good documentation can be found at [1]. [1] https://docs.openstack.org/cinder/latest/admin/generalized_filters.html Change-Id: I21e7c0ea427aef1f6665394d4b8e9a1f30d6dbb1 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/cli/command-objects/block-storage-resource-filter.rst8
-rw-r--r--doc/source/cli/commands.rst1
-rw-r--r--doc/source/cli/data/cinder.csv2
3 files changed, 10 insertions, 1 deletions
diff --git a/doc/source/cli/command-objects/block-storage-resource-filter.rst b/doc/source/cli/command-objects/block-storage-resource-filter.rst
new file mode 100644
index 00000000..3e4c33ba
--- /dev/null
+++ b/doc/source/cli/command-objects/block-storage-resource-filter.rst
@@ -0,0 +1,8 @@
+=============================
+block storage resource filter
+=============================
+
+Block Storage v3
+
+.. autoprogram-cliff:: openstack.volume.v3
+ :command: block storage resource filter *
diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst
index d9bedb36..d789eceb 100644
--- a/doc/source/cli/commands.rst
+++ b/doc/source/cli/commands.rst
@@ -77,6 +77,7 @@ referring to both Compute and Volume quotas.
* ``aggregate``: (**Compute**) a grouping of compute hosts
* ``availability zone``: (**Compute**, **Network**, **Volume**) a logical partition of hosts or block storage or network services
* ``block storage cluster``: (**Volume**) clusters of volume services
+* ``block storage resource filter``: (**Volume**) filters for volume service resources
* ``catalog``: (**Identity**) service catalog
* ``command``: (**Internal**) installed commands in the OSC process
* ``compute agent``: (**Compute**) a cloud Compute agent available to a hypervisor
diff --git a/doc/source/cli/data/cinder.csv b/doc/source/cli/data/cinder.csv
index 54ce7967..eeaaeacc 100644
--- a/doc/source/cli/data/cinder.csv
+++ b/doc/source/cli/data/cinder.csv
@@ -69,7 +69,7 @@ group-update,volume group set,Updates a group. (Supported by API versions 3.13 -
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.
-list-filters,,List enabled filters. (Supported by API versions 3.33 - 3.latest)
+list-filters,block storage resource filter list,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,volume message delete,Removes one or more messages. (Supported by API versions 3.3 - 3.latest)