Skip to main content

Create failover group DR operation schedule​

Select

SaaS
Customer Managed

API to create failover group DR operation schedule

Path Parameters
  • failoverGroupId int32 required

    Id of the failover group

Request Body
  • scheduleId int32

    Id of the schedule if available, required for modifying, deleting schedule

  • scheduleName string

    Name of the schedule, for modify

  • policyId int32

    Schedule policy Id to which the schedule belongs

  • scheduleOperation string

    Possible values: [ADD, DELETE, MODIFY]

    Default value: MODIFY

    Operation being performed on schedule

  • vmOperationType string

    Possible values: [PLANNED_FAILOVER, TEST_BOOT]

    Type of DR operation (only applicable for Failover groups)

  • backupType string required

    Possible values: [FULL, INCREMENTAL, DIFFERENTIAL, SYNTHETICFULL, TRANSACTIONLOG, SNAPSHOT]

    Schedule Backup level

  • forDatabasesOnly boolean

    Default value: false

    Boolean to indicate if schedule is for database agents

  • isRetentionBasedSyntheticFull boolean

    Default value: false

    Boolean to indicate if synthetic full schedule is based on retention rules

  • isAuxCopySchedule boolean

    Default value: false

    Boolean to indicate if schedule is aux copy schedule.

  • schedulePattern object required

    Used to describe when the schedule runs

  • scheduleFrequencyType string required

    Possible values: [MINUTES, DAILY, WEEKLY, MONTHLY, YEARLY, AUTOMATIC]

    schedule frequency type

  • frequency int32

    Possible values: >= 1

    Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months

  • weeklyDays string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

    Days of the week for weekly frequency

  • dayOfMonth int32

    Possible values: >= 1 and <= 31

    Day on which to run the schedule, applicable for monthly, yearly

  • weekOfMonth string

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    Specific week of a month

  • dayOfWeek string

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

  • monthOfYear string

    Possible values: [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]

  • repeatIntervalInMinutes int32

    Possible values: >= 1

    How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types.

  • repeatUntilTime int32

    Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes

  • timezone object
  • id int32
  • name string
  • startTime int32

    Default value: 75600

    start time of schedule in seconds

  • startDate int32

    start date of schedule in epoch format

  • endDate int32

    Schedule end date in epoch format

  • noOfTimes int32

    The number of times you want the schedule to run.

  • exceptions object[]

    Exceptions to when a schedule should not run, either in dates or week of month and days

  • onDates int32[]

    Possible values: >= 1 and <= 31

    list of dates in a month. For ex: 1, 20

  • onWeekOfTheMonth string[]

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    On which week of month, for ex: FIRST, LAST

  • onDayOfTheWeek string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

    On which days, for ex: MONDAY, FRIDAY

  • daysBetweenSyntheticFulls int32

    Possible values: >= 6

    No of days between two synthetic full jobs

  • maxBackupIntervalInMins int32

    Default value: 240

    The number of mins to force a backup on automatic schedule.

  • calendarId int32

    Default value: 1

    Custom Calendar Id for the schedule

  • calendarName string

    Custom Calendar name for the schedule

  • jobStaggerDurationInMins int32

    Specifies the duration in minutes of how long scheduled jobs can be spread. Applicable for daily, weekly, monthly and yearly frequency types. Value of 0 means job staggering is disabled.

  • scheduleOption object

    Specific options to be set on schedules

  • useDiskCacheForLogBackups boolean

    Used to enable disk caching feature on databases for automatic schedules on server plan

  • commitFrequencyInHours int32

    Commit frequency in hours for disk cache backups from automatic schedules

  • daysBetweenAutoConvert int32

    Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan

  • o365ItemSelectionOption string

    Possible values: [SELECT_ALL, SELECT_NEVER_PROCESSED, SELECT_MEETING_SLA, SELECT_NOT_MEETING_SLA_PROCESSED_ATLEAST_ONCE, SELECT_FAILED_LAST_ATTEMPT, SELECT_PROCESSED_ATLEAST_ONCE, SELECT_NOT_MEETING_SLA, SELECT_MEETING_SLA_NOT_RECENTLY_BACKED_UP]

    item backup option for O365 V2 backup jobs

  • jobRunningTimeInMins int32

    total job running time in minutes

  • minBackupIntervalInMins int32

    Default value: 15

    The min number of mins to check for file activity on automatic schedule.

  • logFilesThreshold int32

    Default value: 50

    The min number of archived log files before a backup job should start

  • logsDiskUtilizationPercent int32

    Default value: 80

    The min log destination disk threshold percentage

  • deleteLogsByAppLvlConfig boolean

    Delete backedup log files by Instance/BackupSet/Subclient settings

  • additionalInfo string
  • taskOperationType string

    Possible values: [BACKUP, SNAPSHOT]

    Schedule operation type

