Chapter 5. aggregate

5.1. aggregate add host

Add host to aggregate

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>

Table 5.1. Table Formatter
Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 5.2. Positional Arguments
Value	Summary
<aggregate>	Aggregate (name or id)
<host>	Host to add to <aggregate>

Table 5.3. Output Formatters
Value	Summary
output formatter options-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 5.4. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 5.5. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

Table 5.6. Shell Formatter
Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

5.2. aggregate create

Create a new aggregate

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>

Table 5.7. Table Formatter
Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 5.8. Positional Arguments
Value	Summary
<name>	New aggregate name

Table 5.9. Output Formatters
Value	Summary
output formatter options-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 5.10. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 5.11. Optional Arguments
Value	Summary
-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 5.12. Shell Formatter
Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

5.3. aggregate delete

Delete existing aggregate(s)

Usage:

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

Table 5.13. Positional Arguments
Value	Summary
<aggregate>	Aggregate(s) to delete (name or id)

Table 5.14. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

5.4. aggregate list

List all aggregates

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]

Table 5.15. Table Formatter
Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 5.16. CSV Formatter
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 5.17. Output Formatters
Value	Summary
output formatter options-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 5.18. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 5.19. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit
--long	List additional fields in output

5.5. aggregate remove host

Remove host from aggregate

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>

Table 5.20. Table Formatter
Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 5.21. Positional Arguments
Value	Summary
<aggregate>	Aggregate (name or id)
<host>	Host to remove from <aggregate>

Table 5.22. Output Formatters
Value	Summary
output formatter options-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 5.23. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 5.24. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

Table 5.25. Shell Formatter
Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

5.6. aggregate set

Set aggregate properties

Usage:

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

Table 5.26. Positional Arguments
Value	Summary
<aggregate>	Aggregate to modify (name or id)

Table 5.27. Optional Arguments
Value	Summary
--name <name>	Set aggregate name
-h, --help	Show this help message and exit
--zone <availability-zone>	Set availability zone name
--no-property	Remove all properties from <aggregate> (specify both --property and --no-property to overwrite the current properties)
--property <key=value>	Property to set on <aggregate> (repeat option to set multiple properties)

5.7. aggregate show

Display aggregate details

Usage:

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

Table 5.28. Table Formatter
Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 5.29. Positional Arguments
Value	Summary
<aggregate>	Aggregate to display (name or id)

Table 5.30. Output Formatters
Value	Summary
output formatter options-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 5.31. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 5.32. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

Table 5.33. Shell Formatter
Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

5.8. aggregate unset

Unset aggregate properties

Usage:

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

Table 5.34. Positional Arguments
Value	Summary
<aggregate>	Aggregate to modify (name or id)

Table 5.35. Optional Arguments
Value	Summary
--property <key>	Property to remove from aggregate (repeat option to remove multiple properties)
-h, --help	Show this help message and exit

5.1. aggregate add host

5.2. aggregate create

5.3. aggregate delete

5.4. aggregate list

5.5. aggregate remove host

5.6. aggregate set

5.7. aggregate show

5.8. aggregate unset

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links