Chapter 19. consistency
This chapter describes the commands under the consistency command.
19.1. consistency group add volume
Add volume(s) to consistency group
Usage:
openstack consistency group add volume [-h]
<consistency-group> <volume>
[<volume> ...]
Table 19.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 19.2. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
19.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 19.3. Positional arguments
| Value | Summary |
|---|---|
| <name> | Name of new consistency group (default to none) |
Table 19.4. Command 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 19.5. 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 19.6. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 19.7. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 19.8. 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. |
19.3. consistency group delete
Delete consistency group(s).
Usage:
openstack consistency group delete [-h] [--force]
<consistency-group>
[<consistency-group> ...]
Table 19.9. Positional arguments
| Value | Summary |
|---|---|
| <consistency-group> | Consistency group(s) to delete (name or id) |
Table 19.10. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --force | Allow delete in state other than error or available |
19.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 19.11. Command 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 19.12. 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 19.13. CSV formatter options
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 19.14. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 19.15. 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. |
19.5. consistency group remove volume
Remove volume(s) from consistency group
Usage:
openstack consistency group remove volume [-h]
<consistency-group> <volume>
[<volume> ...]
Table 19.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 19.17. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
19.6. consistency group set
Set consistency group properties
Usage:
openstack consistency group set [-h] [--name <name>]
[--description <description>]
<consistency-group>
Table 19.18. Positional arguments
| Value | Summary |
|---|---|
| <consistency-group> | Consistency group to modify (name or id) |
Table 19.19. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --name <name> | New consistency group name |
| --description <description> | New consistency group description |
19.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 19.20. Positional arguments
| Value | Summary |
|---|---|
| <consistency-group> | Consistency group to display (name or id) |
Table 19.21. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 19.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 19.23. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 19.24. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 19.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. |
19.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 19.26. Positional arguments
| Value | Summary |
|---|---|
| <snapshot-name> | Name of new consistency group snapshot (default to None) |
Table 19.27. Command 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 19.28. 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 19.29. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 19.30. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 19.31. 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. |
19.9. consistency group snapshot delete
Delete consistency group snapshot(s).
Usage:
openstack consistency group snapshot delete [-h]
<consistency-group-snapshot>
[<consistency-group-snapshot> ...]
Table 19.32. Positional arguments
| Value | Summary |
|---|---|
| <consistency-group-snapshot> | Consistency group snapshot(s) to delete (name or id) |
Table 19.33. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
19.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 19.34. Command 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 19.35. 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 19.36. CSV formatter options
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 19.37. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 19.38. 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. |
19.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 19.39. Positional arguments
| Value | Summary |
|---|---|
| <consistency-group-snapshot> | Consistency group snapshot to display (name or id) |
Table 19.40. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 19.41. 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 19.42. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 19.43. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 19.44. 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. |
