summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/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/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/service.rst')
-rw-r--r--doc/source/cli/command-objects/service.rst143
1 files changed, 143 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/service.rst b/doc/source/cli/command-objects/service.rst
new file mode 100644
index 00000000..a69c6950
--- /dev/null
+++ b/doc/source/cli/command-objects/service.rst
@@ -0,0 +1,143 @@
+=======
+service
+=======
+
+Identity v2, v3
+
+service create
+--------------
+
+Create new service
+
+.. program:: service create
+.. code-block:: bash
+
+ openstack service create
+ [--name <name>]
+ [--description <description>]
+ [--enable | --disable]
+ <type>
+
+.. option:: --name <name>
+
+ New service name
+
+.. option:: --description <description>
+
+ New service description
+
+.. option:: --enable
+
+ Enable service (default)
+
+ *Identity version 3 only*
+
+.. option:: --disable
+
+ Disable service
+
+ *Identity version 3 only*
+
+.. _service_create-type:
+.. describe:: <type>
+
+ New service type (compute, image, identity, volume, etc)
+
+service delete
+--------------
+
+Delete service(s)
+
+.. program:: service delete
+.. code-block:: bash
+
+ openstack service delete
+ <service> [<service> ...]
+
+.. _service_delete-service:
+.. describe:: <service>
+
+ Service(s) to delete (type, name or ID)
+
+service list
+------------
+
+List services
+
+.. program:: service list
+.. code-block:: bash
+
+ openstack service list
+ [--long]
+
+.. option:: --long
+
+ List additional fields in output
+
+Returns service fields ID, Name and Type. :option:`--long` adds Description
+and Enabled (*Identity version 3 only*) to the output.
+
+service set
+-----------
+
+Set service properties
+
+* Identity version 3 only*
+
+.. program:: service set
+.. code-block:: bash
+
+ openstack service set
+ [--type <type>]
+ [--name <name>]
+ [--description <description>]
+ [--enable | --disable]
+ <service>
+
+.. option:: --type <type>
+
+ New service type (compute, image, identity, volume, etc)
+
+.. option:: --name <name>
+
+ New service name
+
+.. option:: --description <description>
+
+ New service description
+
+.. option:: --enable
+
+ Enable service
+
+.. option:: --disable
+
+ Disable service
+
+.. _service_set-service:
+.. describe:: <service>
+
+ Service to modify (type, name or ID)
+
+service show
+------------
+
+Display service details
+
+.. program:: service show
+.. code-block:: bash
+
+ openstack service show
+ [--catalog]
+ <service>
+
+.. option:: --catalog
+
+ Show service catalog information
+
+ *Identity version 2 only*
+
+.. _service_show-service:
+.. describe:: <service>
+
+ Service to display (type, name or ID)