Creating/Editing a Job

Creates or edits the job.

Before editing a job you need to lock it for editing. Editing capabilities:

  • schedules

  • source job objects (VMs, hosts, clusters)

  • target job objects (repositories, destinations for the recovery)

  • job options

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:

https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request JSON Example 1

Copy 

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data "{
        "action": "JobManagement",
        "method": "saveJob",
        "data": [{
             "actions: [],
             "bandwidthThrottlingRuleIds": null,
             "containers": [{
                       "id": 1,
                       "launchIntoEc2Classic": null,
                       "position": 0,
                       "sourceVid": "VIRTUAL_CONTAINER-1",
                       "targetAvailabilityZoneVid": null,
                       "targetInstanceAccessType": null,
                       "targetInstanceType": null,
                       "targetKeyPairVid": null,
                       "targetLuVid": null,
                       "targetPath": null,
                       "targetSecurityGroupVid": null,
                       "targetStorageVid": null,
                       "targetSubnetVid": null,
                       "targetVid": ["VMWARE_ESX-2", "VMWARE_DATASTORE-8", null, ""],
                       "targetVmFolderVid": null,
                       "targetVpcVid": null
                           }],
             "groupId": null,
             "hvType": "VMWARE",
             "id": 2,
             "lockUuid": "8d5836f4-845a-4ced-a9cb-2cc181eb5d54",
             "name": "VMware replication job",
             "objects": [{
                       "appAwareEnabled": true,
                       "credentialVid": null,
                       "exchangeLogTruncationCredentialVid": null,
                       "exchangeLogTruncationEnabled": false,
                       "id": 34,
                       "launchIntoEc2Classic": null,
                       "mappings": [{
                               "sourceIdentifier": "[datastore1] cong-tran-test-folder-05-replica/cong-tran-test-folder-05-replica.vmdk",
                               "sourceVid": "VMWARE_VDISK-329",
                               "target": null,
                               "targetVid": "VMWARE_DATASTORE-8",
                               "type": "NORMAL" }],
                       "nextRunAction": null,
                       "otherTargetVids": [],
                       "parentContainerSourceVid": "VIRTUAL_CONTAINER-1",
                       "position": 11,
                       "reipCredentialVid": null,
                       "reipEnabled": false,
                       "savepointVid": null,
                       "sourceVid": "VM-161",
                       "sqlLogTruncationCredentialVid": null,
                       "sqlLogTruncationEnabled": false,
                       "targetAvailabilityZoneVid": null,
                       "targetInstanceAccessType": null,
                       "targetInstanceType": null,
                       "targetKeyPairVid": null,
                       "targetLuVid": "VMWARE_ESX-2",
                       "targetName": "cong-tran-test-folder-05-replica-replica",
                       "targetSecurityGroupVid": null,
                       "targetStoragePath": null,
                       "targetStorageVid": "VMWARE_DATASTORE-8",
                       "targetSubnetVid": null,
                       "targetVid": null,
                       "targetVmFolderVid": null,
                       "targetVpcVid": null,
                        }],
             "options": {
                       "applicationAwareMode": "VSS_IGNORE_ERRORS",
                       "autoreplaceInaccessibleTransporters": true,
                       "differentialTrackingFallbackBehavior": "LAST_RETRY",
                       "differentialTrackingFallbackMode": "RESET_HYPERVISOR",
                       "differentialTrackingMode": "HYPERVISOR",
                       "ebsVolumeMode": "AUTO",
                       "enabledLimitedTransporterLoad": false,
                       "encryptionMode": "NONE",
                       "exchangeLogTruncationMode": "NONE",
                       "excludedVid": null,
                       "profilingEnabled": true,
                       "fullBackupDayOfMonth": null,
                       "fullBackupDayOfWeek": null,
                       "fullBackupEveryJobRuns": 5,
                       "fullBackupMode": "SYNTHETIC",
                       "fullBackupRunSettingsType": "EVERY",
                       "generateMac": false,
                       "id": 2,
                       "limitedTransporterLoad": 3,
                       "namingType": "APPEND_AFTER",
                       "networkAccelerationMode": "NONE",
                       "networkMappingMode": "NEVER",
                       "networkMappingVidList": null,
                       "postScriptBehavior": "NONE",
                       "postScriptErrorMode": "NONE",
                       "postScriptExecutionMode": "NEVER",
                       "postScriptExecutionPath": null,
                       "powerSourceVmsOff": true,
                       "powerVmsOn": false,
                       "preScriptBehavior": "NONE",
                       "preScriptErrorMode": "NONE",
                       "preScriptExecutionMode": "NEVER",
                       "preScriptExecutionPath": null,
                       "proxyTransporterVid": null,
                       "reIpMode": "NEVER",
                       "reIpRuleVidList": null,
                       "recipientList": "",
                       "recoveryTimeObjective": null,
                       "recoveryTimeObjectiveType": null,
                       "recoveryType": "SYNTHETIC",
                       "retentionPolicy": {
                                      "keepDayCount": null,
                                      "keepMonthCount": null,
                                      "keepWeekCount": null,
                                      "keepYearCount": null,
                                      "maxCount": 10,
                                      "retentionMode": "RULESET" },
                       "screenshotVerificationDelay": null,
                       "screenshotVerificationDiscard": null,
                       "screenshotVerificationLimit": null,
                       "screenshotVerificationMode": "NEVER",
                       "screenshotVerificationRto": null,
                       "screenshotVerificationStoragePath": null,
                       "screenshotVerificationStorageVid": null,
                       "screenshotVerificationTargetVid": null,
                       "sendReports": false,
                       "sourceTransporterVid": null,
                       "sqlLogTruncationMode": "NONE",
                       "targetTransporterVid": null,
                       "temporaryVolumeType": "MAGNETIC",
                       "thinDiskMode": "AUTO",
                       "transporterMapping: [{
                                "kind": "TARGET",
                                "sourceVid": "VMWARE_ESX-2",
                                "transporterVid": null
                                },{
                                "kind": "TARGET",
                                "sourceVid": "VMWARE_ESX-2",
                                "transporterVid": null }],
                        "transporterMode": "AUTO",
                        "transporterType": "AUTO",
                    },
             "policyRuleGroup": {
                       "id": 1,
                       "condition": "ALL",
                       "policyRules: [{
                              "condition: "IS",
                              "criteria": null,
                              "id": 1,
                              "isExcludeItem": null,
                              "locationTargetVid": "VMWARE_ESX-2",
                              "locationType": "VMWARE_HOST_AND_CLUSTER",
                              "position": 1,
                              "powerState": "ON",
                              "secondCondition": "IS",
                              "secondCriteria": null,
                              "size": null,
                              "sizeType": "GB",
                              "type": "VMWARE_VM_LOCATION"}]
                                 },
             "schedules": [{
                    "dayOfMonth": 1,
                    "dayOfWeek": 5,
                    "effectiveDate": "2019-09-05T00:00:00",
                    "enabled": true,
                    "endTime": null,
                    "every": 30,
                    "everyType": "MINUTE",
                    "month": 0,
                    "monthlyEveryType": "LAST",
                    "nextRun": "2019-09-06T00:00:00.000+07:00",
                    "nextRunRelative": 0,
                    "on": 31,
                    "position": 1,
                    "startTime": "12:00:00 AM",
                    "timezone": "Asia/Bangkok",
                    "timezoneOffsetMs": 25200000,
                    "triggerEvents": null,
                    "triggerItem": null,
                    "triggerItemName": null,
                    "triggerItemTypeName": null,
                    "triggerRunType": null,
                    "type": "DAILY"}],
             "type": "REPLICATION",
             "violatesLicense": false
      }],
        "type": "rpc",
        "tid": 1}"

