models.protection_job module

class models.protection_job.ProtectionJob(name=None, policy_id=None, view_box_id=None, leverage_san_transport=None, abort_in_blackout_period=None, alerting_config=None, alerting_policy=None, cloud_parameters=None, continue_on_quiesce_failure=None, create_remote_view=None, creation_time_usecs=None, data_migration_policy=None, dedup_disabled_source_ids=None, description=None, end_time_usecs=None, environment=None, environment_parameters=None, exclude_source_ids=None, exclude_vm_tag_ids=None, full_protection_sla_time_mins=None, full_protection_start_time=None, id=None, incremental_protection_sla_time_mins=None, incremental_protection_start_time=None, indexing_policy=None, is_active=None, is_deleted=None, is_direct_archive_enabled=None, is_native_format=None, is_paused=None, last_run=None, leverage_storage_snapshots=None, leverage_storage_snapshots_for_hyperflex=None, missing_entities=None, modification_time_usecs=None, modified_by_user=None, parent_source_id=None, perform_source_side_dedup=None, policy_applied_time_msecs=None, post_backup_script=None, pre_backup_script=None, priority=None, qos_type=None, quiesce=None, remote_script=None, remote_view_name=None, source_ids=None, source_special_parameters=None, start_time=None, summary_stats=None, tenant_id=None, timezone=None, uid=None, user_specified_tags=None, view_name=None, vm_tag_ids=None)

Bases: object

Implementation of the ‘ProtectionJob’ model.

Provides details about a Protection Job.

Attributes:

leverage_san_transport (bool): If this field is set to true, then the

backup for the objects will be performed using dedicated storage area network (SAN) instead of LAN or managment network.

abort_in_blackout_period (bool): If true, the Cohesity Cluster aborts

any currently executing Job Runs of this Protection Job when a blackout period specified for this Job starts, even if the Job Run started before the blackout period began. If false, a Job Run continues to execute, if the Job Run started before the blackout period starts.

alerting_config (AlertingConfig): Specifies optional settings for

alerting.

alerting_policy (list of AlertingPolicyEnum): Array of Job Events.

During Job Runs, the following Job Events are generated: 1) Job succeeds 2) Job fails 3) Job violates the SLA These Job Events can cause Alerts to be generated. ‘kSuccess’ means the Protection Job succeeded. ‘kFailure’ means the Protection Job failed. ‘kSlaViolation’ means the Protection Job took longer than the time period specified in the SLA.

cloud_parameters (CloudParameters): Specifies Cloud parameters that

are applicable to all Protection Sources in a Protection Job in certain scenarios.

continue_on_quiesce_failure (bool): Whether to continue backing up on

quiesce failure.

create_remote_view (bool): Specifies whether to create a remote view

name to use for view overwrite.

creation_time_usecs (long|int): Specifies the time when the Protection

Job was created.

data_migration_policy (DataMigrationPolicy): Specifies settings for

data migration in NAS environment. This also specifies the retention policy that should be applied to files after they have been moved to cohesity cluster.

dedup_disabled_source_ids (list of long|int): List of source ids for

which source side dedup is disabled from the backup job.

description (string): Specifies a text description about the

Protection Job.

end_time_usecs (long|int): Specifies the epoch time (in microseconds)

after which the Protection Job becomes dormant.

environment (EnvironmentProtectionJobEnum): Specifies the environment

