VssProperties#

class VssProperties(backup_type=None, should_include_writers=False, writers=None, should_store_vss_metadata=False, *args, **kwargs)#

Bases: object

For Windows VMs/agents, application-consistent recovery points are selected using the Windows-specific Volume Shadow Copy Service (VSS). The enclosed properties, also called VSS properties, are used by the Windows platform to decide the type of application-consistent recovery points to consider.

Parameters:

  • backup_type (required) – (backup_type)

  • should_include_writers – (should_include_writers) Indicates whether the given set of VSS writers’ UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers’ UUIDs will be excluded. (Default False)

  • writers – (writers) List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.

  • should_store_vss_metadata – (should_store_vss_metadata) Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation. (Default False)

property backup_type#
Type:

BackupType

property should_include_writers#

Indicates whether the given set of VSS writers’ UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers’ UUIDs will be excluded.

Type:

bool

property should_store_vss_metadata#

Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation.

Type:

bool

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

property writers#

List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.

Type:

list[ str ]