SPECTRUM Control Panel

Transcription

1 SPECTRUM Control Panel User Guide Document 5029

2 Notice This documentation (the "Documentation") and related computer software program (the "Software") (hereinafter collectively referred to as the "Product") is for the end user's informational purposes only and is subject to change or withdrawal by CA at any time. This Product may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Product is confidential and proprietary information of CA and protected by the copyright laws of the United States and international treaties. Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the Documentation for their own internal use, and may make one copy of the Software as reasonably required for back-up and disaster recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy. Only authorized employees, consultants, or agents of the user who are bound by the provisions of the license for the Software are permitted to have access to such copies. The right to print copies of the Documentation and to make a copy of the Software is limited to the period during which the license for the Product remains in full force and effect. Should the license terminate for any reason, it shall be the user's responsibility to certify in writing to CA that all copies and partial copies of the Product have been returned to CA or destroyed. EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS PRODUCT "AS IS" WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS PRODUCT, INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE. The use of this Product and any product referenced in the Documentation is governed by the end user's applicable license agreement. The manufacturer of this Product is CA. This Product is provided with "Restricted Rights." Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections , , and (c)(1) - (2) and DFARS Section (c)(1)(ii), as applicable, or their successors. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. Copyright 2007 CA. All rights reserved.

3 Contents Preface Chapter 1: Overview Chapter 2: Control Panel Menus File Menu Select Host Machine Save Database Restore Database Initialize to Legacy Database Exit Control Menu Start/Stop SpectroSERVER Auto Start/Stop Archive Manager Start/Stop Archive Manager SpectroGRAPH Configure Menu SpectroSERVER Configuration License Control Performance Tuning File Paths Communications Event Log Statistics Log Location Server Location Server Settings Panel Client Applications panel Host Security Model Type Editor Event Configuration Editor Help Menu About the SPECTRUM Control Panel SPECTRUM Control Panel Online Manuals Chapter 3: Control Panel Function Buttons Process Control Start and Stop the SpectroSERVER SpectroGRAPH

4 Contents Database Administration Save Database On-Line Backup Save Restore Database Configure Host Security Location Server Chapter 4: Message Window Chapter 5: SpectroSERVER Status Index SPECTRUM Control Panel User Guide

5 Preface This guide is intended for SPECTRUM Administrators and Operators using SPECTRUM in the Windows, Solaris, or Linux environment. What is in this book: This guide contains the following chapters Chapter 1, Overview, on page 7 provides a brief introduction to the SPECTRUM Control Panel. Chapter 2, Control Panel Menus, on page 9 explains each of the menus available from the Control Panel. Chapter 3, Control Panel Function Buttons, on page 17 discusses the SPECTRUM Control Panel push-button interface. Chapter 4, Message Window, on page 21 discusses the SPECTRUM Control Panel Message Window. Chapter 5, SpectroSERVER Status, on page 23 discusses SpectroSERVER status in the SPECTRUM Control Panel Status field. 5

6 Preface Text Conventions The following text conventions are used in this document: Element Convention Used Example Variables (The user supplies a value for the variable.) The directory where you installed SPECTRUM (The user supplies a value for the variable.) Courier and Italic in angle brackets (<>) <$SPECROOT> Type the following: DISPLAY=<workstation name>:0.0 export display Navigate to: <$SPECROOT>/app-defaults Linux, Solaris, and Windows directory paths Unless otherwise noted, directory paths are common to all operating systems, with the exception that slashes (/) should be used in Solaris and Linux paths, and backslashes (\) should be used in Windows paths. <$SPECROOT>/app-defaults on Solaris and Linux is equivalent to <$SPECROOT>\app-defaults on Windows. On-screen text Courier The following line displays: path= /audit User-typed text Courier Type the following path name: C:\ABC\lib\db Cross-references Underlined and hypertextblue See Document Feedback on page 6. References to SPECTRUM documents (title and number) Italic SPECTRUM Installation Guide (5136) Document Feedback Please send feedback regarding SPECTRUM documents to the following address: Spectrum-docs@aprisma.com Thank you for helping us improve our documentation. Online Documents SPECTRUM documents are available online at: Check this site for the latest updates and additions. 6 SPECTRUM Control Panel User Guide

