Matt Riedemann 879f820778 docs: clarify compute service --service option
The compute service commands emit a "Binary" in the output but
the --service filter option isn't as clear that it's the binary
(for set it is but not list) nor do the docs give an example
of a binary (typically nova-compute but could be others like
nova-conductor, nova-scheduler, etc). This simply mentions that
the --service option is the binary for "compute service list"
and gives an example value for the option in both list and set
help.

Change-Id: If87fc37352c3a251cc89041723adbe04dedf4f8a
2019-07-01 15:06:56 -04:00

91 lines
1.6 KiB
ReStructuredText

===============
compute service
===============
Compute v2
compute service delete
----------------------
Delete compute service(s)
.. program:: compute service delete
.. code:: bash
openstack compute service delete
<service> [<service> ...]
.. _compute_service_delete-service:
.. describe:: <service>
Compute service(s) to delete (ID only)
compute service list
--------------------
List compute services
.. program:: compute service list
.. code:: bash
openstack compute service list
[--host <host>]
[--service <service>]
[--long]
.. option:: --host <host>
List services on specified host (name only)
.. option:: --service <service>
List only specified service binaries (name only). For example,
``nova-compute``, ``nova-conductor``, etc.
.. option:: --long
List additional fields in output
compute service set
-------------------
Set compute service properties
.. program:: compute service set
.. code:: bash
openstack compute service set
[--enable | --disable]
[--disable-reason <reason>]
[--up | --down]
<host> <service>
.. option:: --enable
Enable service
.. option:: --disable
Disable service
.. option:: --disable-reason <reason>
Reason for disabling the service (in quotes). Should be used with :option:`--disable` option.
.. option:: --up
Force up service
.. option:: --down
Force down service
.. _compute_service_set-host:
.. describe:: <host>
Name of host
.. describe:: <service>
Name of service (Binary name), for example ``nova-compute``