POLYCENTER Console Manager Users' Guide

*HyperReader

  CONTENTS

  Title Page

  Copyright Page

  Preface

  Part I    PCM Setup and Administration

  1      Introduction

  1.1     What PCM Is and What It Does

  1.2     Serviced Systems You Can Monitor and Manage
    1.2.1      Management and Monitoring Tasks

  1.3     Software Components
    1.3.1      Primary Console Controller
    1.3.2      Child Console Controller
    1.3.3      Event Notification Services
    1.3.4      User Interfaces
    1.3.5      Directories Used by PCM

  1.4     Online Help
    1.4.1      Getting Help From the Command Line Interface
    1.4.2      Getting Help From the C3 Interface

  1.5     Steps for Setting Up PCM

  2      Setting Up the Environment

  2.1     Hardware Requirements

  2.2     Transport Types
    2.2.1      Choosing Transport Types

  2.3     Connecting Using Direct Transport
    2.3.1      Setting Up a Direct Connection

  2.4     Connecting Using LAT Transport
    2.4.1      Setting Up a LAT Connection
    2.4.2      Configuring for LAT
    2.4.3      Creating Terminal Devices On the Host System

  2.5     Connecting Using TELNET Transport
    2.5.1      Setting Up a TELNET Connection
    2.5.2      Configuring for TELNET

  2.6     Connecting Using Pseudo-Terminals
    2.6.1      Configuring for Pseudo-Terminals

  2.7     Identifying and Solving Connection Problems
    2.7.1      Common Symptoms
    2.7.2      Possible Solutions

  3      Modifying the Configuration Database

  3.1     The Configuration Database

  3.2     The Configuration Editor
    3.2.1      What You Can Do from the Configuration Editor

  3.3     Setting Up Your Configuration Database for the First Time

  3.4     Using the Command Line Interface to the Configuration Editor
    3.4.1      Starting the Configuration Editor
    3.4.2      Configuration Editor Commands
    3.4.3      Getting Help in the Configuration Editor
    3.4.4      Adding Serviced Systems
    3.4.5      Adding Groups
    3.4.6      Adding Users
      3.4.6.1      Granting Privileges
    3.4.7      Setting PCM Characteristics
      3.4.7.1      Setting Timeout
      3.4.7.2      Setting File Space Checking and Thresholds
      3.4.7.3      Setting Archiving
    3.4.8      Modifying the Contents of the Configuration Database
    3.4.9      Deleting From the Configuration Database
    3.4.10     Verifying the Contents of the Configuration Database
    3.4.11     Saving the Configuration Database
    3.4.12     Saving the Contents of the Configuration Database In Another Binary File
      3.4.12.1     Editing the Contents of a Saved Binary File
    3.4.13     Saving the Contents of the Configuration Database in Text Format
      3.4.13.1     Exporting the Contents of the Configuration Database
      3.4.13.2     Importing the Contents of the Configuration Database
    3.4.14     Leaving the Configuration Editor
      3.4.14.1     Consequences of Saving With Verification Errors
    3.4.15     Activating Your Configuration Database Changes

  3.5     Using the X-Windows Interface to the Configuration Editor
    3.5.1      Starting the Configuration Editor
      3.5.1.1      Starting the Configuration Editor from the Command Line Interface
      3.5.1.2      Starting the Configuration Editor from the C3 Interface
    3.5.2      Configuration Editor Messages on Startup
    3.5.3      What the Configuration Editor Window Looks Like
    3.5.4      Getting Help in the Configuration Editor
    3.5.5      Adding Serviced Systems
    3.5.6      Adding Groups
    3.5.7      Adding Users
      3.5.7.1      Granting Privileges
    3.5.8      Setting PCM Characteristics
      3.5.8.1      Setting Timeout
      3.5.8.2      Setting File Space Checking and Thresholds
      3.5.8.3      Setting the Filespace Interval
      3.5.8.4      Setting Archiving
    3.5.9      Modifying the Contents of the Configuration Database
    3.5.10     Deleting From the Configuration Database
    3.5.11     Verifying the Contents of the Configuration Database
    3.5.12     Saving the Configuration Database
    3.5.13     Saving the Contents of the Database in Another Binary File
      3.5.13.1     Editing the Contents of a Saved Binary file
    3.5.14     Saving the Contents of the Configuration Database in Text Format
      3.5.14.1     Exporting the Contents of the Configuration Database
      3.5.14.2     Importing the Contents of the Configuration Database
    3.5.15     Leaving the Configuration Editor
      3.5.15.1     Consequences of Saving With Verification Errors
    3.5.16     Activating Your Configuration Database Changes

  3.6     Recreating the PCM Configuration Database

  4      Managing PCM

  4.1     Background Information on Archiving Log Files
    4.1.1      Hints on Archiving

  4.2     Managing Disk Space

  4.3     Managing PCM from the Command Line Interface
    4.3.1      PCM Management Functions
    4.3.2      Starting the PCM Software
      4.3.2.1      Restarting PCM
    4.3.3      Stopping the PCM Software
    4.3.4      Reconfiguring the PCM Software
    4.3.5      Archiving Log Files
      4.3.5.1      Archiving the PCM Event Log Files
      4.3.5.2      Archiving the Oldest Data
      4.3.5.3      Archiving All But The Most Recent Data
      4.3.5.4      Archiving Data On All Systems
      4.3.5.5      Archiving Data Without Confirmation
      4.3.5.6      Archiving Data Up To a Specified Time
      4.3.5.7      Deleting the Archived Data
      4.3.5.8      Changing the Archive Directory
      4.3.5.9      Reading Archived Data
    4.3.6      Finding the Status of PCM Components
      4.3.6.1      Information About PCM in General
      4.3.6.2      Information Specific to a Particular Serviced System
      4.3.6.3      Information on Users Connected to Consoles of Serviced Systems
      4.3.6.4      Information on Events

  4.4     Managing PCM from the C3 Interface
    4.4.1      Starting the PCM Software
      4.4.1.1      Restarting PCM at the C3 Interface
    4.4.2      Stopping the PCM Software
    4.4.3      Reconfiguring the PCM Software
    4.4.4      Archiving Log Files
      4.4.4.1      Archiving the PCM Event Log Files
      4.4.4.2      Archiving the Oldest Data
      4.4.4.3      Archiving All But The Most Recent Data
      4.4.4.4      Archiving Data On All Systems
      4.4.4.5      Archiving Data Up To a Specified Time
      4.4.4.6      Deleting the Archived Data
      4.4.4.7      Changing the Archive Directory
      4.4.4.8      Reading Archived Data
    4.4.5      Finding the Status of PCM Components
      4.4.5.1      Information About PCM in General
      4.4.5.2      Information Specific to a Particular Serviced System
      4.4.5.3      Information Specific to a Particular Group
      4.4.5.4      Information on Users Connected to Consoles of Serviced Systems
      4.4.5.5      Information on Events

  4.5     Backing Up the Configuration Database

  4.6     Verifying the Integrity of Log and Archive Files

  4.7     Repairing Log and Archive Files

  Part II    Using PCM

  5      Using PCM From the Command Line Interface

  5.1     Getting Online Help

  5.2     PCM Console Commands

  5.3     Connecting to the Console of a Serviced System
    5.3.1      Exiting the Console of a Serviced System
    5.3.2      Entering the Monitor Interface
    5.3.3      Locking and Unlocking Consoles

  5.4     Writing Console Activity Output to a File, Printer or Terminal
    5.4.1      Changing the Behavior of the Terminal Device
    5.4.2      Memory Constraints When Using Watch

  5.5     Extracting Historical Log Data for Review
    5.5.1      Extracting Events Based on Priority

  5.6     Invoking the Monitor Interface for a Serviced System

  5.7     Performing a Dialog With a Serviced System
    5.7.1      Status Values Returned by the Dialog Command
    5.7.2      Creating a Dialog Script

  5.8     Unlocking a Console Being Used by Another User

  5.9     Using Eventlist Interactively

  6      Using PCM From the C3 Interface

  6.1     What You Can Do from the C3 Interface

  6.2     Entering and Leaving the C3 Interface
    6.2.1      Starting the C3 Interface
    6.2.2      Leaving the C3 Interface

  6.3     What the C3 Interface Looks Like
    6.3.1      The Main C3 Window
      6.3.1.1      Contents of the C3 Window
      6.3.1.2      Displaying the Systems in a Group
    6.3.2      The Group Window
      6.3.2.1      Contents of the Group Window

  6.4     Getting Online Help
    6.4.1      Help From the Help Menu
    6.4.2      Help from Within a Dialog Box

  6.5     Connecting to the Console of a Serviced System
    6.5.1      Exiting the Console of a Serviced System
    6.5.2      Entering the Monitor Interface
    6.5.3      Locking and Unlocking Consoles

  6.6     Writing Console Activity Output to a File, Printer or Terminal

  6.7     Examining Events for a Specific System

  6.8     Extracting Historical Log Data

  6.9     Logging On To a Serviced System

  6.10    Invoking the Monitor Interface for a Serviced System

  6.11    Performing a Dialog with a Serviced System

  6.12    Unlocking a Console Being Used by Another User

  6.13    Locating a Serviced System

  6.14    Resetting the Color of Icons

  6.15    Looking at C3 Messages

  6.16    Using Eventlist Interactively

  7      Using the Monitor Interface

  7.1     What You Can Do from the Monitor Interface

  7.2     What the Monitor Interface Looks Like

  7.3     Starting the Monitor Interface
    7.3.1      Starting the Monitor Interface from the Command Line
    7.3.2      Starting the Monitor Interface from the Command Line
    7.3.3      The Monitor Initialization Command File

  7.4     Getting Help on the Monitor Interface

  7.5     Leaving the Monitor Interface

  7.6     Monitor Interface Commands

  7.7     Connecting to the Console of a Serviced System

  7.8     Unlocking a Console Being Used by Another User

  7.9     Reading Current Console Log Data

  7.10    Manipulating Screen Layout
    7.10.1     Displaying a Different System
    7.10.2     Displaying Multiple Systems Concurrently
    7.10.3     Returning to a Single Log Window
    7.10.4     Displaying Systems at Set Intervals

  7.11    Finding Historical Console Log Data
    7.11.1     By Time
    7.11.2     By Text String
    7.11.3     By Event

  7.12    Reading Previously Archived Log Data

  7.13    Transmitting a Break Signal on a Console Line

  7.14    Displaying Timestamped Console Log Data

  7.15    Performing a Dialog with a Serviced System
    7.15.1     Creating a Dialog Script

  7.16    Using Scripts

  8      Customizing PCM

  8.1     The Customization File

  8.2     Customizing the Monitor and Connect Interfaces
    8.2.1      Creating an Initialization File
    8.2.2      Setting Control Keys

  8.3     Customizing Your C3 Display
    8.3.1      How To Set Up a Common Console Manager C3 View
    8.3.2      Setting Startup Options
    8.3.3      Setting Control Keys
    8.3.4      Setting the DECnet Node Name and TCP/IP Host Name
    8.3.5      Setting the DECterm Resource File Name for a Serviced System
    8.3.6      Moving Icons
    8.3.7      Adding Icons Representing Peripherals
    8.3.8      Modifying Icons Representing Peripherals
    8.3.9      Modifying Icons Representing Serviced Systems
    8.3.10     Modifying Icons Representing Groups
    8.3.11     Displaying the Group, System and Peripheral Labels
      8.3.11.1     Displaying and Hiding Labels for Individual Icons
    8.3.12     Drawing Lines
    8.3.13     Adding Text to the Display
    8.3.14     Adding a Background Bitmap
    8.3.15     Changing Icon, Window and Label Colors
      8.3.15.1     Changing the Color of Group Icons
      8.3.15.2     Changing the Color of Serviced System Icons
      8.3.15.3     Changing the Color of Peripheral Icons
      8.3.15.4     Changing the Color of Labels
      8.3.15.5     Changing the PCM Display Background
    8.3.16     Changing Audio/Visual Indicators for Event Notification
    8.3.17     Creating Your Own Icons

  Part III    Event Notification Services (ENS)

  9      Understanding ENS

  9.1     What is ENS?

  9.2     Overview of the ENS Components

  9.3     Events
    9.3.1      Literal Strings and Regular Expressions in Events
    9.3.2      Event Attributes
    9.3.3      Events Generated by PCM

  9.4     Scans
    9.4.1      Scan Attributes
    9.4.2      Relationship Between Events and Scans

  9.5     Filters
    9.5.1      Filter Attributes
    9.5.2      Dispatches

  9.6     Actions
    9.6.1      Action Attributes
    9.6.2      Invoking Actions
      9.6.2.1      Command Line Data Passing
      9.6.2.2      IPC Data Passing

  9.7     Hints on Filtering Events and Dispatching Actions

  10     Setting Up the ENS Components

  10.1    Steps in Creating Filters, Dispatches and Actions

  10.2    Using the Command Line Interface to the Configuration Editor
    10.2.1     Adding Events
    10.2.2     Modifying and Deleting Events
    10.2.3     Adding Scans
    10.2.4     Modifying and Deleting Scans
    10.2.5     Adding Filters and Dispatches
    10.2.6     Modifying and Deleting Filters
      10.2.6.1     Modifying and Deleting Dispatches for Filters
    10.2.7     Adding Actions
    10.2.8     Modifying and Deleting Actions

  10.3    Using the X-Windows Interface to the Configuration Editor
    10.3.1     Adding Events
    10.3.2     Modifying and Deleting Events
    10.3.3     Adding Scans
    10.3.4     Modifying and Deleting Scans
    10.3.5     Adding Filters
      10.3.5.1     Adding Dispatches for Your Acions
    10.3.6     Modifying and Deleting Filters
      10.3.6.1     Modifying and Deleting Dispatches for Filters
    10.3.7     Adding Actions
    10.3.8     Modifying and Deleting Actions

  10.4    Example of How to Set Up a System to Scan for an Event

  11     Scenarios for Filtering Events

  11.1    Filtering for a Specific Event Class

  11.2    Filtering for a Specific Event Priority

  11.3    Filtering Events from a Group of Systems Depending on the Time

  11.4    Filtering Duplicate Events in a Group of Systems

  12     Using the Eventlist Interface

  12.1    Starting Eventlist
    12.1.1     Starting Eventlist from the Command line Interface
    12.1.2     Starting Eventlist from the C3 Interface

  12.2    What the Eventlist Interface Looks Like

  12.3    What You Can Do With Eventlist

  12.4    Restarting Eventlist

  12.5    Disconnecting Eventlist from ENS

  12.6    Reconnecting Eventlist to ENS

  12.7    Customizing Eventlist
    12.7.1     Modifying the Appearance of the Eventlist Interface on Startup
    12.7.2     Changing the Bell Volume Settings of Event Priorities
    12.7.3     Changing the Eventlist Background Color
    12.7.4     Changing the Way Eventlist Works
      12.7.4.1     Specifying Text for Acknowledged Events
      12.7.4.2     Specifying Text for Cleared Events
      12.7.4.3     Setting a Limit on the Number of Events Received
      12.7.4.4     Changing the Event Priority That Sets the ENS Icon Color
      12.7.4.5     Indicating That Eventlist is to Exit When PCM is Shut Down

  12.8    Manipulating Events
    12.8.1     Acknowledging Events
    12.8.2     Clearing Events
    12.8.3     Displaying an Event Context
    12.8.4     Removing Events by Priority or by Selection

  12.9    Stopping Events From Being Displayed in the Eventlist Window
    12.9.1     Filtering Out Events
      12.9.1.1     File Location of Saved Eventlist Filters
    12.9.2     Stopping Events Below a Specific Priority

  12.10   Viewing the Distribution of Event Priorities

  12.11   Saving Your Changes to Eventlist
    12.11.1    Action Routines
    12.11.2    The Command Line Interface
    12.11.3    The C3 Interface

  12.12   Restoring the Default Options

  13     Supplied Action Routines

  13.1    Eventlist
    13.1.1     Action Definition
    13.1.2     Userdata as Specified in Filter Dispatch

  13.2    Eventsingle
    13.2.1     Action Definition
    13.2.2     Userdata as Specified in Filter Dispatch
    13.2.3     Changing the Eventsingle X-Windows Settings

  13.3    Mail
    13.3.1     Action Definition
    13.3.2     Userdata as Specified in Filter Dispatch

  13.4    Broadcast
    13.4.1     Action Definition
    13.4.2     Userdata as Specified in Filter Dispatch

  13.5    Archive Cleanup
    13.5.1     Action Definition
    13.5.2     Userdata as Specified in Filter Dispatch
    13.5.3     Customizing the Archive Cleanup Action Routine

  14     Creating Your Own Action Routines

  14.1    Types of Action Routine

  14.2    Creating Shell Script Or Command Procedure Actions

  14.3    Creating Image Actions
    14.3.1     Acknowledging and Clearing Events

  14.4    Examples of Action Routines
    14.4.1     Building the Image
    14.4.2     Location of User Interface Routines

  15     Creating an Event Preprocessor

  15.1    What is Event Preprocessing?

  15.2    Writing an Event Preprocessor

  15.3    Example of an Event Preprocessor

  16     CM Callable Interface Routines

  CMActionName

  CMEventXxxx

  CMEventContextYyyy

  CMFreeEvent

  CMGetEventContext

  CMRetrieveEventText

  CMUserAcknowledgeEvent

  CMUserClearEvent

  CMUserGetEvent

  CMUserInit

  CMUserMainLoop

  CMUserPPInit

  CMUserPPSendEvent

  CMUserSendEvent

  CMUserShutdown

  A   Using VAX 8500/8700/8800 Systems as Serviced Systems

  A.1     Setting Up VAXconsole Ports
    A.1.1      On VAX 8500/8700/8800 Systems
    A.1.2      On VAX 8830/8840 Systems

  A.2     Completing Tasks on the Host System
    A.2.1      For VAX 8500/8700/8800 Systems
    A.2.2      For VAX 8830/8840 Systems

  B   Setting Up the X-Windows Transport for the X-Windows Interface

  B.1     Setting the X-Windows Destination for TCP/IP Transport

  B.2     Setting the X-Windows Destination for DECnet Transport

  C   PCM Commands Quick Reference

  D   Sample Configuration Database Export File

  E   Sample DIALOG File

  Glossary
    action . . . filter
    group . . . userdata

  EXAMPLES

  14-1       Example Action Routine

  14-2       Example Action Routine

  15-1       Example Event Preprocessor

  A-1        VAXconsole PRO380 Communication Line Setup Menu

  D-1        Configuration Database Export File for Manual Edit

  E-1        Example DIALOG File

  FIGURES

  1-1        Overview of PCM

  1-2        Steps for Setting Up PCM

  2-1        DECconnect Cable and Adapters

  2-2        Direct Connection

  2-3        Connection Using LAT Protocol

  2-4        Example Connection Using a DECserver ~ 700

  2-5        Connection Using TELNET Protocol

  2-6        Pseudo-Terminal Connection

  3-1        The X-Windows Configuration Editor Main Window

  3-2        Example of the System Dialog Box

  3-3        The Group Dialog Box

  3-4        The User Dialog Box

  3-5        The Characteristics Dialog Box

  4-1        Archiving Caused by Reaching the Critical Threshold

  4-2        Managing PCM from the C3 Interface

  4-3        Starting PCM from the C3 Interface

  4-4        Stopping PCM from the C3 Interface

  4-5        Reconfiguring PCM from the C3 Interface

  4-6        Archiving from the C3 Interface

  4-7        Archive Dialog Box

  4-8        PCM General Information

  4-9        Specific System Status

  4-10       Specific System Status

  4-11       Specific Group Status

  6-1        Example of Starting the C3 Interface

  6-2        Example of a Group Window in the C3 Interface

  6-3        Watch Dialog Box

  6-4        Console Manager Extract Dialog Box

  6-5        Locate System Dialog Box

  7-1        The Monitor Interface

  7-2        Multiple Log Windows

  8-1        Modify System Dialog Box

  8-2        Moving Icons

  8-3        Peripheral Icon Dialog Box

  8-4        Adding a Peripheral

  8-5        Adding Lines to Show Connections

  8-6        Adding Text

  8-7        Adding a Background Bitmap

  9-1        Overview of ENS

  9-2        Example of an Event Using the Context Attributes

  9-3        Scan Structure

  9-4        Flow Diagram for Filter Matching

  9-5        Flow Diagram for Executing Dispatches

  10-1       The Event Dialog Box

  10-2       The Scans Dialog Box

  10-3       Event Selection Box for Scans

  10-4       The Additional Scans Dialog Box

  10-5       The Filter Dialog Box

  10-6       The Dispatch Dialog Box

  10-7       The Dispatch Hours Dialog Box

  10-8       The Action Dialog Box

  10-9       The Event Dialog Box

  10-10      The Scans Dialog Box

  10-11      The Event Dialog Box

  10-12      The Additional Scans Dialog Box

  10-13      The System Dialog Box

  10-14      The Filter Dialog Box

  10-15      The Filter Event Dialog Box

  10-16      The Filter Class Dialog Box

  10-17      The Dispatch Dialog Box

  10-18      The Dispatch Hours Dialog Box

  11-1       Dispatching Events During Working Hours

  11-2       Dispatching Events During Non-Working Hours

  12-1       The Eventlist Window

  12-2       Eventlist Startup Settings Dialog Box

  12-3       Eventlist General Settings Dialog Box

  12-4       Eventlist Filter Settings Dialog Box

  13-1       Action Definition for Eventlist on Digital UNIX

  13-2       Action Definition for Eventsingle on Digital UNIX

  13-3       Action Definition for Mail on Digital UNIX

  13-4       Action Definition for Broadcast on Digital UNIX

  13-5       Action Definition for Archive_cleanup on Digital UNIX

  TABLES

  1 Supported Platforms

  2 The C3 Interface on VCS Version 1.4 and PCM Version 1.6

  1-1        PCM User Interfaces

  1-2        Directories Used by PCM on Digital UNIX Systems

  1-3        Directories Used by PCM on OpenVMS Systems

  2-1        Choosing the Transport Type for the Serviced System

  3-1        Configuration Editor Commands

  3-2        PCM Characteristics

  3-3        Removing Entities and References from the Configuration Database

  3-4        System Attributes

  3-5        Connection Details

  3-6        Group Attributes

  3-7        User Attributes

  3-8        PCM Characteristics

  3-9        Removing Entities and References from the Configuration Database

  4-1        PCM Management Functions

  4-2        Switches to the Shutdown Command

  4-3        Switches to the Reconfigure Command

  4-4        Switches to the Archive Command

  4-5        Switches to the Status Command

  5-1        PCM Command Line Commands

  5-2        Switches to the Watch Command

  5-3        Switches to the Extract Command

  5-4        Meaning of Status Values Reported by the Dialog Command

  5-5        Commands for Performing a Dialog

  6-1        Switches to console c3 and CONSOLE COORDINATE

  7-1        Monitor Interface Commands

  7-2        Keystrokes for Scrolling Through Data

  7-3        Monitor Interface Commands for Scrolling

  7-4        Switching Between Log Windows

  7-5        Commands for Performing a Dialog

  8-1        Default Control Keys

  8-2        Interfaces Affected By Having A Common C3 Interface on Digital UNIX

  8-3        Interfaces Affected By Having A Common C3 Interface on OpenVMS

  8-4        Default Control Keys

  8-5        File Extensions for Bitmaps

  9-1        ENS Components

  9-2        Regular Expression Metacharacters

  9-3        PCM Event Attributes

  9-4        Event Priorities and Default Colors

  9-5        PCM Console Manager Class Events

  9-6        PCM Scan Attributes

  9-7        PCM Filter Attributes

  9-8        PCM Dispatch Attributes

  9-9        How an Event is Filtered Using Subsets

  9-10       PCM Action Attributes

  9-11       Data Passing Methods

  9-12       Determining Data Passing Methods

  12-1       Digital UNIX Values for Eventlist

  12-2       OpenVMS Values for Eventlist

  12-3       Eventlist Task Availability

  13-1       Eventlist Details

  13-2       Values for Eventlist

  13-3       Eventsingle Details

  13-4       Values for Eventsingle

  13-5       Routine Customization Parameters

  13-6       Mail Details

  13-7       Values for Mail

  13-8       Broadcast Details

  13-9       Values for Broadcast

  13-10      Archive Cleanup Details

  16-1       CMEventXxxx Routines

  16-2       CMEventContextYyyyy routines

  C-1        Overview of PCM Commands