models.sql_env_job_parameters module

class models.sql_env_job_parameters.SqlEnvJobParameters(aag_preference=None, aag_preference_from_sql_server=None, backup_system_databases=None, backup_type=None, backup_volumes_only=None, incremental_snapshot_upon_restart=None, is_copy_only_full=None, num_streams=None, user_database_preference=None, with_clause=None)[source]

Bases: object

Implementation of the ‘SqlEnvJobParameters’ model.

Specifies job parameters applicable for all ‘kSQL’ Environment type Protection Sources in a Protection Job.

aag_preference (AagPreferenceEnum): Specifies the preference for

backing up databases that are part of an AAG. Only applicable if ‘aagPreferenceFromSqlServer’ is set to false or not given. kPrimaryReplicaOnly implies backups should always occur on the primary replica. kSecondaryReplicaOnly implies backups should always occur on the secondary replica. kPreferSecondaryReplica implies secondary replica is preferred for backups. kAnyReplica implies no preference of about whether backups are performed on the primary replica or on a secondary replica. If no secondary replica is available, then performing backups on the primary replica is acceptable.

aag_preference_from_sql_server (bool): If true, AAG preferences are

taken from the SQL server host. If this is set to false or not given, preferences can be overridden by aagBackupPreference.

backup_system_databases (bool): If true, system databases are backed

up. If this is set to false, system databases are not backed up. If this field is not specified, default value is true.

backup_type (BackupTypeSqlEnvJobParametersEnum): Specifies the type of

the ‘kFull’ backup job. Specifies whether it is Volume level backup or individual files level backup. kSqlVSSVolume implies volume based VSS full backup. kSqlVSSFile implies file based VSS full backup.

backup_volumes_only (bool): If set to true, only the volumes

associated with databases should be backed up. The user cannot select additional volumes at host level for backup. If set to false, all the volumes on the host machine will be backed up. In this case, the user can further select the exact set of volumes using host level params. Note that the volumes associated with selected databases will always be included in the backup.

incremental_snapshot_upon_restart (bool): If true, the backup of type

kSqlVssVolume will be incremental after restart

is_copy_only_full (bool): If true, the backup is a full backup with

the copy-only option specified.

num_streams (int): Number of streams to be used in native sql backup. user_database_preference (UserDatabasePreferenceEnum): Specifies the

preference for backing up user databases on the host. kBackupAllDatabases implies to backup all databases. kBackupAllExceptAAGDatabases implies not to backup AAG databases. kBackupOnlyAAGDatabases implies to backup only AAG databases.

with_clause (string): With clause is used for setting clauese in

native sql backup.

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.