7 Chapter 1: Overview The SPECTRUM Control Panel allows you to configure SPECTRUM resources, start and stop the SpectroSERVER, perform database administration, and maintain the SPECTRUM installation. You can access the SPECTRUM Control Panel in the Windows environment by choosing Start>Programs>SPECTRUM>Administration>Control Panel. In the Solaris or Linux environment you can access the Control Panel by choosing the Control Panel selection from the list of items on the SPECTRUM menu. Note: You must be logged in as the install user or someone in the install user s group to launch applications using the Control Panel. Unless the install user is root, root will not be able to launch applications from the Control Panel. The Control Panel is divided into four functional areas, as shown in Figure 1-1 on page 8. These areas are explained in the following chapters: Control Panel Menus on page 9: Control Panel Menus Control Panel Function Buttons on page 17: Process Control, Database Administration, and Configure buttons Message Window on page 21: Message Window SpectroSERVER Status on page 23: Status Window 7

8 Chapter 1: Overview Figure 1-1: SPECTRUM Control Panel Menus Function Buttons Message Window SpectroSERVER Status 8 SPECTRUM Control Panel User Guide

9 Chapter 2: Control Panel Menus This chapter explains each of the menus available from the Control Panel. In this chapter: File Menu Control Menu on page 10 Configure Menu on page 11 Help Menu on page 16 File Menu The File menu provides Database Administration functions and an Exit function to exit from the SPECTRUM Control Panel. Select Host Machine This option allows you to select the SpectroSERVER that you want to manage using the Control Panel. Save Database Depending on the configuration of the host machine, this selection either allows you to create an on-line backup or perform a complete save of the SpectroSERVER database. See the Save Database on page 18 section for complete instructions. Restore Database This selection lets you load a previously saved database. The Restore Database selection serves the same function as the control panel Database Administration Restore button. 9

10 Chapter 2: Control Panel Menus Initialize to Legacy Database Initialize to Legacy Database initializes your database to the state that existed following your last installation. All models specific to your network are removed, leaving a database structure consisting of the modeling catalog and a limited number of internal models. Important: Do not use this feature without first making a backup copy of your database. To initialize your SpectroSERVER database: 1. Select File > Initialize to Legacy Database from the menu. An information dialog box appears warning you of the consequences of initializing. 2. If you understand the consequences and still want to initialize your database, click OK. If you want to retain your existing database, click Cancel. 3. If SpectroSERVER is running when you start to initialize your database, a second dialog box appears indicating that the SpectroSERVER will be shut down during this process. Click OK to start the initialization. Exit This selection closes the SPECTRUM Control Panel. Control Menu The Control menu provides access to the following selections: Start/Stop SpectroSERVER This selection controls the operation of the SpectroSERVER. When the SpectroSERVER is running, the menu selection reads Stop SpectroSERVER. If the SpectroSERVER is inactive, the menu selection reads Start SpectroSERVER. Auto Start/Stop Archive Manager This selection lets you configure the Archive Manager to start or stop with the SpectroSERVER on the workstation you are managing. If you disable the Archive Manager, the Auto Stop/Start Archive Manager option becomes unavailable. Start/Stop Archive Manager This selection starts or stops the Archive Manager. Note: The Archive Manager control buttons will be disabled when any other running process has locked the database. Do not attempt to change the state of the Archive Manager when running an online backup. SpectroGRAPH This selection starts or stops the SpectroGRAPH. 10 SPECTRUM Control Panel User Guide

