Click or drag to resize

ApiCreateScheduleRequest Properties

The ApiCreateScheduleRequest type exposes the following members.

Properties
  NameDescription
Public propertyAttributes
The "frequency" object is returned in "attributes" to indicate the frequency at which the snapshot will be made.
Valid values for "frequency" are:
Days of Week
Days of Month
Time Interval
Public propertyHours
Number of hours between snapshots or hour at which the snapshot will occur in "Days of Week", or "Days of Month" mode.
Valid values: 0 - 24
Public propertyMinutes
Number of minutes between snapshots or minute at which the snapshot will occur in "Days of Week", or "Days of Month" mode.
Valid values: 0 - 59
Public propertyMonthdays
The days of the month that a snapshot will be made.
Valid values: 1 - 31
Public propertyPaused
Indicates if the schedule should be paused or not.
Public propertyRecurring
Indicates if the schedule will be recurring or not.
Public propertyScheduleInfo
An object of schedule information about how the snapshot should be created at each scheduled interval.
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. (Array of Integers)
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. (String)
Public propertyScheduleName
Unique name for the schedule.
Public propertyScheduleType
Indicates the type of schedule to create.
Valid value is:
snapshot
Public propertyStartingDate
Time after which the schedule will be run. If not set the schedule starts immediately. Formatted in UTC time.
Public propertyWeekdays
Day of the week the snapshot is to be created.
Required values:
day: 0 - 6 (Sunday - Saturday)
offset: 1
Top
See Also