diff --git a/doc/source/command-line.rst b/doc/source/command-line.rst index 728cb100..e9d689cb 100644 --- a/doc/source/command-line.rst +++ b/doc/source/command-line.rst @@ -14,3 +14,4 @@ Click the Link below for the details. command/queue command/claim + command/pool diff --git a/doc/source/command/pool.rst b/doc/source/command/pool.rst new file mode 100644 index 00000000..e8747044 --- /dev/null +++ b/doc/source/command/pool.rst @@ -0,0 +1,152 @@ +Pool +==== + +For help on a specific :command:`openstack pool` command, enter: + +.. code-block:: console + + $ openstack pool COMMAND -h/--help + +The five commands: + +.. code-block:: console + + pool create + pool delete + pool list + pool show + pool update + +.. _openstack_pool_create: + +openstack pool create +--------------------- + +.. code-block:: console + + usage: openstack pool create [-h] [-f {json,shell,table,value,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] [--pool_group ] + [--pool_options ] + + +Create a pool. + +**Positional arguments:** + +```` + Name of the pool. + +```` + Storage engine URI. + +```` + weight of the pool. + +**Optional arguments:** + +``--pool_group `` + Group of the pool. + +``--pool_options `` + An optional request component related to + storage-specific options. + +.. _openstack_pool_delete: + +openstack pool delete +--------------------- + +.. code-block:: console + + usage: openstack pool delete [-h] + +Delete a pool. + +**Positional arguments:** + +```` + Name of the pool. + + +.. _openstack_pool_list: + +openstack pool list +------------------- + +.. code-block:: console + + usage: openstack pool list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] + [--quote {all,minimal,none,nonnumeric}] + [--marker ] [--limit ] + [--detailed ] + +List available Pools. + +**Optional arguments:** + +``--marker `` + Pool's paging marker. + +``--limit `` + Page size limit. + +``--detailed `` + Detailed output. + +.. _openstack_pool_show: + +openstack pool show +------------------- + +.. code-block:: console + + usage: openstack pool show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] + [--prefix PREFIX] + + +Display pool details. + +**Positional arguments:** + +```` + Pool to display (name). + +.. _openstack_pool_update: + +openstack pool update +--------------------- + +.. code-block:: console + + usage: openstack pool update [-h] [-f {json,shell,table,value,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] [--pool_uri ] + [--pool_weight ] + [--pool_group ] + [--pool_options ] + + +Update a pool attribute. + +**Positional arguments:** + +```` + Name of the pool. + +**Optional arguments:** + +``--pool_uri `` + Storage engine URI. + +``--pool_weight `` + Weight of the pool. + +``--pool_group `` + Group of the pool. + +``--pool_options `` + An optional request component related to + storage-specific options.