Netcool/OMNIbus Probe for Alcatel 5620 Logfile Version Reference Guide. July 25, 2008 IBM SC

Transcription

1 Netcool/OMNIbus Probe for Alcatel 5620 Logfile Version Reference Guide July 25, 2008 IBM SC

2

3 Netcool/OMNIbus Probe for Alcatel 5620 Logfile Version Reference Guide July 25, 2008 IBM SC

4 Note Before using this information and the product it supports, read the information in Notices and Trademarks, on page 9. Edition notice This edition applies to version of Probe for Alcatel-Lucent 5620 Logfile (SC ) and to all subsequent releases and modifications until otherwise indicated in new editions. This edition replaces SC Copyright IBM Corporation 2006, US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents Document Control Page v IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 Logfile Summary Data acquisition Specifying which log files to read Modes of operation Peer-to-peer failover functionality Properties and command line options Elements Path status log files Alarm log files Error messages ProbeWatch messages Appendix. Notices and Trademarks... 9 Notices Trademarks Copyright IBM Corp. 2006, 2008 iii

6 iv IBM Tivoli Netcool/OMNIbus Probe for Alcatel 5620 Logfile: Reference Guide

7 Document Control Page Use this information to track changes between versions of this guide. The Probe for Alcatel-Lucent 5620 Logfile documentation is provided in softcopy format only. To obtain the most recent version, please visit the IBM Tivoli Netcool Knowledge Center: omnibus/probes/common/probes.html Table 1. Document modification history Document version Publication date Comments 01 July 25, 2008 First IBM publication. Copyright IBM Corp. 2006, 2008 v

8 vi IBM Tivoli Netcool/OMNIbus Probe for Alcatel 5620 Logfile: Reference Guide

9 IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 Logfile Summary The Alcatel 5620 Network Manager is a network management system for multi-technology networks. A set number of operators can simultaneously access the same system and manage the network from different sites. Management activities include customizing or restricting views of the network for different operators. The Probe for Alcatel-Lucent 5620 Logfile supports versions 4.0 and 4.1 of Alcatel 5620 and reads the log files to generate alarms. The Alcatel 5620 CORBA interface provides a good support to the Alcatel 5620 system. For details, see the Tivoli Netcool/OMNIbus Probe for Alcatel 5620 CORBA Reference Guide, (SC ). This guide contains the following sections: v Summary v Data acquisition on page 2 v Properties and command line options on page 3 v Elements on page 5 v Error messages on page 7 v ProbeWatch messages on page 8 The following table provides a summary of the Probe for Alcatel-Lucent 5620 Logfile. Table 2. Summary Probe target Alcatel 5620 Logfiles versions 4.0 and 4.1 Probe executable name Patch number 3.0 Probe supported on Properties file Rules file Requirements Connection method Remote connectivity Licensing nco_p_alcatel_5620_logfile Solaris, HP-UX, AIX, Linux $OMNIHOME/probes/arch/alcatel_5620_logfile.props $OMNIHOME/probes/arch/alcatel_5620_logfile.rules A currently supported version of Netcool/OMNIbus. probe-compatibility-3.x (foribm Tivoli Netcool/OMNIbus 3.6) Reads alarm log file or path status log file or both No Peer-to-peer failover functionality Available Internationalization Electronic licensing is no longer implemented in IBM Tivoli Netcool/OMNIbus products. All Tivoli products now use the IBM Tivoli software licensing process. Not available Copyright IBM Corp. 2006,

10 Table 2. Summary IP environment (continued) IPv4 only Data acquisition The Probe for Alcatel-Lucent 5620 Logfile can acquire event data from an alarm log file, from a path status log file, or from both. The probe also supports the offline replaying of historical data. Specifying which log files to read When the probe starts, it determines which log files to read from the properties file or from the command line options. If you specify a value for the AlarmLog property, the probe acquires data from an alarm log file. If you specify a value for the PathLog property, the probe acquires path status data. If you do not specify a value for either property, the probe does not run. Modes of operation You can run the probe in either recovery, cleanstart, or replay mode. The modes of operation dictate the probe to process recovery data in one of the following mode: v Recovery - The probe stores recovery data in a recovery file. When the probe starts, it references the recovery file to determine the point within the log file from which to start reading alarms. To specify a recovery file, use the AlarmRecoveryFile property. v Cleanstart - The probe ignores the recovery file and starts reading events created after the probe started. To run the probe in cleanstart mode, set the Cleanstart property to 1. v Replay - The probe ignores the recovery file and starts reading events from the beginning of the log file. To run the probe in replay mode, set the Replay property to 1. Peer-to-peer failover functionality The probe supports failover configurations where two probes run simultaneously. One probe acts as the master probe, sending events to the ObjectServer; the other acts as the slave probe on standby. If the master probe fails, the slave probe activates. While the slave probe receives heartbeats from the master probe, it does not forward events to the ObjectServer. If the master probe shuts down, the slave probe stops receiving heartbeats from the master and any events it receives thereafter are forwarded to the ObjectServer on behalf of the master probe. When the master probe is running again, the slave probe continues to receive events, but no longer sends them to the ObjectServer. 2 IBM Tivoli Netcool/OMNIbus Probe for Alcatel 5620 Logfile: Reference Guide