type (such as kVMware or kSQL) of the Protection Source this Job is protecting. Supported environment types such as ‘kView’, ‘kSQL’, ‘kVMware’, etc. NOTE: ‘kPuppeteer’ refers to Cohesity’s Remote Adapter. ‘kVMware’ indicates the VMware Protection Source environment. ‘kHyperV’ indicates the HyperV Protection Source environment. ‘kSQL’ indicates the SQL Protection Source environment. ‘kView’ indicates the View Protection Source environment. ‘kPuppeteer’ indicates the Cohesity’s Remote Adapter. ‘kPhysical’ indicates the physical Protection Source environment. ‘kPure’ indicates the Pure Storage Protection Source environment. ‘Nimble’ indicates the Nimble Storage Protection Source environment. ‘kAzure’ indicates the Microsoft’s Azure Protection Source environment. ‘kNetapp’ indicates the Netapp Protection Source environment. ‘kAgent’ indicates the Agent Protection Source environment. ‘kGenericNas’ indicates the Generic Network Attached Storage Protection Source environment. ‘kAcropolis’ indicates the Acropolis Protection Source environment. ‘kPhsicalFiles’ indicates the Physical Files Protection Source environment. ‘kIsilon’ indicates the Dell EMC’s Isilon Protection Source environment. ‘kGPFS’ indicates IBM’s GPFS Protection Source environment. ‘kKVM’ indicates the KVM Protection Source environment. ‘kAWS’ indicates the AWS Protection Source environment. ‘kExchange’ indicates the Exchange Protection Source environment. ‘kHyperVVSS’ indicates the HyperV VSS Protection Source environment. ‘kOracle’ indicates the Oracle Protection Source environment. ‘kGCP’ indicates the Google Cloud Platform Protection Source environment. ‘kFlashBlade’ indicates the Flash Blade Protection Source environment. ‘kAWSNative’ indicates the AWS Native Protection Source environment. ‘kO365’ indicates the Office 365 Protection Source environment. ‘kO365Outlook’ indicates Office 365 outlook Protection Source environment. ‘kHyperFlex’ indicates the Hyper Flex Protection Source environment. ‘kGCPNative’ indicates the GCP Native Protection Source environment. ‘kAzureNative’ indicates the Azure Native Protection Source environment. ‘kKubernetes’ indicates a Kubernetes Protection Source environment. ‘kElastifile’ indicates Elastifile Protection Source environment. ‘kAD’ indicates Active Directory Protection Source environment. ‘kRDSSnapshotManager’ indicates AWS RDS Protection Source environment. ‘kCassandra’ indicates Cassandra Protection Source environment. ‘kMongoDB’ indicates MongoDB Protection Source environment. ‘kCouchbase’ indicates Couchbase Protection Source environment. ‘kHdfs’ indicates Hdfs Protection Source environment. ‘kHive’ indicates Hive Protection Source environment. ‘kHBase’ indicates HBase Protection Source environment.

environment_parameters (EnvironmentTypeJobParameters): Specifies

additional parameters that are common to all Protection Sources in a Protection Job created for a particular environment type.

exclude_source_ids (list of long|int): Array of Excluded Source

Objects. List of Object ids from a Protection Source that should not be protected and are excluded from being backed up by the Protection Job. Leaf and non-leaf Objects may be in this list and an Object in this list must have an ancestor in the sourceId list.

exclude_vm_tag_ids (list of long|int): Array of Arrays of VM Tag Ids

that Specify VMs to Exclude. Optionally specify a list of VMs to exclude from protecting by listing Protection Source ids of VM Tags in this two dimensional array. Using this two dimensional array of Tag ids, the Cluster generates a list of VMs to exclude from protecting, which are derived from intersections of the inner arrays and union of the outer array, as shown by the following example. For example a Datacenter is selected to be protected but you want to exclude all the ‘Former Employees’ VMs in the East and West but keep all the VMs for ‘Former Employees’ in the South which are also stored in this Datacenter, by specifying the following tag id array: [ [1000, 2221], [1000, 3031] ], where 1000 is the ‘Former Employee’ VM Tag id, 2221 is the ‘East’ VM Tag id and 3031 is the ‘West’ VM Tag id. The first inner array [1000, 2221] produces a list of VMs that are both tagged with ‘Former Employees’ and ‘East’ (an intersection). The second inner array [1000, 3031] produces a list of VMs that are both tagged with ‘Former Employees’ and ‘West’ (an intersection). The outer array combines the list of VMs from the two inner arrays. The list of resulting VMs are excluded from being protected this Job.

full_protection_sla_time_mins (long|int): If specified, this setting

is number of minutes that a Job Run of a Full (no CBT) backup schedule is expected to complete, which is known as a Service-Level Agreement (SLA). A SLA violation is reported when the run time of a Job Run exceeds the SLA time period specified for this backup schedule.

full_protection_start_time (TimeOfDay): Specifies the time of day to

