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.

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

class Info(state=None, location=None, start_time=None, end_time=None, duration=None, progress=None, size=None, user=None, messages=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Details.Info class contains information about a backup job.

Tip

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

Parameters:

• state (com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState) – The state of the backup job.
• location (str) – URL of the backup location.
• start_time (datetime.datetime) – Time when the backup job was started.
• end_time (datetime.datetime) – Time when the backup job was finished. This attribute is optional and it is only relevant when the value of state is one of null or null.
• duration (long) – Time in seconds it took to complete the backup job.
• progress (long) – Progress of the job in percentage.
• size (long) – Size of the backup. This attribute is optional and it is only relevant when the value of state is null.
• user (str) – The username for the remote backup location.
• messages (list of com.vmware.vapi.std_client.LocalizableMessage) – List of any info/warning/error messages returned by the backup job.

Details.list()

Returns detailed information about the current and historical backup jobs.

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

com.vmware.appliance.recovery.backup.profile_client module

class com.vmware.appliance.recovery.backup.profile_client.Retention(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Retention class provides methods to create and update the retention policy for a backup profile.

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

class Info(max_count=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Retention.Info class contains retention information associated with a profile.

Tip

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

Parameters:max_count (long) – Number of backups which should be retained. If retention is mot set, all the backups will be retained forever.

Retention.get(profile)

Gets the retention policy for a profile.

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

Retention.set(profile, info)

Updates a profile with the retention policy.

Parameters:

• profile (str) – Identifier of the profile The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.profile.retention.
• info (Retention.Info) – Info Structure

Raise:

com.vmware.vapi.std.errors_client.NotFound if profile associated with id does not exist.

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if provided with invalid retention info.

Raise:

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

class com.vmware.appliance.recovery.backup.profile_client.Schedule(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Schedule class provides methods to create and update the schedule policy for a backup profile.

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

class DayOfWeek(string)

Bases: vmware.vapi.bindings.enum.Enum

The Schedule.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 schedule for a profile. See Schedule.Info.

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 DayOfWeek instance.

FRIDAY = DayOfWeek(string=u'FRIDAY')

Friday

MONDAY = DayOfWeek(string=u'MONDAY')

Monday

SATURDAY = DayOfWeek(string=u'SATURDAY')

Saturday

SUNDAY = DayOfWeek(string=u'SUNDAY')

Sunday

THURSDAY = DayOfWeek(string=u'THURSDAY')

Thursday

TUESDAY = DayOfWeek(string=u'TUESDAY')

Tuesday

WEDNESDAY = DayOfWeek(string=u'WEDNESDAY')

Wednesday

class Schedule.Info(minute=None, hour=None, days=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Schedule.Info class contains the schedule information associated with a profile.

Tip

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

Parameters:

• minute (long) – Minute when backup should run.
• hour (long) – Hour when backup should run. The hour should be specified in 24-hour clock format.
• days (list of Schedule.DayOfWeek or None) – Day of week when the backup should be run. Days can be specified as list of days. If None the backup will be run everyday.

Schedule.get(profile)

Gets the scheduler policy for a profile.

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

Schedule.set(profile, info)

Updates a profile with the schedule policy.

Parameters:

• profile (str) – Identifier of the profile The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.profile.schedule.
• info (Schedule.Info) – Info Structure

Raise:

com.vmware.vapi.std.errors_client.NotFound if profile associated with id does not exist.

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if provided with invalid schedule info.

Raise:

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

Module contents