Chapter 19. compute

This chapter describes the commands under the compute command.

19.1. compute agent create

Create compute agent

Usage:

openstack compute agent create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      <os> <architecture> <version> <url>
                                      <md5hash> <hypervisor>

Table 19.1. Positional Arguments

ValueSummary

<os>

Type of os

<architecture>

Type of architecture

<version>

Version

<url>

Url

<md5hash>

Md5 hash

<hypervisor>

Type of hypervisor

Table 19.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 19.3. Output Formatters

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

Table 19.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 19.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 19.6. 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.

19.2. compute agent delete

Delete compute agent(s)

Usage:

openstack compute agent delete [-h] <id> [<id> ...]

Table 19.7. Positional Arguments

ValueSummary

<id>

Id of agent(s) to delete

Table 19.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

19.3. compute agent list

List compute agents

Usage:

openstack compute agent 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]
                                    [--hypervisor <hypervisor>]

Table 19.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--hypervisor <hypervisor>

Type of hypervisor

Table 19.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 19.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 19.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 19.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.

19.4. compute agent set

Set compute agent properties

Usage:

openstack compute agent set [-h] [--agent-version <version>]
                                   [--url <url>] [--md5hash <md5hash>]
                                   <id>

Table 19.14. Positional Arguments

ValueSummary

<id>

Id of the agent

Table 19.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--agent-version <version>

Version of the agent

--url <url>

Url of the agent

--md5hash <md5hash>

Md5 hash of the agent

19.5. compute service delete

Delete compute service(s)

Usage:

openstack compute service delete [-h] <service> [<service> ...]

Table 19.16. Positional Arguments

ValueSummary

<service>

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.

Table 19.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

19.6. compute service list

List compute services. 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.

Usage:

openstack compute service 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]
                                      [--host <host>] [--service <service>]
                                      [--long]

Table 19.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--host <host>

List services on specified host (name only)

--service <service>

List only specified service binaries (name only). for example, ``nova-compute``, ``nova-conductor``, etc.

--long

List additional fields in output

Table 19.19. 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 19.20. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 19.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 19.22. 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.

19.7. compute service set

Set compute service properties

Usage:

openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     [--up | --down]
                                     <host> <service>

Table 19.23. Positional Arguments

ValueSummary

<host>

Name of host

<service>

Name of service (binary name), for example ``nova- compute``

Table 19.24. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--enable

Enable service

--disable

Disable service

--disable-reason <reason>

Reason for disabling the service (in quotes). should be used with --disable option.

--up

Force up service. requires ``--os-compute-api- version`` 2.11 or greater.

--down

Force down service. requires ``--os-compute-api- version`` 2.11 or greater.