pager-admin

Internal documentation for pager admin

Pager group administration

Setup

  • pager-admin must be run from a system that is running AFS and has “ldapsearch” installed
  • Your Unity ID must be in the cccadm PTS group to access/run the pager-admin script
  • Recommended host : See internal pager admin notes

Command syntax

/afs/unity/adm/paging/bin/pager-admin

Help

  • Type ‘help’ at the prompt, which shows the list of available commands
  • Add the -h option to any command for more information about that command

Warning Be careful, this script can corrupt the database if used incorrectly. With the less common commands (“delete”, eg), the script might not be completely debugged

Getting started

Before you make any changes to a group, list the group info first, this will show you the members of the group, their position in the pager, rotation, etc

list group <groupname>

The add command adds an existing user to the group $group

add normal user $user $group $pos

Note : If the user does not exist, it must first be created with the “create command”

$pos is their position in the pager rotation (they show up in the “list group” command)

Examples

Adding a user “joe” to the pager system, then into a group “shrooms”

$create user joe $add user joe shrooms (by default : added at the end of the rotation)

Adding a user “joe” into group “shrooms” at position 4

$add normal user joe shrooms 4

If there is a user in position 4, then users 4 and above are shifted down one position and joe is inserted at position 4

pager-admin commands

The entire list of commands and their definitions is shown below

Definition of terms

  • “groups” are the entities that have pager group members
  • “users” are accounts which are members of the groups
  • “organization” is a record in the user data
  • “orgs” are a informational label

User types

  • normal - a user in the pager system
  • locked - a user locked into a specific position in the rotation
  • delegate - a user not in the pager rotation that can be added

List commands

  • help - generate full list of commands
  • list all users - list unity IDs of all users in pager system
  • list all groups - list all groups in pager system
  • list user $user - list detail on user $user
  • list group $group - list detail on $group, including members and position in pager rotation

Describe commands

  • describe $table - describes the layout of a table in the database

Describe provides a list of attributes for a particular user or group that can be changed with the “modify” command. It also describes the available values for those attributes.

$table Attributes
accounts user
groups group

Create commands - create new users and groups

  • create user $user - create a new user $user
  • create group $group_name - create a new group called group_name

Add commands - adding users to groups as “normal”, “locked” or “delegate”

  • add normal user $user $group $pos - add user to $group with position $pos in cycle. If that position is occupied, $user is added at that position and higher numbered users are increased by one
  • add locked user $user $group $pos - add a user and lock them to a specific position in the rotation. Position is not changeable except by admin
  • add delegate user $user $group $admin - a delegate user is a member of the group that is not in the current pager rotation.

Modify commands - changing group attributes

  • modify user $user $user_attr $value - change $user attribute
  • modify group $group $group_attr $value - change $group attribute

Remove command - removing a user from a group

  • remove user $user $group - remove $user from $group

Delete commands - deleting users and groups

  • delete user $user - delete $user from system (remove from groups first)
  • delete group $group - delete group $group from the system

Exiting pager-admin

  • exit
  • quit

What is the purpose of the org?

The “org” is just an informational field in the user record. It is changeable by the user and has no particular meaning that affects the functionality of the pager system

Organization commands

Listed separately as organization information is just a label for a group. Example: The “textiles” group has the organization name “College Of Textiles”

  • list all orgs - list organizations in pager system and their organization number
  • list org $org_num - list organization by number (see list all orgs to show numbers)
  • create org $org - create a new organization $org
  • modify org of user $user $org
  • delete org $org

Parameter values

Parameter Values
rotation none, forward, reverse
offdutybehavior drop, hold
rotationstyle weekly, dayofweek, customweekly
oncall n, y
oncallpage n, y
startweek sunday, monday, tuesday, wednesday, thursday, friday, saturday
nodefacl n, y

Updating notification email for pager group rotation

Data is stored in “notifications” table of pager_db database on uni04sm. Field must be modified in MySQL

mysql -h sysnews.ncsu.edu -u pageradmin -p “use pager_db;”

update the notifications table

pager_db schema (uni04sm)

+-----------------+
| pager_db        |
+-----------------+
| access_list     | - users/groups allowed to contact users/groups
| account_cc      | - where to email cc of pages for user/group
| account_pagers  | - pager info tied to each account, can be multiples
| accounts        | - user/special account base info
| alerts          | - empty, web site alerts maybe?
| changes         | - custom group instructions
| custom_schedule | - used to set changes in customweekly rotations
| group_hours     | - list of paid hours per week
| group_members   | - members - groups table
| groups          | - group definitions
| holidays        | - list of known university paid holidays
| host_access     | - ip acls for some pager functions
| instructions    | - special instructions by user or group
| modems          | - modem hardware/connection info
| news            | - website news items
| notifications   | - where to send duty notices
| oncalllog       | - oncall history record by group, slot, uid
| organizations   | - list of org names by id number
| overrides       | - per day timeslot changes
| printed         | - per user list of weeks printed as timesheets
| problems        | - pulldown menu fodder
| taps            | - modem information for paging
+-----------------+

Tags:
Edit me