ModifySchedule

Contributors netapp-mwallis ntap-bmegan Download PDF of this page

You can use ModifySchedule to change the intervals at which a scheduled snapshot occurs. You can also delete or pause a schedule by using this method.

Parameters

This method has the following input parameters:

Name

Description

Type

Default value

Required

attributes

Use to change the frequency of the snapshot occurrence. Possible values:

  • Days of Week

  • Days of Month

  • Time Interval

JSON object

None

No

hours

Number of hours between snapshots or hour at which the snapshot will occur in Days of Week or Days of Month mode. Valid values are 0 through 24.

string

None

No

name

The name of the snapshot. If no name is entered, the date and time the group snapshot was taken is used. The maximum name length allowed is 244 characters.

string

None

No

minutes

Number of minutes between snapshots or minute at which snapshot will occur in Days of Week or Days of Month mode. Valid values are 0 through 59.

integer

None

No

lastRunStatus

The result or status of the last scheduled snapshot creation.

string

None

No

paused

Indicates if the schedule should be paused or not. Valid values:

  • true

  • false

boolean

None

No

recurring

Indicates if the schedule will be recurring or not. Valid values are:

  • true

  • false

boolean

None

No

runNextInterval

Use to choose whether or not to run the snapshot the next time the scheduler is active. Valid values:

  • true

  • false

When set to true, the scheduled snapshot runs the next time the scheduler is active, and then resets back to false.

boolean

false

No

scheduleID

Unique ID of the schedule.

integer

None

Yes

scheduleName

Unique name for the schedule. The maximum schedule name length allowed is 244 characters.

string

None

No

scheduleType

Indicates the type of schedule to create. The only supported value is snapshot.

string

None

Yes

scheduleInfo

The unique name given to the schedule, the retention period for the snapshot that was created, and the volume ID of the volume from which the snapshot was created. Valid values:

  • volumeID: The ID of the volume to be included in the snapshot. (integer)

  • volumes: A list of volume IDs to be included in the group snapshot. (integer array)

  • name: The snapshot name to be used. (string)

  • enableRemoteReplication: Indicates if the snapshot should be included in remote replication. (boolean)

  • retention: The amount of time the snapshot will be retained in HH:mm:ss. If empty, the snapshot is retained forever. (string)

  • fifo: The snapshot is retained on a First-In-First-Out (FIFO) basis. (string)

  • ensureSerialCreation: Specify if a new snapshot creation should be allowed if a previous snapshot replication is in progress. (boolean)

None

No

snapMirrorLabel

The label used by SnapMirror software to specify the snapshot retention policy on a SnapMirror endpoint.

string

None

No

toBeDeleted

Indicates if the schedule is marked for deletion. Valid values:

  • true

  • false

boolean

None

No

startingDate

Indicates the date the first time the schedule began or will begin.

ISO 8601 date string

None

No

monthdays

The days of the month that a snapshot will be made. Valid values are 1 through 31.

integer array

None

Yes

weekdays

Day of the week the snapshot is to be created. The day of the week starts at Sunday with the value of 0 and an offset of 1.

string

None

No

Return value

This method has the following return value:

Name

Description

Type

schedule

An object containing the modified schedule attributes.

Request example

{
  "method": "ModifySchedule",
  "params": {
    "scheduleName" : "Chicago",
    "scheduleID" : 3
    },
  "id": 1
}

Response example

{
  "id": 1,
  "result": {
    "schedule": {
      "attributes": {
        "frequency": "Days Of Week"
            },
      "hasError": false,
      "hours": 5,
      "lastRunStatus": "Success",
      "lastRunTimeStarted": null,
      "minutes": 0,
      "monthdays": [],
      "paused": false,
      "recurring": true,
      "runNextInterval": false,
      "scheduleID": 3,
      "scheduleInfo": {
        "volumeID": "2"
            },
      "scheduleName": "Chicago",
      "scheduleType": "Snapshot",
      "startingDate": null,
      "toBeDeleted": false,
      "weekdays": [
        {
          "day": 2,
          "offset": 1
      }
      ]
    }
  }
}

New since version

9.6