openstack.shared_file_system.v2.share_snapshot

The ShareSnapshot Class

The ShareSnapshot class inherits from Resource.

class openstack.shared_file_system.v2.share_snapshot.ShareSnapshot(_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 = 'snapshot'

Singular form of key for resource.

resources_key = 'snapshots'

Plural form of key for resource.

base_path = '/snapshots'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_commit = True

Allow update operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_list = True

Allow list operation for this resource.

allow_head = False

Allow head operation for this resource.

created_at

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

description

The user defined description of the resource.

display_name

The user defined name of the resource.

display_description

The user defined description of the resource

project_id

ID of the project that the snapshot belongs to.

share_id

The UUID of the source share that was used to create the snapshot.

share_proto

The file system protocol of a share snapshot

share_size

The snapshot’s source share’s size, in GiBs.

size

The snapshot size, in GiBs.

status

The snapshot status

user_id

ID of the user that the snapshot was created by.

reset_status(session, status)

Reset the snapshot to the given status.

Parameters:

status – The status of the share to reset to.

Returns:

None

force_delete(session)

Force delete the snapshot.

Returns:

None

manage(session, share_id, provider_location, **params)

Manage a share snapshot.

Parameters:

• session – A session object used for sending request.

• share_id – The UUID of the share that has snapshot which should be managed.

• provider_location – Provider location of the snapshot on the backend.

• params –

  Optional parameters to be sent. Available parameters include:

  • name: The user defined name of the resource.

  • display_name: The user defined name of the resource. This field sets the name parameter.

  • description: The user defined description of the resource.

  • display_description: The user defined description of the resource. This field sets the description parameter.

  • driver_options: A set of one or more key and value pairs, as a dictionary of strings, that describe driver options.

Returns:

The share snapshot that was managed.

unmanage(session)

Unmanage a share snapshot.

Parameters:

session – A session object used for sending request.

Returns:

None