com.vmware.appliance.recovery package¶

Subpackages¶

com.vmware.appliance.recovery.backup package

Submodules¶

com.vmware.appliance.recovery.backup_client module¶

class com.vmware.appliance.recovery.backup_client.Job(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Job class provides methods to be performed on a backup job.

class BackupJobStatus(id=None, state=None, messages=None, progress=None, start_time=None, end_time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Job.BackupJobStatus class represents the status of a backup/restore job.

Tip

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

class BackupRequest(parts=None, backup_password=None, location_type=None, location=None, location_user=None, location_password=None, comment=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Job.BackupRequest class represents a requested backup piece.

Tip

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

class BackupRestoreProcessState(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Job.BackupRestoreProcessState class defines the possible states of a backup/restore process.

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.

FAILED = BackupRestoreProcessState(string='FAILED')¶: Backup/Restore job failed.

INPROGRESS = BackupRestoreProcessState(string='INPROGRESS')¶: Backup/Restore job is in progress.

NONE = BackupRestoreProcessState(string='NONE')¶: Backup/Restore job is not started.

SUCCEEDED = BackupRestoreProcessState(string='SUCCEEDED')¶: Backup/Restore job completed successfully.

class LocalizableMessage(id=None, default_message=None, args=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Job.LocalizableMessage class represents a localizable message.

Tip

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

class LocationType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Job.LocationType class defines the type of destination location for backup/restore. You specify the location type when you create a backup job. See Job.BackupRequest.

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.

FTP = LocationType(string='FTP')¶: Destination is FTP server.

FTPS = LocationType(string='FTPS')¶: Destination is FTPS server.

HTTP = LocationType(string='HTTP')¶: Destination is HTTP server.

HTTPS = LocationType(string='HTTPS')¶: Destination is HTTPS server.

SCP = LocationType(string='SCP')¶: Destination is SSH server.

class ReturnResult(status=None, messages=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Job.ReturnResult class contains the result information for the cancel operation.

Tip

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

class ReturnStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Job.ReturnStatus class defines the return type for the cancel operation. You specify the return status when you return the result of cancel job. See Job.ReturnResult.

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.

FAIL = ReturnStatus(string='FAIL')¶: Cancel operation failed.

OK = ReturnStatus(string='OK')¶: Cancel operation succeeded.

WARNING = ReturnStatus(string='WARNING')¶: Cancel operation passed with warnings.

cancel(id)¶

Cancel the backup job.

Parameters:	id (`str`) – ID (ID of job) The parameter must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.job`.
Return type:	`Job.ReturnResult`
Returns:	BackupJobStatus Structure
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if backup associated with id does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

create(piece)¶

Initiate backup.

Parameters:	piece (`Job.BackupRequest`) – BackupRequest Structure
Return type:	`Job.BackupJobStatus`
Returns:	BackupJobStatus Structure
Raise:	`com.vmware.vapi.std.errors_client.FeatureInUse` A backup or restore is already in progress.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

get(id)¶

See backup job progress/result.

Parameters:	id (`str`) – ID (ID of job) The parameter must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.job`.
Return type:	`Job.BackupJobStatus`
Returns:	BackupJobStatus Structure
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if backup associated with id does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

list()¶

Get list of backup jobs

Return type:	`list` of `str`
Returns:	list of BackupJob IDs The return value will contain identifiers 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_client.LocationSpec(location=None, location_user=None, location_password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LocationSpec class has fields to represent a location on the backup server. This class was added in vSphere API 6.7

Tip

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

class com.vmware.appliance.recovery.backup_client.Parts(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parts class provides methods Provides list of parts optional for the backup

class LocalizableMessage(id=None, default_message=None, args=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Parts.LocalizableMessage class Structure representing message

Tip

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

class Part(id=None, name=None, description=None, selected_by_default=None, optional=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Parts.Part class Structure representing backup restore part

Tip

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

get(id)¶

Gets the size (in MB) of the part.

Parameters:	id (`str`) – Identifier of the part. The parameter must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.parts`.
Return type:	`long`
Returns:	long Size of the part in megabytes.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

list()¶

Gets a list of the backup parts.

Return type:	`list` of `Parts.Part`
Returns:	Information about each of the backup parts.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

class com.vmware.appliance.recovery.backup_client.Schedules(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Schedules class provides methods to be performed to manage backup schedules. This class was added in vSphere API 6.7

class CreateSpec(parts=None, backup_password=None, location=None, location_user=None, location_password=None, enable=None, recurrence_info=None, retention_info=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Schedules.CreateSpec class contains fields to be specified for creating a new schedule. The structure includes parts, location information, encryption password and enable flag. This class was added in vSphere API 6.7

Tip

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

class DayOfWeek(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Schedules.DayOfWeek class defines the set of days when backup can be scheduled. The days can be specified as a list of individual days. You specify the days when you set the recurrence for a schedule. See Schedules.RecurrenceInfo.days. 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.

FRIDAY = DayOfWeek(string='FRIDAY')¶: Friday. This class attribute was added in vSphere API 6.7

MONDAY = DayOfWeek(string='MONDAY')¶: Monday. This class attribute was added in vSphere API 6.7

SATURDAY = DayOfWeek(string='SATURDAY')¶: Saturday. This class attribute was added in vSphere API 6.7

SUNDAY = DayOfWeek(string='SUNDAY')¶: Sunday. This class attribute was added in vSphere API 6.7

THURSDAY = DayOfWeek(string='THURSDAY')¶: Thursday. This class attribute was added in vSphere API 6.7

TUESDAY = DayOfWeek(string='TUESDAY')¶: Tuesday. This class attribute was added in vSphere API 6.7

WEDNESDAY = DayOfWeek(string='WEDNESDAY')¶: Wednesday. This class attribute was added in vSphere API 6.7

class Info(parts=None, location=None, location_user=None, enable=None, recurrence_info=None, retention_info=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Schedules.Info class contains information about an existing schedule. The structure includes Schedule ID, parts, location information, encryption password, enable flag, recurrence and retention information. This class was added in vSphere API 6.7

Tip

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

class RecurrenceInfo(minute=None, hour=None, days=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Schedules.RecurrenceInfo class contains the recurrence information associated with a schedule. This class was added in vSphere API 6.7

Tip

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

class RetentionInfo(max_count=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Schedules.RetentionInfo class contains retention information associated with a schedule. This class was added in vSphere API 6.7

Tip

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

class UpdateSpec(parts=None, backup_password=None, location=None, location_user=None, location_password=None, enable=None, recurrence_info=None, retention_info=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Schedules.UpdateSpec class contains the fields of the existing schedule which can be updated. This class was added in vSphere API 6.7

Tip

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

create(schedule, spec)¶

Creates a schedule. This method was added in vSphere API 6.7

Parameters:	schedule (`str`) – Identifier of the schedule The parameter must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.schedule`. spec (`Schedules.CreateSpec`) – CreateSpec Structure
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if provided with invalid schedule specification.
Raise:	`com.vmware.vapi.std.errors_client.AlreadyExists` if the schedule with the given id already exists.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

delete(schedule)¶

Deletes an existing schedule. This method was added in vSphere API 6.7

Parameters:	schedule (`str`) – Identifier of the schedule The parameter must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.schedule`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if schedule associated with id does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

get(schedule)¶

Returns an existing schedule information based on id. This method was added in vSphere API 6.7

Parameters:	schedule (`str`) – Identifier of the schedule The parameter must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.schedule`.
Return type:	`Schedules.Info`
Returns:	Info Structure
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if schedule associated with id does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

list()¶

Returns a list of existing schedules with details. This method was added in vSphere API 6.7

Return type:	`dict` of `str` and `Schedules.Info`
Returns:	Map of schedule id to Info Structure The key in the return value `dict` will be an identifier for the resource type: `com.vmware.appliance.recovery.backup.schedule`.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

run(schedule, comment=None)¶

Initiate backup with the specified schedule. This method was added in vSphere API 6.7

Parameters:	schedule (`str`) – Identifier of the schedule The parameter must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.schedule`. comment (`str` or `None`) – field that specifies the description for the backup. If None the backup will have an empty comment.
Return type:	`Job.BackupJobStatus`
Returns:	BackupJobStatus Structure
Raise:	`com.vmware.vapi.std.errors_client.FeatureInUse` if a backup or restore is already in progress.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if schedule associated with id does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

update(schedule, spec)¶

Updates a schedule. This method was added in vSphere API 6.7

Parameters:	schedule (`str`) – Identifier of the schedule The parameter must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.schedule`. spec (`Schedules.UpdateSpec`) – UpdateSpec Structure
Raise:	`com.vmware.vapi.std.errors_client.InvalidArgument` if provided with invalid schedule specification.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if schedule associated with id does not exist.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

class com.vmware.appliance.recovery.backup_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

class com.vmware.appliance.recovery.backup_client.SystemName(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The SystemName class provides methods to enumerate system names of appliance backups. This class was added in vSphere API 6.7

list(loc_spec)¶

Returns a list of system names for which backup archives exist under loc_spec. This method was added in vSphere API 6.7

Parameters:	loc_spec (`LocationSpec`) – LocationSpec Structure
Return type:	`list` of `str`
Returns:	list of system names The return value will contain identifiers for the resource type: `com.vmware.appliance.recovery.backup.system_name`.
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if `loc_spec` doesn’t 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.

com.vmware.appliance.recovery.reconciliation_client module¶

class com.vmware.appliance.recovery.reconciliation_client.Job(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Job class provides methods to create and get the status of reconciliation job. This class was added in vSphere API 6.7

class CreateSpec(sso_admin_user_name=None, sso_admin_user_password=None, ignore_warnings=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Job.CreateSpec class has the fields to request the start of reconciliation job. This class was added in vSphere API 6.7

Tip

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

class Info(description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, messages=None, progress=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Job.Info class represents the reconciliation job information. It contains information related to current Status, any associated messages and progress as percentage. This class was added in vSphere API 6.7

Tip

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

class Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Job.Status class defines the status values that can be reported for an operation. 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.

FAILED = Status(string='FAILED')¶: The operation failed. This class attribute was added in vSphere API 6.7

NONE = Status(string='NONE')¶: The operation is not running. This class attribute was added in vSphere API 6.7

RUNNING = Status(string='RUNNING')¶: The operation is in progress. This class attribute was added in vSphere API 6.7

SUCCEEDED = Status(string='SUCCEEDED')¶: The operation completed successfully. This class attribute was added in vSphere API 6.7

create(spec)¶

Initiate reconciliation. This method was added in vSphere API 6.7

Parameters:	spec (`Job.CreateSpec`) – CreateSpec Structure
Return type:	`Job.Info`
Returns:	Info Structure
Raise:	`com.vmware.vapi.std.errors_client.FeatureInUse` A backup or restore is already in progress.
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` Reconciliation is allowed only after restore has finished successfully.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

get()¶

Get reconciliation job progress/result. This method was added in vSphere API 6.7

Return type:	`Job.Info`
Returns:	Info Structure
Raise:	`com.vmware.vapi.std.errors_client.NotFound` if there is no running reconciliation job.
Raise:	`com.vmware.vapi.std.errors_client.Error` if any error occurs during the execution of the operation.

class com.vmware.appliance.recovery.reconciliation_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.appliance.recovery.restore_client module¶

class com.vmware.appliance.recovery.restore_client.Job(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Job class provides methods Performs restore operations

class BackupRestoreProcessState(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Job.BackupRestoreProcessState class Defines state of backup/restore process

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.

FAILED = BackupRestoreProcessState(string='FAILED')¶: Failed

INPROGRESS = BackupRestoreProcessState(string='INPROGRESS')¶: In progress

NONE = BackupRestoreProcessState(string='NONE')¶: Not started

SUCCEEDED = BackupRestoreProcessState(string='SUCCEEDED')¶: Completed successfully

class LocalizableMessage(id=None, default_message=None, args=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Job.LocalizableMessage class Structure representing message

Tip

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

class LocationType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Job.LocationType class Defines type of all locations for backup/restore

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.

FTP = LocationType(string='FTP')¶: Destination is FTP server

FTPS = LocationType(string='FTPS')¶: Destination is FTPS server

HTTP = LocationType(string='HTTP')¶: Destination is HTTP server

HTTPS = LocationType(string='HTTPS')¶: Destination is HTTPS server

SCP = LocationType(string='SCP')¶: Destination is SSH server

class RestoreJobStatus(state=None, messages=None, progress=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Job.RestoreJobStatus class Structure representing backup restore status

Tip

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

class RestoreRequest(backup_password=None, location_type=None, location=None, location_user=None, location_password=None, sso_admin_user_name=None, sso_admin_user_password=None, ignore_warnings=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Job.RestoreRequest class Structure representing requested restore piece

Tip

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

class ReturnResult(status=None, messages=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Job.ReturnResult class Structure representing precheck result

Tip

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

class ReturnStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Job.ReturnStatus class Defines the state of precheck

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.

FAIL = ReturnStatus(string='FAIL')¶: Check failed

OK = ReturnStatus(string='OK')¶: Check passed

WARNING = ReturnStatus(string='WARNING')¶: Passed with warnings

cancel()¶

Cancel the restore job

Return type:	`Job.ReturnResult`
Returns:	RestoreJobStatus Structure
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

create(piece)¶

Initiate restore.

Parameters:	piece (`Job.RestoreRequest`) – RestoreRequest Structure
Return type:	`Job.RestoreJobStatus`
Returns:	RestoreJobStatus Structure
Raise:	`com.vmware.vapi.std.errors_client.FeatureInUse` A backup or restore is already in progress
Raise:	`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` Restore is allowed only after deployment and before firstboot
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

get()¶

See restore job progress/result.

Return type:	`Job.RestoreJobStatus`
Returns:	RestoreJobStatus Structure
Raise:	`com.vmware.vapi.std.errors_client.Error` Generic error

class com.vmware.appliance.recovery.restore_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase