SCH Service Parameters

This chapter describes the parameters for scheduling events to be performed automatically by the bridge/router and for setting up an automatic back-up and port loopback recovery using event-based macro execution (EBME). Table 110 lists the SCH Service parameters and commands.

Table 110 SCH Service Parameters and Commands

Parameters	Commands
ActiveSCHedule	ADD, DELete, SHow
CONFiguration	SHow
CONTrol	SETDefault, SHow
EbmeCONFig	SETDefault, SHow
EbmeCONTrol	SHow
EbmeEVent	ADD, DELete, SHow
EVent	ADD, DELete, SHow

Syntax

ADD -SCH ActiveSCHedule <mm/dd | SUN | MON | TUE | WED | THU | FRI | SAT > <daily schedule>

DELete -SCH ActiveSCHedule <mm/dd | SUN | MON | TUE | WED | THU | FRI | SAT >

SHow -SCH ActiveSCHedule [mm/dd | <day of the week> | <daily schedule> | TODAY] day of the week: SUN | MON | TUE | WED | THU | FRI | SAT

ADD and DELete: None
SHow: All active schedules currently defined

Description

The ActiveSCHedule parameter assigns, unassigns, and displays a daily schedule for a day of the week or a calendar date.

Values

When used with the ADD command, the first argument to the ActiveSCHedule parameter must be either a calendar date in the format mm/dd or one of the following keywords: SUN, MON, TUE, WED, THU, FRI; the second argument must be the name of a daily schedule (previously defined using the EVent parameter).

If there is a daily schedule set for the calendar date corresponding to today and if you have also set a day of the week schedule corresponding to today, only the daily schedule for the calendar date is used, not the day of the week schedule.

Syntax

SHow -SCH CONFiguration

No default

Description

The CONFiguration parameter displays the current settings of the CONTrol parameter, all of the active schedules, and all of the available daily schedules.

Syntax

SETDefault -SCH CONTrol = ([Enabled | Disabled], [RealTimeClock | NoRealTimeClock], [Log | NoLog])

SHow -SCH CONTrol

Disable, RealTimeClock, NoLog

Description

The CONTrol parameter enables or disables the scheduling function, specifies the use of the system's hardware clock (if any) or a clock emulated in bridge/router software, and enables or disables logging of scheduled event.

Values

Enabled | Disabled	Enables or disables the scheduling function.
RealTimeClock | NoRealTimeClock	RealTimeClock selects the system's hardware clock (NETBuilder II system only). NoRealTimeClock selects NETBuilder software clock emulation and locks out the Enable function until the software clock is reset. After resetting the clock, you can enable scheduling.
Log | NoLog	Log causes all commands or macros and the first 80 characters of each resulting system response message to be stored in the system log buffer. NoLog curtails logging. Output from macros is not logged regardless of the Log | NoLog setting.

Syntax

SHow -SCH EbmeCONFig

No default

Description

The EbmeCONFig parameter displays the current values of the EbmeCONTrol parameter, and all events and actions configured for a given port.

Syntax

SETDefault -SCH EbmeCONTrol = ([Enable | Disable], [RunOnBootFail | NoRunOnBootFail], [Log | NoLog])

SHow -SCH EbmeCONTrol

Disable, NoRunOnBootFail, NoLog

Description

The EbmeCONTrol parameter enables or disables EBME.

Values

Enable | Disable	Enables and disables EBME.
RunOnBootFail | NoRunOnBootFail	When RunOnBootFail is specified, EBME is enabled when the primary connections fail to establish within 5 minutes after the bridge/router boots, the actions set for the PortDown event of the primary port occur if EBME is enabled. No action is taken with NoRunOnBootFail is specified.
Log | NoLog	The Log value causes 80 characters of the output from an event-based command to be recorded in the system log buffer. For event-based macros, the macro name and a macro complete/incomplete message is recorded. No action is taken with NoLog specified.

Syntax

ADD !<port> -SCH EbmeEVent <event_keywords> [<DebounceTimer> (1-32767sec)] [<command-string(1-80 char)> ]

DELete !<port> -SCH EbmeEVent <event_keywords> | ALL

SHow [!<port>] -SCH EbmeEVent

Debounce Timer = 15, command-string = Null

Description

The EbmeEVent parameter specifies an event for a port, for example, port up or port down.

Macros invoked through EBME cannot require user input or contain the following commands: PING, TraceRoute, DEFine, LIsten, SHow History, or UNDefine. Be sure to verify your macros before using them.

Values

<event_keywords>	Indicates the PortUp, PortDown, or LoopBack event for this command or macro. For LoopBack to be detected, the STP Service needs to be enabled and the port needs to be in the bridge forwarding state.
<DebounceTimer>	Sets the time in seconds to wait after receiving the port status change notification and before executing the user-defined command or macro.
<command-string>	Specifies an arbitrary bridge/router UI command or executable macro, for example, DO <macroname>.

Syntax

ADD -SCH EVent <daily schedule> <hh:mm> <command-string>

DELete -SCH EVent <daily schedule> <hh:mm | event# | ALL>

SHow -SCH EVent [<daily schedule> | TODAY | ALL]

ADD and DELete: None
SHow: ALL

Description

The EVent parameter creates, deletes, updates, or displays a daily schedule. A daily schedule consists of events. Events consist of a time of day and a command or macro. A daily schedule cannot be executed until it is assigned to a calendar date or day of the week, using ActiveSCHedule.

If a daily schedule name was previously defined, the ADD -SCH -EVent command adds events to the daily schedule, or modifies the event for the specified time. If a daily schedule name was not previously defined, the ADD -SCH EVent command creates a daily schedule under the specified name.

Values

<daily schedule>	You must assign a unique name to the daily schedule. The logical name can be 1-12 characters long and contain any combination of letters and numbers. The characters _, -, @, and * can be used, except as the first character of the daily schedule name. Reserved word values for the ActiveSCHedule parameter (for example, SUN, MON, TODAY) are not valid daily schedule names.
<hh:mm>	Specifies the time of day at which you want the event to occur, in the format hh:mm, where hh represents the hours in 24-hour format and mm represents the minutes. With DELete, you can specify the event number of the schedule to be deleted.
<command-string>	Specifies the desired command exactly as you would enter it on the command line. To execute a macro, use:
	DO <macro name>
ALL	Deletes all events of a schedule when used with the DELete command or allows you to display all events for a specified schedule.
TODAY	Displays the events for today for a specific schedule.

Example 1

To define the daily schedule "midnight" and specify that the macro "clocksync" will occur at 9:30 PM, enter:

ADD -SCH EVent midnight 21:30 DO clocksync

When this event occurs, the bridge/router receives the following message:

DO clocksync

Macros invoked through the scheduler cannot require user input or contain the following commands: PING, TraceRoute, DEFine, LIsten, SHow History, or UNDefine. If you schedule a macro that contains an illegal command, the scheduler will log the following error message (if you have enabled logging):

Command not accessible through scheduler

To add another event to the daily schedule "midnight," enter:

ADD -SCH EVent midnight 00:01 DO trace

You can schedule multiple events for the same time; each event is run consecutively.