Chapter 39. host

This chapter describes the commands under the host command.

39.1. host list

List hosts

Usage:

openstack host 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]
                           [--zone <zone>]

Table 39.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--zone <zone>

Only return hosts in the availability zone

Table 39.2. Output Formatters

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

--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

Table 39.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 39.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.5. Table Formatter

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.

39.2. host set

Set host properties

Usage:

openstack host set [-h] [--enable | --disable]
                          [--enable-maintenance | --disable-maintenance]
                          <host>

Table 39.6. Positional Arguments

ValueSummary

<host>

Host to modify (name only)

Table 39.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--enable

Enable the host

--disable

Disable the host

--enable-maintenance

Enable maintenance mode for the host

--disable-maintenance

Disable maintenance mode for the host

39.3. host show

Display host details

Usage:

openstack host show [-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]
                           <host>

Table 39.8. Positional Arguments

ValueSummary

<host>

Name of host

Table 39.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 39.10. Output Formatters

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

--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

Table 39.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 39.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 39.13. Table Formatter

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.