### Navigation

- index
- modules |
- next |
- previous |
- vSphere Automation SDK for Python 6.5.0 documentation »
- com Package »
- vmware Package »
- appliance Package »

# recovery Package

## `recovery` Package

## `backup_client` Module

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

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  `Job` class provides methods Performs backup restore operations

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

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

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    `Job.BackupJobStatus` class Structure representing backup restore status

    Tip

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

    Parameters: | id (`str`) – TimeStamp based ID state (`Job.BackupRestoreProcessState`) – process state messages (`list` of `Job.LocalizableMessage`) – list of messages progress (`long`) – percentage complete start_time (`datetime.datetime`) – Time when this backup was started. end_time (`datetime.datetime` or `None`) – Time when this backup was finished. endTime End time is None till backup is finished.

  class `Job.``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`

    `Job.BackupRequest` class Structure representing requested backup piece

    Tip

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

    Parameters: | parts (`list` of `str`) – a list of optional parts. Run backup parts APIs to get list of optional parts and description backup_password (`str` or `None`) – a password for a backup piece The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). backupPassword If no password then the piece will not be encrypted location_type (`Job.LocationType`) – a type of location location (`str`) – path or url location_user (`str` or `None`) – username for location locationUser User name for this location if login is required. location_password (`str` or `None`) – password for location locationPassword Password for the specified user if login is required at this location. comment (`str` or `None`) – Custom comment comment an optional comment

  class `Job.``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.

    Parameters: | string (`str`) – String value for the `BackupRestoreProcessState` instance.

    `FAILED` = BackupRestoreProcessState(string=u'FAILED')

      Failed

    `INPROGRESS` = BackupRestoreProcessState(string=u'INPROGRESS')

      In progress

    `NONE` = BackupRestoreProcessState(string=u'NONE')

      Not started

    `SUCCEEDED` = BackupRestoreProcessState(string=u'SUCCEEDED')

      Completed successfully

  class `Job.``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.

    Parameters: | id (`str`) – id in message bundle default_message (`str`) – text in english args (`list` of `str`) – nested data

  class `Job.``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.

    Parameters: | string (`str`) – String value for the `LocationType` instance.

    `FTP` = LocationType(string=u'FTP')

      Destination is FTP server

    `FTPS` = LocationType(string=u'FTPS')

      Destination is FTPS server

    `HTTP` = LocationType(string=u'HTTP')

      Destination is HTTP server

    `HTTPS` = LocationType(string=u'HTTPS')

      Destination is HTTPS server

    `SCP` = LocationType(string=u'SCP')

      Destination is SSH server

  class `Job.``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.

    Parameters: | status (`Job.ReturnStatus`) – Check status messages (`list` of `Job.LocalizableMessage`) – List of messages

  class `Job.``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.

    Parameters: | string (`str`) – String value for the `ReturnStatus` instance.

    `FAIL` = ReturnStatus(string=u'FAIL')

      Check failed

    `OK` = ReturnStatus(string=u'OK')

      Check passed

    `WARNING` = ReturnStatus(string=u'WARNING')

      Passed with warnings

  `Job.``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` ID is not found
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Job.``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` Generic error

  `Job.``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` ID is not found
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Job.``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` Generic error

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

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

  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.

    Parameters: | id (`str`) – id in message bundle default_message (`str`) – text in english args (`list` of `str`) – nested data

  class `Parts.``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.

    Parameters: | id (`str`) – part ID 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.parts`. 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.parts`. name (`Parts.LocalizableMessage`) – part name id in message bundle description (`Parts.LocalizableMessage`) – part description id in message bundle selected_by_default (`bool`) – Is part selected by default in UI optional (`bool`) – Estimated size of this piece

  `Parts.``get`(id)

    Get size of the optional part

    Parameters: | id (`str`) – part id The parameter must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.parts`.
    Return type: | `long`
    Returns: | int size
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Parts.``list`()

    Get a list of the backup parts

    Return type: | `list` of `Parts.Part`
    Returns: | list of parts
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

## `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

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

  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.

    Parameters: | string (`str`) – String value for the `BackupRestoreProcessState` instance.

    `FAILED` = BackupRestoreProcessState(string=u'FAILED')

      Failed

    `INPROGRESS` = BackupRestoreProcessState(string=u'INPROGRESS')

      In progress

    `NONE` = BackupRestoreProcessState(string=u'NONE')

      Not started

    `SUCCEEDED` = BackupRestoreProcessState(string=u'SUCCEEDED')

      Completed successfully

  class `Job.``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.

    Parameters: | id (`str`) – id in message bundle default_message (`str`) – text in english args (`list` of `str`) – nested data

  class `Job.``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.

    Parameters: | string (`str`) – String value for the `LocationType` instance.

    `FTP` = LocationType(string=u'FTP')

      Destination is FTP server

    `FTPS` = LocationType(string=u'FTPS')

      Destination is FTPS server

    `HTTP` = LocationType(string=u'HTTP')

      Destination is HTTP server

    `HTTPS` = LocationType(string=u'HTTPS')

      Destination is HTTPS server

    `SCP` = LocationType(string=u'SCP')

      Destination is SSH server

  class `Job.``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.

    Parameters: | state (`Job.BackupRestoreProcessState`) – process state messages (`list` of `Job.LocalizableMessage`) – list of messages progress (`long`) – percentage complete

  class `Job.``RestoreRequest`(backup_password=None, location_type=None, location=None, location_user=None, location_password=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.

    Parameters: | backup_password (`str` or `None`) – a password for a backup piece backupPassword If no password then the piece will not be decrypted location_type (`Job.LocationType`) – a type of location location (`str`) – path or url location_user (`str` or `None`) – username for location locationUser User name for this location if login is required. location_password (`str` or `None`) – password for location locationPassword Password for the specified user if login is required at this location.

  class `Job.``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.

    Parameters: | status (`Job.ReturnStatus`) – Check status messages (`list` of `Job.LocalizableMessage`) – List of messages

  class `Job.``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.

    Parameters: | string (`str`) – String value for the `ReturnStatus` instance.

    `FAIL` = ReturnStatus(string=u'FAIL')

      Check failed

    `OK` = ReturnStatus(string=u'OK')

      Check passed

    `WARNING` = ReturnStatus(string=u'WARNING')

      Passed with warnings

  `Job.``cancel`()

    Cancel the backup job

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

  `Job.``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

  `Job.``get`()

    See restore job progress/result.

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

### Navigation

- index
- modules |
- next |
- previous |
- vSphere Automation SDK for Python 6.5.0 documentation »
- com Package »
- vmware Package »
- appliance Package »