11 Configure Menu Configure Menu Selections from this menu let you configure SpectroSERVER and SpectroGRAPH, resources, and start the Model Type Editor and the Event Configuration Editor. SpectroSERVER Configuration The SpectroSERVER Configuration window lets you control certain aspects of the SpectroSERVER configuration. When you make changes in this window, you are editing the.vnmrc resource file, which controls SpectroSERVER operation and performance. See Defining SPECTRUM Resources (2559) for more information on the.vnmrc file. The SpectroSERVER Configuration window contains these areas: License Control on page 11 Performance Tuning on page 12 File Paths on page 12 Communications on page 12 Event Log on page 13 Statistics Log on page 13 License Control Your SPECTRUM license conveys the right to use SpectroSERVER and SpectroGRAPH for a set period of time as controlled by an Activation Key and associated Expiration Date. The Key and Date are printed on a certificate shipped with the installation CD. The Activation key and Expiration Date are entered in the License Control area of the SpectroSERVER Configuration window. If a new SS Activation Key is needed, input the new Key and Date in the License Control area. Activation Key If you attempt to use SpectroSERVER after the license term expires or with an invalid Activation Key (a unique encrypted password for your copy of SpectroSERVER), the system displays an error message advising you of an access problem. For further information concerning the SS Activation Key or the Expiration Date, consult the SPECTRUM Installation Guide (5136). Expiration Date This parameter (format = mm/dd/yyyy) is the expiration date of your SPECTRUM license. It must match the date entered during installation (obtained from support or from the certificate shipped with the SPECTRUM CD). It should not be changed after installation, unless you obtain a new Activation Key with a new expiration date. Device Limit This parameter shows the maximum number of devices that can be modeled with this SpectroSERVER. A value of 0 indicates that there is no limit on the number of devices that can be modeled. SPECTRUM Control Panel User Guide 11

12 Chapter 2: Control Panel Menus Performance Tuning SpectroSERVER is a multi-threaded process. During normal operation, each subsystem allocates numerous work threads. Since each thread consumes memory and computing capacity, it is important to understand how they can affect performance. Max Number of Poll Threads and Work Thread Age are two of the parameters used to control the allocation of work threads. To better understand the interaction between resources and the parameters controlling work threads, refer to the SPECTRUM Performance View User Guide (3509). Max. Number of Poll Threads This parameter sets the maximum number of work threads dedicated to polling. Work Thread Age Work threads that are no longer needed by a subsystem are returned to a work thread pool. This resource specifies how long (in seconds) a work thread can remain in the pool without being used. File Paths The SpectroSERVER Configuration window provides easy access to the file paths defined within the.vnmrc file. VNM File Path This parameter specifies the root subdirectory that contains SpectroSERVER external files, such as specific device alert mapping. Communications Communications Port This parameter specifies an IP port number. The port number is defined during installation.this parameter can be set to any valid, unreserved IP port below 64,000. SNMP Port This parameter specifies a value that can be used to select a port from which SNMP requests can be sent via the SpectroSERVER. It can be set to any unsigned 16-bit integer in the range 0x400 (1,024) to 0xFFFF (65,535). Some implementations (e.g., IBM Mainframe MVS system) of SNMP agents treat the port as a signed number. In these cases, this resource must be set to a value between 0x400 (1,024) to 0x7FFF (32,768). 12 SPECTRUM Control Panel User Guide

