com.vmware.appliance.recovery.backup package

Submodules

com.vmware.appliance.recovery.backup.job_client module

class com.vmware.appliance.recovery.backup.job_client.Details(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Details class provides methods to get the details about backup jobs. This class was added in vSphere API 6.7.

Parameters: config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class BuildInfo(version_name=None, version=None, build_number=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Details.BuildInfo class contains information about the build of the appliance. This class was added in vSphere API 6.7.2.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

version_name (str) – Appliance product type, for example 6.8.2 GA. This attribute was added in vSphere API 6.7.2.
version (str) – Appliance version, for example 6.8.2.10000. This attribute was added in vSphere API 6.7.2.
build_number (str) – Build Number of the appliance. This attribute was added in vSphere API 6.7.2.

class FilterSpec(jobs=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Details.FilterSpec class contains attributes used to filter the results when listing backup jobs details (see Details.list()). This class was added in vSphere API 6.7.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: jobs (set of str or None) – Identifiers of backup jobs that can match the filter. This attribute was added in vSphere API 6.7. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job. If None the filter will match all the backup jobs.

class Info(location=None, duration=None, size=None, progress=None, location_user=None, type=None, messages=None, build=None, fast_backup=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Details.Info class contains information about a backup job. This class was added in vSphere API 6.7.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

location (str) – URL of the backup location. This attribute was added in vSphere API 6.7.
duration (long) – Time in seconds since the backup job was started or the time it took to complete the backup job. This attribute was added in vSphere API 6.7. This attribute is optional and it is only relevant when the value of CommonInfo#status is one of com.vmware.cis.task_client.Status.SUCCEEDED, com.vmware.cis.task_client.Status.FAILED, or com.vmware.cis.task_client.Status.RUNNING.
size (long) – Size of the backup data transferred to remote location. This attribute was added in vSphere API 6.7. This attribute is optional and it is only relevant when the value of CommonInfo#status is one of com.vmware.cis.task_client.Status.SUCCEEDED, com.vmware.cis.task_client.Status.FAILED, or com.vmware.cis.task_client.Status.RUNNING.
progress (com.vmware.cis.task_client.Progress) – Progress of the job. This attribute was added in vSphere API 6.7. This attribute is optional and it is only relevant when the value of CommonInfo#status is one of com.vmware.cis.task_client.Status.SUCCEEDED, com.vmware.cis.task_client.Status.FAILED, or com.vmware.cis.task_client.Status.RUNNING.
location_user (str) – The username for the remote backup location. This attribute was added in vSphere API 6.7.
type (Details.Type) – Type of the backup job. Indicates whether the backup was started manually or as a scheduled backup. This attribute was added in vSphere API 6.7.
messages (list of com.vmware.vapi.std_client.LocalizableMessage) – List of any info/warning/error messages returned by the backup job. This attribute was added in vSphere API 6.7.
build (Details.BuildInfo) – Information about the build of the appliance. This attribute was added in vSphere API 6.7.2. This attribute is optional because it was added in a newer version than its parent node.
fast_backup (bool or None) – Option to enable Postgres DB/ VCDB fast backup. This attribute was added in vSphere API 6.7.
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.
service (str) – Identifier of the service containing the operation. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.service. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.service.
operation (str) – Identifier of the operation associated with the task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.operation. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.operation.
parent (str or None) – Parent of the current task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.task. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.task. This attribute will be None if the task has no parent.
target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing one the operation performed on. This attribute will be None if the operation has no target or multiple targets.
status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.
cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
error (Exception or None) – Description of the error if the operation status is “FAILED”. If None the description of why the operation failed will be included in the result of the operation (see com.vmware.cis.task_client.Info.result).
start_time (datetime.datetime) – Time when the operation is started. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.RUNNING, com.vmware.cis.task_client.Status.BLOCKED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.FAILED.
end_time (datetime.datetime) – Time when the operation is completed. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.SUCCEEDED or com.vmware.cis.task_client.Status.FAILED.
user (str or None) – Name of the user who performed the operation. This attribute will be None if the operation is performed by the system.

class Type(string)

Bases: vmware.vapi.bindings.enum.Enum

The Details.Type class defines the type of backup job. This enumeration was added in vSphere API 6.7.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the Type instance.

MANUAL = Type(string='MANUAL'): Job type is Manual. This class attribute was added in vSphere API 6.7.

SCHEDULED = Type(string='SCHEDULED'): Job type is Scheduled. This class attribute was added in vSphere API 6.7.

list(filter=None)

Returns detailed information about the current and historical backup jobs. This method was added in vSphere API 6.7.

Parameters: filter (Details.FilterSpec or None) – Specification of matching backup jobs for which information should be returned. If None, the behavior is equivalent to Details.FilterSpec with all attributes None which means all the backup jobs match the filter.
Return type: dict of str and Details.Info
Returns: Map of backup job identifier to Info Structure. The key in the return value dict will be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.
Raise: com.vmware.vapi.std.errors_client.Error if any error occurs during the execution of the operation.

class com.vmware.appliance.recovery.backup.job_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.appliance.recovery.backup.system_name_client module

class com.vmware.appliance.recovery.backup.system_name_client.Archive(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Archive class provides methods to get the backup information. This class was added in vSphere API 6.7.

Parameters: config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class FilterSpec(start_timestamp=None, end_timestamp=None, comment_substring=None, max_results=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Archive.FilterSpec class contains attributes used to filter the results when listing backup archives (see Archive.list()). If multiple attributes are specified, only backup archives matching all of the attributes match the filter. This class was added in vSphere API 6.7.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

start_timestamp (datetime.datetime or None) – Backup must have been taken on or after this time to match the filter. This attribute was added in vSphere API 6.7. If None the filter will match oldest backups.
end_timestamp (datetime.datetime or None) – Backup must have been taken on or before this time to match the filter. This attribute was added in vSphere API 6.7. If None the filter will match most recent backups.
comment_substring (str or None) – Backup comment must contain this str to match the filter. This attribute was added in vSphere API 6.7. If None the filter will match backups with any comment.
max_results (long or None) – Limit result to a max count of most recent backups. This attribute was added in vSphere API 6.7. If None it defaults to 128.

class Info(timestamp=None, location=None, parts=None, version=None, system_name=None, comment=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Archive.Info class represents backup archive information. This class was added in vSphere API 6.7.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

timestamp (datetime.datetime) – Time when this backup was completed. This attribute was added in vSphere API 6.7.
location (str) – Backup location URL. This attribute was added in vSphere API 6.7.
parts (list of str) – List of parts included in the backup. This attribute was added in vSphere API 6.7.
version (str) – The version of the appliance represented by the backup. This attribute was added in vSphere API 6.7.
system_name (str) – The system name identifier of the appliance represented by the backup. This attribute was added in vSphere API 6.7. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.
comment (str) – Custom comment added by the user for this backup. This attribute was added in vSphere API 6.7.

class Summary(archive=None, timestamp=None, version=None, comment=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Archive.Summary class contains commonly used information about a backup archive. This class was added in vSphere API 6.7.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

archive (str) – Backup archive identifier. This attribute was added in vSphere API 6.7. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive.
timestamp (datetime.datetime) – Time when this backup was started. This attribute was added in vSphere API 6.7.
version (str) – The version of the appliance represented by the backup archive. This attribute was added in vSphere API 6.7.
comment (str) – Custom comment added by the user for this backup. This attribute was added in vSphere API 6.7.

get(spec, system_name, archive)

Returns the information for backup corresponding to given backup location and system name. This method was added in vSphere API 6.7.

Parameters

spec (com.vmware.appliance.recovery.backup_client.LocationSpec) – LocationSpec Structure.
system_name (str) – System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.
archive (str) – Archive identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive.

Return type

Archive.Info

Returns

Info Structure.

Raise

com.vmware.vapi.std.errors_client.NotFound if backup does not exist.

Raise

com.vmware.vapi.std.errors_client.Error if any error occurs during the execution of the operation.

list(loc_spec, system_name, filter_spec)

Returns information about backup archives corresponding to given backup location and system name, which match the Archive.FilterSpec. This method was added in vSphere API 6.7.

Parameters

loc_spec (com.vmware.appliance.recovery.backup_client.LocationSpec) – LocationSpec Structure.
system_name (str) – System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.
filter_spec (Archive.FilterSpec) – Specification of matching backups for which information should be returned.

Return type

list of Archive.Summary

Returns

Commonly used information about the backup archives.

Raise

com.vmware.vapi.std.errors_client.NotFound if combination of loc_spec and system name does not refer to an existing location on the backup server.

Raise

com.vmware.vapi.std.errors_client.Error if any error occurs during the execution of the operation.

class com.vmware.appliance.recovery.backup.system_name_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance