Modify existing archive plan details
Select
Modify existing archive plan details
Path Parameters
- planId int32 required
Id of the plan
- application/json
Request Body
- newName string
New plan name to update
archivingRules object
Files which meet both time stamp and file size rules will be archived
fileTimestampMethod stringPossible values: [
LAST_ACCESSED
,LAST_MODIFIED
]Default value:
LAST_MODIFIED
fileTimestamp int32Default value:
90
To archive files based on the last accessed or modified date of each file within the folder, specify the number of days. Should be supplied with fileTimestampMethod.
fileSize int32Default value:
1
To archive files based on the size of the file, specify the minimum file size in KB.
afterArchivingPossible values: [
REPLACE_FILE_WITH_STUB
,DELETE_THE_FILE
]After an archive job, replace the file that meets the archiving rules with a stub or delete the file that meets the archiving rules
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
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
backupWindow object[]
Archive job will run only in the specified archive window
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
regionToConfigure 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 Archiving rules.
storagePool stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]RPO stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]archivingRules stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]
- 200
- 404
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Requested Details not found
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}