python-zaqarclient/doc/source/command/pool.rst

Pool

For help on a specific openstack pool command, enter:

$ openstack pool COMMAND -h/--help

The ten commands:

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

openstack pool create

usage: openstack 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 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 pool delete

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

Delete a pool.

Positional arguments:

<pool_name>

Name of the pool.

openstack messaging pool delete ---------------------

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

Delete a pool.

Positional arguments:

<pool_name>

Name of the pool.

openstack pool list

usage: openstack 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 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 pool show

usage: openstack 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 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 pool update

usage: openstack 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.

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.