Skip to main content

Create Server Plan​

Select

SaaS
Customer Managed

Create a Server Plan

Request Body
  • planName string required

    Name of the new plan

  • backupDestinations object[]

    Backup destinations for the plan. Specify where you want to store your backup data.

  • backupDestinationName string required

    Backup destination details. Enter the name during creation.

  • storagePool object
  • id int32
  • name string
  • storageTemplateTags object[]

    It is used in Global config template plan creation. Needs in plan creation on global commcell

  • id int32
  • name string
  • value string
  • storageType StorageType

    Possible values: [ALL, DISK, CLOUD, HYPERSCALE, TAPE]

  • netAppCloudTarget boolean

    Only for snap copy. Enabling this changes SVM Mapping to NetApp cloud targets only.

  • isConfiguredForReplication boolean

    Used if the copy is used for replication group

  • isSnapCopy boolean

    Is this a snap copy? If isMirrorCopy is not set, then default is Vault/Replica.

  • isMirrorCopy boolean

    Is this a mirror copy? Only considered when isSnapCopy is true.

  • region object
  • id int32
  • GUID string
  • name string
  • sourceCopy object
  • id int32
  • name string
  • backupsToCopy string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • fullBackupTypesToCopy PlanFullBackupTypeToCopy

    Possible values: [FIRST, LAST]

    Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default is LAST while adding new backup destination.

  • backupStartTime int32

    Backup start time in seconds. The time is provided in unix time format.

  • optimizeForInstantClone boolean

    Flag to specify if primary storage is copy data management enabled.

  • overrideRetentionSettings boolean

    Tells if this copy should use storage pool retention period days or the retention defined for this copy. Set as true to use retention defined on this copy.

  • retentionRuleType RententionRuleTypes

    Possible values: [RETENTION_PERIOD, SNAP_RECOVERY_POINTS]

    Which type of retention rule should be used for the given backup destination

  • retentionPeriodDays int32

    Possible values: >= 1 and <= 9999

    Default value: 30

    Retention period in days. -1 can be specified for infinite retention. If this and snapRecoveryPoints both are not specified, this takes precedence.

  • snapRecoveryPoints int32

    Possible values: >= 1

    Number of snap recovery points for snap copy for retention. Can be specified instead of retention period in Days for snap copy.

  • useExtendedRetentionRules boolean

    Use extended retention rules

  • extendedRetentionRules object

    If you want to update, specify the whole object. Extended retention rules should be bigger than retention period.

  • firstExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • secondExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • thirdExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • mappings object[]
  • vendor

    Possible values: [NETAPP, AMAZON, PURE, AZURE]

    Snapshot vendors available for Snap Copy mappings

  • source object
  • id int32
  • name string
  • target object
  • id int32
  • name string
  • sourceVendor object
  • id int32
  • name string
  • targetVendor object
  • id int32
  • name string
  • subclients object[]
  • id int32
  • name string
  • mappingType

    Possible values: [DEFAULT_MAPPING, SUBCLIENT_MAPPING]

    Mapping type for pure storage replicaton

  • backupDestinationIds int32[]

    Primary Backup Destination Ids (which were created before plan creation). This is only considered when backupDestinations array object is not defined.

  • 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 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]

    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.

  • 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

  • additionalInfo string
  • operationType string

    Possible 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 int64

    Time in seconds since the beginning of the day

  • endTime int64

    Time 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 int64

    Time in seconds since the beginning of the day

  • endTime int64

    Time in seconds since the beginning of the day

  • filesystemAddon boolean

    flag to enable backup content association for applicable file system workload.

  • 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 boolean

    Do you want to back up the system state? Applicable only for Windows

  • backupSystemStateOnlyWithFullBackup boolean

    Default value: false

    Do you want to back up system state only with full backup? Applicable only if the value of backupSystemState is true

  • useVSSForSystemState boolean

    Do you want to back up system state with VSS? Applicable only if the value of backupSystemState is true

  • windowsNumberOfDataReaders object
  • useOptimal boolean

    Set optimal number of data readers. if it is set to true, count will be ignored.

  • count int32

    Possible 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 boolean

    Set optimal number of data readers. if it is set to true, count will be ignored.

  • count int32

    Possible 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 boolean

    Set optimal number of data readers. if it is set to true, count will be ignored.

  • count int32

    Possible values: >= 1

    Number of data readers.

  • forceUpdateProperties boolean

    Do you want to sync properties on associated subclients even if properties are overriden at subclient level?

  • snapshotOptions object

    This feature applies only to File System Agents

  • snapRecoveryPoints int32

    Possible values: >= 1

    Number of snap recovery points for default snap copy for retention. Can be specified instead of retention period in Days for default snap copy.

  • retentionPeriodDays int32

    Default value: 30

    Retention period in days. -1 can be specified for infinite retention. If this and snapRecoveryPoints both are not specified, this takes precedence.

  • enableBackupCopy boolean

    Flag to enable backup copy

  • backupCopyRPOMins int32

    Default value: 240

    Backup copy RPO in minutes

  • enableSnapCatalog boolean

    Flag to enable deferred snapshot cataloging

  • backupCopyOptions object

    Options for snap management with backup copy

  • backupTypeToCopy BackupCopyFullBackupType

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS]

    Backup type to copy for backup copy operation

  • backupFullToCopy PlanFullBackupTypeToCopy

    Possible values: [FIRST, LAST]

    Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default is LAST while adding new backup destination.

  • startTime int32

    Snapshots to be copied from a particular time in unix time format. By default, 0 means since the inception of the snap copy.

  • enableAlert boolean

    Flag to enable backup copy fallen behind alert

  • alertInHours int32

    Default value: 48

    Alert to throw when backup copy falls behind in hours

  • action backupCopyFallenBehindAction

    Possible values: [BASED_ON_RETENTION, SKIP_IF_PENDING, WAIT_FOR_COMPLETION]

    Which type of action should be followed if backup copy falls behind

  • skipAfterThresholdDays int32

    Default value: 14

    The allowable delay in days before a backup copy job is considered overdue

  • databaseOptions object

    This feature applies only to database agents

  • logBackupRPOMins int32

    Log backup RPO in minutes

  • useDiskCacheForLogBackups boolean

    Use disk cache for log backups

  • commitFrequencyInHours int32

    Commit frequency in hours

  • workload object
  • workloadTypes object[]
  • id int32
  • name string
  • workloadGroupTypes WorkloadGroup[]

    Possible values: [FILE_SERVER, LAPTOP, HYPERVISOR]

  • solutions object[]
  • id int32
  • name string
  • allowPlanOverride boolean

    Flag to enable overriding of plan. Plan cannot be overriden by default.

  • 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 string

    Possible values: [OPTIONAL, MUST, NOT_ALLOWED]

  • storagePool string

    Possible values: [OPTIONAL, MUST, NOT_ALLOWED]

  • RPO string

    Possible values: [OPTIONAL, MUST, NOT_ALLOWED]

  • parentPlan object
  • id int32
  • name string
  • additionalProperties object
  • RPO int32

    The least RPO in minutes for the plan

  • addons object
  • database boolean

    Database options should be shown with this plan

  • fileSystem boolean

    File system options should be shown with this plan

  • snap boolean

    Snap options should be shown with this plan

  • snapStatus string

    Possible values: [DISABLED, ENABLED, INCOMPLETE]

  • indexCopy boolean

    Index copy options should be shown with this plan

  • status string

    Possible values: [ENABLED, DISABLED, INCOMPLETE, HIDDEN, BACKUP_DISABLED]

    status if plan backups are enabled or disabled

  • 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 boolean

    Flag for enabling indexing

  • status string

    Possible values: [NOT_APPLICABLE, ENABLED, SETUP_IN_PROGRESS]

    Default value: NOT_APPLICABLE

    Type of indexing status.

  • statusMessage string

    Tells 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 int32
  • name string
  • errorCode int32
  • errorMessage string

    Tells about the error occured during file search setup for given storage pool

  • enableAdvancedView boolean

    Setting to suggest plan has some advanced settings present. Setting is OEM specific and not applicable for all cases.

  • deviceStreams int32

    Default value: 100

    For each region, the data to backup is divided into these many streams while writing to backup destination.

  • upgradedFromStoragePolicy boolean

    Setting to suggest plan was created from PolicyToPlan workflow. If true, editing RPO is not allowed.

Responses

Success

Schema
  • plan object
  • id int32
  • GUID string
  • name string
  • errors object[]
  • component string

    Plan Entity for which error occured

  • errorCode int32

    Error Code for plan

  • errorMessage string

    Error message for plan

Loading...