cinder.api.v3.groups module¶

The groups controller.

class GroupsController¶

Bases: Controller

The groups API controller for the OpenStack API.

create(req, body)¶

Create a new group.

create_from_src(req, body)¶

Create a new group from a source.

The source can be a group snapshot or a group. Note that this does not require group_type and volume_types as the “create” API above.

delete_group(req, id, body)¶

detail(req)¶

Returns a detailed list of groups.

disable_replication(req, id, body)¶

Disables replications for a group.

enable_replication(req, id, body)¶

Enables replications for a group.

failover_replication(req, id, body)¶

Fails over replications for a group.

index(req)¶

Returns a summary list of groups.

list_replication_targets(req, id, body)¶

List replication targets for a group.

reset_status(req, id, body)¶

show(req, id)¶

Return data about the given group.

update(req, id, body)¶

Update the group.

Expected format of the input parameter ‘body’:

{
    "group":
    {
        "name": "my_group",
        "description": "My group",
        "add_volumes": "volume-uuid-1,volume-uuid-2,...",
        "remove_volumes": "volume-uuid-8,volume-uuid-9,..."
    }
}

versioned_methods = {'create': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'create_from_src': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'delete_group': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'detail': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'disable_replication': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'enable_replication': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'failover_replication': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'index': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'list_replication_targets': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'reset_status': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'show': [<cinder.api.openstack.versioned_method.VersionedMethod object>], 'update': [<cinder.api.openstack.versioned_method.VersionedMethod object>]}¶

wsgi_actions = {'create-from-src': 'create_from_src', 'delete': 'delete_group', 'disable_replication': 'disable_replication', 'enable_replication': 'enable_replication', 'failover_replication': 'failover_replication', 'list_replication_targets': 'list_replication_targets', 'reset_status': 'reset_status'}¶

wsgi_extensions = []¶

create_resource()¶