Backup and Recovery Jobs

The following topics describe job attributes that work with backup and recovery platforms and services:

AWS Backup Job

AWS Backup enables you to back up and restore your data to the Amazon cloud.

To create an AWS Backup job, see Creating a Job. For more information about this plug-in, see Control-M for AWS Backup.

The following table describes the AWS Backup job attributes.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to AWS Backup, as described in AWS Backup Connection Profile Parameters.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Action

Determines one of the following AWS Backup actions to perform:

  • Backup

  • Restore from Backup

Window VSS

Determines whether to enable the Windows Volume Shadow Copy Service (VSS), which enables you to backup computer files or volumes when they are in use, as follows:

  • Disabled

  • Enabled

Backup Vault Name

Defines the vault name where the backup is stored.

Case Sensitive: No

Role ARN

Defines the Amazon Resource Name (ARN) of the AWS IAM Role that AWS Backup runs as to create a recovery point.

An ARN is a standardized AWS resource address.

The AWS IAM role must be granted read and write privileges to create or update the AWS resources that are in the backup or restore point.

arn:aws:iam::12234888888:role/service-role/AWSBackupDefaultServiceRole1

Idempotency Token

Defines a unique ID (idempotency token), which guarantees that the job executes only once.

Control-M-Idem-%%ORDERID

Resource ARN

Defines the Amazon Resource Name (ARN) of the backup.

arn:aws:backup:us-east-1:123456789012:key/abcd1234-5678-9012-efgh-ijklmnopqrst

Restore Parameters

Defines a set of JSON-based key-value pairs that contain the information required to restore the backup from a recovery point.

For no parameters, type {}.

Recovery Point ARN

Defines the Amazon Resource Name (ARN) of the recovery point, where the backup is restored from.

Status Polling Interval

Determines the number of seconds to wait before checking the job status.

Default: 150

AWS DataSync Job

AWS DataSync enables you to move large amounts of data between on-premises storage and AWS storage services, as well as between AWS storage services.

To create an AWS DataSync job, see Creating a Job. For more information about this plug-in, see Control-M for AWS DataSync.

The following table describes the AWS DataSync job attributes.

Attribute

Action

Description

Connection Profile

All

Determines the authorization credentials that are used to connect Control-M to AWS DataSync, as described in AWS DataSync Connection Profile ParametersAWS DataSync Connection Profile Parameters.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Action

All

Determines one of the following AWS DataSync actions to perform:

  • Execute Task

  • Create Task

  • Delete Task

Task ARN

  • Execute Task

  • Delete Task

Defines the Amazon Resource Name (ARN) of the task.

An ARN is a standardized AWS resource address.

Rules:

  • Type: String

  • Length: Maximum 128 characters

arn:aws:datasync:us-east-1:1123123141:task/task-0752fa45494724f46

Output Logs

Execute Task

Determines whether to append the log for the executed task from Cloudwatch to the outputClosed A tab in the job properties pane of the Monitoring domain where the job output appears that indicates whether a job ended OK, and is used, for example, with jobs that check file location..

Parameters

Create Task

Defines the parameters for the AWS DataSync job, in JSON format, which enables you to control how the job executes.

{ "CloudWatchLogGroupArn": "arn:aws:logs:us-east-1:122343284444:log-group:/aws/datasync", "DestinationLocationArn": "arn:aws:datasync:us-east-1:122343288888:location/loc-033b5bfd75d01abdb", "Name": "test3", "Options": { "Atime": "BEST_EFFORT", "BytesPerSecond": -1, "Gid": "NONE", "LogLevel": "BASIC", "Mtime": "PRESERVE", "ObjectTags": "PRESERVE", "OverwriteMode": "ALWAYS", "PosixPermissions": "NONE", "PreserveDeletedFiles": "PRESERVE", "PreserveDevices": "NONE", "PreserveNfsAcls": "NONE", "SecurityDescriptorCopyFlags": "NONE", "TaskQueueing": "ENABLED", "TransferMode": "CHANGED", "Uid": "NONE", "VerifyMode": "ONLY_FILES_TRANSFERRED" }, "SourceLocationArn": "arn:aws:datasync:us-east-1:122343286666:location/loc-068ae820d8f199aa7", "TaskArn": "arn:aws:datasync:us-east-1:122343283444:task/task-0752fa45494724f46", "TaskVersion": "V1" }

