Skip to main content

Update the server plan​

Used to modify an exsiting server plan

Path Parameters
  • planId int32 required

    Id of the Plan to update

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 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?

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

  • 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

  • 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

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

    Flag to set to use System Default Service Level Agreement

  • SLAPeriod int32

    SLA Period in Days

  • excludeFromSLA boolean

    Flag to set to exclude plan from SLA

  • enableAfterDelay int32

    Time provided in Unix format. Give 0 to reset any existing delay.

  • exclusionReason string

    Reason for exclusion from SLA

  • databaseOptions object

    This feature applies only to database agents

  • logBackupRPOMins int32

    Log backup RPO in minutes

  • runFullBackupEvery int32

    Full backup frequency in days

  • useDiskCacheForLogBackups boolean

    Use disk cache for log backups

  • commitFrequencyInHours int32

    Commit frequency in hours

  • regionToConfigure object
  • id int32
  • name string
  • backupDestinationIds int32[]

    Primary Backup Destination Ids (which were created before plan creation).

  • snapshotOptions object

    This feature applies only to File System Agents

  • enableBackupCopy boolean

    Flag to enable backup copy

  • backupCopyRPOMins int32

    Backup copy RPO in minutes

  • backupCopyFrequency object

    Used to describe the frequency of backup

  • scheduleFrequencyType string

    Possible values: [MINUTES, DAILY, WEEKLY, MONTHLY, YEARLY]

    Default value: DAILY

    schedule frequency type

  • frequency int32

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

  • startTime int32

    Default value: 75600

    start time of schedule in seconds for daily, weekly, monthly, yearly frequency

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

    Possible values: [OPTIONAL, MUST, NOT_ALLOWED]

  • storagePool string

    Possible values: [OPTIONAL, MUST, NOT_ALLOWED]

  • RPO string

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

    Flag to specify if parent or derived plan backupDestination should be used when inherit mode is optional. True - derived, False - Base.

  • rpo boolean

    Flag to specify if parent or derived plan rpo should be used when inherit mode is optional. True - derived, False - Base.

  • backupContent boolean

    Flag 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 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.

Responses

Success

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/serverplan/:planid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
planId — path required
Body
{

  "newName": "string",

  "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

  },

  "filesystemAddon": true,

  "rpo": {

    "backupFrequency": {

      "schedules": [

        {

          "scheduleId": 0,

          "scheduleName": "string",

          "policyId": 0,

          "scheduleOperation": "MODIFY",

          "vmOperationType": "PLANNED_FAILOVER",

          "backupType": "FULL",

          "forDatabasesOnly": 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

          },

          "scheduleOption": {

            "useDiskCacheForLogBackups": true,

            "commitFrequencyInHours": 0,

            "daysBetweenAutoConvert": 0,

            "o365ItemSelectionOption": "SELECT_ALL",

            "jobRunningTimeInMins": 0

          }

        }

      ],

      "operationType": "ADD"

    },

    "backupWindow": [

      {

        "dayOfWeek": [

          "SUNDAY"

        ],

        "startTime": 0,

        "endTime": 0

      }

    ],

    "fullBackupWindow": [

      {

        "dayOfWeek": [

          "SUNDAY"

        ],

        "startTime": 0,

        "endTime": 0

      }

    ],

    "SLA": {

      "useSystemDefaultSLA": true,

      "SLAPeriod": 0,

      "excludeFromSLA": true,

      "enableAfterDelay": 0,

      "exclusionReason": "string"

    }

  },

  "databaseOptions": {

    "logBackupRPOMins": 0,

    "runFullBackupEvery": 0,

    "useDiskCacheForLogBackups": true,

    "commitFrequencyInHours": 0

  },

  "regionToConfigure": {

    "id": 0,

    "name": "string"

  },

  "backupDestinationIds": [

    0

  ],

  "snapshotOptions": {

    "enableBackupCopy": true,

    "backupCopyRPOMins": 0,

    "backupCopyFrequency": {

      "scheduleFrequencyType": "DAILY",

      "frequency": 1,

      "weeklyDays": [

        "SUNDAY"

      ],

      "dayOfMonth": 0,

      "weekOfMonth": "FIRST",

      "dayOfWeek": "SUNDAY",

      "monthOfYear": "JANUARY",

      "startTime": 75600

    }

  },

  "workload": {

    "workloadTypes": [

      {

        "id": 0,

        "name": "string"

      }

    ],

    "workloadGroupTypes": [

      "FILE_SERVER"

    ],

    "solutions": [

      {

        "id": 0,

        "name": "string"

      }

    ]

  },

  "allowPlanOverride": true,

  "overrideRestrictions": {

    "backupContent": "OPTIONAL",

    "storagePool": "OPTIONAL",

    "RPO": "OPTIONAL"

  },

  "overrideInheritSettings": {

    "backupDestination": true,

    "rpo": true,

    "backupContent": true

  },

  "settings": {

    "fileSearch": {

      "enabled": true,

      "status": "NOT_APPLICABLE",

      "statusMessage": "string",

      "errors": [

        {

          "storage": {

            "id": 0,

            "name": "string"

          },

          "errorCode": 0,

          "errorMessage": "string"

        }

      ]

    },

    "enableAdvancedView": true

  }

}

