python-openstackclient/doc/source/command-objects/server-group.rst
zhiyong.dai 26a74d4596 Add choices for option '--policy'
When creating server group, the '--policy' option is required, but
valid choice is 'affinity' or 'anti-affinity', adding multiple
policies will produce an error. This patch add choices and default
value for option '--policy', and remove the former help message.

Change-Id: I312680af384363b3e9a7de9aa1f0946643e193e2
Closes-Bug: #1662771
2016-11-27 15:32:28 +08:00

81 lines
1.4 KiB
ReStructuredText

============
server group
============
Server group provides a mechanism to group servers according to certain policy.
Compute v2
server group create
-------------------
Create a new server group
.. program:: server group create
.. code-block:: bash
openstack server group create
--policy <policy>
<name>
.. option:: --policy <policy>
Add a policy to :ref:`\<name\> <server_group_create-name>`
('affinity' or 'anti-affinity', default to 'affinity')
.. _server_group_create-name:
.. describe:: <name>
New server group name
server group delete
-------------------
Delete existing server group(s)
.. program:: server group delete
.. code-block:: bash
openstack server group delete
<server-group> [<server-group> ...]
.. describe:: <server-group>
Server group(s) to delete (name or ID)
(repeat to delete multiple server groups)
server group list
-----------------
List all server groups
.. program:: server group list
.. code-block:: bash
openstack server group list
[--all-projects]
[--long]
.. option:: --all-projects
Display information from all projects (admin only)
.. option:: --long
List additional fields in output
server group show
-----------------
Display server group details
.. program:: server group show
.. code-block:: bash
openstack server group show
<server-group>
.. describe:: <server-group>
Server group to display (name or ID)