13 Configure Menu Event Log Under normal conditions, events are recorded in SPECTRUM s Distributed Data Management (DDM) database. However, if communication between the SpectroSERVER and the Archive Manager is lost, event information is stored temporarily in the SpectroSERVER s database until communication is re-established. The growth of this temporary event data in the SpectroSERVER database is regulated by entries in the SpectroSERVER.vnmrc resource file.the Event Log fields enable you to easily edit these settings. Max. Event Recs to Save Maximum number of records that can be stored in the database. The default is 20,000 records. Event Record Increment The number of records to be deleted from the database when the number of records exceeds the Max Event Recs to Save value. The default is 100 records. If you remove the event_record_increment entry from the.vnmrc file, the default is 250 records. Statistics Log Under normal conditions, statistics are recorded in SPECTRUM s Distributed Data Management (DDM) database. If communication between the SpectroSERVER and the Archive Manager is lost, however, statistics information is stored temporarily in the SpectroSERVER s database until communication is re-established. The growth of this temporary statistics data in the SpectroSERVER database is controlled by entries in the SpectroSERVER.vnmrc resource file. Use the Event Log fields to edit these settings. Max. Statistics Recs to Save The maximum number of records that can be stored in the database. The default is 5,000 records. Statistics Record Increment The number of records to be deleted from the Statistics Log database when the number of records exceeds the Max Statistics Recs to Save value. The default is 500 records. Location Server The Location Server is used to locate other SPECTRUM services on the network. The Location Server Configuration window lets you define the location server characteristics and your client applications. The Location Server Configuration window is divided into the following sections: Location Server Settings Panel on page 14 Client Applications panel on page 14 For more information on Location Servers, see Distributed SpectroSERVER (2770). SPECTRUM Control Panel User Guide 13

14 Chapter 2: Control Panel Menus Location Server Settings Panel Main LS Host This field contains the main location server host name. This host workstation determines which connection services are available on the network. Other location servers will connect to the main location server to determine the location and availability of services. Main LS Port This field contains the main location server port address. The default port address is 0xdaff. Backup Main LS Host This field contains the backup main location server name. If the main location server is not available when another machine attempts to connect to it, the machine will be redirected to the backup main location server. When a SPECTRUM system is booted up (or the Process Daemon, processd, is stopped and started), the location server on that system attempts to connect to the main location server to download the map information. The map information is a listing of each SPECTRUM service available and the location of each server. If the main location server is down at that time, the map information is not available to the SPECTRUM system. Therefore, clients will not be able to connect to any SPECTRUM service. The role of the backup main location server is to provide redundancy for the main location server in this scenario. If a backup main location server has been configured, the location server on the system will attempt to contact it after contact to the main location server has failed. This allows clients to access SPECTRUM services even though the main location server is down. The backup main location server system and the main location server should both be highly available systems. Each system that is pointing to the same main location server should also point to the same backup main location server. Backup Main LS Port This field contains the backup main location server port address. Max Connections The maximum number of port connections that can be made to this location server. The default number of connections is 750. Client Applications panel Hostname Port The client application main location server hostname. It preserves landscape map integrity for different environments. The client application main location server port. 14 SPECTRUM Control Panel User Guide

15 Configure Menu Host Security The Host Security window lets you enter a list of servers and users allowed to connect to the host. This is implemented by editing the.hostrc file in the Spectrum directory. To add a server/user to the list, enter the name in the appropriate box and click Add. To delete from either the Server List or the User List, enter the name into the appropriate box and click Remove. To let all other hosts have access to the host machine, enter a plus sign in Server List Add box and click Add. To let all other users have access to the host machine, enter a plus sign in the Server List Add box and click Add. To allow only the machine you are on to connect to the server, enter a minus sign in the Server List Add box and click Add. The minus sign will become the name of your current machine when added to the server list. Note: In order to save the host security configuration, there must be at least one entry in the Server List. Model Type Editor The Model Type Editor button starts the Model Type Editor (MTE) application. The Model Type Editor lets you modify the SpectroSERVER modeling catalog and configure relations, objectclasses, and their contents. This button is disabled (greyed-out) except when the SpectroSERVER is in an INACTIVE or STOPPED state. This button is disabled when the database is being used by either SpectroSERVER and/or during save or restore operations. To learn more about the operation of the Model Type Editor, refer to Model Type Editor User s Guide (0659). Note: In order to successfully launch the Model Type Editor in the Windows environment, the Exceed X Server must be installed and running on your machine. For more information on Exceed, refer to the SPECTRUM Installation Guide (5136). Event Configuration Editor The Event Configuration Editor (ECE) is an application that lets you control the way that SpectroSERVER and SpectroGRAPH process and display events and alarms. To start the Event Configuration Editor, select the ECEditor menu. Using the ECE, you can: Modify existing events and alarms Create events and alarms Define event to alarm mappings For more information on the Event Configuration Editor, see the Event Configuration Editor Users Guide (2260). For more information on event processing, see the Event Configuration Files Guide (5070). SPECTRUM Control Panel User Guide 15

