openstack.block_storage.v3.cluster

The Cluster Class

The Cluster class inherits from Resource.

class openstack.block_storage.v3.cluster.Cluster(_synchronized=False, connection=None, **attrs)

The base resource

Parameters:

• _synchronized – This is not intended to be used directly. See new() and existing().

• connection – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

resource_key = 'cluster'

Singular form of key for resource.

resources_key = 'clusters'

Plural form of key for resource.

base_path = '/clusters'

The base part of the URI for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_list = True

Allow list operation for this resource.

active_backend_id

The ID of active storage backend (cinder-volume services only).

binary

The binary name of the services in the cluster.

created_at

The date and time when the resource was created.

disabled_reason

The reason for disabling the cluster.

frozen

Whether the cluster is frozen for replication.

last_heartbeat

The last periodic heartbeat received.

name

The name of the cluster.

num_down_hosts

The number of down hosts in the cluster.

num_hosts

The number of hosts in the cluster.

replication_status

The cluster replication status.

state

The state of the cluster. One of up or down.

status

The status of the cluster. One of enabled or disabled.

updated_at

The date and time when the resource was last updated.

enable(session)

Enable scheduling for the cluster.

disable(session, *, reason=None)

Disable scheduling for the cluster.

Parameters:

reason – The reason for disabling the cluster.