Create Server Plan For Workload
Select
SaaS
Customer Managed
Create server plan for a tenant company with given workload and region
- application/json
Request Body
- workloadType string
Type of workload
region object
plan object
Responses
- 200
- 400
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
plan object
errors object[]
{
"plan": {
"id": 0,
"GUID": "string",
"name": "string"
},
"errors": [
{
"component": "string",
"errorCode": 0,
"errorMessage": "string"
}
]
}
Bad request
- application/json
- Schema
- Example (from schema)
Schema
plan object
errors object[]
{
"plan": {
"id": 0,
"GUID": "string",
"name": "string"
},
"errors": [
{
"component": "string",
"errorCode": 0,
"errorMessage": "string"
}
]
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
plan object
errors object[]
{
"plan": {
"id": 0,
"GUID": "string",
"name": "string"
},
"errors": [
{
"component": "string",
"errorCode": 0,
"errorMessage": "string"
}
]
}
POST /v4/workload/serverplan
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Workload/ServerPlan' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"workloadType": "string",
"region": {
"id": 0,
"name": "string"
},
"plan": {
"planName": "string",
"backupDestinations": [
null,
null
],
"backupDestinationIds": [
0
],
"rpo": {
"backupFrequency": {
"schedules": [
{
"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"
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"doNotSubmitJobForBackupWindow": true,
"doNotSubmitJobForFullBackupWindow": true
},
"filesystemAddon": true,
"backupContent": {
"windowsIncludedPaths": [
"string"
],
"windowsExcludedPaths": [
"string"
],
"windowsFilterToExcludePaths": [
"string"
],
"backupSystemState": true,
"backupSystemStateOnlyWithFullBackup": false,
"useVSSForSystemState": true,
"windowsNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"macIncludedPaths": [
"string"
],
"macExcludedPaths": [
"string"
],
"macFilterToExcludePaths": [
"string"
],
"unixNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"unixIncludedPaths": [
"string"
],
"unixExcludedPaths": [
"string"
],
"unixFilterToExcludePaths": [
"string"
],
"macNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"forceUpdateProperties": true
},
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
},
"workload": {
"workloadTypes": [
{
"id": 0,
"name": "string"
}
],
"workloadGroupTypes": [
"FILE_SERVER"
],
"solutions": [
{
"id": 0,
"name": "string"
}
]
},
"allowPlanOverride": true,
"overrideRestrictions": {
"backupContent": "OPTIONAL",
"storagePool": "OPTIONAL",
"RPO": "OPTIONAL"
},
"parentPlan": {
"id": 0,
"name": "string"
},
"additionalProperties": {
"RPO": 0,
"addons": {
"database": true,
"fileSystem": true,
"snap": true,
"snapStatus": "DISABLED",
"indexCopy": true
},
"status": "ENABLED"
},
"settings": {
"fileSearch": {
"enabled": true,
"status": "NOT_APPLICABLE",
"statusMessage": "string",
"errors": [
{
"storage": {
"id": 0,
"name": "string"
},
"errorCode": 0,
"errorMessage": "string"
}
]
},
"enableAdvancedView": true,
"deviceStreams": 100,
"upgradedFromStoragePolicy": true
}
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Workload/ServerPlan' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"workloadType": "string",
"region": {
"id": 0,
"name": "string"
},
"plan": {
"planName": "string",
"backupDestinations": [
null,
null
],
"backupDestinationIds": [
0
],
"rpo": {
"backupFrequency": {
"schedules": [
{
"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"
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"doNotSubmitJobForBackupWindow": true,
"doNotSubmitJobForFullBackupWindow": true
},
"filesystemAddon": true,
"backupContent": {
"windowsIncludedPaths": [
"string"
],
"windowsExcludedPaths": [
"string"
],
"windowsFilterToExcludePaths": [
"string"
],
"backupSystemState": true,
"backupSystemStateOnlyWithFullBackup": false,
"useVSSForSystemState": true,
"windowsNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"macIncludedPaths": [
"string"
],
"macExcludedPaths": [
"string"
],
"macFilterToExcludePaths": [
"string"
],
"unixNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"unixIncludedPaths": [
"string"
],
"unixExcludedPaths": [
"string"
],
"unixFilterToExcludePaths": [
"string"
],
"macNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"forceUpdateProperties": true
},
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
},
"workload": {
"workloadTypes": [
{
"id": 0,
"name": "string"
}
],
"workloadGroupTypes": [
"FILE_SERVER"
],
"solutions": [
{
"id": 0,
"name": "string"
}
]
},
"allowPlanOverride": true,
"overrideRestrictions": {
"backupContent": "OPTIONAL",
"storagePool": "OPTIONAL",
"RPO": "OPTIONAL"
},
"parentPlan": {
"id": 0,
"name": "string"
},
"additionalProperties": {
"RPO": 0,
"addons": {
"database": true,
"fileSystem": true,
"snap": true,
"snapStatus": "DISABLED",
"indexCopy": true
},
"status": "ENABLED"
},
"settings": {
"fileSearch": {
"enabled": true,
"status": "NOT_APPLICABLE",
"statusMessage": "string",
"errors": [
{
"storage": {
"id": 0,
"name": "string"
},
"errorCode": 0,
"errorMessage": "string"
}
]
},
"enableAdvancedView": true,
"deviceStreams": 100,
"upgradedFromStoragePolicy": true
}
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Workload/ServerPlan' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"workloadType": "string",
"region": {
"id": 0,
"name": "string"
},
"plan": {
"planName": "string",
"backupDestinations": [
null,
null
],
"backupDestinationIds": [
0
],
"rpo": {
"backupFrequency": {
"schedules": [
{
"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"
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"doNotSubmitJobForBackupWindow": true,
"doNotSubmitJobForFullBackupWindow": true
},
"filesystemAddon": true,
"backupContent": {
"windowsIncludedPaths": [
"string"
],
"windowsExcludedPaths": [
"string"
],
"windowsFilterToExcludePaths": [
"string"
],
"backupSystemState": true,
"backupSystemStateOnlyWithFullBackup": false,
"useVSSForSystemState": true,
"windowsNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"macIncludedPaths": [
"string"
],
"macExcludedPaths": [
"string"
],
"macFilterToExcludePaths": [
"string"
],
"unixNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"unixIncludedPaths": [
"string"
],
"unixExcludedPaths": [
"string"
],
"unixFilterToExcludePaths": [
"string"
],
"macNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"forceUpdateProperties": true
},
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
},
"workload": {
"workloadTypes": [
{
"id": 0,
"name": "string"
}
],
"workloadGroupTypes": [
"FILE_SERVER"
],
"solutions": [
{
"id": 0,
"name": "string"
}
]
},
"allowPlanOverride": true,
"overrideRestrictions": {
"backupContent": "OPTIONAL",
"storagePool": "OPTIONAL",
"RPO": "OPTIONAL"
},
"parentPlan": {
"id": 0,
"name": "string"
},
"additionalProperties": {
"RPO": 0,
"addons": {
"database": true,
"fileSystem": true,
"snap": true,
"snapStatus": "DISABLED",
"indexCopy": true
},
"status": "ENABLED"
},
"settings": {
"fileSearch": {
"enabled": true,
"status": "NOT_APPLICABLE",
"statusMessage": "string",
"errors": [
{
"storage": {
"id": 0,
"name": "string"
},
"errorCode": 0,
"errorMessage": "string"
}
]
},
"enableAdvancedView": true,
"deviceStreams": 100,
"upgradedFromStoragePolicy": true
}
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Workload/ServerPlan' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"workloadType": "string",
"region": {
"id": 0,
"name": "string"
},
"plan": {
"planName": "string",
"backupDestinations": [
null,
null
],
"backupDestinationIds": [
0
],
"rpo": {
"backupFrequency": {
"schedules": [
{
"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"
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"doNotSubmitJobForBackupWindow": true,
"doNotSubmitJobForFullBackupWindow": true
},
"filesystemAddon": true,
"backupContent": {
"windowsIncludedPaths": [
"string"
],
"windowsExcludedPaths": [
"string"
],
"windowsFilterToExcludePaths": [
"string"
],
"backupSystemState": true,
"backupSystemStateOnlyWithFullBackup": false,
"useVSSForSystemState": true,
"windowsNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"macIncludedPaths": [
"string"
],
"macExcludedPaths": [
"string"
],
"macFilterToExcludePaths": [
"string"
],
"unixNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"unixIncludedPaths": [
"string"
],
"unixExcludedPaths": [
"string"
],
"unixFilterToExcludePaths": [
"string"
],
"macNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"forceUpdateProperties": true
},
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
},
"workload": {
"workloadTypes": [
{
"id": 0,
"name": "string"
}
],
"workloadGroupTypes": [
"FILE_SERVER"
],
"solutions": [
{
"id": 0,
"name": "string"
}
]
},
"allowPlanOverride": true,
"overrideRestrictions": {
"backupContent": "OPTIONAL",
"storagePool": "OPTIONAL",
"RPO": "OPTIONAL"
},
"parentPlan": {
"id": 0,
"name": "string"
},
"additionalProperties": {
"RPO": 0,
"addons": {
"database": true,
"fileSystem": true,
"snap": true,
"snapStatus": "DISABLED",
"indexCopy": true
},
"status": "ENABLED"
},
"settings": {
"fileSearch": {
"enabled": true,
"status": "NOT_APPLICABLE",
"statusMessage": "string",
"errors": [
{
"storage": {
"id": 0,
"name": "string"
},
"errorCode": 0,
"errorMessage": "string"
}
]
},
"enableAdvancedView": true,
"deviceStreams": 100,
"upgradedFromStoragePolicy": true
}
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Workload/ServerPlan' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"workloadType": "string",
"region": {
"id": 0,
"name": "string"
},
"plan": {
"planName": "string",
"backupDestinations": [
null,
null
],
"backupDestinationIds": [
0
],
"rpo": {
"backupFrequency": {
"schedules": [
{
"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"
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"doNotSubmitJobForBackupWindow": true,
"doNotSubmitJobForFullBackupWindow": true
},
"filesystemAddon": true,
"backupContent": {
"windowsIncludedPaths": [
"string"
],
"windowsExcludedPaths": [
"string"
],
"windowsFilterToExcludePaths": [
"string"
],
"backupSystemState": true,
"backupSystemStateOnlyWithFullBackup": false,
"useVSSForSystemState": true,
"windowsNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"macIncludedPaths": [
"string"
],
"macExcludedPaths": [
"string"
],
"macFilterToExcludePaths": [
"string"
],
"unixNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"unixIncludedPaths": [
"string"
],
"unixExcludedPaths": [
"string"
],
"unixFilterToExcludePaths": [
"string"
],
"macNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"forceUpdateProperties": true
},
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
},
"workload": {
"workloadTypes": [
{
"id": 0,
"name": "string"
}
],
"workloadGroupTypes": [
"FILE_SERVER"
],
"solutions": [
{
"id": 0,
"name": "string"
}
]
},
"allowPlanOverride": true,
"overrideRestrictions": {
"backupContent": "OPTIONAL",
"storagePool": "OPTIONAL",
"RPO": "OPTIONAL"
},
"parentPlan": {
"id": 0,
"name": "string"
},
"additionalProperties": {
"RPO": 0,
"addons": {
"database": true,
"fileSystem": true,
"snap": true,
"snapStatus": "DISABLED",
"indexCopy": true
},
"status": "ENABLED"
},
"settings": {
"fileSearch": {
"enabled": true,
"status": "NOT_APPLICABLE",
"statusMessage": "string",
"errors": [
{
"storage": {
"id": 0,
"name": "string"
},
"errorCode": 0,
"errorMessage": "string"
}
]
},
"enableAdvancedView": true,
"deviceStreams": 100,
"upgradedFromStoragePolicy": true
}
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Workload/ServerPlan' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"workloadType": "string",
"region": {
"id": 0,
"name": "string"
},
"plan": {
"planName": "string",
"backupDestinations": [
null,
null
],
"backupDestinationIds": [
0
],
"rpo": {
"backupFrequency": {
"schedules": [
{
"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"
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"doNotSubmitJobForBackupWindow": true,
"doNotSubmitJobForFullBackupWindow": true
},
"filesystemAddon": true,
"backupContent": {
"windowsIncludedPaths": [
"string"
],
"windowsExcludedPaths": [
"string"
],
"windowsFilterToExcludePaths": [
"string"
],
"backupSystemState": true,
"backupSystemStateOnlyWithFullBackup": false,
"useVSSForSystemState": true,
"windowsNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"macIncludedPaths": [
"string"
],
"macExcludedPaths": [
"string"
],
"macFilterToExcludePaths": [
"string"
],
"unixNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"unixIncludedPaths": [
"string"
],
"unixExcludedPaths": [
"string"
],
"unixFilterToExcludePaths": [
"string"
],
"macNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"forceUpdateProperties": true
},
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
},
"workload": {
"workloadTypes": [
{
"id": 0,
"name": "string"
}
],
"workloadGroupTypes": [
"FILE_SERVER"
],
"solutions": [
{
"id": 0,
"name": "string"
}
]
},
"allowPlanOverride": true,
"overrideRestrictions": {
"backupContent": "OPTIONAL",
"storagePool": "OPTIONAL",
"RPO": "OPTIONAL"
},
"parentPlan": {
"id": 0,
"name": "string"
},
"additionalProperties": {
"RPO": 0,
"addons": {
"database": true,
"fileSystem": true,
"snap": true,
"snapStatus": "DISABLED",
"indexCopy": true
},
"status": "ENABLED"
},
"settings": {
"fileSearch": {
"enabled": true,
"status": "NOT_APPLICABLE",
"statusMessage": "string",
"errors": [
{
"storage": {
"id": 0,
"name": "string"
},
"errorCode": 0,
"errorMessage": "string"
}
]
},
"enableAdvancedView": true,
"deviceStreams": 100,
"upgradedFromStoragePolicy": true
}
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Workload/ServerPlan' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"workloadType": "string",
"region": {
"id": 0,
"name": "string"
},
"plan": {
"planName": "string",
"backupDestinations": [
null,
null
],
"backupDestinationIds": [
0
],
"rpo": {
"backupFrequency": {
"schedules": [
{
"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"
}
],
"operationType": "ADD"
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"fullBackupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"doNotSubmitJobForBackupWindow": true,
"doNotSubmitJobForFullBackupWindow": true
},
"filesystemAddon": true,
"backupContent": {
"windowsIncludedPaths": [
"string"
],
"windowsExcludedPaths": [
"string"
],
"windowsFilterToExcludePaths": [
"string"
],
"backupSystemState": true,
"backupSystemStateOnlyWithFullBackup": false,
"useVSSForSystemState": true,
"windowsNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"macIncludedPaths": [
"string"
],
"macExcludedPaths": [
"string"
],
"macFilterToExcludePaths": [
"string"
],
"unixNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"unixIncludedPaths": [
"string"
],
"unixExcludedPaths": [
"string"
],
"unixFilterToExcludePaths": [
"string"
],
"macNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"forceUpdateProperties": true
},
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"databaseOptions": {
"logBackupRPOMins": 0,
"useDiskCacheForLogBackups": true,
"commitFrequencyInHours": 0
},
"workload": {
"workloadTypes": [
{
"id": 0,
"name": "string"
}
],
"workloadGroupTypes": [
"FILE_SERVER"
],
"solutions": [
{
"id": 0,
"name": "string"
}
]
},
"allowPlanOverride": true,
"overrideRestrictions": {
"backupContent": "OPTIONAL",
"storagePool": "OPTIONAL",
"RPO": "OPTIONAL"
},
"parentPlan": {
"id": 0,
"name": "string"
},
"additionalProperties": {
"RPO": 0,
"addons": {
"database": true,
"fileSystem": true,
"snap": true,
"snapStatus": "DISABLED",
"indexCopy": true
},
"status": "ENABLED"
},
"settings": {
"fileSearch": {
"enabled": true,
"status": "NOT_APPLICABLE",
"statusMessage": "string",
"errors": [
{
"storage": {
"id": 0,
"name": "string"
},
"errorCode": 0,
"errorMessage": "string"
}
]
},
"enableAdvancedView": true,
"deviceStreams": 100,
"upgradedFromStoragePolicy": true
}
}
}'