Chapter 40. hypervisor

This chapter describes the commands under the hypervisor command.

40.1. hypervisor list

List hypervisors

Usage:

openstack hypervisor list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--noindent] [--max-width <integer>]
                                 [--fit-width] [--print-empty]
                                 [--sort-column SORT_COLUMN]
                                 [--sort-ascending | --sort-descending]
                                 [--matching <hostname>] [--marker <marker>]
                                 [--limit <limit>] [--long]

Table 40.1. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--matching <hostname>

Filter hypervisors using <hostname> substring

--marker <marker>

The uuid of the last hypervisor of the previous page; displays list of hypervisors after marker. (supported with --os-compute-api-version 2.33 or above)

--limit <limit>

Maximum number of hypervisors to display. note that there is a configurable max limit on the server, and the limit that is used will be the minimum of what is requested here and what is configured in the server. (supported with --os-compute-api-version 2.33 or above)

--long

List additional fields in output

Table 40.2. Output formatter options

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Table 40.3. CSV formatter options

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 40.4. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.5. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

40.2. hypervisor show

Display hypervisor details

Usage:

openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <hypervisor>

Table 40.6. Positional arguments

ValueSummary

<hypervisor>

Hypervisor to display (name or id)

Table 40.7. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.8. Output formatter options

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 40.9. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.10. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 40.11. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

40.3. hypervisor stats show

Display hypervisor stats details

Usage:

openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

Table 40.12. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.13. Output formatter options

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Table 40.14. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.15. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 40.16. Table formatter options

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.