Page 1
78-4025693-01 Rev D
Prisma II Hybrid Amplifier
Installation Guide
Page 2
Page 3
For Your Safety
Explanation of Warning and Caution Icons
Avoid personal injury and product damage! Do not proceed beyond any symbol
until you fully understand the indicated conditions.
The following warning and caution icons alert you to important information about
the safe operation of this product:
You may find this symbol in the document that accompanies this product.
This symbol indicates important operating or maintenance instructions.
You may find this symbol affixed to the product. This symbol indicates a live
terminal where a dangerous voltage may be present; the tip of the flash points
to the terminal device.
You may find this symbol affixed to the product. This symbol indicates a
protective ground terminal.
You may find this symbol affixed to the product. This symbol indicates a
chassis terminal (normally used for equipotential bonding).
You may find this symbol affixed to the product. This symbol warns of a
potentially hot surface.
You may find this symbol affixed to the product and in this document. This
symbol indicates an infrared laser that transmits intensity-modulated light
and emits invisible laser radiation or an LED that transmits intensitymodulated light.
Important
Please read this entire guide. If this guide provides installation or operation
instructions, give particular attention to all safety statements included in this guide.
Page 4
Notices
Tr ademark Acknowledgments
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its
affiliates in the U.S. and other countries. To view a list of cisco trademarks, go to this
URL: www.cisco.com/go/trademarks.
Third party trademarks mentioned are the property of their respective owners.
The use of the word partner does not imply a partnership relationship between
Cisco and any other company. (1110R)
Publication Disclaimer
Cisco Systems, Inc. assumes no responsibility for errors or omissions that may
appear in this publication. We reserve the right to change this publication at any
time without notice. This document is not to be construed as conferring by
implication, estoppel, or otherwise any license or right under any copyright or
patent, whether or not the use of any information in this document employs an
invention claimed in any existing or later issued patent.
Copyright
© 2008-2011, 2012 Cisco and/or its affiliates. All rights reserved. Printed in the United
States of America.
Information in this publication is subject to change without notice. No part of this
publication may be reproduced or transmitted in any form, by photocopy,
microfilm, xerography, or any other means, or incorporated into any information
retrieval system, electronic or mechanical, for any purpose, without the express
permission of Cisco Systems, Inc.
Page 5
78-4025693-01 Rev D iii
Contents
Important Safety Instructions ix
Laser Safety xix
Chapter 1 Module Introduction 1
Hybrid Amplifier Description ................................................................................................ 3
Hybrid Amplifier Features ........................................................................................ 3
Hybrid Amplifier Operation ..................................................................................... 3
Hybrid Amplifier Optical Output ............................................................................ 3
Laser Warning ............................................................................................................. 3
Hybrid Amplifier Module Block Diagram .............................................................. 4
Hybrid Amplifier Front and Back Panel ............................................................................... 5
Hybrid Amplifier Illustration (Front and Back) ..................................................... 5
Hybrid Amplifier Front Panel Features ................................................................... 5
Back Panel Connectors ............................................................................................... 6
Module Configuration ............................................................................................................ 7
Configuration and Monitoring Methods ................................................................. 7
Chapter 2 Module Installation 9
Preparing for Installation ...................................................................................................... 10
Unpacking and Inspecting the Module ................................................................. 10
Equipment and Tools Needed ................................................................................ 10
Site Requirements .................................................................................................................. 11
Access Requirements ................................................................................................ 11
Equipment Rack ........................................................................................................ 11
Operating Environment ........................................................................................... 11
Power Requirements ................................................................................................ 11
Space Requirements ................................................................................................. 12
Chassis Style .............................................................................................................. 12
Front-Access Chassis - Front Panel Illustration .................................................... 12
Rear-Access Chassis - Front Panel Illustration ..................................................... 13
Installing the Module in the Chassis ...................................................................................
14
To Install the Module ............................................................................................... 14
To Enable Optical Output ........................................................................................ 15
Cleaning Optical Connectors ............................................................................................... 20
Introduction ............................................................................................................... 20
Recommended Equipment ...................................................................................... 20
Tips for Optimal Fiber Optic Connector Performance ........................................ 20
Page 6
Contents
iv 78-4025693-01 Rev D
To Clean Optical Connectors .................................................................................. 21
Fiber Optic Connector Cleaning Instructions ....................................................... 21
Connecting Optical Cables ................................................................................................... 24
To Connect Cable ...................................................................................................... 24
External Alarms Connections ............................................................................................... 25
Master-Slave Operation ........................................................................................... 25
ALARMS IN and ALARMS OUT Connections .................................................... 25
Master-Slave Illustration .......................................................................................... 26
ALARMS IN Connector ........................................................................................... 26
ALARMS OUT Connector ....................................................................................... 26
Prisma II Redundancy Interface Panel ................................................................................ 27
Chapter 3 Operation Using CLI 29
Prisma II Platform Configuration ........................................................................................ 30
Using the CLI .......................................................................................................................... 31
CLI Overview ............................................................................................................ 31
CLI Command Modes .............................................................................................. 31
Command Syntax ..................................................................................................... 33
Command Hints and Help ...................................................................................... 35
Login and Logout ..................................................................................................... 36
Module Commands ............................................................................................................... 38
Overview .................................................................................................................... 38
Alarm Command ...................................................................................................... 39
Show Command ........................................................................................................ 40
Info Command .......................................................................................................... 42
Reset Command ........................................................................................................ 45
Set Command ............................................................................................................ 45
ICIM Commands.................................................................................................................... 48
Alarm Command ......................................................................................................
48
Info Command .......................................................................................................... 48
Show Command ........................................................................................................ 50
Set Command ............................................................................................................ 52
User Command ......................................................................................................... 53
IPRoute Command ................................................................................................... 54
Reboot Command ..................................................................................................... 55
Traps Command ....................................................................................................... 55
Terminal Commands ............................................................................................................. 56
Overview .................................................................................................................... 56
Colsep Command ..................................................................................................... 56
Paging Command ..................................................................................................... 57
Pattern Command ..................................................................................................... 60
Headers Command ................................................................................................... 61
Show Command ........................................................................................................ 62
Page 7
Contents
78-4025693-01 Rev D v
Chapter 4 Operation Using ICIM 63
ICIM Introduction .................................................................................................................. 65
Laser Warning ........................................................................................................... 65
ICIM Function ........................................................................................................... 66
ICIM Block Diagram ................................................................................................. 66
ICIM Front Panel .................................................................................................................... 67
ICIM2 Illustration (Front Panel) ............................................................................. 67
ICIM2 Front Panel Features ..................................................................................... 67
ICIM2 LCD ................................................................................................................. 68
ICIM Keypad ............................................................................................................. 69
ICIM Password ....................................................................................................................... 70
Password Protection System ................................................................................... 70
To Access the Password Menu ............................................................................... 70
Expired Password or Inactive Password Messages ............................................. 71
To Enter the User Password .................................................................................... 71
To Change the User Password ................................................................................ 72
To Disable the User Password using ICIM ........................................................... 73
Operating the ICIM ............................................................................................................... 75
Using the ICIM .......................................................................................................... 75
Accessing the ICIM LCD Contrast ......................................................................... 75
ICIM MAIN Menu .................................................................................................... 75
ICIM MAIN Menu Illustration ............................................................................... 76
Prisma II ICIM Menu ................................................................................................ 76
Prisma II MAIN Menu and ICIM Menu Structure ............................................... 77
Hybrid Amplifier Software Menu Structure ......................................................... 78
Checking the Operating Status using the ICIM ................................................................. 79
To Check Operating Status using the ICIM .......................................................... 79
STATUS Menus ......................................................................................................... 80
Configuring the Module using the ICIM ............................................................................
81
To Configure Parameters using the ICIM ............................................................. 81
CONFIG Menus ........................................................................................................ 82
Hybrid Amplifier Service Mode ............................................................................. 82
To Change Service Mode on the Hybrid Amplifier ............................................. 83
Checking Alarms using the ICIM ........................................................................................ 84
To Check Alarms using the ICIM ........................................................................... 84
To View Active User Alarms ................................................................................... 85
To Set Adjustable Alarm Thresholds using the ICIM .......................................... 85
To Check Alarm Thresholds .................................................................................... 86
Alarm Threshold Menus .......................................................................................... 86
To View Active Module Alarms ............................................................................. 87
Module Alarm Menus .............................................................................................. 87
Checking Manufacturing Data using the ICIM ................................................................. 88
To Check Manufacturing Data ................................................................................ 88
MFG. DATA Menus ................................................................................................. 89
Saving the Configuration using the ICIM .......................................................................... 90
To Save the Current Configuration ........................................................................ 90
Page 8
Contents
vi 78-4025693-01 Rev D
Configuration Complete .......................................................................................... 90
SNMP Configuration ............................................................................................................. 91
SNMP Considerations .............................................................................................. 91
Basic SNMP Setup..................................................................................................... 91
To Set Up the IP Configuration Parameters for SNMP Support using
ICIM ......................................................................................................................... 92
To Restart the ICIM by Removing the ICIM ......................................................... 93
Community Strings ............................................................................................................... 94
Default Community Strings .................................................................................... 94
Setting SNMP Trap Receiver Parameters ........................................................................... 95
To Set Traps for a Specific IP Address using P2TrapRecvEntry ........................ 95
New SNMP Variables ............................................................................................................ 96
Table of Inserted Modules ....................................................................................... 96
Table of Removed Modules ..................................................................................... 96
Previous IP Address ................................................................................................. 97
Boot Dialog for ICIM/SNMP Configuration ..................................................................... 98
To Prepare to Change Parameters .......................................................................... 99
To Change Parameters ........................................................................................... 100
To Restart the ICIM using ICIM ........................................................................... 101
Adjusting Alarm Thresholds .............................................................................................. 102
To Adjust Alarm Thresholds ................................................................................. 102
Chapter 5 Operation Using LCI 103
LCI Introduction .................................................................................................................. 104
Laser Warning ......................................................................................................... 104
LCI Function ............................................................................................................ 104
System Requirements .......................................................................................................... 105
Computer Requirements ........................................................................................ 105
Cable Requirements ................................................................................................ 105
Installing LCI ........................................................................................................................ 106
To Install the LCI Software .................................................................................... 106
Connecting Your Computer to the Chassis ...................................................................... 110
To Connect the Computer to a Prisma II Chassis............................................... 110
Starting LCI Software .......................................................................................................... 111
To Start LCI Software ............................................................................................. 111
LCI Module Tree .................................................................................................................. 113
Introduction ............................................................................................................. 113
Module Tree ............................................................................................................. 113
Accessing Module Details ................................................................................................... 114
Module Details Window ........................................................................................ 114
Checking the Operating Status .......................................................................................... 115
To Check Operating Status using LCI ................................................................. 115
Configuring the Module using LCI ................................................................................... 117
To Configure Parameters using LCI .................................................................... 117
Page 9
Contents
78-4025693-01 Rev D vii
Checking the Module Alarms using LCI .......................................................................... 119
To Check Alarms using LCI .................................................................................. 119
Modifying Module Alarm Limits using LCI .................................................................... 121
To Modify Alarm Limits using LCI ...................................................................... 121
Checking Manufacturing Data using LCI ........................................................................ 123
To Check Manufacturing Data using LCI ........................................................... 123
Chapter 6 Maintenance and Troubleshooting 125
Module Maintenance ........................................................................................................... 126
Recommended Maintenance ................................................................................. 126
Maintenance Record ............................................................................................... 126
General Troubleshooting Information .............................................................................. 127
Introduction ............................................................................................................. 127
Equipment Needed ................................................................................................. 127
Additional Assistance ............................................................................................ 127
Troubleshooting ...................................................................................................... 127
Troubleshooting Alarm Conditions .................................................................................. 128
Amplifier Alarm Conditions ................................................................................. 128
Chapter 7 Customer Support 129
Appendix A Prisma II Permitted CLI Commands 131
From CLI ............................................................................................................................... 132
From ICIM............................................................................................................................. 133
From */* MODULE ............................................................................................................. 139
From TERMINAL ................................................................................................................ 142
Appendix B Module Parameter Descriptions 143
Hybrid Amplifier Parameters ............................................................................................ 144
Hybrid Amplifier Operating Status Parameters ................................................ 144
Hybrid Amplifier Configurable Parameters ....................................................... 145
Hybrid Amplifier Alarm Data Parameters ......................................................... 145
Hybrid Amplifier Manufacturing Data Parameter Examples .......................... 147
Glossary 149
Index 155
Page 10
Page 11
Important Safety Instructions
78-4025693-01 Rev D ix
Important Safety Instructions
Read and Retain Instructions
Carefully read all safety and operating instructions before operating this equipment,
and retain them for future reference.
Follow Instructions and Heed Warnings
Follow all operating and use instructions. Pay attention to all warnings and cautions
in the operating instructions, as well as those that are affixed to this equipment.
Terminology
The terms defined below are used in this document. The definitions given are based
on those found in safety standards.
Service Personnel - The term service personnel applies to trained and qualified
individuals who are allowed to install, replace, or service electrical equipment. The
service personnel are expected to use their experience and technical skills to avoid
possible injury to themselves and others due to hazards that exist in service and
restricted access areas.
User and Operator - The terms user and operator apply to persons other than service
personnel.
Ground(ing) and Earth(ing) - The terms ground(ing) and earth(ing) are synonymous.
This document uses ground(ing) for clarity, but it can be interpreted as having the
same meaning as earth(ing).
Electric Shock Hazard
This equipment meets applicable safety standards.
WARNING:
To reduce risk of electric shock, perform only the instructions that are
included in the operating instructions. Refer all servicing to qualified service
personnel only.
Electric shock can cause personal injury or even death. Avoid direct contact with
dangerous voltages at all times. The protective ground connection, where provided,
is essential to safe operation and must be verified before connecting the power
supply.
Page 12
Important Safety Instructions
x 78-4025693-01 Rev D
Know the following safety warnings and guidelines:
Dangerous Voltages
- Only qualified service personnel are allowed to perform equipment
installation or replacement.
- Only qualified service personnel are allowed to remove chassis covers and
access any of the components inside the chassis.
Grounding
- Do not violate the protective grounding by using an extension cable, power
cable, or autotransformer without a protective ground conductor.
- Take care to maintain the protective grounding of this equipment during
service or repair and to re-establish the protective grounding before putting
this equipment back into operation.
Installation Site
When selecting the installation site, comply with the following:
Protective Ground - The protective ground lead of the building’s electrical
installation should comply with national and local requirements.
Environmental Condition – The installation site should be dry, clean, and
ventilated. Do not use this equipment where it could be at risk of contact with
water. Ensure that this equipment is operated in an environment that meets the
requirements as stated in this equipment’s technical specifications, which may be
found on this equipment’s data sheet.
Installation Requirements
WARNING:
Allow only qualified service personnel to install this equipment. The
installation must conform to all local codes and regulations.
Equipment Placement
WARNING:
Avoid personal injury and damage to this equipment. An unstable mounting
surface may cause this equipment to fall.
To protect against equipment damage or injury to personnel, comply with the
following:
Install this equipment in a restricted access location.
Do not install near any heat sources such as radiators, heat registers, stoves, or
Page 13
Important Safety Instructions
78-4025693-01 Rev D xi
other equipment (including amplifiers) that produce heat.
Place this equipment close enough to a mains AC outlet to accommodate the
length of this equipment’s power cord.
Route all power cords so that people cannot walk on, place objects on, or lean
objects against them. This may pinch or damage the power cords. Pay particular
attention to power cords at plugs, outlets, and the points where the power cords
exit this equipment.
Use only with a cart, stand, tripod, bracket, or table specified by the
manufacturer, or sold with this equipment.
Make sure the mounting surface or rack is stable and can support the size and
weight of this equipment.
The mounting surface or rack should be appropriately anchored according to
manufacturer’s specifications. Ensure this equipment is securely fastened to the
mounting surface or rack where necessary to protect against damage due to any
disturbance and subsequent fall.
Ventilation
This equipment has openings for ventilation to protect it from overheating. To
ensure equipment reliability and safe operation, do not block or cover any of the
ventilation openings. Install the equipment in accordance with the manufacturer’s
instructions.
Rack Mounting Safety Precautions
Mechanical Loading
Make sure that the rack is placed on a stable surface. If the rack has stabilizing
devices, install these stabilizing devices before mounting any equipment in the rack.
WARNING:
Avoid personal injury and damage to this equipment. Mounting this
equipment in the rack should be such that a hazardous condition is not caused
due to uneven mechanical loading.
Reduced Airflow
When mounting this equipment in the rack, do not obstruct the cooling airflow
through the rack. Be sure to mount the blanking plates to cover unused rack space.
Additional components such as combiners and net strips should be mounted at the
back of the rack, so that the free airflow is not restricted.
CAUTION:
Installation of this equipment in a rack should be such that the amount of
airflow required for safe operation of this equipment is not compromised.
Page 14
Important Safety Instructions
xii 78-4025693-01 Rev D
Elevated Operating Ambient Temperature
Only install this equipment in a humidity- and temperature-controlled environment
that meets the requirements given in this equipment’s technical specifications.
CAUTION:
If installed in a closed or multi-unit rack assembly, the operating ambient
temperature of the rack environment may be greater than room ambient
temperature. Therefore, install this equipment in an environment compatible
with the manufacturer’s maximum rated ambient temperature.
Handling Precautions
When moving a cart that contains this equipment, check for any of the following
possible hazards:
WARNING:
Avoid personal injury and damage to this equipment! Move any equipment
and cart combination with care. Quick stops, excessive force, and uneven
surfaces may cause this equipment and cart to overturn.
Use caution when moving this equipment/cart combination to avoid injury from
tip-over.
If the cart does not move easily, this condition may indicate obstructions or
cables that may need to be disconnected before moving this equipment to
another location.
Avoid quick stops and starts when moving the cart.
Check for uneven floor surfaces such as cracks or cables and cords.
Grounding
This section provides instructions for verifying that the equipment is properly
grounded.
Safety Plugs (USA Only)
This equipment may be equipped with either a 3-terminal (grounding-type) safety
plug or a 2-terminal (polarized) safety plug. The wide blade or the third terminal is
provided for safety. Do not defeat the safety purpose of the grounding-type or
polarized safety plug.
To properly ground this equipment, follow these safety guidelines:
Grounding-Type Plug - For a 3-terminal plug (one terminal on this plug is a
protective grounding pin), insert the plug into a grounded mains, 3-terminal
outlet.
Note: This plug fits only one way. If this plug cannot be fully inserted into the
outlet, contact an electrician to replace the obsolete 3-terminal outlet.
Page 15
Important Safety Instructions
78-4025693-01 Rev D xiii
Polarized Plug - For a 2-terminal plug (a polarized plug with one wide blade
and one narrow blade), insert the plug into a polarized mains, 2-terminal outlet
in which one socket is wider than the other.
Note: If this plug cannot be fully inserted into the outlet, try reversing the plug.
If the plug still fails to fit, contact an electrician to replace the obsolete 2-terminal
outlet.
Grounding Terminal
If this equipment is equipped with an external grounding terminal, attach one end of
an 18-gauge wire (or larger) to the grounding terminal; then, attach the other end of
the wire to a ground, such as a grounded equipment rack.
Safety Plugs (European Union)
Class I Mains Powered Equipment – Provided with a 3-terminal AC inlet and
requires connection to a 3-terminal mains supply outlet via a 3-terminal power
cord for proper connection to the protective ground.
Note: The equipotential bonding terminal provided on some equipment is not
designed to function as a protective ground connection.
Class II Mains Powered Equipment – Provided with a 2-terminal AC inlet that
may be connected by a 2-terminal power cord to the mains supply outlet. No
connection to the protective ground is required as this class of equipment is
provided with double or reinforced and/or supplementary insulation in
addition to the basic insulation provided in Class I equipment.
Note: Class II equipment, which is subject to EN 50083-1, is provided with a
chassis mounted equipotential bonding terminal. See the section titled
Equipotential Bonding for connection instructions.
Equipotential Bonding
If this equipment is equipped with an external chassis terminal marked with the IEC
60417-5020 chassis icon (
), the installer should refer to CENELEC standard EN
50083-1 or IEC standard IEC 60728-11 for correct equipotential bonding connection
instructions.
AC Power
Important: If this equipment is a Class I equipment, it must be grounded.
If this equipment plugs into an outlet, the outlet must be near this equipment,
and must be easily accessible.
Connect this equipment only to the power sources that are identified on the
equipment-rating label normally located close to the power inlet connector(s).
This equipment may have two power sources. Be sure to disconnect all power
Page 16
Important Safety Instructions
xiv 78-4025693-01 Rev D
sources before working on this equipment.
If this equipment does not have a main power switch, the power cord connector
serves as the disconnect device.
Always pull on the plug or the connector to disconnect a cable. Never pull on the
cable itself.
Unplug this equipment when unused for long periods of time.
Connection to -48 V DC/-60 V DC Power Sources
If this equipment is DC-powered, refer to the specific installation instructions in this
manual or in companion manuals in this series for information on connecting this
equipment to nominal -48 V DC/-60 V DC power sources.
Circuit Overload
Know the effects of circuit overloading before connecting this equipment to the
power supply.
CAUTION:
Consider the connection of this equipment to the supply circuit and the effect
that overloading of circuits might have on overcurrent protection and supply
wiring. Refer to the information on the equipment-rating label when
addressing this concern.
General Servicing Precautions
WARNING:
Avoid electric shock! Opening or removing this equipment’s cover may
expose you to dangerous voltages.
CAUTION:
These servicing precautions are for the guidance of qualified service
personnel only. To reduce the risk of electric shock, do not perform any
servicing other than that contained in the operating instructions unless you
are qualified to do so. Refer all servicing to qualified service personnel.
Be aware of the following general precautions and guidelines:
Servicing - Servicing is required when this equipment has been damaged in any
way, such as power supply cord or plug is damaged, liquid has been spilled or
objects have fallen into this equipment, this equipment has been exposed to rain
or moisture, does not operate normally, or has been dropped.
Wristwatch and Jewelry - For personal safety and to avoid damage of this
equipment during service and repair, do not wear electrically conducting objects
such as a wristwatch or jewelry.
Page 17
Important Safety Instructions
78-4025693-01 Rev D xv
Lightning - Do not work on this equipment, or connect or disconnect cables,
during periods of lightning.
Labels - Do not remove any warning labels. Replace damaged or illegible
warning labels with new ones.
Covers - Do not open the cover of this equipment and attempt service unless
instructed to do so in the instructions. Refer all servicing to qualified service
personnel only.
Moisture - Do not allow moisture to enter this equipment.
Cleaning - Use a damp cloth for cleaning.
Safety Checks - After service, assemble this equipment and perform safety
checks to ensure it is safe to use before putting it back into operation.
Electrostatic Discharge
Electrostatic discharge (ESD) results from the static electricity buildup on the human
body and other objects. This static discharge can degrade components and cause
failures.
Take the following precautions against electrostatic discharge:
Use an anti-static bench mat and a wrist strap or ankle strap designed to safely
ground ESD potentials through a resistive element.
Keep components in their anti-static packaging until installed.
Avoid touching electronic components when installing a module.
Fuse Replacement
To replace a fuse, comply with the following:
Disconnect the power before changing fuses.
Identify and clear the condition that caused the original fuse failure.
Always use a fuse of the correct type and rating. The correct type and rating are
indicated on this equipment.
Batteries
This product may contain batteries. Special instructions apply regarding the safe use
and disposal of batteries:
Safety
Insert batteries correctly. There may be a risk of explosion if the batteries are
incorrectly inserted.
Page 18
Important Safety Instructions
xvi 78-4025693-01 Rev D
Do not attempt to recharge ‘disposable’ or ‘non-reusable’ batteries.
Please follow instructions provided for charging ‘rechargeable’ batteries.
Replace batteries with the same or equivalent type recommended by
manufacturer.
Do not expose batteries to temperatures above 100°C (212°F).
Disposal
The batteries may contain substances that could be harmful to the environment
Recycle or dispose of batteries in accordance with the battery manufacturer’s
instructions and local/national disposal and recycling regulations.
The batteries may contain perchlorate, a known hazardous substance, so special
handling and disposal of this product might be necessary. For more information
about perchlorate and best management practices for perchlorate-containing
substance, see www.dtsc.ca.gov/hazardouswaste/perchlorate.
Modifications
This equipment has been designed and tested to comply with applicable safety, laser
safety, and EMC regulations, codes, and standards to ensure safe operation in its
intended environment. Refer to this equipment's data sheet for details about
regulatory compliance approvals.
Do not make modifications to this equipment. Any changes or modifications could
void the user’s authority to operate this equipment.
Modifications have the potential to degrade the level of protection built into this
equipment, putting people and property at risk of injury or damage. Those persons
making any modifications expose themselves to the penalties arising from proven
non-compliance with regulatory requirements and to civil litigation for
compensation in respect of consequential damages or injury.
Accessories
Use only attachments or accessories specified by the manufacturer.
Page 19
Important Safety Instructions
78-4025693-01 Rev D xvii
Electromagnetic Compatibility Regulatory Requirements
This equipment meets applicable electromagnetic compatibility (EMC) regulatory
requirements. Refer to this equipment's data sheet for details about regulatory
compliance approvals. EMC performance is dependent upon the use of correctly
shielded cables of good quality for all external connections, except the power source,
when installing this equipment.
Ensure compliance with cable/connector specifications and associated
installation instructions where given elsewhere in this manual.
Otherwise, comply with the following good practices:
Multi-conductor cables should be of single-braided, shielded type and have
conductive connector bodies and backshells with cable clamps that are
conductively bonded to the backshell and capable of making 360° connection to
the cable shielding. Exceptions from this general rule will be clearly stated in the
connector description for the excepted connector in question.
Ethernet cables should be of single-shielded or double-shielded type.
Coaxial cables should be of the double-braided shielded type.
EMC Compliance Statements
Where this equipment is subject to USA FCC and/or Industry Canada rules, the
following statements apply:
FCC Statement for Class A Equipment
This equipment has been tested and found to comply with the limits for a Class A
digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to
provide reasonable protection against harmful interference when this equipment is
operated in a commercial environment.
This equipment generates, uses, and can radiate radio frequency energy and, if not
installed and used in accordance with the instruction manual, may cause harmful
interference to radio communications. Operation of this equipment in a residential
area is likely to cause harmful interference in which case users will be required to
correct the interference at their own expense.
Industry Canada - Industrie Canadiene Statement
This apparatus complies with Canadian ICES-003.
Cet appareil est confome à la norme NMB-003 du Canada.
CENELEC/CISPR Statement with Respect to Class A Information Technology Equipment
This is a Class A equipment. In a domestic environment this equipment may cause
radio interference in which case the user may be required to take adequate
measures.
Page 20
Page 21
Laser Safety
78-4025693-01 Rev D xix
Laser Safety
Introduction
This equipment contains an infrared laser that transmits intensity-modulated light
and emits invisible radiation.
Warning: Radiation
WARNING:
Avoid personal injury! Use of controls, adjustments, or procedures other
than those specified herein may result in hazardous radiation exposure.
Avoid personal injury! The laser light source on this equipment (if a
transmitter) or the fiber cables connected to this equipment emit invisible
laser radiation. Avoid direct exposure to the laser light source.
Avoid personal injury! Viewing the laser output (if a transmitter) or fiber
cable with optical instruments (such as eye loupes, magnifiers, or
microscopes) may pose an eye hazard.
Do not apply power to this equipment if the fiber is unmated or unterminated.
Do not stare into an unmated fiber or at any mirror-like surface that could reflect
light emitted from an unterminated fiber.
Do not view an activated fiber with optical instruments such as eye loupes,
magnifiers, or microscopes.
Use safety-approved optical fiber cable to maintain compliance with applicable
laser safety requirements.
Warning: Fiber Optic Cables
WARNING:
Avoid personal injury! Qualified service personnel may only perform the
procedures in this manual. Wear safety glasses and use extreme caution when
handling fiber optic cables, particularly during splicing or terminating
operations. The thin glass fiber core at the center of the cable is fragile when
exposed by the removal of cladding and buffer material. It easily fragments
into glass splinters. Using tweezers, place splinters immediately in a sealed
waste container and dispose of them safely in accordance with local
regulations.
Page 22
Laser Safety
xx 78-4025693-01 Rev D
Safe Operation for Software Controlling Optical Transmission Equipment
If this manual discusses software, the software described is used to monitor and/or
control ours and other vendors’ electrical and optical equipment designed to
transmit video, voice, or data signals. Certain safety precautions must be observed
when operating equipment of this nature.
For equipment specific safety requirements, refer to the appropriate section of the
equipment documentation.
For safe operation of this software, refer to the following warnings.
WARNING:
Ensure that all optical connections are complete or terminated before
using this equipment to remotely control a laser device. An optical or laser
device can pose a hazard to remotely located personnel when operated
without their knowledge.
Allow only personnel trained in laser safety to operate this software.
Otherwise, injuries to personnel may occur.
Restrict access of this software to authorized personnel only.
Install this software in equipment that is located in a restricted access area.
Page 23
Laser Safety
78-4025693-01 Rev D xxi
Maximum Laser Power
The maximum laser power that can be expected from this amplifier module is
defined in the following table.
Output
Configuration
Maximum
Output
IEC 60825-1 Product
Classification
Accessible Radiation
Level with Fibers
removed "When Open"
4 x 18 18.5 dBm 1M 1M
8 x 18 19.5 dBm 1M 1M
9 x 19 19.5 dBm 1M 1M
4 x 21.5 22.0 dBm 1M 3B
8 x 21.5 22.0 dBm 1M 3B
Warning Labels
The following labels are located on this product.
Laser Warning
Labels
Laser Aperture
Label
Laser Classification
Label
Page 24
Laser Safety
xxii 78-4025693-01 Rev D
Product and Laser Information Label
Note: This sample label shows laser information for 9x19 output configuration. Labels for
other output configurations may show different laser information.
Page 25
Laser Safety
78-4025693-01 Rev D xxiii
Location of Labels on Equipment
The following illustration displays the location of warning labels on this equipment.
Page 26
Page 27
78-4025693-01 Rev D 1
Overview
This chapter describes the Prisma® II Hybrid Amplifier. The hybrid
amplifier delivers both analog and digital signals. Microprocessor
control allows ease of installation and flexibility of application.
This product comes configured as an uncooled double-wide module,
as follows:
Prisma II Hybrid Amplifier (9 x 19 dBm)
Prisma II Hybrid Amplifier (4 x 21.5 dBm)
Prisma II Hybrid Amplifier (8 x 21.5 dBm)
Prisma II GF Hybrid Amplifier (4 x 18 dBm)
Prisma II GF Hybrid Amplifier (8 x 18 dBm)
Purpose
This guide provides information about the hybrid amplifier. This
chapter describes the front and back panels, and presents a setup
summary for the amplifier.
Who Should Use This Document
This document is intended for authorized service personnel who have
experience working with similar equipment. The service personnel
should have appropriate background and knowledge to complete the
procedures described in this document.
1 Chapter 1
Module Introduction
Page 28
2 78-4025693-01 Rev D
Qualified Personnel
Only appropriately qualified and skilled personnel should attempt to
install, operate, maintain, and service this product.
WARNING:
Only appropriately qualified and skilled personnel should attempt
to install, operate, maintain, and service this product.
Scope
This guide discusses the following topics.
Description of the hybrid amplifier
Installation procedures
CLI Operation
ICIM Operation
LCI Operation
Maintenance and troubleshooting
CLI command reference
Descriptions of module parameters
Document Version
This is the third release of this guide (Rev C).
In This Chapter
Hybrid Amplifier Description .............................................................. 3
Hybrid Amplifier Front and Back Panel ............................................. 5
Module Configuration ........................................................................... 7
Page 29
Hybrid Amplifier Description
78-4025693-01 Rev D 3
Hybrid Amplifier Description
The Prisma II optical network is an advanced transmission system designed to
optimize network architectures and increase reliability, scalability, and cost
effectiveness.
Hybrid Amplifier Features
The Prisma II Hybrid Amplifier has the following features:
Front panel green light emitting diode (LED) to indicate operating status
Front panel red LED to indicate alarm status
Optical input/output connectors
Hot-swappable and plug-and-play capability
Front panel optical output test point, -20 dB
Hybrid Amplifier Operation
Operating stand-alone or followed by post-amplifiers, this module provides highperformance transmission of voice, video, and data signals for optical networking.
The module is controlled by an ICIM2, CLI, LCI, or SNMP software.
Hybrid Amplifier Optical Output
The module comes standard with SC/APC Duplex optical connectors. Optical
jumpers are sold separately to interconnect hybrid amplifier and post-amplifier
modules and to interconnect to other equipment that may have other optical
connector types.
Laser Warning
WARNING:
Avoid damage to your eyes! Do not look into any optical connector while the
system is active. Even if the unit is off, there may still be hazardous optical
levels present.
Page 30
Chapter 1 Module Introduction
4 78-4025693-01 Rev D
Hybrid Amplifier Module Block Diagram
A block diagram of the hybrid amplifier module is shown below.
Page 31
Hybrid Amplifier Front and Back Panel
78-4025693-01 Rev D 5
Hybrid Amplifier Front and Back Panel
Hybrid Amplifier Illustration (Front and Back)
Hybrid Amplifier Front Panel Features
Part Function
Alarm Indicator Red ON – Major Alarm active
Red Blinking – Minor Alarm active
Red OFF – No Alarm active
Laser On Indicator Green ON – Laser enabled and input power OK
Green Blinking – Module disabled or in Slave mode
Green Fast Blinking – Module communicating with ICIM
or LCI
Green OFF – Laser disabled or input power critically low
Page 32
Chapter 1 Module Introduction
6 78-4025693-01 Rev D
Part Function
Laser Aperture Out Connects the output signal to the optical cable. The optical
outputs are divided into two banks, A and B.
Laser Aperture In Connects the optical cable input signal to the module
inputs.
-20 dB Laser Aperture Out
Test Point
Provides a -20 dB sample of the optical output signal
relative to the bank B optical outputs.
Back Panel Connectors
Blind-mate connectors make it easy to install this module. The push-on connector on
the back of the module mates with the back plane bus connector inside the chassis.
This 110-pin connector provides the following:
Electrical power input connection
Alarm communications
Status-monitoring communications
Communications and control connections
Page 33
Module Configuration
78-4025693-01 Rev D 7
Module Configuration
The module is shipped from the factory with operational parameters set to factory
defaults. However, you will probably choose to configure the operating parameters
so that they are best suited for your application.
Configuration and Monitoring Methods
The module may be controlled and monitored using one of the following methods.
The CLI software
The CLI software running locally on a PC connected to the ICIM can be used to
control and monitor the module. For instructions on operating this module using
the CLI, refer to Operation Using CLI (on page 29) and the Prisma II Platform
Remote User Interface Guide, System Release 2.03, part number 4025477.
ICIM Web Interface
The ICIM Web Interface offers a user-friendly alternative to CLI commands for
remote module setup and monitoring. Users navigate a series of HTML pages
through a standard web browser to view and, where permitted, adjust module
parameters. For additional information, see the Prisma II Platform Remote User
Interface Guide, System Release 2.03, part number 4025477.
The Prisma II ICIM Front Panel
If an ICIM is installed in the Prisma II chassis, it may be used to monitor the
Prisma II application modules within its domain. For security reasons, this nonpassword protected front panel interface is limited to read-only monitoring
except that the amplifier may be placed in service mode. For instructions on
operating this module using the ICIM, refer to Operation Using ICIM (on page
63).
LCI software
The LCI software running on a locally connected PC may be used to configure
operating parameters of Prisma II modules. For instructions on operating this
module using the LCI software, refer to Operation Using LCI (on page 103).
TNCS or ROSA Remote software
TNCS or ROSA software may be used to configure and monitor all functions of
the Prisma II modules. For further information, refer to the TNCS Administrator
Release 3.0 Software User's Guide, part number 4013494 or the appropriate ROSA
software documentation.
Page 34
Chapter 1 Module Introduction
8 78-4025693-01 Rev D
SNMP software
The module may be controlled and monitored remotely via an SNMP connection
using an appropriate Network Management System. For instructions on
operating this module using the ICIM, refer to Operation Using ICIM (on page
63) and the Prisma II Platform System Guide, System Release 2.03, part number
4025478.
Page 35
78-4025693-01 Rev D 9
Introduction
This chapter contains instructions, site requirements, equipment, and
tools needed to install the Prisma II Hybrid Amplifier.
2 Chapter 2
Module Installation
In This Chapter
Preparing for Installation ..................................................................... 10
Site Requirements ................................................................................. 11
Installing the Module in the Chassis .................................................. 14
Cleaning Optical Connectors .............................................................. 20
Connecting Optical Cables .................................................................. 24
External Alarms Connections ............................................................. 25
Prisma II Redundancy Interface Panel .............................................. 27
Page 36
Chapter 2 Module Installation
10 78-4025693-01 Rev D
Preparing for Installation
Before you begin, make sure that the module is in good condition and that you have
the tools and equipment listed here.
Unpacking and Inspecting the Module
As you unpack the module, inspect it for shipping damage. Inspect the rear
connectors for bent pins.
If you find any damage, contact Cisco Services.
Equipment and T ools Needed
You need the following equipment and tools to install these modules.
You need . . . To . . .
a Prisma II Chassis with power supply provide housing, power, and input/output
connections to the module.
3/8-in. flat-blade screwdriver secure the module in the chassis.
optical cables with connectors carry optical input and output signals.
optical cleaning materials clean optical connectors.
optical power meter verify optical input and output levels.
Page 37
Site Requirements
78-4025693-01 Rev D 11
Site Requirements
Before you begin, make certain that your installation site meets the requirements
discussed in this section.
Access Requirements
WARNING:
Use this product in locations that restrict access to all persons who are not
authorized. Otherwise, personal injury or equipment damage may occur.
Ensure that only authorized personnel have access to this equipment. Otherwise,
personal injury or equipment damage may occur.
Equipment Rack
To install this module, your site must be equipped with an Electronics Industry
Association (EIA) equipment rack that properly houses the chassis with proper
spacing for air circulation. For instructions on installing the chassis in the rack, refer
to the guide that was shipped with the chassis.
Operating Environment
CAUTION:
Avoid damage to this product! Operating this product outside the specified
operating temperature limits voids the warranty.
Follow these recommendations to maintain an acceptable operating temperature of
the equipment.
For a chassis with one or more hybrid amplifier modules installed, air inlet
temperature must be between -5°C and 55°C (23°F and 131°F).
Note: Refer to the module data sheet and the product guide for product-specific
temperature specifications.
Keep cooling vents clear and free of obstructions.
Provide ventilation as needed using air-deflecting baffles, forced-air ventilation,
or air outlets above enclosures, either alone or in combination.
Power Requirements
All Prisma II application modules receive their electrical power from the chassis. The
modules may be installed with the chassis under power.
Page 38
Chapter 2 Module Installation
12 78-4025693-01 Rev D
Space Requirements
The hybrid amplifiers are double-wide modules. They are usually installed in slots 5
through 15. Slots 1 through 4 are usually reserved for the power supplies. Slots 15
and 16 are reserved for the ICIM2, if installed. If an ICIM2 is not installed, any other
module could be installed in these slots.
Chassis Style
The Prisma II chassis is configured with front connectors. Power, RF input/output,
and other connectors are located on the front of the chassis. Connections to the
chassis serve the same function and are made in the same manner regardless of the
location of the connectors or chassis configuration.
Note: The chassis ships with either a rear exhaust or a front exhaust fan tray. The
rear exhaust fan tray has its air exhaust ports on the rear of the fan tray. The front
exhaust fan tray has its air exhaust ports on the front of the fan tray and a solid back
panel.
Front-Access Chassis - Front Panel Illustration
The following illustration shows the front of the front-access Prisma II standard
chassis with two power supplies, 10 full-height modules, and the ICIM installed.
The power inlets, RF input/output, and RF ports are located on the recessed bottom
of the connector interface panel on the front-access version of the chassis.
Page 39
Site Requirements
78-4025693-01 Rev D 13
Rear-Access Chassis - Front Panel Illustration
The following illustration shows the front of the rear-access Prisma II standard
chassis with two power supplies, 10 full-height modules, and the ICIM installed.
Page 40
Chapter 2 Module Installation
14 78-4025693-01 Rev D
Installing the Module in the Chassis
T o Install the Module
Important: The following procedure assumes that the chassis is mounted in a rack.
This procedure applies to both front access and rear access chassis styles. The
modules are hot-swappable and have plug-and-play capability.
WARNING:
Avoid damage to your eyes! Do not look into any optical connector while the
system is active. Even if the unit is off, there may still be hazardous optical
levels present.
Important: When a module (power supply or application module) is inserted into
the chassis, alarm(s) may be generated momentarily while the module powers up.
This will be briefly indicated on the module LED and may also generate an alarm in
the Event Log. This is a normal occurrence and does not indicate a module problem.
Complete the following steps to install the module in the chassis.
1 Locate the fiber guides at the bottom of the chassis and the module guide slots
inside the chassis as shown in the following illustration.
2 Align the ridges on the top and bottom of the module with the module guide
slots located on the chassis.
3 Locate the two ejector levers on the left of the module. Swing the ejectors out so
they are perpendicular to the module front panel.
Page 41
Installing the Module in the Chassis
78-4025693-01 Rev D 15
4 Gently slide the module into the chassis until its power and communications
connections join connectors on the Back Plane Bus. Do not force the module into the
chassis. If properly aligned, it should slide in with minimal force.
5 Slowly press the module ejector levers toward the chassis and confirm that the
jaws of the ejectors engage with the mounting flange in the chassis. When this
occurs, the ejectors act as levers that pull the module toward the mounting flange
and cause its power and communications connectors to mate fully with the
corresponding connectors at the rear of the chassis. After confirming correct
ejector operation, press both ejectors fully so that they are parallel to the module
front panel.
6 Hand-tighten the screw at the top of the module to secure it in the chassis. Use a
3/8-in. flat-blade screwdriver to secure. Do not over-tighten.
7 Fill any unused slots with module blanks to guarantee proper cooling air flow.
T o Enable Optical Output
As a safety precaution, the optical output of this module is disabled by factory
default.
Complete the following steps to enable optical output after the module is installed.
1 Obtain the chassis and slot number for the module. When using Telnet for
communication with the module, also obtain the chassis IP address.
2 Use HyperTerminal, Telnet, or your network management system to establish
CLI (command line interface) communication with the module's controlling
ICIM. Once communication is established, the CLI> prompt appears onscreen.
Note: Instructions for using HyperTerminal and Telnet are provided below. For
instructions on using your network management system, see your network
administrator.
Page 42
Chapter 2 Module Installation
16 78-4025693-01 Rev D
3 At the CLI> prompt, type module chassis <x> slot <y>, where x and y are the
chassis number and slot number respectively, and then press Enter. The prompt
changes from CLI> to x/y MODULE>, where x/y specifies the module's chassis
and slot location.
4 At the x/y MODULE> prompt, type set control enable on, and then press Enter.
The optical output of the module should now be enabled.
To Set Up a HyperTerminal Serial Port Session with the ICIM2
1 Connect one end of a DB-9 to DB-9 straight-through serial cable to an available
COM port on your personal computer, and the other end to the ICIM front panel
serial port.
2 Open a HyperTerminal session on your laptop (or desktop) PC that you will use
to connect to the ICIM. The HyperTerminal program typically is found at:
Start\All Programs\Accessories\Communication\Hyperterminal
The new Connection Description dialog box appears.
3 Type in a name for the connection, select an icon of your choice, and click OK.
The Connect To dialog box appears.
Page 43
Installing the Module in the Chassis
78-4025693-01 Rev D 17
4 In the Connect Using field, click the drop-down arrow and select the serial port
that you will use for the connection, and then click OK. The COM Properties
dialog box appears.
Note: For most applications, the serial port is COM1 or COM2.
5 Set the following port setting in the COM Properties dialog box.
6 Click OK. The HyperTerminal main program window appears.
7 On the File menu, click Save to save the settings.
8 Wait for the ICIM boot to finish. Once finished, you should see the following
display:
-------------------- W A R N I N G
Page 44
Chapter 2 Module Installation
18 78-4025693-01 Rev D
--------------------Unauthorized or improper use of this system may result in
administrative disciplinary action and civil or criminal penalties.
By continuing to use this system you indicate your awareness of and
consent to these terms and conditions of use. LOG OFF IMMEDIATELY
if you do not agree to the conditions stated in this warning.
login:
9 Log in using the default username Administrat0r and the default password
AdminPassw0rd. Note the 0 (zero) character in each string.
login: Administrat0r
Password: AdminPassw0rd
Successful login will return the following prompt:
Login of user "Administrat0r" successful
Proceed to CLI at the prompt
Welcome to the ICIM User Interface.
Copyright (c) Cisco Systems, Inc., 2005
Proceed to CLI at the shell prompt
shell>
10 At the shell> prompt, type cli, and then press Enter. The CLI> command prompt
appears.
11 Enter the module configuration commands as indicated above.
12 Type logout and then press Enter to exit the session.
13 Remove the serial cable. It is no longer required.
To Set Up a Telnet Session with the ICIM
1 Using a Category 5 Ethernet (Cat5) cable, connect the ICIM front panel Ethernet
port to your local network.
2 Open a command prompt window and verify connectivity by pinging the ICIM's
IP address. For example:
C:\> ping 172.18.50.100
Page 45
Installing the Module in the Chassis
78-4025693-01 Rev D 19
3 At the command prompt, type:
telnet <IP address>
where
IP address is the IP address of the ICIM. The session starts and the Telnet
Login prompt appears.
4 At the Login prompt, type Administrat0r (note the zero character in the string),
and then press Enter.
5 At the Password prompt, type AdminPassw0rd (note the zero character in the
string), and then press Enter.
6 At the telnet> prompt, type cli, and then press Enter. The CLI> command
prompt appears.
7 Enter the module configuration commands as indicated above.
8 Type logout and then press Enter to exit the session.
Page 46
Chapter 2 Module Installation
20 78-4025693-01 Rev D
Cleaning Optical Connectors
Introduction
Cleaning fiber-optic connectors can help prevent interconnect problems and
therefore aid system performance. When optical connectors are disconnected and
reconnected, the fiber surface can become dirty or scratched. The goal of cleaning
the fiber optic connectors is to remove all dust and contaminants without leaving
any residue. It is also recommended that all connectors be visually inspected after
cleaning to verify the connector is clean and undamaged.
Recommended Equipment
CLETOP or OPTIPOP ferrule cleaner (for specific connector type)
Compressed air (also called “canned air”)
Lint-free wipes moistened with optical-grade (99%) isopropyl alcohol
Bulkhead swabs (for specific connector type)
Optical connector scope with appropriate adaptor
Tips for Optimal Fiber Optic Connector Performance
Do not connect or disconnect optical connectors with optical power present.
Always use compressed air before cleaning the fiber optic connectors and when
cleaning connector end caps.
Always install or leave end caps on connectors when they are not in use.
If you have any degraded signal problems, clean the fiber optic connector.
Advance a clean portion of the ferrule cleaner reel for each cleaning.
Turn off optical power before making or breaking optical connections to avoid
microscopic damage to fiber mating surfaces.
Page 47
Cleaning Optical Connectors
78-4025693-01 Rev D 21
T o Clean Optical Connectors
WARNING:
Avoid personal injury! Use of controls, adjustments, or performance of
procedures other than those specified herein may result in hazardous
radiation exposure.
Avoid personal injury! The laser light source on this equipment emits
invisible laser radiation. Avoid direct exposure to the laser light source.
Avoid personal injury! Viewing the laser output with optical instruments
(such as eye loupes, magnifiers, or microscopes) may pose an eye hazard.
Connect or disconnect fiber only when equipment is OFF or in Service mode.
Do not apply power to this equipment if the fiber is unmated or unterminated.
Do not look into an unmated fiber or at any mirror-like surface that could reflect
light that is emitted from an unterminated fiber.
Do not view an activated fiber with optical instruments such as eye loupes,
magnifiers, or microscopes.
Use safety-approved optical fiber cable to maintain compliance with applicable
laser safety requirements.
Fiber Optic Connector Cleaning Instructions
Connector cleanliness is crucially important for optimum results in fiber optic
communications links. Even the smallest amount of foreign material can make it
impossible to obtain the expected insertion and return losses. This can reduce the
range of the equipment, shorten its expected service life, and possibly prevent the
link from initializing at all.
New equipment is supplied with clean optical connectors and bulkheads. Clean
these connectors and bulkheads in the field only if you observe and can verify an
optical output problem.
Connectors and Bulkheads
Most fiber optic connectors are of the physical contact (PC) type. PC type connectors
are designed to touch their mating connector to prevent air gaps, which cause
reflections. For optimum performance, all dirt must be removed.
Bulkheads can also become dirty enough to affect performance, either from airborne
dust or from contamination introduced by connectors.
Page 48
Chapter 2 Module Installation
22 78-4025693-01 Rev D
WARNING:
Avoid damage to your eyes! Do not look into any optical connector while the
system is active. Even if the unit is off, there may still be hazardous optical
levels present.
Note: Read the above warning before performing cleaning procedures.
Cleaning Connectors
It is important that all external jumper connectors be cleaned before inserting them
into the optical module. Follow these steps to clean fiber optic connectors that will
be connected to the optical module:
Important: Before you begin, remove optical power from the module or ensure that
optical power has been removed.
1 Inspect the connector through an optical connector scope. If the connector is
damaged, e.g., scratched, burned, etc., replace the jumper.
2 If the connector is dirty but otherwise undamaged, clean the connector as
follows:
a Make several swipes across the face of the connector with a CLETOP ferrule
cleaner. This will remove dust and some films.
b Listen for a slight "squeak" typically generated during this process, indicating
a clean connector.
c Inspect the connector again through the scope to confirm that it is clean.
3 If a second inspection indicates that further cleaning is needed:
a Use 99% isopropyl alcohol and a lint-free wipe to clean the connector.
b Use the CLETOP ferrule cleaner again to remove any film left over from the
alcohol.
c Inspect the connector again through the scope and confirm that it is clean.
4 If necessary, repeat steps 3a-3c until the connector is clean.
Cleaning Bulkheads
Important: Do not detach the bulkhead from the module front panel for cleaning
under any circumstances. There is little or no slack in the fiber attached to the
bulkhead, and any attempt to remove the bulkhead will risk damage to the fiber.
It is generally more difficult to clean bulkhead connectors and verify their condition
due to the inaccessibility of the fiber end face. For this reason, you should only
attempt to clean a bulkhead connector when a dirty connector is indicated.
Page 49
Cleaning Optical Connectors
78-4025693-01 Rev D 23
Follow these steps to clean the bulkhead:
WARNING:
Avoid personal injury! Use of controls, adjustments, or performance of
procedures other than those specified herein may result in hazardous
radiation exposure.
Avoid personal injury! The laser light source on this equipment emits
invisible laser radiation. Avoid direct exposure to the laser light source.
Avoid personal injury! Viewing the laser output with optical instruments
(such as eye loupes, magnifiers, or microscopes) may pose an eye hazard.
1 Insert a dry bulkhead swab into the bulkhead and rotate the swab several times.
2 Remove the swab and discard. Swabs may be used only once.
3 Check the bulkhead optical surface with a fiber connector scope to confirm that it
is clean. If further cleaning is needed:
a Moisten a new bulkhead swab using a lint-free wipe moistened with optical-
grade (99%) isopropyl alcohol.
b With the connector removed, fully insert the bulkhead swab into the
bulkhead and rotate the swab several times.
c Remove the swab and discard. Swabs may be used only once.
d Check with a fiber connector scope again to confirm that there is no dirt or
alcohol residue on the optical surface.
e If any alcohol residue remains, clean it off with a new dry bulkhead swab.
4 Mate all connectors to bulkheads and proceed to Verifying Equipment
Operation below.
5 It is also recommended that all connectors be visually inspected after cleaning to
verify the connector is clean and undamaged.
Verifying Equipment Operation
Perform circuit turn-up. If the equipment does not come up, i.e., fails verification or
indicates a reflection problem, clean the connectors and bulkheads again.
For Further Assistance
If you have any questions or concerns about cleaning fiber optic connectors, contact
Cisco Services.
Page 50
Chapter 2 Module Installation
24 78-4025693-01 Rev D
Connecting Optical Cables
T o Connect Cable
Important: It is recommended that all connections be made with the optical power
off. This will reduce the risk of damage to the fiber.
Note: Observe laser safety precautions. Refer to Laser Safety (on page xix) for
additional information.
Follow this procedure to make the optical cable connections for each module to be
installed.
CAUTION:
High power density exists on fiber when optical power is present. To avoid
microscopic damage to fiber mating surfaces, turn off optical power or reduce
power below 15 dBm before making or breaking optical connections.
1 After cleaning the end of the fiber, connect the optical cable(s) to the top
connector(s).
2 After cleaning the end of the fiber, attach the optical cable from the optical source
to the input connector (bottom) of the module. This is the optical input
connection.
3 Route the output cable(s) to the appropriate destination.
Page 51
External Alarms Connections
78-4025693-01 Rev D 25
External Alarms Connections
Master-Slave Operation
All Prisma II modules ship from the factory configured as a “master.” They can be
reconfigured as "slave" or redundant modules through command line interface (CLI)
commands. The chassis allows for local hard-wired redundancy by using the
ALARM IN and ALARM OUT connectors on the connector interface panel. With
these connectors, a master-slave pair of modules can be configured so that if the
master fails, the slave takes over.
ALARMS IN and ALARMS OUT Connections
The chassis provides two connections for external alarms to and from each module
slot. These alarm connections are located in two 37-pin D-connectors (DB-37) labeled
ALARMS IN and ALARMS OUT.
When a critical alarm occurs in a master module, the master turns off and the slave
(redundant module) is enabled. To make this happen, the pin representing the
master module slot in the ALARM OUT connector must be externally wired to the
pin representing the slave module slot in the ALARM IN connector.
Important:
This module takes up two slots in the Prisma II chassis. For purposes of
redundancy wiring, the module is identified with the higher-numbered slot. For
example, if the module occupies slots 6 and 7 (module ejector lever at slot 6), its
ALARM IN and ALARM OUT connections are made at slot 7, and the pins for
slot 6 are not used.
Any device configured as a master ignores its own ALARM IN contacts.
To verify proper wiring and redundant configuration, unplug the master device
and confirm that the slave module turns on as a result.
Once the ALARM IN and ALARM OUT contacts are wired, take care to ensure
that the master and slave modules are not moved to other slots. If they are, the
ALARM IN and ALARM OUT connectors will need to be rewired to the
appropriate pins.
Page 52
Chapter 2 Module Installation
26 78-4025693-01 Rev D
Master-Slave Illustration
ALARMS IN Connector
ALARMS OUT Connector
For more information about ALARMS IN and ALARMS OUT, refer to the Prisma II
Platform System Guide, System Release 2.03, part number 4025478.
Page 53
Prisma II Redundancy Interface Panel
78-4025693-01 Rev D 27
Prisma II Redundancy Interface Panel
The Prisma II Redundancy Interface Panel is an accessory to the Prisma II platform.
It is intended to be used with the master-slave feature and the contact closure alarm
feature of the Prisma II platform.
The Prisma II Redundancy Interface Panel serves as an extension to the two DB-37
connectors labeled ALARM IN and ALARM OUT on the connector interface panel of
the chassis. The terminals on the redundancy interface panel are extensions of pins
on the ALARMS OUT and ALARMS IN connectors on the chassis.
Note: This module takes up two slots in the Prisma II chassis. For purposes of
redundancy wiring, the module is identified with the higher-numbered slot. For
example, if the module occupies slots 6 and 7 (module ejector lever at slot 6), its
ALARM IN and ALARM OUT connections are made at slot 7, and the pins for slot 6
are not used.
For more information about the Redundancy Interface Panel, refer to the Prisma II
Chassis Installation and Operation Guide, part number 713375.
Page 54
Page 55
78-4025693-01 Rev D 29
Introduction
This chapter describes the procedures for using the CLI to monitor the
module. The procedures used in this chapter apply if you are using
the Prisma II ICIM2 to monitor the module.
For an overview of module operating features, see Module
Introduction (on page 1).
Laser Warning
WARNING:
Avoid damage to your eyes! Do not look into any optical connector
while the system is active. Even if the unit is off, there may still be
hazardous optical levels present.
3 Chapter 3
Operation Using CLI
In This Chapter
Prisma II Platform Configuration ....................................................... 30
Using the CLI ......................................................................................... 31
Module Commands .............................................................................. 38
ICIM Commands .................................................................................. 48
Terminal Commands ............................................................................ 56
Page 56
Chapter 3 Operation Using CLI
30 78-4025693-01 Rev D
Prisma II Platform Configuration
Page 57
Using the CLI
78-4025693-01 Rev D 31
Using the CLI
CLI Overview
The command-line interface (CLI) to the ICIM supports monitoring and control of
the ICIM domain, which includes the ICIM itself, the host chassis, and all other
modules installed in the host chassis and other daisy-chained chassis.
The CLI is designed for use by craft operators as well as by remote monitoring
systems. To meet both needs, CLI accepts commands in either of two formats:
A modal format allows craft operators to first select one of four command
modes, and then make use of mode-specific monitoring or control commands
and help screens.
A non-modal format allows an operator or network management system to enter
all parameters for a particular control or monitoring command, including
command mode changes, on a single line.
CLI Command Modes
All CLI interactions occur in one of four command modes. Command modes affect
the scope of the commands entered as well as how they are interpreted.
Mode Description
CLI The default command mode at login, used for issuing CLI
commands to perform general control and monitoring tasks
Module Used to issue Module mode commands, which are directed to a
specific module or range of modules installed in the ICIM domain
ICIM Used to issue ICIM mode commands, which are directed to the
ICIM itself
Terminal Used to issue Terminal mode commands, which control the way
that information is displayed onscreen
The current command mode is indicated by the onscreen prompt, as follows:
Prompt Meaning
CLI> CLI command mode now in effect
*/* MODULE> Module command mode now in effect; no chassis or slot specified
(see below for details)
ICIM> ICIM command mode now in effect
TERMINAL> Terminal command mode now in effect
Page 58
Chapter 3 Operation Using CLI
32 78-4025693-01 Rev D
Selecting Command Modes
CLI mode is the default command mode at login. A different command mode is
selected by entering the desired mode name at the CLI command prompt.
The following sample dialog shows how you would change from CLI mode to
Module mode:
CLI> module <Enter>
*/* MODULE>
You can then use any CLI commands recognized in Module command mode.
To exit Module mode and return to CLI mode, use the exit command as follows:
*/* MODULE> exit <Enter>
CLI>
If desired, you can then change to icim command mode as follows:
CLI> icim <Enter>
ICIM>
You cannot change command modes directly, e.g., by typing terminal at the ICIM>
prompt. Instead, you must change the command mode by first returning to CLI
mode, and then selecting the new mode, as shown below:
ICIM> exit <Enter>
CLI> terminal <Enter>
TERMINAL>
Entering Commands - Modal Format
Craft operators typically enter commands modally; that is, by first changing to the
appropriate command mode and then entering the desired command.
The following sample dialog illustrates this process.
CLI> module <Enter>
*/* MODULE> chassis 1 slot 6 <Enter>
01/06 MODULE> alarm <Enter>
No active alarms found
Success!
01/06 MODULE>
The first line of this example selects the Module command mode. In the next line, the
prompt changes to reflect the new command mode. The command on this line
selects chassis 1, slot 6 as the object of subsequent commands. On pressing Enter, the
prompt changes from */* MODULE> to 01/06 MODULE> to reflect this selection.
The next line issues the alarm command. The response on pressing Enter reflects the
alarm status for all of the modules installed in or daisy-chained with Chassis 1.
Modal command entry is often helpful for human operators. It can minimize the
need for keystrokes in some cases, saving time and eliminating a possible source of
error. Modal operation can also help to streamline the work flow by focusing
commands and human attention on a particular chassis or module of interest.
Page 59
Using the CLI
78-4025693-01 Rev D 33
Entering Commands - Non-Modal Format
A non-modal command is entered all at once, on a single command line. For
example, the alarm command entered above could have been entered as follows:
CLI> module chassis 1 slot 6 alarm exit <Enter>
No active alarms found
Success!
CLI>
Because of its relative efficiency, this is the preferred command entry format for
network management systems. Craft operators may also find non-modal command
entry to be more efficient when they are already very familiar with the syntax of the
command being used.
Command Syntax
The general format of a non-modal CLI command, as it usually should be sent from
a network management system, is as follows:
modename modeoptions action actionoptions values exit eol
where the keywords in the command serve the following functions:
Keyword Function
modename The name of a mode switch: cli, module, icim, or terminal
modeoptions Options that may be associated with the modename
action A command keyword such as set, show, info, etc.
actionoptions Options that may be associated with the action
values Values that may be associated with the action
eol End of Line, equivalent to Carriage Return or Enter
exit Used to return to CLI command mode
The general format of a modal CLI command, as a craft operator might send it, is as
follows:
ModeName modeOptions eol
modeOptions eol
modeOptions Action actionOptions Values eol
Action actionOptions Values eol
Exit eol
where the keywords have the same functions as described above for the non-modal
format.
Page 60
Chapter 3 Operation Using CLI
34 78-4025693-01 Rev D
Usage Guidelines
CLI commands, unlike login passwords, are insensitive to case. For example, the
keywords Set, set, and SET all have the same meaning in CLI.
If a particular action requires modeoptions that are not included in the
command, an error message will be issued.
In general, CLI commands issued from a network monitoring system should
have the non-modal "single-line" form shown above. Exceptions may be made
where they will improve efficiency.
Mode changes can be used to restrict the scope of most CLI commands. When
the command mode changes, the prompt changes to reflect the new mode.
End of Line
The CLI syntax is command-line oriented. Accordingly, the eol delimiter (shown as
\n in the grammar) is functionally equivalent to Carriage Return or Enter; that is, it
terminates the command. The eol delimiter cannot be used to split a single command
across two or more lines.
Shown below, for example, is a legal form of a set command within module mode as
a craft operator might enter it:
20/11 Module> set control enable 1 eol
However, the following form of the same command is not legal:
20/11 Module> set control eol (continue the command on the next line)
20/11 Module> enable 1 eol
Wildcards
Some CLI command parameters can include one or more wildcard characters (*) to
give added flexibility.
The following sample dialog shows how a craft operator could use a wildcard to
check the output power on all modules in chassis 20:
CLI> module chassis 20 slot * <Enter>
20/* MODULE> show monitor outpwr <Enter>
MODID NAME VALUE UNITS
20/05 OutPwr -5.33429 dBm
20/07 OutPwr 10.086 dBm
20/13 OutPwr -6.15736 dBm
SUCCESS!
20/* MODULE>
Page 61
Using the CLI
78-4025693-01 Rev D 35
The first line in this example changes from CLI mode to Module mode and specifies
chassis 20, any (*) slot. On the next line, the prompt has changed to reflect the new
mode and chassis specification. The show command entered at this prompt,
followed by the arguments monitor and outpwr, specifies that the response should
include only those modules for which outpwr is a monitored parameter. The
response to this command identifies each applicable module by chassis and slot
location and displays the current output power level in dBm.
The next sample dialog shows how a craft operator could use a wildcard to check all
monitored parameters whose name contained pwr:
CLI> module chassis 20 slot * <Enter>
20/* MODULE> show monitor *pwr* <Enter>
MODID NAME VALUE UNITS
20/05 OutPwr 8.3 dBm
20/07 OutPwr 5.91542 dBm
20/14 OutPwrA 18.9057 dBm
20/14 OutPwrB 18.8904 dBm
SUCCESS!
20/* MODULE>
As can be seen from the response, the pattern matching and keyword matching is
caseless, so the OutPwr and InPwr parameters are included even though a lowercase
P was used in the command line. Wildcards default to MS Windows filename
pattern matching format, where ?, *, and [x-y] have special meaning. This format can
be adjusted using the Terminal command Pattern to use POSIX regex wildcards. See
Terminal Commands (on page 56) for additional information.
Note: Wildcards are never allowed anywhere in a Set command.
Command Hints and Help
Abbreviations and Shortcuts
In general, the CLI interpreter recognizes the shortest character string that
unambiguously identifies a keyword (command or argument). In the CLI command
mode, for example, the entry of either m (or mod, etc.) is recognized as the module
command.
The table below lists other "shortcuts" available to users in all CLI command modes.
Shortcut Description
TAB Automatically completes typing of a keyword
ESC Displays a list of expected keywords or tokens
BACKSPACE
^H
Erases characters to the left of the text cursor
^A Displays the current input with all keywords expanded
Page 62
Chapter 3 Operation Using CLI
36 78-4025693-01 Rev D
Shortcut Description
^D Performs a logout when typed at the beginning of a line
^L Displays the current input as received by the command interpreter;
used for testing line noise
^P Moves the text cursor to a previous command line (limited)
^X Cancels the current input line
Note: While useful for craft operators, avoid using abbreviations and shortcuts in
network management system commands, as they are a potential source of error.
Alarm Information
You can use the alarm command in any command mode to get a list of currently
active alarms in the ICIM domain. You can also change command modes or
additional arguments to narrow the scope of the response, as explained later in this
chapter.
Getting Online Help
Craft operators can type help (or the ? character) and then press Enter to view online
help screens for each command mode.
The help screens for Module, ICIM, and Terminal modes can be viewed while in CLI
mode by using the following commands:
help module
help terminal
help icim
Note: A summary of recognized CLI commands by command mode is also provided
in Prisma II Permitted CLI Commands (on page 131).
Login and Logout
To use the CLI, you first establish communication with a chassis using Telnet,
Hyperterminal, or your network management system. Telnet and Hyperterminal
instructions are included in To Enable Optical Output (on page 15).
Page 63
Using the CLI
78-4025693-01 Rev D 37
Once communication is established, the control console or PC displays the following
message from the ICIM:
-------------------- W A R N I N G
--------------------Unauthorized or improper use of this system may result in
administrative disciplinary action and civil or criminal penalties.
By continuing to use this system you indicate your awareness of and
consent to these terms and conditions of use. LOG OFF IMMEDIATELY
if you do not agree to the conditions stated in this warning.
login:
Login
Complete the following steps to log into the CLI.
1 At the login prompt, type your assigned user name (or if none is assigned, type
Administrat0r), and then press Enter. The user name is case-sensitive.
2 At the password prompt, type your assigned password (or if none is assigned,
type AdminPassw0rd), and then press Enter. The password is case-sensitive.
An acknowledgement similar to the following appears:
Login of user "Administrat0r" successful
Welcome to the ICIM User Interface
Copyright (C) Cisco Systems, Inc., 2005
Proceed to CLI at the shell prompt
shell>
3 To enter the CLI, type cli at the shell prompt, then press Enter. The prompt
changes as shown below.
CLI>
You can now use CLI commands to interact with the ICIM2.
Logout
To log out of the CLI and exit the session, type logout, then press Enter.
Note: CLI always recognizes the logout command, regardless of the current
command mode.
Page 64
Chapter 3 Operation Using CLI
38 78-4025693-01 Rev D
Module Commands
Overview
Basic Command Syntax
The general non-modal form of a Module command is as follows:
MODULE Modspecs Command args ... Exit
Modspecs, or module specifications, are the parameters that identify the chassis and
slot to be addressed by the command.
The keyword chassis specifies the affected chassis.
The keyword slot specifies the affected slot or slots.
For example, the command module chassis 20 slot 11 selects slot 11 of chassis 20 as
the object of the command arguments (if any) that follow. Once this command is
entered, the Module prompt changes to reflect the current module specification.
The following exchange shows how a craft operator might specify slot 11 of chassis
20 before performing a series of checks on the module installed there:
*/* MODULE> module chassis 20 slot 11 <Enter>
20/11 MODULE>
Entering Modspecs
The chassis keyword may be used to specify a single chassis, a range of chassis, or
with the wildcard character (*), all chassis in the ICIM domain, as shown in this
dialog:
*/* MODULE> chassis 10
10/* MODULE> chassis [2-87]
[02-87]/* MODULE> chassis *
*/* MODULE>
Similarly, the slot keyword may be used independently to specify a single slot, a
range of slots, or all slots in the ICIM domain, as shown in this dialog:
10/* MODULE> slot [2-18]
10/[02-18] MODULE> slot 15
10/15 MODULE> slot *
10/* MODULE>
The chassis and slot also may be specified together by using the single keyword
modid, as shown here:
[10-34]/01 MODULE> modid [1-5]/[4-13]
[01-05]/[04-13] MODULE> modid 0512
05/12 MODULE> modid *
*/* MODULE>
The modid method can be somewhat faster to enter, but the resulting dialog may be
less readable than when using the chassis and slot keywords.
Page 65
Module Commands
78-4025693-01 Rev D 39
Module Command Prompt
The Module command prompt always indicates the current module specification, as
shown in the following examples.
Prompt Meaning
*/* MODULE> The modspec is "wild." The command will include all slots
and chassis in the ICIM domain.
20/* MODULE> The modspec specifies a chassis but not a slot. The command
will address all slots (modules) in chassis 20.
*/11 MODULE> The modspec specifies a slot but not a chassis. The command
will address slot 11 of all chassis in the ICIM domain.
20/11 MODULE> The modspec specifies a chassis and a slot. The command will
address only slot 11 of chassis 20 in the ICIM domain.
[1-7]/[4-15] MODULE> The modspec indicates a range of slots and chassis. The
command will address slots 4-15 of chassis 1-7 in the domain.
Note:
Modspecs persist when exiting and re-entering Module command mode, but
do not affect the scope of operation in other (CLI, ICIM, Terminal) command
modes.
When specifying a range of chassis or slots, the range need not be fully
populated. For example, the chassis range [1-7] does not require that there be
seven chassis; it only means that chassis numbers within that range will be
included.
For a network management system or other automatic control interface, a
specific chassis and slot are required for backward compatibility, and should
always be specified.
For craft operators, ranges may be specified for non-set commands, and
module specifications may be concatenated.
Alarm Command
The alarm command is used to display all active alarms in the domain of the ICIM.
The following sample dialog illustrates the use of this command:
20/* MODULE> alarm <Enter>
No active alarms found
SUCCESS!
20/* MODULE>
This response indicates that no alarms are currently active anywhere in the ICIM
domain. The scope of response is not limited to chassis 20, despite the current status
of the Module prompt.
Page 66
Chapter 3 Operation Using CLI
40 78-4025693-01 Rev D
Alarm Module
The argument module can be added to modify the scope of the command to include
only the active alarms in the range indicated by the current Module prompt.
The following sample dialog shows how this argument affects the response.
20/* MODULE> alarm module <Enter>
No active alarms found
SUCCESS!
20/* MODULE>
This response indicates that no alarms are currently among the modules installed in
chassis 20. Alarms that may exist in other chassis are not reflected.
Show Command
The show command (at the Module prompt) is used to display the values of
parameters specified by one of four following arguments: control, monitor,
alarmstate, or alarmparam. These arguments, in turn, are followed by the name of a
control (or monitor or alarm) to match against. This name can be the complete name
or a pattern that includes one or more wildcard characters (*).
Show Control
The following sample dialogs using the control argument show the use of both
complete names and wildcards, as well as the kinds of information returned.
*/* MODULE> show control enable <Enter>
MODID NAME SETTING UNITS
20/05 Enable On (1)
20/06 Enable On (1)
20/07 Enable On (1)
20/09 Enable On (1)
20/13 Enable Off (0)
SUCCESS!
*/* MODULE>
*/* MODULE> show control *serv* <Enter>
MODID NAME SETTING UNITS
01/07 Service Off (0)
01/08 ServiceA Off (0)
01/08 ServiceB On (1)
SUCCESS!
*/* MODULE>
Show Monitor
The sample dialog below shows the kind of information returned by the monitor
argument.
*/* MODULE> show monitor *pwr <Enter>
Page 67
Module Commands
78-4025693-01 Rev D 41
MODID NAME VALUE UNITS
20/05 OutPwr 8.29224 dBm
20/06 InPwr 5.91542 dBm
20/06 OutPwr 18.9929 dBm
20/13 InPwr 17.2202 dBm
20/13 OutPwr 19.4671 dBm
SUCCESS!
*/* MODULE>
Note:
The information returned by the monitor argument includes units of
measurement.
InPwr values are stated to several decimal places, but only the first 2 or 3 are
significant.
Show Alarmstate
The following sample dialog shows the kind of information returned by the
alarmstate argument.
*/* MODULE> show alarmstate *pwr <Enter>
MODID NAME STATE
20/05 OutPwr 0 (major low)
20/06 InPwr 0 (major low)
20/06 MaxInPwr 0 (ok)
20/07 OutPwr 2 (ok)
20/08 XSPwr 0 (ok)
20/13 OutPwr 0 (major low)
20/13 InPwr 0 (major low)
SUCCESS!
*/* MODULE>
Note: The information returned by the alarmstate argument provides both the
numeric value and its meaning.
Show Alarmparam
Alarms also have parameters, such as thresholds. Accordingly, the alarmparam
argument is in turn followed by an argument that specifies one of five parameters:
hysteresis, majorhigh, majorlow, minorhigh, and minorlow.
Page 68
Chapter 3 Operation Using CLI
42 78-4025693-01 Rev D
The following sample dialog illustrates the use of these arguments.
*/* MODULE> show alarmparam *pwr minorhigh <Enter>
MODID NAME MinorHigh
20/05 OutPwr 1
20/06 InPwr 5
20/06 MaxInPwr N/A
SUCCESS!
*/* MODULE>
Note:
The returned value of N/A shown above indicates that the alarm does not have
the requested parameter.
Some alarm values can also be changed by a craft operator or network
management system. See the set alarmparam command for details.
Show Module
This command is used to generate a list of information for specified modules that
will help with their physical identification.
The following is a sample craft operator dialog using show module to display
information for the modules in slots 3, 4, and 5 of all chassis in the ICIM domain:
*/* MODULE> slot [3-5] <Enter>
*/[03-05] MODULE> show module <Enter>
MODID MODTYPE NAME SERIAL
20/03 Prisma II Power Supply 3 / Fan Tray ^ABCDEFG
20/05 9x19dBm Prisma II Hybrid Amp ^AAG1AZI
SUCCESS!
*/[03-05] MODULE>
Info Command
The info command (at the Module prompt) is used to display more detailed
information than is returned by using the show command. The command can be
followed by the argument control, monitor, alarm, or module, which, in turn, is
followed by one or more arguments further specifying the type of information to be
returned.
The details or characteristics that can be requested for each argument include the
following:
Argument Details Description
Alarm
Hysteresis threshold hysteresis value
Index alarm number, starting at 1, in the list of alarms
Label name of the alarm
Limitadjust allowed if alarm is adjustable, not allowed if not
Majorhigh High Major threshold
Page 69
Module Commands
78-4025693-01 Rev D 43
Argument Details Description
Majorlow Low Major threshold
Minorhigh High Minor threshold
Minorlow Low Minor threshold
Nominal alarm nominal value
Rangehi upper limit for this threshold
Rangelo lower limit for this threshold
Type alarm type (1, 2, and 7 are adjustable)
Value alarm state
Control
Index control number, starting at 1, in the list of controls
Label name of the control
Rangehi upper limit for this control
Rangelo lower limit for this control
Rangestep smallest increment allowed
Statenames list of symbolic control values
Type control type: D(igital), F(loat), B(oolean), S(tate)
Units control unit
Value control setting
Monitor
Index monitor number, starting at 1, in the list of
monitors
Label name of monitor
Statenames list of symbolic values
Type value type: D(igital), F(loat), B(oolean), S(tate)
Units units of measurement
Value value
Module
Activerev active software image revision for the module
Bootrev current boot image revision for the module
CLEI Common Language Equipment ID code for
module
CLLI Common Language Locator ID code for module
Coderev code revision
Datecode manufacturing date (encoded)
Devtype numeric type value used for element manager
Page 70
Chapter 3 Operation Using CLI
44 78-4025693-01 Rev D
Argument Details Description
Downldable module can be downloaded with new firmware
Inactiverev inactive software image revision for the module
Mandata manufacturing data
Modtype manufacturing data (alias for MANDATA)
Name name of module
Nextimage flash bank where active image resides
Numanalogcontrols number of analog controls
Numcontrols total number of controls
Numdigitalcontrols number of digital controls
Nummonits number of monitored values
Numofalarms number of alarms
Scriptrev script revisions
Selftest status of module self test
Serial serial number
Tos time of service
The following sample dialog illustrates the use of the info command to view the
value and statenames characteristics for the cross control:
*/* MODULE> info control cross value statenames <Enter>
MODID NAME VALUE STATENAMES
20/08 Cross False (0) False (0), True (1)
SUCCESS!
*/* MODULE>
In the example above, the control's name pattern was explicit (no wildcards). The
details to be listed were Value and the available StateNames (not all controls and
monitors have StateNames). In this case, the value is 0 (False).
Page 71
Module Commands
78-4025693-01 Rev D 45
The next example shows how a network management system might construct an
info command to determine the domain of an ICIM. Note how a Terminal command
is first issued to define the vertical bar (|) character as a column separator to be used
for any subsequent output. See Terminal Commands (on page 56) for details.
CLI> terminal colsep "|" paging 0 exit
CLI> module chassis * slot * info module devtype name exit
CHASSIS|SLOT|TYPE|NAME
20|3|5000|Power Supply 3 / Fan Tray
20|5|1001|1310nm Forward Transmit
20|6|2002|Forward Receiver
20|7|1001|1310nm Forward Transmit
20|8|4000|Optical Switch
20|9|3011|FHEDA
20|13|3000|1550nm Optical Amplifier
20|14|2000|Reverse Data Receiver
SUCCESS!
CLI> logout
As can be seen from the resulting output, the Terminal command has an immediate
effect on the output, with the columns in each line of the response separated by |
characters. This makes it easy for the network management system to parse the
response.
Reset Command
The reset command is used to set all controls and alarms in a specified application
module to its factory defaults.
Because this action is potentially severe, this command can only be executed by an
Admin user, and a dialog is presented for confirmation. The reset command is only
supported by the new CCB3 modules.
Note: In the factory default state, this module has its outputs disabled. Thus,
resetting the module results in loss of output signal.
Set Command
The set command is used to assign a value to one or more parameters specified by a
subsequent control or alarmparam argument.
Set Control
The set control command is followed by two additional arguments. The first
identifies the control, while the second specifies the value to be assigned.
Page 72
Chapter 3 Operation Using CLI
46 78-4025693-01 Rev D
Important: To avoid possible system disruption, broadcast set commands are not
supported. This means that the set control command can only be applied to one
module (chassis and slot number) at a time. If a specific chassis and slot number are
not specified in advance, the CLI interpreter will disallow the command. In addition,
the name of the control to be changed must be explicit; no wildcard characters are
permitted.
The following example shows how a craft operator might use set control to disable
the module in slot 5 of chassis 20, and then use show control to confirm the change.
*/05 MODULE> module chassis 20 <Enter>
20/05 MODULE> set control enable 0 <Enter>
SUCCESS!
20/05 MODULE> show control enable <Enter>
MODID NAME SETTING UNITS
20/05 Enable 0
SUCCESS!
20/05 MODULE>
This example shows what would happen if the operator had omitted the initial step
of specifying the chassis:
*/05 MODULE> set control enable 0 <Enter>
Error: This command can only be used at an explicit Chassis and Slot prompt
Set the chassis and slot to specific values before using this command
*/05 MODULE>
Set Alarmparam
The CLI can be used to change the parameters of alarms that do not shut down a
module. These alarms are the "user" alarms of types 1, 2, and 7. While a full
description of the various alarm types is outside the scope of this document, it is
important here to note that any attempt to change an alarm's parameter will only be
effective if that alarm is of type 1, 2, or 7.
The set alarmparam command is typically used in conjunction with the info
command to first learn about alarm type and status, and then change alarm status
where appropriate and allowed.
The following sample dialog shows the info command can be used to first learn
about all (*) alarms in Module 2006, i.e., the module installed in chassis 20, slot 06:
20/06 MODULE> info alarm * type majorlow minorlow majorhigh minorhigh <Enter>
MODID NAME TYPE MAJORLOW MINORLOW MAJORHIGH MINORHIGH
20/06 PsOk 6 N/A N/A N/A N/A
20/06 OutPwr 1 -1 -0.7 1 0.7
20/06 IntPs 6 N/A N/A N/A N/A
20/06 Enable 6 N/A N/A N/A N/A
20/06 LasTemp 3 -20 -15 20 15
20/06 LasBias 1 -2 -1 -0.001 -0.01
20/06 InPwr 1 -16 -5 45 25
20/06 Service 5 N/A N/A N/A N/A
SUCCESS!
20/06 MODULE>
Page 73
Module Commands
78-4025693-01 Rev D 47
This response shows that the OutPwr, LasTemp, LasBias, and InPwr alarms all have
majorlow and majorhigh parameters. However, only InPwr, OutPwr, and LasBias
can be changed, as LasTemp is of type 3 rather than 1, 2, or 7.
The following sample dialog shows how a craft operator would set the majorhigh
parameter of outpwr to 35°C, and then confirm the change.
20/06 MODULE> set alarmparam outpwr majorhigh 35 <Enter>
SUCCESS!
20/06 MODULE>
20/06 MODULE> info alarm * type majorhigh
MODID NAME TYPE MAJORHIGH
20/06 PsOk 6 N/A
20/06 OutPwr 1 35
20/06 IntPs 6 N/A
20/06 Enable 6 N/A
20/06 LasTemp 3 15
20/06 LasBias 1 -0.01
20/06 InPwr 1 25
20/06 Service 5 N/A
SUCCESS!
20/06 MODULE>
Page 74
Chapter 3 Operation Using CLI
48 78-4025693-01 Rev D
ICIM Commands
ICIM commands provide for monitoring and control of the ICIM itself and for the
ICIM domain in general.
Alarm Command
The alarm command is used to display all active alarms in the domain of the ICIM.
The following sample dialog illustrates the use of this command:
ICIM> alarm <Enter>
No active alarms found
SUCCESS!
ICIM>
This response indicates that no alarms are currently active anywhere in the ICIM
domain. To narrow the command scope to specific chassis or modules, use this
command in Module mode together with the module option, as described in Module
Commands (on page 38).
Info Command
The info command is used to request a listing of one or more parameter values
specific to the ICIM module itself.
The general command syntax is as follows:
info argument argument ... argument
where each argument can have one of the values listed in the table below.
Value Function
ACTIVEREV Active software image revision for the ICIM
ATTNSTATUS Value for the Attention line (Low is normal)
BOOTREV Current boot image revision for the ICIM
CHASSIS Chassis containing the ICIM
CLEI Common Language Equipment ID code for the ICIM
CLLI Common Language Locator ID code for the ICIM
COMMREAD Sets the SNMP Community Read string
COMMTRAP Sets the SNMP Community Trap string
COMMWRITE Sets the SNMP Community Write string
DEVTYPE Devtype for the ICIM2 or ICIM2-XD
DOWNLDCMD Download command (used by SOUP)
Page 75
ICIM Commands
78-4025693-01 Rev D 49
Value Function
DOWNLDDIR Directory path for FTP, excluding filename (used by SOUP)
DOWNLDFILE Filename only of image to FTP (used by SOUP)
DOWNLDRESULT Download progress status and result (used by SOUP)
DOWNLDSEM Application security semaphore (used by SOUP)
DOWNLDSIG Application security information (used by SOUP)
DOWNLDSTATE State machine value to indicate FTP/download progress (used by
SOUP)
DOWNLDTGT Module (chassis and slot) to upgrade with release image (used by
SOUP)
DOWNLDUSER Application User ID to ensure only one instance (used by SOUP)
FTPSERVER IP address of FTP Server (used by SOUP)
FTPUSER User name for an FTP account
GATEWAY IP address of TCP/IP gateway, for packet routing
HWREV Hardware Revision
INACTIVEREV Inactive software image revision for the ICIM
IP TCP/IP address of the ICIM
IPSEC Reserved for future use
MAC MAC Address, used in low-level Ethernet routing
MANDATA Manufacturing data
NEXTIMAGE The image to be active after the next reboot
PREVIOUSIP Value of the TCP/IP before it was last changed
SELFTEST Results of the ICIM self test
SERIAL Serial number of the ICIM
SIZE Number of modules in the ICIM domain
SLOT Chassis slot number for the ICIM (15 for ICIM2, 17 for ICIM2-XD)
SMC The value (Chassis * 100) + Slot for the ICIM
STATUSMSG Status and Error message information
SUBNET Subnet mask, such as 255.255.255.0
SWDATE Software date (obsolete)
SWREV Software revision (obsolete)
THRESHOLD Login attempts threshold value
TIMEOUT User session inactivity timeout value
Page 76
Chapter 3 Operation Using CLI
50 78-4025693-01 Rev D
Value Function
TOS Time of Service of the ICIM
TZONE Time zone string setting
UPDATEID Always zero (0); this is a write-only value
Any number of these values can be listed, and the output returns the values in the
order requested.
The sample dialog below shows how this command might be sent by a network
management system.
CLI> icim info IP devtype serial swrev attnstatus size exit
IP DEVTYPE SERIAL SWREV ATTNSTATUS SIZE
172.23.200.154 5011 AADORTI 0.00.15 0 8
SUCCESS!
CLI>
Show Command
The show command is used to request information about the ICIM settings in the
info command and about the elements in the ICIM domain, how they are currently
provisioned (configured), and what traps are defined in the Traps table. The basic
command syntax is:
show argument
where argument specifies whether the request is for those items in the info
command, or for domain, provisioning, traps, or clock information, as further
explained below.
Show Domain
This command displays a list of all of the modules in the ICIM domain. The sample
dialog below illustrates the use of this command.
ICIM> show domain <Enter>
MODID DEVTYPE SERIAL ACTIVEREV CODEREV NAME
20/03 5010 1234567 1.00.05 CF_CCB3 Power Supply 3 / Fan Tray
20/05 1031 12345678 1.65.00 CF_CCB3 1550nm EM TX FTTP
20/07 3030 AACZOIF 1.00.05 CF_CCB3 1550nm Pre-Amp FTTP
20/08 3031 !AAGJUHB 1.00.05 CF_CCB3 1550nm Post-Amp FTTP
20/05 3019 AAG1AZI 1.01.02 CF_CCB Prisma II Hybrid Amp
SUCCESS!
ICIM>
In the response, each module is identified by its chassis and slot number (MODID)
as well as by object type (DEVTYPE), serial number (SERIAL), software revision
number (ACTIVEREV), and product description (NAME).
Page 77
ICIM Commands
78-4025693-01 Rev D 51
Show Provisioning
This command displays a list of the CLI commands needed to restore any
replacement modules in the ICIM domain to their current operating states. This list
can serve as a command reference to quickly configure a replacement module so that
it operates identically to the original.
The output is intended primarily for use by a network management system, which
would store the provisioning commands until needed. In the event that a module is
replaced, the system would then send the provisioning commands required to
configure the replacement module to match the operating state of the original.
The following sample dialog shows how a network management system might send
the command, and includes a portion of a typical response.
CLI> icim show provisioning exit
. . . .
Module Chassis 20 Slot 5 Set Control Enable On EXIT
Module Chassis 20 Slot 5 Set Control AGC On EXIT
Module Chassis 20 Slot 5 Set Control RFDrive 0 EXIT
Module Chassis 20 Slot 5 Set Control OMISet 0 EXIT
Module Chassis 20 Slot 5 Set Control Master Master EXIT
Module Chassis 20 Slot 5 Set Control CWMode Off EXIT
Module Chassis 20 Slot 5 Set Control LenMode Off EXIT
. . . .
Using the list requires first locating all command lines that target the chassis and slot
location of the replacement module. The commands are then sent to the replacement
module one at a time in the order listed. For example, after replacing the module in
chassis 20 slot 6 in the above example, the commands on lines 6-9 of the response
would be sent to configure the replacement module.
Note: The CLI has no mechanism for accepting multiple commands at a single
prompt from either a craft operator or a network management system. It is necessary
to send the first command, wait for a new prompt, send the next command, and so
on until all commands are sent.
Show Traps
This command is used to display the current status of the Trap table. The basic
syntax is as follows:
show traps
Page 78
Chapter 3 Operation Using CLI
52 78-4025693-01 Rev D
A typical response to this command is shown in the sample craft operator dialog
below:
CLI> icim <Enter>
ICIM> show traps
IDX STATE IP Address
0 Enabled 172.18.50.41
1 Enabled 172.18.50.1
2 Enabled 172.18.50.6
3 Disabled 0.0.0.0
4 Disabled 0.0.0.0
SUCCESS!
ICIM>
Show Clock
Note that the show command supports access to the ICIM real time clock (RTC), as
follows:
ICIM> show clock exit
MM-DD-YYYY HH:mm:ss
11-15-2005 12:01:40
SUCCESS!
ICIM>
Set Command
The set command allows a single value to be set in the ICIM. The basic syntax is:
set argument value
Where argument is one of the values listed in the following table.
Value Function
CLLI Common Language Locator ID code for the ICIM
CLOCK Date and Time as maintained by the ICIM
COMMREAD SNMP Read Community string
COMMWRITE SNMP Write Community string
COMMTRAP SNMP Trap Community string
GATEWAY IP address of the TCP/IP gateway, for packet routing
IP TCP/IP address of the ICIM
STATUSMSG Error or Status message
SUBNET Subnet mask, such as 255.255.255.0
UPDATEID Write-only; value of 1 causes ICIM to re-read ID of all modules
Some of these values (IP and GATEWAY, for example) result in changes to the ICIM
NVRAM, but do not take effect until the next reboot.
Page 79
ICIM Commands
78-4025693-01 Rev D 53
Set Clock
This command allows the ICIM real time clock (RTC) to be set and confirmed by a
single command, as shown in the following example.
ICIM> set clock 10/5/2005 12:40:00
MM-DD-YYYY HH:mm:ss
10-05-2005 12:40:00
SUCCESS!
ICIM>
User Command
The user command permits control and monitoring of system users and their
authorization levels. The basic syntax is as follows:
user argument value
where argument specifies whether the command is to add, change, delete, or show
user information, as further explained below.
User Add
This command can be used by the Admin user to add a new login and password to
the authentication table. A dialog is used to obtain the and validate the password.
The new authorization level s given on the command line, and can be one of the
following.
Authorization Description
ADMIN Equivalent to a Unix superuser (root) and should be allowed for
only the most trusted logins. An Admin can change passwords, IP
addresses, and other critical values.
READWRITE Allows typical operations, including the ability to change control
values and alarm parameters.
READ Allows the user to read non-critical values only, and has no write
permissions.
User Change
This command can be used by the Admin user to change the password of an existing
user. A dialog is used to obtain and validate the new password. The basic syntax is
as follows:
user change (username)
user add (username) (authorization level)
Page 80
Chapter 3 Operation Using CLI
54 78-4025693-01 Rev D
where
username must be 6 to 14 characters in length, must contain both letters and
numbers, and cannot contain special characters; for example, abc123.
authorization level is either admin, readwrite, or read.
Note:
After entering this command, you will be prompted to enter a password for the
user. The password must be 6 to 14 characters in length, must contain both letters
and numbers, but may contain special characters.
This command cannot be used to change the authorization level of the user. To
change authorization level, the user must be deleted and then added to the
system again, but specifying a different new authorization level.
User Delete
This command can be used by the Admin user to delete a login. The command
syntax is as follows:
user delete (username)
Note: Deleting a user that is already logged in does not terminate their current
session.
User Show
This command can be used by the Admin user to list all the available logins and
authorization levels. It does not display the passwords.
IPRoute Command
The iproute command permits control and monitoring of a list of up to four alternate
gateways for routing TCP/IP packets. The basic syntax is as follows:
iproute argument
where argument specifies whether the command is to add, delete, or show the route
information, as further explained below.
IPRoute Add
This command can be used to add a new entry to the list of alternate gateways for
routing TCP/IP packets. If the list already contains four entries, at least one entry
must be deleted using the iproute delete command before the new entry can be
added.
IPRoute Delete
This command can be used to remove an entry from the list of alternate gateways for
routing TCP/IP packets.
Page 81
ICIM Commands
78-4025693-01 Rev D 55
IPRoute Show
This command can be used to list all current entries in the listing of alternate
gateways for routing TCP/IP packets.
Reboot Command
The reboot command causes the ICIM to be reset. The basic syntax is as follows:
reboot
Note: User of this command requires Admin user permissions.
Tr aps Command
The traps command allows the entries in the Trap table to be enabled or disabled,
and allows the IP address of the Trap table to be set. The basic syntax is as follows:
traps trapenable trapindex [IPAddress]
where
trapenable is enable or disable to specify the command function.
trapindex is the table index (0-4).
[IPAddress] is the optional IP address to put in the table.
Note:
Admin permissions are required to use this command.
The Trap table has 5 entries, indexed 0-4. Each entry can be enabled by supplying
a valid IP address, or if the table entry already has a valid IP address.
When disabling an entry in the Traps table, you can specify an empty IP address,
i.e., 0.0.0.0.
See the Show Traps section of Show Command (on page 50) for instructions on
viewing selected portions of the Trap table.
Page 82
Chapter 3 Operation Using CLI
56 78-4025693-01 Rev D
Terminal Commands
Overview
Terminal commands are intended for control of the output or pattern matching
format.
Note:
Using the alarm command while in this mode shows a list of all active alarms in
the ICIM domain.
Using the show command while in this mode lists the current values for all
terminal states.
Colsep Command
The colsep command controls the separation between columns of output in the
display. By default, output is displayed in columns only slightly wider than are
needed for the longest value in the column. Adding spaces between columns can
make the output more legible to a craft operator, but may make output parsing more
difficult for a remote network management system.
On the other hand, if network management software recognizes a specific character
(such as |) as a column separator, the colsep command can be used to insert this
character between columns in the output.
The basic command syntax is as follows:
colsep "string"
where string is the column separation character or characters, or is empty ("") to
specify default column separation.
In the sample dialog below, a network management system sends this command to
enforce default column separation just before it sends a command requesting
columns of output.
CLI> terminal colsep "" exit
CLI> module modid * show control *serv* exit
MODID NAME SETTING UNITS
01/07 Service Off (0)
01/08 Service Off (0)
01/09 ServiceA On (1)
01/09 ServiceB Off (0)
SUCCESS!
CLI>
The next example shows how the output could be modified to make it more easily
parsed by another program, such as Microsoft Excel:
Page 83
Terminal Commands
78-4025693-01 Rev D 57
CLI> terminal colsep "," exit
CLI> module modid * show control *serv* exit
CHASSIS,SLOT,NAME,SETTING,UNITS
1,7,Service,Off(0),
1,8,Service,Off(0),
1,9,ServiceA,On(1),
1,9,ServiceB,Off(0),
SUCCESS!
CLI>
If the output data itself might contain columns, another character such as | can be
used as a column separator, as shown in the following example:
CLI> terminal colsep "|" exit
CLI> module modid * show control *serv* exit
CHASSIS|SLOT|NAME|SETTING|UNITS
1|7|Service|Off(0)
1|8|Service|Off(0)
1|9|ServiceA|On(1)
1|9|ServiceB|Off(0)
SUCCESS!
CLI>
Paging Command
The paging command is used to control paging behavior for long CLI output. The
basic syntax is as follows:
paging value
where value is zero (0) to disable paging completely, or a number 24 or greater to
specify the height of the paging window in lines of text.
Page 84
Chapter 3 Operation Using CLI
58 78-4025693-01 Rev D
Disabling Paging
Normally, when a CLI response is too long to fit in a single 24-line Telnet window,
the output is automatically paged using the familiar “more” format, as shown in the
following example:
CLI> module modid * show control * exit
MODID NAME SETTING UNITS
20/05 Enable 1
20/05 CwMode 0
20/05 LoRFInh 0
20/05 Master Slave (0)
20/05 RFDrive 0 dB
20/06 Enable 1
20/06 Master 1
20/06 WaveLen 1550nm (1)
20/06 NomPin 0 dBm
20/07 Enable 1
20/07 CwMode 1
20/07 LoRFInh 1
20/07 Master Master (1)
20/07 RFDrive 0 dB
20/08 Cross False (0)
20/08 Bar False (0)
20/08 Mode Auto (1)
20/08 WaveLen 1550nm (1)
20/08 NomPIn3 0 dBm
20/08 NomPIn4 0 dBm
20/08 Delta 6 dB
20/08 HystAmpl 3 dB
---line 23 of 51 total lines--Enter 'Q' to quit:
Craft operators can simply press Enter to display the next page of output. However,
network management software may have difficulty working with this output
format.
Page 85
Terminal Commands
78-4025693-01 Rev D 59
The paging command can address this problem by turning off all paging, as follows:
CLI> terminal paging 0 exit
CLI> module modid * show control * exit
MODID NAME SETTING UNITS
01/05 Enable On (1)
01/05 AGC On (1)
01/05 RFDrive 0 dB
01/05 OMISet 0 dB
01/05 Master Master (1)
01/05 CWMode Off (0)
01/05 LenMode Off (0)
01/07 Enable On (1)
01/07 SetAtten 0 dB
01/07 Master Master (1)
01/07 LoInpEna Off (0)
01/07 Service Off (0)
01/08 Enable On (1)
01/08 SetAtten 0 dB
01/08 Master Master (1)
01/08 LoInpEna Off (0)
01/08 Service Off (0)
01/09 Enable On (1)
01/09 SetAtten 0 dB
01/09 Master Master (1)
01/09 ServiceA Off (0)
01/09 ServiceB Off (0)
01/12 Enable On (1)
01/12 SetAtten 0 dB
01/12 Master Master (1)
01/12 ServiceA Off (0)
01/12 ServiceB Off (0)
10/09 Enable On (1)
10/09 SetAtten 0 dB
10/09 Master Master (1)
10/09 LoInpEna Off (0)
10/09 Service Off (0)
76/06 Cross False (0)
76/06 Bar False (0)
76/06 Mode Auto (1)
76/06 WaveLen 1550nm (1)
76/06 NomPin3 19 dBm
76/06 NomPin4 19 dBm
76/06 Delta 2 dB
76/06 HystAmpl 1 dB
76/06 HystTime 1 sec
76/06 Revert Auto (1)
76/06 PrimInp Port_4 (1)
76/06 DfltSw Bar (1)
76/08 Enable On (1)
76/08 SetAtten 0 dB
76/08 Master Master (1)
76/08 LoInpEna Off (0)
76/08 Service Off (0)
76/10 Enable On (1)
76/10 SetAtten 0 dB
76/10 Master Master (1)
76/10 ServiceA Off (0)
76/10 ServiceB Off (0)
SUCCESS!
CLI>
The paging 0 setting can be useful in allowing a network management system or
other interacting program to capture all CLI output at once.
Page 86
Chapter 3 Operation Using CLI
60 78-4025693-01 Rev D
Enabling Paging
When paging is enabled in CLI, a feature called Smart Paging attempts to determine
the best Telnet window size automatically. If it cannot do so, Smart Paging uses the
number of lines specified in the Paging command as the Telnet window size. Smart
Paging has no effect when paging is disabled.
Pattern Command
The pattern command is used to select one of two pattern matching styles for the
names of monitors, controls, and alarms:
wildcard pattern matching specifies the standard Windows method, which uses
*, ?, and [xyz] patterns.
regex pattern matching specifies POSIX regular expressions as used in many
Unix or Perl programs.
The default is Windows-style wildcards. When this style is in effect, CLI interprets
wildcards as shown in the following sample dialogs:
20/03 MODULE> show monitor ps*
MODID NAME VALUE UNITS
20/03 Ps1Inst 0 Inst
20/03 Ps1+24V 0 V
20/03 Ps1+5V 0 V
20/03 Ps1-5V 0 V
20/03 Ps1Temp 0 degC
20/03 Ps3Inst 1 Inst
20/03 Ps3+24V 24.4629 V
20/03 Ps3+5V 5.39218 V
20/03 Ps3-5V -5.43724 V
20/03 Ps3Temp 30.4215 degC
SUCCESS!
20/03 MODULE>
20/03 MODULE> show monitor ps*5*
MODID NAME VALUE UNITS
20/03 Ps1+5V 0 V
20/03 Ps1-5V 0 V
20/03 Ps3+5V 5.39218 V
20/03 Ps3-5V -5.43724 V
SUCCESS!
20/03 MODULE>
Page 87
Terminal Commands
78-4025693-01 Rev D 61
The Regex pattern matching style includes a much more powerful, but also more
complex, pattern matching format, a description of which is beyond the scope of this
document. For further information, refer to resources available on the public internet
for Perl or Boost, such as:
http://perldoc.perl.org/
http://www.boost.org/
Headers Command
The headers command is used to enable or disable the display of column headers
that may appear in CLI output. The basic command syntax is as follows:
headers value
where value is 0 to disable header display, and 1 (or any number other than 0) to
enable header display.
Headers are enabled (1) by default, as shown in the sample craft operator dialog
below:
20/03 MODULE> show monitor ps*5* <Enter>
MODID NAME VALUE UNITS
20/03 Ps1+5V 0 V
20/03 Ps1-5V 0 V
20/03 Ps3+5V 5.39218 V
20/03 Ps3-5V -5.43724 V
SUCCESS!
20/03 MODULE>
To following sample dialog shows how a craft operator might disable the column
headers and confirm the change:
20/03 MODULE> terminal <Enter>
TERMINAL> headers 0 <Enter>
TERMINAL> module modid 2003 <Enter>
20/03 MODULE> show monitor ps*5* <Enter>
20/03 Ps1+5V 0 V
20/03 Ps1-5V 0 V
20/03 Ps3+5V 5.39218 V
20/03 Ps3-5V -5.43724 V
SUCCESS!
20/03 MODULE>
Page 88
Chapter 3 Operation Using CLI
62 78-4025693-01 Rev D
Show Command
The show command is used to display the current values for terminal states. The
basic command syntax is as follows:
show
A typical response to this command is shown in the following sample craft operator
dialog:
TERMINAL> show <Enter>
Terminal Settings:
COLSEP ""
PAGING 24 LINES PER PAGE
PATTERN WILDCARD
HEADERS 1 (Enabled)
SUCCESS!
TERMINAL>
Page 89
78-4025693-01 Rev D 63
Introduction
The procedures in this chapter apply if you are using the Prisma II
ICIM2 front-panel interface to configure and operate the module. For
information on using CLI commands or the ICIM Web Interface to
configure and operate the module, see the Prisma II Platform Remote
User Interface Guide, System Release 2.03, part number 4025477.
Scope of This Chapter
Included in this chapter are descriptions of the ICIM front panel
keypad and liquid crystal display (LCD), and detailed procedures on
how to use the front-panel menus to configure the module.
Note: You must use CLI commands or the ICIM Web Interface to
configure and operate the module when using the ICIM2-XD. For
details, see the Prisma II Platform Remote User Interface Guide, System
Release 2.03, part number 4025477.
4 Chapter 4
Operation Using ICIM
Page 90
Chapter 4 Operation Using ICIM
64 78-4025693-01 Rev D
In This Chapter
ICIM Introduction ................................................................................. 65
ICIM Front Panel ................................................................................... 67
ICIM Password ...................................................................................... 70
Operating the ICIM .............................................................................. 75
Checking the Operating Status using the ICIM ................................ 79
Configuring the Module using the ICIM ........................................... 81
Checking Alarms using the ICIM ....................................................... 84
Checking Manufacturing Data using the ICIM ................................ 88
Saving the Configuration using the ICIM ......................................... 90
SNMP Configuration ............................................................................ 91
Community Strings .............................................................................. 94
Setting SNMP Trap Receiver Parameters .......................................... 95
New SNMP Variables........................................................................... 96
Boot Dialog for ICIM/SNMP Configuration .................................... 98
Adjusting Alarm Thresholds ............................................................. 102
Page 91
ICIM Introduction
78-4025693-01 Rev D 65
ICIM Introduction
Laser Warning
WARNING:
Avoid personal injury! Use of controls, adjustments, or procedures other
than those specified herein may result in hazardous radiation exposure.
Avoid personal injury! The laser light source on this equipment (if a
transmitter) or the fiber cables connected to this equipment emit invisible
laser radiation. Avoid direct exposure to the laser light source.
Avoid personal injury! Viewing the laser output (if a transmitter) or fiber
cable with optical instruments (such as eye loupes, magnifiers, or
microscopes) may pose an eye hazard.
Do not apply power to this equipment if the fiber is unmated or unterminated.
Do not stare into an unmated fiber or at any mirror-like surface that could reflect
light emitted from an unterminated fiber.
Do not view an activated fiber with optical instruments such as eye loupes,
magnifiers, or microscopes.
Use safety-approved optical fiber cable to maintain compliance with applicable
laser safety requirements.
Even if the unit is off, there may still be hazardous optical levels present.
Page 92
Chapter 4 Operation Using ICIM
66 78-4025693-01 Rev D
ICIM Function
The ICIM serves as the module-to-user interface and as the interface between the
Prisma II modules and TNCS or ROSA. The ICIM allows local module configuration
and status monitoring for up to 140 modules located in multiple chassis.
Important:
Do not operate any Prisma II Chassis without a fan tray installed properly. If a
fan tray is not installed in the Prisma II Chassis, the ICIM will not communicate
with any of the modules in that chassis.
All chassis connected in a daisy-chain must be powered and have a fan tray
installed. A chassis that is connected but is either not powered, or does not have
a fan tray installed will cause faulty operation of the ICIM.
All chassis connected in this daisy-chain must have a unique chassis
identification (ID) number.
The last chassis in the daisy-chain must have a terminator installed in the ICIM
OUT connector. Otherwise, faulty communication with the ICIM may occur.
ICIM Block Diagram
A block diagram representing the ICIM2 or ICIM2-XD is shown below.
Page 93
ICIM Front Panel
78-4025693-01 Rev D 67
ICIM Front Panel
ICIM2 Illustration (Front Panel)
ICIM2 Front Panel Features
Part Function
LCD screen Displays the ICIM2 menus, alarms, and status information.
12-key numeric
keypad
Used to navigate the ICIM2 menus and configure the application
modules.
Ethernet connector Directly connects the ICIM2 to an IP network. The ICIM2 Ethernet
port is suitable for connection to intra-building wiring, nonexposed wiring or cabling only.
Page 94
Chapter 4 Operation Using ICIM
68 78-4025693-01 Rev D
Yellow LED on
Ethernet connector
Glows when the Ethernet port is operating in full duplex.
Blinks when collisions occur on the Ethernet port.
Green LED on
Ethernet connector
Glows when a link is established on the Ethernet port.
Blinks during data activity on the Ethernet port.
RS232 connector Used to connect a PC to the Prisma II system for CLI
communication and setup.
ICIM2 LCD
The LCD on the front panel of the ICIM gives you a visual link to the ICIM
firmware. When the ICIM is installed and powered up, the MAIN menu appears on
the LCD.
The following illustration shows the ICIM MAIN menu.
Page 95
ICIM Front Panel
78-4025693-01 Rev D 69
ICIM Keypad
The ICIM keypad has 12 keys for monitoring parameters. The table below lists each
key and briefly describes its function.
Button Function
Displays status information for the selected module.
Displays configuration information for the selected module.
Displays all of the parameters in alarm for a selected module.
Moves the menu selection area up.
Moves the menu selection area down.
Selects the highlighted parameter.
Displays ICIM module information such as firmware version and serial
number.
Shifts function of a keypad button to the function or number label just
above that button.
Decreases numerical readings of selected configuration parameters.
Increases numerical readings of selected configuration parameters.
Enters input data (if valid).
Exits the current menu and displays the MAIN menu.
Page 96
Chapter 4 Operation Using ICIM
70 78-4025693-01 Rev D
ICIM Password
The ICIM2 lets you send configuration commands, change alarm thresholds, and
restore factory default settings in Prisma II modules. To prevent unauthorized
changes to these parameters, you can use a password protection system.
Password authorization only applies to configurable parameters. Status and alarm
information is always available on the ICIM2, regardless of password
implementation.
Password Protection System
The ICIM2 menu options available in the password protection system are shown
here.
Menu Option Description
User Psw A user-settable password.
Created, entered, and changed by the system operator(s)
Must be exactly eight digits, using only the 0-9 number keys
Change Psw Changes an existing user password
Disable Psw Disables the user password function
SA Psw A service password that is used by factory personnel only
Important: If you only want to monitor status and alarm data, simply skip the
password function when it appears on the ICIM2 menu. You can access all module
status and alarm information without a password.
However, once a user password is entered, you are required to enter it every time
you want to set configurable parameters to any module controlled by that ICIM2.
Refer to Expired Password or Inactive Password Messages (on page 71) and To
Enter the User Password (on page 71).
T o Access the Password Menu
The Password menu allows you to create, enter, change, or disable the user
password. It also allows service personnel to use the factory default password.
1 Press the
key.
2 Use the
key to scroll down until Password is highlighted.
Page 97
ICIM Password
78-4025693-01 Rev D 71
3 Press the key. The Password menu appears. User Psw is highlighted.
Expired Password or Inactive Password Messages
After entering a valid password, you are authorized to make changes to system
parameters. As a security precaution, this authorization expires automatically 10
minutes after your last keystroke.
After your authorization to change system parameters expires:
If you try to change any system parameters, the menu displays Psw Expired.
If you try to disable the password, the menu displays Failed, Password Not
Active.
If either of these messages appears, you must re-enter the password as described in
To Enter the User Password (on page 71) to renew your authorization to change
system parameters.
T o Enter the User Passwor d
To use the user password feature, you must create and enter a password of exactly
eight digits using only the 0-9 number keys.
The password remains active for 10 minutes after your last keystroke. To change
configuration parameters after 10 minutes, you must re-enter your password.
Complete the following steps to enter a user password.
1 Access the Password menu as shown in To Access the Password Menu (on page
70).
2 Press the
key. The user password menu appears.
3 When User Psw/Shift Off appears, press the
key to display Shift On, and
then enter the eight digits of your password, using the 0-9 number keys.
Page 98
Chapter 4 Operation Using ICIM
72 78-4025693-01 Rev D
To change a digit you have just typed, use the CAN (Cancel) function by
pressing the
key. This deletes the last digit typed.
4 Press the
key to enter the password. The ICIM display updates to show
whether your password entry was accepted.
If the password is accepted, the word Accepted appears in the menu, and
you are able to return to the MAIN menu.
If the password was rejected, the word Rejected appears in the menu.
Reasons for a password to be rejected include:
– Entering more than eight digits for the password.
– Pressing keys other than the 0-9 number keys.
– Entering an incorrect password if a valid password has been entered.
If the password is rejected, press the
key to return to the password
menu and re-enter the password as described in step 3 above.
T o Change the User Password
After entering a user password, you are authorized to change it as long as the
current password is active. If more than 10 minutes elapse since your last keystroke,
this authorization expires and you must re-enter the current password before
changing to a new one.
Complete the following steps to change the user password.
1 Access the Password menu as shown in To Access the Password Menu (on page
70).
2 Use the
key to scroll down until Change Psw is highlighted.
3 Press the
key to select Change Psw.
4 When Change Psw /Shift Off appears, press the
key to display Shift On,
and then enter the eight digits of your new password, using the 0-9 number keys.
Page 99
ICIM Password
78-4025693-01 Rev D 73
To change a digit you have just typed, use the CAN (Cancel) function by
pressing the
key. This deletes the last digit typed.
5 Press the
key to input the new password. The ICIM display updates to
show whether your password entry was accepted.
If the new password entry was accepted, you are able to return to the MAIN
menu.
If the new password entry was rejected:
– Press the
key to return to the password entry menu.
– Clear all digits using the CAN (Cancel) function.
– Re-enter an 8-digit password using only the 0-9 number keys.
– Press the
key to input the password.
T o Disable the User Password using ICIM
If a user password has been entered, you may disable it at any time. However, the
current password must be active prior to disabling it. If the current password has
expired (more than 10 minutes have passed since your last keystroke), you must reenter the current password before disabling it.
1 Press the
key.
2 Use the
key to scroll down until Password is highlighted.
3 Press the
key.
4 Use the
key to scroll down until Disable Psw is highlighted.
5 Press the
key to select Disable Psw.
Page 100
Chapter 4 Operation Using ICIM
74 78-4025693-01 Rev D
6 If the current password is active, the menu displays Password Is Now Disabled.
You can now make changes to parameters without any password.
7 If the current password has expired (more than 10 minutes have passed since
your last keystroke), the menu displays Failed, Password Not Active. If this
occurs, you must re-enter the current password and repeat this procedure.
Loading...