Chapter 6. aggregate This chapter describes the commands under the aggregate command. 6.1. aggregate add host Add host to aggregate Usage: Table 6.1. Positional arguments Value Summary <aggregate> Aggregate (name or id) <host> Host to add to <aggregate> Table 6.2. Command arguments Value Summary -h, --help Show this help message and exit Table 6.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 Table 6.4. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 6.5. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 6.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. 6.2. aggregate create Create a new aggregate Usage: Table 6.7. Positional arguments Value Summary <name> New aggregate name Table 6.8. 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 6.9. 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 Table 6.10. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 6.11. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 6.12. 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. 6.3. aggregate delete Delete existing aggregate(s) Usage: Table 6.13. Positional arguments Value Summary <aggregate> Aggregate(s) to delete (name or id) Table 6.14. Command arguments Value Summary -h, --help Show this help message and exit 6.4. aggregate list List all aggregates Usage: Table 6.15. Command arguments Value Summary -h, --help Show this help message and exit --long List additional fields in output Table 6.16. 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 --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 6.17. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 6.18. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 6.19. 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. 6.5. aggregate remove host Remove host from aggregate Usage: Table 6.20. Positional arguments Value Summary <aggregate> Aggregate (name or id) <host> Host to remove from <aggregate> Table 6.21. Command arguments Value Summary -h, --help Show this help message and exit Table 6.22. 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 Table 6.23. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 6.24. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 6.25. 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. 6.6. aggregate set Set aggregate properties Usage: Table 6.26. Positional arguments Value Summary <aggregate> Aggregate to modify (name or id) Table 6.27. 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) 6.7. aggregate show Display aggregate details Usage: Table 6.28. Positional arguments Value Summary <aggregate> Aggregate to display (name or id) Table 6.29. Command arguments Value Summary -h, --help Show this help message and exit Table 6.30. 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 Table 6.31. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 6.32. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 6.33. 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. 6.8. aggregate unset Unset aggregate properties Usage: Table 6.34. Positional arguments Value Summary <aggregate> Aggregate to modify (name or id) Table 6.35. 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 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] [--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>