curl -L -X PUT 'https://localhost/webconsole/api/V4/ServerPlan/:planId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "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
  },
  "filesystemAddon": true,
  "rpo": {
    "backupFrequency": {
      "schedules": [
        {
          "scheduleId": 0,
          "scheduleName": "string",
          "policyId": 0,
          "scheduleOperation": "MODIFY",
          "vmOperationType": "PLANNED_FAILOVER",
          "backupType": "FULL",
          "forDatabasesOnly": 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
          },
          "scheduleOption": {
            "useDiskCacheForLogBackups": true,
            "commitFrequencyInHours": 0,
            "daysBetweenAutoConvert": 0,
            "o365ItemSelectionOption": "SELECT_ALL",
            "jobRunningTimeInMins": 0
          }
        }
      ],
      "operationType": "ADD"
    },
    "backupWindow": [
      {
        "dayOfWeek": [
          "SUNDAY"
        ],
        "startTime": 0,
        "endTime": 0
      }
    ],
    "fullBackupWindow": [
      {
        "dayOfWeek": [
          "SUNDAY"
        ],
        "startTime": 0,
        "endTime": 0
      }
    ],
    "SLA": {
      "useSystemDefaultSLA": true,
      "SLAPeriod": 0,
      "excludeFromSLA": true,
      "enableAfterDelay": 0,
      "exclusionReason": "string"
    }
  },
  "databaseOptions": {
    "logBackupRPOMins": 0,
    "runFullBackupEvery": 0,
    "useDiskCacheForLogBackups": true,
    "commitFrequencyInHours": 0
  },
  "regionToConfigure": {
    "id": 0,
    "name": "string"
  },
  "backupDestinationIds": [
    0
  ],
  "snapshotOptions": {
    "enableBackupCopy": true,
    "backupCopyRPOMins": 0,
    "backupCopyFrequency": {
      "scheduleFrequencyType": "DAILY",
      "frequency": 1,
      "weeklyDays": [
        "SUNDAY"
      ],
      "dayOfMonth": 0,
      "weekOfMonth": "FIRST",
      "dayOfWeek": "SUNDAY",
      "monthOfYear": "JANUARY",
      "startTime": 75600
    }
  },
  "workload": {
    "workloadTypes": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "workloadGroupTypes": [
      "FILE_SERVER"
    ],
    "solutions": [
      {
        "id": 0,
        "name": "string"
      }
    ]
  },
  "allowPlanOverride": true,
  "overrideRestrictions": {
    "backupContent": "OPTIONAL",
    "storagePool": "OPTIONAL",
    "RPO": "OPTIONAL"
  },
  "overrideInheritSettings": {
    "backupDestination": true,
    "rpo": true,
    "backupContent": true
  },
  "settings": {
    "fileSearch": {
      "enabled": true,
      "status": "NOT_APPLICABLE",
      "statusMessage": "string",
      "errors": [
        {
          "storage": {
            "id": 0,
            "name": "string"
          },
          "errorCode": 0,
          "errorMessage": "string"
        }
      ]
    },
    "enableAdvancedView": true
  }
}'