Update the server plan
Select
Used to modify an exsiting server plan
Path Parameters
- planId int32 required
Id of the Plan to update
- application/json
Request Body
- newName string
New plan name to update
backupContent object
This feature applies only to file system agents
windowsIncludedPaths string[]Paths to include for Windows
windowsExcludedPaths string[]Paths to exclude for Windows
windowsFilterToExcludePaths string[]Paths that are exception to excluded paths for Windows
backupSystemState booleanDo you want to back up the system state? Applicable only for Windows
backupSystemStateOnlyWithFullBackup booleanDefault value:
false
Do you want to back up system state only with full backup? Applicable only if the value of backupSystemState is true
useVSSForSystemState booleanDo you want to back up system state with VSS? Applicable only if the value of backupSystemState is true
windowsNumberOfDataReaders object
useOptimal booleanSet optimal number of data readers. if it is set to true, count will be ignored.
count int32Possible values:
>= 1
Number of data readers.
macIncludedPaths string[]Paths to include for Mac
macExcludedPaths string[]Paths to exclude for Mac
macFilterToExcludePaths string[]Paths that are exception to excluded paths for Mac
unixNumberOfDataReaders object
useOptimal booleanSet optimal number of data readers. if it is set to true, count will be ignored.
count int32Possible values:
>= 1
Number of data readers.
unixIncludedPaths string[]Paths to include for UNIX
unixExcludedPaths string[]Paths to exclude for UNIX
unixFilterToExcludePaths string[]Paths that are exception to excluded paths for Unix
macNumberOfDataReaders object
useOptimal booleanSet optimal number of data readers. if it is set to true, count will be ignored.
count int32Possible values:
>= 1
Number of data readers.
forceUpdateProperties booleanDo you want to sync properties on associated subclients even if properties are overriden at subclient level?
- filesystemAddon boolean
flag to enable backup content association for applicable file system workload.
rpo object
Recovery Point Objective (RPO) is the maximum amount of time that data can be lost during a service disruption. Your RPO determines the frequency of your backup jobs.
backupFrequency object
schedules object[]
scheduleId int32Id of the schedule if available, required for modifying, deleting schedule
scheduleName stringName of the schedule, for modify
policyId int32Schedule policy Id to which the schedule belongs
scheduleOperation stringPossible values: [
ADD
,DELETE
,MODIFY
]Default value:
MODIFY
Operation being performed on schedule
vmOperationType stringPossible values: [
PLANNED_FAILOVER
,TEST_BOOT
]Type of DR operation (only applicable for Failover groups)
backupType string requiredPossible values: [
FULL
,INCREMENTAL
,DIFFERENTIAL
,SYNTHETICFULL
,TRANSACTIONLOG
]Schedule Backup level
forDatabasesOnly booleanDefault value:
false
Boolean to indicate if schedule is for database agents
isRetentionBasedSyntheticFull booleanDefault value:
false
Boolean to indicate if synthetic full schedule is based on retention rules
schedulePattern object required
Used to describe when the schedule runs
scheduleFrequencyType string requiredPossible values: [
MINUTES
,DAILY
,WEEKLY
,MONTHLY
,YEARLY
,AUTOMATIC
]schedule frequency type
frequency int32Possible 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 int32Possible values:
>= 1
and<= 31
Day on which to run the schedule, applicable for monthly, yearly
weekOfMonth stringPossible values: [
FIRST
,SECOND
,THIRD
,FOURTH
,LAST
]Specific week of a month
dayOfWeek stringPossible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
,DAY
,WEEKDAY
,WEEKEND_DAYS
]monthOfYear stringPossible values: [
JANUARY
,FEBRUARY
,MARCH
,APRIL
,MAY
,JUNE
,JULY
,AUGUST
,SEPTEMBER
,OCTOBER
,NOVEMBER
,DECEMBER
]repeatIntervalInMinutes int32Possible values:
>= 1
How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types.
repeatUntilTime int32Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes
timezone object
id int32name stringstartTime int32Default value:
75600
start time of schedule in seconds
startDate int32start date of schedule in epoch format
endDate int32Schedule end date in epoch format
noOfTimes int32The 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 int32Possible values:
>= 6
No of days between two synthetic full jobs
maxBackupIntervalInMins int32Default value:
240
The number of mins to force a backup on automatic schedule.
scheduleOption object
Specific options to be set on schedules
useDiskCacheForLogBackups booleanUsed to enable disk caching feature on databases for automatic schedules on server plan
commitFrequencyInHours int32Commit frequency in hours for disk cache backups from automatic schedules
daysBetweenAutoConvert int32Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan
o365ItemSelectionOption stringPossible 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 int32total job running time in minutes
minBackupIntervalInMins int32Default value:
15
The min number of mins to check for file activity on automatic schedule.
logFilesThreshold int32Default value:
50
The min number of archived log files before a backup job should start
logsDiskUtilizationPercent int32Default value:
80
The min log destination disk threshold percentage
operationType stringPossible values: [
ADD
,MODIFY
,DELETE
,NONE
,OVERWRITE
]Operation type for the list
backupWindow object[]
Backup window for incremental backup
dayOfWeek string[]Possible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
]startTime int64Time in seconds since the beginning of the day
endTime int64Time in seconds since the beginning of the day
fullBackupWindow object[]
Backup window for full backup
dayOfWeek string[]Possible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
]startTime int64Time in seconds since the beginning of the day
endTime int64Time in seconds since the beginning of the day
SLA object
A server meets SLA (Service Level Agreement) when all of its subclients have at least one successful backup during the number of days specified at the CommCell, Server Group or plan level.
useSystemDefaultSLA booleanFlag to set to use System Default Service Level Agreement
SLAPeriod int32SLA Period in Days
excludeFromSLA booleanFlag to set to exclude plan from SLA
enableAfterDelay int32Time provided in Unix format. Give 0 to reset any existing delay.
exclusionReason stringReason for exclusion from SLA
logSLAMinutes int32Database log SLA period in Minutes
databaseOptions object
This feature applies only to database agents
logBackupRPOMins int32Log backup RPO in minutes
runFullBackupEvery int32Full backup frequency in days
useDiskCacheForLogBackups booleanUse disk cache for log backups
commitFrequencyInHours int32Commit frequency in hours
regionToConfigure object
id int32name string- backupDestinationIds int32[]
Primary Backup Destination Ids (which were created before plan creation).
snapshotOptions object
This feature applies only to File System Agents
enableBackupCopy booleanFlag to enable backup copy
backupCopyRPOMins int32Backup copy RPO in minutes
backupCopyFrequency object
Used to describe the frequency of backup
scheduleFrequencyType stringPossible values: [
MINUTES
,DAILY
,WEEKLY
,MONTHLY
,YEARLY
]Default value:
DAILY
schedule frequency type
frequency int32Possible values:
>= 1
Default value:
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 int32Possible values:
>= 1
and<= 31
Day on which to run the schedule, applicable for monthly, yearly
weekOfMonth stringPossible values: [
FIRST
,SECOND
,THIRD
,FOURTH
,LAST
]Specific week of a month
dayOfWeek stringPossible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
,DAY
,WEEKDAY
,WEEKEND_DAYS
]monthOfYear stringPossible values: [
JANUARY
,FEBRUARY
,MARCH
,APRIL
,MAY
,JUNE
,JULY
,AUGUST
,SEPTEMBER
,OCTOBER
,NOVEMBER
,DECEMBER
]startTime int32Default value:
75600
start time of schedule in seconds for daily, weekly, monthly, yearly frequency
workload object
workloadTypes object[]
id int32name stringworkloadGroupTypes WorkloadGroup[]Possible values: [
FILE_SERVER
,LAPTOP
,HYPERVISOR
]solutions object[]
id int32name string- allowPlanOverride boolean
Flag to enable overriding of plan. Once enabled, cannot be disabled.
overrideRestrictions object
To allow the derived plans that use this plan as the base plan to override the settings, property allowPlanOverride must be true, and then select one of the options for Storage pool, RPO and backup Content.
backupContent stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]storagePool stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]RPO stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]overrideInheritSettings object
This feature applies to derived plans when inherit mode is optional.Provides user to set entity preference between parent and derived plan.
backupDestination booleanFlag to specify if parent or derived plan backupDestination should be used when inherit mode is optional. True - derived, False - Base.
rpo booleanFlag to specify if parent or derived plan rpo should be used when inherit mode is optional. True - derived, False - Base.
backupContent booleanFlag to specify if parent or derived plan backupContent should be used when inherit mode is optional. True - derived, False - Base.
settings object
fileSearch object
This feature applies to file servers and virtualization. Enabling this feature allows you to search for backed-up files using the global search bar, and creates resource pools with required infrastructure entities.
enabled booleanFlag for enabling indexing
status stringPossible values: [
NOT_APPLICABLE
,ENABLED
,SETUP_IN_PROGRESS
]Default value:
NOT_APPLICABLE
Type of indexing status.
statusMessage stringTells what is happening behind the scene, so that user can knows why indexing is not enabled or if its in progress
errors object[]
File search was enabled on plan but failed to process some of the storage pool(s) with these errors
storage object
id int32name stringerrorCode int32errorMessage stringTells about the error occured during file search setup for given storage pool
enableAdvancedView booleanSetting to suggest plan has some advanced settings present. Setting is OEM specific and not applicable for all cases.
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Requested Details not found