Request JSON Example 2

Copy 
curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data "{
        "action": "JobManagement",
        "method": "saveJob",
        "data": [{
            "id": null,
            "name": "Microsoft Office 365 backup job",
            "hvType": "OFFICE365",
            "type": "BACKUP",
            "targetStorageType": "DISK",
            "groupId": null,
            "lockUuid": null,
            "schedules": [{
                "enabled": false,
                "type": "DAILY",
                "position": 1,
                "startTime": "12:00:00 AM",
                "endTime": null,
                "timezone": "EET",
                "timezoneOffsetMs": null,
                "on": 31,
                "everyType": "MINUTE",
                "every": 30,
                "monthlyEveryType": "LAST",
                "dayOfMonth": 1,
                "dayOfWeek": 5,
                "month": 0,
                "triggerItem": null,
                "triggerRunType": null,
                "triggerEvents": null,
                "effectiveDate": null,
                "nextRun": null}],
            "options": {
                "applicationAwareMode": null,
                "retentionPolicy": {
                    "retentionMode": "RULESET",
                    "maxCount": 10,
                    "keepDayCount": null,
                    "keepWeekCount": null,
                    "keepMonthCount": null,
                    "keepYearCount": null },
                "encryptionMode": null,
                "networkAccelerationMode": null,
                "thinDiskMode": null,
                "ebsVolumeMode": null,
                "temporaryVolumeType": null,
                "differentialTrackingMode": null,
                "differentialTrackingFallbackMode": null,
                "differentialTrackingFallbackBehavior": null,
                "preScriptExecutionMode": "NEVER",
                "preScriptExecutionPath": null,
                "preScriptBehavior": "NONE",
                "preScriptErrorMode": "NONE",
                "postScriptExecutionMode": "NEVER",
                "postScriptExecutionPath": null,
                "postScriptBehavior": "NONE",
                "postScriptErrorMode": "NONE",
                "namingType": null,
                "sendReports": null,
                "recipientList": null,
                "exchangeLogTruncationMode": null,
                "sqlLogTruncationMode": null,
                "powerVmsOn": null,
                "generateMac": null,
                "recoveryType": null,
                "powerSourceVmsOff": null,
                "transporterMode": null,
                "replacementTransporterMode": null,
                "transporterType": null,
                "sourceReplacementTransporterMode": null,
                "targetReplacementTransporterMode": null,
                "sourceReplacementTransporterVid": null,
                "targetReplacementTransporterVid": null,
                "sourceTransporterVid": null,
                "targetTransporterVid": null,
                "transporterMapping": [],
                "vmVerificationType": null,
                "vmVerificationRto": null,
                "vmVerificationTargetVid": null,
                "vmVerificationStorageVid": null,
                "vmVerificationStoragePath": null,
                "vmVerificationLimit": null,
                "vmVerificationDelay": null,
                "vmVerificationDiscard": null,
                "excludedVid": [],
                "profilingEnabled": true,
                "reIpMode": null,
                "reIpRuleVidList": null,
                "networkMappingMode": null,
                "networkMappingVidList": null,
                "fullBackupRunSettingsType": null,
                "fullBackupDayOfMonth": null,
                "fullBackupDayOfWeek": null,
                "fullBackupMode": null,
                "fullBackupEveryJobRuns": 5,
                "proxyTransporterVid": null,
                "recoveryTimeObjective": null,
                "recoveryTimeObjectiveType": null,
                "enabledLimitedTransporterLoad": false,
                "limitedTransporterLoad": 3,
                "targetLocationType": null,
                "tapeAppending": null},
        "objects": [{
            "position": 0,
            "sourceVid": "OFFICE365_EXCHANGE_MAILBOX-5",
            "savepointVid": null,
            "parentContainerSourceVid": null,
            "targetVid": null,
            "targetLuVid": null,
            "targetStorageVid": "BACKUP_REPOSITORY-3",
            "targetName": null,
            "nextRunAction": null,
            "mappings": [],
            "id": null,
            "credentialVid": null,
            "exchangeLogTruncationCredentialVid": null,
            "sqlLogTruncationCredentialVid": null,
            "targetVmFolderVid": null,
            "targetStoragePath": null,
            "otherTargetVids": null,
            "targetInstanceType": null,
            "launchIntoEc2Classic": null,
            "targetInstanceAccessType": null,
            "appAwareEnabled": null,
            "reipEnabled": null,
            "reipCredentialVid": null,
            "targetVpcVid": null,
            "targetSubnetVid": null,
            "targetAvailabilityZoneVid": null,
            "targetSecurityGroupVid": null,
            "targetKeyPairVid": null,
            "exchangeLogTruncationEnabled": null,
            "sqlLogTruncationEnabled": null}],
      "containers": [],
      "actions": [],
      "policyRuleGroup": {
            "condition": "ALL",
            "policyRules": [] },
      "violatesLicense": "",
      "bandwidthThrottlingRuleIds": null,
      "originalLocations": null
    }],
    "type": "rpc",
    "tid": 1}"

