Use this Knowledge Script to send a paging call with AppManager event information to one or more recipients. Paging systems and target recipients (individuals or groups) are defined in the %systemroot%\netiqpage.ini file on the computer where the action is targeted, either the AppManager Management Server computer (MS) or the AppManager agent computer (MC). Before using this script, review and edit the netiqpage.ini file to identify the groups, phone numbers, and other parameters appropriate for your specific paging system.
By default, the event information includes the name of the agent computer and the event severity. You can select additional information to include.
You can also construct a custom message to send to recipients.
This script raises an event if you select the custom message format but neglect to enter any text for the custom message body. Under these circumstances, the script continues to execute and uses the standard message format.
Because each paging system has its own command-line syntax or API requirements, you need to define some information about the paging systems you are using in the netiqpage.ini file before using this Knowledge Script. The netiqpage.ini file specifies:
Path to the paging server interface. For example, the path to the command-line program used to send the page.
Command-line parameters or API syntax used to construct the page. For example, a specific paging interface may require a pager number, sender ID, or start time as command line arguments.
Target group or profile names that contain the rules for contacting groups or individuals. For example, some paging systems allow an administrator to set up templates that define contact flow to control when specific groups can be reached by pager.
The following information is defined in the netiqpage.ini file in two sections:
The [system] section, which defines the paging system, the path to the interface, and the command line parameters to be passed in from the [group_name] section depending on the Name of the group to page you enter in the Knowledge Script.
The [group_name] sections, which define the details for target groups.
The following in an example of a netiqpage.ini file with definitions for three paging systems and two target groups, QA and Sales:
;;
;; sample netiqpage.ini file
;;
[system]
;; For the command line syntax for these paging systems:
;; first %s maps to the target_name [target]
;; second %s maps additional parameters [param]
;; third %s is the message passed in from the Knowledge Script
;;
attention=c:\AttnClient\attn -t %s %s %s
telalert=c:\usr\telalert\telalertc -c %s %s -m %s
hiplink=c:\hiplink\cms\hlclp -r:%s %s -m:'%s' ;; msg in quotes
[QA]
pageco1=hiplink
target1=M
param1=
start_time1=00/00/00 00:00:00
stop_time1=00/00/00 23:59:59
[Sales]
pageco1=telalert
target1=Pager
param1= -n 4083031937
start_time1=00/00/00 00:00:00
stop_time1=00/00/00 23:59:59
pageco2=telalert
target2=Pager
param2= -n 4083031937
start_time2=5/12/98 00:00:00
stop_time2=6/30/98 00:00:00
The Action_Page Knowledge Script uses the information defined in this file and the Action properties entered to construct the required command line to send the page. For example, if you set the Name of the group to page parameter to Sales, AppManager sends a page to the Sales pager number (408-303-1937) using the telalert paging system.
Within the netiqpaqe.ini file, you can set a paging start time and end time for each person or group. This allows you to define specific periods when the individuals in a group can be paged. For example, if you have a Tech Support group with two employees who can be paged any day of the week between the hours of midnight and 8:00 a.m. and one employee who can be paged at any hour during specific dates, you might create entries similar to the following in the netiqpaqe.ini file:
[TechSupport]
pageco1=telalert
target1=Blake // Blake can be paged
param1= -n 4083031937 // between 12:00 a.m.
start_time1=00/00/00 24:00:00 // and 8:00 a.m.
stop_time1=00/00/00 08:00:00 // (no start date or
// end date)
pageco2=telalert
target2=Andy // Andy has the same
param2= -n 4084551037 // schedule as Blake
start_time2=00/00/00 24:00:00
stop_time2=00/00/00 08:00:00
pageco3=telalert
target3=Alex // Alex can be paged any
param3= -n 4156542200 // hour from midnight
start_time3=7/12/98 00:00:00 // July 12, 1998 until
stop_time3=7/30/98 10:30:00 // 10:30a.m. July 30
Both the start_time and stop_time parameters consist of two parts—the date and time. If you do not want to specify a start date or an end date, set the first part of the appropriate parameter to 00/00/00 (as illustrated with Blake and Andy in the example above). If you do not want to specify a start time or an end time, set the second part of the appropriate parameter to 00:00:00 (as illustrated with Alex in the example).
You cannot use the start_time and stop_time parameters to set up weekly scheduling. You can only define scheduling profiles or templates using parameters associated with your paging system. For example, if your paging system supports a -s schedule_profile command-line parameter, you can include this in the netiqpaqe.ini file as you do other parameters. For example:
[system]
page_app=c:\PageSysClient\sendpage -t %s -n %s %s -m %s
[WeekdayCrew]
pageco1=page_app
target1=scott
param1= -n 4083031937 -s weekday_profile
// name of a template that
// allows paging Mon-Fri
start_time1=00/00/00 00:00:00
stop_time1=00/00/00 00:00:00
Set the following parameters as needed:
|
Parameter |
How to Set It |
|---|---|
|
Event Notification |
|
|
Event severity -- Action warning |
Set the event severity level, from 1 to 40, to indicate the importance of an event in which the Page job returns a warning. The default is 35 (magenta event indicator). |
|
Event severity -- Action failure |
Set the event severity level, from 1 to 40, to indicate the importance of an event in which the Page job fails. |
|
Severity Configuration |
|
|
Minimum event severity for Action |
Set the minimum severity level, from 1 to 40, for an event that triggers this Action. The default is 1. |
|
Maximum event severity for Action |
Set the maximum severity level, from 1 to 40, for an event that triggers this Action. The default is 40. |
|
Action |
|
|
Name of the group to page (in netiqpage.ini) |
Provide the name of the individual or group to receive this page. Valid names are the [group_name] sections you defined in the netiqpage.ini file. |
|
Send a test page to a file? |
Select Yes to send a test page to a file. The default is unselected. |
|
Full path to test page file |
Provide the full path to the file where you want to send your test page. The default is c:\page.log. |
|
Message format |
Select whether you want to use the standard message or create a custom message. The default is Standard. Use the Standard message format if you want the message text to be generated by the Knowledge Script. Use the Custom message format if you want to create your own message. |
|
Standard Message Options |
|
|
Include date/timestamp? |
Select Yes to include the date and time of the event. The default is unselected. |
|
Include JobID? |
Select Yes to include the ID of the Knowledge Script job that raised the event. The default is unselected. |
|
Include agent computer name? |
Select Yes to include the name of the computer on which the event was raised. The default is Yes. |
|
Include event severity? |
Select Yes to include the event severity with the page. The default is Yes. |
|
Include Knowledge Script name? |
Select Yes to include the name of the Knowledge Script that raised the event. The default is unselected. |
|
Include AppManager object name? |
Select Yes to include the name of the AppManager object where the event was raised. The default is unselected. |
|
Include AppManager event ID (MS Action only)? |
Select Yes to include the event ID number when the Action is initiated by the AppManager management server. The default is unselected. |
|
Include event detail message? |
Select Yes to include the text of the event detail message with the page. The default is unselected. |
|
Custom Message Options |
|
|
Custom message |
Provide the message, up to 255 characters, you want to send with the page. If you do not specify a message, AppManager constructs a default message including the name of the agent computer and the severity level of the event. |