Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 5. aggregate

This chapter describes the commands under the aggregate command.

5.1. aggregate add host
Copy link

Usage:

openstack aggregate add host [-h] [-f {json,shell,table,value,yaml}]

                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <aggregate> <host>
Copy to Clipboard Toggle word wrap

Add host to aggregate

Expand
Table 5.1. Positional Arguments
ValueSummary

<aggregate>

Aggregate (name or id)

<host>

Host to add to <aggregate>

Expand
Table 5.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 5.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

Expand
Table 5.4. 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.

Expand
Table 5.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 5.6. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

5.2. aggregate create
Copy link

Usage:

openstack aggregate create [-h] [-f {json,shell,table,value,yaml}]

                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                [--zone <availability-zone>]
                                [--property <key=value>]
                                <name>
Copy to Clipboard Toggle word wrap

Create a new aggregate

Expand
Table 5.7. Positional Arguments
ValueSummary

<name>

New aggregate name

Expand
Table 5.8. Optional 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)

Expand
Table 5.9. 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

Expand
Table 5.10. 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.

Expand
Table 5.11. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 5.12. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

5.3. aggregate delete
Copy link

Usage:

openstack aggregate delete [-h] <aggregate> [<aggregate> ...]
Copy to Clipboard Toggle word wrap

Delete existing aggregate(s)

Expand
Table 5.13. Positional Arguments
ValueSummary

<aggregate>

Aggregate(s) to delete (name or id)

Expand
Table 5.14. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

5.4. aggregate list
Copy link

Usage:

openstack aggregate list [-h] [-f {csv,json,table,value,yaml}]

                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

List all aggregates

Expand
Table 5.15. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 5.16. 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

Expand
Table 5.17. 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.

Expand
Table 5.18. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 5.19. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

5.5. aggregate remove host
Copy link

Usage:

openstack aggregate remove host [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <aggregate> <host>
Copy to Clipboard Toggle word wrap

Remove host from aggregate

Expand
Table 5.20. Positional Arguments
ValueSummary

<aggregate>

Aggregate (name or id)

<host>

Host to remove from <aggregate>

Expand
Table 5.21. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 5.22. 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

Expand
Table 5.23. 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.

Expand
Table 5.24. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 5.25. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

5.6. aggregate set
Copy link

Usage:

openstack aggregate set [-h] [--name <name>]

                             [--zone <availability-zone>]
                             [--property <key=value>] [--no-property]
                             <aggregate>
Copy to Clipboard Toggle word wrap

Set aggregate properties

Expand
Table 5.26. Positional Arguments
ValueSummary

<aggregate>

Aggregate to modify (name or id)

Expand
Table 5.27. Optional 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)

5.7. aggregate show
Copy link

Usage:

openstack aggregate show [-h] [-f {json,shell,table,value,yaml}]

                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX]
                              <aggregate>
Copy to Clipboard Toggle word wrap

Display aggregate details

Expand
Table 5.28. Positional Arguments
ValueSummary

<aggregate>

Aggregate to display (name or id)

Expand
Table 5.29. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 5.30. 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

Expand
Table 5.31. 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.

Expand
Table 5.32. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 5.33. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

5.8. aggregate unset
Copy link

Usage:

openstack aggregate unset [-h] [--property <key>] <aggregate>
Copy to Clipboard Toggle word wrap

Unset aggregate properties

Expand
Table 5.34. Positional Arguments
ValueSummary

<aggregate>

Aggregate to modify (name or id)

Expand
Table 5.35. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key>

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

Back to top
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. Explore our recent updates.

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.

Theme

© 2025 Red Hat