openstack/python-openstackclient
Code Issues Proposed changes

Convert 'server' commands to use autoprogram

Browse Source 
Convert the remaining server commands.

Change-Id: Ief84abb899be9fd60ce4d546abefc226e0ae4f81
This commit is contained in:
Stephen Finucane 2017-04-20 11:20:59 +01:00 committed by Stephen Finucane
parent 8efed05e82
commit 21212cabd5
4 changed files with 13 additions and 171 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/source/cli/command-objects/server-backup.rst
View File

@ -7,38 +7,5 @@ instance. The backup command manages the number of archival copies to retain.
Compute v2 Compute v2
server backup create .. autoprogram-cliff:: openstack.compute.v2
-------------------- :command: 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)

43
doc/source/cli/command-objects/server-event.rst
View File

@ -2,44 +2,11 @@
server event server event
============ ============
Server event is the event record that had been done on a server, include: event Server event are event record for server operations. They consist of: type
type(create, delete, reboot and so on), event result(success, error), start (create, delete, reboot and so on), result (success, error), start time, finish
time, finish time and so on. These are important information for server time and so on. These are important for server maintenance.
maintains.
Compute v2 Compute v2
server event list .. autoprogram-cliff:: openstack.compute.v2
----------------- :command: server event *
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)

76
doc/source/cli/command-objects/server-group.rst
View File

@ -2,79 +2,9 @@
server group 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 Compute v2
server group create .. autoprogram-cliff:: openstack.compute.v2
------------------- :command: server group *
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)

26
doc/source/cli/command-objects/server-image.rst
View File

@ -7,27 +7,5 @@ image is created in the Image store.
Compute v2 Compute v2
server image create .. autoprogram-cliff:: openstack.compute.v2
------------------- :command: 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)