start the Full Protection Schedule. This is optional and only applicable if the Protection Policy defines a monthly or a daily Full (no CBT) Protection Schedule. Default value is 02:00 AM. deprecated: true

id (long|int): Specifies an id for the Protection Job. incremental_protection_sla_time_mins (long|int): If specified, this

setting is number of minutes that a Job Run of a CBT-based backup schedule is expected to complete, which is known as a Service-Level Agreement (SLA). A SLA violation is reported when the run time of a Job Run exceeds the SLA time period specified for this backup schedule.

incremental_protection_start_time (TimeOfDay): Specifies the time of

day to start the CBT-based Protection Schedule. This is optional and only applicable if the Protection Policy defines a monthly or a daily CBT-based Protection Schedule. Default value is 02:00 AM. deprecated: true

indexing_policy (IndexingPolicy): Specifies settings for indexing

files found in an Object (such as a VM) so these files can be searched and recovered. This also specifies inclusion and exclusion rules that determine the directories to index.

is_active (bool): Indicates if the current state of the Protection Job

is Active or Inactive. When you create a Protection Job on a Primary Cluster with a replication schedule, the Cohesity Cluster creates an Inactive copy of the Job on the Remote Cluster. In addition, when an Active and running Job is deactivated, the Job becomes Inactive.

is_deleted (bool): Equals ‘true’ if the Protection Job was deleted but

some Snapshots are still associated with this Job. If ‘true’, no new Job Runs are started by this Protection Job.

is_direct_archive_enabled (bool): Specifies if this is a direct

archive backup job.

is_native_format (bool): Specifies if native format should be used for

archiving, applicable for only direct archive jobs.

is_paused (bool): Indicates if the Protection Job is paused, which

means that no new Job Runs are started but any existing Job Runs continue to execute.

last_run (ProtectionRunInstance): Specifies the status of one Job Run.

A Job Run can have one Backup Run and zero or more Copy Runs.

leverage_storage_snapshots (bool): Specifies whether to leverage the

storage array based snapshots for this backup job. To leverage storage snapshots, the storage array has to be registered as a source. If storage based snapshots can not be taken, job will fallback to the default backup method.

leverage_storage_snapshots_for_hyperflex (bool): Specifies whether to

leverage Hyperflex as the storage snapshot array

missing_entities (list of ProtectionSource): Specifies Information

about missing entities.

modification_time_usecs (long|int): Specifies the last time this Job

was updated.

modified_by_user (string): Specifies the last Cohesity user who

updated this Job.

name (string): Specifies the name of the Protection Job. parent_source_id (long|int): Specifies the id of the registered

Protection Source that is the parent of the Objects that may be protected by this Job. For example when a vCenter Server is registered on a Cohesity Cluster, the Cohesity Cluster assigns a unique id to this field that represents the vCenter Server.

perform_source_side_dedup (bool): Specifies whether source side dedupe

should be performed or not.

policy_applied_time_msecs (long|int): Specifies the epoch time (in

milliseconds) when the associated Policy was last applied to this Job. This is used to determine if the Policy has changed since it was last applied to this Job.

policy_id (string): Specifies the unique id of the Protection Policy

associated with the Protection Job. The Policy provides retry settings, Protection Schedules, Priority, SLA, etc. The Job defines the Storage Domain (View Box), the Objects to Protect (if applicable), Start Time, Indexing settings, etc.

post_backup_script (BackupScript): Specifies the script associated

with the backup job. This field must be specified for ‘kPhysical’ jobs. This script will be executed post backup run.

pre_backup_script (BackupScript): Specifies the script associated with

the backup job. This field must be specified for ‘kPhysical’ jobs. This script will be executed pre backup run. The ‘remoteScript’ field will be used for remote adapter jobs and ‘preBackupScript’ field will be used for ‘kPhysical’ jobs.

priority (PriorityEnum): Specifies the priority of execution for a

Protection Job. Cohesity supports concurrent backups but if the number of Jobs exceeds the ability to process Jobs, the specified priority determines the execution Job priority. This field also specifies the replication priority. ‘kLow’ indicates lowest execution priority for a Protection job. ‘kMedium’ indicates medium execution priority for a Protection job. ‘kHigh’ indicates highest execution priority for a Protection job.

