summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/volume-service.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/volume-service.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/volume-service.rst')
-rw-r--r--doc/source/cli/command-objects/volume-service.rst66
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/volume-service.rst b/doc/source/cli/command-objects/volume-service.rst
new file mode 100644
index 00000000..2ad23240
--- /dev/null
+++ b/doc/source/cli/command-objects/volume-service.rst
@@ -0,0 +1,66 @@
+==============
+volume service
+==============
+
+Volume v1, v2
+
+volume service list
+-------------------
+
+List volume service
+
+.. program:: volume service list
+.. code:: bash
+
+ openstack volume service list
+ [--host <host>]
+ [--service <service>]
+ [--long]
+
+.. option:: --host <host>
+
+ List services on specified host (name only)
+
+.. option:: --service <service>
+
+ List only specified service (name only)
+
+.. option:: --long
+
+ List additional fields in output
+
+volume service set
+------------------
+
+Set volume service properties
+
+.. program:: volume service set
+.. code:: bash
+
+ openstack volume service set
+ [--enable | --disable]
+ [--disable-reason <reason>]
+ <host>
+ <service>
+
+.. option:: --enable
+
+ Enable volume service
+
+.. option:: --disable
+
+ Disable volume service
+
+.. option:: --disable-reason <reason>
+
+ Reason for disabling the service
+ (should be used with :option:`--disable` option)
+
+.. _volume_service_set-host:
+.. describe:: <host>
+
+ Name of host
+
+.. describe:: <service>
+
+ Name of service (Binary name)