models.nas_backup_params module

class models.nas_backup_params.NasBackupParams(backup_existing_snapshot=None, blacklisted_ip_addrs=None, continue_on_error=None, encryption_enabled=None, filtering_policy=None, fld_config=None, full_backup_snapshot_label=None, incremental_backup_snapshot_label=None, is_source_initiated_backup=None, mixed_mode_preference=None, s3_viewbackupproperties=None, snapshot_change_enabled=None)

Bases: object

Implementation of the ‘NasBackupParams’ model.

Message to capture any additional backup params for a NAS environment.

Attributes:

backup_existing_snapshot (bool): This bool parameter will be set only

for DP volumes when customer doesn’t select the full_backup_snapshot_label and incremental_backup_snapshot_label. When set to true, backend will be using existing oldest snapshot for the first backup. Each incremental will be selected in ascending of snapshot create time on the source.

blacklisted_ip_addrs (list of string): Job level list of IP addresses

that should not be used.

continue_on_error (bool): Whether the backup job should continue on

errors for snapshot based backups. For non-snapshot-based generic NAS backup jobs, Magneto always continues on errors.

encryption_enabled (bool): Whether this backup job should use

encryption.

filtering_policy (FilteringPolicyProto): Proto to encapsulate the

filtering policy for backup objects like files or directories. If an object is not matched by any of the ‘allow_filters’, it will be excluded in the backup. If an object is matched by one of the ‘deny_filters’, it will always be excluded in the backup. Basically ‘deny_filters’ overwrite ‘allow_filters’ if they both match the same object. Currently we only support two kinds of filter: prefix which always starts with ‘/’, or postfix which always starts with ‘*’ (cannot be “*” only). We don’t support regular expression right now. A concrete example is: Allow filters: “/” Deny filters: “/tmp”, “*.mp4” Using such a policy will include everything under the root directory except the /tmp directory and all the mp4 files.

fld_config (ViewIdMappingProto_FileLevelDataLockConfig): File level

data lock configuration. To support File DataLock functionality similar to Netapp SnapLock, the following fields will be required from the user. This is same as what Cohesity as a filer offers for File DataLock.

full_backup_snapshot_label (string): Only used when we backup using

discovered snapshots. This prefix is to figure out which discovered snapshot we need to use for full backup.

incremental_backup_snapshot_label (string): Only used when we backup

using discovered snapshots. This prefix is to figure out which discovered snapshot we need to use for incremental backup.

is_source_initiated_backup (bool): Source initiated backup when the

source sends pushes the data like for example snapmirror based backup for netapp.

mixed_mode_preference (int): If the target entity is a mixed mode

volume, which NAS protocol type the user prefer to backup. This does not apply to generic NAS and will be ignored.

s3_viewbackupproperties (S3ViewBackupProperties): This message captures

all the details needed by NAS Backup to create S3 views and also details needed by Netapp to access the S3 bucket.

snapshot_change_enabled (bool): Whether this backup job should utilize

changelist like API when available for faster incremental backups.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

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.

Returns:

object: An instance of this structure class.