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 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 the unique ID (idempotency token) that guarantees the job runs only once.

After it runs successfully, this ID cannot be reused.

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 runs.

{ "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 to check the job status before the job ends 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 job status.

Default: 150

Failure Tolerance

 

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

Default: 0

Veeam Backup Job

Veeam Backup & Replication enables you to create image-level backups and replication for VMware, Hyper-V, Windows, Linux, and cloud platforms.

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

The following table describes the Veeam Backup job type attributes.

Attribute

Description

Connection Profile

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

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces

Action

Determines one of the following Veeam Backup operations to perform:

  • Backup Job: Creates image-level backups of virtual, physical, and cloud hosts.

  • NAS Backup Job: Creates backups of file shares and object storage repositories.

  • Backup Copy Job: Copies backup files to a secondary repository.

  • Agent Backup Job: Creates a backup of a Veeam Agent.

Backup UID

Defines the unique ID for the Veeam Backup job to initiate.

urn: veeam:Job:48aabdab-50da-42c6-b728-cca1b59be7ad

Retry

Determines whether to rerun a failed Veeam Backup job in the next attempt to run the job.

Status Polling Interval

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

Default: 60

Failure Tolerance

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

Default: 2

Veritas NetBackup Job

Veritas NetBackup enables backup and recovery across physical, virtual, and cloud platforms.

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

The following table describes the Veritas NetBackup job type attributes.

Attribute

Action

Description

Connection Profile

  • Run Backup

  • Run Backup - JSON

  • Restart

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

Action

  • Run Backup

  • Run Backup - JSON

  • Restart

Determines one of the following NetBackup actions to perform:

  • Run Backup: Runs a NetBackup policy.

  • Run Backup - JSON: Submits a job definition in JSON format to run a NetBackup policy.

  • Restart: Restarts a NetBackup policy.

Create Jobs Per Client

Run Backup

Determines whether the job runs for each client in the policy.

Policy Name

Run Backup

Defines the NetBackup backup policy that runs the backup.

Schedule Name

Run Backup

(Optional) Defines the NetBackup schedule that triggers the backup.

Client Name

Run Backup

(Optional) Defines the host name of the client to back up.

Keyword

Run Backup

(Optional) Defines a text label that is attached to the backup image archive.

Instance Name

Run Backup

(Optional) Defines the name of the Oracle or Microsoft SQL Server instance to back up.

Database Name

Run Backup

(Optional, Microsoft SQL Server ) Defines the name of the Microsoft SQL Server database to back up.

DB Unique Name

Run Backup

(Oracle database only) Defines the Oracle RAC database name of the database to back up. This must be the same database defined by the DB ID parameter. You must define both name and ID parameters.

DB ID

Run Backup

(Oracle database only) Defines the Oracle RAC database ID of the database to back up. This must be the same database defined by the DB Unique Name parameter. You must define both name and ID parameters.

Trial Backup

Run Backup

Determines the way to run the backup.

Valid Values:

  • True: Runs a trial backup that cannot be recovered.

  • False: Runs a normal backup.

JSON Parameters

Run Backup - JSON

Defines job parameters in JSON format.

The following example shows JSON parameters to run a backup:

Copy

    "data": { 
        "type": "backupRequest"
        "attributes": { 
            "policyName": "DemoPolicy"
            "scheduleName": "DemoSchedule"
            "clientName": "dba-tlv-x2d11c.bmc.com"
            "trialBackup": false 
        } 
    }
}

Output Management

  • Run Backup

  • Run Backup - JSON

Determines one of the following output options:

  • Display logs for job: Retrieves NetBackup logs for the job in all outcomes.
  • Display logs for failed jobs only: Retrieves NetBackup logs only when the job fails.
  • None: Does not retrieve NetBackup logs for the job.

Restart Job ID

Restart

Defines the most recent failed or incomplete NetBackup job.

Status Polling Frequency

  • Run Backup

  • Run Backup - JSON

  • Restart

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

Default: 60

Failure Tolerance

 

  • Run Backup

  • Run Backup - JSON

  • Restart

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

Default: 2