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

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.

class Info(location=None, duration=None, size=None, progress=None, location_user=None, type=None, messages=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.

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.

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

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

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.

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.

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.

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:
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