Home

NMS OAM System User`s Manual

1. _clock_monitor tS clock_control action _clock_reconfigure results if necessary N x ow SO 2 C oe eg S ee NO so oO main The main section of the program does the following Step Action 1 Initializes variables and parses the command line options 2 Invokes _initData_file to read and parse the configuration file 3 Attempts to open the switch for each listed board by invoking swiOpenSwitch and builds an array of switch handles swihd_array 4 Based on the information from the configuration file determines the primary and fallback timing references for the primary master and the fallback timing reference for the secondary master 5 Builds an array h110_parms containing the new configuration for each affected board 6 Configures the primary and secondary master by invoking swiConfigBoardClock with h110_parms NMS Communications 7 Registers to receive NMS OAM events 8 Invokes swiGetBoardClock for each board to determine its clocking status and stores the results in an array h110_query_parms 9 Invokes _printClockStatus to print the initial clocking status to the screen 10 Enters the while loop described in the previous illustration 11 Updates the screen based on clocking changes 12 Shuts down if the Q key is pressed 107 System level clocking with clockdemo NMS OAM System User s Manual _clock_monitor _clock_monitor is called at regular i
2. In a multiple host NMS OAM configuration it is possible to have boards in different hosts with the same board name and board number However to avoid confusion give each board a name and number that is unique to the entire host 16 NMS Communications NMS OAM System User s Manual Overview of NMS OAM Multiple host NMS OAM If your resources are distributed over several systems multiple CPUs chassis or both that are linked over an IP network you can set up a multiple host configuration of NMS OAM This configuration enables an application running on one system to access and manage resources on other systems A multiple host NMS OAM configuration consists of several hosts CPUs One of these hosts the management host configures and manages the resources such as boards on other hosts that are called resource hosts The following illustration shows the relationship between the management host and resource hosts Management host Resource host A Resource host B Each resource host runs an instance of the Natural Access Server ctdaemon including NMS OAM Each resource host also has its own NMS OAM database containing data for the components on that host only NMS Communications 17 Overview of NMS OAM NMS OAM System User s Manual Management applications and utilities such as the NMS OAM utilities reside on the management host The configuration text files also reside on the management host The following illust
3. AG 4040C_E1 Number 0 Bus 2 Slot 9 File agpi4000 cfg AG 4040C El Wink start protocol Name1 Product CG_6000C_Quad Number 1 Bus 2 Slot 10 File c6nocc cfg HO GEG O00 Cp wa Ne ee eeoa Name2 Product CG_6100C Number 2 Bus 2 Slot 11 File c lenocc cfg CG 6100C E1 No call control Name3 Product AG 4040C_E1 Number 3 Bus 2 S LOE 12 File agpi4000 cfg AG 4040C El Wink start protocol NMS Communications 79 Other utilities NMS OAM System User s Manual Board locate pciscan Name pciscan Purpose Determines the PCI bus and slot assignments for NMS PCI and CompactPCI boards installed in the system Usage pciscan options If you invoke pciscan without any command line options it returns the locations of all NMS PCI and CompactPCI boards in the system If you invoke pciscan with command line arguments the specified board flashes an LED The following table lists the valid command line options Description Specifies the PCI bus and slot location of the board on which to flash an LED Displays the Help screen and terminates Returns the locations for all PCI devices in the system including NMS PCI boards Displays additional information CG boards only Logs output to a file named pci_cfg txt Displays five PCI memory addresses Displays register values for NMS boards Description pciscan displays the PCI bus and PCI slot nu
4. Description Use oamgen to create a system configuration file describing the configuration of the boards in a chassis oamgen creates a file called sample cfg located in the directory from which oamgen was invoked Note For oamgen to operate ctdaemon must be running To learn how to start ctdaemon refer to Starting the Natural Access Server on page 34 As oamgen locates each board it displays the product name and PCI bus slot location of the board For example NMS OAM configuration file generator inserting board AG 4040C Bl 2 9 Inserting board CG_6000C_Quad 2 10 Pe lnisereing board CElcli0Gh 2 1 Inserting board AG 4040C_ Bl 2 13 A sample OAM configuration file sample cfg has been generated To boot the NMS boards in the chassis use the command oamsys f sample cfg In the system configuration file oamgen assigns a board name and number to each board Boards are numbered in the order in which oamgen discovers them in the system starting with board 0 The board name for each board is Namex where x is the board number for example Nameo0 oamgen also assigns each board a keyword file based on the board s product type Each keyword file is one of the sample keyword files installed for the boards in the nms oam cfg directory opt nms oam cfg under UNIX To learn what sample board keyword files are installed for your board types refer to the board documentation When oamgen is complete you can immediatel
5. To run on a remote host the utility must be physically resident on the remote host Use a separate third party utility such as te net rsh or rexec to invoke the utility When debugging Hot Swap applications use hssrv in console mode the default to see Hot Swap driver messages 76 NMS Communications NMS OAM System User s Manual Other utilities Procedure To run Assrv in console mode Step Action 1 Stop NMS OAM and any Natural Access applications 2 Stop hsmgr 3 Invoke hssrv with the option k to stop any previous instance of the driver hes k 4 Reboot the system 5 Start hssrv in console mode by entering ssa ac If a print option is included on the command line mmessage_type messages display as boards are inserted and extracted There are three types of messages Configuration messages messages related to a device configuration process Inesiays MAE ACK desst gt SUr hssrv Remove 40100000 4011FFFF hssrv Remove 40120000 4013FFFF hssrv Connected through bridge 0 8 hssrv BASE 0 32 bit 128 00 KB Configure as 40100000 4011FFFF Nestv BASE 1 32 bit 128 00 KB Configure as 40120000 4013Frrr ISSA S PASSIN INC ieee lz Sh keessa ar 2 Messe hssrv IRQ10O configured hssrv aghw AG PCI Board Error and warning messages hssrv Device is not in RT table hssrv Warning SetHWInt is not supported hssrv Assuming that IRQ is preconfigured Informational messages
6. roy to poll screen output every 10 seconds Wew ore Vox EO exit 56 NMS Communications NMS OAM System User s Manual Using oamsys and oammon Enter any of the following commands Command Description c Changes the number of lines of message that oammon prints to the screen every 10 seconds the default is ten lines After entering c enter a positive integer to indicate the number of lines of message text to print p Prints the last 10 lines of received message text to the screen every 10 seconds This is a toggle command The first time you enter p it enables on screen polling The second time you enter p it disables on screen polling q Exits oammon For oammon to report messages ctdaemon must be running To learn how to start Natural Access in this mode refer to Starting the Natural Access Server on page 34 If oammon is started before ctdaemon it displays Waiting for CT Access Server When oammon is running and ctdaemon starts oammon displays the interactive menu and begins logging messages to the file oammon log located in nms oam log under Windows and opt nms oam log under UNIX or Linux Each time you start oammon the previous oammon og file is moved to oammon bak and a new oammon iog file is created for the current session Messages reported by oammon include trace messages from managed components in the system For more information about tracing refer to the board documentation To monitor mu
7. NMS OAM System User s Manual 9000 6819 23 COMMUNICATIONS 100 Crossing Boulevard Framingham MA 01702 5406 USA www nmscommunications com NMS OAM System User s Manual No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of NMS Communications Corporation 2008 NMS Communications Corporation All Rights Reserved Alliance Generation is a registered trademark of NMS Communications Corporation or its subsidiaries NMS Communications Natural MicroSystems AG CG CX QX Convergence Generation Natural Access Natural Access MX CT Access Natural Call Control Natural Media NaturalFax NaturalRecognition NaturalText Fusion Open Telecommunications Natural Platforms NMS HearSay AccessGate MyCaller and HMIC are trademarks or service marks of NMS Communications Corporation or its subsidiaries Multi Vendor Integration Protocol MVIP is a registered trademark of GO MVIP Inc UNIX is a registered trademark in the United States and other countries licensed exclusively through X Open Company Ltd Windows NT MS DOS MS Word Windows 2000 and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and or other countries Clarent and Clarent ThroughPacket are trademarks of Clarent Corporation Sun Sun Microsystems Solaris Netra and the Sun logo are trademarks or registered trademarks of Sun Microsystems Inc in the United
8. a single chassis The boards are configured in the following way Board Description Drives Primary timing Fallback timing reference reference A Primary clock A_CLOCK NETREF Local digital trunk 2 master B Secondary clock B_CLOCK A_CLOCK Local digital trunk 3 master C Clock slave Nothing A_CLOCK B_CLOCK D Clock slave NETREF based on local A_CLOCK B_CLOCK digital trunk 4 Clock fallback is enabled on all boards Board A defined as the primary clock master drives A_CLOCK All other boards on the system connected to the CT bus use A_CLOCK as their primary timing reference Board A derives its own timing reference from the NETREF signal driven by board D based on a signal from one of board D s digital trunks trunk 4 In addition board A is configured to use timing signals received on one of its own digital trunks trunk 2 as its fallback timing reference If NETREF fails board A continues to drive A_CLOCK based on its fallback timing reference Board B is set up as a backup or secondary clock master driving the CT bus clock not driven by the primary clock master Board B normally receives its timing reference from A_CLOCK which is driven by board A This means that board B acts as a clock slave to board A If A_CLOCK fails board B continues driving B_CLOCK but now uses the timing signals received from one of its digital trunks trunk 3 All 96 NMS Communications NMS OAM System User s Manual H 100 and H 110 bus clocking
9. detected using the x option The board name is specified with the n option If the board name is omitted all detected boards are added Refer to Automatically detecting and adding boards on page 63 for more information When this option is used all other options except the x option are ignored b brdno Specify the target board number If this option and the g l m and n options are omitted any specified operations are performed for all boards Use this option to change the board number Refer to Changing board ID information on page 65 NMS Communications 59 Using oamcfg Option c product d export filename f cfgfile g shelf slot hor import filename k keyword value PCIbus slot m MAC_address n name 60 NMS OAM System User s Manual Use this option to Create a record in the NMS OAM database for the board containing basic board ID information product is the product string for the board type If product is oamcfg displays a list of all board product types supported by the installed plug ins in alphabetical order and then terminates If product is oamcfg chooses the first product name in this list Delete the records for the boards from the NMS OAM database Export a snapshot of the contents of the NMS OAM database to filename The contents of the file can then be imported into another NMS OAM database by invoking oamcfg with the import option Add
10. for information about all boards oamcfg q To perform an oamcfg operation for a board on a resource host use the command line option to specify the target host For example the following command queries for information about the board in PCI bus 1 slot 14 on resource host IP_3 Orme we 3 i igial E NMS Communications 61 Using oamcfg NMS OAM System User s Manual Displaying board product types When specifying board configuration information in a system configuration file you must supply the product type for each board The product type is a string that identifies the board type to NMS OAM Different board plug ins support different board types To determine what strings to specify for your boards you can query NMS OAM for the board types supported by the installed plug ins For example amergi C oamcfg returns a list of supported board types in alphabetical order Each listed product type is a valid string that you can use to identify the products in the system configuration file Adding and deleting boards This topic describes how to perform the following tasks with oamcfg e Create a record in the database e Automatically detect and add boards e Delete a board Creating a record in the database To create a record in the NMS OAM database for the object enter oamcfg c product 1 PCIbus slot n brdname b brdno host The following table explains each option Option Use this opt
11. hssrv hsbios PCI BIOS Interface Loaded hssrv hsrmgr Resource Manager Interface Loaded hssrv hshw CompactPCI Hardware Interface Loaded Nesev PC Bi0s found 3 bustes hssrv IRQ routing table 9 record s hssrv Check for reserved resource manager keys hssrv 14 reserved key s hssrv Get current system configuration hssrv PCI IDE Mark IRQ14 Primary channel is in compatibility mode hssrv PCI IDE Mark ITROI5 Secondary channel is in compatibility mode hssrv 8 PCI device s were found hasiye IRS 7 6 8 A Sy IM abil Byala aba hssrv 16 93 MB allocated by devices hssrv Search for PCI2PCI bridges hssrv PCI2PCI bridge at 0 8 0 gt 1 hssrv Memory window 40100000 401FFFFF 1 MB hssrv PCI2PCI bridge at 0 12 0 gt 2 hssrv Memory window 40200000 402FFFFF 1 MB hssrv Shared resources 00000001 0000000D hssrv 24 Software driver s configured NMS Communications 77 Other utilities NMS OAM System User s Manual System configuration file creator oamgen Name oamgen Purpose Scans a chassis for boards and creates a system configuration file describing the board setup Note The system configuration file created by oamgen may not be appropriate for your configuration You may need to make further modifications to the file before running oamsys to configure your boards based on the file Usage oamgen This utility has no command line options
12. keyword 1 val2 keyword 2 vali keyword 3 val4 keyword vali val2 val 1 val4 keyword 0 vali keyword 1 val2 keyword 2 val 1 keyword 3 val4 kywd1 1 3 kywd2 1 2 list vall val2 kywd1 1 kywd2 1 list 0 val1 kywd1 1 kywd2 1 list 1 val2 kywd1 1 kywd2 2 list 0 val1 kywd1 1 kywd2 2 list 1 val2 kywd1 2 kywd2 1 list 0 val1 kywd1 2 kywd2 1 list 1 val2 kywd1 2 kywd2 2 list 0 val1 kywd1 2 kywd2 2 list 1 val2 kywd1 3 kywd2 1 list 0 val1 kywd1 3 kywd2 1 list 1 val2 kywd1 3 kywd2 2 list 0 val1 kywd1 3 kywd2 2 list 1 val2 Note For users of the NMS OAM service API oamcfg performs keyword expansion not NMS OAM When specifying keywords and values using the NMS OAM service do not use this keyword expansion syntax 52 NMS Communications NMS OAM System User s Manual Creating NMS OAM configuration files Starting boards automatically Using keywords you can configure each board to start automatically whenever the Natural Access Server ctdaemon starts or when the board is Hot Swap inserted You can also configure the boards to stop automatically whenever ctdaemon exits Note When a board is Hot Swap extracted it is stopped automatically regardless of the keyword settings The board is stopped when its ejector handles are lifted To configure boards to start or stop automatically Step 1 Action For each board that you want to start or
13. reconfigure as few boards as necessary to maintain system integrity Sample timing reference priorities file The following is a sample listing of a timing reference priorities file A list of timing references that are prioritized Priority Board Trunk 0 0 1 0 0 2 0 3 il 1 1 1 99 0 0 OSC 99 1 0 OSC 99 2 0 OSC 99 3 0 OSC end of list NMS Communications 103 System level clocking with clockdemo NMS OAM System User s Manual The text in this file denotes the following e Board O trunks 1 and 2 and board 3 trunk 1 are all equally reliable and are the most reliable trunks available e Board 1 trunk 1 is also available as a timing reference but is not as reliable as the trunks listed above it e Boards 0 1 2 and 3 also have internal oscillators that can be used as timing references but only as a last resort Assuming all trunks are non operational to begin with clockdemo makes the following initial assignments based on this file e Board 0 is primary master driving A_CLOCK using its internal oscillator as a timing reference e Board 1 is secondary master driving B_CLOCK based on A_CLOCK e Boards 2 and 3 are slaves to A_CLOCK clockdemo displays the configuration as follows CLOCKDEMO Version 2 0 Mar 15 2001 15 00 36 Boards Clock Mode Current Mastering Fallback Clock Source A Reck BB elock Occurred 0 PRIMARY INTERNAL YES NO 3 SLAVE H100_A NO il SECONDARY H100_A YES NO 2 SLAVE H100_A
14. Hot Swap 23 36 37 70 73 76 125 Hot Swap driver 31 76 Hot Swap manager 31 70 HSK Wizard 25 hsmgr 70 hsmon 73 hssrv 76 K keyword files 43 keywords 50 L log files 37 M MAC addresses 15 59 64 65 managed components 13 46 management host 17 20 migration 121 123 125 125 126 multiple host configurations 17 21 44 127 Index N Natural Access 34 NETREF 90 98 119 NETREF2 90 94 98 119 NETWORK timing reference 90 94 98 NMS OAM database 13 64 NMS OAM service 12 NMS OAM setup 20 NMS OAM Supervisor 9 nmspcinfo cfg 28 0 oam rpt 37 oamcfg 59 identifying boards 61 launching 59 task sequence 68 oamgen 78 oaminfo 12 oammon 36 56 oamsys 20 55 OSC timing reference 90 94 98 P PCI bus 28 128 NMS OAM System User s Manual pciscan 28 80 primary clock master 89 100 114 primary timing reference 114 product types 62 R resource host 17 21 34 44 62 83 S secondary clock master 89 94 100 115 serial number 15 SNMP 121 standalone boards 116 startup log 37 struct keywords 50 supervisor 10 system configuration files 45 96 T timing references 90 94 98 tracing 35 126 trunkmon 83 U utilities 55 56 59 70 73 76 80 83 87 124 NMS Communications
15. MAC addresses If this option and the b g l and n options are omitted any specified operation is performed for all boards Specify the target board or component by name name can be the name of a board or another component such as an EMC or the Supervisor If this option and the b g l and m options are omitted the specified operation is performed for all boards Stop the specified boards The board stops immediately interrupting any ongoing process To avoid problems make sure a board is not performing any operations before stopping it Query the NMS OAM database for the board ID information for the specified boards NMS Communications NMS OAM System User s Manual Using oamcfg Option Use this option to r Cause oamcfg to reset all keywords to their default values except board ID information for the specified components oamcfg then makes the specified changes Use when configuration data in the NMS OAM database is being changed that is the f or k option is used or board ID information is changed If the r option is omitted oamcfg adds or replaces keyword values specified in the board keyword file without disturbing any other settings S Start the specified boards t testopts Test the specified boards if supported by the board plug in testopts is a numeric value indicating how to perform the test X Search the chassis for boards and adds information about each board it finds into subkeywords
16. NO Press q then ENIER to Exit Board 0 is primary master driving A_CLOCK using its internal oscillator Board 1 is secondary master Its fallback timing reference is OSC All other boards are clock slaves If board 1 trunk 1 becomes operational the clock configuration changes as follows Boards Clock Mode Current Mastering Fallback Clock Source A Glock Clock Occurred 0 SECONDARY H100_A YES NO 38 SLAVE H100_A NO lg PRIMARY NETWORK 1 YES NO 2 SLAVE H100_A NO Press q then ENTER to Exit Board 1 has become primary master driving A_CLOCK using trunk 1 as its primary timing reference Its secondary timing reference is OSC Board 0 has been demoted to secondary master Its secondary timing reference is OSC If board 3 trunk 1 then becomes operational board 3 becomes primary master since it has a higher priority rating in the timing reference priorities file Its fallback timing reference is OSC Board 1 is demoted to secondary master Its fallback timing reference is trunk 1 Board 0 is demoted to slave Boards Clock Mode Current Mastering Fallback Clock Source A Clock B Glock Occurred 0 SLAVE H100_A NO 33 PRIMARY NETWORK 1 YES NO ily SECONDARY H100_A YES NO g SLAVE H100_A NO Press q then ENIER to Exit 104 NMS Communications NMS OAM System User s Manual Now board 0 trunk 2 becomes operational Simultaneously board O trunk 1 System level clocking with clockdemo momentarily becomes
17. Setting up an NMS OAM host Configuring Hot Swap Hot Swap functionality is an integral part of NMS OAM It is designed for use with CompactPCI Hot Swap compliant boards It is supported on Windows and UNIX systems This topic provides the following information e Hot Swap compatible boards e Hot Swap EMC e Hot Swap platform requirements e Configuring Hot Swap under Windows e Configuring Hot Swap under Solaris e Configuring Hot Swap under Linux Hot Swap compatible boards A Hot Swap compatible board includes a switch built into the ejector handle and a front panel Hot Swap LED When you insert a board into the system the switch signals that the board is fully seated with the handle closed and that the software connection can be initiated When you remove a board the switch signals that the board is being extracted and that the software disconnection can be initiated When lit the Hot Swap LED indicates that the software disconnection is complete and extraction is permitted You can open the handle the rest of the way and eject the board The PCI interface for NMS Hot Swap compatible CompactPCI boards includes the Hot Swap control and status register HS_CSR The PCI interface is responsible for management of the ejector handle switches and the Hot Swap LED NMS Communications 23 Setting up an NMS OAM host NMS OAM System User s Manual The following illustration shows the ejector handles and Hot Swap LED on an AG 4
18. States and or other countries All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International Inc in the United States and or other countries Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems Inc Linux is a registered trademark of Linus Torvalds Red Hat is a registered trademark of Red Hat Inc All other marks referenced herein are trademarks or service marks of the respective owner s of such marks All other products used as components within this product are the trademarks service marks registered trademarks or registered service marks of their respective owners Every effort has been made to ensure the accuracy of this manual However due to the ongoing improvements and revisions to our products NMS Communications cannot guarantee the accuracy of the printed material after the date of publication or accept responsibility for errors or omissions Revised manuals and update sheets may be published when deemed necessary by NMS Communications P N 9000 6819 23 Revision history Revision Release date Notes 1 0 February 2000 _ CYF for Natural Access 2000 1 Beta 1 1 June 2000 CYF for PSF 4 0 1 2 September 2000 CYF for Natural Access 2000 1 1 3 February 2001 _ CYF for 2000 2 maintenance release 1 4 April 2001 CYF for 2001 1 1 5 June 2001 CYF 1 6 August 2001 CYF for NACD 2001 1 1 7 November 2001 CYF for NACD 2002 1 Beta
19. Summary Of CHANGES sedere nsoni vee aaa ARAA DEANA E E aE a E AOE Ee ANOA ATA AAEE GAA 121 NMS OAM and agmon differences sssssssssrrrrsssrrrrrsrrrrrrrunsrrrrnnnnrnrrnnnsrnrrnnns 122 NMS OAM service UtiItiGS atic hid haere idence aiden tana diee ANEAN AAK ENA 122 Migrating configuration files cece cece ee eee eee eee eee teeta eee e tenn e ened 123 AGZOANN ev seve abby dais desdeh viduiay ateetduntrdatehe A ouuie E ete riedah a uedua tise atestes 124 Board identification Changes ccece cece cent eee eee eee eee eee teen ENEA 125 Hot Swap CHANGES taiiceiroutierewes tnbds cha ads aae aaa ideale O EA EANA AAAA E NA aa 125 Tracing chanje Sir carna e EA EEEE EA A E EEEE DESEES EENT EE 126 NMS Communications 5 1 Introduction The NMS OAM System User s Manual describes how to set up a chassis containing NMS boards and how to use NMS OAM software to configure start and monitor the boards This document is written for developers and system administrators NMS Communications 2 Overview of NMS OAM NMS OAM components NMS Communications operations administration and maintenance OAM software is the component of the Natural Access development environment that enables you to administer and maintain NMS resources in a system NMS OAM can manage hardware components such as NMS boards or software components such as the NMS Hot Swap and H 100 H 110 clock management processes This topic presents e N
20. a host has a unique board number e A unique PCI bus and slot in which the board is located The following secondary ID information is also available e A driver name and driver board ID combination The driver name is unique among all driver names on the host The driver board ID is unique among all boards accessed by a given driver However two boards accessed by different drivers can have the same driver board ID The driver name and driver board ID together make up an ID for the board that is unique within the host e A serial number if supported This number is assigned at the factory and is not present for all boards e CompactPCI CG and CX boards only A unique shelf and slot in which the board is located The shelf refers to the backplane or portion of the backplane in which the board is installed Slot refers to the physical slot within the chassis where the board is located Note Implementation of shelf and slot differs depending upon the chassis manufacturer and specific hardware settings Shelf and slot information is available only with boards installed in CompactPCI chassis with a bus that complies with PICMG 2 1 Refer to the chassis documentation for more information e Boards with Ethernet capability only Unique MAC addresses one for each Ethernet controller on each board NMS Communications 15 Overview of NMS OAM NMS OAM System User s Manual The following illustration shows board identification options Board
21. and extracting boards as directed by the wizard After you have inserted and extracted a board from every slot the Review dialog box displays the settings for each physical slot Click Finish A dialog box displays a prompt to save your changes to the registry If you are satisfied with your changes click Yes Otherwise click No and run the wizard again NMS Communications NMS OAM System User s Manual Setting up an NMS OAM host Windows Hot Swap Kit utilities You can make modifications to the Hot Swap configuration and monitor Hot Swap activity using the following utilities installed with the Hot Swap Kit Utility Description Hot Swap Kit e Changes the default mapping between physical PCI slot numbers and Configuration logical slot numbers e Changes the default resource assignments for slots e Modifies the PCI configuration space polling rate e Modifies the software disconnection timeout e Specifies alternate HS_CSR drivers Slot Information Retrieves current information about boards installed in a CompactPCI system To access a utility select Start gt Programs gt Hot Swap Kit and select the utility in the menu For more information about a specific utility start the utility and press F1 Configuring Hot Swap under Solaris To allow hot swapping of boards in a CompactPCI Solaris system adequate address space must be preconfigured To maximize the number of slots available for hot swapping e Have all sl
22. board that complies with the MVIP 95 standard clockdemo can also operate without a clocking priorities file and instead configure and manage clocking on boards specified on the command line with the b option In this case clockdemo attempts to determine the current configuration and to maintain clock synchronization as best as it can However this mode does not provide as robust a clocking scheme as when the clocking priorities file is used In some cases clockdemo can assign OSC as a fallback source Use this clockdemo mode only if board clocking has previously been configured using a swish script or other method If the clocking priorities file is used set all boards to standalone mode before running clockdemo To do so use the NMS OAM utilities or the NMS OAM service to set the Clocking HBus ClockMode keyword to STANDALONE for each board Note When using clockdemo do not use any other Clocking HBus XXX keywords to specify clocking configurations for the boards Board level clocking configuration interferes with clockdemo s operation and can cause glitches in the system clock signal clockdemo does not provide support for NETREF 1 or NETREF2 102 NMS Communications NMS OAM System User s Manual System level clocking with clockdemo Creating a timing reference priorities file The timing reference priorities file is specified with the f option on the command line It lists boards and trunks on the boards and rates their rel
23. board with the most reliable available trunks as primary master and configures the most reliable trunks on this board as the primary and fallback timing references for the system clockdemo also attempts to configure a different board as secondary master All other boards become clock slaves clockdemo then polls all boards at regular intervals and monitors all trunks currently serving as timing references If clockdemo detects that a system clock has failed or that fallback has occurred or that a critical trunk is having problems it reassigns timing references or configures new primary and secondary masters to maintain or restore the integrity of the system clock In each case clockdemo picks the most reliable available boards and trunks clockdemo also monitors NMS OAM events to detect Hot Swap insertion or removal of boards If the primary or secondary master is removed clockdemo assigns a new primary or secondary master as necessary clockdemo logs clocking configurations and changes to the screen The following is sample clockdemo output CUOCKDEMOM Vicresn One Os Mancemleom 2 00 lumleor O03 6 Boards Clock Mode Current Mastering Fallback Clock Source A Clock B Clock Occurred 0 SLAVE H100_A NO 3 PRIMARY NETWORK 1 YES NO ils SECONDARY H100_A YES NO 2 SLAVE H100_A NO Press gq then BENIER to Exit clockdemo uses Switching SWI service commands to configure clocking on each board It can configure and manage clocking on any
24. eee eee nena eee eee e eee anes 33 Starting the Natural Access SCrvel cceceeee cece eee eee eee nena eee teen e neta ene e ate taee 34 Starting the Natural Access Server Under WiINdOWS ccecceceeeee teen teen eneeeaeenas 34 Starting the Natural Access Server under UNIX cccccecceeseeseeeeeeeeeeeeeeneeeaeeeas 35 Starting the Natural Access Server in the in process mode eceeeee eee eees 35 Verifying HOt SWAD rirci erenn o sens E see cues eovdees debe eevk ber euves tebeatae eoeeenes 36 Logging Startup Events iis ciciviteetin cect vesviteerin EARNAN AANA AEE AOA T KE 37 Configuring PCI bus address space for Hot Swap Solaris ssssssssssressssrrressrres 37 PCI bus segments and space WINdOWS cceeee eee etre eee eee ee ee teeta neat etna eee 38 Using leftover allocated Space ecceeceee eee e eee e eens eee nena sean eae teen eena ena 39 Chapter 5 Creating NMS OAM configuration fileS sc cseeseseeseeeeeeeeeeeeeeeneae 43 Configuration file OVEMVIGW vic cecicciene cea vie semieeess EEA AANE NAARAAN eerie 43 System configuration files in multiple host configurationS cceeeee eee eee eens 44 Creating a system configuration file cccece eee e eee eee eee eee eee ee eae tates 45 Configuration file SECtIONS rispiri natin tcimecmierstinieias tere evan teres xe dene eee eran 45 Mandatory StatOMentS cccccccce eee enn EEE EEE Enna 46 Board Keyword SECtiONS si siciceseeicte aces saeatenad
25. generated in some cases when tracing is enabled To avoid overloading the system shut down oammon before setting the tracing flags with agtrace In this case you can get the tracing information from agpierr log as previously described Previously Natural Access dispatcher traces were displayed by ctdaemon ctdaemon was also used to set the debug mask With NMS OAM dispatcher traces are displayed by oammon or retrieved through the Natural Access queue The debug mask is set using the board keyword DebugMask For more information refer to the board documentation 126 NMS Communications A A_CLOCK 89 90 94 98 AGLOAD 123 agmon 122 array keywords 50 B B_CLOCK 89 90 94 98 blocate 87 board keyword files 48 50 113 boards 48 adding 62 clock fallback 89 116 configuring 55 deleting 63 detecting 63 ID information 15 65 125 identification 15 keyword files 43 48 113 monitoring 56 name 45 65 number 45 65 plug ins 10 product type 62 search functions 28 serial number 15 starting 53 66 stopping 66 testing 66 BRI trunks 83 C clock fallback 89 94 116 clock management 89 clock management EMC 29 configuring 99 NMS Communications Index limitations 113 clock slaves 89 100 116 clockdemo 53 99 101 106 configuration files 43 board keyword files 48 50 importing and exporting 67 system configuration files 45 96 ctdaemon 20 34 E EMC 10 event logs 37 F fallback timing reference 103 H H 100 H 110 bus 29
26. information refer to Reading and changing database information on page 64 You can change the board name or number Refer to Changing board ID information on page 65 Automatically detecting and adding boards oamcfg can automatically detect boards in a resource host chassis You can then use oamcfg to add records for detected boards to the NMS OAM database on that host To detect boards in a chassis use the x option To detect boards in a resource host also include the option indicating the host oamcfg x MyHostl oamcfg detects boards in the chassis and creates entries in the DetectedBoards x array keyword for each board These keywords are displayed on the screen as follows DetectedBoards DetectedBoards DetectedBoards DetectedBoards 0 Name AG 2000_0_16 Olea occu eA Cm 1000 0 Location PCI Bus 0 0 Location PCi giot 16 DetectedBoards 1 Name AG_2000_BRI_0_17 DetectedBoards 1 Product AG_2000_BR DetectedBoards 1 Location PCI Bus 0 DetectedBoards 1 Location PCI Slot 17 DetectedBoards 2 DetectedBoards 2 DetectedBoards 2 DetectedBoards 2 Name AG_4000_E1_0_15 Product AG 4000_E1 Location PCI BUS 0 Location eCi Slot 15 Note If you have a chassis with an unusual PCI bus topology for example bus number 171 directly follows bus number 0 oamcfg searches functions more slowly To speed up operation create a text file specifying bus numbers to search Ref
27. is called clock fallback This feature can be enabled or disabled Note Not all boards support clock fallback For more information about board models refer to the board documentation Secondary clock masters You can set up a second device to be used as a backup or secondary clock master if the primary clock master stops driving its CT bus clock because both of its timing references failed or it was hot swapped out or for some other reason For the secondary clock master to work 1 It must receive its primary timing reference from the CT bus clock driven by the primary clock master either A_CLOCK or B_CLOCK 2 It must drive the CT bus clock not driven by the primary master For example if the primary clock master is driving A_CLOCK the secondary clock master must drive B_CLOCK In this case both clocks are synchronized 3 It must have a fallback timing reference This timing reference must not be the primary clock master s primary or fallback timing reference 4 All other slave boards must be set up so their fallback timing references are the CT bus clock driven by the secondary clock master 94 NMS Communications NMS OAM System User s Manual H 100 and H 110 bus clocking The following illustration shows a sample secondary clock master configuration Timing reference channels H 110 bus JA CT bus clocks A_CLOCK B_CLOCK NETREF1 soveeeeeeenenfeessasoe fessssocececeeceneeehessasnnenee
28. models support NETREF or NETREF2 For more information about board models refer to the board documentation NMS Communications 93 H 100 and H 110 bus clocking NMS OAM System User s Manual Fallback timing references Boards can optionally be assigned a backup fallback timing reference that it can use if its primary timing reference fails For a clock master the source for the fallback timing reference should NOT be the source currently used by the clock master for its primary timing reference For example if a clock master s primary timing reference source is a NETWORK signal from one of its trunks the fallback timing reference source can be a NETWORK signal from another one of its trunks or a signal from NETREF1 NETREF2 if H 110 or OSC In the following illustration the fallback timing reference source is NETREF1 The following illustration shows a system using a fallback timing reference Timing CT bus clocks reference channels H 110 bus Primary clock master r Clock slave Ordinarily drives i Driving timing A_CLOCK based on reference signal Clock timing reference from ion NETREF1 based slave digital trunk now ion external timing using NETREF1 i reference ee Timing reference Non functional digital digital trunk trunk ordinarily used as primary timing reference The ability of a board to automatically switch to its fallback timing reference if its primary timing reference fails
29. modify them For more information about the sample files supplied for the hardware refer to the board documentation System configuration files in multiple host configurations If you have a multiple host NMS OAM configuration create a separate system configuration file for each resource host containing configuration information for that host only Store all system configuration files and board keyword files on the host system To configure and start up resource hosts run oamsys multiple times each time specifying a different resource host and system configuration file The system configuration files can share keyword files if necessary The following illustration shows using oamsys in a multiple host configuration Management host Board keyword System file configuration kwdA cfa N file serverA cfg serverB cfg Board keyword file kwdB cfg D Resource host A Resource host B NMS OAM Supervisor NMS OAM database NMS OAM Supervisor NMS OAM database If the resource hosts have identical configurations you can use the same system configuration file for each resource host However having boards with the same board name on more than one resource host can lead to confusion 44 NMS Communications NMS OAM System User s Manual Creating NMS OAM configuration files Creating a system configuration file A system configuration file is an ASCII text file Typically this file is named oamsys cfg By
30. of the NETREF signal Set to 8K Note Not all boards can drive NETREF or NETREF2 Refer to the board documentation for more information NMS Communications 119 1 2 Migrating to NMS OAM Summary of changes This section provides information on migrating from agmon to NMS OAM The following list summarizes the changes introduced with NMS OAM The AG board configuration and monitoring utility agmon is deprecated NMS OAM performs board management operations across AG QX CX and CG boards Utilities included with NMS OAM duplicate and enhance operations formerly performed by agmon The AGM library is deprecated NMS OAM has an API for initializing and monitoring boards and for performing many other tasks The AG configuration file has been replaced by files with very different structure and syntax Keywords used in these files are different from AG configuration file keywords The ag2oam utility included with NMS OAM translates AG configuration files into the new syntax Previously the only method of identifying a board in software was the board number A new identifier the name can be used to identify each board as well as certain software modules and other components The HSI service is deprecated Hot Swap functionality is implemented as an extended component of NMS OAM The Hot Swap manager has not changed The QX board configuration and monitoring utility qxload is deprecated NMS OAM performs board managem
31. other slave boards fall back to B_CLOCK and board B serves as the clock master The primary master also falls back to B_CLOCK and is now a slave to the secondary master The system continues in this configuration until an application intervenes This configuration assigns the following clocking priorities Timing Clocking configuration priority First Board A primary master drives A_CLOCK using its primary timing reference board D digital trunk 4 using NETREF Slaves synchronize to A_CLOCK Second Board A primary master drives A_CLOCK using its fallback timing reference board A digital trunk 2 Slaves synchronize to A_CLOCK Third Board B secondary master drives B_CLOCK using its fallback timing reference board B digital trunk 3 Slaves synchronize to B_CLOCK The following illustration shows the sample board clocking configuration Driving clock Clock source Fallback clock source Network board Network board Drives A_CLOCK Uses NETREF as timing reference Falls back to network signal Drives B_CLOCK Does not drive a Uses A_CLOCK as clock Uses timing reference ACLOCK as Falls back to network signal timing reference Falls back to B_CLOCK Network trunk connection Network trunk connection NMS Communications H 110 Bus A_CLOCK A_CLOCK B_CLOCK B_CLOCK NETREF NETREF NETREF2 n NETREF2 y vy vv Board A Board B Board C Board D Pr
32. reliability control clocking at the system level using an application such as clockdemo For more information refer to Running clockdemo on page 101 For a detailed overview of H 100 and H 110 bus clocking refer to CT bus clocking overview on page 89 For more information about retrieving and setting NMS OAM keyword values refer to the NMS OAM Service Developer s Reference Manual Configuring clocking with board keywords has the following limitations e Unlike the clockdemo application which allows you to specify several boards to take over mastery of the clock from one another in a fallback situation the board keyword method allows you to specify only a fixed primary and secondary master e The board keyword method does not create an autonomous clock timing environment If you implement clock fallback using this method an application must still intervene when clock fallback occurs to reset system clocking before other clocking changes occur If both the primary and secondary clock masters stop driving the clocks and an application does not intervene the boards default to standalone mode Note Not all boards can act as primary or secondary master For information about board models refer to the board documentation Refer to the System configuration file example on page 96 for an example of using board keywords to set up clock fallback in a multiple board system NMS Communications 113 Configuring CT bus clocking with board key
33. run pciscan with the PCI bus and PCI slot locations For example peiscan 0 14 An LED on the board flashes If the i option is specified extra information is reported for CG boards only This information includes e Number of DSPs on the board e Number of HMIC switches on the board e Number of lines digital or analog on the board e Number of Ethernet chips on the board e Whether or not the board has a daughterboard e Number of CPUs on the board This information is reported as follows Bus Slot NMS ID DSP Switch Line Eth xCard CPU 2 wO G00 SA i 4 2 No 1 CG_6000C_Quad 2 il OxGO0O 32 il 4 2 No 1 CG_6000C_Quad 2 S 0x50d N A N A N A N A N A N A AG 4040C TI There were 3 NMS PCI board s detected NMS Communications 81 Other utilities NMS OAM System User s Manual If the i option is specified and a specific PCI bus and slot are specified detailed information is reported for the board at the specified location as follows 82 NMS Communications NMS OAM System User s Manual Other utilities Digital trunk status trunkmon Name trunkmon Purpose Displays the status of digital trunks Usage trunkmon options where options are Option Description b board Specifies the board to monitor Default 0 S Enables beep when trunk alarm state changes Default no beep Displays the trunkmon Help screen and terminates mode Sets the framer loopback mode Available mode entries include 0 No loop
34. slave Clock slave The channel over which the timing reference signal is carried to the clock master is called NETREF The following illustration shows a system using a timing reference from NETREF CT bus clocks CT bus J Timing reference channel Primary clock H Clock slave master i Driving timing ioi i Clock Driving A_CLOCK i reference signal on based on timing NETREF based on reference signal external timing from NETREF i reference slave N Timing reference digital trunk 92 NMS Communications NMS OAM System User s Manual H 100 and H 110 bus clocking On the H 110 bus a second timing reference signal can be carried on a fourth channel called NETREF2 NETREF is referred to as NETREF1 in this case The following illustration shows a system using a timing reference from NETREF2 Timing reference CT bus clocks channels H 110 bus TENERE PAN Onn rrr re rrerepcreereeeeenemetneefeeeN ETRE F 1 eens Hn ve lt se neve nner A qo NETREF2 Clock slave Driving timing ireference signal on NETREF2 based on external timing reference Primary clock j Clock slave master Driving timing Driving A_CLOCK ireference signal based on timing on NETREF1 reference signal based on from NETREF1 external timing reference N Timing reference digital trunk Timing reference digital trunk Note Not all board
35. such as trunks clockresource h Defines for clockresource c priority txt Sample clocking priority list file clockdemo performs three main tasks e Monitors for clocking changes for example trunk signal failures e Determines what to do when there is a change e Reconfigures clocking on the boards When a change to a timing reference or board requires changes to the clocking configuration clockdemo determines the minimum number of steps to take to rectify the situation to avoid reconfiguring boards unnecessarily The code for each of clockdemo s tasks is encapsulated in the main section of the program The loop is triggered at regular intervals regulated by the timeout set using the t option on the command line It is also triggered whenever an NMS OAM board started or board stopped event is received The main section contains the following functions Function Description _clock_monitor Polls all boards and returns the board status results in an array _clock_control Determines an action to take if necessary for each board based upon the status results _clock_reconfigure Reconfigures affected boards based upon the determined action 106 NMS Communications NMS OAM System User s Manual System level clocking with clockdemo The following illustration shows clockdemo main functions clockdemo Loop triggered by timeout specified with t option on command line or by STARTBOARD or STOPBOARD event
36. system adequate address space must be preconfigured To maximize the number of slots available for hot swapping e Have all slots populated at boot time or e Have no slots populated at boot time This topic describes how to allocate space for hot swapping Note Windows system address space is configured automatically during installation of the Hot Swap Kit On a Linux system the Hot Swap driver allocates and de allocates memory for inserted or removed boards NMS Communications 37 Starting NMS OAM NMS OAM System User s Manual PCI bus segments and space windows The PCI architecture allows a system to include a tree of PCI buses Most CompactPCI systems have at least two PCI bus segments one on the processor board and one or more dedicated to CompactPCI slots There is at least one bus segment per 8 CompactPCI slots PCI to PCI bridges connect these buses The following illustration shows PCI bus slots and segments Slots Slots PCI bus segment A PCI bus segment B Each device requires a certain amount of address space on the bridges At boot time the system BIOS configures address space windows on each bridge to define the range of addresses that is the bus number or memory address that are allocated behind that bridge The following illustration shows segments and allocated address space on bridge Slot
37. the information from keyword file cfgfile to the database records for the specified components This option can appear more than once on a command line to load multiple files Statements in the board keyword file override information already in the record Note oamcfg is designed to parse keyword files not system configuration files such as those that oamsys takes as input Specify the shelf and slot of the board for which to perform the specified operation If this option and the b l m and n options are omitted the specified operation is performed for all boards Display oamcfg Help screen and terminate Cause oamcfg to return immediately when used with the p s and t options By default oamcfg does not return until it receives indications that its operations have completed successfully or not Import the contents of an NMS OAM database from filename All current records are destroyed and replaced with those from the file Set keyword to value in the database record for the specified component This option can appear more than once on a command line to set multiple keywords Specify the target board by PCI bus and slot If this option and the b g m and n options are omitted any specified operation is performed for all boards Use this option to change the PCI bus and slot location specified in the database for a board Refer to Changing board ID information on page 65 Specify the target board by one of its
38. the total number of slots contained in the chassis including slots occupied by system components Click Next The Please insert board dialog box appears Insert a board into the specified slot and close the ejector handles If you cannot insert the board because the specified slot is a system slot select I can t insert board because this is a system slot If your CompactPCI bus is divided into multiple segments the slot numbers indicated on the chassis may not match the slot numbers indicated in the wizard In this case you must determine which slots belong to the segment When prompted for physical slot 1 use the left most peripheral slot in the segment When prompted for physical slot 2 use the slot to the right of this slot and so on Click Next If you selected I can t insert board because this is a system slot the Please insert board dialog box appears prompting you to insert a board in another slot Repeat step 3 for the new slot Otherwise the wizard searches the CompactPCI bus and associates the specified slot number with the slot currently containing the board The Please extract board dialog box appears Open the board s ejector handles After a moment the Hot Swap LED on the board lights When the Hot Swap LED lights extract the board If you remove the board before the LED lights you can damage the chassis or the board Click Next Repeat steps 3 through 7 for each slot in the system Continue inserting
39. to be Cfg To specify a space within a file name surround it with quotation marks Cancers o My pillar 64 NMS Communications NMS OAM System User s Manual Using oamcfg Specifying settings on the command line To set a specific keyword you can specify it directly on the command line using the k keyword value option keyword is a valid keyword name for the component and value is a valid value for the keyword The keyword and value must be separated by an equal sign For example oamcfg b 1 k DebugLevel 3 If you need to embed a space in a keyword and value designation place the whole designation in quotation marks For example oamcfg b 1 k DebugLevel 3 The k option can appear more than once on a command line to set multiple values If no board is specified oamcfg sets the keyword for all boards in the NMS OAM database For more information about keywords and values refer to Using board keyword files on page 48 Changing board ID information You can change the number or PCI bus and slot information for a board To do so specify a board on the command line using a board identification option b g l m or n This board must be currently listed in the database Specify the new number PCI bus and slot or both using other b or I options on the same command line oamcfg checks the database for each option If it determines that only one option specifies current information for an
40. when NMS OAM starts boards the information in the database for each board not the configuration files determines how the board is configured NMS OAM provides functionality not available with agmon such as board testing for board models that support this operation and alert notification It is also extensible with extended management components EMCs and board plug ins For example Hot Swap is now implemented as an EMC NMS OAM supports new board families such as CG NMS OAM and agmon cannot be used simultaneously NMS OAM service utilities The fol Utility 122 lowing utilities are supplied with NMS OAM Description oamsys Replaces agmon s configuration and booting capabilities Configures the NMS OAM database based on information supplied in configuration files and then starts all boards oamcfg Provides access to individual NMS OAM configuration functions Reads configuration files to configure individual boards oammon Replaces agmon s monitoring capabilities Monitors boards for board errors and events oaminfo Enables you to display and set NMS OAM keywords Searches for text in keywords For more information about oaminfo refer to the NMS OAM Service Developer s Reference Manual NMS Communications NMS OAM System User s Manual Migrating to NMS OAM Migrating configuration files With agmon all information for all boards was specified in a single AG configuration file With NMS OAM uti
41. 040C board Telephony I O a Ejector handle switch H 110 connector Ejector handle switch Hot Swap Hot Swap LED control status register HS_CSR Hot Swap EMC Hot Swap is implemented as an extended management component EMC The Hot Swap EMC e Automatically stops a CompactPCI board prior to its physical removal from the chassis e Automatically starts a board when it is physically installed in the chassis if supported Board automatic starting is controlled by configuration keywords Refer to Starting boards automatically on page 53 for more information e Makes alerts and other messages related to Hot Swap available to client applications The Hot Swap EMC communicates with the Hot Swap manager and driver to perform Hot Swap operations The Hot Swap manager and driver must be started in order for Hot Swap operations to work To learn how to start these components refer to Starting Hot Swap on page 31 Note Hot Swap is supported only by CompactPCI boards but some CompactPCI boards do not support Hot Swap Removing a board that does not support Hot Swap functionality while the system is running can cause serious damage to the board and to the system To determine if a board model supports Hot Swap refer to the documentation for the board 24 NMS Communications NMS OAM System User s Manual Setting up an NMS OAM host Hot Swap platform requirements Hot Swap development requires an Intel or SPARC
42. 1 8 May 2002 MVH for NACD 2002 1 1 9 April 2003 SRR for NACD 2003 1 2 0 November 2003 MVH for Natural Access 2004 1 Beta 2 1 May 2005 MCM for Natural Access 2004 1 2 2 October 2005 MVH for Natural Access 2005 1 SP 1 2 3 June 2008 SRG for Natural Access R8 Last modified June 23 2008 Refer to the NMS web site www nmscommunications com for product updates and for information about support policies warranty information and service offerings 2 NMS Communications Table Of Contents Chapter 1 INtrOductiOn cccccecsecseeseeeseeeeeeeeeeeeeeeeeeeeeeeaeeeseaseaseaseasenseuseneeesenaes 7 Chapter 2 Overview of NMS OAM cccccecceeeeeeeeeeeeceeseenneeeeeeeeasenseasesseenessennenees 9 NMS OAM Components ir esine uve Gonbvee dataccadtie aire dodtonseega nena a a heen 9 NMS OAM architeCture ccce cece eee re renner enna ed 9 Performing OAM taskS sc csrcetteus cxrnntesserieenauesivaresihs ceeeuiersaeenerer rans 10 NMS OAM database perice aa shies E O nia E RAA 13 Board identification methodS s sssssssssrssssrrnrrsssrrnrnnrsrrnrnnnurrrrnnnururrnnnneurnnnnnns 15 Multiple host NMS OAM wsssisaceccese cereives veeteves seve ests ARAN deve Ea 17 Overview of setting up NMS OAM ccceeee eee ee eee eee eee eee e eae e eee teeta 20 Single host COnfIQUratiONS ce cece eee eee need ee eee ena ea eta etaes 20 Multiple host Configuration tiaicsiiecceuiieie eisini nN NAERON cers 21 Chapter 3 Setting up a
43. CI board models The board plug ins do not support TX boards When the Supervisor starts up it loads all plug ins that it finds The Supervisor looks for these modules in the nms bin directory opt nms lib under UNIX Plug in files have the extension bpi Extended management components EMCs EMCs are software modules that add functionality to NMS OAM NMS OAM provides the following EMCs e The Hot Swap EMC allows you to insert and extract Hot Swap compatible CompactPCI boards without powering down the system Hot Swap improves system availability by reducing down time due to routine configuration changes and board replacements e The Clock Management EMC manages H 100 and H 110 bus clock configurations When the Supervisor starts up it loads all EMCs that it finds The Supervisor looks for these modules in the nms bin directory opt nms lib under UNIX EMC files have the extension emc Performing OAM tasks You can perform the following tasks using NMS OAM e Create delete and query component configurations e Start stop and test components e Receive notifications from components Use the following NMS OAM components to perform OAM tasks e The oamsys oamcfg oammon and oaminfo utilities e The NMS OAM service In a multiple host NMS OAM configuration these utilities reside on the management host and communicate with the resource hosts over the IP network 10 NMS Communications NMS OAM System User s Manual Ov
44. CompactPCI compliant platform that conforms to the following specifications e PICMG 2 0 Revision 2 1 CompactPCI e PICMG 2 1 Revision 1 0 CompactPCI Hot Swap Hot Swap platform e PCI BIOS Revision 2 1 PCI BIOS services are used to manage interrupt assignments for hot inserted boards e PICMG 2 5 Revision 1 0 CompactPCI Computer Telephony If the H 110 bus is not present the CompactPCI board will not power up Configuring Hot Swap under Windows To configure Hot Swap under Windows Step Description 1 Install the Hot Swap Kit during the Natural Access installation For more information about install the Hot Swap Kit refer to the Natural Access installation booklet Note If you do not install the Hot Swap Kit inserting or removing an NMS CompactPCI board while the system is running can damage the chassis or the board 2 Shut down your system and turn the power off 3 Remove all NMS CompactPCI boards from the system 4 Power up the system and log in as a user with administrative privileges 5 Run the HSK Wizard once for each system slot processor Refer to Running the HSK Wizard on page 25 for more information Running the HSK Wizard The Hot Swap Kit Wizard performs two functions e Determines the logical slot number for each physical peripheral slot in a CompactPCI chassis A slot path identifies each physical slot e Adjusts the resources assigned to the CompactPCI bridges in the system at boot time so that bo
45. D_EXTRACTION_CONFIGURED HSM_EXTRACT_PENDING HSM_S2_S2R Handle is opened HSM_BOARD_EXTRACTION_UNCONFIGURED HSM_DRIVER_NO_CHANNELS HSM_S2R_S1U Board UNpreparation requested HSM_UNPREPARE_ BOARD HSM_ BOARD STOPPED HSM_S1U_P0 Surprise extraction HSM_BOARD_PHYSICALLY_EXTRACTED For CG 6565C boards all Hot Swap messages are displayed when the board handles are flipped The utility does not display separate messages when the board is physically extracted NMS Communications 75 Other utilities NMS OAM System User s Manual Hot Swap driver hssrv Name hssrv Purpose Starts and coordinates the set of Hot Swap drivers Solaris only Usage hssrv options where options are Option Description h Displays the hssrv Help screen and terminates mc Prints configuration related messages mi Prints information messages me Prints warnings and error messages ma Prints all messages C Starts the Hot Swap driver as a console application default d Starts the Hot Swap driver as a daemon k Kills any previous instance of the daemon Description On a Solaris system hssrv must be running to use Hot Swap When Natural Access is installed hssrv is placed in the opt nms hotswap bin directory Start hssrv as a daemon or as a console application To run hssrv at boot time recommended add information about the program to the etc inittab file For more information refer to the UNIX administrator manual
46. G cccceeeeceeeeeeeeeeeeeeeeeeeeeeeeaeaeeaeaeeeseeeaeaeeesaeeauaeseueesonas 59 oa MCF OVERVIEW aoire ies tetanic p retin EAEE awe A AET Pawan ve dba aeie nana ELENEK TINA 59 LAUNCHING CAMEO avaeente iiraddiniaaeveteavaeletatadddeneiewasilovhosswe deen edaads deaUdelarveudeuans 59 Command line OptioNS ssiri ehini cris traii ienaa aai AEA ATEAN AA deans ECEE 59 Identifying boards in oamcfg Operations s sssssssssrrsrssurrrrrusurrrrnnnuerrnrnnnerrnnns 61 Displaying board Product types ceecccccecee eee eee eee eee eee eee eee e eee eee eee EEE eae ta 62 Adding and deleting board Sisiiirer ririri noie eriia eee eee eee ANACAN EENE AAAA KAn 62 Creating a record in the database sssssssrsrrsssrrnrrsrsrrrrnsrurrrrnnsuerrnnnnuerrnnns 62 Automatically detecting and adding boardS ssssssssrssssssrrrresrerrnnrurrrrnenserran 63 Deleting a board iersinii eiii anera ANEA DAEA ARAALI TIAA AAA TRAVA enti dead aise ts 63 Reading and changing database information sssssssssssrrsrssrrrrrrserrrrennerrrrrnnes 64 Displaying board ID information cc cece ceee eee cence eee eee eee eee een etna eeeeeaeeenes 64 Specifying settings in board keyword files ccccceeceeeee eee eeeeeeaeeaeeteeeeneeeaennas 64 Specifying settings on the command liNe cece eee e eee eee e ee eee teeta nena eae 65 Changing board ID information ccceeeeee eee eee eee ee eee eee eee eee eae tated 65 Replacing existing Gata sicccic
47. I option to configure loopback in one of the following modes Loopback Description mode Line Data from the board s external DS1 interfaces is looped back to the external DS1 through the framer chip s line interface unit LIU Backplane Data from the board s PCM highway is looped back to the board s PCM highway through the framer chip s PCM input Note On AG boards set the agtrace trace mask to 0x1000 before implementing loopback For example if you run trunkmon with the following arguments eeuimlsmom li e0 the first trunk is set up in line loopback mode trunkmon displays the following output Set loopback mode 1 on trunk 0 You can use the q option to query the current loopback mode and view the loopback output with oammon For example if you run trunkmon with the following arguments trunkmon q tl oammon specifies the second trunk s loopback mode in the following way Get loopback mode 2 from trunk 1 Procedure To run trunkmon for board number O enter trunkmon trunkmon s output differs depending upon whether the digital trunks are ISDN primary rate PRI or basic rate BRI For boards with PRI trunks the output resembles the following Digital Trunk Monitor NMS Communications Wer lez dun 2i 2001 Press F3 or ESC to exit ALT F1 to reset BOARD 0 Monitor start time Tuergun 26r k52 1E2200 Alarms Remote Errored Failed Code SIERS Frame alarms sec sec violations sync Trunk O RED NONE ile 15 0 1 No
48. IVIEW siviideruateeierinanidilar tected Tene lidec aw ANENE 89 Clock masters and clock SlAVES cccee cece eee eee eee nae aiaa 89 TIMING TETEREN CES oes cache ve dsineadewen da neataws yodaus cane eidalen we bee pala NENO AEAEE EAA NAET IENA 90 NETRE F aiaee EA EAA A AANE AOE EAEE A ecuutalicliaants valgus erie LANE AE AAAA 92 Fallback timing referentes innuna ea a a a E AAAA A 94 Secondary clock masters sssssssrssnssrrsrrarnannnennennesnasnasnsennennernorrorrnernnnnn 94 System configuration file example ssssssssssssssssssrssssssrsrrrnrrrnrrrrrrrrrnnnrnnannnnnnnn 96 Board KEYWOTAS unid aeaee cede oivtadalsisestvbbalciesde wvehwlide Subbed ed SaDo E ia AEE Teie ss 98 Clock Signal summary ese cise ocean AEE EAA EA EAT EATE AANE E ant 98 Configuring clocking in your System s ssssssssssrrrrsssrrrrrrsurnrnnnuunrrnrnuuurrnnnernrns 99 Choosing master and slave boardS sssssssssrsrrsrsrrrrrussrrrnrunnnrrnnnursrrrrnururns 100 Chapter 10 System level clocking with clockdemo sssssssssssnnnnnnnnnnnnnnnn 101 RUNNING ClOCKGEMO vaania renina See a aaea Oa EA aa AN a ANE oa Eai 101 Creating a timing reference priorities file sssssssssrrrssssrrnrrnrrrrrrrsrsrrrrrrrsres 103 Sample timing reference priorities file sssssssssssrrsrrssrrssrssrrsrrsrrrerrrrrrrns 103 clockdemo program StrUCCUFe ccc cece eee eee ener nena teas 106 MAIN Seid chaise Seva setucvie eva nawed sthwaeleceuy Geesweotev A T E ebtevad
49. In Solaris if you are running the Hot Swap manager in console mode ensure that the Hot Swap driver hssrv is running otherwise startup fails Refer to Hot Swap driver hssrv on page 76 for more information In Linux ensure that the Hot Swap kernel driver is loaded Refer to Starting Hot Swap under Linux on page 33 for more information If the print option is on default messages display as boards are inserted and extracted Each message displays in the following format direction destination pci_bus pci_slot hsmessage where Field Description direction Direction of message gt indicates an output message lt indicates an input message destination Label given to an application for example hsmon or the label for querying a board for example QSlot pci_bus CompactPCI bus and slot location pci_slot hsmessage Hot Swap manager message indicating the Hot Swap state or message NMS Communications 71 Other utilities For example NMS OAM System User s Manual gt QSlotI 0 9 HSM_REPLY_SLOT_BY_IDENT_DATA lt QSlotI 0 0 HSM_OPEN_CONNECTION lt QSlotI 0 0 HSM_QUERY_SLOT_BY_IDENT_DATA gt QSlotI 0 9 HSM_REPLY_SLOT_BY_IDENT_DATA lt QSlotI 0 0 HSM_CLOSE_CONNECTION lt QState 0 0 HSM_OPEN_CONNECTION lt QState 0 9 HSM_QUERY_HSM_ STATE gt QState 0 9 HSM_REPLY_HSM STATE status HSMS_PO lt QState 0 0 HSM_CLOSE_CONNECTION lt OAM 0 0 HSM_OPEN_CONNECTION lt OAM 0 0 HSM_CLOSE_CONNECTION lt HSMON 0 0 HSM_OPE
50. MS OAM architecture e Performing OAM tasks NMS OAM architecture NMS OAM software includes the following components e NMS OAM Supervisor a part of the Natural Access Server ctdaemon e Board plug ins e Extended management components EMCs The following illustration shows NMS OAM components Natural Access Server ctdaemon eremeee won NMS OAM Supervisor Poon PrTTT TTT TT TTT i eee eet Cet TETT eee Clock Board Board Hot Swap Management plug in plug in EMC EMC Boards Boards NMS Communications Overview of NMS OAM NMS OAM System User s Manual NMS OAM Supervisor The NMS OAM Supervisor provides the main NMS OAM logic It performs the following tasks e Loads all board plug ins and extended management components EMC when it starts up e Coordinates the activities of the managed components in the system e Manages a database containing configuration information for the components in the system The NMS OAM Supervisor is an integral part of the Natural Access Server ctdaemon To use the NMS OAM software Natural Access must be installed on your system and ctdaemon must be running To learn how to start ctdaemon refer to Starting the Natural Access Server on page 34 Board plug ins NMS OAM communicates with boards through software extensions called board plug ins one for each board family The NMS OAM board plug ins support the AG CG CX and QX PCI and CompactP
51. Manual Starting NMS OAM For console interaction with the NMS ctdaemon service invoke ctdaemon c from any command prompt while the service is running Starting the Natural Access Server under UNIX On UNIX systems invoke ctdaemon i from the command prompt This method allows full console interaction with the ctdaemon Starting the Natural Access Server in the in process mode In certain debugging scenarios it is useful to start the Natural Access Server in the in process mode When the Natural Access Server runs in this mode tracing messages are reported directly to stdout To start the Natural Access Server in the in process mode Step Action 1 Access a command prompt on the host system If the host system is a remote host access the command prompt on the host using a separate third party utility such as telnet rsh or rexec 2 Enter the following ctdaemon When the Natural Access Server is not running in the in process mode tracing messages are captured in agpierror log Under Windows this file is located in nms oam log Under UNIX it is located in opt nms oam log Use the dectrace utility to decode ISDN information from this file as follows dectrace f nms oam log agpierror log gt mytrace txt NMS Communications 35 Starting NMS OAM NMS OAM System User s Manual Verifying Hot Swap Once you have started the Hot Swap manager and driver on a host use oammon to verify that all Hot Swap files are
52. NCE_CHANGED was returned by _clock_monitor e Determines new fallback sources based on the priorities set in the configuration file e If the source is on another board chooses a new secondary master e Updates h110_parms to describe the new configuration e Includes CLKSYS_ACTION_NEW_PRIMARY CLKSYS_ACTION_NEW_SECONDARY and or CLKSYS_ACTION_RELOAD_PRIMARY_FALLBACK in the returned action as appropriate NMS Communications NMS OAM System User s Manual System level clocking with clockdemo _clock_reconfigure _clock_reconfigure is called at regular intervals by the while loop in the main section It is called directly after _clock_control returns unless action is CLKSYS_ACTION_NONE It reconfigures one or more of the boards in the system based upon the action returned by _clock_control _clock_reconfigure is passed the following information Parameter Description action Action code returned by _clock_control h110_parms Array updated by _clock_control describing the new configuration to set swihd_array Array of switch handles num_of_boards Number of boards in the system h110_query_parms Array updated by _clock_monitor containing the current configuration as reported by swiGetBoardClock _clock_reconfigure does the following Step Action 1 If action is CLKSYS_ACTION_RELOAD e Compares various parameters in h110_query_parms the configuration reported by the boards with equivalent parameters in h110_parm
53. N_CONNECTION lt HSMON 0 0 HSM_OPEN_CONNECTION lt HSMON 0 9 HSM_QUERY_HSM_STATE gt HSMON 0 9 HSM_REPLY_HSM STATE status HSMS_PO lt HSMON 0 0 HSM_CLOSE_CONNECTION lt HSMON 0 0 HSM_OPEN_CONNECTION lt HSMON 0 9 HSM_QUERY_SLOT_INFO gt HSMON 0 9 HSM_REPLY_SLOT_INFO lt HSMON 0 0 HSM_CLOSE_CONNECTION Error messages hsmgr displays the following error messages Error message Error Can t create hsmgr_hsd event object Error Can t create hsmgr_hsf event object HSMor initialization error pci bus slot HSMgr internal error Wrong transition from old state to new state pci bus slot Skipped HSM_BOARD_CONFIGURED message Informational messages Description Hot Swap manager cannot create the hsmgr_hsd event object Check system resources Hot Swap manager cannot create the hsmgr_hsf event object Check system resources This message usually follows other error messages Check to see if another copy of the Hot Swap manager is running Hot Swap manager encountered an error transitioning between states A board preparation application sent an unexpected message hsmgr displays the following informational messages Informational message Use statediagram diagram Changed from oldstatediagram to newstatediagram diagram 72 Description On startup the Hot Swap manager displays the state diagram it is using If the state diagram changes the Hot Swap manager displays the
54. Sgnl Trunk 1 NONE YELLOW 1 IS 2 0 OK Trunk 2 NONE NONE 1 0 0 0 OK atseybboure 3 NONE NONE 1 0 0 0 OK 84 NMS Communications NMS OAM System User s Manual Other utilities The following table explains the trunkmon output for PRI trunks trunkmon display PRI trunks Alarm Remote Alarm Errored seconds Failed seconds Code violations Slips Frame sync Description T1 trunks e RED Red alarm or loss of frame e BLUE Blue alarm or AIS alarm e NONE No alarm E1 trunks e AIS All ones alarm e NO_FRM Loss of frame e 16 AIS All ones in timeslot 16 e NONE No alarm T1 trunks e YELLOW Remote loss of frame e NONE No alarm E1 trunks e FAULT Remote loss of frame e NO_SMF Remote loss of signaling multiframe e NONE No alarm One second intervals containing one or more errors Ti trunks Number of one second intervals that are preceded by 10 consecutive failed seconds E1 trunks Number of one second intervals in which loss of signal occurs out of frame occurs or excessive bit error rate is detected Line code violations Slips accumulator OK Proper frame synchronization to the trunk NoSgnl Loss of signal No Frm Loss of frame No MF Loss of signaling multiframe NoCRCF No CRC frame synchronization For boards with BRI trunks trunkmon s output resembles the following Digital Trunk Monitor NMS Communications Ver 1 2 Jun 21 2001 BOARD 0 Press F3 or ESC to exi
55. aetaessavaedsansntdaaadeateceas aan daecsaaeregens 46 Configuring NON bOard ODjeCtS cceece eee ee eee ee eee eee eee a 46 Sample configuration file ccceeee cece eee eee ee eee ee eee eae tana 47 NMS Communications 3 Table of Contents NMS OAM System User s Manual Using board keyword files siniraan a aan see cuie ogevteveeaiedhbeectiadgedeeneenes 48 Keyword file SYNtaxs cPvsecsewsetisneataresstagees nteal weeoterddehsteaseveeendbave et et sa ieee RER 48 Board keyword file example wo cece ccc eect renee ene EEE EEE EEE EEE EE EEE 49 Specifying Keywords and values oo ceec cece eee eee EE EEE EE REE EEE Eta 50 Keyword name value PAIS cece ec eee EEE EEE EE EEE REE EEE EE EEE 50 Struct KeyWord Surri veces Vad avan EEEE mad ENGA E E T EAE E A E A ia 50 Array KeyWords nmo e mien a A E a Sees ee a ae eee eae 51 Array keyword eXxpanSion s ssssssssrssrssrresrsssasnsensensesnornorrorrnerrarrennnnnannnannan 51 Starting boards automatically c cece eee e eee eee eee eee eee eee eee e eee aeneies 53 Chapter 6 Using OAMSYS and OAMMON ccceeeeeeeeeeeeeeeeeeeeeseeseseeeeeeeeeeeeseeeeeenes 55 SING OAM SYS arresi a EAKA EA dey tenaculigeemenedddied swage deers Aa a E 55 RUMMING OAMSYS oeaan ae hate cbedia et elon dav aA n E a Git aAA cua A EARNS AA Saia 55 eine er aa nake EAEE EA A A A A A N A E 56 OAMMON command line OPTIONS ceceeeccecee cece eee eee eee eee EEA tee EEE eet aS 57 Chapter 7 USING OAMCE
56. ard Note Use this timing reference source only if no network timing references are available Note Not all boards support all signals For more information about board models refer to the board documentation Configuring clocking in your system Configure board clocking in your system in one of two ways Choose only one of these configuration methods across all boards on the CT bus Otherwise the two methods interfere with one another and board clocking does not operate properly Method Details Using clockdemo Create an application that assigns each board its clocking mode monitors application model clocking changes and re configures clocking if clock fallback occurs A sample clocking application clockdemo is provided with Natural Access clockdemo provides a robust fallback scheme that suits most system configurations clockdemo source code is included allowing you to modify the program if your clocking configuration is very complex For more information refer to Running clockdemo on page 101 Note Most clocking applications including clockdemo require all boards on the CT bus to be started in standalone mode Using board This method is documented in Configuring the primary clock master on page keywords with or 114 Configuring the secondary clock master on page 115 and Configuring without application clock slaves and standalone boards on page 116 Unlike the clockdemo intervention application which allows several
57. ard drives For the secondary clock master specify the clock not driven by the primary clock master For example if the primary master drives B_CLOCK specify MASTER_A for this keyword for the secondary master Clocking HBus ClockSource Specifies the primary timing reference for the board For the secondary clock master set to the CT bus clock driven by the primary master A_CLOCK or B_CLOCK This makes the secondary master a slave to the primary master Clocking HBus AutoFallBack Enables or disables clock fallback on the board For the secondary clock master set to YES Clocking HBus FallBackClockSource Specifies the fallback timing reference for the board to use if the primary timing reference fails Once the secondary master is driving the CT bus clock it continues to drive the clock until software intervention by an application For the secondary clock master set to any timing reference not used by the primary clock master e NETREF to use NETREF also called NETREF1 e NETREF2 to use NETREF2 H 110 only e NETWORK to derive the timing from the clock pulse on a digital trunk connected to the board e OSC to use the board s on board oscillator Use only when no other source is available Clocking HBus FallBackNetwork If Clocking HBus FallBackClockSource is set to NETWORK specifies the board trunk from which to derive the fallback timing reference Clocking HBus NetRefSpeed If using NETREF 1 or NETREF2 as a timing refere
58. ards can be inserted and extracted while the system is running The new resource allocations are stored in the registry and become effective whenever the system is booted This resource adjustment is important because by default CompactPCI bridge memory windows are initialized to be just big enough for devices physically installed at boot time Unless the wizard is run to set up a different configuration only boards physically installed at boot time can be hot swapped in and out The wizard prompts you for the number of slots in the chassis It then asks you to insert a board in each slot When you insert the board the wizard locates the board and maps the logical slot number to the physical slot It then asks you to remove the board and insert it in another slot and repeats the process Configure each system slot processor in the system separately If the CompactPCI bus is divided into multiple segments controlled by separate CPUs you must run the NMS Communications 25 Setting up an NMS OAM host NMS OAM System User s Manual wizard separately for each CPU In this case the slot numbers indicated on the chassis may not match the slot numbers indicated in the wizard You can use any NMS Hot Swap compatible board in the configuration process To use the HSK Wizard Step 1 10 26 Description Launch the HSK Wizard by selecting Start gt Programs gt Hot Swap Kit gt HSK Wizard The Slot count dialog box appears Enter
59. ary of a system configuration file to load If you invoke oamsys without this option it searches for a file named oamsys cfg in the current directory and then in the paths specified in the AGLOAD environment variable If you specify a file name without an extension oamsys assumes the extension to be cfg host Load the configuration file on resource host host host is an IP address or machine name If unspecified the operation is performed on the host on which the utility was initialized oamsys reads system configuration files not board keyword files Board keyword files to be added to the NMS OAM database must be specified within the system configuration file Refer to Creating a system configuration file on page 45 NMS Communications 55 Using oamsys and oammon NMS OAM System User s Manual When invoked with a valid file name oamsys does the following e Checks the syntax of the system configuration file and checks that all required keywords are present oamsys reports all syntax errors it finds Note oamsys checks syntax only on the system configuration file and not on any keyword files referenced in the file e Checks for uniqueness of board name number and bus slot within the system configuration file e Shuts down all boards referenced in the NMS OAM database if any e Deletes all board configuration information currently stored in the NMS OAM database if any e Sets up the NMS OAM database according to the s
60. aster driving a bus clock Yes Primary clock master enters standalone mode using its internal oscillator as its timing reference It no longer drives a bus clock The board stays in this mode until the clock is reprogrammed by the application The board may not be in an operable condition NMS Communications 117 Configuring CT bus clocking with board keywords NMS OAM System User s Manual Secondary clock master fallback behavior The following illustration shows the role of the secondary clock master in board level clock fallback The secondary master takes over when the primary master stops driving the clock The secondary master continues to drive the clock for the system until an application intervenes The following illustration show clock fallback behavior for the secondary clock master Gray shapes indicate typical NMS board behavior Not strictly defined in ECTF specification Secondary master continues to act as a slave to the primary master It also drives the CT bus clock not driven by the primary master based on the clock the primary master is driving All slaves use the primary master signal secondary master receiving bus clock ignal from primar master Yes No Secondary master drives the CT bus clock not driven by the primary master using its fallback timing reference for example if primary m
61. aster drove A_CLOCK secondary drives B_CLOCK All slaves switch to this clock Is secondary clock master s fallback timing reference functional Yes Secondary master continues as the system master until reset by an application Secondary clock master drives the clock using its internal oscillator as its timing reference The board stays in this mode until the clock is reprogrammed by the application The system may not be in an operable condition 118 NMS Communications NMS OAM System User s Manual Configuring CT bus clocking with board keywords Clock slave fallback behavior If the primary master stops driving the clock all slaves attempt to switch over to the other CT bus clock driven by the secondary master They continue to use this clock until reset by an application If fallback is enabled but the secondary timing reference is not functional the board enters standalone mode using its internal oscillator as the timing reference It continues in this fashion until the secondary timing reference is restored The board continues using either the secondary timing reference or the oscillator until reset by an application For more information refer to the illustration in Primary clock master fallback behavior on page 117 Configuring NETREF NETREF1 and NETREF2 If you specified that any board use NETREF NETREF1 or NETREF2 as a timing reference you must configure one
62. atede devas narava NANAI ETA EAE Oriente EAA ANA aA a 65 Starting stopping and testing boardS s sssssssssssssssssssssrinrrrnrrrrrrrrrrnnrnnrnnrsnnss 66 Starting boards sararan irra Ea AA a EE AR EA a TA EENAA SEAE 66 Stopping boards seein evita cinta aia he ee ad UETA ad eee 66 Testing DO ALAS nuirir oane ni Meandenies dat vacdeheraiesar tines ENN ents 66 Importing and exporting configurations cceee cece eee eee eee eee eee eee eee eae 67 OAaMClg task SEQUENCE ica i cere aaua ete eat ce cee varies Mace eee eae A eee ieee 68 Chapter 8 Other Utilities cccccsscseeeseeseeeeeeeeeeeneeneeeeeaeeeseasenseasessenseneeneensens 69 Utilities OVErViGW isni aa e a E a a AA bad headed eee ear ea 69 Hot Swap Manager ASME erriren einsi vs ninn aita a a Aa dA Aii 70 Hot Swap monitor ASMON iridis irsrinisirsiiniriiiirii iniii t a ii n ENEA aa 73 Hot Swap driver NSS imar decease a cea A A WT nd AAV eed ee ae 76 System configuration file creator OAIMGEN iceeee eee eee eee teeta eee eeeeeaeee nae 78 Board locates peiSGan isis iteiisie dean ceiedlered sil nie i AEGEAN OAT EEN iaa 80 Digital trunk status trUNKMON rian c cece a eee eee ene eee eee eee ene A 83 AG board locate blocate s n ccc cece center a aa ae EA ene ea T a Aaah 87 4 NMS Communications NMS OAM System User s Manual Table of Contents Chapter 9 H 100 and H 110 bus clocking sssssss25 89 CT bus clocking OVE
63. ation 7 If you insert a CompactPCI board when board auto start is enabled messages reporting the insertion and the board start display Refer to Starting boards automatically on page 53 for more information For example Wed Sep 26 13 57 11 HSWEVN_BOARD_INSERTED INFO Board 0 NameO0 HotSwap notification Wed Sep 26 13 54 10 HSWEVN_ONLINE_PENDING INFO Board 0 NameO HotSwap notification Wed Sep 26 13 54 10 HSWEVN_BOARD_READY INFO Board 0 NameQ HotSwap notification Refer to Using oammon on page 56 for more information 36 NMS Communications NMS OAM System User s Manual Starting NMS OAM Logging startup events NMS OAM automatically maintains the following NMS OAM event logs on each host File name Description startup log A list of all NMS OAM events that occurred when the host started This file is rewritten whenever the host starts It is closed after the host starts oam rpt Low level report information generated when a board is started Information about each board is appended to the file when the board is started The file is rewritten when the host is started Note For users migrating from agmon this file is the NMS OAM equivalent of the ag rpt file generated by agmon On the host the files are found in the following locations e Windows nms oam log e UNIX opt nms oam log Configuring PCI bus address space for Hot Swap Solaris To allow hot swapping of boards in your CompactPCI Solaris
64. atural Access under UNIX e Starting the Natural Access Server in the in process mode Note If ctdaemon is stopped all dependent applications receive an error Stop and restart the service for NMS OAM functions to become available again Note that applications accessing Natural Access in in process mode only are not affected if ctdaemon is shut down For the NMS OAM Supervisor to start up within the Natural Access Server when it boots the following line must appear in the ctasys section in cta cfg this line is included by default Service oam oammgr Starting the Natural Access Server under Windows Under Windows start ctdaemon as a service using a console window or in the Control Panel To start ctdaemon in a console window Step Action 1 Access a command prompt on the host system If the host system is a remote host access the command prompt on the host using a separate third party utility such as telnet rsh or rexec 2 Enter the following net start ctdaemon To start ctdaemon using the Control Panel Step Action 1 Open the Administrative Tools applet in the control panel The Administrative Tools window appears 2 Open the Services applet within this window The Services window appears 3 Double click on NMS ctdaemon The Properties window appears 4 Click Start 5 Click OK 6 Close the Services window 7 Close the Administrative Tools window 34 NMS Communications NMS OAM System User s
65. ay 32 DLMFiles 0 cg6krun DebugMask 0x0 NMS Communications 49 Creating NMS OAM configuration files NMS OAM System User s Manual Specifying keywords and values This topic provides the following information e Keyword name value pairs e Struct keywords e Array keywords e Array keyword expansion Keyword name value pairs In its simplest form a statement consists of a keyword name followed by an equal sign and then a value keyword_name value where keyword_name denotes a parameter and value indicates the value to assign the parameter AutoStart YES For a list of valid keywords for a component see the manual for the device you are configuring NMS OAM Supervisor keywords Clock Management EMC keywords and Hot Swap EMC keywords are listed in the NMS OAM Service Developer s Reference Manual Struct keywords Struct keywords are similar to C language structures A struct is a group of related named values elements under a common name The fully qualified keyword name for each element in the struct consists of the struct name followed by a period and then the element name Within NMS OAM the fully qualified keyword name for an element is always used to refer to the element The following illustration shows Struct keyword names Driver Name QX2000 Driver BoardID WI Struct keyword Value _ Keyword name oll Structs can contain structs In the following examp
66. back normal mode 1 Line loopback 2 Backplane loopback The loopback option works only on CG boards and AG 4040 boards t trunknumb Specifies the trunk number The trunk number is a zero based index associated with the board by NMS OAM If no trunk number is specified trunkmon defaults to trunk 0 host Displays the status of trunks on resource host host If unspecified it is assumed that the trunks are on the host on which trunkmon was initialized q For diagnostic purposes only Queries framer loopback mode and displays the output in oammon Description trunkmon displays the status of all trunks connected to the specified board trunkmon continuously monitors the status of the trunks and updates the display if the data changes If the s option is specified tr unkmon beeps when an alarm transition occurs Framer loopback diagnostic options Use the I and t loopback options for diagnostic purposes on CG and AG boards with DS1 interfaces The loopback options verify whether the board s DS1 configuration matches the configuration of its incoming lines Caution trunkmon loopback options are intended for diagnostic purposes only AG and CG boards cannot process data appropriately when either loopback mode is in use In addition the NMS compliance certificates obtained for the CG or AG board do not apply when loopback is in use NMS Communications 83 Other utilities NMS OAM System User s Manual Use the
67. board 2 PCI bus 0 PCI slot 0 Note For each operation except c if no specific component is referenced on the command line with the b l or n options the operation is performed for all boards on the resource host specified with the option or on the management host if is not specified Assigns board ID information if specified on the command line Values specified on the command line override any values previously set Note If the r option is specified any existing data for the boards is deleted when any new information is added with the f or k options or if the board ID information changes Refer to Reading and changing database information on page 64 In the NMS OAM database record s for the components adds the contents of any keyword files specified with f options In the NMS OAM database record s for the components sets any values specified with k options on the command line The value for a given keyword specified on the command line overrides any value for that keyword previously loaded from a keyword file If q is specified displays the board s name and number or the names and numbers of all boards if no board is specified on the command line If s is specified attempts to start the board or all boards if no board is specified on the command line By default oamcfg waits until all board start or test attempts succeed or fail unless the i option is specified If p is specified stops t
68. boards automatically when the Supervisor starts up set the AutoStart keyword for each board For more information about this keyword refer to the NMS OAM Service Developer s Reference Manual NMS Communications 47 Creating NMS OAM configuration files NMS OAM System User s Manual Using board keyword files A board keyword file contains keyword settings When you create the system configuration file you can reference one or more board keyword files to use for the components in your system Refer to Creating a system configuration file on page 45 for more information When you run oamsys the utility adds the settings for each component to the NMS OAM database Several sample keyword files are supplied with the hardware installation Each of these files configures the board to use a different protocol for example wink start or off premises station You can reference these files in the system configuration file or modify them For more information about the sample files supplied for your hardware refer to the board documentation For detailed descriptions of the keywords supported for the board refer to the board documentation If the system contains more than one board with the same configuration you can use the same keyword file for each of these boards Note All sample files set each board to stand alone clocking mode For boards to communicate with each other across the CT bus modify the clocking information for each board R
69. boards to take over mastery of the clock in a fallback situation the board keyword method allows you to specify only a fixed primary and secondary master For this reason the board keyword method is best used only if you do not want to implement clock fallback in your system or in test configurations where clock reliability is not a factor The board keyword method does not create an autonomous clock timing environment An application must still intervene when clock fallback occurs to reset system clocking before other clocking changes occur If both the primary and secondary clock masters stop driving the clocks and an application does not intervene the boards default to standalone mode NMS Communications 99 H 100 and H 110 bus clocking NMS OAM System User s Manual Choosing master and slave boards Some boards can drive clock signals more reliably than others and have more flexible clocking capabilities If your system contains several board models choose the boards with the best clocking characteristics for your primary and secondary masters The following list ranks the NMS boards by their abilities to serve as clock masters a eS aE 6 CG 6xxx family best AG 4000 AG 4000C AG 4040 and AG 4040C AG 2000 AG 2000C and AG 2000 BRI CX 2000 and CX 2000C QX 2000 For example if your system contains a CG 6000C an AG 4000C and a CX 2000C board the CG 6000C board should serve as primary master The AG 4000C board s
70. cfg e Starting boards e Stopping boards e Testing boards Starting boards Once a board is properly configured and is physically installed in the system use the s option to start the board oamcfg s n myboard If no board is specified oamcfg attempts to start all boards in the NMS OAM database By default oamcfg waits after attempting to start the specified boards until all board start attempts succeed or fail reporting the results to stdout To avoid this use the i option Came romao a If the i option is used results are still available The results come asynchronously encapsulated in NMS OAM events which oammon can receive and display Stopping boards To stop a board use the p option oamcfg p n myboard If no board is specified oamcfg attempts to stop all boards in the NMS OAM database Note The specified board stops immediately interrupting any ongoing process To avoid problems make sure a board is not performing any operations before stopping it By default oamcfg waits after attempting to stop the board until all board stop attempts succeed or fail reporting the results to stdout To avoid this use the i option came romea If the i option is used results are still available The results come asynchronously encapsulated in NMS OAM events which oammon can receive and display Testing boards To test a board use the t testopts option oamcfg t 0x80000301 n myboard testop
71. ck_monitor returns It uses the information returned by _clock_monitor to determine if any action is necessary to reconfigure the clocks It returns an action code describing the action to be taken if any _clock_control is passed the following information Parameter Description clock_status Code returned by _clock_monitor describing the status of the system clocks and timing references h110_parms The previous set of clocking settings made to each board by clockdemo h110_query_parms Array containing the clocking status information for each board updated by _clock_monitor num_of_boards Number of boards in the system _clock_control returns the following information Parameter Description action Integer describing one or more actions to take if any e CLKSYS_ACTION_NONE 0x0 Take no action e CLKSYS_ACTION_RELOAD 0x01 Reload each board s current configuration e CLKSYS_ACTION_NEW_PRIMARY 0x02 Configure a new primary master e CLKSYS_ACTION_NEW_SECONDARY 0x04 Configure a new secondary master e CLKSYS_ACTION_RELOAD_PRIMARY_FALLBACK 0x08 Reload the primary master s current configuration Do not change any other boards h110_parms An updated set of clock settings to make to one or more boards NMS Communications 109 System level clocking with clockdemo NMS OAM System User s Manual _clock_control does the following Step 1 3 4 5 110 Action Calls _find_master This function e
72. default oamsys looks for a file with this name when it starts up If you know the PCI bus and slot locations of the boards in your system create the system configuration file manually as described in this topic If you do not know the locations of your boards use the oamgen utility included with the NMS OAM software to create a skeleton system configuration file for your system You can then complete this file manually and then run oamsys For more information refer to System configuration file creator oamgen on page 78 This topic provides the following information e Configuration file sections e Mandatory statements e Board keyword sections e Configuring non board objects e Sample configuration file You can find a sample system configuration file in the nms oam cfg directory under Windows or in opt nms oam cfg under UNIX Configuration file sections Statements within the system configuration file appear one to a line Any text appearing after a number sign is a comment and is ignored Statements in all configuration files are not case sensitive except where operating system conventions prevail for example file names under UNIX The system configuration file is divided into multiple sections one for each board Each section is headed with the name of the board in square brackets Myboard This name can contain a space for example My board but must not be preceded by or followed by a space For e
73. e Boards Boards Applications on the management host can direct NMS OAM on a resource host to configure start and manage its resources based on the NMS OAM database NMS Communications 19 Overview of NMS OAM Overview of setting up NMS OAM NMS OAM System User s Manual Administrators can use NMS OAM to set up hosts in single host configurations or in multiple host configurations Single host configurations If your configuration consists of only one host follow these steps to set up NMS OAM 1 20 Step Description Ensure that your chassis is set up properly for Hot Swap boards Required only if you are using Hot Swap Install NMS OAM software Start the Natural Access Server ctdaemon if it is not already running Also start Hot Swap Create a system configuration file describing your system In this file give each board a unique name and board number If your system contains two or more boards connected through the H 100 or H 110 bus configure clocking on the bus Use oamsys to create records for components in the NMS OAM database based upon the system configuration file and to start all installed boards Documented in Configuring Hot Swap on page 23 Natural Access installation booklet Starting the Natural Access Server on page 34 Starting Hot Swap on page 31 Creating a system configuration file on page 45 CT bus clocking overview on page 89 Using oamsys on
74. e switches to the secondary clock it continues to use the clock until reset by an application Configuring standalone boards Configure a board in standalone mode so that the board references its own timing information set Clocking HBus ClockMode to STANDALONE In this mode the board is not able to make connections to the CT bus With some board models specifying standalone mode can cause certain default switch connections to be made on the board to route incoming information from the trunk to DSP resources The SwitchConnections and SwitchConnectMode keywords control this behavior Refer to the board documentation for more information Board level clock fallback behavior This topic describes the following aspects of clock fallback behavior when clocking is configured with board keywords e Primary clock master fallback behavior e Secondary clock master fallback behavior e Clock slave fallback behavior Note The illustrations describe the actions taken by most NMS board models in these situations For specifics on a particular board refer to the board manual 116 NMS Communications NMS OAM System User s Manual Configuring CT bus clocking with board keywords Primary clock master fallback behavior The following illustration shows the role of the primary clock master in board level clock fallback If the primary master loses its primary timing reference and switches to its secondary reference and then the primary r
75. e topics in this section describe H 100 H 110 clocking as described in the ECTF H 110 Hardware Compatibility Specification CT Bus R1 0 Not all boards support this specification completely For information on setting up clocking with a particular board type refer to the board documentation Note Hardware clocking procedures are not transparent to the application In addition to configuring clocking the application must monitor clocking and take appropriate action when required Clock masters and clock slaves To synchronize data transfer from device to device across the H 100 bus or H 110 bus devices on the bus must be phase locked to a high quality 8 MHz clock and 8 kHz frame pulse These signals together compose a CT bus clock One board on the bus generates drives the clock This board is called the clock master All other boards use this clock as a timing reference by which they synchronize their own internal clocks These boards are called clock slaves see the following illustration Note Not all boards can serve as clock masters For more information refer to the board documentation The following illustration shows a clock master and clock slaves Aa Q Clock slave Clock master Lo LILI Clock slaveN IN Clock Clock slave pulse NMS Communications 89 H 100 and H 110 bus clocking NMS OAM System User s Manual Two CT bus clocks can run s
76. efer to CT bus clocking overview on page 89 for information Keyword file syntax A keyword file is an ASCII text file Typically the file has the extension cfg Within the file each statement appears on its own line A line beginning with a number sign denotes a comment and is ignored If a line ends with a backslash the next line is assumed to be a continuation of the line 48 NMS Communications NMS OAM System User s Manual Board keyword file example Creating NMS OAM configuration files The following board keyword file configures a CG 6000C board to run with NOCC Board specific information such as board ID information is not included in board keyword files c nocc cig CG 6000 configuration file Se Se SH OSE OSH OSE This file configures the board to run Voice with NOCC Clocking HBus ClockMode STANDALONE Clocking HBus ClockSource OSC Clocking HBus ClockSourceNetwork 1 TCPFiles nocc DSPStream VoiceIdleCode 0 3 0x7F DSPStream SignalIdleCode 0 3 0x00 Networkinterface TIKI 0 3 Type T1 NetworkInterface T1E1 0 3 Impedance DSX1 NetworkInterface T1E1 0 3 LineCode B8ZS NetworkInterface T1E1 0 3 FrameType ESF NetworkInterface T1E1 0 3 SignalingType CAS DS CS O54 o Sli malo 0 cg6klibu DSP C5s 0 231 xbaw MU_LAW per Cox lee Saes voice tone dtmf echo rvoice callp ptf wave oki ima
77. efer to Using oammon on page 56 for more information oaminfo The oaminfo utility enables you to access keywords from the command line oaminfo can display all keywords for a component or specific keywords and values It can also search for text in keyword names and set keyword values oaminfo can perform its functions on both local and remote hosts For more information about oaminfo refer to the NMS OAM Service Developer s Reference Manual NMS OAM service You can program access to NMS OAM functionality using the NMS OAM service NMS OAM is implemented as a service under the Natural Access development environment Natural Access provides standard programming interfaces for hardware independent functions Under Natural Access logically related functions NMS OAM operations for example are divided into groups called services which have similar APIs NMS OAM utilities make calls to the NMS OAM service to perform their operations For information about using the NMS OAM service refer to the NMS OAM Service Developer s Reference Manual 12 NMS Communications NMS OAM System User s Manual Overview of NMS OAM NMS OAM database NMS OAM maintains a database containing configuration information for each component under its control This information consists of parameters and values Each parameter and value is expressed as a keyword name and value pair for example AutoStart YES You can use NMS OAM to retrieve and modify conf
78. eference is established again the master switches back to the primary timing reference The following illustration show clock fallback behavior for the primary clock master Gray shapes indicate typical NMS board behavior Not strictly defined in ECTF specification Primary clock master drives one of the two CT bus clocks A_CLOCK or B_CLOCK based on its primary timing reference All other boards are slaves to this clock including the secondary master Is primary clock master s primary timing reference functional Yes Is primary clock master s auto fallback enabled Yes Primary clock master drives the same CT bus clock based on its fallback timing reference All other boards continue to be slaves to this clock including the secondary master Is primary clock master s fallback timing reference functional Yes pe Primary clock master continues to attempt to use the bad primary timing reference At this point the board may not be in an operable condition and may require rebooting when the primary timing reference returns Primary clock master becomes a slave to the secondary master The board stays in this mode until the clock is reprogrammed by the application or until it loses the timing reference from the secondary master Is secondary clock m
79. en by the secondary clock master 5 The secondary master and slaves do not switch back to the primary timing reference automatically if the primary reference is re established Software intervention is required prior to any further clock changes 6 Ifthe board formerly used as the primary clock master is still active but is not receiving a primary or fallback timing reference the board attempts to become a slave to the clock driven by the secondary master NMS Communications 95 H 100 and H 110 bus clocking NMS OAM System User s Manual The secondary clock master is now clock master for the whole system The following illustration shows the secondary clock master driving system clock Signal interrupted because primary master s timing Timing reference references are both down channels bus clocks H 110 bus A_CLOCK B_CLOCK ey Se ae A ee ae NETREF1 a D A DA NETREF2 Clock slave master Secondary clock Clock slave Using l Using fallback timing per y BIRING fallback reference B_CLOCK Tis wn B CLOCK based timing No longer driving ear on fallback reference NETREF1 because references Ba timing reference B_CLOCK trunk is down down Is now S A i ee i i ES Disabled Timing reference digital trunk i digital trunk SN Disabled digital trunk System configuration file example The following example describes a system configuration where four boards reside in
80. ent operations for QX boards For information about migrating QX applications to NMS OAM refer to the QX 2000 Installation and Developer s Manual NMS SNMP services use NMS OAM Therefore SNMP provides information only on boards started using the OAM service Tracing messages are retrieved using the NMS OAM oammon monitoring utility NMS Communications 121 Migrating to NMS OAM NMS OAM System User s Manual NMS OAM and agmon differences agmon functio is deprecated with the introduction of NMS OAM NMS OAM provides all nality formerly provided by agmon NMS OAM differs from agmon in the following ways Note agmon is a utility program controllable only using its command line NMS OAM is a Natural Access service accessible programmatically using its API Various subsets of NMS OAM service functionality can also be accessed with the oamsys oamcfg and oammon utilities agmon configures boots and monitors boards as a single operation With NMS OAM configuration board starting and stopping and monitoring operations are all accessible separately using the NMS OAM utilities and API functions With agmon the central repository of configuration information is the AG configuration file With NMS OAM configuration information is kept in a dynamic database that is managed by the service The utilities supplied with NMS OAM use configuration files as a convenient way to supply information to the NMS OAM database However
81. entire configuration to the specified output file Note Do not modify the output file It is for use by NMS OAM only To import the contents of a configuration database from a file invoke oamcfg with the import filename option where filename is the file to import oamcfg import myfile cfg oamcfg imports the entire configuration from the specified input file The current configuration is lost and is replaced by the new configuration All plug ins are restarted NMS Communications 67 Using oamcfg NMS OAM System User s Manual oamcfg task sequence Regardless of the order in which the options are specified oamcfg always performs operations in the following order 1 10 11 12 68 Step Action If x is specified ignores all other command line options except a Searches the system for boards If a is specified ignores all other command line options except x Adds any detected boards to the NMS OAM database If c is specified creates a board in the NMS OAM database unless c is specified If c is specified oamcfg displays a list of all product types supported by the installed plug ins in alphabetical order and then terminates Assigns the board a default name number PCI bus and slot The following defaults are used Item Default Name Product name followed by a space and then a numeral For example CG_6000C_QUAD 0 Number Next unused number For example if board 1 exists the next number is
82. er to Specifying PCI bus numbers for board search functions on page 28 for more information To add a detected board to the NMS OAM database use the a option Also specify the n option indicating the name of the board to add For example the following command line adds detected board AG_2000_0_16 to the database on resource host MyHost1 oamcfg a n AG 2000 0 Io MyHost1 To add all detected boards at once omit any specific board name as follows oamcfg a MyHostl Deleting a board To delete a board from the NMS OAM database use the d option The following command deletes the board named myboard oamcfg d n myboard Note This operation does not require that the board be physically removed from the system If no board is specified oamcfg deletes all boards from the NMS OAM database NMS Communications 63 Using oamcfg NMS OAM System User s Manual Reading and changing database information When a record is created for a board in the NMS OAM database it is assigned a unique name and board number You can display and change this information with oamcfg This topic describes how to use oamcfg to e Display board ID information e Specify settings in board keyword files e Specify keyword settings on the command line e Change board ID information e Replace existing data in the database Displaying board ID information To display the ID parameters for a board use the q option For example the f
83. ers 107 AGIOCK SIMMOMILO LE evaded neta a wa vlna a a a a aw Baraca wale dia a N wale ard 108 amp GIOCK COMTO siicevewedvecaictuluer ania ar aa vee Aa ane ees won aara aaa aaa bua ines 109 Clock reconfigure ccsccccsiws tives ercaW estes AnA eetive AAN ETEVA EENAA EAKA ETANDONE eviawee exe 111 Chapter 11 Configuring CT bus clocking with board keywords scss0005 113 Limitations of clock configuration with board keywords c eeeeeeeee test enna 113 Configuring the primary clock MAaSter cece cece cence eee eee ee teeta eae ea eee 114 Configuring the secondary clock MAStEl cceeeeee ee eee eee eee eee neta eee eeae ees 115 Configuring clock slaves and Standalone bOardS ceecceceeeee esse cnet eeeeeeeeneenaeeaes 116 Configuring standalone boards c cece cece eee e eee eee eee e ee eee ene e eee e eee nneeaee 116 Board level clock fallback behavior eccece cece eee eee e eens eee eee ee teeta eae eae ed 116 Primary clock master fallback behavior ccecceeee eee eee eee eee e eee neee nee neee ees 117 Secondary clock master fallback behavior ccc cece eeeeeeeeeeeeeeeeeeneeesaneeeanes 118 Clock slave fallback Deh AVIOF cece ee cece eee cee eee eee eee eee e teeta eee ne eae 119 Configuring NETREF NETREF1 and NETREP2 c ceceeeeee cnet eee eeee seat taeeaeaes 119 Chapter 12 Migrating to NMS OAM ccsceeeseeeeseeeeeeeeeeeeeeeeeeuaeeeuaeeouaeennaes 121
84. erview of NMS OAM The following illustration shows the relationships between NMS OAM components oammon oaminfo oamsys Custom oamerg application NMS OAM Management hos ae reac ce VICE l ace eh seat Resource host NMS OAM Configuration database To use any NMS OAM utility on any host the Natural Access Server ctdaemon must be running on the target host and have the NMS OAM Supervisor started within it Refer to Starting the Natural Access Server on page 34 for more information oamsys To configure and start managed components on a host use the oamsys utility This utility creates records for components in the NMS OAM database on a resource host based on system configuration files you supply It then attempts to start all boards in the database Configuration parameter values for each managed component are listed in the system configuration file If the component is a board this information includes the board s ID information oamsys completely renews the database each time it runs and restarts all boards Any parameters not listed in the configuration file are reset to their default settings Thus oamsys makes it easy to track the configuration of an entire host Note If you are migrating to NMS OAM utilities are available to assist in the transition from agmon to NMS OAM Refer to Summary of changes on page 121 for more information To perform its tasks the oams
85. es board numbers Within NMS OAM boards are still assigned unique board numbers and you can still use this method to identify them in software Within the NMS OAM service you can also identify a board using its location bus and slot as well as with other information Refer to Board identification methods on page 15 for more information Hot Swap changes Previously Hot Swap was implemented as a Natural Access service the HSI service This interface is now implemented as an NMS OAM extended management component EMC The following list details changes to the API made as a result of the NMS OAM implementation For further information refer to the NMS OAM Service Developer s Reference Manual e The HSI service is deprecated and is not compatible with NMS OAM e The information formerly returned by HSI functions hsiGetBoardInfo and hsiGetLogicalBoardInfo is now available using other means as follows Information New source Board information oamBoardGetXxX and oamBoardLookupByXxXxX functions Hot Swap state Hot Swap EMC Board name State keyword e Hot Swap events are now passed to applications using the same event handling mechanism used for NMS OAM events Hot Swap events and errors have not changed except for their prefixes Hot Swap events have the prefix HSWEVN_ and Hot Swap error codes have the prefix HSWERR_ They are specified in hswdef h e A new state was added to the state machine Unsupported If a board does no
86. et to LD_LIBRARY_PATH opt nms lib To start the Hot Swap applications in console mode Step Action 1 Access a command prompt on the host system If the host system is a remote host access the command prompt on the host using a separate third party utility such as telnet rsh or rexec 2 Load the Hot Swap driver by entering opt nms hotswap bin hsmgr_startup start 3 Stop the previously running Hot Swap manager by entering opt nms hotswap bin hsmgr k 4 Start the Hot Swap manager by entering opt nms hotswap bin hsmgr To start the Hot Swap applications as daemons Step Action 1 Access a command prompt on the host system If the host system is a remote host access the command prompt on the host using a separate third party utility such as telnet rsh or rexec 2 Load the Hot Swap driver and start the Hot Swap manager in daemon mode by entering opt nms hotswap bin hsmgr_startup start Refer to Hot Swap driver hssrv on page 76 and to Hot Swap manager hsmgr on page 70 for more information NMS Communications 33 Starting NMS OAM NMS OAM System User s Manual Starting the Natural Access Server Before you use NMS OAM or any related utility start the Natural Access Server ctdaemon on each resource host ctdaemon must be running for NMS OAM functions to be available This topic provides the following information about starting Natural Access e Starting Natural Access under Windows e Starting N
87. ethods described in Board identification methods on page 15 The pciscan utility displays the logical CompactPCI or PCI bus and slot information for each NMS board installed in the system To determine the PCI bus and slot numbers for each board Step Action 1 Access a command prompt on the target host system If the host system is a remote host access the command prompt on the host using a separate third party utility such as telnet rsh or rexec 2 Run pciscan by entering pciscan The pciscan output is similar to the following Bus Sillot WMS 1D 2 11 0x50d AG_4000C_E1 2 13 0x6000 CG_6000C_QUAD There were 2 NMS PCI board s detected 3 Record the PCI bus and slot numbers You can also use pciscan to flash an LED on a specific board Refer to Board locate pciscan on page 80 for more information Creating a chart of timeslot mappings can be useful when configuring the chassis The following illustration shows a CompactPCI or PCI chassis mapping chart Back of chassis Left Right Front of chassis Specifying PCI bus numbers for board search functions If you have a chassis with an unusual PCI bus topology for example bus number 171 directly follows bus number 0 utilities that search the PCI buses for boards and other information function more slowly These utilities include e pciscan e oamcfg s board auto detect function described in Automatically detecting and adding boards on page 63 e oam
88. existing board it assigns that board the number PCI bus slot or both given in the other options To change the number of the board in bus 0 slot 20 specify the following assumes that board number 5 does not currently exist Came om W320 sisi jmoreraiacl lq 5 Note You cannot change a board s name MAC address or shelf and slot information You cannot specify the same board identification option twice on the same command line When referencing an existing board with a given identification option you must specify two command lines to change that option For example to change board number 0 to 15 assuming that board number 15 does not currently exist specify the following Same foqu PRO NRECEME oamcfg n temp b 15 Replacing existing data By default when oamcfg adds changes or deletes information for a component using the f or k options or changes board ID information as described in Changing board ID information on page 65 it does not disturb any other settings for the board Use the r option to delete all database information for the board before adding the new information This is useful when you want to start from a blank slate when changing information for a component gamer b 1 2 f filea cfig f fileb cig NMS Communications 65 Using oamcfg NMS OAM System User s Manual Starting stopping and testing boards This topic provides information about performing the following tasks with oam
89. feseeseeeestttannseceeeeeefeceesezananben NETREF2 Clock slave Currently using Clock slave Primary clock master Secondary Currently using Driving A_CLOCK clock master based on external Driving ALCOLOCK A_CLOCK ae timing reference B_CLOCK based Fallback timing ref B_CLOCK reference Driving NETREF1 Fallback timing on A_CLOCK reference NETREF1 Currently B_CLOCK ibased on external acting as i timing reference A slave Fallback i Timing reference J timing N Timing reference digital trunk ref external digital trunk i Timing reference i digital trunk not currently being used Note Not all boards can act as secondary master For information about the boards refer to the board specific documentation With a secondary clock master clock fallback works as follows 1 As long as the primary clock master is driving its CT bus clock the secondary clock master acts as a slave to the primary clock master However the secondary master also drives the CT bus clock not driven by the primary master for example B_CLOCK if the primary master is driving A_CLOCK 2 Ifthe primary clock master stops driving its CT bus clock all slaves including the secondary clock master lose their primary timing reference 3 This triggers the secondary master to fall back to its fallback timing reference This also triggers other slaves to fall back to the CT bus clock driv
90. g board keyword files on page 48 and Specifying keywords and values on page 50 for more information You can also include sections to configure non board components such as an EMC or the Supervisor Refer to Configuring non board objects on page 46 for more information When oamsys runs a record is created for each object in the NMS OAM database containing default parameter settings Then the settings in the configuration files are added to the record The following illustration shows how NMS OAM configuration files interact through oamsys System configuration file Keyword file oamsys cfg filea cfg Beard A TCPFILE 0 NOCC eas oie nie oleae Number Country USA Y Bus 0 Slot 20 File filea cfg NMS OAM oamsys configuration Board B database Product CG6000 QUAD Keyword file ber 2 fileb cfg Bus 0 TCPFILE 0 NOCC an ae Country USA Bee Tessee esd Supervisor Aut artEnabled Yes utoStopEnabled Yes If your system contains more than one board with the same configuration you can use the same keyword file for each of these boards NMS Communications 43 Creating NMS OAM configuration files NMS OAM System User s Manual Several sample keyword files are supplied with the hardware installation Each of these files configures the board to use a different protocol for example wink start or off premises station You can reference these files in the system configuration file or
91. g reference for a board is an external signal from which it can derive a clock pulse e Configure all other boards as clock slaves so they synchronize to the clock master signal Refer to CT bus clocking overview on page 89 for more information For specifics on setting up clocking for the boards refer to the board documentation Clock Management EMC The NMS OAM service provides H 100 and H 110 bus clock management services to boards in a chassis that is connected through the bus This functionality is provided in the Clock Management EMC When the boards in a system are started the Clock Management EMC e Configures the clock on each board as specified in the NMS OAM database e Ensures that the bus clock master board the board driving the clock is running before setting the clocks on the slave boards Refer to the NMS OAM Service Developer s Reference Manual for more information about the Clock Management EMC NMS Communications 29 Starting NMS OAM Starting Hot Swap This topic describes how to start Hot Swap under the following operating system environments e Windows e Solaris e Linux Starting Hot Swap under Windows When Natural Access is installed on a host the Hot Swap manager is installed as a Windows service It is configured to be started manually as follows Action Access a command prompt on the host system Enter net start hsmgr To set the Hot Swap manager to start aut
92. gen described in System configuration file creator oamgen on page 78 28 NMS Communications NMS OAM System User s Manual Setting up an NMS OAM host To get around this problem create a text file listing the buses that these utilities must search The text file must be named nmspcinfo cfg It must be located either in the nms ctaccess cfg directory opt nms ctaccess cfg under UNIX or in the local directory from which pciscan oamgen and ctdaemon are launched In the file PCI bus numbers must appear on one line separated by semicolons and preceded by the keyword Bus Bus numbers must appear in numerical order For example Bus 0 1 2 120 169 Specify a range of consecutive bus numbers as shown here BUS ORO 1207 169 Configuring the H 100 or H 110 bus clock If the boards are connected to each other on the H 100 or H 110 bus set up a bus clock to synchronize communications between the boards connected to the bus In addition to provide redundant and fault tolerant clocking between devices on the bus configure alternative fallback clock sources to provide the clock signal if the primary source fails To configure the bus clock for a system e Configure a board to act as clock master driving the bus clock e Optional Configure another board to act as secondary clock master driving the clock if the primary clock master fails e Configure primary and secondary timing references for each clock master board The timin
93. gh a digital trunk This is called a NETWORK timing reference 90 NMS Communications NMS OAM System User s Manual H 100 and H 110 bus clocking The following illustration shows a system using a timing reference from NETWORK O g Q Clock master Clock slave Signal from Clock slave id m digital trunk Clock slave e Ina system with no digital telephone network interfaces an on board oscillator can be used as the timing reference to drive the clock signals This is called an OSC timing reference Use OSC only if there is no external clock source available The following illustration shows a system using a timing reference from OSC Clock slave z Clock master ite Clock slave Clock slave NMS Communications 91 H 100 and H 110 bus clocking NMS OAM System User s Manual NETREF The timing reference used by a clock master to drive the CT bus clock originates from an oscillator or trunk connected to another device in the system In this case the timing reference signal is carried over the CT bus to the clock master which derives the clock signal and drives the clock for the slaves The following illustration shows a system using a timing reference from another device Clock slave Clock master p aClock signals Clock
94. gsm ms g726 mf DSP C5x 0 Files qtsignal tone dtmf echo callp NULL NULL Resource 0 Name RSC1 Resource 0 Size 120 Resource 0 TCPs nocc FEFE AE HEFE FE FE FE HE FE FE FE FE FE FE HE FE FE FE EE HEE HE HE FE FE FE TE FE FE HE FE FE E TE REE HEE HE FE TE FE AE HE FE E FE HEE SE E Before modifying this resource definition string refer to the CG6000C Installation and Developers Manual HERE AE FE TE HE FE E FE TE FE FE HE FE FE FE TE HEE HE HEARERS EEE HERRERA E HEH EEE EE Resource 0 Definitions dtmf det_all amp echo 1n20_apt25 amp ptf det_2f amp tone gen amp callp gne amp ptf det_4f amp rvoice rec_mulaw amp rvoice play_mulaw rvoice rec_alaw amp rvoice play_alaw rvoice rec_lin amp rvoice play lin voice ree l6 amp vorce play 16 100 voice play_16_150 voice play_16_200 voice rec_24 amp voice play_ 24 100 voice play 24 150 voice play_24 200 N voice HSC 32 amp Wolee olay 32 100 voice pllay 32 150 voice play_32_200 voice rec_64 amp voice play_64_ 100 voice play_64_150 voice play 64 200 wave rec_11_16b amp N wave play_11_16b wave rec_11_8b amp wave play_11_8b oki rec_24 amp oki play 24 100 oki play 24 150 oki play_24 200 oki rec_32 amp oki play_32_100 oki play_32_150 oki play_32_200 ima rec_24 amp ima play_24 ima rec_32 amp ima play_32 gsm_ms frgsm_rec amp gsm_ms frgsm_play g 26 rec 32 g 26 pl
95. he board continues to drive the CT bus clock using this timing reference until the first timing reference is re established Specifies the fallback timing reference for the board to use if the primary timing reference fails The board continues to drive the CT bus clock using this timing reference until the primary timing reference is re established For the primary clock master set to any of the following e NETREF to use NETREF also called NETREF1 e NETREF2 to use NETREF2 H 110 only e NETWORK to derive the timing from the clock pulse on a digital trunk connected to the board e OSC to use the board s on board oscillator Use only when no other source is available Note The fallback timing reference must be different from the primary timing reference If Clocking HBus FallBackClockSource is set to NETWORK specifies the board trunk from which to derive the fallback timing reference 1 to n where n is the number of trunks on the board If using NETREF 1 or NETREF2 as a timing reference set to 8K NMS Communications NMS OAM System User s Manual Configuring CT bus clocking with board keywords Configuring the secondary clock master You can optionally set up a secondary clock master to drive a CT bus clock if the primary clock master stops driving its CT bus clock Use the following keywords to configure the secondary clock master Keyword Description Clocking HBus ClockMode Specifies the CT bus clock that the bo
96. he boards If t is specified tests the boards If d is specified deletes the boards from the NMS OAM database NMS Communications Other utilities Utilities overview In addition to the configuration and monitoring utilities oamsys oammon and oamcfg the following utilities are available with Natural Access software Utility Description hsmgr Runs the Hot Swap manager hsmon Monitors the Hot Swap manager hssrv Starts and coordinates the set of Hot Swap drivers Solaris only oamgen Creates a system configuration file pciscan Determines PCI and CompactPCI bus and slot locations trunkmon Displays the status of digital trunks blocate For UNIX systems associates the PCI bus assignment to a physical board by flashing an LED on the board s end bracket NMS Communications Refer to Hot Swap manager hsmgr on page 70 Hot Swap monitor hsmon on page 73 Hot Swap driver hssrv on page 76 System configuration file creator oamgen on page 78 Board locate pciscan on page 80 Digital trunk status trunkmon on page 83 AG board locate blocate on page 87 69 Other utilities NMS OAM System User s Manual Hot Swap manager hsmgr Name hsmgr Purpose Runs the Hot Swap manager Usage hsmgr options where options are Option Description C Windows only Starts the Hot Swap manager as a console application d UNIX on
97. hould serve as secondary master The CX 2000C board should act as a slave If you have more than one board of a given model assign these boards as your masters before using any boards with poorer clocking characteristics For example if your system contains two AG 4000 boards and one AG 2000 board the two AG 4000 boards should serve as primary and secondary masters The AG 2000 board should act as a Slave 100 NMS Communications 1 O System level clocking with clockdemo Running clockdemo clockdemo is an application that configures H 100 and H 110 clocks for all boards using switching commands Then it monitors for clocking changes and reconfigures clocking if clock fallback occurs or if the status of a timing reference changes clockdemo provides a robust fallback scheme that suits most system configurations Source code is included allowing you to modify the program if your clocking configuration is complex For a complete overview of H 100 and H 110 bus clocking refer to CT bus clocking overview on page 89 Name clockdemo Purpose e Configures H 100 and H 110 clocks for all boards using switching commands e Monitors for clocking changes and reconfigures clocking if clock fallback occurs or the status of a timing reference changes Usage clockdemo options where options are Option Description b n Specifies a list of boards to be managed by clockdemo Multiple boards can be specified by repeating the b o
98. iability clockdemo uses this information to determine how best to configure the boards and which boards or timing references to use in case of signal failure The timing reference priorities file is an ASCII text file In the file trunks are listed one to a line in this fashion priority board_number trunk_number where Parameter Description priority Indicates the reliability of the trunk priority is an integer between 0 best and 99 worst Trunks with equivalent reliability can be given identical priority numbers board_number Indicates the number of the board on which the trunk is located board_number is an integer between 0 and 32767 trunk_number Indicates the trunk number trunk_number is an integer between 0 and the total number of trunks supported by the board type 0 designates the board s internal oscillator OSC The values on each line are separated by spaces Any text following a number sign denotes a comment and is ignored clockdemo follows these rules when choosing primary and secondary masters and timing references for each e The system must have one and only one primary master e If possible the system should also have one and only one secondary master e The primary and secondary masters must be different boards e The primary and fallback timing references for a master board must be trunks on that board or the board s internal oscillator e Incase of a need to reconfigure clocking
99. iguration parameters When you set up your system you build text files describing the components You enter this information into the database using NMS OAM utilities such as oamsys and oamcfg Refer to Using oamsys on page 55 and oamcfg overview on page 59 for more information The following illustration shows the NMS OAM database configuration process OPPEN Utility NMS OAM onfiguration oamsys or Supervisor files fi oamcfg Plug in Boards NMS OAM database With the utilities or an application based on the NMS OAM service you use NMS OAM to configure start and manage components in the system based on the NMS OAM database The following illustration shows how an application uses configuration information NMS OAM Supervisor Application or utility NMS OAM database 1l lt gt Boards NMS Communications 13 Overview of NMS OAM NMS OAM System User s Manual You can also set up NMS OAM to configure and start boards automatically whenever it starts up without any intervention by a utility or application The following illustration shows the board auto start process NMS OAM Supervisor NMS OAM database 14 NMS Communications NMS OAM System User s Manual Overview of NMS OAM Board identification methods Within NMS OAM each board is referenced using the following identifiers e A unique name e A board number Each board in
100. imary clock Secondary clock Clock slave Clock slave master master Network board connection Drives NETREF i based on network signal Uses A_CLOCK as timing i reference Falls i back to B_CLOCK Network trunk 97 H 100 and H 110 bus clocking NMS OAM System User s Manual Board keywords If clocking is set up for the system through board keywords clock configuration keywords can be set as follows for each board Board Role Clocking keyword settings A Primary clock master Clocking HBus ClockMode MASTER_A Clocking HBus ClockSource NETREF Clocking HBus AutoFallBack YES Clocking HBus FallBackClockSource NETWORK Clocking HBus FallBackNetwork 2 B Secondary clock master Clocking HBus ClockMode MASTER_B Clocking HBus ClockSource A_CLOCK Clocking HBus AutoFallBack YES Clocking HBus FallBackClockSource NETWORK Clocking HBus FallBackNetwork 3 C Clock slave Clocking HBus ClockMode SLAVE Clocking HBus ClockSource A_CLOCK Clocking HBus AutoFallBack YES Clocking HBus FallBackClockSource B_CLOCK D Slave driving NETREF Clocking HBus ClockMode SLAVE Clocking HBus ClockSource A_CLOCK Clocking HBus AutoFallBack YES Clocking HBus FallBackClockSource B_CLOCK Clocking HBus NetRefSource NETWORK Clocking HBus NetRefSourceNetwork 4 Clocking HBus NetRefSpeed 8K Clock signal summary The following table summarizes the reference clocks that a clock master can dr
101. imultaneously on the bus They are called A_CLOCK and B_CLOCK The clock master can drive either one When you set up CT bus clocking choose one of these clocks for your master and slaves The other one is a redundant signal that can be used by a secondary clock master Refer to Secondary clock masters on page 94 for more information The following illustration shows a system using A_CLOCK as its clock reference CT bus CT bus clocks A_CLOCK B_CLOCK Clock master Clock slave Clock slave Clock slave Drives a CT bus Gets its timing Gets its timing Gets its timing clock based on reference from reference from reference from a signal from a a CT bus clock a CT bus clock a CT bus clock timing driven by a driven by a driven by a reference clock master clock master clock master A Timing reference Timing references To drive its CT bus clock a clock master takes a reference signal extracts the frequency information defines a phase reference at the extracted frequency and broadcasts this information as A_CLOCK or B_CLOCK This reference signal is called a timing reference When you set up a clock master you specify what source the board uses as its timing reference Note Not all boards support all timing references For information on the board models refer to the board documentation The timing reference signal originates in one of two places e It can originate within the public network and enter the system throu
102. installed and the Hot Swap driver and the Hot Swap manager are running To verify the Hot Swap installation Step Action 1 Create records for the components in the system in the NMS OAM database Refer to Configuration file overview on page 43 for information 2 Access a command prompt on the host system 3 Start oammon by entering oammon 4 If you open the ejector handles on a CompactPCI board messages reporting the extraction display For example Wed Sep 26 J3 55 18 HSWEVN_REMOVAL REQUESTED INFO Board 0 Name0 HotSwap notification Wed Sep 26 13 55 18 HSWEVN_BOARD_OFFLINE INFO Board 0 NameO HotSwap notification 5 When you physically remove the board the following message displays Wed Sep 26 13 55 57 HSWEVN_BOARD_REMOVED INFO Board 0 Name0 HotSwap notification 6 If you insert a CompactPCI board when board auto start is disabled messages reporting the insertion display but the board fails to start Refer to Starting boards automatically on page 53 for more information For example Wed Sep 26 13 57 11 HSWEVN_BOARD_INSERTED INFO Board 0 Name0 HotSwap notification Wed Sep 26 13 57 11 HSWEVN_ONLINE_PENDING INFO Board 0 Name0 HotSwap notification Wed Sep 26 13 57 11 HSWEVN_PREPARATION_FAILED INFO Board 0 NameO HotSwap notification Later when the board is started a Hot Swap message reporting the board start is displayed Wed Sep 26 13 54 10 HSWEVN_BOARD_ READY INFO Board 0 Name0 HotSwap notific
103. ion to specify c product Product string for the board type Refer to Displaying board product types on page 62 for information on retrieving a list of valid product name strings If product is omitted oamcfg chooses the first product name in this list PCIbus slot PCI bus and slot location of a board in the system If this option is omitted oamcfg assumes PCI bus 0 slot 0 n brdname Name to give the board If this option is omitted a default name is generated b brdno Number to give the board 0 15 If this option is omitted a default number is generated host Machine name or IP address of the resource host where the board is located If not specified oamcfg performs its operations on the host on which it is initialized The g and m options cannot be used to identify the board in this operation Refer to Command line options on page 59 Note The board must currently be physically installed in the system for its name to be added or deleted from the NMS OAM database For example the following command adds a record for a CG 6000C board located in PCI bus 0 slot 20 on resource host MyHost1 oamcfg c CG_6000C_QUAD 1 0 20 MyHost1 62 NMS Communications NMS OAM System User s Manual Using oamcfg When a record is created for a board the record includes a unique name and board number for the board You can use either of these identifiers to refer to the board in future calls To learn how to retrieve this
104. ive Clock Details A_CLOCK The set of primary bit clocks CT8A and framing signals CTFrameA The CT8A signal is an 8 MHz clocking reference for transferring data over the CT bus The CTFrameA provides a low going pulse signal every 1024 8 MHz clock cycles B_CLOCK The set of secondary bit clocks CT8B and framing signals CTFrameB The CT8B signal is an 8 MHz clocking reference for transferring data over the CT bus The CTFrameB provides a low going pulse signal every 1024 8 MHz clock cycles 98 NMS Communications NMS OAM System User s Manual H 100 and H 110 bus clocking The following table summarizes the timing references that a clock master can use Timing reference NETWORK NETREF NETREF1 NETREF2 OSC Details The timing signal from a digital trunk attached to the clock master board Within the digital trunk interface an 8 kHz reference is derived from the frequency of the incoming signal The clock master is frequency locked to this 8 kHz reference so that the long term timing of the system matches that of the public telephone network Note No timing signal is available from an analog trunk The CTNETREF_1 signal Can be 8 kHz 1 544 MHz or 8 MHz NMS recommends using only 8 kHz signals for most boards H 110 only The CTNETREF_2 signal Can be 8 kHz 1 544 MHz or 8 MHz NMS recommends using only 8 kHz signals for most boards Clock signal derived from an oscillator on the clock master bo
105. le struct Clocking contains structs Hbus and MVIP Clocking HBus ClockMode MASTER_A Clocking HBus AutoFallBack YES Clocking MVIP ClockRef SEC8K Clocking MVIP AutoFallBack NO In this example Clocking Hbus and MVIP are struct keywords 50 NMS Communications NMS OAM System User s Manual Creating NMS OAM configuration files Array keywords Many keywords are organized into arrays lists of items of the same type Each element of the array can have a unique value The index for an array keyword appears as a suffix surrounded by square brackets Each index is zero based TCPFile 0 nocc A struct can contain arrays DSPStream SignalIdleCode 0 0x00 DSPStream VoiceIdleCode 0 0x00 DSPStream SignalIdleCode 1 0x00 DSPStream VoiceIdleCode 1 0x00 It is also possible to have an array of structs Resource 0 Name RSC1 Resource 0 Size 120 Resource 0 FileName 0 myfile foo Resource 0 FileName 1 myfile2 foo Resource 0 SpanEnable AUTO Resource 1 Name RSC1 Resource 1 Size 60 Resource 1 FileName 0 myfile foo Resource 1 SpanEnable AUTO For any array keyword xxx xxx Count indicates the number of elements in the array For example Resource Count 2 xxx Count is automatically updated for each element added or removed from an array This value cannot be set directly Array keyword expansion For convenience there is a shorthand method of assigning values to keywo
106. lities a system configuration file contains a list of managed components in the system boards or software modules such as an EMC For each managed component a list is specified of parameters and values to configure that component Most of the parameters for boards are usually listed in separate keyword files referenced in the system configuration file The syntax of these files is very different from the syntax of an AG configuration file Parameters are still specified as keyword name and value pairs for example AutoStart YES However struct keywords containing multiple values and array keywords containing multiple indexed values are now supported These keywords are often specified using a special shorthand notation Keyword names are as consistent as possible across board families For more information about system configuration files refer to Creating a system configuration file on page 45 For more information about keyword files see Using board keyword files on page 48 For more information about NMS OAM equivalents for specific AG configuration file keywords refer to the board documentation NMS Communications 123 Migrating to NMS OAM ag2o0am NMS OAM System User s Manual The ag2oam utility included with NMS OAM translates AG configuration files into system configuration files and keyword files that oamsys can process To use ag2o0am Step Action 1 Go through the AG configuration file and determine the pr
107. located to segment B Uninitialized 40 NMS Communications NMS OAM System User s Manual Starting NMS OAM Some boards such as the CG 6000C board have an address space requirement of two 1 MB memory regions Since this requirement exactly matches the 1 MB granularity you cannot add more of these boards than were present at start up without rebooting The following illustration shows a PCI bus with a CG 6000C board inserted suoiBbas AJowaw gw T om Buldinbas 30009 99D Setup at boot time Slots Slots PCI bus segment A PCI bus segment B Memory at run time Address space on bridge Address space on bridge allocated to segment A allocated to segment B NMS Communications 41 5 Creating NMS OAM configuration files Configuration file overview Once you have determined the internal layout of the system create NMS OAM configuration files describing the layout Then run oamsys to initialize the NMS OAM database based on the information in the file To set up NMS OAM create a system configuration file Refer to Creating a system configuration file on page 45 for more information This file contains e A list of boards in the system e For each board the name of one or more board keyword files containing keywords and values to configure the board These settings are expressed as keyword name and value pairs Refer to Usin
108. ltiple hosts start a separate instance of oammon for each host Each instance monitors one host only Oammon command line options The following table describes the oammon command line options Option Use this option to Display a Help screen and terminate h Display a Help screen and terminate V Run in verbose mode and return extended board information s messagetext Send a test alert notification message containing text messagetext to all applications currently monitoring for alert messages for example another instance of oammon that is monitoring oammon then terminates messagetext can be any string of characters Applications receive an OAMEVN_ALERT event containing a pointer to an OAM_MSG structure containing the message text For more information about alert notification refer to the NMS OAM Service Developer s Reference Manual L Print logged messages to stdout This option is recommended for diagnostic purposes only f filename Log messages to a file named filename and to stdout This option is ignored unless the L option is also used server Monitor activity on a resource server where server is a host name or IP address If unspecified oammon monitors the local host on which it was initialized This option is ignored unless the L option is also used NMS Communications 57 Using oamcfg oamcfg overview The NMS OAM configuration utility oamcfg enables you to perform the following
109. ly Starts the Hot Swap manager as a daemon h Displays the hsmgr Help screen and terminates k UNIX only Kills previous instance of the daemon n Disables display of messages and states o log_file Specifies an output log file for messages instead of writing to standard output Description hsmgr must be running to use Hot Swap When Natural Access is installed hsmgr is installed as a service and is configured to be started manually To run on a remote host the utility must be physically resident on the remote host Use a separate third party utility such as telnet rsh or rexec to invoke the utility When debugging Hot Swap applications run hsmgr in console mode to see Hot Swap manager messages 70 NMS Communications NMS OAM System User s Manual Other utilities Procedure To run hsmgr in console mode Step 1 Action To stop any previous instance of hsmgr Under Windows a Open the Administrative Tools applet in the Control Panel The Administrative Tools window appears b Open the Services applet within this window The Services window appears c Double click on NMS HotSwap Manager The Properties window appears Click Stop Click OK Close the Services window moa g Close the Administrative Tools window Under UNIX Run the Hot Swap manager with the k option to stop any previous instance of the manager hsmgr k Start the Hot Swap manager in console mode by entering heme e
110. mber for all NMS CompactPCI boards installed in the system To run this utility on a remote host the utility must be physically resident on the remote host Use a separate third party utility such as te net rsh or rexec to invoke the utility If you have a chassis with an unusual PCI bus topology for example bus number 171 directly follows bus number 0 pciscan functions more slowly To speed up operation create a text file specifying PCI bus numbers to search Refer to Specifying PCI bus numbers for board search functions on page 28 for more information On Windows systems you can use pciscan to show the physical slot location of a specific board by flashing an LED on the board Note On UNIX systems use cg6ktoo to flash a board LED on a specific CG board as described in the CG board documentation or blocate to flash a board LED ona specific AG board Refer to AG board locate blocate on page 87 for more information 80 NMS Communications NMS OAM System User s Manual Other utilities Procedure To run pciscan enter porscan pciscan displays output similar to the following 2 11 0x50d AG_4040C_E1 2 13 0x6000 CG_6000C_QUAD There were 2 NMS PCI board s detected If the I option is specified the board configuration is also logged to an ASCII text file with the current date and time The log is created in a file named pci_cfg txt in the current working directory To flash an LED on a specific board under Windows
111. mple myfile_oamsys cfg e One or more keyword files one for each board listed in the AG configuration file This file is named oldname_Board_n cfg where oldname is the name of the AG configuration file minus the extension and n is the number of the board as it appeared in the AG configuration file For example myfile_Board_0 cfg The keyword file for each board is appropriately referenced in the system configuration file in the section describing the board Note ag20am assumes that the input AG configuration file is valid If errors exist in the input file in most cases they will be propagated in the output files 124 NMS Communications NMS OAM System User s Manual Migrating to NMS OAM Board identification changes Previously the board number was the only way of identifying a board in software This number was assigned in the AG configuration file With the NMS OAM service boards are also identified by board names The board name for a board is assigned when the record for the board is first created in the NMS OAM database You can specify the name of a board in the system configuration file you supply to oamsys Refer to Creating a system configuration file on page 45 Names are also used for other types of components such as extended management components EMCs board plug ins and the NMS OAM Supervisor itself Refer to Configuring non board objects on page 46 for more information Most NMS API software still requir
112. n NMS OAM hOSt cccceeeeeeeeeeeeeeeeeeeeeneeeeeeeeeneeeeeeeneee 23 Configuring HOt SWAP isisecneicciciies venini Nai anaa EEEN AEE EAA oxiadnteawen eed EEE S 23 Hot Swap compatible boardS ssssssssssssssssssssssrssrrrnrinrrrnrrrrrrrrrrnrrnnnnnrnnrannns 23 HOC SWAD EMC EE E EE E e a EEO E 24 Hot Swap platform requirements ccc cece eect eee eee eee eee teeta eae eee ened 25 Configuring Hot Swap under WiNdOWS cece cece cece eee cere eee eee e teen teen eees 25 Configuring Hot Swap under Solaris ceceeeee cece eee eens eee eee teeta eee ees 27 Configuring Hot Swap under L NUX ccc ccee cece e ee eee eee eee eee eats eee ee eee 27 Determining PCI bus and slot locations c cc eeeee cece eee eee eee eee teeta eee ee eae 28 Specifying PCI bus numbers for board Search fUNCtIONS ccecceeee cnet eeeeeee eens 28 Configuring the H 100 or H 110 bus ClOCK cece ece cece eee eee teste eee ees 29 Clock Management EMC cece eee eee ee eee Na 29 Chapter 4 Starting NMS OAM cccccceeeseeeeeeeeeeeeeeeeeeeeseeeeeeeeeeeaeeeeeeeeeaeeaeeeeneae 31 Starting Ol SW sng scdaarenicepaaniscenes apaa aa E E E ten nian ent E EE AEEA 31 Starting Hot Swap under WINdOWS ccceee cece eect eee e ee eee e eee e eee ee eee e neta 31 Starting Hot Swap under Solaris ceceecee cess eee e ee eee eaten eee eee eee eens 32 Starting Hot Swap under LINUX cece eee e cece eee
113. nce set to 8K NMS Communications 115 Configuring CT bus clocking with board keywords NMS OAM System User s Manual Configuring clock slaves and standalone boards Any board connected to the CT bus that is not the primary or secondary clock master must be configured as a clock slave Each clock slave derives its primary timing reference from A_CLOCK or B_CLOCK whichever is driven by the primary clock master If you have set up a secondary clock master when the primary clock master stops driving its CT bus clock the clock slaves can get their clocking information from the secondary clock master Use the following keywords to configure clock slaves Keyword Description Clocking HBus ClockMode Specifies the CT bus clock that the board drives For a clock slave set to SLAVE to indicate that the board does not drive any CT bus clock Clocking HBus ClockSource Specifies the primary timing reference for the board For each slave set to the CT bus clock driven by the primary master A_CLOCK or B_CLOCK Clocking HBus AutoFallBack Enables or disables clock fallback on the board If you have set up a secondary clock master set to YES for each slave Otherwise set to NO Clocking HBus FallBackClockSource Specifies the fallback timing reference for the board to use if the primary timing reference fails If you have set up a secondary clock master set to the timing reference driven by the secondary clock master Once a slav
114. new diagram information NMS Communications NMS OAM System User s Manual Other utilities Hot Swap monitor hsmon Name hsmon Purpose Monitors the Hot Swap manager Usage hsmon options where options are Option Description Ss Stops hsmon i PCIbus slot Inserts a board Initiates management driven insertion e PCIbus slot Extracts a board Initiates management driven extraction g PCIbus slot Gets the state of the specified slot q Terminates hsmon Displays the hsmon Help screen and terminates Description hsmon traces all messages from the Hot Swap manager Use this utility for installation verification and diagnostics To run on a remote host the utility must physically reside on the remote host Use a separate third party utility such as te net rsh or rexec to invoke the utility NMS Communications 73 Other utilities Procedure 74 Step 1 2 Action NMS OAM System User s Manual Make sure the Hot Swap manager and Hot Swap driver are running To launch the Hot Swap monitor enter hsmon Hot Swap manager messages display in this format direction destination pci_bus pci_slot hsmessage where Field direction destination pci_bus pci_slot hsmessage Insert a board Description Indicates the direction of the message gt indicates an output message lt indicates an input message Label given to an application for example hsmon or
115. nfiguration File cfg By default oamsys searches for the keyword files listed with this keyword in the same way it searches for the system configuration file itself see Running oamsys on page 55 To reference a file in another directory specify the directory along with the file name File c mydir filel cfg Keywords are set in the order in which oamsys encounters them in the files Specifying a setting for a keyword in more than one file is not recommended Note In addition to or instead of keyword file names you can specify keyword settings for a board directly in the board s section in the system configuration file Use the keyword syntax described in Specifying keywords and values on page 50 Configuring non board objects In addition to sections for boards the system configuration file can include sections containing configuration information for non board objects such as EMCs board plug ins or the NMS OAM Supervisor The section for each object is headed with the object s name in square brackets D Supervisor The object name for the NMS OAM Supervisor is Supervisor The object name for a plug in or EMC is its file name for example hotswap emc 46 NMS Communications NMS OAM System User s Manual Creating NMS OAM configuration files This name must not be preceded by or followed by spaces For example the following names are not valid Supervisor Supervisor Below each board name are keyword
116. ng status information for each board This information consists of the following e Its A_CLOCK status e Its B_CLOCK status e Whether fallback occurred or not Managed in A global structure containing the updated status of each trunk on each board clockresource c 108 NMS Communications NMS OAM System User s Manual System level clocking with clockdemo _clock_monitor does the following Step Action 1 Checks each board in swihd_array to determine whether it exists 2 Polls the status of each existing board using swiGetBoardClock This updates hi110_query_parms for the board 3 If more than 50 percent of the boards report that A_CLOCK failed includes CLKSYS_STATUS_A_FAIL in the returned clock_status 4 If more than 50 percent of the boards report that B_CLOCK failed includes CLKSYS_STATUS_B_FAIL in the returned clock_status 5 If fallback is reported by a board includes CLKSYS_STATUS_FALLBACK_OCCURRED in the returned clock_status 6 If fallback is reported by a board but there is no clock failure includes CLKSYS_STATUS_INCONSISTENT in the returned clock_status 7 If one of the trunks designated as a fallback source has failed includes CLKSYS_STATUS_REFERENCE_CHANGED in the returned clock_status 8 Updates the global structure containing the updated status of each trunk on each board _clock_control _clock_control is called at regular intervals by the while loop in the main section directly after _clo
117. ntervals by the while loop in the main section Its purpose is to determine whether a clocking change has occurred by monitoring the clocking status of each board and the status of each trunk involved in clocking It returns an integer indicating one or more of six possible states This information is used by the _clock_control function to determine whether to perform any clocking reconfiguration _clock_monitor is passed the following information Parameter Description num_of_boards Number of boards in the chassis swihd_array Array containing the handles of all boards opened in the main section of the program _clock_monitor returns the following information Parameter Description clock_status Integer indicating the type of clocking change if any e 0 No clocking change has occurred e CLKSYS_STATUS_FALLBACK_OCCURRED 0x01 Fallback has occurred e CLKSYS_STATUS_A_FAIL 0x02 A_CLOCK is no longer being driven e CLKSYS_STATUS_B_FAIL 0x04 B_CLOCK is no longer being driven e CLKSYS_STATUS_INCONSISTENT 0x08 Fallback has occurred on some boards but not all boards This can occur if the primary master is switching between its primary and fallback timing references but is still managing to drive the system clock successfully e CLKSYS_STATUS_REFERENCE_CHANGED 0x10 A_CLOCK and B_CLOCK have not failed but one of the trunks designated as a fallback source has failed h110_query_parms Updated array containing the clocki
118. oduct type for each board number For example Board 0 AG 2000 T1 Board 1 AG 2000 T1 Board 2 AG 4000C T1 2 Enter ag2oam options where options are Option f filename p m n product h Description Duplicates in the output files any comments it finds in the original file If this option is not specified comment lines are omitted Specifies the name and path if necessary of AG configuration file to translate Default is ag cfg If no path is specified ag20am searches first in the current directory and then in the paths specified with the AGLOAD environment variable Specifies the AG product type for board s m n This option can appear on the command line as many times as necessary If you do not specify board numbers the specified product types are used for all boards Refer to Displaying board product types on page 62 for more information Displays the Help screen and terminates Displays the Help screen and terminates For example with the configuration listed in step 1 enter agZoam i myfile ctg p0 1 AG 2000 _T1 p2 AG 4000C 11 If the operation is successful ag20am returns without a message ag2oam outputs the following files in the same path as the source file e A system configuration file listing all boards from the AG configuration file This file is named oldname_oamsys cfg where oldname is the name of the AG configuration file minus the extension For exa
119. of the DetectedBoards Supervisor array Use the a option to create records for detected boards in the NMS OAM database When this option is used all other options except the a option are ignored A single invocation of oamcfg can perform multiple operations by specifying more than one operation on the command line For example the following command line creates a record in the NMS OAM database for a CG 6000C board in bus 0 slot 20 displays the board s ID parameters loads keyword file cgnocc cfg replacing all existing information if any and attempts to start the board Game tg ms 00 e eGo 0 0CROUADS e E eonocenecEgmuSr ass Identifying boards in oamcfg operations To indicate the board on which oamcfg is to perform a specified operation use any of the following options Option Use this option to identify a board by b boardno Its board number g shelf slot Its shelf and slot location Only valid for boards in CompactPCI chassis with PICMG 2 1 compliant buses PCIbus slot Its PCI bus and slot location m MACaddr The MAC address of one of its Ethernet chips Only valid for boards with Ethernet capability n name Its board name For example the following command queries for information about the board in PCI bus 1 slot 14 Game ome i ag If you omit a board identification option from the command line oamcfg performs the specified operation for all boards For example the following command queries
120. ollowing command displays all ID parameters in the database oamcfg q oamcfg responds with output similar to the following NAME NUMBER BUS SLOT SHELF SLOT MAC ADDRESS PRODUCT AG_4040C_E1_2_13 0 2 13 N A 00 20 22 f 13 40 AG _4040C_E1 CG_6000C_Quad_2_10 3 2 10 31 7 00 20 22 40 08 74 CG_6000C_Quad CG_6000C_Quad_2_11 4 2 11 31 6 00 20 22 31 19 12 CG_6000C_Quad You can change the board name or number Refer to Changing board ID information on page 65 To specify keyword settings with oamcfg you can e Supply the keywords in a keyword file The information is stored in the NMS OAM database e Specify the keywords on the oamcfg command line Specifying settings in board keyword files Use the oamcfg f fname option to specify a board keyword file fname is the name of a board keyword file You can include this option more than once to specify more than one file If no board is specified oamcfg loads the keyword file for all boards The following command adds the configuration information in keyword files filea cfg and fileb cfg to the database record for board 1 gamelo b 1 filea cftg fileb cfig If you omit the path oamcfg searches for the specified files in the current directory and then the paths specified in the AGLOAD environment variable To search elsewhere specify the entire path along with the file name on the command line If you specify a file name without an extension oamcfg assumes the extension
121. omatically on a host using the Windows Control Panel follow these steps Step Action 1 Open the Administrative Tools applet in the Control Panel The Administrative Tools window appears 2 Open the Services applet within this window The Services window appears 3 Double click on NMS HotSwap Manager The Properties window appears 4 In the Startup Type drop down menu select Automatic 5 Click OK 6 Close the Services window 7 Close the Administrative Tools window Refer to Hot Swap manager hsmgr on page 70 for more information NMS Communications 31 Starting NMS OAM NMS OAM System User s Manual Starting Hot Swap under Solaris When Natural Access is installed the Hot Swap driver and Hot Swap manager are placed in the opt nms hotswap bin directory These services can be started as daemons or as console applications Note The Hot Swap manager requires the LD_LIBRARY_PATH environment variable to be set to LD_LIBRARY_PATH opt nms lib opt nms hotswap lib To start the Hot Swap applications in console mode Step Action 1 Access a command prompt on the host system If the host system is a remote host access the command prompt on the host using a separate third party utility such as telnet rsh or rexec 2 Start the Hot Swap driver by entering opt nms hotswap bin hssrv 3 Start the Hot Swap manager by entering opt nms hotswap bin hsmgr This script sets the LD_LIBRARY_PATH environment variable and s
122. operational and then stops clockdemo creates the following configuration Boards Clock Mode OF SECONDARY 38 PRIMARY tet SLAVE 2 SLAVE Current Mastering Clock Source Poo kit lek H100_A YES NETWORK 1 YES H100_A H100_A Press Vg then ENIER to Exit Now board 0 trunk 2 becomes non operational Boards Clock Mode 0 SLAVE 38 PRIMARY its SECONDARY 2 SLAVE Current Mastering Clock Source amp Clock B Clock H100_A NETWORK 1 YES H100_A YES H100_A Press q then ENTER to Exit Now board 3 trunk 1 becomes non operational Boards Clock Mode Og SECONDARY SES SLAVE ile PRIMARY 2 SLAVE Current Mastering Clock Source amp Clock B Clock NETWORK 1 YES H100_A Press q then ENTER to Exit Lastly board 1 trunk 1 becomes non operational Boards Clock Mode OFS SECONDARY SE SLAVE E PRIMARY 2 SLAVE Current Mastering Clock Source A Clock By eleck H100_A YES H100_A INTERNAL YES H100_A Press iq then ENEER tow oats NMS Communications Fallback Occurred Fallback Occurred Fallback Occurred Fallback Occurred 105 System level clocking with clockdemo NMS OAM System User s Manual clockdemo program structure clockdemo consists of the following files File Contains clockdemo c Main source code clockdemo exe Compiled executable clockresource c Auxiliary functions invoked by functions in clockdemo to manage timing reference information
123. operations e Create or delete boards in the database e Specify settings for a component s parameters either individually or collectively using board keyword files e Start or stop one or more boards e Test boards if supported e Detect boards in a system e Display basic ID information for boards e Import or export the contents of the OAM database oamcfg can perform a given operation for a single board or it can configure all boards in a single invocation Launching oamcfg To launch oamcfg enter oamcfg on the command line followed by zero or more command line options Precede each option with a hyphen or slash If the option includes data specify the data directly after the option on the command line Valid options are described in the following table Note To use oamcfg ctdaemon must be running To learn how to start ctdaemon refer to Starting the Natural Access Server on page 34 Command line options Use the b g l m and or n options to specify a board or other component for the operations If you do not specify a board or component with these options the specified operations are performed for all boards Option Use this option to host Perform the operation on resource host host host is an IP address or machine name If unspecified the operation is performed on the host on which the utility was initialized a Create a record in the NMS OAM database for a board that was automatically
124. or all AG boards installed in a UNIX system If a PCI bus and slot number is specified on the command line blocate flashes an LED on the specified board To learn which LED flashes on your board model refer to the board documentation Example Flashing all AG board LEDs To display the PCI bus and slot numbers for all AG boards in the UNIX system enter blocate The output resembles the following Thu Jul 10 15 51 22 There was 1 NMS AG PCI card s detected BUS SLOT INTERRUPT 00 14 Oxf The board configuration is also logged to an ASCII text file pci_cfg txt with the current date and time The file is created in the current working directory Example Flashing a specific board LED To flash an LED on a specific AG board in a UNIX system enter blocate pci_bus pci_slot where pci_bus and pci_slot are the PCI bus and PCI slot locations of the board For example blocate 0 14 The following message displays Flashing LED for NMS PCI board on bus 0 slot 14 The LED on the specified board flashes briefly NMS Communications 87 9 H 100 and H 110 bus clocking CT bus clocking overview If the boards in a system are connected to each other on the CT bus set up a bus clock to synchronize communications between the boards connected to the bus In addition to provide redundant and fault tolerant clocking on the bus configure alternative fallback clock sources to provide the clock signal if the primary source fails Th
125. or two other boards to drive the signals Configure a different board for each signal The source for each signal can be a digital trunk Note NETREF2 is available only in H 110 configurations Use the following keywords to configure a board to drive NETREF NETREF1 Keyword Description Clocking HBus NetRefSource Specifies the source of the NETREF NETREF1 timing reference Set to any of the following e NETWORK to drive NETREF based on the signal from a digital trunk connected to the board e STANDALONE if the board will not drive NETREF e OSC to drive NETREF using the board s oscillator for debugging purposes only Clocking HBus NetRefSourceNetwork If Clocking HBus NetRefSource is set to NETWORK specifies the number of the trunk from which to get the signal Clocking HBus NetRefSpeed Sets the speed of the NETREF signal Set to 8K Use the following keywords to configure a board to drive NETREF2 Keyword Description Clocking HBus NetRef2Source Specifies the source of the NETREF2 timing reference Set to any of the following e OSC to drive NETREF2 using the board s oscillator e NETWORK to drive NETREF2 based on the signal from a digital trunk connected to the board e STANDALONE if the board will not drive NETREF2 Clocking HBus NetRef2SourceNetwork If Clocking HBus NetRefSource is set to NETWORK specifies the number of the trunk from which to get the signal Clocking HBus NetRef2Speed Sets the speed
126. ots populated at boot time or e Have no slots populated at boot time To learn more about how to allocate space for hot swapping on Solaris systems refer to Configuring PCI bus address space for Hot Swap Solaris on page 37 Configuring Hot Swap under Linux On Linux hosts the Hot Swap kernel module allocates and de allocates memory for inserted or removed boards The NMS Hot Swap software is located in the following directory opt nms hotswap bin The libraries are located in the following directory Jopt nms lib The following command installs the Hot Swap driver kernel module and starts the Hot Swap manager as a daemon opt nms hotswap bin hsmgr_startup sh start The following command can uninstall the Hot Swap driver This command stops the Hot Swap manager if it is running opt nms hotswap bin hsmgr_startup sh stop The following command stops the Hot Swap manager opt nms hotswap bin hsmstart stop On subsequent boots of the host after the Hot Swap driver is installed the following command starts the Hot Swap manager as a daemon opt nms hotswap bin hsmstart start NMS Communications 27 Setting up an NMS OAM host NMS OAM System User s Manual Determining PCI bus and slot locations To configure the boards under NMS OAM determine the logical CompactPCI or PCI bus and slot information for each NMS board installed in the system After the boards are configured you can identify each board using m
127. page 55 Board identification methods on page 15 NMS Communications NMS OAM System User s Manual Multiple host configurations Overview of NMS OAM To set up a multiple host NMS OAM configuration follow these steps 1 Step Description Determine which systems will serve as resource hosts and which one will serve as the management host CompactPCI only Ensure that each host chassis is set up properly for Hot Swap boards Required only if you are using Hot Swap Install NMS OAM software on each host Start the Natural Access Server ctdaemon on each host if it is not already running Also start the Hot Swap driver and the Hot Swap manager Create system configuration files one for each resource host In each file give each board in the host a unique name and board number If a host contains two or more boards connected through the H 100 or H 110 bus configure clocking on the bus Use oamsys to create records for components in the NMS OAM database on each host based upon the system configuration file and to start all installed boards NMS Communications Documented in Configuring Hot Swap on page 23 Natural Access installation booklet Starting the Natural Access Server on page 34 Starting Hot Swap on page 31 Creating a system configuration file on page 45 CT bus clocking overview on page 89 Using oamsys on page 55 Board identification methods on page 15 21 3
128. pecifications in the system configuration file e Attempts to start all boards as described in the database oamsys invokes oamcfg repeatedly to perform its actions With each invocation the command line is displayed Refer to oamcfg overview on page 59 for more information Using oammon The oammon utility enables you to perform the following operations e Monitor for board errors and other messages from the OAM system e Capture these messages in a flat file oammon og e Send an alert notification message to all NMS OAM client applications Note NMS OAM utilities such as oammon can only run if ctdaemon and NMS OAM have been started Therefore oammon does not log OAM startup information OAM startup information is logged to the file startup og Refer to Logging startup events on page 37 for information To launch oammon enter oammon at the command line followed by any command line options Precede each option with a hyphen If the option includes data specify the data directly after the option on the command line Valid options are described in oammon command line options on page 57 When you invoke oammon without command line options oammon displays an interactive menu and immediately begins logging messages to a file named oammon log The oammon interactive menu appears as follows Hnter to output log fille tail based on current screen output line count Wen to change screen output line count current count is 10
129. ption on the command line ale il iy 2 lg 3 The minimum number of boards allowed is 2 In addition to the listed boards clocking for all boards listed in the file specified with the f option are managed If no boards are specified using either method clockdemo attempts to manage clocking for boards numbered 0 1 and 2 f file_name Specifies the name of a text file containing a list of available timing references prioritized by their reliability For more information about this file refer to Creating a timing reference priorities file on page 103 In addition to the boards listed in the file clocking for all boards listed using the b option are managed d Turns on debug messages showing clocking status t m_sec Specifies the rate in ms at which clockdemo polls the boards for clocking status changes Default is 2000 h Displays a Help screen and terminates NMS Communications 101 System level clocking with clockdemo NMS OAM System User s Manual Description clockdemo configures H 110 H 100 clocking for all specified boards It then monitors the boards and board trunks and reconfigures clocking if events occur that jeopardize or interrupt the clock pulse clockdemo is given a text file listing boards to manage Also listed are digital trunks on these boards from which a clock master can derive a timing reference In the file the trunks are rated in order of reliability Based on this file clockdemo assigns the
130. ration shows NMS OAM host components Management host A Applications Utilities oamcfg oamsys Configuration files Database Resource host A NMS OAM Managed object Board A Managed object Board B Resource host AJ Managed object Board plug in Managed object Hot Swap EMC Hot Swap EMC Managed object Clock Mgmt EMC Clock Managed object NMS OAM Supervisor If a management host includes resources that require management the management host can also serve as a resource host In this case the management host also must run an instance of the Natural Access Server ctdaemon including NMS OAM The database on this host contains information about the local resources only even if the management host is also managing other resource hosts 18 NMS Communications NMS OAM System User s Manual Overview of NMS OAM The utilities on the management host are used to configure the database on each resource host one database at a time The following illustration shows configuring the NMS OAM database on a resource host r Management host Configuration Utilities files uo ewoyu uo1 e4n uop Resource host A Resource host B ctdaemon ctdaemon NMS OAM H NMS OAM i Supervisor Supervisor NMS OAM databas
131. rds in an array Multiple keyword names can be assigned the same value in a single line as follows Statement Expanded equivalent keyword 0 2 value keyword 0 value keyword 1 value keyword 2 value keyword 0 2 value same as previous row keyword 1 3 5 value keyword 1 value keyword 3 value keyword 5 value keyword 0 3 5 7 9 value keyword 0 value keyword 1 value keyword 2 value keyword 3 value keyword 5 value keyword 6 value keyword 7 value keyword 9 value NMS Communications 51 Creating NMS OAM configuration files NMS OAM System User s Manual A separate range can be specified for each keyword array index in the name Statement Expanded equivalent kywd1 1 kywd2 1 2 value kywd1 1 kywd2 1 value kywd1 1 kywd2 2 value value value value value value value kywd1 1 3 kywd2 1 2 value kywdi 1 kywd2 1 kywd1 1 kywd2 2 kywd1 2 kywd2 1 kywd1 3 kywd2 1 kywd1 3 kywd2 2 kywd1 2 kywd2 2 Multiple values for keywords in an array can be specified on a single line separated by spaces To include spaces in a value surround the value with quotation marks Values are assigned to keywords in numerical order starting with 0 The array keyword is specified without the square brackets or index value for example Resource for Resource x Statement Expanded equivalent keyword vali val2 vali val4 keyword 0 valli
132. ress space requirements are small enough For example if a board requires two 128K memory regions and a CompactPCI bus segment contains only one of these boards at boot time hot insertion of up to three additional boards into that segment can be accommodated The following illustration shows a PCI bus with a 256K board inserted a Setup at boot time e Yio RE 3 a 3 X ox lt 3 6 o gt as O Q F o oO Slots Slots PCI bus segment A PCI bus segment B Memory at run time Address space on bridge Address space on bridge allocated to segment A allocated to segment B Uninitialized NMS Communications 39 Starting NMS OAM NMS OAM System User s Manual However if an 8 slot segment has four slots occupied at boot time with the boards no more boards can be hot inserted into that segment because four boards occupy exactly one megabyte of address space The following illustration shows a PCI bus with four 256K boards inserted Setup at boot time suolBbas AJOWaW Y8ZT OM Buldinbas Z pieog Idd suolBbas AJOWSW Y8ZT OM Buluinbas A pseog Idd suolBbas AJOWSW Y8ZT Om Buluinbes XY pseog Dd suol AJOWAaW Y 8ZT OM Huluinbas M pseog Idd Slots Slots PCI bus segment A PCI bus segment B Memory at run time Address space on bridge Address space on bridge allocated to segment A al
133. s the new configuration specified by _clock_control e If any of the parameters do not match reconfigures the boards as specified in h110_parms 2 If action is CLKSYS_ACTION_NEW_PRIMARY and the board number of the primary master has changed e Sets all boards to standalone mode e Configures the primary master as specified in h110_parms e Configures the secondary master as specified in h110_parms e Configures the slaves as specified in h110_parms 3 If action is CLKSYS_ACTION_NEW_PRIMARY and the board number of the primary master has NOT changed e Configures the primary master as specified in h110_parms 4 If action is CLKSYS_ACTION_NEW_SECONDARY e Reconfigures the old secondary master as a slave as specified in h110_parms e Configures the new secondary master as specified in h110_parms 5 If action is CLKSYS_ACTION_RELOAD_PRIMARY_FALLBACK e Gets the primary master s old configuration and reloads it Does not disturb other boards NMS Communications 111 1 1 Configuring CT bus clocking with board keywords Limitations of clock configuration with board keywords You can configure clocking in a system by specifying each board s role in the board s record in the NMS OAM database using keywords Configuring clocking in this manner is best if you do not want to implement clock fallback in your system or in test configurations where clock reliability is not a factor Otherwise for maximum system
134. s Slots PCI bus segment A PCI bus segment B Address space on bridge Address space on bridge allocated to segment A allocated to segment B Boards can be hot inserted only into slots for which memory has been preallocated Memory is usually allocated as follows e If any devices are physically installed at boot time the bridge windows are initialized to be just big enough to span the address spaces that have been allocated to these devices behind the bridge In this case boards can be hot inserted only into slots that were populated at boot time This is true unless the boards can fit into leftover allocated space as described below e If no devices are physically installed at boot time a single large bridge window is initialized that can accommodate any number of boards that can fit into it This window is 16 MB under Windows 64 MB under Solaris To maximize the number of slots available for hot swapping you should have all slots populated at boot time or have no slots populated at boot time 38 NMS Communications NMS OAM System User s Manual Starting NMS OAM Using leftover allocated space Usually each address space window cannot be less than 1 MB in size If allocations to boards behind the bridge do not add up to an integral number of megabytes some fraction of a megabyte will be available in the window and unallocated This unallocated space is then available for insertion of additional boards whose add
135. s are not reported to the application Also the application can receive unexpected service API errors NMS Communications 53 Using oamsys and oammon Using oamsys Use the oamsys utility to set up the NMS OAM database based upon parameter values specified in a system configuration file This utility e Stops any currently operating boards e Creates records for board components in the NMS OAM database based on a system configuration file you supply Any existing board specific data in the database is deleted and replaced with the contents of the system configuration file Refer to Configuration file overview on page 43 for more information e Configures non board components Refer to Configuring non board objects on page 46 for more information e Attempts to start all boards To perform its tasks the oamsys utility makes multiple calls to the oamcfg utility Refer to oamcfg overview on page 59 for more information To use oamsys ctdaemon must be running To learn how to start Natural Access in this mode refer to Starting the Natural Access Server on page 34 To configure and start up boards on multiple systems run oamsys once for each system specifying the target system on the command line oamsys can configure only one system at a time Running oamsys To launch oamsys enter oamsys options where options are Option Use this option to f filename Specify the file name and path if necess
136. settings specified as described in Specifying keywords and values on page 50 For example Supervisor AutoStartEnabled Yes AutoStopEnabled Yes The File statement can also be used to specify a keyword file containing settings for the object Supervisor File supvparms cfg To learn what keywords can be set for board plug ins refer to the board specific documentation To learn what keywords can be set for EMCs or the NMS OAM Supervisor refer to the NMS OAM Service Developer s Reference Manual Sample configuration file The following system configuration file describes two CG 6000C boards one at PCI bus 0 slot 20 and the other at PCI bus 0 slot 21 The first board is assigned keyword file a6wnk cfg which sets up the board to use the wink start protocol The second board uses keyword file a6ops cfg which sets up the board to use the off premises station protocol Supervisor keywords are set to start the boards automatically when the system boots or when they are Hot Swap inserted and to stop automatically when the system shuts down This is the NMS OAM system configuration file It describes all the boards in my system My board Product CG_6000C_QUAD Number 1 Bus 0 Slot 20 File 6wnk cfg Wink Start protocol My other board Product CG_6000C_QUAD Number 2 Bus 0 Slot 21 File 6ops cfg Off Premises Station protocol Supervisor AutoStartEnabled Yes AutoStopEnabled Yes To start
137. stop automatically set the AutoStart or AutoStop keywords to Yes AutoStart and AutoStop are set to No by default Set the Supervisor keywords AutoStartEnabled or AutoStopEnabled to Yes These keywords enable auto starting or auto stopping of all boards whose AutoStart or AutoStop keywords are set to Yes You can set Supervisor keywords directly in the system configuration file as shown in the following example Supervisor AutoStartEnabled Yes AutoStopEnabled Yes Consider the following information when automatically starting and stopping boards Your application must not attempt to access a board before its start process is completed An application can determine that a board is completely started by monitoring for OAM board start done events To learn more about NMS OAM events refer to the NMS OAM Service Developer s Reference Manual When boards are started the Clock Management EMC or a clock management program such as clockdemo can alter the state of the board s clocking based upon board configurations As a result certain clock dependent functionality is not immediately available to an application following the board start done event To determine when functionality is available an application can receive and interpret clocking events Refer to Running clockdemo on page 101 for more information If ctdaemon is stopped while an application is running the boards are no longer accessible using NMS OAM NMS OAM board event
138. t ALT F1 to reset Monitor start time State Kow w Z Ss CAROR 210 Onl Type Slips Errors Receives Transm ESERE Trunk 0 Trunka Trunk 2 Trunk 3 G3 NONE E7 NONE NMS Communications NT 0 0 12 12 1 0 ee 0 0 0 0 0 0 TE 0 0 12 al 1 0 DE 0 0 0 0 0 0 85 Other utilities NMS OAM System User s Manual The following table explains the trunkmon output for BRI trunks trunkmon display BRI trunks Description State Activation deactivation layer 1 state machine ITU T 1430 F1 F8 TE trunks G1 G4 NT trunks NONE All others Type Indicates how stack on trunk was initialized NT Stack initialized as NT TE Stack initialized as TE Stack not initialized on this trunk Slips Slips accumulator Errors Errors accumulator Receives Indicates bytes received Transmits Indicates bytes transmitted B1 Shows if there is communication currently on the B1 channel B2 Shows if there is communication currently on the B2 channel 86 NMS Communications NMS OAM System User s Manual Other utilities AG board locate blocate Name blocate Purpose For UNIX systems associates the PCI bus assignment to a physical board by flashing an LED on the board Usage blocate options where options are Description pci_bus pci_slot Specifies the PCI bus and slot location of the AG board on which to flash an LED Description If no options are specified blocate displays the PCI bus and PCI slot number f
139. t support Hot Swap it is permanently in this state NMS Communications 125 Migrating to NMS OAM NMS OAM System User s Manual e Hot Swap state names have changed to be closer to their SNMP equivalents Old state name New state name NOT PRESENT Extracted OFFLINE OffLine PREPARATION OnLinePending PREPARATION FAILED Failed RUNNING OnLine DOWNING OffLinePending none Unsupported e The Hot Swap Developer s Manual is now obsolete For Hot Swap runtime information refer to the Hot Swap topics in the manual you are currently reading For Hot Swap developer information refer to the NMS OAM Service Developer s Reference Manual Tracing changes Previously AG driver trace messages were displayed by agmon or retrieved using the AGM library API The debug mask was set using agmon s x command line option or using agtrace or the AGM library The CG driver was not supported With NMS OAM AG and CG driver trace messages are displayed by the oammon monitoring utility or retrieved through the Natural Access queue The debug mask is set using agtrace Trace messages are also logged to agpierror log Under Windows this file can be found in nms oam log Under UNIX it is stored in opt nms oam log This file is formatted in the same way as the agerror og file generated with agmon Use dectrace to decode ISDN information from this file as follows dectrace f nms oam log agpierror log gt mytrace txt A large amount of data is
140. tarts the Hot Swap manager in console mode To start the Hot Swap applications as daemons Step Action 1 Access a command prompt on the host system If the host system is a remote host access the command prompt on the host using a separate third party utility such as telnet rsh or rexec 2 Start the Hot Swap driver in daemon mode by entering opt nms hotswap bin hssrv d 3 Ensure that the LD_LIBRARY_PATH environment variable is set to LD_LIBRARY_PATH opt nms lib opt nms hotswap lib 4 Start the Hot Swap manager in daemon mode by entering opt nms hotswap bin hsmgr d To run the services in daemon mode at boot time recommended edit the etc inittab file to include lines that set the LD_LIBRARY_PATH environment variable and then start the Hot Swap driver and Hot Swap manager In this case do not include the d command line option For more information about the inittab file refer to the UNIX administrator manuals Refer to Hot Swap driver hssrv on page 76 and to Hot Swap manager hsmgr on page 70 for more information 32 NMS Communications NMS OAM System User s Manual Starting NMS OAM Starting Hot Swap under Linux When Natural Access is installed the Hot Swap driver and Hot Swap manager are placed in the opt nms hotswap bin directory The Hot Swap manager service can be started as a daemon or as a console application Note The Hot Swap manager requires the LD_LIBRARY_PATH environment variable to be s
141. the label for querying a board for example QSlotI CompactPCI bus and slot location Hot Swap manager message indicating the Hot Swap state or message The following messages appear HSM_BOARD_PHYSICALLY_ INSERTED HSM_PO_SO Board is inserted HSM_BOARD_CONFIGURED SM_SO_S1 Board is configured HEM eil eli Device instances ercated HSM_PREPARE_BOARD HSM_S1I_S1B Board preparation requested HSM_S1B_S2 Board is ready HSM_BOARD_READY If the Hot Swap manager does not properly detect the board the final two lines of Hot Swap messages shown in each of the previous examples are replaced by the following HSM_S1B_S1BF Failed to prepare board Enter s to stop the Hot Swap monitor The following messages display Stopping monitor monitor stopped Enter q to quit NMS Communications NMS OAM System User s Manual Other utilities Board extraction messages When you remove a CG board hsmon displays the following messages Board type Action and messages CG 6000C Flip board handles CG 6100C and CG 6500C SM_BOARD_EXTRACTION_CONFIGURED HSM_EXTRACT_PENDING boards HSM_S2_S2R Handle is opened HSM_BOARD_EXTRACTION_UNCONFIGURED HSM_DRIVER_NO_CHANNELS HSM_S2R_S1U Board UNpreparation requested HSM_UNPREPARE_ BOARD HSM_BOARD_ STOPPED HSM_S1U_SO Extraction is authorized Physically extract board HSM _BOARD_PHYSICALLY_EXTRACTED HSM_SO_PO Board is extracted CG 6565C Flip board handles HSM_BOAR
142. ts is a bit mask indicating how the test is performed If no board is specified oamcfg attempts to start testing on all boards in the NMS OAM database Testing is started on the boards in numerical order of board numbers Note Currently only CG boards support testing Testing can interrupt current board activities For this reason do not use a board for any other operations during testing 66 NMS Communications NMS OAM System User s Manual Using oamcfg After attempting to start the board tests oamcfg waits by default until all board test start attempts succeed or fail reporting results to stdout and oammon To avoid this wait use the i option oamcfg n myboard t 0x80000301 i If the i option is used results are still available The results come asynchronously encapsulated in NMS OAM events which oammon can receive and display Importing and exporting configurations You can export the contents of the NMS OAM database to a file and then import the file into the NMS OAM database on another system This feature is useful for setting up multiple identical systems Note Only the entire contents of a database can be exported Importing a database file completely obliterates and replaces all data in an existing database To export the contents of a configuration database invoke oamcfg with the export filename option where filename is the output file to create oamcfg export myfile cfg oamcfg exports a snapshot of the
143. words NMS OAM System User s Manual Configuring the primary clock master The primary clock master drives a CT bus clock used as the primary timing reference by all other boards connected to the CT bus Use the following keywords to configure the primary clock master Keyword Clocking HBus ClockMode Clocking HBus ClockSource Clocking HBus ClockSourceNetwork Clocking HBus AutoFallBack Clocking HBus FallBackClockSource Clocking HBus FallBackNetwork Clocking HBus NetRefSpeed 114 Description Specifies the CT bus clock that the board drives For the primary clock master specify e MASTER_A for A_CLOCK e MASTER_B for B_CLOCK Specifies the primary timing reference for the board For the primary clock master set to any of the following e NETREF to use NETREF also called NETREF1 e NETREF2 to use NETREF2 H 110 only e NETWORK to derive the timing from the clock pulse on a digital trunk connected to the board e OSC to use the board s on board oscillator Use only when no other source is available If Clocking HBus ClockSource is set to NETWORK specifies the board trunk to derive the primary timing reference from 1 to n where n is the number of trunks on the board Enables or disables clock fallback on the board When set to YES specifies that the board automatically switches to the Clocking HBus FallBackClockSource timing reference when the Clocking HBus ClockSource timing reference fails T
144. xamines h110_parms and returns indices to the boards in the array configured as primary and secondary master _find_master also determines which clock A_CLOCK or B_CLOCK is being used as the primary system clock If the primary clock A_CLOCK or B_CLOCK has failed e Calls __choose_new_primary to choose a new primary master based on the configuration file e Calls _choose_new_secondary to choose a new secondary master based on the configuration file e Updates the hii0_parms array describing the new system wide configuration e Includes CLKSYS_ACTION_NEW_PRIMARY and CLKSYS_ACTION_NEW_SECONDARY in the returned action If the primary clock A_CLOCK or B_CLOCK is functional but the secondary clock B_CLOCK or A_CLOCK failed e Calls _choose_new_secondary to choose a new secondary master based on the configuration file e Updates the hi10_parms array to describe a new configuration in which the old secondary master is now a Slave e Includes CLKSYS_ACTION_NEW_SECONDARY in the returned action If CLKSYS_STATUS_INCONSISTENT was returned by _clock_monitor e Updates the hi10_parms array to describe a configuration in which all secondary master and slave boards reporting clock inconsistency are reloaded with their current configurations e If the primary master reported an inconsistency selects a new fallback source for the primary master e Includes CLKSYS_ACTION_RELOAD in the returned action If CLKSYS_STATUS_REFERE
145. xample the following names are not valid Myboard Myboard Note Board names must be unique within a system configuration file Below each board name are statements that apply to the board Each statement appears on its own line Each statement consists of a keyword name followed by an equal sign and then a value keyword_name value NMS Communications 45 Creating NMS OAM configuration files NMS OAM System User s Manual Mandatory statements In the section for each board the following statements must appear Keyword Description Product Name of the board product To learn how to retrieve a list of valid strings to use refer to Displaying board product types on page 62 Number Board number Use any integer from 0 to 32767 Each board s number must be unique Bus PCI bus number The bus slot location for each board must be unique Slot PCI slot number The bus slot location for each board must be unique Board keyword sections To specify a keyword file for the board use the File keyword File myfile cfg You can specify more than one keyword file Specify the file names on a single line following the File keyword separated by a space File filel cfg file2 cfg file3 cfg Alternatively you can specify multiple File keywords one to a line File filel cfg File file2 cfg File file3 cfg To include embedded spaces in a file name surround the name with quotation marks File My Co
146. y run oamsys to configure and start the boards in the system based on sample cfg Alternatively you can modify sample cfg to suit your configuration before running oamsys For more information about system configuration files refer to Creating a system configuration file on page 45 For more information about oamsys refer to Using oamsys on page 55 78 NMS Communications NMS OAM System User s Manual Other utilities If you have a chassis with an unusual PCI bus topology for example bus number 171 directly follows bus number 0 oamgen functions more slowly To speed up operation create a text file specifying PCI bus numbers to search Refer to Specifying PCI bus numbers for board search functions on page 28 for more information Note Wink start protocol keyword files are installed on your system only if one of the countries you chose during software installation is the United States If the sample cfg file output by oamgen calls for a wink start protocol keyword file modify sample cfg or install the wink start protocol keyword files before running oamsys The following example is a typical sample cfg file generated by oamgen sample cfg Sample OAM configuration file generated by oamgen based on the NMS boards found in this chassis To boot the NMS boards in this chassis use the command oamsys f sample cfg You may need to modify the keyword configuration files on the File XXXX cfg lines to suit your needs Product
147. ys utility makes multiple calls to the oamcfg utility Use oamsys to set up both local and remote configurations Refer to Using oamsys on page 55 for more information NMS Communications 11 Overview of NMS OAM NMS OAM System User s Manual oamcfg oamcfg provides access to individual NMS OAM configuration functions Using this utility you can e Create or delete boards in the database e Specify settings for a component s parameters either individually or collectively using keyword files e Start or stop one or more boards e Test boards if supported e Detect boards in a system e Display basic ID information for boards e Import or export the contents of the NMS OAM database oamcfg can perform one or more operations for a single component Alternatively the utility can perform operations on all board components in the database with one call All oamcfg operations can be performed on both local and remote resources Use oamcfg to update components oamcfg can be cumbersome if you use it to update many components in a complex system Use oamsys for this purpose Refer to oamcfg overview on page 59 for more information oammon The oammon utility enables you to access NMS OAM monitoring functions Using oammon you can e Monitor board errors and other messages e Capture messages in a flat file e Send atest alert notification message to all NMS OAM client applications oammon can monitor both local and remote resources R

NMS OAM System User`s Manual

Contents

Download Pdf Manuals

Related Search

Related Contents