Request Fields

Field
Type
Value(s)
action string

JobManagement

method string

saveJob

data array Array of parameters
type string rpc
tid int 1

data

Field
Type
Description
 Possible values (if applicable) or format
id long null if creating a new job. Job ID otherwise
name string The display name of a job
hvType string Platform type

VMWARE, HYPERV, AWS, NUTANIX, PHYSICAL,OFFICE365

type string Job type

BACKUP, REPLICATION, BACKUP_COPY, RECOVERY_VMS, RECOVERY_FILES, REPLICA_FAILOVER, FLASH_BOOT, RECOVERY_OBJECTS, SITE_RECOVERY

groupId long The ID of a group where job must be created. null if the job must be placed to the top level
lockUuid string null for the new job. If you edit an existing job, pass the lockUuid value from the getJobForEditing request response
schedules array The schedules for the job. See the schedules table below
options Json Job options. See the options table below
objects array Source and target objects. See the objects table below
containers array Monitored containers (e.g. a Cluster). See the containers table below

violatesLicense

boolean

Checks does the job violate license

bandwidthThrottlingRuleIds

array

IDs of bandwidth throttling rules

actions

array

Specific for Site Recovery job. See the actiontable below

policyRuleGroup

Json

See the policyRuleGroup table below

action

Structure of Site Recovery job actions.

