summaryrefslogtreecommitdiff
path: root/doc/source/cli
diff options
context:
space:
mode:
authorStephen Finucane <sfinucan@redhat.com>2017-04-20 11:20:59 +0100
committerStephen Finucane <stephenfin@redhat.com>2017-10-26 09:34:04 +0000
commit21212cabd52c85fdd572fc0c230868106a7f8eda (patch)
tree39d765f0a277118dddc3621cee2fb5b98acf1557 /doc/source/cli
parent8efed05e823eb76f309c0fee821fdc67a9886a3a (diff)
downloadpython-openstackclient-21212cabd52c85fdd572fc0c230868106a7f8eda.tar.gz
Convert 'server' commands to use autoprogram
Convert the remaining server commands. Change-Id: Ief84abb899be9fd60ce4d546abefc226e0ae4f81
Diffstat (limited to 'doc/source/cli')
-rw-r--r--doc/source/cli/command-objects/server-backup.rst39
-rw-r--r--doc/source/cli/command-objects/server-event.rst43
-rw-r--r--doc/source/cli/command-objects/server-group.rst76
-rw-r--r--doc/source/cli/command-objects/server-image.rst26
4 files changed, 13 insertions, 171 deletions
diff --git a/doc/source/cli/command-objects/server-backup.rst b/doc/source/cli/command-objects/server-backup.rst
index 9ddb2cdf..f2a2e2c9 100644
--- a/doc/source/cli/command-objects/server-backup.rst
+++ b/doc/source/cli/command-objects/server-backup.rst
@@ -3,42 +3,9 @@ server backup
=============
A server backup is a disk image created in the Image store from a running server
-instance. The backup command manages the number of archival copies to retain.
+instance. The backup command manages the number of archival copies to retain.
Compute v2
-server backup create
---------------------
-
-Create a server backup image
-
-.. program:: server create
-.. code:: bash
-
- openstack server backup create
- [--name <image-name>]
- [--type <backup-type>]
- [--rotate <count>]
- [--wait]
- <server>
-
-.. option:: --name <image-name>
-
- Name of the backup image (default: server name)
-
-.. option:: --type <backup-type>
-
- Used to populate the ``backup_type`` property of the backup
- image (default: empty)
-
-.. option:: --rotate <count>
-
- Number of backup images to keep (default: 1)
-
-.. option:: --wait
-
- Wait for operation to complete
-
-.. describe:: <server>
-
- Server to back up (name or ID)
+.. autoprogram-cliff:: openstack.compute.v2
+ :command: server backup create
diff --git a/doc/source/cli/command-objects/server-event.rst b/doc/source/cli/command-objects/server-event.rst
index ef4685f8..372cb400 100644
--- a/doc/source/cli/command-objects/server-event.rst
+++ b/doc/source/cli/command-objects/server-event.rst
@@ -2,44 +2,11 @@
server event
============
-Server event is the event record that had been done on a server, include: event
-type(create, delete, reboot and so on), event result(success, error), start
-time, finish time and so on. These are important information for server
-maintains.
+Server event are event record for server operations. They consist of: type
+(create, delete, reboot and so on), result (success, error), start time, finish
+time and so on. These are important for server maintenance.
Compute v2
-server event list
------------------
-
-List recent events of a server
-
-.. program:: server event list
-.. code:: bash
-
- openstack server event list
- <server>
-
-.. describe:: <server>
-
- Server to list events (name or ID)
-
-server event show
------------------
-
-Show server event details
-
-.. program:: server event show
-.. code:: bash
-
- openstack server event show
- <server>
- <request-id>
-
-.. describe:: <server>
-
- Server to show event details (name or ID)
-
-.. describe:: <request-id>
-
- Request ID of the event to show (ID only)
+.. autoprogram-cliff:: openstack.compute.v2
+ :command: server event *
diff --git a/doc/source/cli/command-objects/server-group.rst b/doc/source/cli/command-objects/server-group.rst
index 97696350..741eb4ad 100644
--- a/doc/source/cli/command-objects/server-group.rst
+++ b/doc/source/cli/command-objects/server-group.rst
@@ -2,79 +2,9 @@
server group
============
-Server group provides a mechanism to group servers according to certain policy.
+Server groups provide 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)
+.. autoprogram-cliff:: openstack.compute.v2
+ :command: server group *
diff --git a/doc/source/cli/command-objects/server-image.rst b/doc/source/cli/command-objects/server-image.rst
index 7e625d9e..c013ca49 100644
--- a/doc/source/cli/command-objects/server-image.rst
+++ b/doc/source/cli/command-objects/server-image.rst
@@ -7,27 +7,5 @@ image is created in the Image store.
Compute v2
-server image create
--------------------
-
-Create a new server disk image from an existing server
-
-.. program:: server image create
-.. code:: bash
-
- openstack server image create
- [--name <image-name>]
- [--wait]
- <server>
-
-.. option:: --name <image-name>
-
- Name of new disk image (default: server name)
-
-.. option:: --wait
-
- Wait for operation to complete
-
-.. describe:: <server>
-
- Server to create image (name or ID)
+.. autoprogram-cliff:: openstack.compute.v2
+ :command: server image create