Chapter 21. consistency
This chapter describes the commands under the consistency
command.
21.1. consistency group add volume
Add volume(s) to consistency group
Usage:
openstack consistency group add volume [-h] <consistency-group> <volume> [<volume> ...]
Table 21.1. Positional Arguments
Value | Summary |
---|---|
<consistency-group> | Consistency group to contain <volume> (name or id) |
<volume> | Volume(s) to add to <consistency-group> (name or id) (repeat option to add multiple volumes) |
Table 21.2. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
21.2. consistency group create
Create new consistency group.
Usage:
openstack consistency group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] (--volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot>) [--description <description>] [--availability-zone <availability-zone>] [<name>]
Table 21.3. Positional Arguments
Value | Summary |
---|---|
<name> | Name of new consistency group (default to none) |
Table 21.4. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--volume-type <volume-type> | Volume type of this consistency group (name or id) |
--consistency-group-source <consistency-group> | Existing consistency group (name or id) |
--consistency-group-snapshot <consistency-group-snapshot> | Existing consistency group snapshot (name or id) |
--description <description> | Description of this consistency group |
--availability-zone <availability-zone> | Availability zone for this consistency group (not available if creating consistency group from source) |
Table 21.5. 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 21.6. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 21.7. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Table 21.8. Table Formatter
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. |
21.3. consistency group delete
Delete consistency group(s).
Usage:
openstack consistency group delete [-h] [--force] <consistency-group> [<consistency-group> ...]
Table 21.9. Positional Arguments
Value | Summary |
---|---|
<consistency-group> | Consistency group(s) to delete (name or id) |
Table 21.10. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--force | Allow delete in state other than error or available |
21.4. consistency group list
List consistency groups.
Usage:
openstack consistency group 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] [--all-projects] [--long]
Table 21.11. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--all-projects | Show details for all projects. admin only. (defaults to False) |
--long | List additional fields in output |
Table 21.12. 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 21.13. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 21.14. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 21.15. Table Formatter
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. |
21.5. consistency group remove volume
Remove volume(s) from consistency group
Usage:
openstack consistency group remove volume [-h] <consistency-group> <volume> [<volume> ...]
Table 21.16. Positional Arguments
Value | Summary |
---|---|
<consistency-group> | Consistency group containing <volume> (name or id) |
<volume> | Volume(s) to remove from <consistency-group> (name or ID) (repeat option to remove multiple volumes) |
Table 21.17. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
21.6. consistency group set
Set consistency group properties
Usage:
openstack consistency group set [-h] [--name <name>] [--description <description>] <consistency-group>
Table 21.18. Positional Arguments
Value | Summary |
---|---|
<consistency-group> | Consistency group to modify (name or id) |
Table 21.19. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <name> | New consistency group name |
--description <description> | New consistency group description |
21.7. consistency group show
Display consistency group details.
Usage:
openstack consistency group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <consistency-group>
Table 21.20. Positional Arguments
Value | Summary |
---|---|
<consistency-group> | Consistency group to display (name or id) |
Table 21.21. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 21.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 21.23. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 21.24. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Table 21.25. Table Formatter
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. |
21.8. consistency group snapshot create
Create new consistency group snapshot.
Usage:
openstack consistency group snapshot create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--consistency-group <consistency-group>] [--description <description>] [<snapshot-name>]
Table 21.26. Positional Arguments
Value | Summary |
---|---|
<snapshot-name> | Name of new consistency group snapshot (default to None) |
Table 21.27. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--consistency-group <consistency-group> | Consistency group to snapshot (name or id) (default to be the same as <snapshot-name>) |
--description <description> | Description of this consistency group snapshot |
Table 21.28. 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 21.29. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 21.30. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Table 21.31. Table Formatter
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. |
21.9. consistency group snapshot delete
Delete consistency group snapshot(s).
Usage:
openstack consistency group snapshot delete [-h] <consistency-group-snapshot> [<consistency-group-snapshot> ...]
Table 21.32. Positional Arguments
Value | Summary |
---|---|
<consistency-group-snapshot> | Consistency group snapshot(s) to delete (name or id) |
Table 21.33. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
21.10. consistency group snapshot list
List consistency group snapshots.
Usage:
openstack consistency group snapshot 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] [--all-projects] [--long] [--status <status>] [--consistency-group <consistency-group>]
Table 21.34. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--all-projects | Show detail for all projects (admin only) (defaults to False) |
--long | List additional fields in output |
--status <status> | Filters results by a status ("available", "error", "creating", "deleting" or "error_deleting") |
--consistency-group <consistency-group> | Filters results by a consistency group (name or id) |
Table 21.35. 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 21.36. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 21.37. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 21.38. Table Formatter
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. |
21.11. consistency group snapshot show
Display consistency group snapshot details
Usage:
openstack consistency group snapshot show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <consistency-group-snapshot>
Table 21.39. Positional Arguments
Value | Summary |
---|---|
<consistency-group-snapshot> | Consistency group snapshot to display (name or id) |
Table 21.40. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 21.41. 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 21.42. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 21.43. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Table 21.44. Table Formatter
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. |