16 Chapter 2: Control Panel Menus Help Menu Clicking Help displays the control panel Help Menu. The Help menu contains the following selections: About the SPECTRUM Control Panel Clicking this selection displays the release version of the SPECTRUM Control Panel, CA corporate address, and CA copyright information. SPECTRUM Control Panel Clicking this selection opens the Online Documents location window. Enter the directory location of the Online Documentation roadmap and files. Online Manuals Clicking this selection displays the documentation roadmap, which lists all SPECTRUM documents by functional categories.the left-hand panel of the Documentation roadmap contains active bookmarks to the major categories of SPECTRUM documents. The right-hand panel displays the text of the selected document. Use the scroll bar to move your field of view up or down within the document. 16 SPECTRUM Control Panel User Guide

17 Chapter 3: Control Panel Function Buttons The middle section of the SPECTRUM Control Panel main window provides a convenient pushbutton interface to configure SPECTRUM resources, start and stop SpectroSERVER, start SpectroGRAPH and perform database administration. These buttons provide the same functionality as some of the control panel menu items. The text on some buttons turns red while SpectroSERVER is running to indicate that these functions will interrupt SpectroSERVER operation. In this chapter Process Control Database Administration on page 18 Configure on page 19 Process Control The buttons in this section allow you to start and stop the SpectroSERVER and the SpectroGRAPH. Start and Stop the SpectroSERVER The Start/Stop SpectroSERVER button controls operation of SpectroSERVER (and the Archive Manager which can automatically start stop with the SpectroSERVER). This button is labeled Start SpectroSERVER when the server is INACTIVE or STOPPED. When the legend on the button reads Start SpectroSERVER, click this button to launch the SpectroSERVER. Conversely, this button is labeled Stop SpectroSERVER whenever the server is RUNNING or STARTING. When the legend reads Stop SpectroSERVER, click this button to stop the active SpectroSERVER. This button is disabled when the state is STOPPING, SAVING, RESTORING, and EDITING. You can also start and stop SpectroSERVER from the Control menu. 17

18 Chapter 3: Control Panel Function Buttons SpectroGRAPH The SpectroGRAPH button launches SpectroGRAPH against a selected server. You can also start SpectroGRAPH by selecting Start SpectroGRAPH from the Control menu. Note: This button is disabled when the Control Panel is managing Linux-based hosts. To launch SpectroGRAPH: 1. Click the SpectroGRAPH button. The Select SpectroSERVER dialog box appears. 2. Select one of the host system names from the list and click OK. (The default will be either the machine that Control Panel is running on, or the last server that SpectroGRAPH was run against.) The Filter/Search button lets you do a search on a specific set of characters. When this toggle switch is set to Filter, you can type in a target string to get a list of those host systems matching your entry. When set to Search, the system finds and highlights the first system in the overall list. Click the Next button to move the highlighted selection to the next matching name. 3. To cancel the SpectroGRAPH selection process, click Exit. Database Administration The Database Administration buttons allow you to save and restore a SPECTRUM database. Save Database The way the Save function works depends on the state of your local host. You can either generate an on-line backup or you can perform a complete save of the database. On-Line Backup If the SpectroSERVER is running, Save initiates a SPECTRUM On-Line Backup. For instructions on the on-line backup functionality, see the Database Management (2601) guide. Save If the SpectroSERVER is not running Save initiates a complete save of the SpectroSERVER database using SSdbsave (with the -c and -m switches). To complete the save operation: 1. Click Save Database. The Save as dialog box displays. 2. Type the path and filename for your database save file in the Save as dialog box. 3. Click OK to begin the save. To exit the save without disturbing any existing files, click Cancel. 18 SPECTRUM Control Panel User Guide

