SupportConsoleDevelopersStart a trialContact

Chapter 6. aggregate

This chapter describes the commands under the aggregate command.

6.1. aggregate add host

Add host to aggregate

Usage:

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

Table 6.1. Positional arguments
ValueSummary

<aggregate>

Aggregate (name or id)

<host>

Host to add to <aggregate>

Table 6.2. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 6.3. 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 6.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 6.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

6.2. aggregate cache image

Request image caching for aggregate

Usage:

openstack aggregate cache image [-h] <aggregate> <image> [<image> ...]

Table 6.7. Positional arguments
ValueSummary

<aggregate>

Aggregate (name or id)

<image>

Image id to request caching for aggregate (name or id). may be specified multiple times.

Table 6.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

6.3. aggregate create

Create a new aggregate

Usage:

openstack aggregate create [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty] [--zone <availability-zone>]
                                  [--property <key=value>]
                                  <name>

Table 6.9. Positional arguments
ValueSummary

<name>

New aggregate name

Table 6.10. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--zone <availability-zone>

Availability zone name

--property <key=value>

Property to add to this aggregate (repeat option to set multiple properties)

Table 6.11. 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 6.12. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 6.13. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

6.4. aggregate delete

Delete existing aggregate(s)

Usage:

openstack aggregate delete [-h] <aggregate> [<aggregate> ...]

Table 6.15. Positional arguments
ValueSummary

<aggregate>

Aggregate(s) to delete (name or id)

Table 6.16. Command arguments
ValueSummary

-h, --help

Show this help message and exit

6.5. aggregate list

List all aggregates

Usage:

openstack aggregate 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]
                                [--long]

Table 6.17. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 6.18. 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 6.19. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 6.20. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

6.6. aggregate remove host

Remove host from aggregate

Usage:

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

Table 6.22. Positional arguments
ValueSummary

<aggregate>

Aggregate (name or id)

<host>

Host to remove from <aggregate>

Table 6.23. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 6.24. 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 6.25. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 6.26. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

6.7. aggregate set

Set aggregate properties

Usage:

openstack aggregate set [-h] [--name <name>]
                               [--zone <availability-zone>]
                               [--property <key=value>] [--no-property]
                               <aggregate>

Table 6.28. Positional arguments
ValueSummary

<aggregate>

Aggregate to modify (name or id)

Table 6.29. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set aggregate name

--zone <availability-zone>

Set availability zone name

--property <key=value>

Property to set on <aggregate> (repeat option to set multiple properties)

--no-property

Remove all properties from <aggregate> (specify both --property and --no-property to overwrite the current properties)

6.8. aggregate show

Display aggregate details

Usage:

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

Table 6.30. Positional arguments
ValueSummary

<aggregate>

Aggregate to display (name or id)

Table 6.31. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 6.32. 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 6.33. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 6.34. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

6.9. aggregate unset

Unset aggregate properties

Usage:

openstack aggregate unset [-h] [--property <key>] <aggregate>

Table 6.36. Positional arguments
ValueSummary

<aggregate>

Aggregate to modify (name or id)

Table 6.37. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from aggregate (repeat option to remove multiple properties)

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.