schedule

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

The schedule object contains information about a schedule created to autonomously make a snapshot of a volume. You can retrieve schedule information for all schedules with the ListSchedules API method.

Object members

This object contains the following members:

Name Description Type

attributes

Indicates the frequency of the schedule occurrence. Possible values:

  • Day of Week

  • Day of Month

  • Time Interval

JSON object

hasError

Indicates whether or not the schedule has errors. Possible values:

  • true

  • false

boolean

hours

Shows the hours that will elapse before the next snapshot is created. Possible values are 0 through 24.

integer

lastRunStatus

Indicates the status of the last scheduled snapshot. Possible values:

  • Success

  • Failed

string

lastRunTimeStart

Indicates the last time the schedule started.

ISO 8601 date string

minutes

Shows the minutes that will elapse before the next snapshot is created. Possible values are 0 through 59.

integer

monthdays

Indicates the days of the month that a snapshot will be made.

array

paused

Indicates whether or not the schedule is paused. Possible values:

  • true

  • false

boolean

recurring

Indicates whether or not the schedule is recurring. Possible values:

  • true

  • false

boolean

runNextInterval

Indicates whether or not the schedule will run the next time the scheduler is active. When true, the schedule will run the next time the scheduler is active and then this value is set back to false. Possible values:

  • true

  • false

boolean

scheduleID

The unique ID of the schedule.

integer

scheduleInfo

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

JSON object

scheduleName

The unique name assigned to the schedule.

string

scheduleType

Only schedule types of snapshot are supported at this time.

string

snapMirrorLabel

The snapMirrorLabel to be applied to the created Snapshot or Group Snapshot, contained in the scheduleInfo. If not set, this value is null.

string

startingDate

Indicates the date the first time the schedule began or will begin; formatted in UTC time.

ISO 8601 date string

toBeDeleted

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

  • true

  • false

boolean

weekdays

Indicates the days of the week that a snapshot will be made.

array

Find more information