Field Type Description  

id

long

Action ID

uuid

string

Action UUid

type

string

Type of site recovery action

VMWARE_FAILOVER, HYPERV_FAILOVER, AWS_FAILOVER, VMWARE_FAILBACK, HYPERV_FAILBACK, AWS_FAILBACK, VMWARE_START_VM, HYPERV_START_VM, AWS_START_INSTANCE, VMWARE_STOP_VM, HYPERV_STOP_VM, AWS_STOP_INSTANCE, RUN_JOB, STOP_JOB, RUN_SCRIPT, ATTACH_REPOSITORY, DETACH_REPOSITORY, SEND_EMAIL, WAIT, CHECK_CONDITION

enabled

boolean

true if enabled

actionMode

string

Action mode

TESTING_AND_PRODUCTION, TESTING, PRODUCTION

waitingBehavior

string

Action waiting mode

WAIT_FOR_COMPLETION, START_IMMEDIATELY

errorHandlingMode

string

Error handling mode

STOP, CONTINUE

position

int

Action position

siteRecoveryStartStopVmActionDetails

Json

Details of the Start/Stop VMs/Instances action. See the siteRecoveryStartStopVmActionDetails table below

siteRecoveryWaitActionDetails

Json 

Details of the Wait action. See the siteRecoveryWaitActionDetails table below

siteRecoveryRunStopJobActionDetails

Json 

Details of the Run/Stop Jobs action. See the siteRecoveryRunStopJobActionDetails table below

siteRecoveryFailoverActionDetails

Json

Details of a Failover action. See the siteRecoveryFailoverActionDetails table below

siteRecoverySendEmailActionDetails

Json

Details of the Send Email action. See the siteRecoverySendEmailActionDetails table below

siteRecoveryAttachDetachRepoActionDetails

Json

Details of the Attach/Detach Repository action. See the siteRecoveryAttachDetachRepoActionDetails table below

siteRecoveryFailbackActionDetails

Json

Details of an Failback action. See the siteRecoveryFailbackActionDetails table below

siteRecoveryCheckConditionActionDetails

Json

Details of the Check Condition action. See the siteRecoveryCheckConditionActionDetails table below

siteRecoveryRunScriptActionDetails

Json

Details of the Run Script action. See the siteRecoveryRunScriptActionDetails table below

siteRecoveryStartStopVmActionDetails

Field Type Description Possible values or format

objects

array

See the objects table below

containers

array

See the containers table below

excludedVid

array

Excluded VID

policyRuleGroup

Json

See the  policyRuleGroup table below

siteRecoveryWaitActionDetails

Field Type Description Possible values or format

timeToWaitType

string

Time unit

MINUTE, HOUR

timeToWait

int

Time to wait

siteRecoveryRunStopJobActionDetails

Field Type Description Possible values or format

id

long

Action ID

jobVidList

array

List of job VIDs

siteRecoveryFailoverActionDetails

Field Type Description Possible values or format

objects

array

See the objects table below

containers

array

See the containers table below

siteRecoverySendEmailActionDetails

Field Type Description Possible values or format

id

long

Action ID

toEmails

string

Emails of recipients

ccEmails

string

Emails of CC recipients

subject

string

Email message subject

messageBody

string

Email message body

files

array

List of files

attachments

array

See the attachments table below

attachments

Field Type Description Possible values or format

id

long

Attachment ID

originalName

string

Original name

fileName

string

File name

siteRecoveryAttachDetachRepoActionDetails

Field Type Description Possible values or format

repositoryVid

string

Backup repository VID

siteRecoveryFailbackActionDetails

Field Type Description Possible values or format

objects

array

See the objects table below

containers

array

See the containers table below

powerSourceVmsOff

boolean

true if the source machines are to be powered off

excludedVid

array

Excluded VID

targetLocationType

string

Type of target location ORIGINAL_LOCATION, NEW_LOCATION

policyRuleGroup

Json

See the policyRuleGroup table below

siteRecoveryCheckConditionActionDetails

Field Type Description Possible values or format

conditionType

string

Condition type

RESOURCE_EXISTS, RESOURCE_RUNNING, IP_HOSTNAME_REACHABLE

resourceType

string

Resource type

VMWARE_VM, HYPERV_VM, EC2_INSTANCE

identificationMethod

string

Identification method

NAME, ID, TAG

identificationMethodOption

string

Option of the identification method

EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH

searchString

string

Search string

sourceEndpoint

string

Source endpoint

DIRECTOR, TRANSPORTER

transporterId

long

Transporter ID

transporterVid

string

