openstack/python-openstackclient
Code Issues Proposed changes
ef33132c39
python-openstackclient/doc/source/command-objects/service.rst

144 lines
2.2 KiB
ReStructuredText
Raw Normal View History

Command docs: add service Co-Authored-By: Lin Hua Cheng <os.lcheng@gmail.com> Change-Id: Icd39e6d769fd4c4797fcf4ef9eb97c71ed166b3b Closes-Bug: #1404434
2014-12-31 10:03:28 -06:00
=======
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>
Update service clist commands for v2 and v3 Changes to the 'service list' commands for Identity v2 and v3: * Document support for --long * Add Description to v3 output with --long * v3 output is now (ID, Name, Type), with (Description, Enabled) added with --long * Change v2 output to match v3 output, with the absense of Enabled. * Update doc to match Closes-Bug: #1411337 Change-Id: I999e3df22f61350cdeba63bbb7d01145c2ffeeaf
2015-01-16 10:54:00 -06:00
.. _service_delete-type:
.. describe:: <service>
Command docs: add service Co-Authored-By: Lin Hua Cheng <os.lcheng@gmail.com> Change-Id: Icd39e6d769fd4c4797fcf4ef9eb97c71ed166b3b Closes-Bug: #1404434
2014-12-31 10:03:28 -06:00
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
Update service clist commands for v2 and v3 Changes to the 'service list' commands for Identity v2 and v3: * Document support for --long * Add Description to v3 output with --long * v3 output is now (ID, Name, Type), with (Description, Enabled) added with --long * Change v2 output to match v3 output, with the absense of Enabled. * Update doc to match Closes-Bug: #1411337 Change-Id: I999e3df22f61350cdeba63bbb7d01145c2ffeeaf
2015-01-16 10:54:00 -06:00
Returns service fields ID, Name and Type. :option:`--long` adds Description
and Enabled (*Identity version 3 only*) to the output.
Command docs: add service Co-Authored-By: Lin Hua Cheng <os.lcheng@gmail.com> Change-Id: Icd39e6d769fd4c4797fcf4ef9eb97c71ed166b3b Closes-Bug: #1404434
2014-12-31 10:03:28 -06:00
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)
Copy Permalink