summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/service.rst144
-rw-r--r--doc/source/commands.rst2
2 files changed, 145 insertions, 1 deletions
diff --git a/doc/source/command-objects/service.rst b/doc/source/command-objects/service.rst
new file mode 100644
index 00000000..d4f63de8
--- /dev/null
+++ b/doc/source/command-objects/service.rst
@@ -0,0 +1,144 @@
+=======
+service
+=======
+
+Identity v2, v3
+
+service create
+--------------
+
+Create new service
+
+.. program:: service create
+.. code-block:: bash
+
+ os 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
+
+.. program:: service delete
+.. code-block:: bash
+
+ os service delete
+ <service>
+
+:option:`<service>`
+ Service to delete (type, name or ID)
+
+service list
+------------
+
+List services
+
+.. program:: service list
+.. code-block:: bash
+
+ os service list
+ [--long]
+
+.. option:: --long
+
+ List additional fields in output
+
+ *Identity version 2 only*
+
+Returns service fields ID and Name, `--long` adds Type and Description
+to the output. When Identity API version 3 is selected all columns are
+always displayed, `--long` is silently accepted for backward-compatibility.
+
+service set
+-----------
+
+Set service properties
+
+* Identity version 3 only*
+
+.. program:: service set
+.. code-block:: bash
+
+ os 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 update (type, name or ID)
+
+service show
+------------
+
+Display service details
+
+.. program:: service show
+.. code-block:: bash
+
+ os 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)
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 3a7fdd23..6fe91a1f 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -109,7 +109,7 @@ referring to both Compute and Volume quotas.
* ``security group rule``: Compute, Network - the individual rules that define protocol/IP/port access
* ``server``: (**Compute**) virtual machine instance
* ``server image``: (**Compute**) saved server disk image
-* ``service``: Identity - a cloud service
+* ``service``: (**Identity**) a cloud service
* ``snapshot``: (**Volume**) a point-in-time copy of a volume
* ``token``: (**Identity**) a bearer token managed by Identity service
* ``usage``: (**Compute**) display host resources being consumed