Transporter VID

ipHostname

string

IP address or host name

actionIfTrueType

string

Type of action to be taken if the condition is satisfied

CONTINUE, STOP_AND_FAIL, END_SUCCESSFULLY, GO_TO_ANOTHER_ACTION

actionIfTrueTargetActionUuid

string

Target action UUid for actionIfTrueType = GO_TO_ANOTHER_ACTION

actionIfFalseType

string

Type of action to be taken if the condition is not satisfied

CONTINUE, STOP_AND_FAIL, END_SUCCESSFULLY, GO_TO_ANOTHER_ACTION

actionIfFalseTargetActionUuid

string

Target action UUid for actionIfFalseType = GO_TO_ANOTHER_ACTION

siteRecoveryRunScriptActionDetails

Field Type Description Possible values or format

targetType

string

Target type

THIS_SERVER, REMOTE_WINDOWS_SERVER, REMOTE_LINUX_SERVER, VMWARE_VM, HYPERV_VM, EC2_INSTANCE

targetVid

string

Target VID

targetIpHostname

string

Target IP address or host name

scriptPath

string

Script path

credentialVid

string

Credential VID

username

string

User name

password

string

User password

sshPort

int

SSH port

policyRuleGroup

Field Type Description Possible values or format

id

long

ID of policy rule group

condition

string

Condition of the policy rule group

ALL, ANY

policyRules

array

See the policyRules table below

policyRules

Field Type Description Possible values or format

id

long

Policy rule ID

type

string

Type of policy rule

isExcludeItem

boolean

true if the item is to be excluded

condition

string

Condition of the policy rule

CONTAIN, DOES_NOT_CONTAIN, EQUAL, DOES_NOT_EQUAL, START_WITH, END_WITH, IS_MORE_THAN, IS_LESS_THAN, IS, IS_NOT

sizeType

string

Unit of size

MB, GB, GIB, TB

size long Machine size

powerState

string

Power state

ON, OFF, SUSPENDED

locationType

string

Location type

VMWARE_HOST_AND_CLUSTER, VMWARE_VM_AND_TEMPLATES, HYPERV_HOSTS_AND_CLUSTERS, AWS_ACCOUNT, JOB_AND_GROUP, BACKUP_REPOSITORY

locationTargetVid

string

Target location VID

criteria

string

Criteria of the policy rule

position

int

Criterion position

secondCondition

string

Second condition of the policy rule

CONTAIN, DOES_NOT_CONTAIN, EQUAL, DOES_NOT_EQUAL, START_WITH, END_WITH, IS_MORE_THAN, IS_LESS_THAN, IS, IS_NOT

secondCriteria

string

Criteria of the second policy rule condition

schedules

Job schedules. You may add more than one schedule.

Field Type Description Possible values or format
enabled boolean If a schedule enabled, then true, false otherwise

type

string The type of backup schedule

DAILY, MONTHLY_YEARLY, PERIODICALLY, TRIGGER, NONE

position int Priority of the schedule
startTime string Start time hh:mm:ss AM/PM
endTime string End time. null if not set
timezone string Time zone
on int A decimal representation of a bit mask for a day of a week. The lowest bit is Monday, the 7th is Sunday. For example, if you need to run a job on weekdays, the bitmask will be 00011111 which is 31 in decimal 1-127
everyType string

If type is PERIODICALLY or TRIGGERED, defines the delay unit between jobs. For example, "Run job every 30 minutes"

DAY (for PERIODICALLY only), MINUTE, HOUR, SECOND
every int

The number of delay units between job runs. For example, "Run job every 30 minutes"
monthlyEveryType string If type is MONTHLY_YEARLY, selects the number of weekday in a month or a day number

FIRST, SECOND, THIRD, FOURTH, LAST, DAY
dayOfMonth int If monthlyEveryType is DAY, selects the day number in a month
dayOfWeek int If monthlyEveryType is either from LAST, selects the number of a weekday
month int If type is MONTHLY_YEARLY, the number of the month when a job must be run
triggerItem string VID of the job that triggers current
triggerRunType string Selects either to run the job immediately after the previous or within a delay. If DELAYED is selected, the delay is defined by the everyType and every fields

IMMEDIATELY, DELAYED

triggerEvents array Trigger job conditions

RUN_SUCCESS, RUN_FAILURE, RUN_STOP

nextRun string Time and date of the next job run YYYY-MM-DDTHH:MM:SS.SSSZ

effectiveDate

string

The date that schedule is effective from. It can be null, so the schedule is effective from now

triggerItemName

string

Name of the triggered item

triggerItemTypeName

string

Name of the triggered item type

timezoneOffsetMs

int

Set by the server. The specified timezone offset with regard to the server's time