qos_type (QosTypeEnum): Specifies the QoS policy type to use for this

Protection Job. ‘kBackupHDD’ indicates the Cohesity Cluster writes data directly to the HDD tier for this Protection Job. This is the recommended setting. ‘kBackupSSD’ indicates the Cohesity Cluster writes data directly to the SSD tier for this Protection Job. Only specify this policy if you need fast ingest speed for a small number of Protection Jobs.

quiesce (bool): Indicates if the App-Consistent option is enabled for

this Job. If the option is enabled, the Cohesity Cluster quiesces the file system and applications before taking Application-Consistent Snapshots. VMware Tools must be installed on the guest Operating System.

remote_script (RemoteJobScript): For a Remote Adapter ‘kPuppeteer’

Job, this field specifies the settings about the remote script that will be executed by this Job. Only specify this field for Remote Adapter ‘kPuppeteer’ Jobs.

remote_view_name (string): Specifies the remote view name to use for

view overwrite. This field is deprecated. Remote view names will automatically be used for all view jobs with replication policy. Use RemoteViewConfigList to setup remote view names. deprecated: true

source_ids (list of long|int): Array of Protected Source Objects.

Specifies the list of Object ids from the Protection Source to protect (or back up) by the Protection Job. An Object in this list may be descendant of another Object in this list. For example a Datacenter could be selected but its child Host excluded. However, a child VM under the Host could be explicitly selected to be protected. Both the Datacenter and the VM are listed.

source_special_parameters (list of SourceSpecialParameter): Array of

Special Source Parameters. Specifies additional settings that can apply to a subset of the Sources listed in the Protection Job. For example, you can specify a list of files and folders to protect instead of protecting the entire Physical Server. If this field’s setting conflicts with environmentParameters, then this setting will be used. Specific volume selections must be passed in here to take effect.

start_time (TimeOfDay): Specifies the time of day to start the

Protection Schedule. This is optional and only applicable if the Protection Policy defines a monthly or a daily Protection Schedule. Default value is 02:00 AM.

summary_stats (ProtectionJobSummaryStats): Specifies statistics about

a Protection Job.

tenant_id (string): Specifies the unique id of the tenant. timezone (string): Specifies the timezone to use when calculating time

for this Protection Job such as the Job start time. Specify the timezone in the following format: “Area/Location”, for example: “America/New_York”.

uid (UniversalId): Specifies a global Protection Job id that is unique

across Cohesity Clusters.

user_specified_tags (list of string): Tags associated with the job.

User can specify tags/keywords that can indexed by Yoda and can be later searched in UI. For example, user can create a ‘kPuppeteer’ job to backup Oracle DB for ‘payroll’ department. User can specify following tags: ‘payroll’, ‘Oracle_DB’.

view_box_id (long|int): Specifies the Storage Domain (View Box) id

where this Job writes data.

view_name (string): For a Remote Adapter ‘kPuppeteer’ Job or a ‘kView’

Job, this field specifies a View name that should be protected. Specify this field when creating a Protection Job for the first time for a View. If this field is specified, ParentSourceId, SourceIds, and ExcludeSourceIds should not be specified. This field is deprecated for view backups. Use sourceIds to specify list of view ids instead.

vm_tag_ids (list of long|int): Array of Arrays of VMs Tags Ids that

Specify VMs to Protect. Optionally specify a list of VMs to protect by listing Protection Source ids of VM Tags in this two dimensional array. Using this two dimensional array of Tag ids, the Cluster generates a list of VMs to protect which are derived from intersections of the inner arrays and union of the outer array, as shown by the following example. To protect only ‘Eng’ VMs in the East and all the VMs in the West, specify the following tag id array: [ [1101, 2221], [3031] ], where 1101 is the ‘Eng’ VM Tag id, 2221 is the ‘East’ VM Tag id and 3031 is the ‘West’ VM Tag id. The inner array [1101, 2221] produces a list of VMs that are both tagged with ‘Eng’ and ‘East’ (an intersection). The outer array combines the list from the inner array with list of VMs tagged with ‘West’ (a union). The list of resulting VMs are protected by this Job.

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.