[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations

Schedule

Schedule represents the meta information required by the server to set resources in maintenance mode at the right interval/time. To construct specific schedules, please see some of the static helper utilities in this class.


Properties

integer as int32
hour Required

The beginning hour of the schedule.


string
scheduleType Required

Type of the schedule. NOTE: Currently schedule type ‘YEARLY’ is not supported.

Possible values are: UNKNOWNONCEDAILYWEEKLYMONTHLYYEARLY


integer as int32
minuteOfTheHour Required

The beginning minutes of the schedule.


integer as int32
duration Required

Duration of the schedule in minutes.


integer as int32
dayOfTheMonth Optional

Deprecated, will be removed after couple of releases.
Day of the month on which the job should be triggered. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with daysOfTheMonth and weeksOfTheMonth.


integer as int32
expireRuns Optional

The number of run after which the schedule should expire. Mutually exclusive with expirationDate and either of them should be always defined when scheduleType != ONCE.


string
expirationDate Optional

The expiration date of the schedule. Should be in format MM/DD/YYYY. Mutually exclusive with expireRuns and either of them should be always defined when scheduleType != ONCE.


array of string
daysOfTheWeek Optional

Days of the week on which the job should be triggered. Must be specified only when scheduleType = WEEKLY or scheduleType = MONTHLY.
When scheduleType = MONTHLY this parameter is mutually exclusive with dayOfTheMonth and daysOfTheMonth, should be specified together with daysOfTheWeek.

Possible values are: UNKNOWNSUNDAYMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAY


integer as int32
month Optional

Deprecated, will be removed after couple of releases.
Month of the year on which the job should be triggered. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with months.


array of integer as int32
months Optional

Months of the year on which the job should be triggered. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with month.


integer as int32
recurrence Optional

Configures how the schedule is repeated within the provided interval, e.g. if scheduleType = DAILY then setting recurrence = 2 would trigger the job every 2 days.
Applicable only when scheduleType = DAILY or scheduleType = WEEKLY.


array of string
daysOfTheMonth Optional

The list of the days of the month on which the job should be triggered. Applicable values are {1,2,…,31,LAST}. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with dayOfTheMonth and weeksOfTheMonth.


string
startDate Optional

Start date for the schedule. Should be in format MM/DD/YYYY and if not specified current date is used.


string
timeZone Optional

Time Zone of the schedule.
If not provided, defaults to the time of the vRealize Operations Manager server.


array of string
weeksOfTheMonth Optional

The list of the week indices of the month on which the job should be triggered. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with dayOfTheMonth and daysOfTheMonth, should be specified together with daysOfTheWeek.

Possible values are: UNKNOWNNFIRSTSECONDTHIRDFOURTHLAST

JSON Example

{
	"duration": 0,
	"hour": 0,
	"minuteOfTheHour": 0,
	"scheduleType": "UNKNOWN"
}
[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations
Property Of

MaintenanceSchedule

Feedback

Was this page helpful?