11 Example property file settings for peer-to-peer failover This section provides a sample failover setup for the probe. The following shows the peer-to-peer settings from the properties file of an example master probe: Server : "NCOMS" RulesFile : "master_rules_file" MessageLog : "master_log_file" PeerHost : "slave_hostname" PeerPort : 5555# [communication port between master and slave probes] Mode : "master" The following shows the peer-to-peer settings from the properties file of the corresponding slave probe: Server : "NCOMS" RulesFile : "slave_rules_file" MessageLog : "slave_log_file" PeerHost : "master_hostname" PeerPort : 5555 # [communication port between master and slave probes] Mode : "slave" Note: The properties file will also contain all other properties required to configure the probe. Properties and command line options You use properties to specify how the probe interacts with the device. You can override the default values by using the properties file or the command line options. The following table describes the properties and command line options specific to this probe. For more information about generic Netcool/OMNIbus properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide. Table 3. Properties and command line options Property name Command line option Description AlarmLog string -alarmlog string This property specifies the file from which the probe reads alarm data. AlarmRecoveryFile string -alarmrecoveryfile string The default is " ". This property specifies the file in which the probe stores recovery information for alarm data. The default is $OMNIHOME/var/ alarm.reco IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 Logfile 3

12 Table 3. Properties and command line options (continued) Property name Command line option Description AliveHeartbeat integer -aliveheartbeat integer This property specifies the frequency (in seconds) with which the probe sends a probe watch message to the ObjectServer to indicate that it is still active. CleanStart integer -nocleanstart (equivalent to CleanStart with a value of 0) -cleanstart (equivalent to CleanStart with a value of 1) The default is 0. Note: The probe rounds up any value that you specify to the nearest 5 seconds. For example, if you specify 13 in this field, the probes sends a probe watch message every 15 seconds. This property specifies whether the probe performs a clean start on start-up: 0: The probe reads events in the recovery file on start-up. 1: The probe ignores the recovery file and reads events created after the probe started. The default is 0. LogfileCheck integer -logfilecheck integer This property specifies the frequency (in seconds) with which the probe checks the log file when running in normal mode. The default is 10. Note: The probe rounds up any value that you specify to the nearest 5 seconds. For example, if you specify 13 in this field, the probes checks the log file every 15 seconds. PathLog string -pathlog string This property specifies the file from which the probe reads path status data. PathRecoveryFile string -pathrecoveryfile string The default is " ". This property specifies the file in which the probe stores recovery information for path status data. The default is $OMNIHOME/var/ path.reco. PollTimeout integer -polltimeout integer This property specifies the length of time (in seconds) the probe waits before attempting to open the log file again. The default is 5. 4 IBM Tivoli Netcool/OMNIbus Probe for Alcatel 5620 Logfile: Reference Guide

13 Table 3. Properties and command line options (continued) Property name Command line option Description Replay integer -noreplay (equivalent to Replay with a value of 0) -replay (equivalent to Replay with a value of 1) This property specifies whether the probe performs a replay on start-up: 0: The probe reads the recovery file. 1: The probe ignores any recovery file and starts reading events from the beginning of the log file. The default is 0. RetryTimeout integer -retrytimeout integer This property specifies the length of time (in seconds) the probe waits after receiving a critical error before restarting. The default is 0. Elements The probe breaks event data down into tokens and parses them into elements. Elements are used to assign values to ObjectServer fields; the field values contain the event details in a form that the ObjectServer understands. Path status log files The following table describes the elements that the Probe for Alcatel-Lucent 5620 Logfile generates for events read from path status log files. Table 4. Elements for path status log files Element name $bandwidth $call_id $call_type $change_mask $dateandtime $error $new_dest $new_source $old_dest $old_source Element description This element shows the bandwidth used. This element contains the call identifier. This element indicates the call type. This element contains the changed mask parameter. This value is only valid if null value is shown for the $old_dest and $new_dest elements. This contains specifies the date and time when the alarm occurred. This element contains the line in the alarm that caused the error. This element contains value for the new destination. This element is only valid if the source and destination values are different. This element contains the new source parameter value. This element contains value for the old destination. This element is only valid if the source and destination values are different. This element contains the old source parameter value. This value is only valid if the $new_dest element shows a non-null value. IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 Logfile 5

