otcextensions.sdk.cbr.v3.checkpoint¶

The CBR Checkpoint Class¶

The Checkpoint class inherits from Resource.

class otcextensions.sdk.cbr.v3.checkpoint.Checkpoint(_synchronized=False, connection=None, **attrs)¶

CBR Checkpoint Resource

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: ty.Optional[str] = 'checkpoint'¶: Singular form of key for resource.

resources_key: ty.Optional[str] = ''¶: Plural form of key for resource.

base_path: str = '/checkpoints'¶: The base part of the URI for this resource.

allow_create = True¶: Allow create operation for this resource.

allow_list = False¶: Allow list operation for this resource.

allow_fetch = True¶: Allow get operation for this resource.

allow_delete = False¶: Allow delete operation for this resource.

allow_commit = False¶: Allow update operation for this resource.

created_at¶: Properties Creation time Example: 2020-02-05T10:38:34.209782

extra_info¶: Extra info

id¶: Resoure point ID

parameters¶: Checkpoint creation parameters

project_id¶: Project ID

status¶: Status

vault¶: Vault information

vault_id¶: Vault ID for checkpoint creation

class otcextensions.sdk.cbr.v3.checkpoint.Parameters(_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.

auto_trigger¶: Properties Whether automatic triggering is enabled

description¶: Backup description

incremental¶: Whether the backup is an incremental backup

name: ty.Union[Body, URI]¶: Backup name

resources¶: UUID list of resources to be backed up

class otcextensions.sdk.cbr.v3.checkpoint.ResourceDetails(_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.

extra_info¶: Checkpoint resource creation Properties Extra information of the resource

id¶: ID of the resource to be backed up

name: ty.Union[Body, URI]¶: Name of the resource to be backed up

resource_type¶: Type of the resource to be backed up

class otcextensions.sdk.cbr.v3.checkpoint.ResourceExtraInfo(_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.

exclude_volumes¶: Properties List of IDs that is excluded from backup.

include_volumes¶: Disk to be backed up

class otcextensions.sdk.cbr.v3.checkpoint.IncludeVolumes(_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.

id¶: Properties EVS disk UUID

os_version¶: OS type

class otcextensions.sdk.cbr.v3.checkpoint.Vault(_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.

id¶: Properties Vault ID

name: ty.Union[Body, URI]¶: Vault name

resources¶: Backup objects

skipped_resources¶: Resources skipped during backup

class otcextensions.sdk.cbr.v3.checkpoint.SkippedResource(_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.

code¶: Properties Error Codes

id¶: Resource ID

name: ty.Union[Body, URI]¶: Resource name

reason¶: Reason for skipping

type¶: type of the resource to be backed up.

class otcextensions.sdk.cbr.v3.checkpoint.CheckpointResource(_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.

backup_count¶: Properties Number of backups

backup_size¶: Backup size

extra_info¶: Extra information of the resource

id¶: ID of the resource to be backed up

name: ty.Union[Body, URI]¶: Name of the resource to be backed up max 255 characters

protect_status¶: Protection status, choices: available, error, protecting, restoring, removing

resource_size¶: Allocated capacity for the associated resource in GB

type¶: type of the resource to be backed up.

class otcextensions.sdk.cbr.v3.checkpoint.ExtraInfo(_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.

name: ty.Union[Body, URI]¶: Properties Backup name

description¶: Backup description

retention_duration¶: Number of days that backups can be retained

last updated: 2024-05-18 00:15