Responses

Failover group DR operation schedule created

Schema
  • scheduleId int32

    Id of the schedule if available, required for modifying, deleting schedule

  • scheduleName string

    Name of the schedule, for modify

  • policyId int32

    Schedule policy Id to which the schedule belongs

  • scheduleOperation string

    Possible values: [ADD, DELETE, MODIFY]

    Default value: MODIFY

    Operation being performed on schedule

  • vmOperationType string

    Possible values: [PLANNED_FAILOVER, TEST_BOOT]

    Type of DR operation (only applicable for Failover groups)

  • backupType string

    Possible values: [FULL, INCREMENTAL, DIFFERENTIAL, SYNTHETICFULL, TRANSACTIONLOG, SNAPSHOT]

    Schedule Backup level

  • forDatabasesOnly boolean

    Default value: false

    Boolean to indicate if schedule is for database agents

  • isRetentionBasedSyntheticFull boolean

    Default value: false

    Boolean to indicate if synthetic full schedule is based on retention rules

  • isAuxCopySchedule boolean

    Default value: false

    Boolean to indicate if schedule is aux copy schedule.

  • schedulePattern object

    Used to describe when the schedule runs

  • scheduleFrequencyType string

    Possible values: [MINUTES, DAILY, WEEKLY, MONTHLY, YEARLY, AUTOMATIC]

    schedule frequency type

  • frequency int32

    Possible values: >= 1

    Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months

  • weeklyDays string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

    Days of the week for weekly frequency

  • dayOfMonth int32

    Possible values: >= 1 and <= 31

    Day on which to run the schedule, applicable for monthly, yearly

  • weekOfMonth string

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    Specific week of a month

  • dayOfWeek string

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

  • monthOfYear string

    Possible values: [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]

  • repeatIntervalInMinutes int32

    Possible values: >= 1

    How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types.

  • repeatUntilTime int32

    Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes

  • timezone object
  • id int32
  • name string
  • startTime int32

    Default value: 75600

    start time of schedule in seconds

  • startDate int32

    start date of schedule in epoch format

  • endDate int32

    Schedule end date in epoch format

  • noOfTimes int32

    The number of times you want the schedule to run.

  • exceptions object[]

    Exceptions to when a schedule should not run, either in dates or week of month and days

  • onDates int32[]

    Possible values: >= 1 and <= 31

    list of dates in a month. For ex: 1, 20

  • onWeekOfTheMonth string[]

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    On which week of month, for ex: FIRST, LAST

  • onDayOfTheWeek string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

    On which days, for ex: MONDAY, FRIDAY

  • daysBetweenSyntheticFulls int32

    Possible values: >= 6

    No of days between two synthetic full jobs

  • maxBackupIntervalInMins int32

    Default value: 240

    The number of mins to force a backup on automatic schedule.

  • calendarId int32

    Default value: 1

    Custom Calendar Id for the schedule

  • calendarName string

    Custom Calendar name for the schedule

  • jobStaggerDurationInMins int32

    Specifies the duration in minutes of how long scheduled jobs can be spread. Applicable for daily, weekly, monthly and yearly frequency types. Value of 0 means job staggering is disabled.

  • scheduleOption object

    Specific options to be set on schedules

  • useDiskCacheForLogBackups boolean

    Used to enable disk caching feature on databases for automatic schedules on server plan

  • commitFrequencyInHours int32

    Commit frequency in hours for disk cache backups from automatic schedules

  • daysBetweenAutoConvert int32

    Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan

  • o365ItemSelectionOption string

    Possible values: [SELECT_ALL, SELECT_NEVER_PROCESSED, SELECT_MEETING_SLA, SELECT_NOT_MEETING_SLA_PROCESSED_ATLEAST_ONCE, SELECT_FAILED_LAST_ATTEMPT, SELECT_PROCESSED_ATLEAST_ONCE, SELECT_NOT_MEETING_SLA, SELECT_MEETING_SLA_NOT_RECENTLY_BACKED_UP]

    item backup option for O365 V2 backup jobs

  • jobRunningTimeInMins int32

    total job running time in minutes

  • minBackupIntervalInMins int32

    Default value: 15

    The min number of mins to check for file activity on automatic schedule.

  • logFilesThreshold int32

    Default value: 50

    The min number of archived log files before a backup job should start

  • logsDiskUtilizationPercent int32

    Default value: 80

    The min log destination disk threshold percentage

  • deleteLogsByAppLvlConfig boolean

    Delete backedup log files by Instance/BackupSet/Subclient settings

  • additionalInfo string
  • taskOperationType string

    Possible values: [BACKUP, SNAPSHOT]

    Schedule operation type

