SCHEDULE Configuration Syntax

The SCHEDULE Configuration allows the MPAvailability (AVMON) record to report the state of entities according to a defined schedule.

Only one SCHEDULE Configuration is created on a node, all schedules are then added to this configuration for each required entity. The schedule defines the periods when the entity is to be monitored with any periods outside of the schedule recorded as scheduled outages.

In the AVAILABILITY Configuration, the corresponding schedule is attached to the required entities. Each entity can only be attached to one schedule, although the schedule can be attached to a number of entities.

The following syntax shows the options available in the SCHEDULE Configuration.

SUBSYS SCHEDULE

SCHEDULE START (<ScheduleName>, <ScheduleStartDate>)
SCHEDULE END (<ScheduleName>, <ScheduleEndDate>)

SCHEDULE ADDSCHED (<ScheduleName>, ONCE, <Date>, <MonitoringPeriod>)
SCHEDULE ADDSCHED (<ScheduleName>, DAILY, <MonitoringPeriod>)
SCHEDULE ADDSCHED (<ScheduleName>, WEEKLY, <Weekdays>, <MonitoringPeriod>)
SCHEDULE ADDSCHED (<ScheduleName>, MONTHLY, <DaysOfTheMonth>, <MonitoringPeriod>)
SCHEDULE ADDSCHED (<ScheduleName>, MONTHLY, <Occurrence>, <Day>, <MonitoringPeriod>)
SCHEDULE ADDSCHED (<ScheduleName>, YEARLY, <DaysOfTheYear>, <MonitoringPeriod>)
SCHEDULE ADDSCHED (<ScheduleName>, YEARLY, <Occurrence>, <Day>, <Month>, <MonitoringPeriod>)

SCHEDULE EXCEPTION (<ScheduleName>, WEEKLY, <Weekdays>, <MonitoringPeriod>)
SCHEDULE EXCEPTION (<ScheduleName>, MONTHLY, <DaysOfTheMonth>, <MonitoringPeriod>)

GLOBAL EXCEPTION (<Date>, <MonitoringPeriod>)

Syntax Elements

SCHEDULE START

Defines the start of a schedule.

<ScheduleName>

Name of the schedule, up to 32 characters.

<ScheduleStartDate>

Starting date for the schedule e.g. 15 AUG 2017, 15AUG2017

SCHEDULE END

Defines the end of a schedule.

<ScheduleName>

Name of the schedule, up to 32 characters.

<ScheduleEndDate>

End date for the schedule e.g. 14 AUG 2009, 14AUG2009

SCHEDULE ADDSCHED

Specifies the schedule that the collector will use to associate with the entity.

<ScheduleName>

Name of the schedule, up to 32 characters.

<Date>

Specifies the date for ONCE schedule type. It is not applicable to DAILY, WEEKLY, MONTHLY or YEARLY schedule types.

<Weekdays>

Specifies days of the week for WEEKLY schedule type. It is not applicable to ONCE, DAILY, MONTHLY or YEARLY schedule types. Multiple entries must be separated by a pipe character '|'.  Example inputs are: MON or MON-FRI or MON|WED|THU.

<DaysOfTheMonth>

Specifies the days of the month for MONTHLY schedule type. It is not applicable to ONCE, DAILY, WEEKLY or YEARLY schedule types. Multiple entries must be separated by a pipe character '|'.  Example inputs are: 15 or 15|17|23 or 01-10.

<Occurrence>

Specifies the recurrence pattern for MONTHLY and YEARLY schedule types.  It is not applicable to ONCE, DAILY or WEEKLY schedule types.  Valid inputs are: FIRST|SECOND|THIRD|FOURTH|LAST.

<Day>

Specifies a day of the week for MONTHLY and YEARLY schedule types.  It is not applicable to ONCE, DAILY or WEEKLY schedule types. Valid inputs are DAY|MON|TUE|WED|THU|FRI|SAT|SUN.  When used in conjunction with the <Occurrence> field this will provide schedules such as: FIRST WEDnesday of the MONTH, THIRD FRIday of the YEAR, or LAST DAY of the MONTH.

<DaysOfTheYear>

Specifies the days of the year for YEARLY schedule type. It is not applicable for
ONCE, DAILY, WEEKLY or MONTHLY schedule types. Multiple entries must be separated by a pipe character '|'. Example inputs are: 13MAY or 05MAY|18JUN|24AUG.

<Month>

Specifies the month for YEARLY schedule types.  It is not applicable to ONCE, DAILY, WEEKLY or MONTHLY schedule types. Example inputs are: JAN or FEB or MAR or APR or MAY or JUN or JUL or AUG or SEP or OCT or NOV or DEC.

<MonitoringPeriod>

Specifies the monitoring time during the day e.g. 09:00-17:00 or 09:00-17:00|21:00-23:00. Multiple entries must be separated by a pipe character '|'.

SCHEDULE EXCEPTION

Exceptions can be defined in the schedule that will also be treated as scheduled outages; these exceptions take precedence over the monitoring periods.

Specifies exceptions to the schedule that the collector will use to associate with the entity. Unless specified an entity will be monitored all the time except the period specified in the exception.

<ScheduleName>

Name of the schedule, up to 32 characters.

<Weekdays>

Specifies days of the week for WEEKLY schedule type. It is not applicable to ONCE, DAILY, MONTHLY or YEARLY schedule types. Multiple entries must be separated by a pipe character '|'.  Example inputs are: MON or MON-FRI or MON|WED|THU.

<DaysOfTheMonth>

Specifies the days of the month for MONTHLY schedule type. It is not applicable to ONCE, DAILY, WEEKLY or YEARLY schedule types. Multiple entries must be separated by a pipe character '|'.  Example inputs are: 15 or 15|17|23 or 01-10.

<MonitoringPeriod>

Specifies the monitoring time during the day e.g. 09:00-17:00 or 09:00-17:00|21:00-23:00. Multiple entries must be separated by a pipe character '|'.

GLOBAL EXCEPTION

Global exceptions can be defined that will apply to all schedules contained in the SCHEDULE Configuration. The advantage of this syntax is that by using a single entry, exceptions can be applied to all schedules instead of adding individual exceptions to each defined schedule. For example, this syntax can be used during a system reboot in order to mark all entities as DOWN as a scheduled outage.

<Date>

Specifies the date on which the global exception will be applicable.

<MonitoringPeriod>

Specifies the monitoring time for the global exception e.g. 22:00-21:00 | 23:00-01:00

Provide feedback on this article