openstack/python-openstackclient
Code Issues Proposed changes
bf32cdf3a9
python-openstackclient/doc/source/cli/command-objects/host.rst

73 lines
990 B
ReStructuredText
Raw Normal View History

Add missing command/configuration object Add missing 'command' and 'configuration' object into command object list, add command, module, host commands describe in command-objects, and add 'mask' and 'unmask' options in configuration command details, fix some format issues by the way. Change-Id: Iea80c7b1e413e02e49b9090b9d3cb9c59aab4c38
2016-02-25 15:28:53 +08:00
====
host
====
Compute v2
The physical computer running a hypervisor.
host 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 hosts
Add missing command/configuration object Add missing 'command' and 'configuration' object into command object list, add command, module, host commands describe in command-objects, and add 'mask' and 'unmask' options in configuration command details, fix some format issues by the way. Change-Id: Iea80c7b1e413e02e49b9090b9d3cb9c59aab4c38
2016-02-25 15:28:53 +08:00
.. program:: host list
.. code:: bash
change os in command example to openstack(2) 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: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack host list
Add missing command/configuration object Add missing 'command' and 'configuration' object into command object list, add command, module, host commands describe in command-objects, and add 'mask' and 'unmask' options in configuration command details, fix some format issues by the way. Change-Id: Iea80c7b1e413e02e49b9090b9d3cb9c59aab4c38
2016-02-25 15:28:53 +08:00
[--zone <availability-zone>]
.. option:: --zone <availability-zone>
Only return hosts in the availability zone
[compute] Add set host command set host command is missing, add it as SetHost class. Change-Id: I7acb94150718b7150598632cbebc3d85018a0d59
2016-02-19 22:52:38 +08:00
host 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 host properties
[compute] Add set host command set host command is missing, add it as SetHost class. Change-Id: I7acb94150718b7150598632cbebc3d85018a0d59
2016-02-19 22:52:38 +08:00
.. program:: host set
.. code:: bash
change os in command example to openstack(2) 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: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack host set
[compute] Add set host command set host command is missing, add it as SetHost class. Change-Id: I7acb94150718b7150598632cbebc3d85018a0d59
2016-02-19 22:52:38 +08:00
[--enable | --disable]
[--enable-maintenance | --disable-maintenance]
<host>
.. _host-set:
.. option:: --enable
Enable the host
.. option:: --disable
Disable the host
.. _maintenance-set:
.. option:: --enable-maintenance
Enable maintenance mode for the host
.. option:: --disable-maintenance
Disable maintenance mode for the host
.. describe:: <host>
Fix errors for "host set" command "Host set" command cannot work. Because: 1.Host has no 'ID' attribute, so 'ID' attribute cannot be found in "host set" command. 2.value "True" and "Flase" are invalid in updata() method of host. 3.Some update functionalities is not supported in host API now. This patch solves the problems 1 and 2 in OSC. But the problem 3 is a API problem and can't be solved in OSC, only XenServer driver support to set enable/disable and maintenance host, it is a normal problem. After this patch the output of "host set" command is: The requested functionality is not supported. (HTTP 501) (Request-ID: req-14031fce-8c90-48a0-8492-dc8e3dd349f3) Just the same as the "host-update" command in novaclient. Change-Id: Ibe94c4d3d492d3d63355de803810edb988e1b4e9 Closes-Bug: #1594689
2016-06-20 19:40:26 +08:00
Host to modify (name only)
[compute] Add set host command set host command is missing, add it as SetHost class. Change-Id: I7acb94150718b7150598632cbebc3d85018a0d59
2016-02-19 22:52:38 +08:00
Add missing command/configuration object Add missing 'command' and 'configuration' object into command object list, add command, module, host commands describe in command-objects, and add 'mask' and 'unmask' options in configuration command details, fix some format issues by the way. Change-Id: Iea80c7b1e413e02e49b9090b9d3cb9c59aab4c38
2016-02-25 15:28:53 +08:00
host show
---------
Display host details
.. program:: host show
.. code:: bash
change os in command example to openstack(2) 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: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack host show
Add missing command/configuration object Add missing 'command' and 'configuration' object into command object list, add command, module, host commands describe in command-objects, and add 'mask' and 'unmask' options in configuration command details, fix some format issues by the way. Change-Id: Iea80c7b1e413e02e49b9090b9d3cb9c59aab4c38
2016-02-25 15:28:53 +08:00
<host>
.. describe:: <host>
Name of host
Copy Permalink