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

98 lines
2.0 KiB
ReStructuredText
Raw Normal View History

Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
===============
compute service
===============
Compute v2
compute service delete
----------------------
Modify some unusual help messages in computev2 Some command help messages are unusual, for example: common help message for a list command: "list objects" unusual help message: "list obejcets command" I think we should keep help message consistent, so I modify the unusual help messages in computev2. Change-Id: Ic5f11eba1a4397949e85d91cc067519752e89bff
2016-06-27 15:27:34 +08:00
Delete compute service(s)
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
.. program:: compute service delete
.. code:: bash
change os in command example to openstack 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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack compute service delete
Support bulk deletion for delete commands in computev2 Support bulk deletion and error handling for "keypair delete" and "service delete" commands in computev2. Up to now, all the delete commands in computev2 support bulk deletion. Change-Id: I6d5c960e9716188e56615514d0921618a15a88ec Partially-Implements: blueprint multi-argument-compute Partial-Bug: #1592906
2016-06-27 11:04:05 +08:00
<service> [<service> ...]
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
Add ":option:` `" in the help message This patch mainly adds ":option:` `" in several help messages in the doc. This modification will create one link which helps the readers find the relative option quickly and conveniently in website. Change-Id: Ia047e15c3b2064e4822ee7df7922d4774d862602
2016-12-19 17:23:35 +08:00
.. _compute_service_delete-service:
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
.. describe:: <service>
Document 2.53 behavior for compute service list/delete With compute API microversion 2.53, nova-compute services can only be deleted with the ID as a UUID to uniquely identify the service in a multi-cell deployment. This documents that for the "compute service delete <service>" argument. The description of the "compute service list" command is also updated to mention that the ID can be retrieved as a UUID using 2.53 or greater. Change-Id: If7d4a27c0aaef588bcd77dd9edddec1e535fbf31 Story: 2005349 Task: 30302
2019-07-25 14:28:43 -04:00
Compute service(s) to delete (ID only). If using
``--os-compute-api-version`` 2.53 or greater, the ID is a UUID which can
be retrieved by listing compute services using the same 2.53+ microversion.
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
compute service list
--------------------
Modify some unusual help messages in computev2 Some command help messages are unusual, for example: common help message for a list command: "list objects" unusual help message: "list obejcets command" I think we should keep help message consistent, so I modify the unusual help messages in computev2. Change-Id: Ic5f11eba1a4397949e85d91cc067519752e89bff
2016-06-27 15:27:34 +08:00
List compute services
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
Document 2.53 behavior for compute service list/delete With compute API microversion 2.53, nova-compute services can only be deleted with the ID as a UUID to uniquely identify the service in a multi-cell deployment. This documents that for the "compute service delete <service>" argument. The description of the "compute service list" command is also updated to mention that the ID can be retrieved as a UUID using 2.53 or greater. Change-Id: If7d4a27c0aaef588bcd77dd9edddec1e535fbf31 Story: 2005349 Task: 30302
2019-07-25 14:28:43 -04:00
Using ``--os-compute-api-version`` 2.53 or greater will return the ID as a
UUID value which can be used to uniquely identify the service in a multi-cell
deployment.
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
.. program:: compute service list
.. code:: bash
change os in command example to openstack 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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack compute service list
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
[--host <host>]
[--service <service>]
Support "--long" option in ListService Add "--long" option in ListService so that compute service disabled reason can be showed. Change-Id: I1ace8f1c4e4efe0a1a8f6710425d73eb5db9e5e1 Closes-Bug: #1556815
2016-03-14 18:07:23 +08:00
[--long]
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
Wrong param type in compute-service.rst compute-service.rst file uses 'describe' for below optional parameters 1. --long 2. --service <service> 3. --host <host> This patchset changes type of these argument to option. Change-Id: Ifd57bdf058efaeaa6cb43a7d4a60ee61ddb8de14 Closes-bug:#1563700
2016-03-30 13:23:37 +05:30
.. option:: --host <host>
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
Log hint when --enable present with --disable-reason --enable and --disable-reason should be mutually exclusive in "compute service set" command, but now when they are present at the same time, --disable-reason would be ignored silently. Fix these and add some hints about --disable-reason argument is ignored in this situation. Change-Id: I43254b6bc40fcae4fd0dc3457f26fad84c267072 Closes-Bug: #1556801
2016-03-14 16:53:51 +08:00
List services on specified host (name only)
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
Wrong param type in compute-service.rst compute-service.rst file uses 'describe' for below optional parameters 1. --long 2. --service <service> 3. --host <host> This patchset changes type of these argument to option. Change-Id: Ifd57bdf058efaeaa6cb43a7d4a60ee61ddb8de14 Closes-bug:#1563700
2016-03-30 13:23:37 +05:30
.. option:: --service <service>
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
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
List only specified service binaries (name only). For example,
``nova-compute``, ``nova-conductor``, etc.
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
Wrong param type in compute-service.rst compute-service.rst file uses 'describe' for below optional parameters 1. --long 2. --service <service> 3. --host <host> This patchset changes type of these argument to option. Change-Id: Ifd57bdf058efaeaa6cb43a7d4a60ee61ddb8de14 Closes-bug:#1563700
2016-03-30 13:23:37 +05:30
.. option:: --long
Support "--long" option in ListService Add "--long" option in ListService so that compute service disabled reason can be showed. Change-Id: I1ace8f1c4e4efe0a1a8f6710425d73eb5db9e5e1 Closes-Bug: #1556815
2016-03-14 18:07:23 +08:00
List additional fields in output
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
compute service set
-------------------
Modify some unusual help messages in computev2 Some command help messages are unusual, for example: common help message for a list command: "list objects" unusual help message: "list obejcets command" I think we should keep help message consistent, so I modify the unusual help messages in computev2. Change-Id: Ic5f11eba1a4397949e85d91cc067519752e89bff
2016-06-27 15:27:34 +08:00
Set compute service properties
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
.. program:: compute service set
.. code:: bash
change os in command example to openstack 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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack compute service set
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
[--enable | --disable]
Add --reason for disable service disbale service allow a reason to be input as disable reason. This patch add support for it. Change-Id: I59622c3970e055ebd46bf03c33c864b6d064db28
2016-02-22 13:38:44 +08:00
[--disable-reason <reason>]
Support compute service force down/up Aims to evacuate servers from compute host as soon as possible, operators might set the compute service force down manually. Novaclient support the behavior, this patch support it in OSC. Change-Id: I22ff1c5d670c449771fdcb3f4f39cd82f428531a Closes-Bug: #1589348
2016-06-06 17:51:56 +08:00
[--up | --down]
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
<host> <service>
Add --reason for disable service disbale service allow a reason to be input as disable reason. This patch add support for it. Change-Id: I59622c3970e055ebd46bf03c33c864b6d064db28
2016-02-22 13:38:44 +08:00
.. option:: --enable
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
Refactor SetService --enable/disable option This patch changes the following: 1. --enable/disable option should follow the rules in the doc below: http://docs.openstack.org/developer/python-openstackclient/command-options.html#boolean-options 2. "--disable-resion" is specified but not "--disable", an exception is raised instead of igoring "--disable-reason" option. Change-Id: I92e9234111e661bfe7119a8e19389a87c874ab0c
2016-05-25 11:12:57 +08:00
Enable service
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
Add --reason for disable service disbale service allow a reason to be input as disable reason. This patch add support for it. Change-Id: I59622c3970e055ebd46bf03c33c864b6d064db28
2016-02-22 13:38:44 +08:00
.. option:: --disable
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
Disable service
Add --reason for disable service disbale service allow a reason to be input as disable reason. This patch add support for it. Change-Id: I59622c3970e055ebd46bf03c33c864b6d064db28
2016-02-22 13:38:44 +08:00
.. option:: --disable-reason <reason>
Add ":option:` `" in the help message This patch mainly adds ":option:` `" in several help messages in the doc. This modification will create one link which helps the readers find the relative option quickly and conveniently in website. Change-Id: Ia047e15c3b2064e4822ee7df7922d4774d862602
2016-12-19 17:23:35 +08:00
Reason for disabling the service (in quotes). Should be used with :option:`--disable` option.
Add --reason for disable service disbale service allow a reason to be input as disable reason. This patch add support for it. Change-Id: I59622c3970e055ebd46bf03c33c864b6d064db28
2016-02-22 13:38:44 +08:00
Support compute service force down/up Aims to evacuate servers from compute host as soon as possible, operators might set the compute service force down manually. Novaclient support the behavior, this patch support it in OSC. Change-Id: I22ff1c5d670c449771fdcb3f4f39cd82f428531a Closes-Bug: #1589348
2016-06-06 17:51:56 +08:00
.. option:: --up
Mention compute service set --up|--down requires 2.11 or greater This simply updates the docs for the compute service set --up and --down options to mention that --os-compute-api-version 2.11 or greater is required to use those options. Change-Id: I52891fe36c84d0df3e868ab4f3c8e2357e9ba529
2019-07-24 12:03:01 -04:00
Force up service. Requires ``--os-compute-api-version`` 2.11 or greater.
Support compute service force down/up Aims to evacuate servers from compute host as soon as possible, operators might set the compute service force down manually. Novaclient support the behavior, this patch support it in OSC. Change-Id: I22ff1c5d670c449771fdcb3f4f39cd82f428531a Closes-Bug: #1589348
2016-06-06 17:51:56 +08:00
.. option:: --down
Mention compute service set --up|--down requires 2.11 or greater This simply updates the docs for the compute service set --up and --down options to mention that --os-compute-api-version 2.11 or greater is required to use those options. Change-Id: I52891fe36c84d0df3e868ab4f3c8e2357e9ba529
2019-07-24 12:03:01 -04:00
Force down service. . Requires ``--os-compute-api-version`` 2.11 or
greater.
Support compute service force down/up Aims to evacuate servers from compute host as soon as possible, operators might set the compute service force down manually. Novaclient support the behavior, this patch support it in OSC. Change-Id: I22ff1c5d670c449771fdcb3f4f39cd82f428531a Closes-Bug: #1589348
2016-06-06 17:51:56 +08:00
Add ":option:` `" in the help message This patch mainly adds ":option:` `" in several help messages in the doc. This modification will create one link which helps the readers find the relative option quickly and conveniently in website. Change-Id: Ia047e15c3b2064e4822ee7df7922d4774d862602
2016-12-19 17:23:35 +08:00
.. _compute_service_set-host:
Add compute service delete This change adds 'compute service delete <service>' to the openstack client. This is the equivalent of 'nova service-delete <id>' Change-Id: I69ef1cac72cbe125c2114f8e958e22350a70f367 Closes-Bug: #1503510
2015-10-06 22:12:44 -05:00
.. describe:: <host>
Name of host
.. describe:: <service>
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
Name of service (Binary name), for example ``nova-compute``
Copy Permalink