summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/server-group.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/server-group.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/server-group.rst')
-rw-r--r--doc/source/cli/command-objects/server-group.rst80
1 files changed, 80 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/server-group.rst b/doc/source/cli/command-objects/server-group.rst
new file mode 100644
index 00000000..97696350
--- /dev/null
+++ b/doc/source/cli/command-objects/server-group.rst
@@ -0,0 +1,80 @@
+============
+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)