14 Table 4. Elements for path status log files (continued) Element name $partition_id $path_end_ida $path_end_idb $path_name $path_number $path_status $path_type Element description This element shows the partition identifier. This element indicates the identifier of path-end A. This element contains the identifier of path-end B. This element shows the path name. This element contains the path number. This element indicates the path status. This element shows the path type (voice, data, DSO, and so on). $rapid This element indicates the RAPID protection (0 - disabled, 1 - enabled). $reconfig $source This element contains the reconfiguration message. This element indicates the source of the data. Alarm log files The following table describes the elements that the Probe for Alcatel-Lucent 5620 Logfile generates for events read from alarm log files. Table 5. Elements for alarm log files Element name $dateandtime $error $inf1 $inf2 $node $sequence $severity $source $start $stream $summary Element description This element specifies the date and time when the alarm occurred. This element contains the line in the alarm that caused the error. This element specifies the extra information about the alarm. This element specifies the extra information about the alarm. This element specifies the node associated with the alarm. This is applicable only when the alarm file is in Telco format. This element specifies the sequence number for the alarm. This element specifies the severity of the alarm. This element specifies the source of the data. This element specifies the first information in the alarm; for example, PSC11^. This element specifies the information about the data stream containing the alarm. This element contains a brief summary of the alarm. 6 IBM Tivoli Netcool/OMNIbus Probe for Alcatel 5620 Logfile: Reference Guide

15 Error messages Error messages provide information about problems that occur while running the probe. You can use the information that they contain to resolve such problems. The following table describes the error messages specific to this probe. For information about generic Netcool/OMNIbus error messages, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide. Table 6. Error messages Error Description Action You must specify an alarm and/or a path file Failed to create File Name Could not process alert Failed to set Element Failed to start path status formatter Failed to start alarm status formatter Failed to send alert Unable to get events Read error Cannot process alert Unrecognized line format The probe found that neither an alarm log file nor a path status log file have been specified. The probe is unable to open the specified output file. The probe could not open the log file. The probe detected an unrecognized element. The alarm received is in an unrecognizable format. Probe failed to send an alert to the ObjectServer. The probe failed to get any events from the log file. The probe cannot read data from the log file. The probe was either unable to set the first or last occurrence, or failed to process the rules file, or could not send the alert to the ObjectServer. The probe found that an alarm line is not in a valid format. Set either the AlarmLog or the PathLog property. Check that the file exists and the file permissions are set correctly. Check that the file exists and that the file permissions are set correctly. Refer to your support contract for details about contacting the IBM Software Support. Refer to your support contract for details about contacting the Help Desk. Check that the probe is still running. If it is not, restart the probe. Check that the log file exists and the file permission is set to read. Check that the log file exists and the file permission set to read. Make sure that the ObjectServer is alive and that there is a valid rules file. Make sure the device is producing a valid alarm format. IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 Logfile 7

16 ProbeWatch messages During normal operations, the probe generates ProbeWatch messages and sends them to the ObjectServer. These messages tell the ObjectServer how the probe is running. The following table describes the ProbeWatch messages that the probe generates. For information about generic Netcool/OMNIbus ProbeWatch messages, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide. Table 7. ProbeWatch messages ProbeWatch message Description Triggers/causes Going down... The probe is shutting down. The probe is shutting down after performing the shutdown routine. 8 IBM Tivoli Netcool/OMNIbus Probe for Alcatel 5620 Logfile: Reference Guide

17 Appendix. Notices and Trademarks Notices This appendix contains the following sections: v Notices v Trademarks This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo , Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Copyright IBM Corp. 2006,

18 Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation Software Interoperability Coordinator, Department 49XA 3605 Highway 52 N Rochester, MN U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without notice. Dealer prices may vary. This information is for planning purposes only. The information herein is subject to change before the products described become available. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. 10 IBM Tivoli Netcool/OMNIbus Probe for Alcatel 5620 Logfile: Reference Guide

19 COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows: (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights reserved. If you are viewing this information softcopy, the photographs and color illustrations may not appear. Trademarks IBM, the IBM logo, ibm.com, AIX, Tivoli, and Netcool are trademarks of International Business Machines Corporation in the United States, other countries, or both. Adobe, Acrobat, Portable Document Format (PDF), PostScript, and all Adobe-based trademarks are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, other countries, or both. Intel, Intel Inside (logos), MMX, and Pentium are trademarks of Intel Corporation in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, or service names may be trademarks or service marks of others. Appendix. Notices and Trademarks 11

20 12 IBM Tivoli Netcool/OMNIbus Probe for Alcatel 5620 Logfile: Reference Guide

21

22 IBM Printed in USA SC