Consistency groups
- consistencyGroups()
get the list of consistency groups
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string | if specified, one get exactly one cgroup instance |
Return value: List of Group
Return value example:
istack/volumev2/v2/goup Group
name : python-cg0
id : 6f519a48-3183-46cf-a32f-41815f813986
2. create_cgroup(**Attrs)
create a cgroup
Parameters:
| Name | Type | Description |
|---|---|---|
| name | xsd:string | The name of the consistency group. |
| description | xsd:string | The description of the consistency group. |
| volume_types | xsd:list | The list of volume types. In an environment with multiple-storage back ends, the scheduler determines where to send the volume based on the volume type. For information about how to use volume types to create multiple-storage back ends, see Configure multiple-storage back ends. |
| user_id | csapi:UUID | The UUID of the user. |
| project_id | csapi:UUID | The UUID of the project. |
| availability_zone (Optional) | xsd:string | The name of the availability zone. |
| status | xsd:string | The status of the consistency group. |
Return value: Group
Return value example:
stack/volumev2/v2/goup Group
name : python-cg0
id : 6f519a48-3183-46cf-a32f-41815f813986
3. create_cgroup_from_src(**attrs)
create one from source
Parameters:
| Name | Type | Description |
|---|---|---|
| name | xsd:string | The name of the consistency group. |
| description (Optional) | xsd:string | The description of the consistency group. |
| cgsnapshot_id (Optional) | csapi:UUID | The UUID of the consistency group snapshot. |
| source_cgid (Optional) | csapi:UUID | The UUID of the source consistency group. |
| user_id | csapi:UUID | The UUID of the user. |
| project_id | csapi:UUID | The UUID of the project. |
| status | xsd:string | The status of the consistency group |
Return value: Group
Return value example:
stack/volumev2/v2/goup Group
name : python-cg0
id : 6f519a48-3183-46cf-a32f-41815f813986
4. update_cgroup(cgroup, **attrs)
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string(inside cgroup param) | must be specified |
| name (Optional) | xsd:string | The consistency group name. |
| description (Optional) | xsd:string | The consistency group description. |
| add_volumes (Optional) | xsd:string | One or more volume UUIDs, separated by commas, to add to the volume consistency group. |
| remove_volumes (Optional) | xsd:string | One or more volume UUIDs, separated by commas, to remove from the volume consistency group. |
Return value: Group
Return value example:
stack/volumev2/v2/goup Group
name : python-cg0
id : 6f519a48-3183-46cf-a32f-41815f813986
5. delete_cgroup(cgroup, **attrs)
delete the consistency group
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string | must be specified |
Return value: None