models_v2.update_archival_snapshot_config module

class models_v2.update_archival_snapshot_config.UpdateArchivalSnapshotConfig(id=None, archival_target_type=None, enable_legal_hold=None, delete_snapshot=None, resync=None, data_lock=None, days_to_keep=None)[source]

Bases: object

Implementation of the ‘Update Archival Snapshot Config.’ model.

Specifies the configuration about updating an existing Archival Snapshot Run.


id (long|int): Specifies the id of the archival target. archival_target_type (ArchivalTargetTypeEnum): Specifies the

snapshot’s archival target type from which recovery has been performed.

enable_legal_hold (bool): Specifies whether to retain the snapshot for

legal purpose. If set to true, the snapshots cannot be deleted until the retention period. Note that using this option may cause the Cluster to run out of space. If set to false explicitly, the hold is removed, and the snapshots will expire as specified in the policy of the Protection Group. If this field is not specified, there is no change to the hold of the run. This field can be set only by a User having Data Security Role.

delete_snapshot (bool): Specifies whether to delete the snapshot. When

this is set to true, all other params will be ignored.

resync (bool): Specifies whether to retry the archival operation in

case if earlier attempt failed. If not specified or set to false, archival is not retried.

data_lock (DataLock2Enum): Specifies WORM retention type for the

snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. ‘Compliance’ implies WORM retention is set for compliance reason. ‘Administrative’ implies WORM retention is set for administrative purposes.

days_to_keep (long|int): Specifies number of days to retain the

snapshots. If positive, then this value is added to exisiting expiry time thereby increasing the retention period of the snapshot. Conversly, if this value is negative, then value is subtracted to existing expiry time thereby decreasing the retention period of the snaphot. Here, by this operation if expiry time goes below current time then snapshot is immediately deleted.

classmethod from_dictionary(dictionary)[source]

Creates an instance of this model from a dictionary


dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.


object: An instance of this structure class.