diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/cli/nova.rst | 99 |
1 files changed, 41 insertions, 58 deletions
diff --git a/doc/source/cli/nova.rst b/doc/source/cli/nova.rst index eeb80462..cada3d62 100644 --- a/doc/source/cli/nova.rst +++ b/doc/source/cli/nova.rst @@ -108,13 +108,6 @@ nova usage ``boot`` Boot a new server. -``cell-capacities`` - Get cell capacities for all cells or a given - cell. - -``cell-show`` - Show details of a given cell. - ``clear-password`` Clear the admin password for a server from the metadata server. This action does not actually @@ -309,10 +302,6 @@ nova usage ``list`` List servers. -``list-extensions`` - List all the os-api extensions that are - available. - ``list-secgroup`` List Security Group(s) of a server. @@ -472,6 +461,9 @@ nova usage '--os-compute-api-version' flag to show help message for proper version] +``server-topology`` + Retrieve NUMA topology of the given server. + ``service-delete`` Delete the service. @@ -1086,7 +1078,8 @@ quality of service support, microversion ``2.72`` is required. versions '2.42' - '2.latest') ``--config-drive <value>`` - Enable config drive. + Enable config drive. The value must be a + boolean value. ``--poll`` Report the new server boot progress until it @@ -1127,38 +1120,6 @@ quality of service support, microversion ``2.72`` is required. Requested hypervisor hostname to create servers. Admin only by default. (Supported by API versions '2.74' - '2.latest') -.. _nova_cell-capacities: - -nova cell-capacities --------------------- - -.. code-block:: console - - usage: nova cell-capacities [--cell <cell-name>] - -Get cell capacities for all cells or a given cell. - -**Optional arguments:** - -``--cell <cell-name>`` - Name of the cell to get the capacities. - -.. _nova_cell-show: - -nova cell-show --------------- - -.. code-block:: console - - usage: nova cell-show <cell-name> - -Show details of a given cell. - -**Positional arguments:** - -``<cell-name>`` - Name of the cell. - .. _nova_clear-password: nova clear-password @@ -1838,11 +1799,13 @@ List hypervisors. (Supported by API versions '2.0' - '2.latest') [hint: use ``--marker <marker>`` The last hypervisor of the previous page; displays list of hypervisors after "marker". + (Supported by API versions '2.33' - '2.latest') ``--limit <limit>`` Maximum number of hypervisors to display. If limit is bigger than 'CONF.api.max_limit' option of Nova API, limit 'CONF.api.max_limit' will be used instead. + (Supported by API versions '2.33' - '2.latest') .. _nova_hypervisor-servers: @@ -2366,18 +2329,6 @@ present in the failure domain. unlocked servers. (Supported by API versions '2.73' - '2.latest') - -.. _nova_list-extensions: - -nova list-extensions --------------------- - -.. code-block:: console - - usage: nova list-extensions - -List all the os-api extensions that are available. - .. _nova_list-secgroup: nova list-secgroup @@ -3361,6 +3312,26 @@ version] ``<tags>`` Tag(s) to set. +.. _nova_server_topology: + +nova server-topology +-------------------- + +.. code-block:: console + + usage: nova server-topology <server> + +Retrieve server NUMA topology information. Host specific fields are only +visible to users with the administrative role. +(Supported by API versions '2.78' - '2.latest') + +.. versionadded:: 16.0.0 + +**Positional arguments:** + +``<server>`` + Name or ID of server. + .. _nova_service-delete: nova service-delete @@ -3725,7 +3696,7 @@ nova unshelve .. code-block:: console - usage: nova unshelve <server> + usage: nova unshelve [--availability-zone <availability_zone>] <server> Unshelve a server. @@ -3734,6 +3705,12 @@ Unshelve a server. ``<server>`` Name or ID of server. +**Optional arguments:** + +``--availability-zone <availability_zone>`` + Name of the availability zone in which to unshelve a ``SHELVED_OFFLOADED`` + server. (Supported by API versions '2.77' - '2.latest') + .. _nova_update: nova update @@ -3823,7 +3800,8 @@ nova volume-attach .. code-block:: console - usage: nova volume-attach [--tag <tag>] <server> <volume> [<device>] + usage: nova volume-attach [--delete-on-termination] [--tag <tag>] + <server> <volume> [<device>] Attach a volume to a server. @@ -3844,6 +3822,11 @@ Attach a volume to a server. ``--tag <tag>`` Tag for the attached volume. (Supported by API versions '2.49' - '2.latest') +``--delete-on-termination`` + Specify if the attached volume sholud be deleted when the server is + destroyed. By default the attached volume is not deleted when the server is + destroyed. (Supported by API versions '2.79' - '2.latest') + .. _nova_volume-attachments: nova volume-attachments |