SPECTRUM. Control Panel User Guide (5029) r9.0.1

Transcription

1 SPECTRUM Control Panel User Guide (5029) r9.0.1

2 This documentation and any related computer software help programs (hereinafter referred to as the Documentation ) is for the end user s informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation 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 related 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 product are permitted to have access to such copies. The right to print copies of the Documentation and to make a copy of the related software is limited to the period during which the applicable 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 Documentation 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 DOCUMENTATION 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 DOCUMENTATION, 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 any product referenced in the Documentation is governed by the end user s applicable license agreement. The manufacturer of this Documentation is CA. 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 (b)(3), as applicable, or their successors. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. Copyright 2008 CA. All rights reserved.

3 Contents Preface Text Conventions v Documentation Location and Feedback vii Contact Technical Support vii 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 OneClick Administration SpectroSERVER Performance Users Configure Menu SpectroSERVER Location Server Host Security Model Type Editor Help Menu Chapter 3: Control Panel Function Buttons Process Control Start/Stop SpectroSERVER OneClick Administration Database Administration Save Database Restore Database Configure Host Security Location Server Exit Contents iii

4 Chapter 4: Message Window Chapter 5: SpectroSERVER Status iv Control Panel User Guide

5 Preface This guide is intended for SPECTRUM administrators and operators using SPECTRUM in the Windows, Solaris, or Linux environment. It is organized as follows: Chapter 1: Overview provides a brief introduction to the SPECTRUM Control Panel. Chapter 2: Control Panel Menus explains each of the menus available from the Control Panel. Chapter 3: Control Panel Function Buttons discusses the SPECTRUM Control Panel push-button interface. Chapter 4: Message Window discusses the SPECTRUM Control Panel Message Window. Chapter 5: SpectroSERVER Status discusses SpectroSERVER status in the SPECTRUM Control Panel Status field. 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.) Italic in angle brackets (<>) <$SPECROOT> Type the following: DISPLAY=<workstation name>:0.0 export display Navigate to: <$SPECROOT>/app-defaults v

6 Text Conventions Element Convention Used Example Linux, Solaris, and Windows directory paths Unless otherwise noted, directory paths are common to both operating systems, with the exception that slashes (/) should be used in Linux and Solaris paths, and backslashes (\) should be used in Windows paths. <$SPECROOT>/app-defaults on Linux and Solaris 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 vi Control Panel User Guide

7 Documentation Location and Feedback Documentation Location and Feedback Check the following site for the latest updates and additions to SPECTRUM documents: To send feedback regarding SPECTRUM documentation, access the following web address: Thank you for helping us improve our documentation. Contact Technical Support For online technical assistance and a complete list of locations, primary service hours, and telephone numbers, contact Technical Support at the following web address: vii

8 Contact Technical Support viii Control Panel User Guide

9 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 on the SpectroSERVER machine in the: Windows environment by choosing Start, Programs, CA, SPECTRUM Control Panel. Solaris environment by choosing the Control Panel selection from the list of items on the SPECTRUM menu. Linux environment by running the SCP command located in <$SPECROOT>/bin/ 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. Overview 1

10 The following image shows an example of the Control Panel: Menus Function Buttons Message Window SpectroSERVER Status The Control Panel is divided into four functional areas. These areas are explained in the following sections: Control Panel Menus on page 3 Control Panel Function Buttons on page 13 Message Window on page 17 SpectroSERVER Status on page 19 2 Control Panel User Guide

11 Chapter 2: Control Panel Menus This chapter explains each of the menus available from the Control Panel: File Menu on page 3 Control Menu on page 5 Configure Menu on page 6 Help Menu on page 10 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. The Save Database selection serves the same function as the control panel Database Administration Save Database button. See the Save Database on page 14 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 Database button. Control Panel Menus 3

12 File Menu To restore the database 1. Click Restore Database. A dialog appears asking whether you wish to initialize your database. 2. Click Yes if you want to initialize the database or click No to perform a models-only load. In either case, the Restore Database dialog appears. 3. Locate and select a previously-saved database backup and click Open for the Windows environment or Ok Solaris environment. If SpectroSERVER is running, SpectroSERVER restarts after the database loads. 4. Click OK to begin the restore. 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 appears warning you of the consequences of initializing. 2. If you understand the consequences and still want to initialize your database, click Yes. If SpectroSERVER is running when you start to initialize your database, a second dialog appears indicating that the SpectroSERVER will be shut down during this process. 3. Click Yes to start the initialization. 4. Restart your OneClick web server and restart any open OneClick consoles. SPECTRUM refreshes the OC Explorer hierarchy and topology view and the SpectroSERVER database is initialized. Exit This selection closes the SPECTRUM Control Panel. 4 Control Panel User Guide

13 Control Menu 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. OneClick Administration The OneClick Administration Control menu selection serves as a quick way to access the OneClick Administration Pages. Clicking OneClick Administration prompts for the Host and Port of the OneClick web server and opens a browser to the OneClick Administration page. Host and Port settings are remembered the next time you open the dialog. Note: To determine the browser location on Windows, SPECTRUM opens the default web browser for the current user of the system. To determine the browser location on Unix and Linux, SPECTRUM uses the PATH variable to first locate Firefox, Mozilla, and then Netscape. If you would like to specify a specific browser, you can set the SPECTRUM_BROWSER environment variable. See the OneClick Console User Guide (5130) for instructions. SpectroSERVER Performance The SpectroSERVER Performance Control menu selection opens the Performance View application. For more information about Performance View, see the SpectroSERVER Performance Administration Guide (3509). Control Panel Menus 5