nextRunRelative

long

Relative time in ms when the job will run next time

options

The options of the job created.

Field Type Description Possible values
applicationAwareMode string Application-aware mode

VSS_IGNORE_ERRORS, VSS_FAIL_ON_ERRORS, NONE

retentionPolicy JSON object Retention policy. See the retentionPolicy table below
encryptionMode string Encryption mode

NONE, NORMAL

networkAccelerationMode string Network acceleration mode

NONE, AUTO, FAST, MEDIUM, BEST

thinDiskMode string VMware specific.  Thin or respective source for replication

AUTO, FORCE_THIN

id

long

null when creating a job

powerSourceVmsOff

boolean

true if the source machines are to be powered off

screenshotVerificationStoragePath

string

Screenshot verification storage path

reIpMode

string

ReIP mode

NEVER, ALWAYS

reIpRuleVidList

array

List of ReIP rule VIDs

networkMappingMode

string

Network mapping mode

NEVER, ALWAYS

networkMappingVidList

array

List of network mapping VIDs

fullBackupRunSettingsType

string

Type of full backup run settings

ALWAYS, EVERY, EVERY2ND, FIRST, SECOND, THIRD, FOURTH, LAST, DAY, EVERY_JOB_RUNS

fullBackupDayOfWeek

int

Full backup day of week

fullBackupDayOfMonth

int

Full backup day of month

fullBackupEveryJobRuns

int

Repetition of full backup for job runs

fullBackupMode

string

Full backup mode

SYNTHETIC, ACTIVE

enabledLimitedTransporterLoad

boolean

true if limited transporter load is enabled

limitedTransporterLoad

boolean

true for limited transporter load

proxyTransporterVid

string

Proxy transporter VID

recoveryTimeObjectiveType

string

Site recovery specific. Type of recovery time objective

MINUTE, HOUR

recoveryTimeObjective

int

Site recovery specific. Recovery time objective
ebsVolumeMode string For AWS jobs only: a type of EBS volume

AUTO, FORCE_MAGNETIC

temporaryVolumeType string For AWS jobs only: a type of a temporary volume

MAGNETIC, GENERAL_PURPOSE_SSD

