python-openstackclient/doc/source/command-objects/service.rst
Kevin_Zheng 446e6f2fa8 change os in command example to openstack(3)
In the current doc, the command examples are like
"os server create" but the acutal command should
be started with "openstack" instead of "os", it
is misleading to first time users.

Change-Id: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00

144 lines
2.2 KiB
ReStructuredText

=======
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-type:
.. 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)