POST /v4/failovergroups/:failovergroupid/schedules

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
failoverGroupId — path required
Body
{

  "scheduleId": 0,

  "scheduleName": "string",

  "policyId": 0,

  "scheduleOperation": "MODIFY",

  "vmOperationType": "PLANNED_FAILOVER",

  "backupType": "FULL",

  "forDatabasesOnly": false,

  "isRetentionBasedSyntheticFull": false,

  "isAuxCopySchedule": false,

  "schedulePattern": {

    "scheduleFrequencyType": "MINUTES",

    "frequency": 0,

    "weeklyDays": [

      "SUNDAY"

    ],

    "dayOfMonth": 0,

    "weekOfMonth": "FIRST",

    "dayOfWeek": "SUNDAY",

    "monthOfYear": "JANUARY",

    "repeatIntervalInMinutes": 0,

    "repeatUntilTime": 0,

    "timezone": {

      "id": 0,

      "name": "string"

    },

    "startTime": 75600,

    "startDate": 0,

    "endDate": 0,

    "noOfTimes": 0,

    "exceptions": [

      {

        "onDates": [

          0

        ],

        "onWeekOfTheMonth": [

          "FIRST"

        ],

        "onDayOfTheWeek": [

          "SUNDAY"

        ]

      }

    ],

    "daysBetweenSyntheticFulls": 0,

    "maxBackupIntervalInMins": 240,

    "calendarId": 1,

    "calendarName": "string",

    "jobStaggerDurationInMins": 0

  },

  "scheduleOption": {

    "useDiskCacheForLogBackups": true,

    "commitFrequencyInHours": 0,

    "daysBetweenAutoConvert": 0,

    "o365ItemSelectionOption": "SELECT_ALL",

    "jobRunningTimeInMins": 0,

    "minBackupIntervalInMins": 15,

    "logFilesThreshold": 50,

    "logsDiskUtilizationPercent": 80,

    "deleteLogsByAppLvlConfig": true

  },

  "additionalInfo": "string",

  "taskOperationType": "BACKUP"

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/FailoverGroups/:failoverGroupId/Schedules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "scheduleId": 0,
  "scheduleName": "string",
  "policyId": 0,
  "scheduleOperation": "MODIFY",
  "vmOperationType": "PLANNED_FAILOVER",
  "backupType": "FULL",
  "forDatabasesOnly": false,
  "isRetentionBasedSyntheticFull": false,
  "isAuxCopySchedule": false,
  "schedulePattern": {
    "scheduleFrequencyType": "MINUTES",
    "frequency": 0,
    "weeklyDays": [
      "SUNDAY"
    ],
    "dayOfMonth": 0,
    "weekOfMonth": "FIRST",
    "dayOfWeek": "SUNDAY",
    "monthOfYear": "JANUARY",
    "repeatIntervalInMinutes": 0,
    "repeatUntilTime": 0,
    "timezone": {
      "id": 0,
      "name": "string"
    },
    "startTime": 75600,
    "startDate": 0,
    "endDate": 0,
    "noOfTimes": 0,
    "exceptions": [
      {
        "onDates": [
          0
        ],
        "onWeekOfTheMonth": [
          "FIRST"
        ],
        "onDayOfTheWeek": [
          "SUNDAY"
        ]
      }
    ],
    "daysBetweenSyntheticFulls": 0,
    "maxBackupIntervalInMins": 240,
    "calendarId": 1,
    "calendarName": "string",
    "jobStaggerDurationInMins": 0
  },
  "scheduleOption": {
    "useDiskCacheForLogBackups": true,
    "commitFrequencyInHours": 0,
    "daysBetweenAutoConvert": 0,
    "o365ItemSelectionOption": "SELECT_ALL",
    "jobRunningTimeInMins": 0,
    "minBackupIntervalInMins": 15,
    "logFilesThreshold": 50,
    "logsDiskUtilizationPercent": 80,
    "deleteLogsByAppLvlConfig": true
  },
  "additionalInfo": "string",
  "taskOperationType": "BACKUP"
}'