differentialTrackingMode string A method used for forever-incremental backup. Can be NONE (disabled), HYPERVISOR (VMware CBT,  Hyper-V RCT, or Nutanix CRT if available), PROPRIETARY (the product's method), or DOUBLE_CHECK (uses both methods to ensure the reliability of the change tracking)

NONE, HYPERVISOR, PROPRIETARY, DOUBLE_CHECK

differentialTrackingFallbackMode string Selects behavior on the change tracking failure

RESET_HYPERVISOR, PROPRIETARY, NONE

differentialTrackingFallbackBehavior string Selects when the fallback mode must be applied

NONE, IMMEDIATE, LAST_RETRY, NEXT_RETRY

preScriptExecutionMode string The mode of execution of pre-job scripts

ALWAYS, NEVER

preScriptExecutionPath string The path to a pre-job script
preScriptBehavior string Job behavior: either to wait for the script to finish or proceed

NONE, WAIT, PROCEED

preScriptErrorMode string The job behavior on pre-job script failure

NONE, FAIL, SKIP

postScriptExecutionMode string The mode of execution of pre-job scripts

NEVER, ALWAYS

postScriptExecutionPath string The path to a post-job script
postScriptBehavior string Job behavior: either to wait for the script to finish or proceed

NONE, WAIT, PROCEED

postScriptErrorMode string The job behavior on post-job script failure

NONE, FAIL, SKIP

namingType string For replication jobs only: the way the replica's name is changed

APPEND_AFTER, ASIS, USE_FROM_REPLICA_INFO

sendReports boolean Select if the reports must be sent after the job is completed
recipientList string The list of recipients
exchangeLogTruncationMode string The mode of Microsoft  Exchange log truncation

NONE, JOB_SUCCESS, ALWAYS

sqlLogTruncationMode string The mode of Microsoft SQL Server log truncation

NONE, JOB_SUCCESS, ALWAYS

powerVmsOn boolean Recovery only. Defines if the recovered VMs must be powered on after the job is completed
generateMac boolean Recovery only. Defines if a new MAC-address should be generated for a recovered VM
recoveryType string Recovery type

SYNTHETIC, PRODUCTION

transporterMode string The method of data transfer: automatic, SAN, HotAdd, or LAN

AUTO, SAN, HOT_ADD, LAN

transporterType string Select the Transporters that should be used by this job or let the product automatically determine the most suitable transporter(s)

AUTO, ALL, CUSTOM

autoreplaceInaccessibleTransporters boolean In case a transporter is unavailable during the job start, a replacement transporter will be picked automatically. If false, the job is explicitly locked to the certain transporter(s)
sourceTransporterVid string If transporterType is set to ALL, defines the source transporter for all hosts
targetTransporterVid string For replication only. If transporterType is set to ALL, defines the target transporter for all hosts
transporterMapping array If transporterType is set to CUSTOM, sets the parameters of a source and target transporters. See the transporterMapping table below
screenshotVerificationMode string The mode of screenshot verification

NEVER, ALWAYS

screenshotVerificationRto int Maximum time allowed to create temporary VM and start the guest OS. If the VM OS is not started within this time, verification of such VM will fail
screenshotVerificationTargetVid string The target container VID to create a temporary VM(s) for screenshot verification
screenshotVerificationDatastorageVid string The target datastore VID to create a temporary VM(s) for screenshot verification
screenshotVerificationLimit int The number of VMs that can be verified at the same time
screenshotVerificationDelay int Delay after actual guest OS starts before taking a screenshot
screenshotVerificationDiscard boolean

For Flash VM Boot jobs. If true, the recovered VMs will be discarded after the verification
excludedVid array of string The VIDs of the VMs excluded from the container (host or cluster)
profilingEnabled boolean Additional information will be collected and recorded in product logs in the course of data transfer, for the purpose of bottleneck detection
transporterMapping
Field Type Description Possible value(s)

id

long

Transporter mapping ID

kind

string

Kind of transporter mapping

SOURCE, TARGET

transporterVid

string

Transporter VID

sourceVid

string

Source VID
retentionPolicy
Field Type Description Possible value(s)
retentionMode string Retention mode. The RULESET defines the retention rules. The EXACT is used for backup copy jobs and copies the rule set of the original backup

RULESET, EXACT

maxCount int Maximum number of recovery points
keepDayCount int Maximum number of days to keep a recovery point
keepWeekCount int Maximum number of weeks to keep a recovery point
keepMonthCount int Maximum number of months to keep a recovery point
keepYearCount int Maximum number of years to keep a recovery point

objects

The source and target objects necessary for job creation.

Field Type Description Possible values
position int Priority of the job object
sourceVid string VID of the selected source item for recovery and backup copy jobs. For instance, for a VMware backup job, a source is a VMware VM
savepointVid string Savepoint VID
jobSourceVid string Job source VID
targetVid string Job target VID in a case of VM seeding or re-using existing backup
targetLuVid string Target container VID
targetStorageVid string VID of the target repository. Must be specified before running a backup job
targetName string Replica target display name
nextRunAction string Defines the action on the next job run

DELETE_KEEP_TARGET (delete the job object itself), DELETE_REMOVE_TARGET (delete the job object itself and remove the target), FORGET_KEEP_TARGET (forget the target in the job object), FORGET_REMOVE_TARGET (remove the target, then forget it in the job object)
mappings array Mapping rules for particular datastores and networks. See the mappings table below
id int Object ID
credentialVid string The VID of credentials for Microsoft Hyper-V or AWS EC2
exchangeLogTruncationCredentialVid string The VID of Microsoft Exchange log truncation credentials
sqlLogTruncationCredentialVid string The VID of Microsoft SQL Server log truncation credentials
targetStoragePath string Microsoft Hyper-V specific: path to the target inside the OS
otherTargetVids array VID of the target objects
targetInstanceType string AWS-specific: target instance type
launchIntoEc2Classic boolean AWS-specific. true if launching into AWS EC2 Classic
appAwareEnabled boolean Checks if the app-aware mode is enabled for this job object

targetVmFolderVid

string

VMware specific. Target VM folder VID

reipEnabled

boolean

true if ReIP is enabled

reipCredentialVid

string

ReIP credential VID
targetVpcVid string Target VPC VID
targetSubnetVid string

Target Subnet VID
targetAvailabilityZoneVid string

Target Availability Zone VID
targetSecurityGroupVid string

Target Security Group VID
targetKeyPairVid string

Target Keypair VID
targetInstanceAccessType string

Type of target instance access
exchangeLogTruncationEnabled boolean

true if truncation of Microsoft Exchange logging is enabled
sqlLogTruncationEnabled boolean true if truncation of Microsoft SQL Server logging is enabled
parentContainerSourceVid string

Parent container source VID, if any

sourceVid Example

To list all VMware VMs, use:

Copy 

{
    "action": "InventoryManagement",
    "method": "list",
    "data": [{
            "includeTypes": ["VM"]
        }
    ],
    "type": "rpc",
    "tid": 1
}

Copy 
{
    "action": "InventoryManagement",
    "method": "list",
    "tid": "302",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "children": [{
                "powerState": "OFF",
                "hostLid": "VMWARE_VMWARE_ESX_host-82849_10.30.29.91_4c4c4544-004c-3810-804c-b5c04f4b344a",
                "hostSc": 1,
                "hostVid": "VMWARE_ESX-11",
                "hostVersion": "6.0.0",
                "lid": "VMWARE_VM_vm-90670_50226a95-bc4c-bc8c-2c63-2c845fdc460f_42222a5e-2343-36eb-f4f7-04167cf4f4c8",
                "isTemplate": false,
                "isWindowsPlatform": false,
                "replicationState": "UNKNOWN",
                "notSupportedReason": null,
                "warningReason": null,
                "isReplicatedFromBackupObject": false,
                "osType": "UNKNOWN",
                "extendedInfo": null,
                "identifier": 210,
                "vid": "VM-210",
                "type": "VM",
                "subType": "VM",
                "name": "000010-sy-replica",
                "description": null,
                "accessible": false,
                "isDisabled": false,
                "replicable": true,
                "hvType": "VMWARE",
                "flags": 0,
                "children": null
            }
        ]
    }
}

