Skip to main content

Create a Schedule Policy​

This operation creates a schedule policy.

More Details

Request Body
  • processinginstructioninfo object
  • taskInfo object
  • associations object[]
  • clientName string
  • backupsetName string
  • instanceName string
  • appName string
  • task object
  • taskType integer
  • policyType integer
  • taskName string
  • appGroup object
  • appGroups object[]
  • appGroupName string
  • subTasks object[]
  • subTaskOperation integer
  • subTask object
  • subTaskName string
  • subTaskType integer
  • operationType integer
  • subTaskId integer
  • pattern object
  • active_end_occurence integer
  • freq_subday_interval integer
  • freq_type integer
  • description string
  • active_end_time integer
  • active_start_time integer
  • active_start_date integer
  • freq_interval integer
  • freq_recurrence_factor integer
  • timeZone object
  • TimeZoneName string
  • options object
  • backupOpts object
  • truncateLogsOnSource boolean
  • sybaseSkipFullafterLogBkp boolean
  • notSynthesizeFullFromPrevBackup boolean
  • backupLevel integer
  • incLevel integer
  • adHocBackup boolean
  • runIncrementalBackup boolean
  • doNotTruncateLog boolean
  • vsaBackupOptions object
  • backupFailedVMsOnly boolean
  • cdrOptions object
  • incremental boolean
  • dataVerificationOnly boolean
  • full boolean
  • dataOpt object
  • skipCatalogPhaseForSnapBackup boolean
  • useCatalogServer boolean
  • followMountPoints boolean
  • enforceTransactionLogUsage boolean
  • skipConsistencyCheck boolean
  • createNewIndex boolean
  • autoCopy boolean
  • mediaOpt object
  • adminOpts object
  • contentIndexingOption object
  • subClientBasedAnalytics boolean
  • commonOpts object
  • perfJobOpts object
Responses

OK

POST /task

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "processinginstructioninfo": {},

  "taskInfo": {

    "associations": [

      {

        "clientName": "string",

        "backupsetName": "string",

        "instanceName": "string",

        "appName": "string"

      }

    ],

    "task": {

      "taskType": 0,

      "policyType": 0,

      "taskName": "string"

    },

    "appGroup": {

      "appGroups": [

        {

          "appGroupName": "string"

        }

      ]

    },

    "subTasks": [

      {

        "subTaskOperation": 0,

        "subTask": {

          "subTaskName": "string",

          "subTaskType": 0,

          "operationType": 0,

          "subTaskId": 0

        },

        "pattern": {

          "active_end_occurence": 0,

          "freq_subday_interval": 0,

          "freq_type": 0,

          "description": "string",

          "active_end_time": 0,

          "active_start_time": 0,

          "active_start_date": 0,

          "freq_interval": 0,

          "freq_recurrence_factor": 0,

          "timeZone": {

            "TimeZoneName": "string"

          }

        },

        "options": {

          "backupOpts": {

            "truncateLogsOnSource": true,

            "sybaseSkipFullafterLogBkp": true,

            "notSynthesizeFullFromPrevBackup": true,

            "backupLevel": 0,

            "incLevel": 0,

            "adHocBackup": true,

            "runIncrementalBackup": true,

            "doNotTruncateLog": true,

            "vsaBackupOptions": {

              "backupFailedVMsOnly": true

            },

            "cdrOptions": {

              "incremental": true,

              "dataVerificationOnly": true,

              "full": true

            },

            "dataOpt": {

              "skipCatalogPhaseForSnapBackup": true,

              "useCatalogServer": true,

              "followMountPoints": true,

              "enforceTransactionLogUsage": true,

              "skipConsistencyCheck": true,

              "createNewIndex": true,

              "autoCopy": true

            },

            "mediaOpt": {}

          },

          "adminOpts": {

            "contentIndexingOption": {

              "subClientBasedAnalytics": true

            }

          },

          "commonOpts": {

            "perfJobOpts": {}

          }

        }

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Task' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "processinginstructioninfo": {},
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "backupsetName": "string",
        "instanceName": "string",
        "appName": "string"
      }
    ],
    "task": {
      "taskType": 0,
      "policyType": 0,
      "taskName": "string"
    },
    "appGroup": {
      "appGroups": [
        {
          "appGroupName": "string"
        }
      ]
    },
    "subTasks": [
      {
        "subTaskOperation": 0,
        "subTask": {
          "subTaskName": "string",
          "subTaskType": 0,
          "operationType": 0,
          "subTaskId": 0
        },
        "pattern": {
          "active_end_occurence": 0,
          "freq_subday_interval": 0,
          "freq_type": 0,
          "description": "string",
          "active_end_time": 0,
          "active_start_time": 0,
          "active_start_date": 0,
          "freq_interval": 0,
          "freq_recurrence_factor": 0,
          "timeZone": {
            "TimeZoneName": "string"
          }
        },
        "options": {
          "backupOpts": {
            "truncateLogsOnSource": true,
            "sybaseSkipFullafterLogBkp": true,
            "notSynthesizeFullFromPrevBackup": true,
            "backupLevel": 0,
            "incLevel": 0,
            "adHocBackup": true,
            "runIncrementalBackup": true,
            "doNotTruncateLog": true,
            "vsaBackupOptions": {
              "backupFailedVMsOnly": true
            },
            "cdrOptions": {
              "incremental": true,
              "dataVerificationOnly": true,
              "full": true
            },
            "dataOpt": {
              "skipCatalogPhaseForSnapBackup": true,
              "useCatalogServer": true,
              "followMountPoints": true,
              "enforceTransactionLogUsage": true,
              "skipConsistencyCheck": true,
              "createNewIndex": true,
              "autoCopy": true
            },
            "mediaOpt": {}
          },
          "adminOpts": {
            "contentIndexingOption": {
              "subClientBasedAnalytics": true
            }
          },
          "commonOpts": {
            "perfJobOpts": {}
          }
        }
      }
    ]
  }
}'