Chapter 18. compute
This chapter describes the commands under the compute command.
18.1. compute agent create
Create compute agent. The compute agent functionality is hypervisor specific and is only supported by the XenAPI hypervisor driver. It was removed from nova in the 23.0.0 (Wallaby) release.
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>
| Value | Summary |
|---|---|
| <os> | Type of os |
| <architecture> | Type of architecture |
| <version> | Version |
| <url> | Url |
| <md5hash> | Md5 hash |
| <hypervisor> | Type of hypervisor |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| Value | Summary |
|---|---|
| -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 |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
| Value | Summary |
|---|---|
| --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. |
18.2. compute agent delete
Delete compute agent(s). The compute agent functionality is hypervisor specific and is only supported by the XenAPI hypervisor driver. It was removed from nova in the 23.0.0 (Wallaby) release.
Usage:
openstack compute agent delete [-h] <id> [<id> ...]
| Value | Summary |
|---|---|
| <id> | Id of agent(s) to delete |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
18.3. compute agent list
List compute agents. The compute agent functionality is hypervisor specific and is only supported by the XenAPI hypervisor driver. It was removed from nova in the 23.0.0 (Wallaby) release.
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]
[--sort-ascending | --sort-descending]
[--hypervisor <hypervisor>]
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --hypervisor <hypervisor> | Type of hypervisor |
| Value | Summary |
|---|---|
| -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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --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. |
18.4. compute agent set
Set compute agent properties. The compute agent functionality is hypervisor specific and is only supported by the XenAPI hypervisor driver. It was removed from nova in the 23.0.0 (Wallaby) release.
Usage:
openstack compute agent set [-h] [--agent-version <version>]
[--url <url>] [--md5hash <md5hash>]
<id>
| Value | Summary |
|---|---|
| <id> | Id of the agent |
| Value | Summary |
|---|---|
| -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 |
18.5. compute service delete
Delete compute service(s)
Usage:
openstack compute service delete [-h] <service> [<service> ...]
| Value | Summary |
|---|---|
| <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. |
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
18.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]
[--sort-ascending | --sort-descending]
[--host <host>] [--service <service>]
[--long]
| Value | Summary |
|---|---|
| -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 |
| Value | Summary |
|---|---|
| -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 |
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
| Value | Summary |
|---|---|
| --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. |
18.7. compute service set
Set compute service properties
Usage:
openstack compute service set [-h] [--enable | --disable]
[--disable-reason <reason>]
[--up | --down]
<host> <service>
| Value | Summary |
|---|---|
| <host> | Name of host |
| <service> | Name of service (binary name), for example ``nova- compute`` |
| Value | Summary |
|---|---|
| -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. |
