The cinder.objects.cluster Module

The cinder.objects.cluster Module

class Cluster(context=None, **kwargs)

Bases: cinder.objects.base.CinderPersistentObject, cinder.objects.base.CinderObject, cinder.objects.base.CinderComparableObject

Cluster Versioned Object.

Method get_by_id supports as additional named arguments:
  • get_services: If we want to load all services from this cluster.
  • services_summary: If we want to load num_nodes and num_down_nodes
    fields.
  • is_up: Boolean value to filter based on the cluster’s up status.
  • read_deleted: Filtering based on delete status. Default value “no”.
  • Any other cluster field will be used as a filter.
OPTIONAL_FIELDS = ('num_hosts', 'num_down_hosts', 'services')
VERSION = '1.1'
active_backend_id
binary
create()
created_at
deleted
deleted_at
destroy()
disabled
disabled_reason
fields = {'binary': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'deleted_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'frozen': Boolean(default=False,nullable=False), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'deleted': Boolean(default=False,nullable=True), 'num_down_hosts': Integer(default=0,nullable=False), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'num_hosts': Integer(default=0,nullable=False), 'disabled': Boolean(default=False,nullable=True), 'active_backend_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'replication_status': ReplicationStatus(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True,valid_values=('error', 'enabled', 'disabled', 'not-capable', 'failover-error', 'failing-over', 'failed-over', 'enabling', 'disabling')), 'services': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'last_heartbeat': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'disabled_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False)}
frozen
id
is_up
last_heartbeat
model

alias of Cluster

name
num_down_hosts
num_hosts
obj_load_attr(attrname)

Lazy load services attribute.

obj_make_compatible(primitive, target_version)

Make a cluster representation compatible with a target version.

replication_status
save()
services
updated_at
class ClusterList(*args, **kwargs)

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

VERSION = '1.0'
fields = {'objects': List(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False)}
classmethod get_all(context, is_up=None, get_services=False, services_summary=False, read_deleted='no', **filters)

Get all clusters that match the criteria.

Parameters:
  • is_up – Boolean value to filter based on the cluster’s up status.
  • get_services – If we want to load all services from this cluster.
  • services_summary – If we want to load num_nodes and num_down_nodes fields.
  • read_deleted – Filtering based on delete status. Default value is “no”.
  • filters – Field based filters in the form of key/value.
objects
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.