Table Of Contents

Command Scheduler

Command Scheduler

---

Revised: July 24, 2009, OL-3743-42

The Command Scheduler (scheduled-command) table allows an operator to schedule a command to execute daily, weekly, or monthly at a specific time. Once a command is scheduled, the Command Scheduler allows removing a command from the schedule. Regardless of whether the command previously executed, the command can be removed at any time. If the command is scheduled to recur and is currently executing within the Element Management System (EMS), the command completes in a normal fashion but is removed from the list from that point forward.

It is often necessary to schedule commands to occur during periods of least system activity. Using the start time and recurrence command parameters, commands can be scheduled at any time and at any frequency. The recurrence parameter schedules a command daily, weekly, or monthly. Scheduling a command without the recurrence parameter causes the Command Scheduler to execute the command only once.

The characteristics of a scheduled command are read once at execution time. During execution, the characteristics can be changed but do not affect the command that is running.

To view generated a report go to https://<active EMS IP address>. Select the report and open ScheduledCommand<generated id>.html. Report results vary based on the scheduled command entered.'

---

Note Noun-verb syntax is not checked until execution.

---

Table Name: SCHEDULED-COMMAND

Table Containment Area: OAMP

Command Types

Show, add, change, and delete

Examples

show scheduled-command id=1234

add scheduled-command start-time=2001-10-01 12:22:22; noun=database; verb=audit

change scheduled-command id=1234; start-time=2001-10-02 20:00:00

delete scheduled-command id=1234

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Change Rules: Security privilege levels apply.

Commands with additional tokens use keys as token and key-values as the token values. Multiple token/token values are separated with a comma (no white space is allowed). For example:

add scheduled-command start-time=2005-0901 02:22:00; noun=mgw; verb=control; 
keys=id,mode,target-state; key-values=emta-11,forced,oos; 

This forces the mgw id=emat-11 out of service at 2:22AM.

---

Note An asterisk preceeding a token name means the token is mandatory. A token without an asterisk is optional.

---

Syntax Description

ID (System generated)	Mandatory for change command. Primary key. System-generated identifier. INTEGER.
VERB	Mandatory for add command. Command-line interface (CLI) verb. VARCHAR(64): 1-64 ASCII characters; any valid command verb.
NOUN	Mandatory for add command. CLI noun. VARCHAR(64): 1-64 ASCII characters; any valid command noun.
KEYS	Key associated with the noun-verb combination. VARCHAR(1024): 1-1024 ASCII characters; any key or keys allowed for the noun-verb combination, separated by a comma. Spaces are not allowed. For example: type,display Note The field size is large because many commands include several keys whose length can be up to 1024 characters.
KEY-VALUES	Value associated with the key entered for the noun-verb combination. VARCHAR(1024): 1-1024 ASCII characters; any value or values associated with the key or keys entered, separated by a comma. Spaces are not allowed. For example: full,none Note The field size is large because many commands include several values whose length can be up to 1024 characters.
START-TIME	Mandatory for add command. Start time of the command. Enter all 19 ASCII characters as shown. DATE: yyyy-mm-dd hh:mm:ss.
NEXT-START-DAY (System generated)	The next time the command will run. System generated based on the start-time. NUMERIC.
USER-NAME (System generated)	Username of the last user to modify the scheduled command. VARCHAR(16): 1-16 ASCII characters.
EXECUTION- COUNTER (System generated)	System-generated command repetition counter. NUMERIC.
RECURRENCE	Number of times to execute the command. VARCHAR(16): 1-16 ASCII characters. Permitted values are: NONE (Default)—One time DAILY WEEKLY MONTHLY