openstack/python-zaqarclient
Code Issues Proposed changes
Files
0233b3be1a17f57977ef6e4ad8d897c3f9b63e6a
python-zaqarclient/doc/source/command/pool.rst
wanghao 8f0b9f5b07 Adding the doc of message in CLI 
The doc of message is missing in zaqarclient.
So this patch will add it and also remove the unused docs for
other resources.

Change-Id: I55c745a81226487292220edfb629ca4f7dfd95d7
Closes-Bug: #1893145
Signed-off-by: wanghao <sxmatch1986@gmail.com>
2020-08-27 08:51:23 +08:00

3.6 KiB
Raw Blame History

Pool

For help on a specific openstack messaging pool command, enter:

$ openstack messaging pool COMMAND -h/--help

The ten commands:

messaging pool create
messaging pool delete
messaging pool list
messaging pool show
messaging pool update

openstack messaging pool create

usage: openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>] [--noindent]
                                       [--prefix PREFIX] [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name> <pool_uri> <pool_weight>

Create a pool.

Positional arguments:

<pool_name>

Name of the pool.

<pool_uri>

Storage engine URI.

<pool_weight>

weight of the pool.

Optional arguments:

--pool_group <pool_group>

Group of the pool.

--pool_options <pool_options>

An optional request component related to storage-specific options.

openstack messaging pool delete

usage: openstack messaging pool delete [-h] <pool_name>

Delete a pool.

Positional arguments:

<pool_name>

Name of the pool.

openstack messaging pool list

usage: openstack messaging pool list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                                     [--max-width <integer>] [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--marker <pool_name>] [--limit <limit>]
                                     [--detailed <detailed>]

List available Pools.

Optional arguments:

--marker <pool_name>

Pool's paging marker.

--limit <limit>

Page size limit.

--detailed <detailed>

Detailed output.

openstack messaging pool show

usage: openstack messaging pool show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                                     [--max-width <integer>] [--noindent]
                                     [--prefix PREFIX]
                                     <pool_name>

Display pool details.

Positional arguments:

<pool_name>

Pool to display (name).

openstack messaging pool update

usage: openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>] [--noindent]
                                       [--prefix PREFIX] [--pool_uri <pool_uri>]
                                       [--pool_weight <pool_weight>]
                                       [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name>

Update a pool attribute.

Positional arguments:

<pool_name>

Name of the pool.

Optional arguments:

--pool_uri <pool_uri>

Storage engine URI.

--pool_weight <pool_weight>

Weight of the pool.

--pool_group <pool_group>

Group of the pool.

--pool_options <pool_options>

An optional request component related to storage-specific options.