Note

See the “vid” attribute for each returned item.

targetStorageVid Example

To list all repositories, use:

Copy 

{
    "action": "InventoryManagement",
    "method": "list",
    "data": [{
            "includeTypes": ["BACKUP_REPOSITORY"]
        }
    ],
    "type": "rpc",
    "tid": 1
}

Copy 
{
    "action": "InventoryManagement",
    "method": "list",
    "tid": "81",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "children": [{
                "backupCount": 21,
                "transporterVid": "TRANSPORTER-1",
                "repoDataStorageType": "INCREMENTAL_WITH_FULL_BACKUPS",
                "state": "OK",
                "repoType": "LOCAL",
                "masterVid": null,
                "objectLockSupported": true,
                "encryption": false,
                "free": 43769815040,
                "size": 950807814144,
                "online": true,
                "parentStorageVid": null,
                "identifier": 34,
                "vid": "BACKUP_REPOSITORY-34",
                "type": "BACKUP_REPOSITORY",
                "subType": null,
                "name": "ee",
                "description": null,
                "accessible": true,
                "isDisabled": false,
                "replicable": false,
                "hvType": "NONE",
                "flags": 0,
                "nameWithDescription": null,
                "children": null
            }, {
                "backupCount": 59,
                "transporterVid": "TRANSPORTER-1",
                "repoDataStorageType": "FOREVER_INCREMENTAL",
                "state": "OK",
                "repoType": "LOCAL",
                "masterVid": null,
                "objectLockSupported": false,
                "encryption": false,
                "free": 144008052736,
                "size": 950807814144,
                "online": true,
                "parentStorageVid": null,
                "identifier": 2,
                "vid": "BACKUP_REPOSITORY-2",
                "type": "BACKUP_REPOSITORY",
                "subType": null,
                "name": "eeeeee",
                "description": null,
                "accessible": true,
                "isDisabled": false,
                "replicable": false,
                "hvType": "NONE",
                "flags": 0,
                "nameWithDescription": null,
                "children": null
            }
        ],
        "totalCount": 2
    }
}

Note

See the “vid” attribute for each returned item.

mappings

Mappings of the specific objects (data storages and NICs).

Field Type Description Possible value(s)
type string Mapping type

NORMAL, SKIP, CREATE

sourceVid string Source object VID
targetVid string Target object VID
target string Hyper-V jobs only: target OS path

sourceIdentifier

string

Source identifier (MAC, disk label, etc)

containers

The parameters of the source objects for recovery and backup copy jobs.

Field Type Description Possible Values
position int Object priority on job processing
sourceVid string Source VID
targetVid array Target VID
id long ID
targetPath string Hyper-V specific: the path to the target inside OS
targetInstanceType string AWS-specific: target instance type

launchIntoEc2Classic

boolean

AWS specific


Fields below are specific for Site recovery jobs


targetLuVid

string

Target logical unit VID

targetStorageVid

string

VMware specific

targetVmFolderVid

string

Target VM folder VID

targetVpcVid

string

Target VPC VID

targetSubnetVid

string

Target Subnet VID

targetAvailabilityZoneVid

string

Target Availability Zone VID

targetSecurityGroupVid

string

Target Security Group VID

targetKeyPairVid

string

Target Keypair VID

targetInstanceAccessType

string

Target Instance Access type

Response Sample

Copy 
 {
    "action": "JobManagement",
    "method": "saveJob",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": 36
}

Response Fields

Field
Value
Description
message string Message if the request failed
where string Reference to the method where the problem occurred
cause string Cause of failure
data int Job ID