14 Configure Menu Users By selecting the Users Control menu selection, you can view user details, set a new password for an existing user, and create an Administrative super user account. Configure Menu The Configure menu allows you to configure SpectroSERVER, location server, host security and start the Model Type Editor. SpectroSERVER 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 the Distributed SpectroSERVER Administrator Guide (2770) for more information about the.vnmrc file. The SpectroSERVER Configuration window contains these areas: License on page 6 Performance Tuning on page 6 File Paths on page 7 Communications on page 7 Event Log on page 7 Statistics Log on page 8 License Your SPECTRUM license conveys the right to use SpectroSERVER for a set period of time as controlled by a SPECTRUM key and associated expiration date. The key and date are printed on a certificate shipped with the installation media. The SPECTRUM key is entered in the License area of the SpectroSERVER Configuration window. If a new SPECTRUM key is needed, enter the new key in the License field. 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. 6 Control Panel User Guide

15 Configure Menu To better understand the interaction between resources and the parameters controlling work threads, see the SpectroSERVER Performance Administration 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 a TCP port number indicating the port through which the client s user interface communicates with the SpectroSERVER. This parameter can be any valid, unreserved TCP port greater than the port number assigned to the IPPoPORT_USERRESERVED and below 64,000. The default is OxBEEF. SNMP Comm. 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). 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. Control Panel Menus 7

16 Configure Menu 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 9 Client Applications Panel on page 9 For more information about location servers, see the Distributed SpectroSERVER Administrator Guide (2770). 8 Control Panel User Guide

17 Configure Menu 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 The client application main location server hostname. It preserves landscape map integrity for different environments. Port The client application main location server port. Control Panel Menus 9

18 Help Menu Host Security The Host Security window lets you enter a list of servers and users allowed to connect to the host. You can also do this by editing the.hostrc file in the SPECTRUM directory. For more information about the.hostrc file, see the Distributed SpectroSERVER Administrator Guide (2770). To add a server or 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, select the server or user and click Remove. To let all hosts and users have access to the host machine, enter a plus sign in 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, object-classes, and their contents. This button is disabled except when the SpectroSERVER is in an INACTIVE or STOPPED state. This button is disabled when the database is being used by SpectroSERVER and during save or restore operations. To learn more about the Model Type Editor, see the Model Type Editor User Guide (0659). Help Menu Clicking Help displays the Control Panel Help menu. From the Help menu you can select one of the following: About SPECTRUM Control Panel Displays the release version of the SPECTRUM Control Panel, CA corporate address, and CA copyright information. SPECTRUM Control Panel Opens the Online Documents location window. Enter the directory location of the Online Documentation Roadmap and files. 10 Control Panel User Guide

19 Help Menu SPECTRUM Documentation Opens the Documentation Roadmap, which lists all SPECTRUM documents by functional categories. Enter the directory location of the Documentation Roadmap and files. Control Panel Menus 11

20 Help Menu 12 Control Panel User Guide

21 Chapter 3: Control Panel Function Buttons The middle section of the SPECTRUM Control Panel main window provides a convenient push-button interface to configure SPECTRUM resources, start and stop SpectroSERVER, and perform database administration. These buttons provide the same functionality as some of the control panel menu items. This chapter includes the following topics: Process Control on page 13 Database Administration on page 14 Configure on page 15 Exit on page 15 Process Control This section discusses the functions of the buttons in the Process Control section of the Control Panel. Start/Stop 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. Control Panel Function Buttons 13

22 Database Administration OneClick Administration The OneClick Administration button serves as a quick way to access the OneClick Administration Pages. Clicking OneClick Administration prompts for the Host and Port of the OneClick web server and opens a browser to the OneClick Administration page. Host and Port settings are remembered the next time you open the dialog. 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 Guide (2601). 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 opens. 2. Navigate to the directory you want to save your database and click OK to begin the save. Restore Database This selection lets you load a previously saved database. For more information about the Restore Database function, see Restore Database on page Control Panel User Guide

23 Configure 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 10. 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 8. 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. Control Panel Function Buttons 15

24 Exit 16 Control Panel User Guide

25 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 up and down, and left and right. You can stop messages from scrolling by selecting the Freeze option or scrolling up. Select the Scroll option 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. Message Window 17

26 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. 18 Control Panel User Guide

27 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. SpectroSERVER Status 19

28 20 Control Panel User Guide

29 Index Symbols.hostrc file 10.vnmrc resource file 6 A Archive Manager 5 S Save Database 3, 14 Status field 19 T Threads 6 D Distributed Data Management (DDM) database 7 E event_record_increment 8 Expiration Date 6 F File menu 3 I Initialize to Legacy Database 4 L Location Server 8 M messages and errors 17 O On-Line Backup 14 R Restore Database 3, 14 Index 21

30 22 Control Panel User Guide