openstack.shared_file_system.v2.share_instance¶

The ShareInstance Class¶

The ShareInstance class inherits from Resource.

class openstack.shared_file_system.v2.share_instance.ShareInstance(_synchronized=False, connection=None, **attrs)¶

The base resource

Parameters:

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

• connection (openstack.connection.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 = 'share_instance'¶

Singular form of key for resource.

resources_key = 'share_instances'¶

Plural form of key for resource.

base_path = '/share_instances'¶

The base part of the URI for this resource.

allow_create = False¶

Allow create operation for this resource.

allow_fetch = True¶

Allow get operation for this resource.

allow_commit = False¶

Allow update operation for this resource.

allow_delete = False¶

Allow delete operation for this resource.

allow_list = True¶

Allow list operation for this resource.

allow_head = False¶

Allow head operation for this resource.

access_rules_status¶

Properties The share instance access rules status. A valid value is active, error, or syncing.

availability_zone¶

The name of the availability zone the share exists within.

cast_rules_to_readonly¶

If the share instance has its cast_rules_to_readonly attribute set to True, all existing access rules be cast to read/only.

created_at¶

The date and time stamp when the resource was created within the service’s database.

host¶

The host name of the service back end that the resource is contained within.

progress¶

The progress of the share creation.

replica_state¶

The share replica state. Has set value only when replication is used. List of possible values: active, in_sync, out_of_sync, error

share_id¶

The UUID of the share to which the share instance belongs to.

share_network_id¶

The share network ID where the resource is exported to.

share_server_id¶

The UUID of the share server.

status¶

The share or share instance status.

reset_status(session, reset_status)¶

Reset share instance to given status

force_delete(session)¶

Force delete share instance