Chapter 5. aggregate This chapter describes the commands under the aggregate command. 5.1. aggregate add host Add host to aggregate Usage: Table 5.1. Positional arguments Value Summary <aggregate> Aggregate (name or id) <host> Host to add to <aggregate> Table 5.2. Command arguments Value Summary -h, --help Show this help message and exit Table 5.3. Output formatter options 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 Table 5.4. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 5.5. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 5.6. Table formatter options 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. 5.2. aggregate cache image Request image caching for aggregate Usage: Table 5.7. Positional arguments Value Summary <aggregate> Aggregate (name or id) <image> Image id to request caching for aggregate (name or id). may be specified multiple times. Table 5.8. Command arguments Value Summary -h, --help Show this help message and exit 5.3. aggregate create Create a new aggregate Usage: Table 5.9. Positional arguments Value Summary <name> New aggregate name Table 5.10. Command 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.11. Output formatter options 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 Table 5.12. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 5.13. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 5.14. Table formatter options 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. 5.4. aggregate delete Delete existing aggregate(s) Usage: Table 5.15. Positional arguments Value Summary <aggregate> Aggregate(s) to delete (name or id) Table 5.16. Command arguments Value Summary -h, --help Show this help message and exit 5.5. aggregate list List all aggregates Usage: Table 5.17. Command arguments Value Summary -h, --help Show this help message and exit --long List additional fields in output Table 5.18. Output formatter options 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 Table 5.19. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 5.20. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 5.21. Table formatter options 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. 5.6. aggregate remove host Remove host from aggregate Usage: Table 5.22. Positional arguments Value Summary <aggregate> Aggregate (name or id) <host> Host to remove from <aggregate> Table 5.23. Command arguments Value Summary -h, --help Show this help message and exit Table 5.24. Output formatter options 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 Table 5.25. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 5.26. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 5.27. Table formatter options 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. 5.7. aggregate set Set aggregate properties Usage: Table 5.28. Positional arguments Value Summary <aggregate> Aggregate to modify (name or id) Table 5.29. Command arguments Value Summary -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.8. aggregate show Display aggregate details Usage: Table 5.30. Positional arguments Value Summary <aggregate> Aggregate to display (name or id) Table 5.31. Command arguments Value Summary -h, --help Show this help message and exit Table 5.32. Output formatter options 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 Table 5.33. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 5.34. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 5.35. Table formatter options 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. 5.9. aggregate unset Unset aggregate properties Usage: Table 5.36. Positional arguments Value Summary <aggregate> Aggregate to modify (name or id) Table 5.37. Command arguments Value Summary -h, --help Show this help message and exit --property <key> Property to remove from aggregate (repeat option to remove multiple properties)

Commands:
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>
openstack aggregate cache image [-h] <aggregate> <image> [<image> ...]
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>
openstack aggregate delete [-h] <aggregate> [<aggregate> ...]
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]
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>
openstack aggregate set [-h] [--name <name>] [--zone <availability-zone>] [--property <key=value>] [--no-property] <aggregate>
openstack aggregate show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <aggregate>
openstack aggregate unset [-h] [--property <key>] <aggregate>