The cinder.objects.consistencygroup Module

class ConsistencyGroup(context=None, **kwargs)

Bases: cinder.objects.base.CinderPersistentObject, cinder.objects.base.CinderObject, cinder.objects.base.CinderObjectDictCompat, cinder.objects.base.ClusteredObject

OPTIONAL_FIELDS = (‘cgsnapshots’, ‘volumes’, ‘cluster’)
VERSION = ‘1.4’
availability_zone
cgsnapshot_id
cgsnapshots
cluster
cluster_name
create(cg_snap_id=None, cg_id=None)

Create a consistency group.

If cg_snap_id or cg_id are specified then volume_type_id, availability_zone, and host will be taken from the source Consistency Group.

created_at
deleted
deleted_at
description
destroy()
fields = {‘status’: ConsistencyGroupStatus(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True,valid_values=(‘error’, ‘available’, ‘creating’, ‘deleting’, ‘deleted’, ‘updating’, ‘error_deleting’)), ‘volume_type_id’: String(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘deleted_at’: DateTime(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘user_id’: String(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=False), ‘description’: String(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘availability_zone’: String(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘deleted’: Boolean(default=False,nullable=True), ‘created_at’: DateTime(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘updated_at’: DateTime(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘cgsnapshot_id’: UUID(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘cluster_name’: String(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘cluster’: Object(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘host’: String(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘source_cgid’: UUID(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘volumes’: Object(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘project_id’: String(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=False), ‘id’: UUID(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=False), ‘cgsnapshots’: Object(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True), ‘name’: String(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=True)}
from_group(group)

Convert a generic volume group object to a cg object.

host
id
model

alias of ConsistencyGroup

name
obj_load_attr(attrname)
obj_make_compatible(primitive, target_version)

Make a CG representation compatible with a target version.

project_id
save()
source_cgid
status
updated_at
user_id
volume_type_id
volumes
class ConsistencyGroupList(*args, **kwargs)

Bases: cinder.objects.base.ObjectListBase, cinder.objects.base.CinderObject

VERSION = ‘1.1’
fields = {‘objects’: List(default=<class ‘oslo_versionedobjects.fields.UnspecifiedDefault’>,nullable=False)}
classmethod get_all(context, filters=None, marker=None, limit=None, offset=None, sort_keys=None, sort_dirs=None)
classmethod get_all_by_project(context, project_id, filters=None, marker=None, limit=None, offset=None, sort_keys=None, sort_dirs=None)
static include_in_cluster(context, cluster, partial_rename=True, **filters)

Include all consistency groups matching the filters into a cluster.

When partial_rename is set we will not set the cluster_name with cluster parameter value directly, we’ll replace provided cluster_name or host filter value with cluster instead.

This is useful when we want to replace just the cluster name but leave the backend and pool information as it is. If we are using cluster_name to filter, we’ll use that same DB field to replace the cluster value and leave the rest as it is. Likewise if we use the host to filter.

Returns the number of consistency groups that have been changed.

objects