Status Polling Frequency

All

Determines the number of seconds to wait before checking the job status.

Default: 20

Failure Tolerance

All

 Determines the number of times the job tries to run before ending Not OK.

Default: 2

Azure Backup Job

Azure Backup enables you to back up and restore your data in the Microsoft Azure cloud.

To create an Azure Backup job, see Creating a Job. For more information about this plug-in, see Control-M for Azure Backup.

The following table describes the Azure Backup job type attributes.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to Azure Backup, as described in Azure Backup Connection Profile Parameters.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Action

Determines one of the following Azure Backup actions to perform:

  • Backup: Backs up your data to the Microsoft Azure cloud.

  • Restore from Backup: Restores your data from a previous backup on the Microsoft Azure cloud.

Vault Resource Group

Defines the name of the resource group for the storage vault in the Backup Center, which is the management platform in Azure Backup.

Case Sensitive: No

Vault Name

Defines the name of the storage vault in the Backup Center.

Case Sensitive: No

VM Resource Group

Defines the name of the resource group where the virtual machine with your data is located.

VM Name

Defines the name of the virtual machine with your data that you want to back up.

Policy Name

Defines the Azure policy that is enforced on your virtual machine and backup job.

Default: DefaultPolicy

Include Or Exclude Disks

Determines one of the following actions to perform when you back up your data:

  • Include: Includes the data stored on the logical unit numbers (LUN) defined in the Disk List attribute.

  • Exclude: Excludes the data stored on the logical unit numbers (LUN) defined in the Disk List attribute.

Disk List

Defines the list of logical unit numbers (LUN) to include or exclude in your backup.

A LUN is an address that points to an area of storage on a logical or virtual disk.

Valid Values: 0–9, separated by commas.

0,1,2

Restore to Latest Recovery Point

Determines whether to restore a backup from the latest recovery point.

Recovery Point Name

Defines the name of the recovery point, which is a copy of the original data from a specific time.

This name is found in the Backup Job or Restore Point Collection areas in the Backup Center.

123245428486171

Storage Account Name

Defines the name of the storage account that is associated with the recovery point.

Restore Region

Determines the region of the virtual machine where the data is restored.

UK South

Status Polling Frequency

Determines the number of seconds to wait before checking the status of the Azure Backup job.

Default: 150

Failure Tolerance

 

Determines the number of times to check the job status before ending Not OK.

Default: 0

NetBackup Job

Control-M for Backup connects to a NetBackup client and enables you to execute backup jobs. Control-M for Backup simplifies the process of defining, monitoring, and troubleshooting backup jobs as well as reducing manual scripts and typing errors.

To create a NetBackup job, see Creating a Job. For more information about this plug-in, see Control-M for Backup.

The following table describes the NetBackup job type attributes.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to NetBackup, as described in NetBackup Connection Profile Parameters.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Variable Name: %%BKP-ACCOUNT

Policy Details

Defines the backup policy.

Policy Name

Defines the backup policy name.

Variable Name: %%BKP-NBU_POLICY_NAME

Schedule

Determines what type of backup is performed (full, incremental).

If the field remains empty, the first scheduled backup of the policy is used.

Variable Name: %%BKP-NBU_SCHEDULE

Client

Defines the client where the backup is performed.

If the field remains empty, the backup executes on all clients that are defined in the policy.

Variable Name: %%BKP-NBU_CLIENT

Create Jobs per Client

Determines whether to create an active Control-M for Backup Job for every client that performs a backup.

The job name for each client appears as follows:

<definition_Job_name>@<client_name>

BMC recommends that you define the Control-M for Backup job inside a SMART folder if you have defined job Prerequisites.

Variable Name: %%BKP-NBU_JOBPERCLIENT

Restart Only Failed Streams on Rerun

Determines whether to restart the backup for failed jobs when you re-execute the backup job.

Variable Name: %%BKP-NBU_ACTIVE_RERUN_ONLY_FAILING

Output Management

Determines one of the following output options:

  • Display log for all Jobs in the output
  • Display log for failed Jobs in the output
  • None