19 Configure Restore Database To restore the database: 1. Click Restore Database. A dialog box appears asking whether you wish to initialize your database. 2. Click Yes if you suspect the database may be corrupted, or click No to save time. In either case, the File Selection dialog box appears. 3. Set the path and select a previously-saved database backup using the File Selection dialog box, and click OK. If SpectroSERVER is running SpectroSERVER will be temporarily shut down and restarted. 4. Click OK to begin the restore. Click Cancel to exit the restore without disturbing the database. Configure The Configure section of the control panel has two buttons, Host Security and Location Server. Host Security The Host Security window lets you enter a list of servers and users allowed to connect to the host. This is implemented by editing the.hostrc file in the Spectrum directory. For more information see Host Security on page 15. Location Server The Location Server is used to locate other SPECTRUM services on the network. The Location Server Configuration window lets you define the location server characteristics and you client applications. For more information see Location Server on page 13. SPECTRUM Control Panel User Guide 19

20 Chapter 3: Control Panel Function Buttons 20 SPECTRUM Control Panel User Guide

21 Chapter 4: Message Window This text window in the lower half of the SPECTRUM Control Panel displays output messages and errors related to the SpectroSERVER process. Scroll bars let you move your field of view both up and down, and left and right. You can stop messages from scrolling by clicking the Freeze button or scrolling up. Click the Scroll button to resume message scrolling, or scroll to the bottom of the message window. All queued-up messages are displayed immediately when the window is unfrozen. No messages are lost. Some examples of common status messages displayed in the message window follow: The server has not been started The server is starting: Clients cannot attach to the server yet. The server is up and running: Clients can now attach to the server. The server is being administratively shut down: The server has abnormally terminated. (This should not occur during normal operation.) The server database is being backed-up: The server is in an inactive state at this time. The server database is being restored from a backup: The server is in an inactive state at this time. The database modeling catalog is being edited via the Model Type Editor (MTE): The server is in an inactive state at this time. The database is locked by an unknown process: A process other than SpectroSERVER, Save, Restore, or the Model Type Editor has locked the database. 21

22 Chapter 4: Message Window The SpectroSERVER is running version <version_number_x> but the database version is <version_number_y>. The SpectroSERVER and the database must have the same version number to be compatible. Please load a <version_number_x> version of the database: You are attempting to run the SpectroSERVER with the wrong version of the SpectroSERVER database. You must use a SpectroSERVER database of the version indicated in the error message. Exit: Click the Exit button at the lower right corner of the SPECTRUM Control Panel main window to close the Control Panel. This action has no effect on processes that were started from the SPECTRUM Control Panel. You can restart the SPECTRUM Control Panel at any time. The panel automatically synchronizes with the executing process and displays the current status. 22 SPECTRUM Control Panel User Guide

23 Chapter 5: SpectroSERVER Status The Status field on the SPECTRUM Control Panel indicates the status of the SpectroSERVER with text and color. Starting: yellow This field changes to Running (green) after the startup period expires. Stopping: yellow This field changes to Inactive (blue) after the server has shutdown. Running: green This field indicates a normal running state. Terminated: red This condition is abnormal and indicates an error. Inactive: blue This field indicates that server shutdown is complete. 23

24 Chapter 5: SpectroSERVER Status 24 SPECTRUM Control Panel User Guide

25 Index.hostrc file 15.vnmrc resource file 11 Activation Key 11 Archive Manager 10 Symbols A D Distributed Data Management (DDM) database 13 E Event Configuration Editor 15 event_record_increment 13 Expiration Date 11 M messages and errors 21 On-Line Backup 18 Restore Database 9, 19 Save Database 9, 18 Status field 23 Threads 12 O R S T File menu 9 F Initialize to Legacy Database 10 IP port number 12 I Location Server 13 L 25

26 Index 26 SPECTRUM Control Panel User Guide