Sie sind auf Seite 1von 219

iConverter® XM5

Aggregation Demarcation Device

USER MANUAL

Release 5.2
Table of Contents
1.0 Overview............................................................................................................................5
1.1 General Description.............................................................................................................. 5
1.2 Definition of Terms................................................................................................................ 5
1.2.1 Carrier Ethernet Terms............................................................................................................................. 5
1.2.2 IEEE 802.1ag Service Operation, Administration and Maintenance (OAM)............................................. 6
1.2.3 IEEE 802.1ag Tools.................................................................................................................................. 7
1.2.4 ITU-T Y.1731 Performance Monitoring..................................................................................................... 8
1.2.5 ITU-T Y.1564............................................................................................................................................. 8
1.2.6 RFC 2544................................................................................................................................................. 9

2.0 Installation and Verification..............................................................................................12


2.1 AC Power Installation......................................................................................................... 12
2.2 DC Power Installation......................................................................................................... 12
2.3 Installing the Transceivers and Connecting the Cables...................................................... 14
2.4 Connecting To the Alarm Contact Connector...................................................................... 14
2.5 Clock I/O Connectors.......................................................................................................... 15
2.5 Serial Console Port............................................................................................................. 16
2.5.1 Serial Console Port Settings................................................................................................................... 16
2.6 Verification.......................................................................................................................... 17

3.0 Hardware Settings...........................................................................................................18


3.1 Overview............................................................................................................................. 18
3.1.1 Serial Console Port .............................................................................................................................. 18
3.1.2 Ethernet Management Port.................................................................................................................... 18
3.1.3 RJ-45 Ports............................................................................................................................................. 19
3.1.4 SFP/SFP+/XFP Ports............................................................................................................................. 19
3.1.5 Connecting To the Alarm Contact Connector.......................................................................................... 19
3.1.6 Clock I/O Connectors.............................................................................................................................. 20
3.1.7 DIP-switch Settings................................................................................................................................. 20

4.0 Module Default Settings..................................................................................................20

5.0 Command Line Interface (CLI)........................................................................................23


5.1 CLI Commands................................................................................................................... 24
5.1.1 Authentication, Authorization and Accounting (AAA).............................................................................. 24
5.1.2 Access Control List (ACL)....................................................................................................................... 29
5.1.3 Ethernet Alarm Indication Signal (AIS)................................................................................................... 31
5.1.4 Zero Touch Provisioning (AUTOCONFIG).............................................................................................. 33
5.1.5 Bandwidth Profile (BWP)........................................................................................................................ 36
5.1.5.1 Standard Ingress Rate Limiting Descriptions.......................................................................... 40
5.1.5.2 Hierarchical Rate Limiting Example........................................................................................ 44
5.1.6 Cable Test (CABLETEST)...................................................................................................................... 45
5.1.7 Connectivity Fault Management Enable/Disable (CFM)......................................................................... 46
5.1.8 IEEE 1588 Clock Input/Output (CLOCKIO)............................................................................................ 47
5.1.9 Contact (CONTACT)............................................................................................................................... 48
5.1.10 Class of Service (COS)........................................................................................................................... 50
5.1.11 Daytime Server Configuration (DAYTIME)............................................................................................. 53
5.1.12 File Directory (DIR)................................................................................................................................. 54
5.1.13 Ethernet Linear Protection Switching (ELPS)......................................................................................... 55
5.1.14 Ethernet Ring Protection Switching (ERPS)........................................................................................... 63
5.1.15 Error List (ERR)...................................................................................................................................... 72
5.1.16 Ethertype (ETHERTYPE)....................................................................................................................... 73

Page 2
5.1.17 Ethernet Virtual Connection (EVC)......................................................................................................... 74
5.1.18 Create a Script File (FILE)...................................................................................................................... 78
5.1.19 Activate FPGA Code (FPGAUPD).......................................................................................................... 79
5.1.20 Activate Firmware (FWUPDATE)............................................................................................................ 80
5.1.21 Internet Group Management Protocol (IGMP)........................................................................................ 81
5.1.21 Interface Settings (INTERFACE)............................................................................................................ 84
5.1.23 IP Configuration (IP)............................................................................................................................... 87
5.1.24 Link Aggregation Control Protocol (LACP)............................................................................................. 88
5.1.25 Layer 2 Control Protocol (L2CP)............................................................................................................ 94
5.1.26 Layer 2 Protocol Tunneling (L2PT)......................................................................................................... 98
5.1.27 IEEE 802.1ag Loopback (LBM)............................................................................................................ 101
5.1.28 IEEE 802.3ah Link OAM (LINKOAM)................................................................................................... 103
5.1.29 IEEE 802.1ab Link Layer Discovery Protocol (LLDP).......................................................................... 108
5.1.30 Physical Location (LOCATION)............................................................................................................ 114
5.1.31 Ethernet Locked Signal (LOCK)........................................................................................................... 116
5.1.32 Link Redundancy (LR).......................................................................................................................... 118
5.1.33 IEEE 802.1ag Linktrace (LTM).............................................................................................................. 120
5.1.34 Maintenance Association (MA)............................................................................................................. 123
5.1.35 MAC Table (MACTABLE)...................................................................................................................... 126
5.1.36 Maintenance Domain (MD)................................................................................................................... 127
5.1.37 Default Maintenance Domain (MDE).................................................................................................... 130
5.1.38 Maintenance Points.............................................................................................................................. 132
5.1.38.1 Maintenance End Point (MEP).............................................................................................. 132
5.1.38.2 Maintenance Intermediate Point (MIP)................................................................................. 135
5.1.39 Module Settings (MODULE)................................................................................................................. 137
5.1.40 Ping (PING).......................................................................................................................................... 139
5.1.41 Port Attributes (PORT).......................................................................................................................... 140
5.1.42 Port Statistics (PORTSTAT).................................................................................................................. 146
5.1.43 ITU-T Y.1731 Performance Monitoring................................................................................................. 147
5.1.43.1 Probe (PROBE).................................................................................................................... 147
5.1.43.2 Type 1: 2-way Delay/Variation (DMM/DMR) Probe Example................................................ 155
5.1.43.3 Type 2: 1-way Delay/Variation (1DM) Probe Example.......................................................... 158
5.1.43.4 Type 3: Single-Ended Loss/Availability (LMM/LMR) Probe Example................................... 159
5.1.43.5 Type 4: Dual Ended Loss/Availability (CCM) Probe Example............................................... 160
5.1.43.6 Type 5: Single-Ended Synthetic Loss (SLM) Probe Example............................................... 161
5.1.44 Protocol Configuration (PROTOCOL)................................................................................................... 162
5.1.45 IEEE 1588 Precision Time Protocol (PTP)........................................................................................... 164
5.1.46 Restart Module (RESTART)................................................................................................................. 167
5.1.47 Restore to Factory Defaults (RESTORE)............................................................................................. 168
5.1.48 IEEE 802.1ag Continuity Check Messages (RMEP)............................................................................ 169
5.1.49 IEEE 802.1w Rapid Spanning Tree Protocol (RSTP)........................................................................... 171
5.1.50 Run a Script File (RUN)........................................................................................................................ 175
5.1.51 Save (SAVE)......................................................................................................................................... 177
5.1.52 SFP Digital Diagnostic Information (SFP)............................................................................................. 178
5.1.53 Display the Common Configuration Parameters (SHOWCONFIG)...................................................... 180
5.1.54 Simple Network Management Protocol (SNMP).................................................................................. 181
5.1.55 Simple Network Time Protocol (SNTP)................................................................................................. 184
5.1.56 Secure Shell Protocol (SSH)................................................................................................................ 185
5.1.57 ITU-T G.8262 Synchronous Ethernet (SYNCE)................................................................................... 187
5.1.58 Syslog Server Configuration (SYSLOG)............................................................................................... 188
5.1.59 Ethernet Service Testing....................................................................................................................... 190
5.1.59.1 Overview............................................................................................................................... 190
5.1.59.2 Third-Party Test Equipment.................................................................................................. 190
5.1.59.3 Built-in Test Initiator (TESTINIT)........................................................................................... 190
5.1.59.4 Test Responder (TESTRESP).............................................................................................. 196
5.1.60 Set/Display Time of Day (TIME)........................................................................................................... 202
5.1.61 SNMP Trap Host (TRAPHOST)............................................................................................................ 203
5.1.62 SNMP Traps (TRAPS).......................................................................................................................... 204
5.1.63 Firmware Version (VER)....................................................................................................................... 209
5.1.64 Time Zones (ZONE)............................................................................................................................. 210

6.0 Specifications................................................................................................................ 211

Page 3
7.0 Appendix A: Bootloader, Firmware and FPGA Code Update ......................................212
7.1 Overview........................................................................................................................... 212
7.2 Save Current Settings....................................................................................................... 212
7.3 Copy the Module Files to Your Hard Drive........................................................................ 212
7.4 Update the Module........................................................................................................... 212
7.4.1 Updating the Bootloader, Firmware and FPGA Code Using FTP......................................................... 212
7.4.1.1 Update the Bootloader.......................................................................................................... 213
7.4.1.2 Update the FPGA Code........................................................................................................ 215
7.4.1.3 Update the Firmware............................................................................................................ 216

8.0 Customer Service Information.......................................................................................218

9.0 Warranty and Copyright.................................................................................................219

Page 4
1.0 OVERVIEW
This document describes the installation and configuration of the iConverter® XM5 Aggregation Demarcation
Device.
1.1 GENERAL DESCRIPTION
The iConverter XM5 Aggregation Demarcation Device provides aggregation and demarcation for Carrier
Ethernet 2.0 services. The XM5 Aggregation Demarcation Device supports the latest carrier-class
Ethernet Service OAM, testing and protection standards. These advanced capabilities enable rapid service
deployments, Service Level Agreement (SLA) assurances, comprehensive fault management and service
protection to reduce operating costs and improve customer satisfaction.
The advanced capabilities include IEEE 802.1ag Connectivity Fault Management (CFM), ITU-T Y.1731
Performance Monitoring and IETF RFC 2544 Ethernet Service Activation Testing. IEEE 802.1ag
Connectivity Fault Management (CFM) proactively monitors service availability and provides tools for
rapid fault isolation. ITU-T Y.1731 adds Performance Monitoring to monitor key SLA parameters including
frame delay, frame delay variation, and frame loss.
For Ethernet Service Activation Testing, the GM4 supports ITU-T Y.1564 and IETF RFC 2544. These
standards allow Service Providers to rapidly verify the configuration and performance of Ethernet services
prior to customer hand off.
1.1.1 Dual Boot Feature
The XM5 supports dual boot, which protects the module from firmware corruption if the power is lost during
the process of upgrading the firmware. The XM5 has two copies of the firmware. One is the primary copy
and the other is the backup copy. When a firmware upgrade is performed, the backup copy is upgraded
with the new firmware. Once the firmware upgrade is complete and verified, the backup copy becomes
the primary running version and the previous primary (old version) becomes the backup. If the primary
becomes corrupt for any reason, the backup version will be restored.
The dual boot feature is supported with a bootstrap version v5.2 or greater. Contact Omnitron for upgrade
details.
1.2 DEFINITION OF TERMS

1.2.1 Carrier Ethernet Terms


Ethernet Virtual Connection (EVC)
An end-to-end Ethernet service is assigned an EVC which connects two physical interfaces creating a
virtual private connection between the interfaces. The interfaces can be a User Network Interface (UNI)
or a Network to Network Interface (NNI).
Network to Network Interface
The NNI is an interface which specifies signaling and management functions between two networks.
User to Network Interface
The UNI is a demarcation point between the responsibility of the service provider and the responsibility of
the subscriber. The UNI resides at the end user location and provides Ethernet service access.
Ethertype
Ethertype is a two-octet field in an Ethernet frame indicating which protocol is used to encapsulate VLAN
information in the frame data. UNI interfaces commonly use Ethertype 0x8100 to define the frame as a
802.1Q tagged VLAN. NNI interfaces commonly use Ethertype 0x88a8 to define the frame as a 802.1ad
Service Provider tagged EVC.

Page 5
Class of Service
Class of Service (CoS) provides the means for managing traffic in a network by grouping similar types
of traffic (voice and video high priority, data low priority) into a service class and treating each class with
its own level of service priority (profiles). Traffic is classified based on the Priority Code Point (PCP),
Differentiated Service Code Point (DSCP) or Layer 2 Control Protocol (L2CP) values.
Priority Code Point (PCP) uses the three bits in the layer 2 packet header to specify priority.
Differentiated Service Code Point (DSCP) is a six bit field in an IP packet that enables different levels of
service to be assigned to the network traffic.
L2CP control is associated with Layer 2 Control Protocols. Classification of L2CP frames is based on
MAC addresses.
1.2.2 IEEE 802.1ag Service Operation, Administration and Maintenance (OAM)
IEEE 802.1ag Service OAM Connectivity Fault Management provides the capability to detect, verify, and
isolate connectivity failures. 802.1ag Service OAM uses frames called OAM Protocol Data Units (PDU)
to send/receive messages to detect loss of service connectivity and perform loopback/linktrace tests to
verify and isolate faults along an end-to-end Ethernet connection.
To create an end-to-end Ethernet service path, 802.1ag uses the concepts of Maintenance Domains,
Maintenance Associations and Maintenance End Points.
Maintenance Domain (MD)
A Maintenance Domain defines a boundary of responsibility. There can be multiple carriers providing
an Ethernet service to a customer. Each carrier defines their boundary of responsibility, or domain level.
These levels make it easy to delineate the responsibilities and make it easy to manage and detect faults
along an Ethernet service. The figure below illustrates nested domains, where the Operator and Service
Domains are nested under the Customer Domain.
The Service Provider delivers the service to the customer and monitors the performance of the service
to ensure the contracted Service Level Agreements are met. The Operator is typically a regional Local
Exchange Carrier (LEC) which often leases the network segments to a Service Provider who inturn provide
an end-to-end Ethernet service. This out-of-franchise application illustrates an end-to-end service path
between two customer locations spanning two or more Operator networks.

Maintenance Association (MA)


A Maintenance Association is a group of maintenance points that defines the physical end-to-end service path.
When a Maintenance Association is created, it is associated with a specific Maintenance Domain, VLAN
ID (EVC) and port number.

Page 6
Maintenance Points
Any port on a network may be configured as a maintenance point. A maintenance point is classified as a
Maintenance End Point (MEP) or Maintenance Intermediate Point (MIP). The table below describes the
function of each type of maintenance point.
Maintenance Maintenance
Function End Point Intermediate Point
Initiates CFM OAMPDU messages Yes No
Responds to loopback and linktrace OAMPDU messages Yes Yes
Keeps track of continuity check OAMPDU messages received Yes No
Forwards CFM OAMPDU messages No Yes

Maintenance End Point (MEP)


Maintenance End Points reside at the edge of a Maintenance Domain. MEPs generate and terminate OAM
Protocol Data Units (PDU) messages. These messages are used to detect loss of service connectivity and
perform loopback/linktrace tests. When a Maintenance End Point is created, it is associated with a specific
Maintenance Domain, Maintenance Association, VLAN ID (EVC) and port number.
A Maintenance End Point can be defined as UP or DOWN MEP. The figure below illustrates an UP and
DOWN MEP.

An UP MEP monitors the forwarding path internal to the node, while a DOWN MEP only monitors the
forwarding path external to the node. An UP MEP is configured on the ingress port, while the DOWN
MEP is configured on the egress port.
Maintenance Intermediate Point (MIP)
Maintenance Intermediate Points are internal to the domain. Maintenance Intermediate Points will forward
OAM PDUs. Maintenance Intermediate Points will forward and respond to loopback and linktrace OAM
PDUs. If the loopback message is intended for the Maintenance Intermediate Point, the loopback message
will not be forwarded.
1.2.3 IEEE 802.1ag Tools
The 802.1ag tools provide proactive fault detection and fault isolation.
Continuity Check
Maintenance End Points automatically issue Continuity Check “heartbeat” messages (OAM PDUs) to detect
loss of service connectivity between end points. Maintenance End Points will detect a loss of connectivity
when three consecutive Continuity Check messages are not received. A Remote Detect Indicator (RDI)
message will be initiated on a loss of connectivity. Once an RDI is received, a service fault alarm is generated.

Page 7
Loopback
A Loopback command can be initiated by a network administrator to verify/isolate an issue with an
end-to-end service path. Loopback is initiated from a Maintenance End Point. Loopback indicates whether
the destination is reachable. It is similar to ICMP Echo Request/Reply (PING).
Linktrace
A Linktrace command can be initiated by a network administrator to verify/isolate an issue with an end-
to-end service path. Linktrace is initiated from a Maintenance End Point. Maintenance End Points send
Linktrace request messages to each Maintenance Point along the service path. Each Maintenance Point
replies and forwards the message along the service path. Each reply indicates the path is a reachable
Maintenance Point. Linktrace is similar to IP Traceroute.
1.2.4 ITU-T Y.1731 Performance Monitoring
TU-T Y.1731 Performance Monitoring tools provide statistics for delay, variation, loss and availability
between MEPs. There are five types of measurements that can be created between MEPs. Y.1731 uses
OAM PDU to send/receive messages to measure the different performance parameters. When enabled,
the OAM PDUs run continuously until disabled. Each performance measurement uses different OAM
PDU message. They are:
1. 2-Way Delay and Delay Variation
Delay Measurement Message (DMM): 2-way delay/variation OAM PDU message
Delay Measurement Reply (DMR): 2-way delay/variation OAM PDU reply

2. 1-Way Delay Variation


One-way Delay Measurement (1DM): 1-way delay variation OAM PDU message

3. Loss and Availability


Loss Measurement Message (LMM): Single-ended loss/availability OAM PDU message
Loss Measurement Reply (LMR): Single-ended loss/availability OAM PDU reply

4. Dual-ended Loss and Availability


Continuity Check Message (CCM): Dual-ended loss/availability OAM PDU message

5. Synthetic Loss
Synthetic Loss Message (SLM): Single-ended loss OAM PDU message
Synthetic Loss Reply (SLR): Single-ended loss OAM PDU reply

1.2.5 ITU-T Y.1564


ITU-T Y.1564 is a Carrier Ethernet service activation test methodology for turning up, installing and
troubleshooting Ethernet-based services. The test methodology allows for complete validation of an
Ethernet service-level agreement (SLA) in a single test.
ITU-T Y.1564 defines test streams with specific attributes identified by different classifiers such as 802.1Q
VLAN, 802.1ad and class of service (CoS) profiles. These services are defined at the UNI level with
different frame and bandwidth profile such as frame size, committed information rate (CIR), and excess
information rate (EIR).

Page 8
1.2.6 RFC 2544
Ethernet connections must be tested to ensure that they are operating correctly and performing to the required
levels. RFC 2544 specifies certain test criteria to validate the operation and service level agreements of
the Ethernet connection. RFC 2544 performs specific tests using standard frame sizes (64, 128, 256, 512,
1024, 1280 and 1518 bytes).
Frame Loss
Frame loss is the number of frames that were transmitted from the source but were never received at the
destination. Frames can be lost or dropped.
Latency
Latency is the total round trip time for a frame to travel from source to destination and back. The round trip
time is the sum of the processing delays in the network and the propagation delay along the transmission path.
Throughput
Data throughput is the maximum amount of data that can be transported from source to destination. The
maximum throughput for various frame sizes is shown on the next page:
100 Mbps:
Frame Down MEP Down MEP Down MEP
Size Throughput Overhead Frames/sec
64 byte 76.19 Mbps 23.81 Mbps 148,809
128 byte 86.49 Mbps 13.51 Mbps 84,459
256 byte 92.75 Mbps 7.25 Mbps 45,289
512 byte 96.24 Mbps 3.76 Mbps 23,496
1024 byte 98.08 Mbps 1.92 Mbps 11,973
1280 byte 98.46 Mbps 1.54 Mbps 9,615
1518 byte 98.69 Mbps 1.30 Mbps 8,127
Frame Up MEP Up MEP Up MEP
Size Throughput Overhead Frames/sec
64 byte 72.72 Mbps 27.28 Mbps 142,045
128 byte 84.21 Mbps 15.79 Mbps 82,236
256 byte 91.42 Mbps 8.58 Mbps 44,642
512 byte 95.52 Mbps 4.48 Mbps 23,320
1024 byte 97.70 Mbps 2.30 Mbps 11,927
1280 byte 98.15 Mbps 1.85 Mbps 9,585
1518 byte 98.44 Mbps 1.56 Mbps 8,106

Page 9
1000 Mbps:
Frame Down MEP Down MEP Down MEP
Size Throughput Overhead Frames/sec
64 byte 761.90 Mbps 238.10 Mbps 1,488,095
128 byte 864.86 Mbps 135.14 Mbps 844,594
256 byte 927.54 Mbps 72.46 Mbps 452,898
512 byte 962.40 Mbps 37.59 Mbps 234,962
1024 byte 980.84 Mbps 19.16 Mbps 119,731
1280 byte 984.61 Mbps 15.38 Mbps 96,153
1518 byte 986.99 Mbps 13.00 Mbps 81,274
Frame Up MEP Up MEP Up MEP
Size Throughput Overhead Frames/sec
64 byte 727.27 Mbps 272.73 Mbps 1,420,454
128 byte 842.11 Mbps 157.89 Mbps 822,368
256 byte 914.28 Mbps 85.72 Mbps 446,428
512 byte 955.22 Mbps 44.78 Mbps 233,208
1024 byte 977.09 Mbps 22.91 Mbps 119,274
1280 byte 981.59 Mbps 18.41 Mbps 95,858
1518 byte 984.43 Mbps 15.57 Mbps 81,063
10Gbps:
Frame Down MEP Down MEP Down MEP
Size Throughput Overhead Frames/sec
64 7,619.04 Mbps 2,380.95 Mbps 14,880,952
128 8,648.64 Mbps 1,351.35 Mbps 8,445,946
256 9,275.36 Mbps 724.63 Mbps 4,528,986
512 9,624.06 Mbps 375.93 Mbps 2,349,624
1024 9,808.42 Mbps 191.57 Mbps 1,197,318
1280 9,846.15 Mbps 153.84 Mbps 961,538
1518 9,869.96 Mbps 130.03 Mbps 812,744

Frame Up MEP Up MEP Up MEP
Size Throughput Overhead Frames/sec
64 7,272.72 Mbps 2,727.27 Mbps 14,204,545
128 8,421.05 Mbps 1,578.94 Mbps 8,223,684
256 9,142.85 Mbps 857.14 Mbps 4,464,286
512 9,552.23 Mbps 447.76 Mbps 2,332,090
1024 9,770.99 Mbps 229.00 Mbps 1,192,748
1280 9,815.95 Mbps 184.04 Mbps 958,589
1518 9,844.35 Mbps 155.64 Mbps 810,636

Page 10
Ethernet devices must allow a minimum idle period between transmission of Ethernet frames known as
the inter-frame gap (IFG) or inter-packet gap (IPG). The minimum inter-frame gap period is 96 bits or
12 bytes + 7 bytes of preamble and 1 byte of delimiter (20 bytes of overhead). An additional 4 bytes are
added for UP MEP interface to include one VLAN tag (24 bytes of overhead).
Down MEP Calculation (1000Mbps interface rate):
Frames/sec = 1 second / ((frame size + 20) x 8ns)
Throughput (Mbps) = frames/sec x frame size x 8
Up MEP Calculation (1000Mbps interface rate):
Frames/sec = 1 second / ((frame size + 24) x 8ns)
Throughput (Mbps) = frames/sec x frame size x 8
Back-to-back
Back-to-back test sends a burst of frames with minimum inter-frame gaps to the responder module. The
frames are returned and counted by the initiator module. If the count of transmitted frames is equal to
the number of frames returned the length of the burst is increased and the test is rerun. The back-to-back
value is the number of frames with the longest burst that the responder module can handle without any
loss of frames.
NOTE: For RFC 2544 back-to-back measurements on UP MEP interfaces, the -bits or -rp command
must be used to alter the number of bits or rate for each frame size based on the table above.
For a 64 byte frame, the -bits value will be 727000000 or the -rp value will be 72.7 (assuming 1000Mbps
interface rate).

Page 11
2.0 INSTALLATION AND VERIFICATION
2.1 AC POWER INSTALLATION
To power the XM5, attach the AC power cord to the Power Receptacle on the front of the unit and plug
into the AC outlet. Confirm the XM5 has powered up properly by checking the status of the Power LED
located on the front of the XM5.
Installation of the equipment should be such that the air flow in the front, back, side and top vents of the
XM5 are not compromised or restricted.
If the installation requires grounding, secure the grounding wire to the ground screws. See the figure below
for the location of the grounding screws.

Front View with AC Connector

Back View with Grounding Screws and DIP-switches

WARNING!!!
NEVER ATTEMPT TO OPEN THE CHASSIS OR SERVICE THE
POWER SUPPLY OR FAN MODULE. OPENING THE CHASSIS
MAY CAUSE SERIOUS INJURY OR DEATH.
THERE ARE NO USER REPLACEABLE OR SERVICEABLE
PARTS IN THIS UNIT.

2.2 DC POWER INSTALLATION


A power source should be available within 5 ft. of the XM5. The over current protection for connection
with centralized DC shall be provided in the building installation, and shall be a UL listed circuit breaker
rated 20 Amps, and installed per the National Electrical Code, ANSI/NFPA-70.
The XM5 requires +/- 20 to 60VDC (48VDC @ 1.2 Amp max rated power). Appropriate overloading
protection should be provided on the DC power source outlets utilized.

WARNING: Only a DC power source that complies with


safety extra low voltage (SELV) requirements can be
connected to the DC-input power supply.

Page 12
WARNING REGARDING EARTHING GROUND:
o This equipment shall be connected to the DC supply
system earthing electrode conductor or to a bonding
jumper from an earthing terminal bar or bus to which the
DC supply system earthing electrode is connected.
o This equipment shall be located in the same immediate
area (such as adjacent cabinets) as any other equipment
that has a connection between the earthed conductor of
the same DC supply circuit and the earthing conductor,
and also the point of earthing of the DC system. The DC
system shall not be earthed elsewhere.
o The DC supply source is to be located within the same
premises as this equipment.
o There shall be no switching or disconnecting devices in
the earthed circuit conductor between the DC source and
the earthing electrode conductor.

Locate the DC circuit breaker of the external power source, and switch the circuit breaker to the OFF position.
Prepare a power cable using a three conductor insulated wire (not supplied) with a 14 AWG gauge minimum.
Cut the power cable to the length required.
Strip approximately 3/8 of an inch of insulation from the power cable wires.
Connect the power cables to the terminal by fastening the stripped ends to the DC power connector.
WARNING: Note the wire colors used in making the positive, negative and ground connections. Use
the same color assignment for the connection at the circuit breaker.
Connect the power wires to the circuit breaker and switch the circuit breaker ON. The Power LED will
indicate the presence of power.
Installation of the equipment should be such that the air flow in the front, back and side vents of the XM5
are not compromised or restricted.
If the installation requires grounding, secure the grounding wire to the ground screws. See the figure below
for the location of the grounding screws.

Front View with Single DC Terminal Connector

Front View with Dual DC Terminal Connector

Back View with Grounding Screws and DIP-switches

Page 13
WARNING!!!
NEVER ATTEMPT TO OPEN THE CHASSIS OR SERVICE THE
POWER SUPPLY OR FAN MODULE. OPENING THE CHASSIS
MAY CAUSE SERIOUS INJURY OR DEATH.
THERE ARE NO USER REPLACEABLE OR SERVICEABLE
PARTS IN THIS UNIT.

Depending on the model number of the unit, a second power source is available. Use the same power
supply installation procedure above for the second power supply.
2.3 INSTALLING THE TRANSCEIVERS AND CONNECTING THE CABLES
The SFP interfaces support SERDES 100BASE-FX, 1000BASE-X fiber transceivers and/or SGMII
10/100/1000BASE-T copper transceivers.
The SFP+/SFP interfaces support 10G Ethernet fiber transceivers up to power level 2 devices and
1000BASE-X fiber transceivers. The XFP interfaces support 10G Ethernet fiber transceivers up to power
level 4 devices.
a. Insert the fiber or copper transceivers into the SFP/XFP receptacles on the XM5.
NOTE: The release latch of the transceiver must be in the closed (up) position before insertion.
The XM5 has the ability to detect the speed and automatically configure the port to match the speed of
approved transceivers. Some fiber transceivers will need to be configured using the port CLI commands
to configure the speed of the port to match the speed of the installed SFP transceiver.
b. Connect the appropriate multimode or single-mode fiber cable to the fiber port on the XM5. When using
dual fiber, it is important to ensure that the transmit (TX) is attached to the receive side of the device
at the other end and the receive (RX) is attached to the transmit side. Single-fiber (SF) transceivers
operate in pairs. The TX wavelength must match the RX wavelength at the other end and the RX
wavelength must match the TX wavelength at the other end.
c. Connect the RJ-45 port via a Category 5 or better cable to a 10BASE-T, 100BASE-TX or 1000BASE-T
Ethernet device (depending on the configuration of the port).
2.4 CONNECTING TO THE ALARM CONTACT CONNECTOR
The alarm contact connector is located on the front of the unit and is used to alert of an internal alarm
conditions and detect the state of external alarm conditions.
The pinout for the alarm contact is shown below.

Alarm Contact Connector Pinout

Pin Function
1 Normally Open - Output
2 Common - Output
3 Normally Closed - Output
4 Detection - Input
5 Ground

Alarm Contact Description

Page 14
The internal alarm (labeled OUT on the alarm contact connector) can be configured to activate when the
fan or power circuit is indicating an alarm condition. The internal alarm is configured using the contact
command. When activated, the normally open relay contact closes and the normally closed relay contact
opens.
The external alarm sensor (labeled IN on the alarm contact connector) can detect if the wired circuit is open
or closed. The change of state of the wired circuit (open/close) will generate a SNMP trap. An example
is the detection of an open door alarm.
The figure below illustrates the internal and external alarm circuitry (shown in the shaded box).

Alarm Contact Connector


Use the supplied connector to attach the wire to the internal and external alarm pins. Use 16 - 24 AWG wire.
WARNING: Never apply an active circuit or voltage to the pins 4 and 5.
2.5 CLOCK I/O CONNECTORS
The clock I/O connectors are located on the front of the unit and can be configured as inputs or outputs to
support IEEE 1588 clock requirements. Not all models support this hardware feature.

Clock I/O
Two BNC connectors are provided. See Section 5.1.8 for more information on configuring the connectors.
The table below defines the LED indicators associated with the connectors.
LED Color OFF State ON State
Clk1 Clock 1 is not configured as an input Clock 1 is configured as an input
Green
In
Clk1 Clock 1 is not configured as an output Clock 1 is configured as an output
Green
Out
Clk2 Clock 2 is not configured as an input Clock 2 is configured as an input
Green
In
Clk2 Clock 2 is not configured as an output Clock 2 is configured as an output
Green
Out

Clock I/O LED Indicators

Page 15
2.5 SERIAL CONSOLE PORT
To configure the XM5 using the serial port, attach a RS232 serial equipped computer with terminal emulation
software such as Procomm or Putty to the serial console port on the XM5. The Serial Console Port (DCE)
is a RJ-45 connector (per EIA/TIA-561).
The serial console port is located on the front of the XM5. Attach the ends of the serial adapter cable to
the serial port of the PC and to the RJ-45 Serial Console Port of the XM5. The port is a standard RS-232
asynchronous serial interface.
The RJ-45 serial pin-outs are illustrated below.

RJ-45 Serial Pin Outs

2.5.1 Serial Console Port Settings


Start the terminal emulation program and select the correct COM Port. Set the serial port to the following:
Bits Per Second 115,200
Data Bits 8
Stop Bits 1
Hardware Flow Control NONE
Parity NONE

Page 16
2.6 VERIFICATION
Verify the XM5 is operational by viewing the status of the LED indicators. The table below provides a
description for each LED indicator.
The Power LED(s) indicate the XM5 is receiving power from the external power source.
The port LEDs indicate the state of connection between link partners. A blinking port activity LED indicates
the presence of data.
LED Function
Color OFF State ON/Blinking State
“Legend”
Power Green/ Solid Green: Module has power
No power
“Pwr A” Yellow Blinking Yellow (10Hz): Fan Alarm
Power
Green/ Solid Green: Module has power
“Pwr B” No Power
Yellow Blinking Yellow (10Hz): Fan Alarm
(Dual power models only)
Solid Green: Port linked at 100M
P1 - P12 Link Activity
Green Port not linked at 100M Blinking Green (10Hz): Data activity
“100”
Blinking Green (1Hz): Far-end fault detected but no link
Solid Green: Port linked at 1G
P1 - P12 Link Activity
Green Port not linked at 1G Blinking Green (10Hz): Data activity
“1G”
Blinking Green (1Hz): Auto-negotiation detected but no link
Solid Green: Port linked at 100M
P13 and P14 Link Activity
Green Port not linked at 100M Blinking Green (10Hz): Data activity
“100”
Blinking Green (1Hz): Far-end fault detected but no link
Solid Green: Port linked at 1G
P13 and P14 Link Activity
Green Port not linked at 1G Blinking Green (10Hz): Data activity
“1G”
Blinking Green (1Hz): Auto-negotiation detected but no link
P13 and P14 Link Activity Solid Green: Port linked at 10M
Green Port not linked at 10M
“100” and “1G” Blinking Green (10Hz): Data activity
Solid Green: Port linked at 10G
P15 and P16 Link Activity
Green Port not linked Blinking Green (10Hz): Data activity
“10G”
Blinking Green (1Hz): Energy detected but no link
Solid Green: Port linked at 1G
P15 and P16 Link/Act
Green Port not linked Blinking Green (10Hz): Data activity
“1G”
Blinking Green (1Hz): Energy detected but no link
Solid Green: Port linked at 100M
Mgmt
Green Port not linked at 100M Blinking Green (10Hz): Data activity
“100”
Blinking Green (1Hz): Far-end fault detected but no link
Solid Green: Port linked at 1G
Mgmt
Green Port not linked at 1G Blinking Green (10Hz): Data activity
“1G”
Blinking Green (1Hz): Auto-negotiation detected but no link
Mgmt Solid Green: Port linked at 10M
Green Port not linked at 10M
“100” and “1G” Blinking Green (10Hz): Data activity

LED Indicators

Page 17
3.0 HARDWARE SETTINGS
3.1 OVERVIEW
The front panel of the XM5 provides access to the RJ-45 (fixed copper) and SFP/SFP+/XFP Ethernet ports
as well as the serial console, rest button, alarm contacts, clock I/O ports and power connectors. The back
panel of the XM5 provides access to the DIP-switches. The reset button when pushed will reboot the module.

Front Panel Layout

Rear Panel Layout

3.1.1 Serial Console Port


The XM5 features a RS-232 Serial Console Port (aka Craft Interface) which can be connected to a computer
for initial setup and configuration. The Serial Console Port is accessed through the a RJ-45 port on the
front of the unit. Attach the ends of the serial adapter cable to the serial port of the PC and to the RJ-45
Serial Console Port of the XM5.
3.1.2 Ethernet Management Port
The XM5 supports a dedicated 10/100/1000Mbps Ethernet management port. The port supports auto-
negotiation and auto MDI/MDI-X crossover. The physical port is referred to as Port 17 in the Command
Line Interface (CLI).

Page 18
3.1.3 RJ-45 Ports
The RJ-45 Ethernet ports support 10BASE-T, 100BASE-TX and 1000BASE-T protocols, auto-negotiation,
auto MDI/MDI-X crossover and can be manually forced to a specific speed and duplex mode using the
port command. See Section 5.1.41 for more information.
3.1.4 SFP/SFP+/XFP Ports
The SFP interfaces support SERDES 100BASE-FX, 1000BASE-X fiber transceivers and/or SGMII
10/100/1000BASE-T copper transceivers. The SFP interfaces operate in manual mode or auto-negotiation
and support full duplex operation.
NOTE: When using 100BASE-FX and SGMII SFPs, the port must be manually configured using
the Command Line Interface (CLI). Interface settings can be changed using the port command. See
Section 5.1.41 for more information.
The SFP+/SFP interfaces support 10G Ethernet fiber transceivers up to power level 2 devices and
1000BASE-X fiber transceivers.
The XFP interfaces support 10G Ethernet fiber transceivers up to power level 4 devices.
3.1.5 Connecting To the Alarm Contact Connector
The alarm contact connector is located on the front of the unit and is used to alert of an internal alarm
conditions and detect the state of external alarm conditions.
The pinout for the alarm contact is shown below.

Alarm Contact Connector Pinout

Pin Function
1 Normally Open - Output
2 Common - Output
3 Normally Closed - Output
4 Detection - Input
5 Ground

Alarm Contact Description

Page 19
3.1.6 Clock I/O Connectors
The clock I/O connectors are located on the rear of the unit and can be configured as inputs or outputs to
support IEEE 1588 clock requirements. Not all models support this hardware feature.

Clock I/O
BNC clock I/O connectors can be configured as inputs or outputs. See Section 5.1.8 for more information
on configuring the ports.
3.1.7 DIP-switch Settings
These DIP-switches are reserved and must be in the OFF (default) position.

4.0 MODULE DEFAULT SETTINGS


The XM5 has the following defaults.
IP
IP Address 192.168.1.220
IP Subnet Mask 255.255.255.0
IP Gateway 192.168.1.1
TFTP Server IP Address 255.255.255.255
Protocols
IP Enabled
Telnet Enabled
FTP Disabled
DHCP Client Disabled
BOOTP Disabled
TFTP Disabled
ZTP Disabled
Passwords
Serial No password assigned (default username: admin)
FTP No password assigned (not enabled)
Telnet public (default username: admin)
SSH public (default username: admin)
SNMPv1/v2c Communities
Read Community Name public
Write Community Name public
SNMPv1/v2c agent enabled

Page 20
SNMPv3 Parameters
SNMPv3 agent enabled
User 1 Type read-only
User 1 Name guest
User 1 security level noAuthNoPriv
User 1 privacy password publicguest
User 1 authentication password publicguest
User 2 Type admin
User 2 Name admin
User 2 security level noAuthNoPriv
User 2 privacy password privateadmin
User 2 authentication password privateadmin
User 3 Type deny
User 3 Name guest1
User 3 security level noAuthNoPriv
User 3 privacy password publicguest
User 3 authentication password publicguest
User 4 Type deny
User 4 Name guest2
User 4 security level noAuthNoPriv
User 4 privacy password publicguest
User 4 authentication password publicguest
General SNMP Parameters
SNMP trap type SNMPv2c
Other Networking Parameters
DHCP Port Number Port 1
DHCP VLAN ID 0 (untagged)
Keep Alive Trap Disabled
Keep Alive Trap interval 10 seconds
Pause Disabled
The XM5 supports passwords for the Serial port, Telnet, FTP, SNMPv1 and v3. It is highly recommended
that the passwords be changed in order to prevent unauthorized access to the module.

Page 21
After power is applied to the XM5, all green LEDs on the XM5 blink while the system is booting. Once
fully booted, the LEDs stop blinking and the fan throttles down to a slower speed.

> No network interfaces found


Jaguar-1 board detected (VSC7460 Rev. B).

Version: vx.x.x

Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
Free Software Foundation, Inc.
RedBoot is free software, covered by the eCos license, derived from the
GNU General Public License. You are welcome to change it and/or distribute
copies of it under certain conditions. Under the license terms, RedBoot’s
source code and full license terms must have been made available to you.
Redboot comes with ABSOLUTELY NO WARRANTY.

Platform: VCore-III (MIPS32 24KEc) JAGUAR


RAM: 0x80000000-0x90000000 [0x8003b158-0x8ffb0000 available]
FLASH: 0x40000000-0x40ffffff, 64 x 0x40000 blocks
FLASH: 0x41000000-0x41ffffff, 64 x 0x40000 blocks
== Executing boot script in 3.000 seconds
RedBoot> diag -a
Hardware self-test: ... Passed
IS0 TCAM self-test: ... Passed
IS1 TCAM self-test: ... Passed
IS2 TCAM self-test: ... Passed
ES0 TCAM self-test: ... Passed
L3 TCAM self-test: ... Passed
DDR SDRAM: Testing [0x8003b158-0x8ffb0000] - Zero Sweep Done
DDR SDRAM: Testing [0x8003b158-0x8ffb0000] - Write Sweep ..................................
..................................... Done
DDR SDRAM: Testing [0x8003b158-0x8ffb0000] - Read Sweep ...................................
.................................... Done
3 tests completed successfully.
RedBoot> fis load -d managed
Image loaded from 0x80040000-0x81243194
RedBoot> go

Mounting File System ................


File system mount successful.
..
Omnitron Systems Technology, Inc. iConverter
Copyright 2001-2014 OST, Inc. Password Entry

--------------------------------------------------------------------------------
Omnitron Systems Technology Technical Support: (949) 250-6510
38 Tesla Sales/Products: (800) 675-8410
Irvine, CA 92618 On the web at: www.omnitron-systems.com
-------------------------------------------------------------------------------

IP address 192.168.1.220
MAC xx-xx-xx-xx-xx-xx
Serial number 00710881

Please enter the username >

Once the XM5 has booted, an Entry screen will be displayed on the attached PC. If a password has been
configured, enter the username and password, and press <ENTER>. A system prompt, ‘>’, will be displayed.
The XM5 is ready for CLI input.

Page 22
5.0 COMMAND LINE INTERFACE (CLI)
The Command Line Interface (CLI) is used to configure the XM5.
At the prompt (>), enter ?, help or h to view the command options.

>?

CLI Command summary


For more help on a specific command, type the <command> -h

Command Description
aaa Authentication, Authorizaton, Accounting Configuration
acl Access Control List for management access
ais Alarm Indication Signal
autoconfig Automatic Module Configuration
bwp Bandwidth profile command
cabletest Copper cable test
cfm CFM global configuration command
clockio Clock I/O configuration
contact Contact closure configuration
cos Class of service configuration
daytime Daytime protocol configuration
dir List the existing files
elps Configures Ethernet Linear Protection Switching
erps Configures Ethernet Ring Protection Switching
err CFM error list status
ethertype Module Ethertype selection for customer and network ports
evc Module Ethernet Virtual Connection configuration
exit Log user out
file File open and close command
fpgaupd Updates the FPGA firmware
fwupdate Update module firmware
h Display the CLI command summary (same as help command)
help Display the CLI command summary
igmp IGMP configuration
interface Module port interface configuration
ip IP Configuration for network 1
lacp LACP/LAG configuration
l2cp Layer 2 Control Protocol configuration
l2pt Layer 2 Protocol Tunneling configuration
lbm CFM loopback message configuration
linkoam Link OAM (802.3ah) configuration
lldp Link Layer Discovery Protocol configuration
location Displays module location information
lock Ethernet Locked Signal (ETH-LCK)
lr Link Redundancy configuration
ltm CFM Linktrace configuration
ma CFM maintenance association configuration
mactable MAC table
md CFM maintenance domain configuration
mde CFM default maintenance domain setup
mep CFM maintenance end point configuration
mip CFM maintenance intermediate point configuration
module Displays module global information
ping Generates a ping to a remote device
port Port attribute configuration
portstat Displays current stats for each port
probe CFM performance metric probe
protocol Protocol configuration
ptp Precision Time Protocol configuration
restart Restarts the module

Page 23
restore Restore local or factory defaults
rmep CFM remote MEP configuration
rstp Rapid spanning tree configuration
run Execute script file
save Stores configuration changes into permanent memory
sfp Displays SFP port information
showconfig Shows basic configuration information
snmp SNMP Configuration
sntp Simple Network Time Protocol configuration
ssh Secure shell configuration
synce Configure a port to operate in synchronous Ethernet mode
syslog Syslog server configuration and log access
testinit Test Initiator
testresp Test Responder
time Displays the module time of day
traphost SNMP Trap Host configuration
traps Module trap setup
ver Displays the firmware version
x Log user out
zone Time zone help
? Display the CLI command summary (same as help command)

Type -h after the desired command for configuration options.


Type exit or x to log out and return to the Entry screen.

Omnitron Systems Technology, Inc. iConverter


Copyright 2001-2014 OST, Inc. Password Entry

--------------------------------------------------------------------------------
Omnitron Systems Technology Technical Support: (949) 250-6510
38 Tesla Sales/Products: (800) 675-8410
Irvine, CA 92618 On the web at: www.omnitron-systems.com
-------------------------------------------------------------------------------

IP address 192.168.1.220
MAC xx-xx-xx-xx-xx-xx
Serial number 00710881

Please enter the username >

NOTE: The commands in the CLI take effect immediately, but the save command must be used to
ensure the information is retained when the power is removed from the module. If the save command
is not used, the configuration changes will be lost.
5.1 CLI COMMANDS
The commands are presented in alphabetical order and are not meant as a configuration guide. Each
command has an explanation and configuration example.
5.1.1 Authentication, Authorization and Accounting (AAA)
The module supports Authentication, Authorization and Accounting (AAA), Remote Authentication Dial-In
User Service (RADIUS), Terminal Access Controller Access-Control System Plus (TACACS+) and Port
Based Network Access Control (802.1X).
AAA is a framework for controlling access to computer resources, enforcing policies, auditing usage and
providing the information necessary to bill for services. AAA configures the client type console, FTP, SSH,
Telnet and the method TACACS+, RADIUS, local, or none.

Page 24
Remote Authentication Dial-In User Service (RADIUS) is a client/server system that secures networks
against unauthorized access. When a user tries to access a specific module, the RADIUS server is contacted
for validation of a correct user name and password.
The user receives one of the following responses from the RADIUS server:
ACCEPT - The user is authenticated.
REJECT - The user is not authenticated and is prompted to reenter the username and password, or
access is denied.
CHALLENGE - A challenge is issued by the RADIUS server and is attempting to collect additional
information from the user including username and password.
CHANGE PASSWORD - A request is issued by the RADIUS server asking the user to select a new
password.
RADIUS is a stateless protocol using UDP, running on Port 1812 between the Client and the Server. A
shared secret key is used to encrypt passwords and exchange responses between the client and the server.
Terminal Access Controller Access-Control System Plus (TACACS+) is a connection oriented Authentication,
Authorization, and Accounting (AAA) protocol. TACACS+ is used to authenticate, authorize, and
accounting for TCP connections.
TACACS+ implements the following functions:
Authentication is the action of determining who a user (or entity) is and provides complete control of
authentication through login and password dialog, challenge and response and messaging support.
Authorization is the action of determining what a user is allowed to do and provides fine-grained control
over user capabilities for the duration of the user’s session.
Accounting is the action of recording what a user is doing, and/or has done and collects and sends
information used for billing, auditing, and reporting to the TACACS+ demon.
When a user attempts to log in to a device the control passes to the TACACS+ server which provides the
challenge and the user provides the response. This is typically user name, password, and other challenge
questions. The information passed between the module and the TACACS+ server is encrypted based upon
the TACACS+ protocol specification,
The module will eventually receive one of the following responses from the TACACS+ server during the
authentication phase:
ACCEPT - The user is authenticated and service may begin. If the module is configured to require
authorization, authorization begins.
REJECT - The user has failed to authenticate. The user may be denied further access, or will be prompted
to retry the login sequence depending upon how the TACACS+ server is configured.
ERROR - An error occurred at some time during the authentication. If an ERROR response is received,
the module will typically try to us an alternative method for authenticating the user.
CONTINUE - The user is prompted for additional authentication information.
Once the Authentication phase is complete, the Authorization phase begins (if configured on the module).
The module again contacts the TACACS+ server and it returns an ACCEPT or RETURN authorization
response. If an ACCEPT response is returned, the response contains attributes that are use to direct the
services that the user can access.
Port Based Network Access Control is defined in IEEE 802.1X. It uses EAPoL (Ethernet Authentication
Protocol over LAN) to communicate between the Supplicant (Client), Authenticator (Ethernet switch) and
Authentication Server.

Page 25
The Supplicant, or Client, is connected to a port that needs to be authenticated via the EAP Server. EAP
Start Frames are sent from the Supplicant to the Authenticator.
The Authenticator, or switch, requests information from the Supplicant and strips the EAP information
from the EAP Ethernet frame and places that information into a RADIUS frame and transmits the frames
towards the EAP RADIUS server. The Authenticator also passes information from the EAP Server to
the Supplicant in the reverse process.
The EAP Server receives the EAP requests and proceeds with the Challenge-Response sequence and
finally allows or denies access to the port.
The aaa command provides the ability to configure AAA, RADIUS, TACACS+ and 802.1X parameters.
To configure AAA, use the aaa option from the CLI prompt. A list of options is displayed when the aaa -h
command is entered.
> aaa -h

Description: Authentication, Authorization, Accounting Configuration


Format: aaa [-h [-ver]|-s] [{-dis|ena} aaa|radius|tacacs+|802.1x]
[-ty aType] [-host iphostlist] [-key aKey] [-p portNum]
[-ptype pmode] [-reauth atime] [-retry rtime] [-to toval] [-retran rnum]
[-l4port a1,a2,a3] [-method client:authlist]
Switches:
-dis disable function: {aaa|radius|tacacs+|802.1x}
-ena enable function: {aaa|radius|tacacs+|802.1x}
[aaa] authentication, authorization, accounting, default disable
[radius] radius protocol, default disabled
[tacacs+] TACACS+ protocol, default disabled
[802.1x] port based access control (802.1x), default disabled
-h display help information
-host selects AAA hosts, [iphostlist]: {host1,..,hostn}
-key selects AAA server key, [aKey], default not defined
-l4port selects AAA Layer 4 port numbers, [a1,a2,a3]:
a1: authentication port number {1..65535}, def 49
a2: authorization port number {1..65535}, def 49
a3: accounting port number {1..65535}, def 49
-method selects authentication per client [client] per method [authlist]
[authlist] authentication list: {local,none,tacacs+,radius}
[client] client list: {console|ftp|ssh|telnet}
-p selects AAA physical port numbers, [portNum]: {1..n|all}, default all
-ptype selects port authentication mode, [pmode]: {auto,mac,on,off}, default on
[auto] configures standard 802.1X authentication on a port
[mac] configures 802.1X MAC bypass authentication on a port
[on] configures a port to be always authorized, 802.1X disabled
[off] configures a port to be always unauthorized
-reauth selects the 802.1X reauthorize time, [atime] in sec: {0..65535}, def 0
a value of zero indicate that reauthorization is not required
-retran selects how many times the module transmits a RADIUS server request,
[rnum]: {0..10}, default 2
-retry selects 802.1X EAP retry time, [rtime] in sec: {1..60}, default 30
-s shows current AAA settings
-to selects AAA server timeout before error declared, [toval] in seconds:
{0...65535}, default 60s
-ty selects configuration type, [aType]: {radius|tacacs+|802.1x}
-ver verbose help

>

The options available using the aaa command are shown below.
The -dis switch disables one of the following functions:

Page 26
aaa disables authentication, authorization, and accounting, default.
radius disables RADIUS (RFC 2865, RFC 2866), default.
tacacs+ disables TACACS+ , default.
802.1x disables port based access control (IEEE 802.1X), default.
The -ena switch enables one of the following functions:
aaa enables authentication, authorization, and accounting.
radius enables RADIUS (RFC 2865, RFC 2866).
tacacs+ enables TACACS+.
802.1x enables port based access control (IEEE 802.1X).
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -host switch configures the IP address of the host. The -ty command specifies the type of host.
The -key switch configures the secret key used to encrypt and decrypt AAA PDU information between
the host and the server.
The -l4port switch configures the TCP or UDP port numbers for the AAA protocol in the following
order: authenticate port (a1), authorization port (a2), accounting port (a3).
The -method switch selects the authentication method for each client (client:authentication).
client supports console,ftp,ssh,telnet.
authentication method options are tacacs+, radius, local, or none.
The -p switch selects the port on the module that is associated with the AAA protocol. The default is all
ports.
The -ptype switch selects the port authentication mode:
auto configures 802.1X authentication on the port.
mac configures 802.1X MAC bypass authentication on the port.
on configures a port to be authorized, disabling 802.1X EAP.
off configures a port to be unauthorized, blocking the port permanently and disabling 802.1X EAP.
The -reauth switch configures the port reauthorization time. 0 to 65535 seconds are valid time settings.
A value of 0 indicates reauthorization is not required.
The -retran switch configures the number of times the module transmits a server request before an
ERROR is declared. The default is 2.
The -retry switch configures the 802.1X retry time (1 to 60 seconds) for new EAP request identify PDU.
The default time value is 30 seconds.
The -s switch displays current AAA settings.
The -to switch configures the AAA server wait timeout value in seconds. When the value expires, the
server will declare an ERROR. A value of 0 disables the timer. The default value is 60 seconds.
The -ty switch configures the AAA protocol type, RADIUS, TACACS+ or 802.1x.
The -ver switch displays the extended help screen.

Page 27
To display the configuration, use the aaa -s command.

> aaa -s

AAA: Disabled

Authentication Method:
Console: local
Telnet: local
FTP: local
SSH: local

TACACS+: Disabled
Server(s):
Authentication Port: 49
Authorization Port: 49
Accounting Port: 49
Key:
Timeout (sec): 60s

RADIUS: Disabled
Server(s):
Authentication Port: 1812
Accounting Port: 1813
Key:
Timeout (sec): 60s
Number of retries: 2

802.1X: Disabled
Port 1: on, retry = 30s, reauthorize = 0s
Port 2: on, retry = 30s, reauthorize = 0s
Port 3: on, retry = 30s, reauthorize = 0s
Port 4: on, retry = 30s, reauthorize = 0s
Port 5: on, retry = 30s, reauthorize = 0s
Port 6: on, retry = 30s, reauthorize = 0s
Port 7: on, retry = 30s, reauthorize = 0s
Port 8: on, retry = 30s, reauthorize = 0s

>

To configure the authentication method for a Telnet client, use the following command.

> aaa -method telnet:radius

To configure the IP address of the RADIUS server, use the following command.

> aaa -host 192.168.1.1 -ty radius

To enable RADIUS, use the aaa -ena radius command.

> aaa -ena radius

Page 28
5.1.2 Access Control List (ACL)
The module provides basic traffic filtering capabilities with Access Control Lists (ACL). Access Control
Lists can prevent certain traffic from entering or exiting the management port. ACLs can be configured
for ARP, ICMP, IP, TCP and UDP protocols. These protocols can be configured to be permitted or denied
access. Two hundred individual ACLs can be configured at one time.
The acl command provides the ability to configure ACL traffic filtering. To configure ACL, use the acl
option from the CLI prompt. A list of options is displayed when the acl -h command is entered.

> acl -h

Description: Access Control List for management access


Format: acl [-a [idx]|-d idx|-dall|-h|-m idx|-s] [-ena|dis]
[-ipsrc ipAddr[,ipAddrEnd] [-ty {deny|permit}] [-dst port] [-src port]
[-dflt {deny|permit}] [-ver]
Switches:
-a add selected ACL, index [idx]: {1..199}
-d delete selected ACL index [idx]: {1..199}
-dall delete all ACLs
-dflt default for items not found in ACL list: {deny|permit}, default permit
-dis disable ACL processing, default
-dst TCP/UDP destination port [port]: {-1..65535}
-ena enable ACL processing
-h display help information
-ipsrc source IP address
[ipAddr] IP address (individual or starting address)
[ipAddrEnd] ending IP address if present
-m modify selected ACL
-proto protocol: {arp,icmp,ip,tcp,udp}, default ip
-s show current configuration
-src TCP or UDP source port number [port]: {-1..65535}
-ty set the ACL access type -aty: {deny|permit}
-ver verbose help

>

The options available using the acl command are shown below.
The -a switch adds a new ACL filter.
The -d switch deletes an existing ACL filter by index number.
The -dall switch deletes all configured ACL filters.
The -dflt switch selects a default behavior for items not found in the ACL list. The default is permit.
The -dis switch disables ACL processing.
The -dst switch selects a TCP or UDP destination port number for an ACL filter. A value of -1 does not
select a specific TCP or UDP port.
The -ena switch enables ACL processing. If the ACL table is empty, the default behavior (-dflt) is applied
to all Ethernet frames that enter the module.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -ipsrc switch selects the IP source address for an ACL filter. The source IP address for ARP is the
“Send IP Address”.
The -m switch modifies an existing ACL filter.

Page 29
The -proto switch selects the protocol:
arp selects the ARP protocol.
icmp selects the ICMP protocol.
ip selects the IP protocol.
tcp selects the TCP protocol.
udp selects the UDP protocol.
The -s switch displays the configured ACL filters.
The -src switch selects a TCP or IP source port number for an ACL filter. A value of -1 does not select a
specific TCP or UDP port .
The -ty switch selects the ACL access type; permit or deny.
The -ver switch displays the extended help screen.
To display the configuration, use the acl -s command.

> acl -s

ACL processing is Disabled


Default ACL behavior is ‘permit’

>

To allow access to a device, the module must be configured to allow (permit) ARP and IP. Since ICMP
is part of the IP protocol, it must be explicitly excluded. ACL filters are processed in the order displayed.
> acl -ena
> acl -dall
> acl -a -ipsrc 172.16.9.1,172.16.9.5 -proto icmp -ty deny
> acl -a -ipsrc 172.16.9.1,172.16.9.5 -proto ip -ty permit
> acl -a -ipsrc 172.16.9.5,172.16.9.5 -proto arp -ty permit

> acl -s

ACL processing is Enabled


Default ACL behavior is ‘permit’

# ACL Details
1 172.16.9.1..172.16.9.5 ICMP via mgt1: deny
2 172.16.9.1..172.16.9.5 IP via mgt1: permit
3 172.16.9.5..172.16.9.5 ARP via mgt1: permit

>

Page 30
5.1.3 Ethernet Alarm Indication Signal (AIS)
The ais command provides alarm suppression and fault notification of a transport path failure.
When a MEP detects a connectivity failure, it will send a multicast AIS in the direction away from the
detected failure path. It will send a multicast AIS on each Service Provider VLAN affected by the failure.
AIS provides alarm suppression so that an Network Management Station does not receive an excessive
number of redundant alarms for a particular fault and informs the Network Management Station that a
transport path and/or a service instance has failed.
NOTE: It is not recommended to use AIS in environments utilizing spanning tree protocol.
To configure AIS, use the ais option from the CLI prompt. A list of options is displayed when the ais -h
command is entered.

> ais -h

Description: Alarm Indication Signal (AIS) configuration


Format: ais [-h|-s|-clr] [-p portNum] [-n domainName | -l domainLevel |
-ni dindex] [-o maName | -oi mindex] [-v primaryVid | -e evcName]
[-m mepid] [-pri pbits] [-md domainLevel] [-err aerror]
[{-ena|-dis} {admin,ais,rx,tx}] [-ver] [-txvid aisVid] [-ctagvid cvid]
Switches:
-clr clear current AIS statistics of the MEP
-ctagvid C-TAG VID associated with the AIS PDUs for the MEP that
originates on a S-Comp UNI port or an NNI port
-dis disable function: {ais,rx,tx}
-ena enable function: {admin,ais,rx,tx}
[admin] force AIS transmission
[ais] AIS protocol, default disabled
[rx] defect condition detection, default disabled
[tx] transmission of AIS PDU, default disabled
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-err selects errors, [aerror], activates the AIS state:
{aisrx,link,lock,low,mep,none}
[aisrx] reception of AIS, default disabled
[link] indicates a link loss error
[lock] indicates a ETH-LCK PDU received
[low] indicates a lower level MEP error
[mep] indicates a MEP error
[none] indicates no errors
-h display help information
-i AIS interval, [interval] value, where: 4 (default) is 1s, 6 is 1min
-l maintenance [domainLevel]: {0...7}
-m source mep ID, [mepid], unique within a MA: {1...8191}
-md transmit maintenance domain level [domainLevel]: {0..7}
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p [portNum] selected: {1..17}
-pri vlan priority bits, [pbits], for AIS sent if tagged; default value is 0
-s show the current AIS configuration and statistics
-txvid defines [aisVID] that the AIS PDU is transmitted with: {0...4095}
-v [primaryVid] associated with the MA: {0...4095}
-ver verbose help or show

>

Page 31
The options available using the ais command are shown below.
The -clr switch clears the AIS statistics.
The -ctagvid switch allows the AIS PDU associated on a NNI port or a scomp UNI to egress as an C-TAG
frame.
The -dis and -ena switches enable or disable specific AIS instances (admin, ais, rx and tx).
admin forces the generation of one AIS PDU.
ais enables/disables AIS globally if not associated with a MEP (-m).
ais enables/disables AIS locally for the MEP when associated with a MEP (-m).
rx enables/disables detection of a defect condition (locally).
tx enables/disables transmission of AIS PDUs (locally).
The -e switch defines the EVC associated with the AIS instance.
The -err switch indicates the type of AIS error generated (link, lock, low, mep or aisrx). One or more errors
can be selected at a time. The default error type is: link and mep.
aisrx indicates ETH-AIS received.
link indicates a port link failure.
lock indicates a ETH-LCK received by the MEP.
low indicates a lower level MEP failure on the port.
mep indicates a MEP failure on the port.
none indicates no failure mode is selected.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -i switch indicates the interval between transmissions of AIS PDUs (4 = 1 second, 6 = 1 minute, all
other values are invalid).
The -l, -n, and -ni switches indicate a specific AIS instance level, domain name and index.
The -m switch defines the AIS instance association with a specific MEP ID.
The -md switch indicates the maintenance domain level an AIS PDU is generated on.
The -o and -oi switches indicate a specific AIS instance is associate with a maintenance association name
and index.
The -p switch associates an AIS instance with the initiating port.
The -pri switch defines the specific AIS instance priority bits for the AIS PDU if tagged.
The -s switch displays the configured and running status of the AIS instances.
The -txvid switch defines the specific VID for the transmitted AIS PDU. If not defined, the primary VID
of the MEP is transmitted with the AIS PDU.
The -v switch indicates the primary VID associated with the AIS instance for specific MEP.
The -ver switch displays the extended help or show status screens.
The example below configures AIS to transmit on MD level 5 with link & mep errors generation.

> ais -l 2 -o ma2 -p 15 -md 5 -err link,mep

Page 32
The example below clears the AIS counters.

> ais -clr

The example below locally enables AIS on MEP 100.

> ais –ena ais -l 5 -o ma5 -m 100

The example below globally enables AIS.

> ais –ena ais

5.1.4 Zero Touch Provisioning (AUTOCONFIG)


The autoconfig command provides auto configuration of Zero Touch Provisioning (ZTP) and Trivial File
Transfer Protocol (TFTP) parameters. To configure auto configuration, use the autoconfig option from the
CLI prompt. A list of options is displayed when the autoconfig -h command is entered.
> autoconfig -h

Description: Automatic Module Configuration


Format: autoconfig [-dall|-h [-ver]|-s] [{-ena|-dis} {tftp|ztp}]
[-ip ipAddr] [-tfn fName] [-p portNum] [-v ztpVid]
Switches:
-dall delete all auto configuration configured parameters
-dis disable autoconfig options: {tftp|ztp}
-ena enable autoconfig options: {tftp|ztp
[tftp] TFTP protocol function, default disabled
[ztp] ZTP protocol function, default disabled
-h display help information
-ip selects the TFTP server address, [ipAddr]
-p selects ZTP port number: {1...17|all}, default 1
-s shows current auto configuration settings
-tfn configure TFTP file name [fName]: 1-23 characters
-v selects ZTP Tag VLAN ID [ztpVid]: {0...4095}, default 0
-ver verbose help

>

The options available using the autoconfig command are shown below.
The -dall switch deletes all auto configuration parameters and returns the values to factor default.
The -dis switch disables the selected protocol. TFTP and ZTP can be disabled. The default is all protocols
are disabled.
The -ena switch enables the selected protocol. TFTP and ZTP can be enabled.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -ip switch manually configures the TFTP server IP address.
The -p switch selects the port on the module to receive and generate ZTP/DHCP requests and responses.
The default port is Port 1.
The -s switch displays the auto configuration parameters on the module.

Page 33
The -tfn switch allows the TFTP filename to be changed. The default name of the file is associated with
the MAC address of the module. The file contains the .ini files to configure the module. The default file
name is <MAC address>bootfile.lst.
The -v switch configures the VLAN ID associated with the ZTP DHCP process. The default VLAN ID is 0.
A VLAN ID of 0 allows DHCP processing to generate and receive untagged data during DHCP operation.
The default Ethertype is 0x8100 for DHCP processing.
The -ver switch displays the extended help screen.
To display the configuration, use the autoconfig -s command.

> autoconfig -s

ZTP: Disabled
TFTP: Disabled
TFTP status: n/a
TFTP server IP: 255.255.255.255
TFTP file name: 00068701da00boot.lst
ZTP DHCP port number: 1
ZTP DHCP Tag VLAN ID: 0

>

Zero Touch Provisioning (ZTP) utilizes DHCP and TFTP to automatically configure the module during
the initial setup.
ZTP is disabled by default. To enable ZTP, use the autoconfig -ena ztp command. When ZTP is enabled,
the module will start the DHCP process on power up or module reboot.

ZTP Process

Page 34
On initial start up:
1. The module initiates a DHCP process requesting the IP address for itself and the IP address for the
TFTP Server. The DHCP Server responds with the IP address of the module and the IP address of
the TFTP Server (NOTE 1).
2. The configuration files for the module are stored on the TFTP Server. The module requests the files
from the TFTP Server. The Server responds with the <MAC>bootfile.lst file.
3. The module reads the <MAC>bootfile.lst file which has the name of the configuration file for the
module (modelscfg.ini). The module requests the modelscfg.ini file from the Server. After the
module receives the .ini file, the module will load the configuration file and restart.
NOTE 1: The dynamically assigned module IP address (from the DHCP Server) has priority over
the manually configured address from the .ini file.
If the DHCP process fails and a TFTP Server IP address is configured in the module, the module will
continue the process and request the configuration files from the TFTP Server.
To change the port on the module to receive and generate ZTP/DHCP requests and responses, use the -p
command.

> autoconfig -p 2
> autoconfig -s

ZTP: Disabled
BOOTP: Disabled
TFTP: Disabled
TFTP status Complete
TFTP server IP: 255.255.255.255
TFTP file name: 00b0c7d182d0boot.lst
DHCP port number: 2
DHCP Tag VLAN ID: 0

>

To enable TFTP protocol on the module, use the -ena tftp command.

> autoconfig -ena tftp


> autoconfig -s

ZTP: Disabled
BOOTP: Disabled
TFTP: Enabled
TFTP status Complete
TFTP server IP: 255.255.255.255
TFTP file name: 00b0c7d182d0boot.lst
DHCP port number: 1
DHCP Tag VLAN ID: 0

>

Page 35
5.1.5 Bandwidth Profile (BWP)
The bwp command provides the ability to configure and display bandwidth profiles associated with each
port. Bandwidth profiles control the amount of bandwidth allowed to each port or EVC.
Bandwidth profiles specifies the average rate of committed and excess Ethernet frames allowed into the
provider’s network. Bandwidth profiles consist of the following parameters:
Committed Information Rate (CIR)
CIR specifies the average rate Ethernet frames are delivered per service performance objectives. These
frames are referred to as being in-profile and classified as green. CIR is an average rate because all
frames are sent at the interface speed (e.g.,10M, 100M, 1G).
Committed Burst Size (CBS)
CBS is the maximum number of bytes allowed for incoming Ethernet frames maintaining in-profile. The
value of CBS will depend on the type of application or traffic being supported. Bursty data applications
will require a larger CBS than more constant rate applications.
Excess Information Rate (EIR)
EIR specifies the average excess service frames (>CIR) transmitted into the provider network. EIR
frames are out of profile and classified as yellow and may be discarded.
Excessive Burst Size (EBS)
EBS is the maximum number of bytes allowed for incoming Ethernet frames to be EIR-conformant.
Egress Committed Information Rate (ECIR)
ECIR specifies the average rate Ethernet frames egress the port. When configuring ECIR, an egress
queue type can be specified (starvation queuing - strict/low latency or weighted fair queuing - high
latency). Starvation queuing processes all high priority traffic before any low priority traffic and uses
a strict priority scheme. Weighted fair queuing will process high priority traffic more often than low
priority traffic in a 6 (high priority), 5, 4, 3, 2, 1 (low priority) weighted scheme.
Coupling Flag (CF)
The Coupling Flag is only used when Color Mode (CM) is set to aware. When the coupling flag is
configured, ingress yellow traffic is bound by EIR + unused CIR and classified as yellow.
Color Mode (CM)
If color mode is unaware (non-color aware policer, 1 rate and 2 colors), the profile is set to a combination
of CIR + EIR. Traffic that meets CIR + EIR is in-profile and classified green. Out-of-profile traffic
that does not meets CIR + EIR is dropped. Burst size is set to CBS+EBS.
If color mode is aware, (color aware policer, 2 rates and 3 colors) traffic is first classified as green or
yellow based on the associated CoS profile or DEI bit. Traffic that meets CIR is in-profile and treated
as green. Out-of-profile traffic and traffic classified as yellow that meets EIR is treated as yellow.
Bandwidth profiles can be associated with a port, an EVC, or a Class of Service. Class of Service profiles
are configured using the cos command and associated with the bandwidth profile using the cn switch on
the bwp command line.
NOTE: Ingress and egress bandwidth profiles need to be configured separately.

Page 36
Hierarchical Rate Limiting provides two levels of bandwidth policing. Level 1 is a per flow policing used
when an EVC is supporting multiple flows requiring different bandwidth limits. Level 2 is the overall
aggregated bandwidth allowed on the EVC.
NOTE: Level 2 bandwidth policing is not color aware.
Level 1 policing assigns different Committed Information Rates (CIR) and Excess Information Rates (EIR)
to each flow. As long as the aggregated CIR of all flows on the EVC are equal or less than the Level 2
profile, all CIR traffic will be considered in-profile and classified green. When a flow is using less than
the configured CIR then EIR traffic will be considered out-of-profile and classified yellow. Green traffic
will always be sent before yellow traffic.
NOTE: The aggregated CIRs of all flows must be equal or less than the Level 2 profile.
Eight service level (Level 1) profiles are supported per EVC.
Multiple Level 1 profiles can use the same Level 2 profile. The Level 1 profiles can be on the same port
or different ports.
Twenty-eight (28) Level 2 profiles are supported.

Page 37
To configure bandwidth profiles, use the bwp option from the CLI prompt. A list of options is displayed
when the bwp -h command is entered.

> bwp -h

Description: Bandwidth profile configuration


Format: bwp [-a|-d|-dall|-h [-ver]|-m|-s] [-p portNum] [-n profileName]
[-cir cirRate] [-eir eirRate] [-cbs cbsSize] [-ebs ebsSize]
[-uni | -e evcName] [-cn cName] [-cf|-nocf] [-dis|-ena]
[-que qtype] [-ecir cirRate[,equeue]][-pol poltype] [-cm cmode]
[-perf|-noperf] [-lvl1pol] [-lvl2name pname] [-lvl2pol] [-lvlnorm]
[-clr] [-ctv|-noctv] [-epol poltype]
Switches:
-a add profile
-cbs committed burst size [cirSize] in KB: {0,5...256000},default 150
-cir committed ingress information rate [cirRate] in kb/sec: {0...10000000},
default=0
-cf coupling flag, combines cir and eir into one group declared yellow
-clr clears statistic counters
-cm color mode [cmode]: {aware|unaware}, default unaware
-cn class of service identifier name [cName], 1-45 ASCII characters
-ctv enables CIR threshold violation notification
-d delete profile
-dall deletes all the configured ingress and egress bandwidth profiles
-dis disable bandwidth profile
-e bandwidth profile associated with [evcName], 1-45 ASCII characters
-ebs excess burst size [eirSize] in KB: {0,5...256000}, default 150
-ecir committed egress information rate [cirRate] in kb/sec: {0...10000000},
default=10000000 for egress queue [equeue]: {0...8}, 0=interface, default
-eir excess information rate [eirRate] in kb/sec: {0...10000000}, default=0
-ena enable bandwidth profile (default)
-epol [-poltype] egress policing count type: {L1|L2}, default is L2
-h display help information
-lvl1pol bandwidth profile is part of hierarchical policer, stage 1
-lvl2pol bandwidth profile is part of hierarchical policer, stage 2
-lvl2name bandwidth profile name, [pname], for stage 2 hierarchical policer
-lvlnorm bandwidth profile is part of a normal policer (default)
-m modifies profile
-n defines [profileName], 1-45 ASCII characters
-nocf separates cir and eir into two groups, no coupling between cir and eir
-noctv disables CIR threshold violation notification
-noperf disables traffic performance data set
-p [portNum] selected: {1...17}
-perf enable traffic performance data set
-pol [poltype] policing count type: {L1|L2|L3}, default is L2
-que type of egress queue [qtype]:
{fairweight|starving|q6,q5,q4,q3,q2,q1},
fairweight is equivalent to ‘6,5,4,3,2,1’
starving is equivalent to ‘sp,sp,sp,sp,sp,sp’, default
q6,q5,q4,q3,q2,q1 can be ‘sp’ (strict priority) or 0..100
for queue weight, but not a mixture of both
-s shows bandwidth profile configuration
-uni bandwidth profile associated with uni (port)
-ver verbose help

>

The options available using the bwp command are shown below.
The -a switch adds a bandwidth profile to a port.
The -cbs switch sets the Committed Burst Size (maximum number of bytes allowed) of the ingress frame.

Page 38
The -cir switch sets the Committed Information Rate of the ingress frame.
The -cf switch is only used when Color Mode (CM) is set to aware. When the coupling flag is configured,
ingress yellow traffic is bound by EIR + unused CIR and classified as yellow.
The -clr switch clears the statistic counters. The statistic counters are displayed using the -perf switch.
The -cm switch configures the color mode of the bandwidth profile. Color unaware is the default setting.
The -cn switch defines the name of the Class of Service profile.
The -ctv and -noctv switches enable/disable SNMP CIR threshold violation notification trap.
The -d switch deletes the bandwidth profile.
The -dall switch deletes all configured bandwidth profiles.
The -dis switch disables all defined bandwidth profiles.
The -e switch defines the EVC associated with the bandwidth profile.
The -ebs switch defines the Excessive Burst Size (maximum number of bytes over the CBS value allowed).
The -ecir switch defines the Committed Information Rate of the egress frame.
The -eir switch defines the average Excess Information Rate of the ingress frame.
The -ena switch enables all defined bandwidth profiles.
The -epol switch configures the egress policing type used. The options are L1 or L2. The default is L2.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -lvl1pol switch indicates level 1 hierarchical policing is used.
The -lvl2pol switch indicates level 2 hierarchical policing is used.
The -lvl2name switch configures the name for the level 2 policing profile.
The -lvlnorm switch indicates a standard bandwidth profile. This is the default setting.
The -m switch modifies a defined bandwidth profile.
The -n switch defines the name of the bandwidth profile.
The -nocf switch removes the coupling between CIR and EIR.
The -noperf disables the performance data for the bandwidth profile.
The -p switch defines the port associated with the bandwidth profile.
The -perf switch will enable/display the performance data for the bandwidth profile.
The -pol switch defines the policing count as layer 1, layer 2 or layer 3 frame types on a per port basis.
The -que switch defines the type of egress queueing used (fairweight or starving).
The -s switch displays the current bandwidth profiles.
The -uni switch associates a bandwidth profile with a UNI port.
The -ver switch displays the extend help screen.

Page 39
5.1.5.1 Standard Ingress Rate Limiting Descriptions
Ingress traffic will be limited by CIR + EIR. Excess traffic will be classified as Red and discarded. Traffic
bound by CIR will be classified as green and traffic bound by EIR will be classified as yellow.
ev1 traffic will be rate limited by bandwidth profile bwp1.

> bwp -a -cir 300000 -cbs 150 -eir 75000 -ebs 150 -p 1 -e ev1 -n bwp1 -cm unaware -cf

Traffic classified as green will be limited to 300,000 kb/sec with a CBS of 150 kbytes. Traffic classified as
yellow will be limited to 75,000 kb/sec with a EBS of 150 kbytes. Excess traffic will be classified as red
and discarded. The -cf switch has no effect when -cm is set to unaware.
ev2 traffic will be rate limited by bandwidth profile bwp2.

> bwp -a -cir 400000 -cbs 150 -eir 100000 -ebs 150 -p 1 -e ev2 -n bwp2 -cm unaware -nocf

Traffic classified as green will be limited to 400,000 kb/sec with a CBS of 150 kbytes. Traffic classified
as yellow will be limited to 100,000 kb/sec with a EBS of 150 kbytes. Excess traffic will be classified as
red and discarded. The -nocf switch has no effect when -cm is set to unaware.
ev3 traffic will be rate limited by bandwidth profile bwp3.

> bwp -a -cir 100000 -cbs 150 -eir 25000 -ebs 150 -p 1 -e ev3 -n bwp3 -cm aware -cf

Traffic classified as green will be limited to 100,000 kb/sec with a CBS of 150 kbytes. Traffic classified
as yellow will be limited to 25,000 kb/sec with a EBS of 150 kbytes. Excess traffic will be classified as
red and discarded.
ev4 traffic will be rate limited by bandwidth profile bwp4.

> bwp -a -cir 200000 -cbs 150 -eir 50000 -ebs 150 -p 1 -e ev4 -n bwp4 -cm aware -nocf

Traffic classified as green will be limited to 200,000 kb/sec with a CBS of 150 kbytes. Traffic classified
as yellow will be limited to 50,000 kb/sec with a EBS of 150 kbytes. Excess traffic will be classified as
red and discarded.

Page 40
To display the configuration, use the bwp -s command.
> bwp -s

Port 1:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 2:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 3:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 4:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 5:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 6:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 7:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 8:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 9:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Page 41
> Port 10:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 11:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 12:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 13:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 14:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

Port 15:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 10000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 10000000/10000000/10000000/10000000/10000000/10000000/
10000000/10000000

Port 16:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 10000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 10000000/10000000/10000000/10000000/10000000/10000000/
10000000/10000000

Port 17:
No ingress bandwidth profile defined, port is operating at full speed

Egress rate = 1000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/100000
0/1000000

>

Starvation queuing (starving) processes all high priority traffic before any low priority traffic and uses a
strict priority scheme. Weighted fair queuing will process high priority traffic more often then low priority
traffic in an 6,5,4 (high priority), 3, 2, 1 (low priority) weighted scheme. Queues 7 and 8 are always set
to strict priority.

Page 42
The example below configures an ingress profile on Port 2 called E1cir with a CIR of 30Mbps and a priority
of Bronze (defined in Section 5.1.10 Class of Service).

> bwp -a -p 2 -n E1cir -e E2 -cir 30000 -cn bronze

The example below configures an ingress profile on Port 1 called 50MService with a CIR of 50Mbps and
a CBS of 5KB on EVC E2.

> bwp -a -n 50MService -p 1 -cir 50000 -cbs 5 -e E2

The example below configures an egress profile on Port 1 with a ECIR of 20Mbps with fair weight queuing.

> bwp -a -p 1 -ecir 20000 -que fairweight

To display the configuration, use the bwp -s command.


> bwp -s

Port 1
Profile “50MService” : cir=50000 cbs=5 eir=0 ebs=150; EVC “E2” ; enabled; cf disabled

Egress rate = 20000kbps, queue=sp,sp,6,5,4,3,2,1 (fair weight)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/
1000000/1000000

Port 2

Profile “E1cir” : cir=30000 cbs=150 eir=0 ebs=150; EVC “E2” COS “bronze” ; enabled; cf
disabled

Egress rate = 10000000kbps, queue=sp,sp,sp,sp,sp,sp,sp,sp (starving)


Egress queue rate (kbps) 8/7/6/5/4/3/2/1 = 1000000/1000000/1000000/1000000/1000000/1000000/
1000000/1000000

Page 43
5.1.5.2 Hierarchical Rate Limiting Example
In this example below, two customers require three different services (voice, video and data) each to be
transported across the service provider’s network. Each service will be assigned a different bandwidth
profile based on their Class of Service classification. All three services will conform to the overall bandwidth
profile of the EVC.
Each customer will be provided with an overall bandwidth profile of 40M.
> evc -a -p 1,2 -e Data1 -v 1000
> evc -a -p 1,3 -e Data2 -v 1001

> interface -a -p 1 -t nni


> interface -a -p 2 -t uni -e Data1:100
> interface -a -p 3 -t uni -e Data2:200

## Traffic classification

> cos -a -cn Hi -pcp 6..7 -g 7,4 -y 7,4


> cos -a -cn Med -pcp 3..5 -g 5,3 -y 5,3
> cos -a -cn Lo -pcp 0..2 -g 2,2 -y 2,2

## Level 2 policer

> bwp -a -n Service1 -cir 40000 -eir 0 -lvl2pol


> bwp -a -n Service2 -cir 40000 -eir 0 -lvl2pol

## Level 1 policer

> bwp -a -p 2 -n Voice -cn Hi -e Data1 -cir 10000 -eir 0 -ty 3 -lvl1pol -lvl2name Service1
> bwp -a -p 2 -n Video -cn Med -e Data1 -cir 20000 -eir 10000 -ty 3 -lvl1pol -lvl2name Service1
> bwp -a -p 2 -n Data -cn Lo -e Data1 -cir 0 -eir 30000 -ty 3 -lvl1pol -lvl2name Service1

> bwp -a -p 3 -n Voice -cn Hi -e Data2 -cir 10000 -eir 0 -ty 3 -lvl1pol -lvl2name Service2
> bwp -a -p 3 -n Video -cn Med -e Data2 -cir 20000 -eir 20000 -ty 3 -lvl1pol -lvl2name Service2
> bwp -a -p 3 -n Data -cn Lo -e Data2 -cir 0 -eir 30000 -ty 3 -lvl1pol -lvl2name Service2

Level 1 policing has been configured for each service (voice, video and data). Since the aggregated CIRs
for all services is less than the Level 2 CIR, all CIR traffic will be considered in-profile and classified green.
10M of EIR traffic will be considered out-of-profile and classified as yellow. The Video EIR traffic has
been assigned a higher priority egress queue than the Data EIR traffic and will have priority if there is a
bandwidth conflict.

Page 44
5.1.6 Cable Test (CABLETEST)
The cabletest command initiates a cable test on the fixed RJ-45 copper ports. The test checks for breaks
in the cable and reports how far from the source the cable break is detected. The cable test will interrupt
service on the selected port.
To initiate a cable test, use the cabletest command from the CLI prompt. A list of options is displayed
when the cabletest -h command is entered.

> cabletest -h

Description: Initiate a cable test for a copper port


Format: cabletest [-h [-ver]] [-p portNum]
Switches:
-h display help information
-p [portNum] selected: {1...17}
-ver verbose help

>

The options available using the cabletest command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -p switch selects initiating port for the cable test.
The -ver switch displays the extend help screen.
NOTE: Cable Test is not supported on Port 17.
In this example, a cable test is initiated on Port 13.

> cabletest -p 13

Testing Port number 13:


No cable break detected

>

In this example, a cable test is initiate on Port 14 showing a break in the cable.

> cabletest -p 14

Testing Port number 14:


Cable failure detected at 2m from source

>

Page 45
5.1.7 Connectivity Fault Management Enable/Disable (CFM)
The cfm command provides the ability to globally enable or disable Connectivity Fault Management function
on the module. If CFM is disabled, CFM frames will be processed as normal Ethernet Service traffic. If
CFM is enabled, CFM frames will be processed according to the 802.1ag specification.
To enable or disable CFM, use the cfm command from the CLI prompt. A list of options is displayed when
the cfm -h command is entered.

> cfm -h

Description: Update global CFM settings


Format: cfm [-dall|-h [-ver]|-s] [{-ena|-dis} portnum]
Switches:
-dall restore factory defaults
-dis disable cfm protocol on the selected [portnum]:
{1...17|all}
-ena enable cfm protocol on the selected [portnum]:
{1...17|all}
-h display help information
-s shows the cfm global configuration
-ver verbose help

>

The options available using the cfm command are shown below.
The -dall switch restores cfm factory defaults setting.
The -dis and -ena switches disable or enable the CFM protocol on a configured port.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -s switch displays the CFM configuration.
The -ver switch displays the extend help screen.
To display the status, use the cfm -s command.

> cfm -s

Port 1: CFM is disabled (functionality is disabled since EVCs are disabled)


Port 2: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 3: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 4: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 5: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 6: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 7: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 8: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 9: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 10: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 11: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 12: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 13: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 14: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 15: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 16: CFM is disabled (functionality is disabled since EVCs are disabled)
Port 17: CFM is disabled (functionality is disabled since EVCs are disabled)

To enable CFM on all ports, using the -ena command.

Page 46
5.1.8 IEEE 1588 Clock Input/Output (CLOCKIO)
The clockio command provides the ability to configure the clock I/O connectors on the rear of the module.
To display and configure the clock I/O, use the clockio command from the CLI prompt. A list of options
is displayed when the clockio -h command is entered.

> clockio -h

Description: Clock I/O configuration


Format: clockio [-h [-ver]] [-s] [-ena|dis clk1|clk2] [-dir in|out]
[-rate 1pps|10mhz] [-term on|off]
Switches:
-dir clock I/O direction: {in|out}
-dis disable function: {clk1|clk2}
-ena enable function: {clk1|clk2}
[clk1] clock I/O 1 selection
[clk2] clock I/O 2 selection
-h display help information
-rate clock rate selection: {1pps|10mhz}
-s shows current clock I/O configuration and status
-term clock signal termination {on|off}
-ver verbose help

>

The options available using the clockio command are shown below.
The -dir switch configures the associated clock I/O (clk1 or clk2) as an input or output. The default is output.
The -dis switch disables clock 1 or clock 2.
The -ena switch enables clock 1 or clock 2.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -rate switch configures the clock rate for clock 1 and clock 2. The rates are 1PPS and 10MHz.
The -s switch displays the configuration and status of the clock I/O.
The -term switch disables (off) or enables (on) the clock termination. The default is disabled.
The -ver switch displays the extend help screen.

Clock I/O
To display the clock I/O configuration and status, use the clockio -s command.
> clockio -s

Port 1: clock mode is disabled, direction is output, rate is 1 PPS


Port 2: clock mode is disabled, direction is output, rate is 1 PPS

>

Page 47
To enable clock 1 and change clock 1 to an input, use the clockio -dir in -ena clk1.

> clockio -dir in -ena clk1

To change to rate for clock 1, use the following command.

> clockio -rate 10mhz -ena clk1

To display the clock I/O configuration and status, use the clockio -s command.
> clockio -s

Port 1: clock mode is enabled, direction is input, rate is 10 MHz


termination is off
input clock is not present
Port 2: clock mode is disabled, direction is output, rate is 1 PPS

>

5.1.9 Contact (CONTACT)


The contact command provides the ability to display the status of the contact closure and assign an action
for closing or opening the contact.
To display and configure the contact closure, use the contact command from the CLI prompt. A list of
options is displayed when the contact -h command is entered.

> contact -h

Description: Contact closure configuration


Format: contact [-h [-ver]|-s] [-mode {fan,none,power}]
Switches:
-h display help information
-mode selects contact closure alarm output mode: {fan,none,power}, default none
[fan] output contact activated when internal fan alarm is detected
[none] output contact is never activated
[power] output contact activated when internal power alarm is detected
-s show the current contact closure status
-ver verbose help

>

The options available using the contact command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -mode switch configures which alarms will be assigned to the contact. The default setting is none.
Fan: when selected, the output alarm state will indicate activated when an internal fan alarm is detected.
None: when selected, the output alarm state is disabled.
Power: when selected, the output alarm state will indicate activated when an internal power alarm is
detected.
The -s switch displays the contact closure status, output mode and activation state. Activated indicates
a normally open contact has closed or a normally closed contact has opened. Not activated indicates a
normally open contact is open or a normally closed contact is closed.
The -ver switch displays the extend help screen.

Page 48
The alarm contact connector is located on the rear of the unit and is used to alert of an internal alarm
conditions and detect the state of external alarm conditions. Not all models support this hardware feature.
The pinout for the alarm contact is shown below.

Alarm Contact Connector Pinout

Pin Function
1 Normally Open - Output
2 Common - Output
3 Normally Closed - Output
4 Detection - Input
5 Ground

Alarm Contact Description

To display the status of the contact, use the contact -s command.

> contact -s

Contact closure input state: open


Contact closure output mode: none
Contact closure output alarm state: not activated

>

To assign the fan alarm to the contact, use the contact -mode fan command.

> contact -mode fan

Contact closure input state: open


Contact closure output mode: fan
Contact closure output alarm state: not activated

Page 49
5.1.10 Class of Service (COS)
The cos command provides the ability to configure and display Class of Service profiles associated with
each port on the module.
To configure Class of Service, use the cos option from the CLI prompt. A list of options is displayed when
the cos -h command is entered.
> cos -h

Description: Class of Service configuration


Format: cos [-a|-d|-dall|-h [-ver]|-m|-s] [-cn cName]
[{-pri cPri}|{-class cClass}|{-trust}]
[[-pcp pbits|-dscp ipPri]
[-macda mAddr] [-macsa mAddr] [-vid vnum]
Switches:
-a add CoS profile
-class sets the class of service [cClass]: {0...8}
where 0=discard, 1=lowest, 8=highest class, default=1
-cn class of service identifier name [cName], 1-45 ASCII characters
-d delete CoS profile
-dall delete all CoS configured profiles
-dscp bandwidth profile associated with IP priority [ipPri]
[ipPri] are the IP priority bits: {*|0..63,0..63|all|rest}
* indicates non-IP traffic
“all” indicates all DSCP priority values
“rest” indicates all the undefined DSCP priority values
-h display help information
-m modifies CoS profile
-macda selects the MAC destination address, [mAddr]: {xx-xx-xx-xx-xx-xx}
-macsa selects the MAC source address, [mAddr]: {xx-xx-xx-xx-xx-xx}
-pcp bandwidth profile associated with tag priority [pbits]: {0..7,0..7}
-pri sets the traffic priority remarking [cPri]: {0...7}
-s shows CoS configuration
-trust sets that the ingress class selection to trust
-ver verbose help
-vid selects the VLAN identification, [vnum]: {0..4095}

>

The options available using the cos command are shown below.
The -a switch adds a class of service profile.
The -class switch sets the egress queue priority for the ingress frame.
The -cn switch defines the name of the class of service profile.
The -d switch deletes a class of service profile.
The -dall switch deletes all configured CoS profiles.
The -dscp switch defines the profile based on the IP priority bits of the ingress frame.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -m switch modifies a defined class of service profile.
The -macda switch provides CoS filtering on the destination MAC address.
The -macsa switch provides CoS filtering on the source MAC address.
The -pcp switch defines the profile based on the PCP bit of the ingress frame.
The -pri switch is used to change the priority (PCP value) of the ingress frame.
The -s switch displays the current class of service profiles.

Page 50
The -trust switch is used to explicitly trust the ingress frames priority values.
The -ver switch displays the extend help screen.
The -vid switch provides CoS filtering on the VLAN ID.
Class of Service (CoS) is supported by mapping customer frames into eight egress queues based on using
the 3-bit Priority Code Point (PCP) field in the VLAN tag.
The priority of ingress frames correspond to eight possible values or priorities (0 through 7). Each frame
is mapped to one of eight egress queues based on the frames PCP priority field. PCP 0 is mapped to egress
queue 1 (lowest priority), PCP 1 is mapped to egress queue 2, PCP 2 is mapped to egress queue 3, PCP
3 is mapped to egress queue 4, PCP 4 is mapped to egress queue 5, PCP 5 is mapped to egress queue 6,
PCP 6 is mapped to egress queue 7 and PCP 7 is mapped to egress queue 8 (highest priority), but can be
overridden by the cos command.

Quality of Service (QoS) Egress Queuing


Priority Code Point (PCP) 0 1 2 3 4 5 6 7
Egress Queue 1 2 3 4 5 6 7 8

Egress Queue vs Frame Priority


(Default Mapping)
Class of Service profiles can use L2CP, DSCP or PCP fields to assign priority to ingress frames.
Differentiated Services Code Point (DSCP) profiles are associated with IP priority bits (ipPri). Values are
0 - 63.
Layer 2 Control Protocol (L2CP) profiles are associated with L2CP protocols. Values are valid MAC
addresses or L2CP name.
Priority Code Point (PCP) profiles are associated with the tagged priority bits (pbits). Values are 0 - 7.
Traffic priority can be re-classified by using several different commands. The class command can be used
to re-classify which egress priority queue is to be used. The pri command re-classifies the priority by
changing the PCP value. The trust switch can be used to explicitly set this condition.
Traffic is mapped to eight egress queues based on the PCP values. The CoS commands provides the ability
to change the egress queue (class) or PCP value (pri) or both.
Green indicates the traffic is within the CIR. Yellow indicates the traffic is within the EIR. The traffic can
be assigned a priority (PCP value) and class (egress queue value). Priority values are 0 - 7, 7 being the
highest priority. Class values are 0 - 8, 0 being discard and 8 being the highest egress queue. Class values
1 - 8 correspond to egress queues 0 - 7.
In the example below class of service profiles are created. Each profile is assigned a name and priority,
class and associated with PCP values.

> cos -a -cn bronze -pcp 0..1


> cos -a -cn silver -pcp 2..3
> cos -a -cn gold -pcp 4..6
> cos -a -cn platinum -pcp 7

Page 51
To display the configuration, use the cos -s command.

> cos -s

Class of Service “bronze”: PCP 0..1


trust
Class of Service “silver”: PCP 2..3
trust
Class of Service “gold”: PCP 4..6
trust
Class of Service “platinum”: PCP 7
trust
>

In this example a class of service profile called “DSCPgold” prioritizing DSCP 61..63 with priority of 6
and a class priority of 3 is created.

> cos -a -cn DSCPgold -pri 6 -class 3 -dscp 61..63


> cos -s

Class of Service “DSCPgold”: DSCP 61..63


priority 6 class 3

>

In this example a class of service profile called “L2CPLMI” prioritizing L2CP E-LMI with priority 7 and
class 4 is created.

> cos -a -cn L2CPLMI -pri 7 -class 4 -l2cp -n elmi


> cos -s

Class of Service “L2CPLMI”:


priority 7 class 4

>

Page 52
5.1.11 Daytime Server Configuration (DAYTIME)
The daytime command provides the ability to configure the module to request the time and day from a
Daytime server per RFC 867. When Daytime is enabled, the responses received from the Daytime server
will be used to set the system time on the module only if SNTP is disabled. Response received from the
Daytime server when SNTP is enabled will be ignored by the module.
To configure the module to support Daytime Protocol, use the daytime command from the CLI prompt. A
list of options is displayed when the daytime -h command is entered.

> daytime -h

Description: Daytime protocol configuration


Format: daytime [-dall|-h [-ver]|-s] [-ena|-dis] [-i interval] [-ip serverNumIP]
[-t {tcp|udp}] [-z zoneVal]
Switches:
-dall restore defaults settings
-dis disable daytime on the module
-ena enable daytime on the module
-h display help information
-i daytime server requested every [interval] minutes: {1...60}
-ip daytime server IP address, [serverNumIP]
-s show daytime configuration
-t daytime server type: {tcp|udp}
-ver verbose help
-z set the time [zoneVal]

>

The options available using the daytime command are shown below.
The -dall switch deletes all settings and restores factory defaults.
The -dis and -ena switches disable or enable Daytime protocol on the module.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -i switch defines the time interval between Daytime requests.
The -ip switch defines the IP address of the Daytime servers.
The -s switch displays the Daytime configuration.
The -t switch defines the Daytime server protocol type.
The -ver switch displays the extend help screen.
The -z switch sets the time zone. Use the zone -h for legal time zone entries.
To enable Daytime services and assign the daytime server IP address, use the -ena and -ip commands.

> daytime -ena -ip 192.168.1.110

To configure the time interval and set the type for TCP, use the -i and -t commands.

> daytime -i 10 -t tcp

Page 53
To display the daytime configuration, use the daytime -s command.

> daytime -s

daytime service is enabled, query interval is 10 minutes


daytime server IP is 192.168.1.110
daytime server type is tcp

>

5.1.12 File Directory (DIR)


The dir command provides the ability to view/delete the files stored on the module.
To view/delete the files stored on the module, use the dir command from the CLI prompt. A list of options
is displayed when the dir -h command is entered.

> dir -h

Description: List the existing files


Format: dir [-d filename]|[-h [-ver]]|[-s]
Switches:
-d delete specified file, [filename]
-h display help information
-s list available files
-ver verbose help

>

The options available using the dir command are shown below.
The -d switch deletes a specific file on the module.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -s switch displays the files stored on the module.
The -ver switch displays extend help screen.
To display the files stored on the module, use the dir -s command.

> dir -s

Size Name
==============================
2 ag24hr.dat
55213 modelscfg.ini
61808 traplog.txt
668 ssh_dsa
1055 ssh_rsa.key
459 ssh_dss.key
611 ssh_dsa.pub
40 modelscfgold.ini
104008 alarm_history_table.dat
1152 default-config

Total: 10 items listed (225016 bytes)

>

Page 54
5.1.13 Ethernet Linear Protection Switching (ELPS)
Ethernet Linear Protection Switching (ELPS) provides automatic protection switching using the Automatic
Protection Switching (APS) protocol defined by ITU-T G.8031. ELPS is a point-to-point mechanism that
provides protection via a redundant link. There are two main deployments: 1+1 protection switching and
1:1 protection switching. With 1+1 protection switching, normal traffic is copied and transported on both
working and protection link. With 1:1 protection switching, normal traffic is transported on either the
working or protection link (the head-end and receiving side work together to determine the active link).
The diagrams below illustrate the two deployment types.

1+1 Protection Switching

1:1 Protection Switching

Page 55
To configure ELPS, use the elps command from the CLI prompt. A list of options is displayed when the
elps -h command is entered.

> elps -h

Description: Configures G.8031 Ethernet Linear Protection Switching (ELPS)


Format: elps [-h|-s|-a|-d] [-ver] [-pn protectionName] [-pi pindex|all]
[{-ena|-dis} {elps|{holdoff,profile,wtr protectionName}}] [-pw portNum]
[-pp portNum] [-e evcName] [-pri pbit] [-pmep md,ma,mep]
[-wmep md,ma,mep] [-typ [1+1|1:1],[aps|noaps],[uni|bidi],[rev|norev]]
[-txrate txTime] [-wtrtime wTime] [-holdoff hOffTime] [-mo mCommand]
[-txsend txNum] [-clr] [-ep evcName]
Switches:
-a add protection instance
-clr clear protection instance statistics
-d deletes protection instance
-dis disable function: {elps|{holdoff,profile,wtr protectionName}}
-ena enable function: {elps|{holdoff,profile,wtr protectionName}}
[elps] Ethernet linear protection protocol, default disabled
[holdoff] hold off timer [protectionName],default enabled
[profile] specific elps profile, [protectionName], default enabled
[wtr] wait to restore timer [protectionName], default enabled
-e [evcName] associated with the protection instance (working port)
-ep [evcName] associated with the protected port if EVC is different in
working and protected ports. If this switch is missing the working
and protected ports use the same EVC.
-h display help information
-holdoff hold-off time, [hOffTime] 0.1s: {0..100}, default 0
-mo manual mode commands, [mCommand]:
[lockout] sets lockout of protection
[freeze],[clearfreeze] freezes or clears freeze state
[force] force switch from normal working link to protection link
[protect] manual switch from working to protection link
[working] manual switch from protection to working link
[exercise] exercise APS protocol
[clear] clear to normal operation
-pi protection instance index [pindex]: {1..16} or [all] profiles
-pmep mep used for protection link instance, [md,ma,mep], where:
[md] maintenance domain level, [ma] maintenance association name
[mep] MEP ID
-pn defines [protectionName] instance, 1-45 ASCII characters
-pp protection link [portNum] selected: {1...17}
-pw working link [portNum] selected: {1...17}
-pri selects aps frame priority bit, [pbit], default is 0
-s show current configuration
-typ protection type selection:
[1+1], [1:1] protection bridge type, default [1+1]
[aps], [noaps] protection switching channel, default [noaps]
[uni], [bidi] protection switching direction, default [uni]
[rev], [norev] protection switching reversion, default [norev]
-txrate rate aps transmit frames [txTime] sec: {1..10}, default 5
-txsend number aps frames to send [txNum] at state change: {1..10}, default 3
-ver verbose help or show
-wmep mep used for working link instance, [md,ma,mep] where:
[md] maintenance domain level, [ma] maintenance association name
[mep] MEP ID
-wtrtime wait to restore timer, [wTime], min: {1..12}, default 5

>

Page 56
The options available using the elps command are shown below.
The -a switch adds a protection instance to a port or EVC.
The -clr switch clears the protection instance’s statistics.
The -d switch deletes a protection instance.
The -dis and -ena switches disable or enable specific functions or protection instance.
The -e switch associates a protection instance with an EVC for the working port.
The -ep switch is used when the protection and working ports have different EVCs. The -ep associates an
EVC with the protected port.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -holdoff switch defines the delay before the beginning of a protection switching action. The hold-off
timer resolution is in 100ms increments.
The -mo switch allows manual commands to override the normal operation of the protocol.
lockout: prevents a working signal from selecting the protection link.
freeze: freezes the state of the protection instance.
force: forces normal traffic to select the protection link.
protect: in the absence of a failure of a working or protection link, forces normal traffic signal to select
the protection link.
working: in the absence of a failure of a working or protection link, in non-revertive operation, forces
normal traffic signal to select the working link.
exercise: exercises the APS protocol.
clear: clears the lockout of protection, forced switch, manual switch, wait-to-restore timer or exercise
command.
The -pi or -pn switches are used to identify or name a specific protection instance profile.
The -pmep switch associates the Maintenance Domain, Maintenance Association and local Maintenance
End Point with the protection link.
The -pp switch associates the protection port with the protection instance.
The -pw switch associates the working port with the protection instance.
The -pri switch associates the priority of an APS frame with the selected VLAN priority bits.
The -s switch displays the current protection instances configuration and status.
The -typ switch defines the type of protection instance:
1+1 or 1:1: defines the protection bridge type
aps or noaps: defines the protection switching channel
uni or bidi: defines protection switching direction
rev or norev: defines protection switching reversion
The -txrate switch defines the time between non-switch APS frames.
The -txsend switch defines the number of APS frames to send when a protection switch occurs.
The -ver switch displays the extended help or show status screens.
The -wmep switch associates the Maintenance Domain, Maintenance Association and local Maintenance
End Point with the working link.

Page 57
The -wtrtime switch sets the wait-to-restore timer in minutes. The wait-to-restore timer defines the time
before revering back to the working link (if -typ rev option has been configured). The timer is not used if
wrt is disabled (-dis wrt) or the protection types is non-revert (-typ norev).
The module supports four protection types:
1+1 unidirectional without APS
Using 1+1 protection switching architecture, normal traffic is copied and transmitted on both working
and protection ports. The protection circuit switching is independent.
1+1 unidirectional with APS
Using 1+1 protection switching architecture, normal traffic is copied and transmitted on both working
and protection ports. 1+1 protection switching uses Automatic Protection Switching (APS) protocol to
ensure both ends of the protection circuit is using the same port (working or protection).
1+1 bidirectional with APS
Using 1+1 protection switching architecture, normal traffic is copied and transmitted on both working
and protection ports. 1+1 protection switching uses Automatic Protection Switching (APS) protocol to
ensure both ends of the protection circuit is using the same port (working or protection).
1:1 bidirectional with APS
Using 1:1 protection switching architecture, normal traffic is transmitted on either the working port or
the protection port. 1:1 protection switching uses Automatic Protection Switching (APS) protocol to
ensure both ends of the protection circuit is using the same port (working or protection).
The protection instance can be configured to revert back after the condition causing the switch has been
cleared or remain on the protection link.
Revert to working
Using Revert to working operation, normal traffic is restored to the working port after the condition
causing a switch has cleared or a clearing command has been issued.
No reversion
Using No reversion operation, normal traffic remains on the protection port even after the condition
causing the switch has been cleared.

Page 58
To configure a port-based 1+1 protection instance, use the elps -pw command.

> elps -a -pn NNIport1 -pw 15 -pp 16


> elps -ena elps

Protection Type 1+1 unidirectional without APS (default)


Reversion Type No reversion (default)
Fault Detection Link failure (default)
Protection Instance Name NNIport1 (-pn)
Working Port Port 1 (-pw)
Protection Port Port 2 (-pp)
To display the ELPS configuration, use the elps -s command.

> elps -s

ELPS Protocol: enabled

------ Ethernet Linear Protection Switching Instance #1 -----------------------


Profile name: NNIport1
Instance: enabled
APS frame transmission rate: 5 sec; number of APS frames at switch: 3
Wait-to-Restore timer: enabled, 5 min
Hold-Off timer: enabled, 0 ms
Manual mode status: no command

Configured type: 1+1, unidirectional, no aps channel, non-revertive


Local type: 1+1, unidirectional, no aps channel, non-revertive
Remote type: n/a
Protection Port: 16; status=Down
Working Port: 15; status=Down

Local Link: Working (port 15); Local Bridge: Protection (port 16)
Remote Link: n/a; Remote Bridge: n/a

Last protection switch: Jan 0, 0 00:00PM (sysUpTime: 0)


Total number of protection switches: 0
Local protection request state: Signal fail(P) (SF)
Remote protection request state: n/a
Protected Item: PORT
APS Protection MEP: n/a
APS Working MEP: n/a
APS Frame Priority: n/a

>

To delete a protection instance, use the -d command.

> elps -d -pn NNIport1

Page 59
The diagram below illustrates the network configuration used for the protection instance.

The following script will be used for the protection instance.


NID # 1 Setup
NID #1
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> evc -a -e E1 -p 16,15,11 -v 1001
> evc -a -e mgt -p 16,15,11,mgt1 -v 2000
> interface -a -p 16 -t nni
> interface -a -p 15 -t nni
> interface -a -p 11 -t uni -e E1:all -e mgt:*
> interface -a -p mgt1 -t uni -e mgt:*
> mdo -a -n MD0 -l 0
> ma -a -n MD0 -o MA0a -e E1 -p 15
> mep -a -n MD0 -o MA0a -e E1 -p 15 -m 230 -dn
> rmep -a -n MD0 -o MA0a -m 231
> ma -a -n MD0 -o MA0b -e E1 -p 16
> mep -a -n MD0 -o MA0b -e E1 -p 16 -m 230 -dn
> rmep -a -n MD0 -o MA0b -m 231
> evc -ena
> cfm -ena all

Page 60
NID # 2 Setup
NID #2
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> evc -a -e E1 -p 16,15,11 -v 1001
> evc -a -e mgt -p 16,15,11,mgt1 -v 2000
> interface -a -p 16 -t nni
> interface -a -p 15 -t nni
> interface -a -p 11 -t uni -e E1:all -e mgt:*
> interface -a -p mgt1 -t uni -e mgt:*
> mdo -a -n MD0 -l 0
> ma -a -n MD0 -o MA0a -e E1 -p 15
> mep -a -n MD0 -o MA0a -e E1 -p 15 -m 231 -dn
> rmep -a -n MD0 -o MA0a -m 230
> ma -a -n MD0 -o MA0b -e E1 -p 16
> mep -a -n MD0 -o MA0b -e E1 -p 16 -m 231 -dn
> rmep -a -n MD0 -o MA0b -m 230
> evc -ena
> cfm -ena all

The example below configures a EVC-based 1:1 protection instance.


NID #1
CLI Command
> elps -a -pn Protection -pp 16 -pw 15 -wmep 0,MA0a,230 -pmep 0,MA0b,230
-typ 1:1,aps,bidi,rev
> elps -ena elps

NID #2
CLI Command
> elps -a -pn Protection -pp 16 -pw 15 -wmep 0,MA0a,231 -pmep 0,MA0b,231
-typ 1:1,aps,bidi,rev
> elps -ena elps

Page 61
To display the extended ELPS configuration, use the elps -s -ver command.

> elps -s -ver

ELPS Protocol: enabled

------ Ethernet Linear Protection Switching Instance #1 -----------------------


Profile name: Protection
Instance: enabled
APS frame transmission rate: 5 sec; number of APS frames at switch: 3
Wait-to-Restore timer: enabled, 5 min
Hold-Off timer: enabled, 0 ms
Manual mode status: no command

Configured type: 1:1, bidirectional, aps channel, revertive


Local type: 1:1, bidirectional, aps channel, revertive
Remote type: n/a
Protection Port: 16; status=ok
Working Port: 15; status=ok

Local Link: Working (NULL, port 15); Local Bridge: Working (NULL, port 15)
Remote Link: n/a; Remote Bridge: n/a

Last protection switch: Jan 0, 0 00:00PM (sysUpTime: 0)


Total number of protection switches: 0
Local protection request state: No request working (NR)
Remote protection request state: n/a
Protected Item: MEP
APS Protection MEP: MD level 0; MA name “MA0b”; MEP ID 230
APS Working MEP: MD level 0; MA name “MA0a”; MEP ID 230
APS Frame Priority: 0
APS Lockout of protection (LO) Tx 0, Rx 0
APS Signal fail for protection (SF-P) Tx 17, Rx 0
APS Forced Switch (FS) Tx 0, Rx 0
APS Signal fail for working (SF) Tx 1, Rx 0
APS Signal degrade (SD) Tx 0, Rx 0
APS Manual switch (MS) Tx 0, Rx 0
APS Manual switch to working (MS-W) Tx 0, Rx 0
APS Wait to restore (WTR) Tx 0, Rx 0
APS Exercise (EXER) Tx 0, Rx 0
APS Reverse request (RR) Tx 0, Rx 0
APS Do not revert (DNR) Tx 0, Rx 0
APS No Request (NR) Tx 10, Rx 0
APS Other (reservered for future standardization) Tx 0, Rx 0

>

Page 62
5.1.14 Ethernet Ring Protection Switching (ERPS)
Ethernet Ring Protection Switching (ERPS) provides automatic protection switching via the Ring Automatic
Protection Switching (R-APS) protocol for Ethernet Ring topologies. ERPS provides service protection
with sub-50ms failover and the prevention of loops. Loop avoidance in an Ethernet ring is achieved by
making traffic flow on all but one of the ring links known as a Ring Protection Link (RPL), which normally
blocks traffic.
All Ethernet nodes in the ring are connected using two independent links. One Ethernet ring node is
designated as the RPL Owner. The RPL Owner is responsible to block traffic at one end of the RPL. When
a failure condition is detected, the RPL Owner is responsible to unblock the RPL and allow the link to be
used for traffic. Connected to the RPL Owner is a RPL Neighbor. The RPL Neighbor is responsible for
blocking traffic at the other end of the RPL. The RPL Neighbor is not responsible for unblocking the RPL.
In the example below, Node A is configured as the RPL Owner and Node B is configured as the RPL
Neighbor. Both nodes are responsible for blocking the transmission and reception of traffic over the RPL
when there is no failure on the ring.

Page 63
To configure ERPS, use the erps command from the CLI prompt. A list of options is displayed when the
erps -h command is entered.

> erps -h

Description: Configures G.8032 Ethernet Ring Protection Switching (ERPS)


Format: erps [-h|-s|-a|-d] [-ver] [-pn pName|-pi {pindex|all}]
[{-ena|-dis} {erps|profile pName {guard,holdoff,rev,wtb,wtr}}]
[-e evcName] [-aev evcname] [-amd mdLevel] [-pri pbit] [-rtyp rType]
[-rp0 pNum[;md,ma,mep][:{ro|rn|nn}]]
[-rp1 {pNum|vp}[;md,ma,mep] [-vdo vname]] [-clr]
[-txsend txNum] [-txrate txTime] [-mo portNum,mCommand] [-wtbtime wTime]
[-wtrtime wTime] [-holdoff hOffTime] [-guardtime gTime] [-ringid idNum]
Switches:
-a add protection instance
-aev selects the APS [evcName] that the APS frames are to be transmitted on
-amd selects the [mdLevel] of the APS frame, default 0
-clr clear protection instance statistics
-d deletes protection instance
-dis disable function: {erps|profile pName {guard,holdoff,rev,wtb,wtr}}
-ena enable function: {erps|profile pName {guard,holdoff,rev,wtb,wtr}}
[erps] Ethernet ring protection protocol, default disabled
[guard] guard timer, default disabled
[holdoff] hold off timer, default disabled
[profile] specific erps profile [protectionName], default enabled
[wtb] wait to block timer, default disabled
[wtr] wait to restore timer, default disabled
[rev] protection switching reversion, default disabled
-e [evcName] associated with protection instance (traffic channel)
-guardtime guard timer, [gTime], 0.01s: {0..500}, default 50
-h display help information
-holdoff hold-off time, [hOffTime] 0.1s: {0..100}, default 0
-mo manual mode commands on [portNum], [mCommand]:
[force] force switch from normal working link to protection link
[manual] force a block on the indicated ring port
[clear] clear to normal operation
-pi protection instance index [pindex]: {1..16} or [all] profiles
-pn defines protection[pName] instance, 1-45 ASCII characters
-pri selects R-APS frame priority bit, [pbit], default is 0
-ringid ring id [idNum]: {1..255}, default 1
-rp0 ring port 0: pNum[;md,ma,mep][:{ro|rn|nn}]
[pNum] port selected: {1...17}
[md] md level, [ma] ma name, [mep] MEP ID,
[ro] RPL owner, [rn] RPL neighbor, [nn] RPL next-neighbor
[vp] virtual port
-rp1 ring port 1: {pNum|vp}[;md,ma,mep]
-rtyp ring type [rType]: {closed|open}, default closed
-s show current configuration
-txrate rate R-APS transmit frames [txTime] sec: {1..10}, default 5
-txsend number R_APS frames to send [txNum] at state change: {1..10}, default 3
-vdo virtual channel domain [vname], 1-45 ASCII characters
-ver verbose help or show
-wtbtime wait to block timer, [wTime], sec: {1..12}, default 5
-wtrtime wait to restore timer, [wTime], min: {1..12}, default 5

>

The options available using the erps command are shown below.
The -a switch adds a protection to a port or EVC. More than one EVC can be added to an existing protection
instance.

Page 64
The -aev switch defines EVC name for the R-APS channel. If not defined, R-APS frames are sent on the
MEP EVC. R-APS frames are transmitted on the R-APS protection EVC. The protection EVC can be
the traffic channel EVC, the md/ma/mep EVC or an independent EVC dedicated to the R-APS channel.
The -amd switch selects the R-APS frame MD level.
The -clr switch clears the statistics associated with the selected protection instance or all statistics for all
instances.
The -d switch deletes a protection instance or a specific EVC from a protection instance. If a protection
instance is deleted that is used as a virtual domain, then the dependent protection instance is also deleted.
The -dis and -ena switches disable or enable specific functions or protection instance.
The -e switch associates an EVC with the protection instance and is defined as a EVC-based ERPS instance.
If an EVC is not defined when a protection instance is added, the protection is defined as a port-based
ERPS instance.
The -guardtime switch sets the guard timer value in 10ms resolution. The guard timer is used to prevent
Ethernet ring nodes from acting upon outdated R-APS messages and prevents the possibility of forming
a closed loop.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -holdoff switch sets the hold-off timer value in 100ms resolution. When a new defect occurs, the
holdoff timer is started (the event is not immediately reported if holdoff timer value is non-zero). When
the holdoff timer expires, if the defect is still present, the defect is reported to the protection switching.
The -mo switch is an administrative command to manually (manual) force a block on a port, force (force) a
switch from a normal working link to a protection link or clear (clear) an administrative command (force,
manual).
The -pi or -pn switches are used to identify or name a specific protection instance profile.
The -pri switch defines the specific R-APS frame pbit priority.
The -ringid switch allows the ring ID to be changed from the default value. The last octet of the MAC
address is designated as ring ID.
The -rp0 switch defines the specific port numbers associated with ring port 0.
The MEP used for protection switching determination is defined by the Maintenance Domain level,
the Maintenance Association name, and the local MEP ID.
Port function type can be defined as the RPL owner (ro), RPL neighbor (rn) or RPL next-neighbor (nn).
The four sub switches can be selected independently:
The Traffic Channel can be defined using the -e switch
The R-APS Channel can be defined using the -aev switch
The R-APS Virtual Channel can be defined using the -vdo switch
The MEP used to determine CCM failure can be defined using the md/ma/mep switches
The -rp1 switch defines the specific port numbers associated with ring port 1.
The MEP used for protection switching determination is defined by the maintenance domain level;
maintenance association name, and the local MEP ID.
The -rtyp switch selects the ERPS ring type: closed or open.
The -s switch the displays the protection instances configured and their running status.

Page 65
The -txrate switch defines the time between non-switch R-APS frames. The Ethernet ring protection
switching mechanism requires the R-APS protocol to coordinate the switching behavior among all Ethernet
ring nodes.
The -txsend switch defines the number of R-APS frames to send when a protection switch occurs.
The -vdo switch defines the virtual domain (protection instance name) associated with the virtual channel.
When a virtual channel is needed on the ring, the -vdo switch defines the APS virtual channel domain used
to sent APS frames. This is only valid when the ring port is defined as a virtual port (vp).
The -ver switch displays the extended help or show status screens.
The -wtbtime sets the wait-to-block timer in seconds. The wait to block (WTB) timer is used when clearing
forced switch and manual switch commands.
The -wtrtime configures the wait-to-restore timer in minutes. The wait to restore (WTR) timer is used to
prevent frequent operation of the protection switching due to intermittent signal failure defects.
NOTES:
An EVC must be associated with an ERPS instance in order for the EVC to function as part of ERPS. If
the EVC is not associated with an ERPS instance, then the EVC functions as normal EVC.
If an ERPS instance is configured with a MEP and the MEP is deleted, the ERPS instance is automatically
deleted. This action will cause a loop condition.
If an ERPS instance is configured with an EVC and the EVC is deleted, the ERPS instance is automatically
deleted. If the EVC is subsequently added back, the ERPS instance will not be automatically recreated.
This action will cause a loop condition.
Deleting the ERPS APS EVC will automatically delete all ERPS instances.
Deleting the first EVC in a list of EVCs associated with the ERPS instance will automatically delete the
ERPS instance.
An ERPS ring owner must be configured or ERPS will not operate correctly.
The following script is an example configuration for a EVC-based Ethernet ring with three nodes.

Page 66
Node A Setup
Node A (RPL Owner)
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> evc -a -e E1 -p 16,15,11 -v 1001
> evc -a -e mgt -p 16,15,11,mgt1 -v 2000
> evc -a -e aps -p 16,15 -v 2001
> interface -a -p 16 -t nni
> interface -a -p 15 -t nni
> interface -a -p 11 -t uni -e E1:100 -e mgt:*
> interface -a -p mgt1 -t uni -e mgt:*
> evc -ena
> cfm -ena all
> erps -a -pn mainaps -e E1 -rp0 15:ro -rp1 16 -aev aps
> erps -a -pn mainaps -e mgt
> erps -ena profile mainaps rev
> erps -ena erps

Port 15 is configured as the RPL (Ring Protection Link) with the module designated as the Ring Owner
(-rp0 15:ro).
Node B Setup
Node B (RPL Neighbor)
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> evc -a -e E1 -p 16,15,11 -v 1001
> evc -a -e mgt -p 16,15,11,mgt1 -v 2000
> evc -a -e aps -p 16,15 -v 2001
> interface -a -p 16 -t nni
> interface -a -p 15 -t nni
> interface -a -p 11 -t uni -e E1:100 -e mgt:*
> interface -a -p mgt1 -t uni -e mgt:*
> evc -ena
> cfm -ena all
> erps -a -pn mainaps -e E1 -rp0 16:rn -rp1 15 -aev aps
> erps -a -pn mainaps -e mgt
> erps -ena erps

Port 15 is configured as the RPL (Ring Protection Link) with the module designated as the Ring Neighbor
(-rp0 16:rn).

Page 67
Node C Setup
Node C (Ring Node)
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> evc -a -e E1 -p 16,15,11 -v 1001
> evc -a -e mgt -p 16,15,11,mgt1 -v 2000
> evc -a -e aps -p 16,15 -v 2001
> interface -a -p 16 -t nni
> interface -a -p 15 -t nni
> interface -a -p 11 -t uni -e E1:100 -e mgt:*
> interface -a -p mgt1 -t uni -e mgt:*
> evc -ena
> cfm -ena all
> erps -a -pn mainaps -e E1 -rp0 15 -rp1 16 -aev aps
> erps -a -pn mainaps -e mgt
> erps -ena erps

To display the status of the protection instance for Node A, use the erps -s command.

> erps -s

ERPS Protocol: enabled

------ Ethernet Ring Protection Switching Instance #1 -----------------------


Profile name: mainaps
Ring Id: 1
Ring Status: Operational
Protection Instance: Enabled
Revertive: Enabled
Ring type: Closed
APS frame transmission rate: 5 sec; number of APS frames at switch: 3
Wait-to-Restore timer: enabled, 5 min
Wait-to-Block timer: disabled, 5 sec
Hold-Off timer: disabled, 0 ms
Guard timer: disabled, 500 ms
Protected traffic channel: EVC “E1” “E2” “mgt”
R-APS Frame Priority: 0, domain level 0

Last protection switch: Dec 26, 2012 09:02AM (sysUpTime: 49300707)


Total number of protection switches: 2

Local state: expires wtr


Remote state: raps no request
Highest priority received request/state: no request
Ring status: idle
Ring port 0: port 15; status=Up, blocked
APS VID “aps”; RPL owner
Ring port 1: port 16; status=Up, forward
APS VID “aps”

>

Page 68
The following script is an example configuration for a MEP-based Ethernet ring with three nodes.

Node A Setup
Node A (RPL Owner)
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> ethertype -uni 8100
> evc -a -e E1 -p 16,15,11 -v 1001
> evc -a -e mgt -p 16,15,11,mgt1 -v 2000
> evc -a -e aps -p 16,15 -v 2001
> interface -a -p 16 -t nni
> interface -a -p 15 -t nni
> interface -a -p 11 -t uni -e E1:100 -e mgt:*
> interface -a -p mgt1 -t uni -e mgt:*
> evc -ena
> cfm -ena all
> md -a -n Domain3 -l 3
> ma -a -n Domain3 -l 3 -o MA03 -p 15 -e E1 -i 4
> mep -a -n Domain3 -l 3 -o MA03 -m 311 -p 15 -e E1 -dn
> rmep -a -n Domain3 -l 3 -o MA03 -m 322 -lmep 311
> mep -a -n Domain3 -l 3 -o MA03 -m 312 -p 16 -e E1 -dn
> rmep -a -n Domain3 -l 3 -o MA03 -m 331 -lmep 312
> erps -a -pn mainaps -e E1 -rp0 15;3,MA03,311:ro -rp1 16;3,MA03,312 -aev aps1 -amd 3 -wtrtime 1
> erps -a -pn mainaps -e mgt
> erps -ena profile mainaps rev
> erps -ena erps

Port 1 is configured as the RPL (Ring Protection Link) with the module designated as the Ring Owner
(-rp0 15...:ro).

Page 69
Node B Setup
Node B (RPL Neighbor)
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> ethertype -uni 8100
> evc -a -e E1 -p 16,15,11 -v 1001
> evc -a -e mgt -p 16,15,11,mgt1 -v 2000
> evc -a -e aps -p 16,15 -v 2001
> interface -a -p 16 -t nni
> interface -a -p 15 -t nni
> interface -a -p 11 -t uni -e E1:100 -e mgt:*
> interface -a -p mgt1 -t uni -e mgt:*
> evc -ena
> cfm -ena all
> md -a -n Domain3 -l 3
> ma -a -n Domain3 -l 3 -o MA03 -p 15 -e E1 -i 4
> mep -a -n Domain3 -l 3 -o MA03 -m 321 -p 15 -e E1 -dn
> rmep -a -n Domain3 -l 3 -o MA03 -m 332 -lmep 321
> mep -a -n Domain3 -l 3 -o MA03 -m 322 -p 16 -e E1 -dn
> rmep -a -n Domain3 -l 3 -o MA03 -m 311 -lmep 322
> erps -a -pn mainaps -e E1 -rp0 16;3,MA03,321:rn -rp1 15;3,MA03,322 -aev aps1 -amd 3
> erps -a -pn mainaps -e mgt
> erps -ena erps

Port 2 is configured as the RPL (Ring Protection Link) with the module designated as the Ring Neighbor
(-rp0 16...:rn).
Node C Setup
Node C (Ring Node)
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> ethertype -uni 8100
> evc -a -e E1 -p 16,15,11 -v 1001
> evc -a -e mgt -p 16,15,11,mgt1 -v 2000
> evc -a -e aps -p 16,15 -v 2001
> interface -a -p 16 -t nni
> interface -a -p 15 -t nni
> interface -a -p 11 -t uni -e E1:100 -e mgt:*
> interface -a -p mgt1 -t uni -e mgt:*
> evc -ena
> cfm -ena all
> md -a -n Domain3 -l 3
> ma -a -n Domain3 -l 3 -o MA03 -p 15 -e E1 -i 4
> mep -a -n Domain3 -l 3 -o MA03 -m 331 -p 15 -e E1 -dn
> rmep -a -n Domain3 -l 3 -o MA03 -m 312 -lmep 331
> mep -a -n Domain3 -l 3 -o MA03 -m 332 -p 16 -e E1 -dn
> rmep -a -n Domain3 -l 3 -o MA03 -m 321 -lmep 332
> erps -a -pn majoraps -e E1 -rp0 15;3,MA03,331 -rp1 16;3,MA03,332 -aev aps1 -amd 3
> erps -a -pn mainaps -e mgt
> erps -ena erps

Page 70
To display the status of the protection instance for Node A, use the erps -s command.

> erps -s

ERPS Protocol: enabled

------ Ethernet Ring Protection Switching Instance #1 -----------------------


Profile name: mainaps
Ring Id: 1
Ring Status: Operational
Protection Instance: Enabled
Revertive: Enabled
Ring type: Closed
APS frame transmission rate: 5 sec; number of APS frames at switch: 3
Wait-to-Restore timer: disabled, 1 min
Wait-to-Block timer: disabled, 5 sec
Hold-Off timer: disabled, 0 ms
Guard timer: disabled, 500 ms
Protected traffic channel: EVC “E1”, “mgt”
R-APS Frame Priority: 0, domain level 3

Last protection switch: Jan 1, 2000 01:41AM (sysUpTime: 610900)


Total number of protection switches: 1

Local state: no request


Remote state: raps no request
Highest priority received request/state: no request
Ring status: idle
Ring port 0: port 15; status=Up, blocked
MD level 3; MA name MA03; MEP ID 311; APS VID “aps1”; RPL owner
Ring port 1: port 16; status=Up, forward
MD level 3; MA name MA03; MEP ID 312; APS VID “aps1”

>

Page 71
5.1.15 Error List (ERR)
The err command provides the ability to display the 802.1ag error conditions on the module. A list of
options is displayed when the err -h command is entered.

> err -h

Description: CFM error list status


Format: err [-h [-ver]|-s]
Switches:
-h display help information
-s show the current error list status
-ver verbose help

>

The options available using the err command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -s switch displays the 802.1ag error conditions on the module.
The -ver switch displays the extended help screen.
To display the 802.1ag error list, use the err -s command from the CLI prompt.

> err -s

VLAN ID Port Error Type


=============================================================================

>

The 802.1ag error list displays error conditions on the module. The table displays VLAN ID, Port # and
Error Type. The following error types may be displayed:
CFM leak
Maintenance Association (MA) x is associated with a specific VID list and one or more of the VIDs in
the MA x pass through the port. No Down MEP is configured on any port for MA x. Another MA, at
a higher Maintenance Domain (MD) Level is associated with at least one of the VID(s) on MA x, and
has a MEP configured on the port.
Conflicting VIDs
MA x is associated with a specific VID list and a Up MEP is configured on a port. Another MA with at
least one of the VID(s) on MA x, has an Up MEP configured on some port.
Excessive Levels
The number of different MD Levels at which MIPs are to be created on this port exceeds the port’s
capability.
Overlapped Levels
A MEP created for one VID at one MD Level, is also configured on another VID at the same MD Level
or higher.

Page 72
5.1.16 Ethertype (ETHERTYPE)
The ethertype command provides the ability to configure the protocol used to encapsulate a VLAN tagged
frame. Ethertype is a two-octet field in an Ethernet frame indicating which protocol is used to encapsulate
tag information in the frame data.
To configure the Ethertype, use the ethertype command from the CLI prompt. A list of options is displayed
when the ethertype -h command is entered.

> ethertype -h

Description: Ethertype selection for tag identification


Format: ethertype [-h [-ver]|-s] [-nni ethertypeVal]
Switches:
-h display help information
-nni selects provider network [ethertypeVal]
[ethertypeVal] selects the Ethertype that is used for the selected
network type, value is entered in hex, typical selection for
customer networks is 8100, for provider networks 88a8
default for customer/provider networks is 8100
-s show port configuration
-ver verbose help

>

The options available using the ethertype command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -nni switch configures the Ethertype for provider frames. The default value is 0x8100.
The -s switch displays the Ethertype configuration of the module.
The -ver switch displays the extended help screen.
Use the following commands to configure the NNI port for a Ethertype value of 0x88a8 (S-Tag).
> ethertype -nni 88a8

Network to Network Interface (NNI) is an interface which specifies signaling and management functions
between two networks.
User Network Interface (UNI) is a demarcation point between the responsibility of the service provider
and the responsibility of the subscriber.
To display the Ethertype configuration, use the ethertype -s command.

> ethertype -s

Customer (UNI) Ethertype value is 8100


Provider (NNI) Ethertype value is 88a8

>

The Ethertype for the UNI interface is 0x8100 and it can not be modified.

Page 73
5.1.17 Ethernet Virtual Connection (EVC)
The evc command provides the ability to configure and display EVCs on the module. An EVC provides a
logical connection between two end points creating a point to point Ethernet connection.
To configure EVCs, use the evc command from the CLI prompt. A list of options is displayed when the
evc -h command is entered.

> evc -h

Description: Ethernet Virtual Connection (EVC) configuration


Format: evc [-a|-d|-dall|-h [-ver]|-m|-s] [-e evcName] [-v evcVid]
[-p ports[:evcVid]] [-pri pbits|-trust] [-preserve {CE-VID,CE-CoS}]
[-nopreserve] [-ena|-dis] [-enaevc evcName] [-disevc evcName]
[-c class] [-cpr cbits] [-nm evcName] [-mact1]
Switches:
-a add selected EVC on specified port
-c provider traffic [class]: {0...8}, default copy class from source
where 0=discard, 1=lowest, 8=highest class, default=1
-cpr ctag priority bits, [cbits]: {0...7}, CE-CoS non-preservation, default=0
-d delete selected EVC
-dall deletes all the configured EVCs
-dis disable global EVC processing
-disevc disable specific evc: [evcName], 1-45 ASCII characters
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-ena enable global EVC processing
-enaevc enable specific evc: [evcName], 1-45 ASCII characters
-h display help information
-m modify existing EVC
-mact1 activates management 1 on the selected EVC
-nm new EVC name, [evcName] (used during modification only)
-nopreserve NO preservation of CE-VID and CE-CoS
-p [portNum] selected: {1...17,mgt1,all}
[evcVid] associated with a port for non-preservation NNI EVCs
-preserve preserves [CE-VID] and/or [CE-CoS], default preserve both
-pri provider vlan priority bits, [pbits], for PDU if sent tagged;
default value is to inherit the priority bits from source port
if the source does not contain a tag, the priority value is set to 0
-s show EVC configuration for specified port
-trust priority trust mode, default
-v [evcVid] associated with provider tag: {0...4095}
-ver verbose help

>

The options available using the evc command are shown below.
The -a switch allows an EVC to be added and configured. The add command must have an EVC name,
the port association specified, and optionally the CE-VID and CE-CoS preservation attributes.
The -c switch defines the provider traffic class priority. The frames ability to be transported across the
network during congestion, depends on the traffic class priority setting.
The -cpr switch allows the priority of the CE-CoS bits to be modified from the original ingress value.
The -d switch deletes a previously defined EVC for all ports.
The -dall switch deletes all configured EVCs.
The -dis switch globally disables all EVCs.
The -disevc switch disables a specific EVC.

Page 74
The -e switch defines the name of the new EVC or the name of an EVC to be deleted. EVCs are defined
and selected by its name.
The -ena switch globally enables all EVCs. For an EVC to be enabled, the EVC must be globally and
individually enabled.
The -enaevc switch enables a specific EVC. When an EVC is created it is locally enabled.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -m switch modifies an existing EVC.
The -mact1 switch activates IP1 on multiple management EVCs.
The -nm switch modifies an existing EVC by name.
The -nopreserve and -preserve switches specify the EVC preservation attributes. By default all EVCs are
created with CE-VID and CE-CoS bits preserved (unless non-preservation attributes are included in the
command line).
The -p switch defines one or more ports on the module to be used when an EVC is added or deleted. All
user available ports can be assigned to one or more EVCs. The management port (mgt1) can be assigned
to none or one EVC.
The -pri switch allows modification of the priority bits in the providers VLAN ID.
The -s switch displays the current EVC configurations for the module.
The -trust switch allows the ingress frame to maintain the original priority level of the frame. -trust is the
default setting. Use the -pri to change the priority level of the ingress frame.
The -v switch defines the S-TAG (provider tag) associated with the EVC. It can be the same value for two
different EVCs.
The -ver switch displays the extended help screen.

Page 75
An EVC allows subscriber’s Ethernet frames to be exchanged between UNIs that are connected via the same
EVC. Subscriber frames may be VLAN tagged or untagged. A provider may also add an additional VLAN
tag to the Ethernet frame to isolate the subscribers’ VLAN tag. To distinguish the subscriber’s VLAN tag
from the provider’s tag, the subscriber’s VLAN is referred to as CE-VLAN (Customer Edge VLAN ID).
The CE-VLAN tag contains the 802.1p field defining the Class of Service priority for the frame. The CoS
field is referred to as CE-VLAN CoS.

Ethernet Frame with 802.1Q Tag

Ethernet Frame with Q-in-Q Tag


Using the preserve command, the CE-VLAN ID/ CE-VLAN CoS can be preserved (unmodified) across the
EVC. Using the nopreserve command, the CE-VLAN ID or CE-VLAN CoS can be mapped to another value.
The EVC preservation attributes are defined by two switches; -preserve and -nopreserve. By default EVCs
CE-VID and CE-CoS are preserved when no preservation attributes are defined on the command line. The
nopreserve command disables both CE-VID and CE-CoS preservation. The preserve CE-VID command
preserves only the CE-VID. The preserve CE-CoS command only preserves CE-CoS.
The preservation attributes are only used for EVCs on a UNI port.
When the nopreserve command is used, the 3 bit Priority Code Point (PCP) field in the Ethernet frame of the
CE-VLAN ID can be modified using the cpr command. The provider’s VLAN PCP field can be modified
using the pri command. Only two ports can be defined by the nopreserve command.

-cpr ctag priority bits, [cbits]:{0...7},for CE-CoS non-preservation, default=0


-pri provider vlan priority bits, [pbits], for PDU if sent tagged;
default value is to inherit the priority bits from source port
if the source does not contain a tag, the priority value is set to 0

The egress queue is set by the -c command and classifies the traffic as green or yellow. Not using the -c
command means the ingress frames egress class is used for priority classification. If the ingress frame is
tagged, the egress queue is based on the priority bits of the ingress frame.

-c provider traffic [class]: {0...4}, default copy class from source


where 0=discard, 1=lowest, 4=highest class, default=1

Page 76
To display the configured EVCs, use the evc -s command.

> evc -s

EVC processing is globally disabled

“mgt” associated with provider tag 999 on ports 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,mg


t1; priority 0;
CE-VLAN and CE-CoS preservation set, EVC enabled; traffic class 1; CTag priority 0
“default” associated with provider tag 1 on ports 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17
; priority 0;
CE-VLAN and CE-CoS preservation set, EVC enabled; traffic class 1; CTag priority 0

>

When configuring a factory default module, delete the management and default EVCs before configuring
the new EVCs.

> evc -d -e mgt


> evc -d -e default

The example below configures an EVC called “ServiceProvider” with a VLAN ID of 1000 on Ports 1, 2,
3 and mgt1.

> evc -a -e ServiceProvider -p 1,2,3,mgt1 -v 1000

The example below configures an EVC called “ServiceProvider100” with a VLAN ID of 100 on Ports 1
and 2 with CE-VLAN preservation set with a priority of 2 and a class of 2.

> evc -a -e ServiceProvider100 -p 1,2 -v 100 -preserve CE-VID -pri 2 -c 2

To display the configured EVCs, use the evc -s command.

> evc -s

EVC processing is globally disabled

“ServiceProvider” associated with provider tag 1000 on ports 1,2,3,Mgt1; priority 0;


CE-VLAN and CE-CoS preservation set, EVC enabled; traffic class 1; CTag priority 0
“ServiceProvider100” associated with provider tag 100 on ports 1,2; priority 2;
CE-VLAN preservation set, EVC enabled; traffic class 2; CTag priority 0

>

To globally disable EVCs, use the -dis command.

> evc -dis

To globally enable EVCs, use the -ena command.

> evc -ena

Page 77
To disable a specific EVC, use the -disevc command.

> evc -disevc ServiceProvider100


> evc -s

EVC processing is globally enabled

“ServiceProvider” associated with provider tag 1000 on ports 1,2,3,Mgt1; priority 0;


CE-VLAN and CE-CoS preservation set, EVC enabled; traffic class 1; CTag priority 0
“ServiceProvider100” associated with provider tag 100 on ports 1,2; priority 2;
CE-VLAN preservation set, EVC not enabled; traffic class 2; CTag priority 0

>

To enable a specific EVC, use the -enaevc command.

> evc -enaevc ServiceProvider100

5.1.18 Create a Script File (FILE)


The file command provides the ability to create a script file and save it on the module. After a file is opened,
all typed CLI commands are written to the file. None of the commands typed will be executed, only written
to the open file. After the file is closed, the run command can be used to execute the saved CLI commands.
To open/create a file on the module, use the file command from the CLI prompt. A list of options is displayed
when the file -h command is entered.

> file -h

Description: file open and close


Format: file [-h [-ver]|-s|-open filename.osf|-close]
Switches:
-close close the currently open script file
-h display help information
-open creates a script file [filename.osf]
-s shows the script file open status
-ver verbose help

>

The options available using the file command are shown below.
The -close switch stops the capture of all typed commands and saves the file.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -open switch starts the capture of all typed commands.
The -s switch displays the open file status.
The -ver switch displays the extended help screen.
To create a file, use the -open command. The filename must have the .osf extension.

> file -open MetroConfig.osf

Page 78
All CLI commands typed after the file has been opened is automatically saved in the file. Once complete
with the configuration, close the file using the -close command.

> file -close

To verify the file has been saved, use the run -l command.
> run -l

Name Size
=================================
MetroConfig.osf 34

Total: 1 items listed (34 bytes).

>

To execute the file, use the run -f <filename.osf> command.

> run -f MetroConfig.osf

Running script file :MetroConfig.osf


Executing cmd:....

5.1.19 Activate FPGA Code (FPGAUPD)


The fpgaupd command provides the ability to activate the FPGA on the module after the code has been
transferred (FTP) to the module. See Appendix A for more information on how to upgrade the FPGA code.
To activate the FPGA firmware stored on the module, use the fpgaupd command from the CLI prompt. A
list of options is displayed when the fpgaupd -h command is entered.

> fpgaupd -h

Description: FPGA firmware update


Format: fpgaupd [-h [-ver]|-s|-w filename [-ip addr]] [-act]
Switches:
-act activate the FPGA firmware
-h display help information
-ip TFTP server address [addr]
-s shows the FPGA firmware version information
-ver verbose help
-w writes to the FPGA, [filename], 1-45 ASCII characters

>

The options available using the fpgaupd command are shown below.
The -act switch activates the newly loaded FPGA code.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -ip switch specifies the IP address of the TFTP server to be used for downloading the file.
The -s switch displays the current FPGA information.
The -ver switch displays the extended help screen.
The -w switch writes the new FPGA code into memory.

Page 79
NOTE: When upgrading the module firmware and the FPGA code, always upgrade the FPGA first
then the module firmware can be upgraded.
The filename of the FPGA code when using the fpgaupd command must be the same as the filename used
during the FTP process.
To update the FPGA, use the -w and -act commands.

> fpgaupd -w <filename> -act

Reading fpga.dat
FPGA image ready to program
Warning: Do not remove power until update is completed!
FPGA update started
Erasing device (~30 seconds)..............................
Programming And Verifying Device(~2 minutes).............................................
..............................
FPGA update complete
FPGA restarted

>

5.1.20 Activate Firmware (FWUPDATE)


The fwupdate command provides the ability to activate the firmware or bootloader on the module. See
Appendix A for more information on how to upgrade the firmware.
To upload the firmware stored on the module, use the fwupdate command from the CLI prompt. A list of
options is displayed when the fwupdate -h command is entered.

> fwupdate -h

Description: Update Module Firmware


Format: fwupdate [-h [-ver]] [-l] [-d filename] [-f filename] [-ip TFTPServerIp]
[-t app|bootloader]
Switches:
-d delete specified firmware file
-f write specified firmware file
-h display help information
-ip TFTP Server ip address [TFTPServerIp]
-l list available firmware files
-t firmware file type (app or bootloader), default app
-ver verbose help

>

The options available using the fwupdate command are shown below.
The -d switch deletes the firmware file on the module.
The -f switch selects the firmware file to upload to the module.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -ip switch specifies the IP address of the TFTP server used for the upgrading of the firmware on the
module.
The -l switch displays the list of available files on the module.
The -t switch selects the type of file that will be updated: application or boot loader.
The -ver switch displays the extended help screen.

Page 80
The filename of the firmware when using the fwupdate command must be the same as the filename used
during the FTP process.
Once the new firmware has been stored on the module, the firmware can be activated by using the following
command:

> fwupdate -f xm5.dat

firmware updating using firmware file :/ram/tmp/xm5.dat


Waiting for firmware update to complete
Starting flash update - do not power off device!

Erasing image................................................

Programming image...............................................................
................................................................................
... Erase from 0x40fc0000-0x40ffffff: .
... Program from 0x87fbf000-0x87fff000 to 0x40fc0000: .
... Program from 0x87fbf00a-0x87fbf00c to 0x40fc000a: .
Flash update succeeded.

5.1.21 Internet Group Management Protocol (IGMP)


The module supports IGMPv1, v2, or v3 IPv4 snooping based upon RFC 4541, which defines the basic
operation of an IGMP snooping switch. IGMP is used to modify the default router behavior for IPv4
Multicast Packets which are flooded to all ports. IGMP provides a method for forwarding IPv4 Multicast
Packets to only the ports with hosts that want to receive the packets. IGMP communications occur between
IPv4 Multicast Routers and Hosts.

IPv4 Multicast Packets have an address range of 224.0.0.0 to 239.255.255.255.


To configure the IGMP snooping on the module, use the igmp command from the CLI prompt. A list of
options is displayed when the igmp -h command is entered.

Page 81
> igmp -h

Description: IGMP Configuration


Format: igmp [-a|-d|-h [-ver]|-m|-s] [{-dis|ena} aging|flood|snooping]
[-to toval] [-ph hnum] [-pr rnum] [-evc evcName] [-grp ipAddr]
Switches:
-a adds manual forwarding map or IGMP interface
-d deletes existing forwarding map or IGMP interface
-dis disable function: {aging|flood|snooping}
-ena enable function: {aging|flood|snooping}
[aging] IGMP route subject to aging out, default disable
[flood] flooding of all unrecognized IGMP groups, default disable
[snooping] IGMP snooping, default disable
-evc selects EVC name, [evcName], for a specific route
-grp IGMP MAC Address, [ipAddr]
-h display help information
-m modifies existing forwarding map
-ph selects host port [hnum]: {1..17|all}
-pr selects router port [rnum]: {1..17|all}
-s shows current IGMP snooping settings
-to sets IGMP route aging [toval] in seconds: {0...65535}, default 60s
-ver verbose help

>

The options available using the igmp command are shown below.
The -a switch manually adds a IGMP route, including source router (-evc) and destination host (-grp IP
address).
The -d switch deletes an IGMP route.
The -dis switch disables aging, flooding and snooping:
aging - disables aging on a specific IGMP route.
flood - disables flooding of unrecognized IGMP routes.
snooping - disables IGMP snooping.
The -ena switch enables aging, flooding and snooping:
aging - enables aging on a specific IGMP route.
flood - enables flooding of unrecognized IGMP routes.
snooping - enables IGMP snooping.
The -evc switch selects the EVC name for a manually configured route.
The -grp switch selects the specific IGMP multicast IP address group.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -m switch modifies an existing IGMP route.
The -ph switch selects the host port(s) on the module for a defined route.
The -pr switch selects the router port(s) on the module for a defined route.
The -s switch displays the current IGMP configurations for the module.
The -to switch selects the timeout value in seconds to automatically remove a route from the forwarding
database. The timeout never expires with a value of 0.
The -ver switch displays the extended help screen.

Page 82
To display the current IGMP configuration, use the -s command.

> igmp -s

Snooping: Disabled
IGMP Flooding: Disabled
Snooping timeout: 60s

>

To automatically enable IGMP snooping on a EVC, use the following commands.

> igmp -a -evc E1


> igmp -a -evc E2
> igmp -ena snooping
> igmp -s

Snooping: Enabled
IGMP Flooding: Disabled
Snooping timeout: 60s

IGMP EVC Interfaces


E1
E2

>

To manually configure a IGMP route, use the -grp to define the multicast IP address and the -pr and -ph
to configure the multicast router and host ports.

> igmp -a -evc E1 -grp 225.100.100.1 -pr 1 -ph 3


> igmp -ena snooping
> igmp -s

Snooping: Enabled
IGMP Flooding: Disabled
Snooping timeout: 60s

IGMP EVC Interfaces


E1

IP Address Type Persistence Router Port Host Port EVC Name


225.100.100.1 Manual Static 1 3 default

>

Page 83
5.1.21 Interface Settings (INTERFACE)
The interface command provides the ability to associate EVCs to specific ports on the module and configure
the port type for NNI or UNI.
To configure the ports on the module, use the interface command from the CLI prompt. A list of options
is displayed when the interface -h command is entered.

> interface -h

Description: Interface configuration


Format: interface [-a|-d|-dall|-h [-ver]|-s] [-p port] [-e evcName[:vidrange]]
[-pt evcName:primaryVID] [-t type] [-except evcName:vid]
[-pcp pbits] [-dscp ipPri]
[-ep evcName[:vidrange]]
Switches:
-a add an EVC association on a specific port
-d delete an EVC association on a specific port
-dall delete all EVC associations and restore defaults
-dscp selects the IP priority, [ipPri]: {*,0..63,0..63|all|rest}
-e selects the [vidrange] for the specified [evcName]
[evcName] is the name of the EVC as defined by the evc command
[vidrange] for a UNI port are the CE-VLANs: { *, 0..4095 | all | rest}
Note: The asterisk indicates untagged data.
-ep selects the [vidrange] for the specified protection [evcName]
[evcName] is the name of the EVC as defined by the evc command
[vidrange] for a UNI port are the CE-VLANs: {*,0..4095|all|rest}
Note: The asterisk indicates untagged data.
-except for [evcName], [vid] is not included in the evc CE-VLAN map
-h display help information
-p [portNum] selected: {1...17,mgt1,all}
-pcp selects the tag priority [pbits]: {0..7,0..7}
-pt select for the specific UNI [evcName] the [primaryVID]: {0...4095}
If this option is not present the [primaryVID] defaults to smallest
vid in the [vidrange]
-s shows the interface configuration
-t selects port [type] for the specified port: {uni|nni}
-ver verbose help

>

The options available using the interface command are shown below.
The -a switch allows an EVC association and configuration to be added to a port.
The -d switch deletes an EVC association on the selected port.
The -dall switch deletes all EVCs and restores factory defaults.
The -dscp switch provides flow filtering on the IP priority bits.
The -e switch defines the EVC association that is being added or deleted on a port.
The -ep switch defines a different EVC when using ELPS.
The -except switch removes a VLAN ID (VID) that has been defined in a VID range (VLAN 200...300).
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -p switch defines one or more ports on the module to be used when an EVC is added or deleted, or
when a port type is changed or defined.
The -pcp switch provides flow filtering on a PCP tag priority (bpit) value.

Page 84
The -pt switch overrides the MEF definition of the primary VID being the smallest VID number in a
range and allows support of the generic CFM implementation. If the -pt switch is not defined on an EVC
association, it defaults to the smallest VID in the range. It is used with the -e switch.
The -s switch displays the current EVC associations and configurations for all the ports on the module.
The -t switch defines the specified port as an UNI or NNI port type.
The -ver switch displays the extend help screen.
CE-VLAN ID on UNI ports can be configured with several vidrange options including:
VLAN 200..300 Indicates range of VLAN ID from 200 to 300.
all Indicates VLAN 1 - 4095.
rest Indicates all VLAN not specifically defined.
* Indicates untagged traffic.
The * can be combined with the other parameters to include untagged traffic (all*, rest*, 200...300*).
Configuring a CE-VLAN for 0 is the same as using the * for untagged traffic.
Extended flow filtering can be configured using the -etype, -ipdst, ipsrc, -l4dest, -l4src, -macda, -macsa
or -pcp switches. When one of these switches are used, only traffic matching the defined values will be
allowed to ingress the port. All other traffic not matching the defined values will be dropped.
The example below configures Port 15 on the module as a NNI.

> interface -a -p 15 -t nni

The example below configures Port 3 to be associated with a “ServiceProvider” EVC, with a customer VLAN
ID 300 with a filter on the PCP value. Only CE-VLAN ID of 300 with a PCP priority of 5 will be allowed.

> interface -a -p 3 -t uni -e ServiceProvider:300 -pcp 5

The example below configures the management port to be associated with a “ServiceProvider” EVC and
accept untagged traffic.

> interface -a -p mgt1 -t uni -e ServiceProvider:*

* indicates the EVC will accept untagged traffic


Once an EVC range has been configured, it must be deleted before the range can be changed or swapped.

Page 85
To display the configuration of the interface, use the interface -s command.

> interface -s

Port 1 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-71]


Port 2 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-72]
Port 3 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-73]
EVC “ServiceProvider” (primary VID 300); CE-VLAN Map 300
No priority; trust; CE-VLAN preserve; CE-CoS preserve
Port 4 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-74]
Port 5 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-75]
Port 6 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-76]
Port 7 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-77]
Port 8 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-78]
Port 9 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-79]
Port 10 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-7a]
Port 11 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-7b]
Port 12 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-7c]
Port 13 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-7d]
Port 14 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-7e]
Port 15 (Comp ID 1) is type NNI [MAC 00-06-87-01-e6-7f]
EVC “ServiceProvider” provider tag 1000; trust
Port 16 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-80]
Port 17 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-81]
Mgt1 (Comp ID 1) is type UNI [MAC 00-06-87-01-e6-70]
EVC “ServiceProvider” (No Primary VID); CE-VLAN Map *
No priority; trust; CE-VLAN preserve; CE-CoS preserve

>

NOTE: The EVC “ServiceProvider” in the example above indicates a trust parameter. When trust
is shown, the priority bits of the ingress frame will be used for the EVC. If trust is not shown, the
priority bit entered with the -pri command will be used. By default all EVCs created will inherit the
priority bits of the ingress frame (trust). See EVC commands in Section 5.1.17.
To delete the EVC association on Port 3, use the -d command.

> interface -d -p 3 -e ServiceProvider

Page 86
5.1.23 IP Configuration (IP)
The ip command provides the ability to configure the IP address, subnet mask and gateway of the module.
It also allows DHCP to be disabled or enabled.
To configure IP, use the ip command from the CLI prompt. A list of options is displayed when the ip -h
command is entered.

> ip -h

Description: IP Configuration
Format: ip [-h [-ver]|-s] [-addr ipAddr] [-net subNet] [-gw gateway]
[{-dis|-ena} circuitid|dhcp|relay|remoteid] [-rserv ipAddr] [-rtype tsel]
Switches:
-addr sets manual IP address [ipAddr]
-dis disable function: {circuitid|dhcp|relay|remoteid}
-ena enable function: {circuitid|dhcp|relay|remoteid}
[circuitid] DHCP Relay Agent Circuit ID enable/disable, dflt enabled
[dhcp] DHCP protocol enable/disable, dflt disabled
[relay] DHCP Relay Agent (option 82) enable/disable, dflt disabled
[remoteid] DHCP Relay Agent Remote ID enable/disable, dflt enabled
-gw set gateway address [gateway]
-h display help information
-net set subnet mask [subNet]
-rserv sets the DHCP Relay Server [ipAddr]
-rtype set the DHCP Relay type, [tsel]: {drop|keep|replace}
-s shows current IP settings
-ver verbose help or show

>

The options available using the ip command are shown below.


The -addr switch configures the IP address of the module.
The -dis switch disables DHCP Relay Agent Circuit ID, DHCP client, DHCP Relay Agent and DHCP
Relay Agent Remote ID.
The -ena switch enables DHCP Relay Agent Circuit ID, DHCP client, DHCP Relay Agent and DHCP
Relay Agent Remote ID.
The -gw switch configures the gateway IP address of the module.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -net switch configures the subnet mask of the module.
The -rserv switch configures the DHCP Relay Server IP address.
The -rtype switch configures the handling of the received DHCP relay frame on the client ports.
drop - drops the DHCP relay frame received on a client port.
keep - forwards the DHCP relay frame received on a client to the server port without changing to the
DHCP relay options.
replace - updates the DHCP relay frame received on a client port with the configured DHCP relay
options before forwarding it to the server port.
The -s switch displays the current IP configuration.
The -ver switch displays the extended help or show status screens.

Page 87
To configure the IP address of the module, use the -addr command.

> ip -addr 192.168.1.100

Use the -s command to view the IP configuration of the module.

> ip -s

MAC address: 00-06-87-01-ff-20


IP Address: 192.168.1.100
Subnet mask: 255.255.255.0
Gateway address: 192.168.1.1

DHCP Disabled
Relay Disabled
Relay Circuit ID Enabled
Relay Remote ID Enabled
Relay type drop
Relay server IP

>

The DHCP Relay Agent relays DHCP messages between DHCP clients and DHCP servers. A DHCP relay
agent receives any DHCP broadcasts and forwards them to the specified IP address.
1. The DHCP client generates a DHCP request.
2. The DHCP relay agent receives the broadcast DHCP request packet and inserts the relay agent information
option (option 82) into the packet. The relay agent information option contains related suboptions
(Circuit ID and Remote ID).
3. The DHCP relay agent sends the DHCP packet to the DHCP server.
4. The DHCP server receives the packet, uses the suboptions to assign IP addresses and other configuration
parameters to the packet, and forwards the packet back to the client.
5. The suboption fields are removed by the relay agent and the IP address information is forwarded to the
client.
5.1.24 Link Aggregation Control Protocol (LACP)
Link Aggregation Groups (LAG) and Link Aggregation Control Protocol (LACP) are methods to provide
more than one link between two devices and automate the configuration and maintenance of the links.
LAG and LACP is defined in the IEEE 802.1ax standard.
Link aggregation as defined in IEEE 802.1ax groups Ethernet interfaces to build a single link layer interface,
called a Link Aggregation Group or bundle.
Grouping multiple links between physical interfaces creates a single logical point-to-point link or LAG. The
LAG balances traffic across the member links within an aggregated Ethernet group and effectively increases
the uplink bandwidth. Another advantage of link aggregation is increased availability, because the LAG is
composed of multiple links. If one link fails, the LAG continues to carry traffic over the remaining links.
LAG needs to be configured manually on each pair of physical interfaces. With LAG, all the interfaces
must operate at the same speed and be in full-duplex mode.
Link Aggregation Control Protocol (LACP), when enabled, automates the LAG connectivity.

Page 88
The main purpose of LACP is to automate the configuration and maintenance of Link Aggregation Groups.
LACP dynamically adds or deletes individual links to the aggregated bundle and provides the mechanism
for recovery from link failures. LACP helps prevent communication failure by detecting misconfigurations
on the local end and remote end of the link.
The lacp command provides the ability to configure the ports on the module to support Link Aggregation
Group and Link Aggregation Control Protocol. A list of options is displayed when the lacp -h command
is entered.
> lacp -h

Description: LACP/LAG Configuration


Format: lacp [{-h|-s} [-ver]] [-p portNum] [-ppri pnum] [-clr]
[{-dis|-ena} {active|aggr|fast|key|lacp|lag}] [-key kval] [-lp lnum]
[-fwd {macda|macsa|port}] [-spri snum] [-act anum] [-aggrkey kval]
Switches:
-act selects maximum number of active ports in a LAG [anum]: {1..4}, default 4
-aggrkey sets link aggregation group key [kval]: {0..65535}
-clr clears statistic counters
-dis disable function: {active|aggr|fast|key|lacp|lag}
-ena enable function: {active|aggr|fast|key|lacp|lag}
[active] LAG active enable/disable passive
[aggr] LAG port aggregatable enable/disable individual link
[fast] LAG port fast (short) timeout enable/disable long timeout
[key] LAG port auto key adjust enable/disable no auto adjust
[lacp] LAG control protocol port enable/disable static group
[lag] LAG module enable/disable
-fwd sets frame forwarding algorithm: {macda|macsa|port}
-h display help information
-key sets the system key for the port [kval]: {0..65535]
-lp sets the logical port number [lnum] for the LAG: {81..88)
-p selects the [portNum] for the LAG group: {1,..,..,16}
-ppri sets port priority [pnum]: {0..65535}
-s shows current LAG/LACP settings
-spri sets system priority [snum]: {0..65535}
-ver verbose help or show

>

The options available using the lacp command are shown below.
The -act switch selects the maximum number of active ports in a Link Aggregation Group.
The -aggrkey sets the link aggregation group key.
The -clr switch allows the port statistic counters to be cleared to zero.
The -dis switch disables one of the following functions:
active disables port active mode and enables port passive mode.
aggr disables port aggregation mode and enables port individual mode.
fast disables LACP fast transmission mode and enables slow transmission mode.
key disables automatic key adjustment and enables manual key usage.
lacp disables LACP on an individual port and enables LAG static group (no LACP automatic
information).
lag disables link aggregation on a per module basis.
The -ena switch enables one of the following functions:
active enables port active mode and disables port passive mode.

Page 89
aggr enables port aggregation mode and disables port individual mode.
fast enables LACP fast transmission mode and disables slow transmission mode.
key enables automatic key adjustment and disables manual key usage.
lacp enables LACP on an individual port and disables LAG static group.
lag enables link aggregation on a per module basis.
The -fwd switch configures the frame forwarding algorithm: ip, macda, macsa or port.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -key switch configures the system key for the port.
The -lp switch sets the logical port number for LAG.
The -p switch selects the port to be used for the Link Aggregation Group.
The -ppri switch configures the port priority.
The -s switch displays the configured settings.
The -spri switch configures the system priority.
The -ver switch displays the extended help or show status screens.

Page 90
To display the current LACP configuration, use the lacp -s command.

> lacp -s

Link Aggregation: Disabled


System Identification: 00-06-87-02-14-40
System Priority: 32768
Frame forwarding: Port

LAG LACP Aggreg Key LACP Tx Aggr Max


Aggr Mode Mode Type Type Role Rate Key Act
==================================================================
1 Disabled Static Indiv Auto Passive Slow 0 4
2 Disabled Static Indiv Auto Passive Slow 0 4
3 Disabled Static Indiv Auto Passive Slow 0 4
4 Disabled Static Indiv Auto Passive Slow 0 4
5 Disabled Static Indiv Auto Passive Slow 0 4
6 Disabled Static Indiv Auto Passive Slow 0 4
7 Disabled Static Indiv Auto Passive Slow 0 4
8 Disabled Static Indiv Auto Passive Slow 0 4
9 Disabled Static Indiv Auto Passive Slow 0 4
10 Disabled Static Indiv Auto Passive Slow 0 4
11 Disabled Static Indiv Auto Passive Slow 0 4
12 Disabled Static Indiv Auto Passive Slow 0 4
13 Disabled Static Indiv Auto Passive Slow 0 4
14 Disabled Static Indiv Auto Passive Slow 0 4
15 Disabled Static Indiv Auto Passive Slow 0 4
16 Disabled Static Indiv Auto Passive Slow 0 4

Port --- Aggregation -- --------- Partner -----------


Port Pri Key Status ID LP Sys ID Port Pri
===================================================================
1 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
2 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
3 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
4 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
5 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
6 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
7 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
8 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
9 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
10 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
11 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
12 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
13 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
14 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
15 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
16 32768 0 Detached 0 0 00-00-00-00-00-00 0 0

>

Page 91
The following example configures LACP/LAG on Port 1 and Port 2 on two 7090-07 PoE modules.

Node A Setup
Node A
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> ethertype -uni 8100
> evc -a -e E1 -p 15,16,17,mgt1 -v 1001
> interface -a -p 15 -t nni
> interface -a -p 16 -t nni
> interface -a -p 17 -t uni -e E1:100*
> interface -a -p mgt1 -t uni -e E1:*
> evc -ena
> cfm -ena all
> l2cp -a -p all -c tunnel -n linkoam
> l2cp -a -p all -c tunnel -n lldp
> lacp -ena lag
> lacp -p 15,16 -ena active,aggr,lacp -key 100

Node B Setup
Node B
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> ethertype -uni 8100
> evc -a -e E1 -p 15,16,17,mgt1 -v 1001
> interface -a -p 15 -t nni
> interface -a -p 16 -t nni
> interface -a -p 17 -t uni -e E1:100*
> interface -a -p mgt1 -t uni -e E1:*
> evc -ena
> cfm -ena all
> l2cp -a -p all -c tunnel -n linkoam
> l2cp -a -p all -c tunnel -n lldp
> lacp -ena lag
> lacp -p 15,16 -ena active,aggr,lacp -key 100

Page 92
To display the current LACP configuration, use the lacp -s command.

> lacp -s

Link Aggregation: Disabled


System Identification: 00-06-87-02-14-40
System Priority: 32768
Frame forwarding: Port

LAG LACP Aggreg Key LACP Tx Aggr Max


Aggr Mode Mode Type Type Role Rate Key Act
==================================================================
1 Disabled Static Indiv Auto Passive Slow 0 4
2 Disabled Static Indiv Auto Passive Slow 0 4
3 Disabled Static Indiv Auto Passive Slow 0 4
4 Disabled Static Indiv Auto Passive Slow 0 4
5 Disabled Static Indiv Auto Passive Slow 0 4
6 Disabled Static Indiv Auto Passive Slow 0 4
7 Disabled Static Indiv Auto Passive Slow 0 4
8 Disabled Static Indiv Auto Passive Slow 0 4
9 Disabled Static Indiv Auto Passive Slow 0 4
10 Disabled Static Indiv Auto Passive Slow 0 4
11 Disabled Static Indiv Auto Passive Slow 0 4
12 Disabled Static Indiv Auto Passive Slow 0 4
13 Disabled Static Indiv Auto Passive Slow 0 4
14 Disabled Static Indiv Auto Passive Slow 0 4
15 Enabled Active Aggreg Fixed Active Fast 0 4
16 Enabled Active Aggreg Fixed Active Fast 0 4

Port --- Aggregation -- --------- Partner -----------


Port Pri Key Status ID LP Sys ID Port Pri
===================================================================
1 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
2 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
3 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
4 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
5 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
6 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
7 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
8 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
9 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
10 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
11 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
12 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
13 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
14 32768 0 Detached 0 0 00-00-00-00-00-00 0 0
15 32768 100 Detached 1 0 00-00-00-00-00-00 0 0
16 32768 100 Detached 1 0 00-00-00-00-00-00 0 0
>

Page 93
5.1.25 Layer 2 Control Protocol (L2CP)
The l2cp command provides the ability to configure and display L2CP frame control on each port. To
keep Service Provider and Subscriber networks separate, each port can be independently configured to
tunnel, forward, discard or peer L2CP frames. This prevents unauthorized interaction between the Service
Provider and Customer networks.
To configure Layer 2 Control Protocols, use the l2cp command from the CLI prompt. A list of options is
displayed when the l2cp -h command is entered.

> l2cp -h

Description: Layer 2 Control Protocol (Reserved Address) configuration


Format: l2cp [-a|-dall|-h [-ver]|-s] [-mac macAddress|-msh sMacAddr|-n l2Name]
[-p portNum] [-c l2cpControl]
Switches:
-a add or change selection
-c type of [l2cpControl]: {discard,tunnel,forward,peer}, default “tunnel”
-dall delete all configured L2CP settings and restore defaults
-h display help information
-mac destination MAC Address, [macAddr]: {xx-xx-xx-xx-xx-xx}
-msh short destination MAC Address, [sMacAddr]: {xx}
Where resultant MAC address is 01-80-c2-00-00-xx
Slow protocol configuration is via mnemonics lacp, marker, and linkoam
-n specifies destination MAC address based upon name:
{rstp, lacp, marker, linkoam, 802.1x, macp, elmi, pbridge, gvrp,
lldp, garp, undef}
-p [portNum] selected: {1...17|all}
-s shows l2cp configuration
-ver verbose help

Where:
rstp Rapid Spanning Tree, DA=01-80-c2-00-00-00
lacp Link aggregation control protocol, DA=01-80-c2-00-00-02, subtype=1
marker Marker protocol, DA=01-80-c2-00-00-02, subtype=2
linkoam Link OAM 802.3ah protocol, DA=01-80-c2-00-00-02, subtype=3
802.1x Port Authentication protocol, DA=01-80-c2-00-00-03
macp IEEE MAC specific protocols, DA=01-80-c2-00-00-04
elmi Ethernet Local Management Interface, DA=01-80-c2-00-00-07
pbridge Provider Bridge Group Address, DA=01-80-c2-00-00-08
gvrp Provider Bridge GVRP Address, DA=01-80-c2-00-00-0d
lldp Link Layer Discovery Protocol (Nearest Bridge), DA=01-80-c2-00-00-0e
garp Generic Address Registration Protocol, DA=01-80-c2-00-00-2X
undef Undefined addresses block, DA=01-80-c2-00-00-xx,
where xx is 05, 06, 09, 0a, 0b, 0c, 0f, and undefined subtypes of 02

>

The options available using the l2cp command are shown below.
The -a switch allows L2CP protocol to be added or changed.
The -c switch defines the way the protocol is handled by the port (discard, tunnel, forward or peer).
The -dall switch deletes all L2CP settings and restores factory default.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -mac switch defines the MAC address of the L2CP protocol to be added or changed.
The -msh switch allows the MAC address to be shortened to the least significant octet.
The -n switch defines the name of the L2CP protocol is be added or changed.

Page 94
The -p switch defines the port associated with L2CP protocol.
The -s switch displays the current L2CP protocol configuration.
The -ver switch displays the extended help screen.
L2CP frames have specific destination MAC addresses that belong to reserved multicast MAC addresses.
The range of L2CP destination MAC addresses are 01-80-C2-00-00-00 through 01-80-C2-00-00-0F and
01-80-C2-00-00-20 through 01-80-C2-00-00-2F. Several L2CP frames share the same destination MAC
address.
The definition of the L2CP controls are:
Discard
The ingress frame will be dropped and no reply is generated. No L2CP frame will egress a port
configured as Discard.
Forward
The ingress frame will not be altered. All EVC rules will be ignored as the frame egress the port
(unmodified). The frame only egresses ports that are configured as Forwarding ports.

Tunnel
The ingress frame will be treated as normal Ethernet service data. When the frame egresses the port,
it will follow the EVC rules configured on the module.

When customer’s LAN segments are interconnected across a Service Provider network, tunneling enables
Layer 2 Control Protocols to be transported across a Service Provide network without any interaction.
This provides a L2CP connection between the customer LAN segment end-points.
Peer
When configured as Peer, the port will participate in the specific Layer 2 Control Protocol. The frame
will be processed according to the specification of the protocol.
Generally, all L2CP frames are either discarded, forwarded or tunneled. However, certain Layer 2
Control Protocols may be peered at the ingress port. LACP and Link OAM are examples of two Layer
2 Control Protocols that may require peering.
NOTE: When Layer 2 Protocol Tunneling is enabled, it will over-ride the associated Layer 2 Control
Protocol setting.

Page 95
The default L2CP settings are shown in the table below.
Destination MAC Protocol Default Setting
01-80-C2-00-00-00 RSTP Tunnel
01-80-C2-00-00-01 Pause Discard
01-80-C2-00-00-02 LACP (Slow Protocol) Tunnel
01-80-C2-00-00-02 Marker (Slow Protocol) Tunnel
01-80-C2-00-00-02 Link OAM (Slow Protocol) Peer
01-80-C2-00-00-02 - Tunnel
01-80-C2-00-00-03 802.1x Port Authentication Tunnel
01-80-C2-00-00-04 IEEE MAC Tunnel
01-80-C2-00-00-05 - Tunnel
01-80-C2-00-00-06 - Tunnel
01-80-C2-00-00-07 E-LMI Tunnel
01-80-C2-00-00-08 Pr Bridge Tunnel
01-80-C2-00-00-09 - Tunnel
01-80-C2-00-00-0A - Tunnel
01-80-C2-00-00-0B - Tunnel
01-80-C2-00-00-0C - Tunnel
01-80-C2-00-00-0D GVRO Tunnel
01-80-C2-00-00-0E LLDP Peer
01-80-C2-00-00-0F - Tunnel
01-80-C2-00-00-2X GARP Tunnel

L2CP Default Settings


To display the configuration of the L2CP Protocols, use the l2cp -s command.

> l2cp -s

Destination Address Port 1 Port 2 Port 3 Port 4 ...... Port 16 Port 17


01-80-c2-00-00-00 (RSTP) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-01 (Pause) discard discard discard discard ...... discard discard
01-80-c2-00-00-02 (LACP) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-02 (Marker) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-02 (Link OAM) peer peer peer peer ...... peer tunnel
01-80-c2-00-00-02 () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-03 (802.1x) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-04 (IEEE MAC) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-05 () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-06 () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-07 (E-LMI) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-08 (Pr Bridge) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-09 () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0a () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0b () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0c () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0d (GVRP) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0e (LLDP) peer peer peer peer ...... peer tunnel
01-80-c2-00-00-0f () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-2X (GARP) tunnel tunnel tunnel tunnel ...... tunnel tunnel

>

Page 96
To configure Port 2 on the module to forward LLDP, use the -n lldp command.

> l2cp -a -p 2 -n lldp -c forward

To display the configuration of the L2CP Protocols, use the l2cp -s command.

> l2cp -s

Destination Address Port 1 Port 2 Port 3 Port 4 ...... Port 16 Port 17


01-80-c2-00-00-00 (RSTP) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-01 (Pause) discard discard discard discard ...... discard discard
01-80-c2-00-00-02 (LACP) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-02 (Marker) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-02 (Link OAM) peer peer peer peer ...... peer tunnel
01-80-c2-00-00-02 () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-03 (802.1x) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-04 (IEEE MAC) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-05 () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-06 () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-07 (E-LMI) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-08 (Pr Bridge) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-09 () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0a () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0b () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0c () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0d (GVRP) tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-0e (LLDP) peer forward peer peer ...... peer tunnel
01-80-c2-00-00-0f () tunnel tunnel tunnel tunnel ...... tunnel tunnel
01-80-c2-00-00-2X (GARP) tunnel tunnel tunnel tunnel ...... tunnel tunnel

>

NOTE: Layer 2 Control Protocol does not provide destination MAC address replacement. Use Layer
2 Protocol Tunneling (L2PT) commands when destination MAC address replacement is required.

Page 97
5.1.26 Layer 2 Protocol Tunneling (L2PT)
The l2pt command provides the ability to configure the module to support Layer 2 Protocol Tunneling on
each port. The module supports tunneling of Cisco Discovery Protocol (CDP), Cisco Per VLAN Spanning
Tree (PVST), Spanning Tree (STP) and VLAN Trunking Protocol (VTP). The module also supports L2CP
MAC address tunneling of E-LMI, LLDP, 802.1x and Slow Protocols. Each protocol can be enabled or
disabled independently.
To configure Layer 2 Protocol Tunneling, use the l2pt command from the CLI prompt. A list of options is
displayed when the l2pt -h command is entered.

> l2pt -h

Description: Configure Layer 2 Protocol Tunneling


Format: l2pt [-a|-d|-dall|-h [-ver]|-s] [-ena|-dis ltype] [-p portNum]
[-drop {cdp|encap|l2cp|pvst|vtp},value] [-e evcName]
Switches:
-a add a l2pt stream association
-d delete a l2pt stream association
-dall deletes all l2pt stream associations
-dis disable [ltype] on an EVC: {cdp|elmi|lldp|port|pvst|slow|stp|vtp}
-ena enable [ltype] on an EVC: {cdp|elmi|lldp|port|pvst|slow|stp|vtp}
[cdp] Cisco Discovery Protocol, default disabled
[elmi] E-LMI protocol, default disabled
[lldp] Link layer discovery protocol, default disabled
[port] 802.1x port authentication protocol, default disabled
[pvst] Cisco Per VLAN Spanning Tree protocol, default disabled
[slow] Slow protocols, default disabled
[stp] Spanning Tree Protocol, default disabled
[vtp] VLAN Trunking Protocol, default disabled
-drop drop threshold [value] in kb/sec: {cdp|encap|l2cp|pvst|vtp}: {0...200},
default 20 kbps
[cdp] Cisco Discovery Protocol
[encap] All encapsulated frames, 01-00-0c-cd-cd-dx
[l2cp] All Layer 2 Control Protocols, 01-80-c2-00-00-0x
[pvst] Cisco Per VLAN Spanning Tree protocol
[vtp] VLAN Trunking Protocol
-e [evcName] associated with the l2pt stream, 1-45 ASCII characters
-h display help information
-p encapsulated [portNum] selected: {1..17}
Ports not specified are not encapsulated
-s shows the l2pt status
-ver verbose help

>

The options available using the l2pt command are shown below.
The -a switch adds a L2PT association to a port or EVC. There are a maximum of five instances that can
be added.
The -d switch deletes a L2PT association from a port or EVC.
The -dall switch deletes all L2PT associations.
The -dis and -ena switches disable or enable a specific protocol encapsulation for a port or EVC.
The -drop switch defines the maximum number of L2PT frame received per second on the module. The
maximum is 500 per type, but the total for all types on all instances is 500. The default is 20.
The -e switch defines the EVC associated with the L2PT instance.

Page 98
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -p switch defines the encapsulated port for the configured EVC. All ports not configured are normal
ports and will not encapsulate L2PT frames.
The -s switch displays the current L2PT status.
The -ver switch displays the extended help screen.
When the -ena switch is used, the destination MAC address of the enabled protocol is changed per the table
below. This allows the enabled protocol to propagate through the network. When the Ethernet PDU reaches
its destination, the original MAC address is restored. A threshold can be configured for each protocol to
only allow a specific number of frames per second.
Ethertype
L2CP Tunnel
Destination MAC Protocol and
MAC Address
Subtype
01-00-0C-CC-CC-CC Cisco CDP, VTP, PVST N/A 01-00-0C-CD-CD-D0
01-80-C2-00-00-00 STP N/A 01-00-0C-CD-CD-D0
01-80-C2-00-00-02 LACP/LAMP (Slow Protocol) 0x8809/01/02 01-00-0C-CD-CD-D4
01-80-C2-00-00-02 Link OAM (Slow Protocol) 0x8809/03 01-00-0C-CD-CD-D4
01-80-C2-00-00-02 ESMC (Slow Protocol) 0x8809/0A 01-00-0C-CD-CD-D4
01-80-C2-00-00-03 802.1x Port Authentication 0x888E 01-00-0C-CD-CD-D3
01-80-C2-00-00-07 E-LMI 0x88EE 01-00-0C-CD-CD-D7
01-80-C2-00-00-0E LLDP 0x88CC 01-00-0C-CD-CD-DE
01-80-C2-00-00-0E PTP Peer 0x88F7 01-00-0C-CD-CD-DE

Tunneled Protocol MAC Destination Changes


To display the configuration of the L2PT Protocols, use the l2pt -s command.

> l2pt -s

Drop threshold (kb/sec): cdp 20, encap 20, l2cp 20, pvst 20, vtp 20

>

In this example, the drop threshold is configured for each protocol. Cisco Discovery Protocol (CDP) drop
threshold is set to 150kbps, Cisco Per VLAN Spanning Tree (PVST) drop threshold is set to 160kbps,
L2PT drop threshold is set to 170kbps, VLAN Trunking Protocol (VTP) drop threshold is set to 180kbps
and Encapsulated Frames (ENCAP) drop threshold is set to 150kbps.

> l2pt -drop cdp,150


> l2pt -drop pvst,160
> l2pt -drop l2cp,170
> l2pt -drop vtp,180
> l2pt -drop encap,190

> l2pt -s

Drop threshold (kb/sec): cdp 150, encap 190, l2cp 170, pvst 160, vtp 180

>

Page 99
In this example, EVCs are configured on the module.

> evc -dis


> evc -dall
> evc -a -e data -p 1,2,3 -v 1000
> evc -a -e mgt -p 1,2,3,mgt1 -v 2000
> interface -a -p 1,2 -t nni
> interface -a -p 3 -t uni -e data:100 -e mgt:*
> interface -a -p mgt -t uni -e mgt:*
> evc -ena

In this example, the L2PT instances are associated with an EVC.

> l2pt -a -p 1,2 -e data


> l2pt -s

Drop threshold (kb/sec): cdp 150, encap 190, l2cp 170, pvst 160, vtp 180

EVC “data” encapsulated port: 1,2; no tunnel

>

In this example, the L2PT instances are configured.

> l2pt -ena cdp -e data


> l2pt -ena pvst -e data
> l2pt -ena stp -e data
> l2pt -ena vtp -e data
> l2pt -ena slow -e data
> l2pt -ena port -e data
> l2pt -ena elmi -e data
> l2pt -ena lldp -e data

> l2pt -s

Drop threshold (kb/sec): cdp 150, encap 190, l2cp 170, pvst 160, vtp 180

EVC “data” encapsulated port: 1,2; tunnel cdp, elmi, lldp, port, pvst, slow, stp, vtp

>

Tunnel implies all packets that ingress Port 3 (non-encapsulated port) will have their original destination
MAC address changed when the packet egresses Port 1 or 2 (encapsulated port) and all packets that ingress
Port 1 or 2 (encapsulated port) will change the destination MAC address back to the original value when
the packet egresses Port 3.
NOTE: When Layer 2 Protocol Tunneling is enabled, it will override any Layer 2 Control Protocol
settings.
NOTE: Layer 2 Protocol Tunneling follows standard EVC processing rules.

Page 100
5.1.27 IEEE 802.1ag Loopback (LBM)
The loopback command provides the ability to initiate and display the result of a loopback test between two
MEPs on the same Maintenance Association and Maintenance Domain. MEPs are able to send loopback
messages (LBM) to verify service connectivity to a particular maintenance point. Loopback indicates
whether the destination is reachable. The MEP will respond with Loopback Responses (LBR).
To enable loopback testing, use the lbm option from the CLI prompt. A list of options is displayed when
the lbm -h command is entered.

> lbm -h

Description: CFM loopback message configuration


Format: lbm [-clr|-h|-s] [-p portNum] [-n domainName|-l domainLevel|
-ni dindex] [-o maName|-oi mindex] [-mac macAddr] [-m mepid]
[-v primaryVid|-e evcName] [-r cnt] [-t testData] [-ver]
[-sz size|-fsz frameSize] [-f freq] [-pri pbits] [-to timeoutVal]
Switches:
-clr clear current loopback statistics of the MEP/MIP
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-f frequency (in ms) to send PDUs, default is 1s: {0,100...60000}
-fsz specifies Ethernet [frameSize], uses data TLV to adjust length
-h display help information
-l maintenance [domainLevel]: {0...7}
-m destination mep ID, [mepid], unique within a MA: {1...8191}
-mac destination MAC Address, [macAddr]: {xx-xx-xx-xx-xx-xx}
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p [portNum] selected: {1...17}
-pri vlan priority bits, [pbits], for PDU sent if tagged; default value is 0
-r repeat count, [rcnt], number of LBMs to be transmitted
0 = continuous transmission until stopped; Default = 3 for unicast LBM
-s show the current loopback statistics kept in this MEP/MIP
-sz TLV packet [size]; filled with testData or random if not defined
-t [testData], pattern of data in ASCII hex bytes: {0-9,A-F}, 1...16 bytes
-to sets the PDU [timeoutVal] in seconds: {1...10}, default 5 sec
-v [primaryVid] associated with the MA: {0...4095}
-ver verbose help or display of loopback full statistics

>

The options available using the lbm command are shown below.
The -clr switch clears the loopback statistics for a specified MEP/MIP.
The -e switch associates the loopback test with a specific EVC.
The -f switch defines the time interval between LBM PDU messages.
The -fsz switch defines the frame size of the loopback data.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -l, -n, and -ni switches indicate a specific level, domain name and index.
The -m switch defines the destination MEP.
The -mac switch defines the destination MAC address.
The -o and -oi switches indicate a specific maintenance association name and index.
The -p switch associates a specific port for loopback.

Page 101
The -pri switch defines the specific VLAN priority bits for the LBM PDU.
The -r switch defines the number of times the loopback test will be run.
The -s switch displays the current loopback statistics.
The -sz switch defines the size of the data pattern used during the loopback test.
The -t switch defines the data pattern used.
The -to switch sets the timeout value.
The -v switch associates a specific VID.
The -ver switch displays the extended help or show status screens.
The example below performs a loopback test on Maintenance Domain “Domain1” with remote Maintenance
End Point 101 on VLAN ID 1000. Other options include setting the size of the test pattern (-sz) and the
number of attempts (-r).

> lbm -p 15 -n Domain1 -m 101 -v 1000 -r 10 -sz 100

Loopback request to 00-06-87-00-cf-f9 with 100 bytes of data:


Reply 1 from 00-06-87-00-cf-f9 bytes 100 time=2 ms
Reply 2 from 00-06-87-00-cf-f9 bytes 100 time=2 ms
Reply 3 from 00-06-87-00-cf-f9 bytes 100 time=2 ms
Reply 4 from 00-06-87-00-cf-f9 bytes 100 time=2 ms
Reply 5 from 00-06-87-00-cf-f9 bytes 100 time=2 ms
Reply 6 from 00-06-87-00-cf-f9 bytes 100 time=2 ms
Reply 7 from 00-06-87-00-cf-f9 bytes 100 time=2 ms
Reply 8 from 00-06-87-00-cf-f9 bytes 100 time=2 ms
Reply 9 from 00-06-87-00-cf-f9 bytes 100 time=2 ms
Reply 10 from 00-06-87-00-cf-f9 bytes 100 time=2 ms

Loopback statistics for 00-06-87-00-cf-f9:


Packets: Sent = 10, Received successfully = 10, Lost = 0 (0 % loss)
Late = 0, Data comparison fail = 0
Min delay = 2 ms, Max delay = 2 ms, Average = 2 ms
Frame variation = 0 ms, Std deviation = 0 ms

>

To display the loopback statistics, use the lbm -s command.

> lbm -s

Loopback statistics for MEP ID 101 initiated by Domain1 level 3 MA01 Port 1
Total messages LBM sent = 10
Total in order valid messages received = 10
Total out of order valid messages received = 0
Total data compare failures = 0
Total number of LBRs transmitted = 0

>

Page 102
5.1.28 IEEE 802.3ah Link OAM (LINKOAM)
The linkoam command provides the ability to configure and monitor IEEE 802.3ah connectivity. By default
802.3ah is enabled.
To configure/monitor IEEE 8023.ah, use the linkoam option from the CLI prompt. A list of options is
displayed when the linkoam -h command is entered.

> linkoam -h

Description: Link OAM (802.3ah) configuration


Format: linkoam [-h [-ver]|-s] [-p portNum] [-m oamMode] [-lb {on|off}]
[-to timeout] [{-dis|-ena} oamFunction] [-e type,window,threshold]
[-cri criticalSelect] [-txrate tvalue]
Switches:
-clr clear event counters
-cri configure critical event
[criticalSelect]: {0,1..n,1..n}, based upon [traps] command number
0 clears the list
-dis disable selected oamFunction: {lb,eve,cri}
-ena enable selected oamFunction: {lb,eve,cri}
[lb] Link OAM loopback, default enabled
[eve] Link OAM event generation, default enabled
[cri] Link OAM critical event generation, default enabled
-e set event [type] [window] time to [threshold] for the specified port,
[type]: {symbol-period | frame | frame-period | frame-sec}
[window] is size of the event window in seconds
[threshold] is number of errors before event is triggered
-h display help information
-lb remote loopback mode state: {on|off}
-m configure oamMode: {active,passive]
-p [portNum] selected: {1..17|all}
-s shows the Link OAM configuration
-to loopback timeout: {0...300} in seconds, where 0 disables timeout
-txrate OAM PDU transmission rate (tvalue): {5...100} in frames/sec, default 10
-ver verbose help

>

The options available using the linkoam command are shown below.
The -clr switch clears the event counters.
The -cri switch configures the traps associated with critical alarm notification.
The -dis switch disables Link OAM loopback (lb), Link OAM event generation (eve) and Link OAM
critical event generation (cri).
The -ena switch enables Link OAM loopback (lb), Link OAM event generation (eve) and Link OAM
critical event generation (cri).
The -e switch configures the event type (type), the event window (window) and the event threshold
(threshold) parameters.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -lb switch enables/disables remote loopback. The default is disabled.
The -m switch configures the OAM mode (active or passive). The default OAM mode is active.
The -p switch associates a specific port for Link OAM configuration.
The -s switch displays the Link OAM configuration and event statistics.

Page 103
The -to switch configures the loopback timeout parameter. A 0 value disables the timeout.
The -txrate switch configures the OAM PDU transmission rate. The default is 10 seconds.
The -ver switch displays the extended help screen.
To display the Link OAM configuration, use the linkoam -s command.

> linkoam -s

Port 1
Modes
802.3ah OAM State Enabled
OAM Mode Active
Critical events Enabled
Loopback Mode Disabled
Loopback Timeout 30 sec
OAM Transmission Rate 10 fps
Local Status Remote Status
Discovery State In Process Discovery State In Process
Multiplexer State Forward Multiplexer State Unknown
Parser Action Forward Parser Action Unknown
Critical Event No Critical Event No
Link Fault No Link Fault No
Supports LB,Cri,Eve Supports Unknown
Mode Unknown
OUI Unknown
Link Events - Windows (sec) Link Events - Thresholds
Symbol Period 1 Symbol Period 1
Frame 1 Frame 1
Frame Period 1 Frame Period 1
Frame Sec 1 Frame Sec 1
Link Events Running Totals Link Errors Running Totals
Symbol Period 0 Symbol Period 0
Frame 0 Frame 0
Frame Period 0 Frame Period 0
Frame Sec 0 Frame Sec 0

Critical event trap list for Port 1: 3

NOTE: All ports will be displayed when the linkoam -s command is executed. To display a single
port, use the linkoam -s -p <portnum> command.

Page 104
Local Status
The Local Status displays the 802.3ah port status of the local device. The local device is controlled directly
by SNMP, Telnet or via the Serial Port and has the ability to communicate with an 802.3ah enabled remote
partner.
• Discovery State - Indicates the Discovery state (“Complete”, “In Process”, “Incomplete” or “Disabled”)
of the local ports. If “Complete” is displayed, Discovery has been completed. If “In Process”, Discovery
has been initiated but waiting for a response from the remote 802.3ah link partner. If “Incomplete”,
Discovery has received a response from the 802.3ah enabled remote partner but the Discovery process
is not yet completed. If “Disabled”, Discovery has not been initiated or 802.3ah is disabled.
• Multiplexer State - Indicates the Multiplexer state (“Discard” or “Forward”) of the local ports. If
“Forward” is displayed, the local device is forwarding non-OAM PDU network frames to the lower
sublayer. If “Discard”, the local device is discarding non-OAM PDU network frames.
• Parser Action - Indicates the Parser Action (“Discard”, “Forward” or “Loopback”) of the local ports.
If “Forward” is displayed, the local device is forwarding non-OAM PDU network frames to the higher
sublayer. If “Loopback”, the local device is looping back non-OAM PDUs network frames. If
“Discard”, the device is discarding non-OAM PDUs network frames.
• Critical Event - Indicates the Critical Event state (“Yes” or “No”) of the local device. If “Yes” is
displayed, the local device has detected a Critical Event. If “No”, the local device has not detected a
critical event.
• Link Fault - Indicates the local device has detected a fault in the receive direction (“Yes” or “No”). If
“Yes” is displayed, the receive link is down. If “No”, the receive link is up.
• Supports - Indicates the supported options (Variable Access “Var”, Link Event Notification “Events”,
Loopback “LB” or “Unknown” if no options are supported) of the remote partner.
Remote Status
The Remote Status displays the 802.3ah port status of the remote device. These remote ports are connected
to the ports of the local device. The remote partner is managed by the local device via the 802.3ah OAM
channel.
• Discovery State - Indicates the Discovery state (“Complete”, “In Process”, “Incomplete” or “Unknown”)
of the remote ports. If “Complete” is displayed, Discovery has been completed. If “In Process”,
Discovery has been initiated but not completed. If “Unknown” is displayed, Discovery state of the
remote partner is indeterminate.
• Multiplexer State - Indicates the Multiplexer state (“Discard”, “Forward” or “Unknown”) of the remote
ports. If “Forward” is displayed, the remote partner is forwarding non-OAM PDUs to the lower sublayer.
If “Discard”, the remote partner is discarding non-OAM PDUs network frames. If “Unknown”, the
Multiplexer state of the remote partner is indeterminate.
• Parser Action - Indicates the Parser Action state (“Discard”, “Forward”, “Loopback” or “Unknown”) of
the remote ports. If “Forward” is displayed, the remote partner is forwarding non-OAM PDUs network
frames to the higher sublayer. If “Loopback” is displayed, the remote partner is looping back non-OAM
PDUs network frames. If “Discard” is displayed, the remote partner is discarding non-OAM PDUs
network frames. If “Unknown” is displayed, Parser action of the remote partner is indeterminate.
• Critical Event - Indicates the Critical Event state (“Yes” or “No”) of the remote partner. If “Yes” is
displayed, the local device has detected a Critical Event. If “No”, the local device has not detected a
critical event.

Page 105
• Link Fault - Indicates the remote partner has detected a fault in the receive direction (“Yes” or “No”).
If “Yes” is displayed, the receive link is down. If “No”, the receive link is up.
• OAM Mode - Indicates the OAM mode (“Active”, “Passive” or “Unknown”) of the remote partner. If
“Unknown” is displayed, OAM mode of the remote partner is indeterminate.
• Supports - Indicates the supported options (Variable Access “Var”, Link Event Notification “Events”,
Loopback “LB” or “Unknown”) of the remote partner. If “Unknown” is displayed, support option of
the remote partner is indeterminate.
• OUI - Indicates the three hex byte IEEE organizational specific identifier (or “Unknown”) of the remote
partner. If “Unknown” is displayed, OUI of the remote partner is indeterminate.
Event windows and error thresholds for each 802.3ah event type are displayed. There are four event types:
Link Events - Windows
• Symbol Period
Sets the Symbol Period window size in 1 second intervals. The window specifies the number of symbols
in the defined period (time interval). For 10G, 1 sec is 1,250,000,000 symbols.
• Frame
Sets the Frame window size in 1 second intervals. The window specifies the number of frames in the
defined period (time interval).
• Frame Period
Sets the Frame Period window size in 1 seconds intervals. The window specifies the number of frames
in the defined period (time interval). For 10G, 1 sec is 14,880,000 frames.
• Frame Seconds
Sets the Frame Seconds window size in 1 second intervals. The window specifies the time interval for
counting errored frames (1-second intervals with at least one frame error).
Link Events - Threshold
• Symbol Period (error symbols per second)
Sets the threshold for the number of errored symbols for the defined Symbol Period window before a
alarm is generated.
• Frame (error frames per second)
Sets the threshold for the number of errors allowed for the defined Frame window before a alarm is
generated.
• Frame Period (error frames per x frames)
Sets the threshold for the number of errors allowed for the defined Frame Period window before a
alarm is generated.
• Frame Seconds (error seconds per x seconds)
Sets the threshold for the number of errors allowed for the defined Frame Second window before a
alarm is generated.
Link Events - Running Totals
• Symbol Period
Indicates the number of errored Symbol Period events alarms that have been generated.
• Frame Window
Indicates the number of errored Frame event alarms that have been generated.

Page 106
• Frame Period
Indicates the number of errored Frame Period event alarms that have been generated.
• Frame Seconds
Indicates the number of errored Frame Seconds event alarms that have been generated.
Link Errors - Running Totals
• Symbol Period
Indicates the sum of Symbol errors that have been detected.
• Frame Window
Indicates the sum of Frame errors that have been detected.
• Frame Period
Indicates the sum of Frame Period errors that have been detected.
• Frame Seconds
Indicates the sum of Frame Second errors that have been detected.
These events/errors are defined on a per port basis. A non-zero window value enables the event. All windows
entries are in seconds. Threshold values are based on the number of symbol/frame errors allowed during
the specified window period before an alarm is generated. When the threshold is exceeded, a SNMP trap
is initiated.
The conversion factor for symbols/frames depends on the speed of the port.
To change the OAM mode on Port 1, use the -m command.

> linkoam -m passive -p 1

The 802.3ah OAM Mode sets the selected port to Passive or Active configuration mode. In Passive mode,
the port cannot initiate Discovery or initiate Loopback Mode. It can observe and report only the port status
of its 802.3ah enabled remote partner. An Active port can initiate Discovery and initiate loopback mode.
To initiate an 802.3ah loopback on Port 2, use the -ena lb command.

> linkoam -ena lb -p 2

The Loopback Mode enables or disables the loopback operation. When Loopback Mode is set to Disable,
the port of the 802.3ah enabled local device will not initiate Loopback operations. It can respond to loopback
commands from its 802.3ah enabled remote partner if set to Passive or Active OAM Mode. When Loopback
Mode is set to Enable, the port of the 802.3ah enabled local device will initiate Loopback operations and
set the 802.3ah enabled remote partner into loopback. In this mode, the 802.3ah enabled local device will
not respond to any other configuration changes until its port is set to Disable or the Loopback timer expires.
To change the 802.3ah loopback timeout for Port 1, use the -t command.

> linkoam -t 100 -p 1

The Loopback Mode Timeout field controls the length of time that the port will stay in Loopback mode
when loopback is initiated. Loopback can be set between 0 and 300 seconds. The 0 setting disables the
timer and the module will stay in loopback until stopped by the user.

Page 107
5.1.29 IEEE 802.1ab Link Layer Discovery Protocol (LLDP)
The IEEE 802.1ab Link Layer Discovery Protocol defines a standard way for Ethernet devices to advertise
information about themselves to their neighbors and store information they discover from other device.
LLDP allows an Optical Network Unit (ONU) in a DPoE network to perform DEMARC Auto-Configuration
(DAC). Each device configured with an active LLDP agent will send and receive messages on all physical
interfaces enabled for LLDP transmission.
The lldp command provides the ability to configure the LLDP agent on the module.
To configure LLDP, use the lldp option from the CLI prompt. A list of options is displayed when the lldp -h
command is entered.

> lldp -h

Description: Configure Link Layer Discovery Protocol (LLDP)


Format: lldp [-dall|-h [-ver]|-s] [-reinit tdly] [-txfnum tnum] [-txfint tsec]
[-txhold tvalue] [-txnum tnum] [-txrate tsec] [-p portNum] [-mode
{none|rxOnly|rxTx|txOnly}] [-tlvena {mgt,pdes,sysname,sysdes,syscap}]
[-ty {dpoe|dpoeauto|std}]
Switches:
-dall delete all LLDP configuration settings and restore defaults
-h display help information
-mode defines the lldp mode on a per port basis
[none] neither lldp transmitter or receiver is enabled
[rxOnly] lldp receiver is enabled
[rxTx] both lldp transmitter and receiver enabled, default
[txOnly] lldp transmitter is enabled
-p [portNum] selected: {1..17}
-reinit delay from port disable until reinitialization, tdly: {1...10} in sec
-s shows the lldp status
-tlvena defines optional TLVs to send: {mgt,pdes,sysname,sysdes,syscap}:
[mgt] Management address
[pdes] Port description, same as Port Name
[sysname] System name, same as sysName object
[sysdes] System description, same as sysDescr object
[syscap] System capabilities
-txfint fast message transmission interval, tsec: {1...3600} in seconds
-txfnum number of lldp messages made during fast tx, tnum: {1..8}, default 4
-txhold multiplier of txrate for TTL value in PDU: {2..10}, default 4
-txnum number of consecutive lldp PDUs, tnum: {1...10}, default 5
-txrate lldp normal message transmission interval, tsec: {5...32768} in sec
-ty port type: {dpoe|dpoeauto|std}
[dpoe] lldp partner is DPoE
[dpoeauto] lldp partner is either standard or DPoE, default
[std] lldp partner is standard
-ver verbose help

>

The options available using the lldp command are shown below.
The -dall switch deletes all LLDP configuration settings.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -mode switch configures the port to receive, transmit, or transmit/receive LLDP PDUs.
The -p switch associates the port with the LLDP port instance.
The -reinit switch configures the delay time in seconds for LLDP to initialize on any interface. The range
is 2 to 5 seconds and the default is 2 seconds.

Page 108
The -s switch displays the current LLDP status.
The -tlvena switch selects which optional TLVs to be included in the transmit Link Layer Discovery
Protocol Data Units (LLD PDUs)
Management address (mgt)
Port description, same as Port Name (pdes)
System name, same as sysName object (sysname)
System description, same as sysDescr object (sysdes)
System capabilities (syscap)
The -txfint switch specifies the time interval between transmissions during fast transmission periods. The
range is 1 to 3,600 seconds and the default value is 1 second.
The -txfnum switch configures the the number of LLD PDUs that are transmitted during a fast transmission
period. The range is 1 to 8 messages and the default value is 4.
The -txhold switch configures the variable used as a multiplier of the Normal Transmission Interval to
determine the time remaining before information in the outgoing LLD PDU is no longer valid. The range
is 1 to 10 and the default is 4.
The -txnum switch configures the maximum number of consecutive LLD PDUs that can be transmitted at
any time. The range is 1 to 10 and the default value is 5.
The -txrate switch configures the transmission frequency of LLDP updates in seconds. The range is 5 to
65,534 seconds and the default is 30 seconds..
The -ty switch configures the LLDP port for DPoE, DPoE Auto (standard LLDP or DPoE), or standard
LLDP operation.
The -ver switch displays the extended help screen.
To configure Port 1 to participate in the DPoE LLDP process, use the following commands.

> l2cp -p 1 -a -n lldp -c peer


> lldp -p 1 -ty dpoe

Use the lldp -s command to display the LLDP status.

> lldp -s

Normal transmission interval: 30s


TTL value multiplier: 4
Fast LLDP transmission interval: 1s
Number of fast LLDP messages: 4
Maximum Number of LLDP messages: 5
Reinitialization delay: 2 sec
Capabilities supported: Bridge, CVLAN, SVLAN
Capabilities enabled: Bridge, CVLAN, SVLAN
Last change time: 5196
Number of times table data inserted: 0
Number of times table data deleted: 0
Number of times table data dropped: 0
Number of times table data aged out: 0

Page 109
Port 1 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 2 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 3 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 4 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Page 110
Port 5 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 6 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 7 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 8 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Page 111
Port 9 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 10 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 11 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 12 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Page 112
Port 13 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 14 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 15 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 16 Info:
LLDP Protocol: Peer
LLDP Mode: Receive and Transmit Enabled
LLDP TLVs included: mgt,pdes,sysname,sysdes,syscap
LLDP Status: LLDP PDUs are not being received
LLDP Type: dpoeauto
LLDP PDUs transmitted: 0
LLDP PDUs transmitted with length errors: 0
LLDP PDUs received: 0
LLDP PDUs discarded: 0
LLDP invalid frames received: 0
LLDP Port TLVs discarded: 0
LLDP Port TLVs unrecognized received: 0
LLDP Port Age Outs: 0

Port 17 Info:
LLDP Protocol: Tunnel

Page 113
5.1.30 Physical Location (LOCATION)
The location command provides the ability to configure the physical location of the module including
address, city, state, zip code, altitude, latitude and longitude.
To configure the Location of the module, use the location option from the CLI prompt. A list of options
is displayed when the location -h command is entered.

> location -h

Description: Displays module location information


Format: location [-dall|-h [-ver]|-s] [-addr mAddr] [-city mCity] [-state mState]
[-postal mPostal] [-lat mLat] [-long mLong] [-alt mAlt]
Switches:
-addr sets module address, [mAddr], 1-32 ASCII characters, default blank
-alt set module altitude, [mAlt], 1-16 characters, default blank
-city sets module city, [mCity], 1-32 ASCII characters, default blank
-dall restore module location factory defaults
-h display help information
-lat sets module latitude [mLast], 1-16 ASCII characters, default blank
value +90.000000 to -90.000000
-long sets module longitude [mLong], 1-16 ASCII characters, default blank
value +180.000000 to -180.000000
-postal sets module postal code/zipcode[mPostal], 1-16 ASCII characters,
default blank
-s shows the module location information
-state sets module state/provide, [mState], 1-32 ASCII characters, default blank
-ver verbose help

>

The options available using the lock command are shown below.
The -addr switch configures the physical module address.
The -alt switch configures the module altitude for above or below sea level.
The -city switch configures the city.
The -dall switch deletes all location settings and restores factory defaults.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -lat switch configures the module latitude from -90.000000 degrees to +90.000000.
The -long switch configures the module longitude from -180.000000 degrees to +180.000000.
The -postal switch configures the postal zone or zip code.
The -s switch displays the location settings for the module.
The -state switch configures the state.
The -ver switch displays the extended help screen.

Page 114
To configure the location for the module, use the following commands.

> location -addr “111 Main Street” -city Chicago -state Illinois -postal 60605
> location -s

Address: 111 Main Street


City: Chicago
State/province: Illinois
Postal/zipcode: 60605
Latitude:
Longitude:
Altitude:

>

NOTE: When configuring text based names, such as 111 Main Street, the text name much be in “ ”
for the command to be valid (location -addr “111 Main Street”). If the text based name does not have
any spaces between the words, then “ ” are not necessary (location -addr 111_Main_Street).

Page 115
5.1.31 Ethernet Locked Signal (LOCK)
The lock command provides the ability to configure an intentional administrative/diagnostic action.
Locked Signal (LCK) is transmitted by a MEP to communicate intentional administrative or diagnostic
actions at a MEP. LCK is sent to all associated MEPs in the MA. It is used for alarm suppression, and
enables MEPs to differentiate between the defect conditions and intentional administrative/diagnostic
actions at the server layer MEP. This capability is only supported in Y.1731.
To configure LOCK, use the lock option from the CLI prompt. A list of options is displayed when the
lock -h command is entered.

> lock -h

Description: Ethernet Locked Signal Signal (ETH-LCK) configuration


Format: lock [-h|-s|-clr] [-p portNum] [-n domainName | -l domainLevel |
-ni dindex] [-o maName | -oi mindex] [-v primaryVid | -e evcName]
[-m mepid] [-pri pbits] [-md domainLevel] [-err aerror]
[{-ena|-dis} {admin,lock,rx,tx}] [-ver] [-txvid lckVid] [-ctagvid cvid]
Switches:
-clr clear current ETH-LCK statistics of the MEP
-ctagvid C-TAG VID associated with the ETH-LCK PDUs for the MEP that
originates on a S-Comp UNI port or an NNI port
-dis disable function: {admin,lock,rx,tx}
-ena enable function: {admin,lock,rx,tx}
[admin] administrative locked state, default disabled
[lock] ETH-LCK protocol, default disabled
[rx] defect condition detection, default disabled
[tx] transmission of ETH-LCK PDU, default disabled
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-err selects errors, [aerror], that activates the ETH-LCK state:
{aisrx,aistx,link,lock,low,mep,none}
[aisrx] reception of AIS
[aistx] generation of AIS
[link] indicates a link loss error
[lock] indicates a ETH-LCK PDU received
[low] indicates a lower level MEP error
[mep] indicates a MEP error
[none] indicates no errors
-h display help information
-i lock interval, [interval] value, where: 4 (default) is 1s, 6 is 1min
-l maintenance [domainLevel]: {0...7}
-m destination mep ID, [mepid], unique within a MA: {1...8191}
-md transmit maintenance domain level [domainLevel]: {0..7}
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p [portNum] selected: {1..17}
-pri vlan priority bits, [pbits], for ETH-LCK sent if tagged; default is 0
-s show the current ETH-LCK configuration and statistics
-txvid defines [lckVID] that the LCK PDU is transmitted with: {0...4095}
-v [primaryVid] associated with the MA: {0...4095}
-ver verbose help or show

>

The options available using the lock command are shown below.
The -clr switch clears the ETH-LCK statistics
The -ctagvid switch associates a C-Tag VID to the ETH-LCK PDU.

Page 116
The -dis and -ena switches enable or disable specific ETH-LCK instances (admin, lock rx and tx).
admin enables/disables the administrative state lock state of the MEP when associated with a MEP.
If tx is enabled, ETH-LCK PDUs will be generated when a MEP is administratively locked. A port
administratively locked will not forward user data on the EVC.
lock enables/disables ETH-LCK globally if not associated with a MEP (-m).
lock enables/disables ETH-LCK locally when associated with a MEP (-m).
rx enables/disables detection of a defect condition (locally).
tx enables/disables transmission of ETH-LCK PDUs (locally).
The -e switch defines the EVC associated with the ETH-LCK instance.
The -err switch indicates the type of error results when ETH-LCK state is active. One or more errors can
be selected at a time. The default error type is: link and mep.
aisrx indicates AIS reception, default disabled.
aistx indicates AIS transmission, default disabled.
link indicates a port link failure, default enabled.
lock indicates a ETH-LCK PDU received by the MEP, default disabled.
low indicates a lower level MEP failure on the port, default disabled.
mep indicates a MEP failure on the port, default enabled.
none indicates no errors.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -i switch indicates the interval between transmissions of ETH-LCK PDUs (4 = 1 second, 6 = 1 minute,
all other values are invalid).
The -l, -n, and -ni switches indicate a specific ETH-LCK instance level, domain name and index.
The -m switch indicates the ETH-LCK instance is associated with a specific MEP ID.
The -md switch indicates the maintenance domain level that an ETH-LCK PDU is generated on.
The -o and -oi switches indicate a specific ETH-LCK instance is associate with a maintenance association
name and index.
The -p switch associates an ETH-LCK instance with the initiating port.
The -pri switch indicates the priority bit for the ETH-LCK PDU associated with a specific ETH-LCK
instance.
The -s switch displays the configured and running status ETH-LCK instances.
The -txvid switch defines the specific VID for the transmitted ETH-LCK PDU. If not defined, the primary
VID of the MEP is transmitted with the ETH-LCK PDU.
The -v switch indicates the primary VID associated with the ETH-LCK instance for specific MEP.
The -ver switch displays the extended help or show status screens.
The example below configures ETH-LCK to transmit on MD level 5 with link & mep errors generation.

> lock -l 2 -o ma2 -md 5 -err link,mep -txvid 5

Page 117
The example below clears the ETH-LCK counters.

> lock -clr

The example below locally enables ETH-LCK on MEP 100.

> lock –ena lock -l 5 -o ma5 -m 100

5.1.32 Link Redundancy (LR)


The lr command configures the module for link redundancy. When configured for link redundancy, the
module will transmit and receive traffic on the primary port (Port 15) and no traffic on the backup port
(Port 16). When a fiber failure occurs on the primary port, the module will switch over to the backup port
within 50msec.

Port Redundancy
To configure link redundancy, use the lr option from the CLI prompt. A list of options is displayed when
the lr -h command is entered.

> lr -h

Description: Link Redundancy configuration


Format: lr [-h [-ver]|-s] [-ena|-dis] [-pro pnum] [-work pnum] [-noret|-ret]
Switches:
-dis disable link redundancy
-ena ena link redundancy
-h display help information
-noret selects no return to working port
-pro select protected (secondary) port number, default port 2
-ret selects return to working port, default
-s show link redundancy configuration
-work select working (primary) port number, default port 1
-ver verbose help

>

The options available using the lr command are shown below.


The -dis and -ena switches disable/enable link redundancy.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -noret switch disables the return to the primary link when the link failure has been resolved.
The -pro switch selects which port will be configured as the backup (secondary) port. The default value
is port 2.

Page 118
The -ret switch enables the return to the primary link when the link failure has been resolved.
The -s switch displays the current configuration.
The -work switch selects which port will be configured as the primary port. The default value is port 1.
The -ver switch displays the extended help screen.
Use the lr -s command to display the link redundancy configuration.

> lr -s

Link redundancy: disabled


Return to primary: enabled

Working port: 1
Status: not active
Link: no link

Protection port: 2
Status: not active
Link: no link

>

To configure the link not to return to the primary link when the link failure has been fixed, use the lr -noret
command.

> lr -noret

Use the lr -s command to display the link redundancy configuration.

> lr -s

Link redundancy: disabled


Return to primary: disabled

Working port: 1
Status: not active
Link: no link

Protection port: 2
Status: not active
Link: no link

>

Page 119
5.1.33 IEEE 802.1ag Linktrace (LTM)
The linktrace command provides the ability to initiate and display the result of a linktrace test between two
MEPs on the same Maintenance Association and Maintenance Domain. Linktrace is used to isolate faults
within a Maintenance Domain. MEPs send Linktrace Messages (LTM) to track the path to a destination
MEP. Each Maintenance Point (MEP or MIP) along the path will respond with a Linktrace Response (LTR).
To enable linktrace testing, use the ltm option from the CLI prompt. A list of options is displayed when
the ltm -h command is entered.

> ltm -h

Description: CFM Linktrace operation


Format: ltm [-h [-ver]|-s] [-mac macAddr] [-m mepid] [-p portNum]
[-n domainName|-l domainLevel|-ni dindex] [-o maName|-oi mindex|
-v primaryVid|-e evcName] [-ttl ttlData] [-to timeoutVal]
Switches:
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-h display help information
-l maintenance [domainLevel]: {0...7}
-m destination mep ID, [mepid], unique within a MA: {1...8191}
-mac destination MAC Address, [macAddr]: {xx-xx-xx-xx-xx-xx}
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p [portNum] selected: {1...17}
-s show the last linktrace results
-to sets the PDU [timeoutVal] in seconds: {1...10}, default 5 sec
-ttl time to live field, [ttlData]
-v [primaryVid] associated with the MA: {0...4095}
-ver verbose help

>

The options available using the ltm command are shown below.
The -e switch associates the linktrace test with a specific EVC.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -l, -n, and -ni switches indicate a specific level, domain name and index.
The -m switch defines the destination MEP.
The -mac switch defines the destination MAC address.
The -o and -oi switches indicate a specific maintenance association name and index.
The -p switch associates a specific port for linktrace.
The -s switch displays the current linktrace statistics.
The -to switch sets the timeout value
The -ttl switch sets the time to live value.
The -v switch associates a specific VID.
The -ver switch displays the extended help screen.

Page 120
The example below performs a linktrace test on Maintenance Domain “Domain1”, Port 1, remote
Maintenance End Point 101 and VLAN ID 1000.

> ltm -p 15 -n Domain1 -m 101 -v 1000

MD index=1 MA Index=1 MEP ID=100 Transaction id 0. TTL 64.


Linktrace sent from Chassis 1, Slot 1, Port 15 00-06-87-00-cf-f1
Tracing the route to 00-06-87-00-cf-f9 on Domain Level 3, vlan 1000
Hit any key to terminate.

Last Egress ID Ingress MAC Relay Ingress Ingress Port


Hop Next Egress ID Egress MAC Reply Egress Egress Port
================================================================================
1 00-00:00-06-87-00-cf-f1 00-06-87-00-cf-f9 RlyHit IngOK Port 15
00-00:00-06-87-00-cf-f9 --:--:--:--:--:-- Term MEP ----- ------

>

Definitions:
Last Egress ID
Identifies the MEP Initiator that originated, or the Responder that forwarded, the Linktrace Message.
Next Egress ID
Identifies the Responder that transmitted the Linktrace Response, and can forward the Linktrace Message
to the next hop.
Ingress MAC
MAC address of the ingress port.
Egress MAC
MAC address of the egress port.
Relay Reply
RlyHit
The Linktrace Message reached the MEP with the same MAC address or MEP ID as the configured
destination MAC or destination MEP ID.
RlyFDB
The Egress Port was determined by consulting the Filtering Database.
RlyMPDB
The Egress Port was determined by consulting the MIP CCM Database.
Forward
Indicates a Linktrace Message was forwarded by the responding maintenance point.
Term MEP
The forwarded Linktrace Message reached the terminating MEP.
Ingress/Egress
egrNoTlv
Indicates that no Reply Egress TLV was returned in the Linktrace Message.
egrOK
The message was forwarded.

Page 121
egrDown
The port’s operational parameters are indicating a down MEP.
egrBlocked
The Egress Port can be identified, but the data frame would not pass through the Egress Port because
the port is not in the forwarding state.
egrVid
The Egress Port can be identified, but the port is not in the member set of the Linktrace Message
VID.
ingNoTlv
Indicates that no Reply Ingress TLV was returned in the Linktrace Message.
ingOK
The message was forwarded.
ingDown
The port’s operational parameters are indicating a down MEP.
ingBlocked
The message will not be forwarded if received on this port due to active topology enforcement.
ingVid
The ingress port is not in the member set of the Linktrace Message VID.
Ingress/Egress Port:
Port number of the ingress and egress port.

Page 122
5.1.34 Maintenance Association (MA)
A Maintenance Association is a group of maintenance points that belong to the same administrative domain.
When a Maintenance Association is created, it is associated with a specific Maintenance Domain, VLAN
ID (EVC) and port number. Names should be descriptive and unique. Maintenance Association names
can be between 1 and 45 characters (combination of letters and numbers with no spaces).
To create a Maintenance Association for a Maintenance Domain, use the ma option from the CLI prompt.
A list of options is displayed when the ma -h command is entered.

> ma -h

Description: CFM maintenance association configuration


Format: ma [-a|-d|-h|-m|-s] [-ver] [-n domainName|-l domainLevel|-ni dindex]]
[-o maName | -oi mindex] [-v primaryVid | -e evcName] [-i interval]
[-c compID | -p portNum] [-to timeoutVal] [-id idSelect][-mhf mhfSelect]
[-nm maNameType] [-noccmseq] [-noporttlv] [-nostatustlv]
Switches:
-a add maintenance association
-c component id, [compID]
1 = s-component (NNI port)
2 = c-component (first UNI port)
3-n = c-component when provider edge bridge (2nd-nth UNI port if
NNI port exists)
-d delete maintenance association
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-h display help information
-i ccm interval, [interval] value, where: 1 is 3.3ms, 2 is 10ms,
3 is 100ms, 4 (default) is 1s, 5 is 10s, 6 is 1min, 7 is 10min
-id sender ID TLV info,[idSelect]: {1(SendIdNone), 2(SendIdChassis),
3 (SendIdManage),4 (SendIdChassisManage),5 (SendIdDefer)}, default is 5
-l maintenance [domainLevel]: {0...7}
-m modify configuration of an existing maintenance association
-mhf MHF creation, [mhfSelect]: {1 (defMHFnone), 2 (defMHFdefault),
3 (defMHFexplicit), 4 (defMHFdefer)}, default is 4
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-nm select [maNameType] for maintenance association name, default is 2:
{1 (primary VLAN ID), 2 (charString), 3 (UnsignedInt16), 4 (vpn ID)}
where vpn ID format: [aa:bb:cc,ddd], where aa:bb:cc is VPN OUI
and ddd is VPN index, 32 (Y1731 MEG ID format) (1-13 ASCII characters)}
-noccmseq turns off incrementing the ccm sequence count and keeps it at zero
-noporttlv turns off Port Status TLV on the CCM
-nostatustlv turns off Interface Status TLV on the CCM
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p [portNum] selected: {1...17}
if [portNum] is a NNI, then compID=1
if [portNum] is a UNI, then compID=2 for lowest numbered UNI port,
compID=3-n for (2nd-nth UNI port if NNI port exists)
-s show existing maintenance associations
-to sets the CCM [timeoutVal] in ms: {100...2100000}, default 3.5x interval,
Min value is ccm rate set by -i command; max value is 10x ccm rate
-v [primaryVid] associated with the MA: {0...4095}
-ver verbose help or show

>

Page 123
The options available using the ma command are shown below.
The -a switch defines a Maintenance Association (MA).
The -c switch defines the component ID.
The component ID relates to the type of component (C-component or S-component) defined on the
module. UNI ports are C-components and NNI ports are S-components. If all the ports are UNI or NNI
the component ID for all ports is “1”. When there are mixed UNI and NNI ports, the component ID for
all NNI ports is “1”. The UNI port’s component ID will start at “2” for the lowest UNI port number
and increment for each additional port (i.e., NNI Port 1 - component ID 1, UNI Port 2 - component ID
2, UNI Port 3 - component ID 3, etc).
The -d switch deletes a defined MA using the configured name (-o) or index number (-oi).
The -e switch associates a specific EVC to a MA.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -i switch defines the time interval at which CCM messages are transmitted.
The -id switch defines the Sender ID TLV type transmitted in CCM, LBM, LTM and LTR messages. The
default value is: sendIdNone (Sender ID TLV is not transmitted).
The -l switch defines the MD level.
The -m switch modifies a defined MA.
The -mhf switch indicates whether the management entity can create MHFs (MIP Half Function) on this
Maintenance Association.
The -n switch defines the name for the MD.
The -ni switch is the index number displayed in the MA table as a short attribute command for deleting or
modifying a MD.
The -nm switch defines the format for the MA name.
The -noccmseq switch turns off incrementing the CCM sequence count and keeps it at zero.
The -noporttlv switch turns off the Port Status TLV field in the CCM PDU.
The -nostatustlv switch turns off Interface Status TLV field on the CCM PDU.
The -o switch defines the name for the MA.
The -oi switch is the index number displayed in the MA table as a short attribute command for deleting or
modifying a MA.
The -p switch associates a specific port to the MA.
The -s switch displays the configuration of the defined MAs on the module.
The -to switch defines the timeout value for CCM messages. This indicates the time period before a CCM
message is counted as lost.
The -v switch associates a specific VID to a MA.
The -ver switch displays the extended help or show status screens.
The example below creates a Maintenance Association “MA01” for the Maintenance Domain “Domain1”,
assigned to Port 1 with a VLAN ID 1000.

> ma -a -n Domain1 -o MA01 -v 1000 -p 1

Page 124
The example below creates a Maintenance Association “MA04” for the Maintenance Domain “Domain5”,
assigned to Port 3 with a VLAN ID 300.

> ma -a -n Domain5 -o MA04 -v 300 -p 3

To display created Maintenance Associations, use the ma -s command.

> ma -s

MA MD Comp Pri MD CCM Time MHF Id Name Domain Name/


Idx Idx ID VLAN Level INTVL Out(ms) Create Perm Type MA Name/Evc Name
=========================================================================================
1 1 1 1000 7 1sec 3500 Defr Defr 2 Domain1/MA01/ServiceProvider
2 3 3 300 5 1sec 3500 Defr Defr 2 Domain5/MA04/ServiceProvider

>

The example below modifies the name of Maintenance Association “MA04” to “MA05”. The command
ni relates to the MD Index and command oi relates to the MA Index number displayed in the Maintenance
Association list (ma -s).

> ma -m -ni 3 -oi 2 -o MA05

To display created Maintenance Associations, use the ma -s command.

> ma -s

MA MD Comp Pri MD CCM Time MHF Id Name Domain Name/


Idx Idx ID VLAN Level INTVL Out(ms) Create Perm Type MA Name/Evc Name
=========================================================================================
1 1 1 1000 7 1sec 3500 Defr Defr 2 Domain1/MA01/ServiceProvider
2 3 3 300 5 1sec 3500 Defr Defr 2 Domain5/MA05/ServiceProvider

>

To delete a Maintenance Association, use the ma -d command.

> ma -d -ni 3 -oi 2

To display created Maintenance Associations, use the ma -s command.

> ma -s

MA MD Comp Pri MD CCM Time MHF Id Name Domain Name/


Idx Idx ID VLAN Level INTVL Out(ms) Create Perm Type MA Name/Evc Name
=========================================================================================
1 1 1 1000 7 1sec 3500 Defr Defr 2 Domain1/MA01/ServiceProvider

>

Page 125
5.1.35 MAC Table (MACTABLE)
The mactable command provides the ability to clear and display the MAC addresses learned by the module.
To display the MAC addresses, use the mactable command from the CLI prompt. A list of options is
displayed when the mactable -h command is entered.

> mactable -h

Description: Show MAC table


Format: mactable [-h [-ver]|-s] [-p portNum] [-e evcName] [-v evcVid] [-clr]
[-aging ageTime]
Switches:
-aging set mac [ageTime] in sec: {10...630} default 300
-clr clears (flushes) the learned MAC addresses
-e [evcName] associated with the EVC S-TAG value
-h display help information
-p [portNum] selected: {1,2,3,4,5,6,7,8,all}
-s shows current protocol settings
-v [evcVid] associated with provider tag: {0...4095}
-ver verbose help or show

>

The options available using the mactable command are shown below.
The -aging switch defines the time before a MAC address expires. The default value is 300 seconds.
The -clr switch clears the learned MAC addresses.
The -e switch associates the MAC table function with a provider EVC (S-Tag).
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -p switch selects the port number.
The -s switch displays the MAC table.
The -v switch associates MAC table function with a customer EVC (C-Tag).
The -ver switch displays the extended help or show status screens.
To display the learned MAC addresses on the module, use the mactable -s -ver command.

> mactable -s -ver

MAC aging = 300s

Retrieving MAC Table information - please wait


3 out of 32768 entries allocated

[0001] MAC address = 00-06-87-02-14-a0 ingress port = 2; vid = 3172


[0002] MAC address = 00-06-87-02-14-a5 ingress port = 2; vid = 3172
[0003] MAC address = 00-08-54-b3-70-48 ingress port = 5; vid = 3172

MAC Table list complete

>

Page 126
5.1.36 Maintenance Domain (MD)
A Maintenance Domain is an administrative domain for the purpose of managing and administering
a network. A domain is assigned a unique maintenance level (0 - 7) by the administrator, defining the
hierarchical relationship of domains. Maintenance domains may nest or touch, but cannot overlap. If two
domains nest, the outer domain must have a higher maintenance level than the inner domain. The figure
below illustrates nested domains, where the Operator and Service Domains are nested under the Customer
Domain. The Customer Domain will have the highest maintenance level.

To configure the Maintenance Domain, a MD name and level must be defined. Names should be descriptive
and unique. Maintenance Domain names can be between 1 and 43 characters (a combination of letters and
numbers with no spaces). When more then one Maintenance Domain is created, the outer domain must
have the higher maintenance level.
Metro Ethernet Forum specifications 17 and 30 define the suggested type and level for each domain.
Domain Suggested Usage
Subscriber Subscriber monitoring of an Ethernet Service
Test Service Provider isolation of subscriber reported problem
EVC Service Provider monitoring of provided service
Service Provider Service Provider Monitoring of Service Provider network
Operator Operator monitoring of the portion of a network
UNI Service Provider monitoring of a UNI
ENNI Network Operators’ monitoring of an ENNI

Domain Default Level


Subscriber 6
Test 5
EVC 4
Service Provider 3
Operator 2
UNI 1
ENNI 1

Page 127
To create a Maintenance Domain, use the md option from the CLI prompt. A list of options is displayed
when the md -h command is entered.

> md -h

Description: CFM maintenance domain configuration


Format: md [-a|-d|-dall|-h [-ver]|-m|-s] [-n domainName | -ni dindex]
[-l domainLevel] [-id idSelect] [-mhf mhfSelect][-nd mdNameType]
Switches:
-a add maintenance domain
-d delete maintenance domain
-dall deletes all maintenance domains and restore mde defaults
-h display help information
-id sender ID TLV info,[idSelect]: {1 (SendIdNone), 2 (SendIdChassis),
3 (SendIdManage), 4 (SendIdChassisManage)}, default 1
-l maintenance [domainLevel]: {0...7}
-m modify configuration of an existing domain
-mhf MHF creation, [mhfSelect]: {1 (defMHFnone), 2 (defMHFdefault),
3 (defMHFexplicit), default is 1
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-nd select [mdNameType] for domain name, default is 4:
{1 (none), 2 (dnsLikeName), 3 (macAddrAndUint), 4 (charString)}
Where macAddrAndUint format: [xx-xx-xx-xx-xx-xx,ggg] where the MAC
Address is xx-xx-xx-xx-xx-xx and ggg is a two octet decimal integer
-s show existing maintenance domains
-ver verbose help

>

The options available using the md command are shown below.


The -a switch defines a Maintenance Domain (MD).
The -d switch deletes a defined MD using the configured name (-n) or index number (-ni).
The -dall switch deletes all configured maintenance domains.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -id switch defines the Sender ID TLV type transmitted in CCMs, LBMs, LTMs and LTRs messages.
The default value is: sendIdNone (Sender ID TLV is not transmitted).
The -l switch defines the maintenance level associated with the domain.
The -m switch modifies a defined MD.
The -mhf switch indicates whether the management entity can create MHFs (MIP Half Function) on this
Maintenance Domain.
The -n switch defines the name for the MD.
The -ni switch is the defined index number displayed in the MD table as a short attribute command for
deleting or modifying a MD.
The -nd switch defines the format for the MD name.
The -s switch displays the configuration of the defined MDs on the module.
The -ver switch displays the extended help screen.

Page 128
The example below creates a Maintenance Domain called “Domain1” with a maintenance level of 7.

> md -a -n Domain1 -l 7

The example below creates a Maintenance Domain called “Domain2” with a maintenance level of 5.

> md -a -n Domain2 -l 5

To display created Maintenance Domains, use the md -s command.

> md -s

Domain Domain Service Name MHF Id Domain


Index Level (MA Idx) Type Create Perm Name
==============================================================
1 7 0 4 None None Domain1
2 5 0 4 None None Domain2

>

The example below modifies the name of Maintenance Domain “Domain2” to “Domain5”. The command
ni relates to the Domain Index number displayed in the Maintenance Domain list (md -s).

> md -m -ni 2 -n Domain5

To display created Maintenance Domains, use the md -s command.

> md -s

Domain Domain Service Name MHF Id Domain


Index Level (MA Idx) Type Create Perm Name
==============================================================
1 7 0 4 None None Domain1
2 5 0 4 None None Domain5

>

To delete a Maintenance Domain, use the md -d command.

> md -d -ni 2

To display created Maintenance Domains, use the md -s command.

> md -s

Domain Domain Service Name MHF Id Domain


Index Level (MA Idx) Type Create Perm Name
==============================================================
1 7 0 4 None None Domain1

>

Page 129
5.1.37 Default Maintenance Domain (MDE)
The mde command provides the ability to configure and display MIP Half Function (MHF) on a Maintenance
Domain and EVC. Default Maintenance Domain provides the ability to create MIPs on MAs or EVCs on
ports that are not configured.
To configure the MIP Half Function (MHF) on a single Maintenance Domain and EVC, use the mde
command from the CLI prompt. A list of options is displayed when the mde -h command is entered.

> mde -h

Description: CFM Default Maintenance Domain configuration


Format: mde [-a|-h [-ver]|-s] [-p portNum|-c compID] [-v primaryVid|-e evcName]
[-l domainLevel] [-mhf mhfSelect] [-id idSelect]
Switches:
-a modify existing default setup
-c component id, [compID]
1 = s-component (NNI port)
2 = c-component (first UNI port)
3-n = c-component when provider edge bridge (2nd-nth UNI port if
NNI port exists)
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-h display help information
-id sender ID TLV info,[idSelect]: {1 (SendIdNone), 2 (SendIdChassis),
3 (SendIdManage), 4 (SendIdChassisManage), 5 (SendIdDefer)}, default 5
-l maintenance [domainLevel]: {0...7}, default 0
-mhf MHF creation, [mhfSelect]: {1 (defMHFnone), 2 (defMHFdefault),
3 (defMHFexplicit), 4 (defMHFdefer)}, default 4
-p [portNum] selected: {1...17}
-s show the current default MD settings
-v [primaryVid] associated with the MA: {0...4095}
-ver verbose help

>

The options available using the mde command are shown below.
The -a switch modifies an existing default setup.
The -c switch defines the component ID.
The component ID relates to the type of component (C-component or S-component) defined on the
module. UNI ports are C-components and NNI ports are S-components. If all the ports are UNI or NNI
the component ID for all ports is “1”. When there are mixed UNI and NNI ports, the component ID for
all NNI ports is “1”. The UNI port’s component ID will start at “2” for the lowest UNI port number
and increment for each additional port (i.e., NNI Port 1 - component ID 1, UNI Port 2 - component ID
2, UNI Port 3 - component ID 3, etc).
The -e switch associates a specific EVC.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -id switch determines the Sender ID TLV type transmitted in CCM, LBM, LTM and LTR messages.
The default value is: sendIdNone (Sender ID TLV is not transmitted).
The -l switch defines the MD level.
The -mhf switch indicates whether the management entity can create MHFs (MIP Half Function).
The -p switch associates a specific port.
The -s switch displays the current VLAN ID table.

Page 130
The -v switch associates a specific VID to a MA.
The -ver switch displays the extended help screen.
MIP Half Function (MHF) is a CFM entity, associated with a single Maintenance Domain, and a single
MD Level and a set of VIDs, that can generate CFM PDUs in response to received CFM PDUs.
To display the default maintenance domain, use the mde -s command from the CLI prompt.

> mde -s

Default domain level = -1


Default MHF creation = defMHFnone(1)
Default Sender ID TLV info = SendIdNone(1)

VLAN MD MHF Sender ID


ID Cid Status Level Ability TLV Info Evc
===============================================================================
0 1 Active -1 Defr(4) Defr(5) mgt
1 1 Active -1 Defr(4) Defr(5) default

>

Page 131
5.1.38 Maintenance Points
Maintenance points can be configured on any port on the network. Depending on the location of the port,
the maintenance point will be classified as a Maintenance End Point (MEP) or Maintenance Intermediate
Point (MIP).
5.1.38.1 Maintenance End Point (MEP)
Maintenance End Points are located at the edge of the Maintenance Domain and generate and terminate
CFM packets. Maintenance End Points are associated with a specific Maintenance Domain, Maintenance
Association, VLAN ID (EVC) and port number. Identifiers should be descriptive and unique. Maintenance
End Point identifiers can be between 1 and 45 characters (combination of letters and numbers with no spaces).
To create a Maintenance End Point, use the mep option from the CLI prompt. A list of options is displayed
when the mep -h command is entered.

> mep -h

Description: CFM maintenance end point configuration


Format: mep [-a|-c|-d|-h|-s|[-ena|-dis {ccm | mepactive}]]
[-n domainName|-l domainLevel|-ni dindex] [-o maName|-oi mindex]
[-m mepid] [-p portNum] [-v primaryVid|-e evcName] [-up|-dn] [-scomp]
[-pri pbits] [-pr pval] [-alarmon time] [-alarmoff time] [-ver]
[-ctagvid cvid]
Switches:
-a add maintenance end point
-alarmoff [time] defect absent before resetting alarm: {250...1000} in 0.01s
-alarmon [time] defect present before fault alarm: {250...1000} in 0.01s
-c change (modify) config of an existing maintenance association end point
-ctagvid C-TAG VID associated with the PDUs for the MEP that
originates on an NNI port
-d delete maintenance end point
-dis disable MEP option: {ccm|mepactive}
[ccm] disable ccm function
[mepactive] disable mep function
-dn mep down direction (towards the LAN entity)
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-ena enable MEP option: {ccm|mepactive}; default is enabled for both
[ccm] enable ccm function
[mepactive] enable mep function
-h display help information
-l maintenance [domainLevel]: {0...7}
-m mep ID, [mepid], unique within a MA: {1...8191}
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p [portNum] selected: {1...17}
-pr lowest priority to trigger Fault Alarm [pval]: {1...6}, default 2
-pri vlan priority bits, [pbits], for PDU sent if tagged; default value is 0
-s show existing maintenance end points
-scomp places a mep on a UNI port to be a part of the S-component
-up mep up direction (facing towards the relay entity)(default)
-v [primaryVid] associated with the MA: {0...4095}
-ver verbose help or show

>

The options available using the mep command are shown below.
The -a switch adds a MEP to a defined MD/MA.

Page 132
The -alarmoff switch defines the amount of time in 1/100 of a second that fault alarm is removed after
correction of the defect.
The -alarmon switch defines the amount of time in 1/100 of a second that a defect must be present before
it is generates a fault alarm.
The -c switch modifies a defined MEP.
The -ctagvid switch associates a C-Tag VID to the OAM PDUs on a NNI port or a scomp UNI.
The -d switch deletes a defined MEP on a MD/MA.
The -dis and -ena switches disable or enable specific functions of a MEP: CCM and MEP active.
The -dn switch defines the MEP as a down MEP.
The -e switch associates a specific EVC to a MEP.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -l, -n, and -ni switches indicate a specific level, domain name and index for the MEP.
The -m switch defines MEP ID for the selected MD/MA.
The -o and -oi switches indicate a specific maintenance association of the MEP.
The -p switch associates a specific port to a MEP.
The -pr switch defines the lowest defect that will trigger a fault alarm. The following fault alarms are set
as the default value: DefMACstatus, DefRemoteCCM, DefErrorCCM and DefXconCCM.
-pr value Defects Reported
All defects
1
DefRDICCM, DefMACstatus, DefRemoteCCM, DefErrorCCM, andDefXconCCM
2 (default) DefMACstatus, DefRemoteCCM, DefErrorCCM, and DefXconCCM
3 DefRemoteCCM, DefErrorCCM, and DefXconCCM
4 DefErrorCCM, and DefXconCCM
5 DefXconCCM
6 None

DefRDICCM
A remote MEP is reported the RDI bit in its last CCM.
DefMACstatus
A remote MEP is reporting its Port Status as not up (linkup).
DefRemoteCCM
The MEP is not receiving valid CCMs from at least one of the remote MEPs.
DefErrorCCM
The MEP has received at least one invalid CCM whose CCM Interval has not yet timed out.
DefXconCCM
The MEP has received at least one CCM from either another Maintenance Association Identifier (MAID)
or a lower MD Level whose CCM Interval has not yet timed out.
The mep -s -ver command will display the fault alarm value.
The -pri switch indicates the specific VLAN priority bits for the MEP.
The -s switch displays the configured MEPs and the running status.
The -scomp switch associates a MEP on a UNI port to a S-TAG.
The -up switch defines a MEP as a up MEP.

Page 133
The -v switch associates a specific VLAN ID with a MEP.
The -ver switch displays the extended help or show status screens.
The example below creates Maintenance End Point 100 associated with Maintenance Association “MA01”
and Maintenance Domain “Domain1”.

> mep -a -n Domain1 -o MA01 -m 100 -v 1000 -p 1

To display created Maintenance End Points, use the mep -s command.

> mep -s

MEP MD P Prim CCM MEP MAC Domain Name/


ID Lvl # VLAN Status Status Int Dir Address MA Name/Evc Name
==========================================================================================
100 7 1 1000 enabled active 1sec Up 00-06-87-00-cf-f1 Domain1/MA01ServiceProvider

>

The example below creates Maintenance End Point 500 associated with Maintenance Association “MA05”
and Maintenance Domain “Domain5”.

> mep -a -n Domain5 -o MA05 -m 500 -v 300 -p 3

To display created Maintenance End Points, use the mep -s command.

> mep -s

MEP MD P Prim CCM MEP MAC Domain Name/


ID Lvl # VLAN Status Status Int Dir Address MA Name/Evc Name
==========================================================================================
100 7 1 1000 enabled active 1sec Up 00-06-87-00-cf-f1 Domain1/MA01ServiceProvider
500 5 3 300 enabled active 1sec Up 00-06-87-00-cf-f2 Domain5/MA05ServiceProvider

>

To obtain more information on configured Maintenance End Points and default values, use the mep -s -ver
command.

> mep -s -ver

MEP MD P Prim CCM MEP MAC Domain Name/


ID Lvl # VLAN Status Status Int Dir Address MA Name/Evc Name
==========================================================================================
100 7 1 1000 enabled active 1sec Up 00-06-87-00-cf-f1 Domain1/MA01ServiceProvider
pri=0, alarmon=250, alarmoff=1000, pr=Def_MAC_REM_ERR_XCON(2)
defect state=Reset Highest Pri Defect=None Defects=None
CCM Tx=0 CCM Sequence Err=0; no RDI Tx; Probe responder=Hopping Priority
>

To delete a Maintenance End Point, use the mep -d command.

> mep -d -n Domain5 -o MA05 -m 500

Page 134
5.1.38.2 Maintenance Intermediate Point (MIP)
Maintenance Intermediate Points are internal to the Maintenance Domain. Maintenance Intermediate
Points will forward CFM packets.
To create a Maintenance Intermediate Point for a Maintenance Domain, use the mip option from the CLI
prompt. A list of options is displayed when the mip -h command is entered.

> mip -h

Description: CFM maintenance intermediate point configuration


Format: mip [-a|-d|-h [-ver]|-s] [-n domainName|-l domainLevel|-ni dindex]
[-o maName | -oi mindex] [-p portNum] [-scomp]
Switches:
-a add explicit maintenance intermediate point
-d delete explicit maintenance intermediate point
-h display help information
-l maintenance [domainLevel]: {0...7}
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p [portNum] selected: {1...17}
-s show existing maintenance intermediate points
-scomp places a mip on a UNI port to be a part of the S-component
-ver verbose help

>

The options available using the mip command are shown below.
The -a switch adds a MIP to a defined MD/MA.
The -d switch deletes a defined MIP on a MD/MA.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -l, -n, and -ni switches indicate a specific level, domain name and index for the MIP.
The -o and -oi switches indicate a specific maintenance association of the MIP.
The -p switch associates a specific port to a MIP.
The -s switch displays the configured MIPs.
The -scomp switch associates a MIP on a UNI port to a S-TAG.
The -ver switch displays the extended help screen.

Page 135
There are several ways to create a MIP. The following are the valid combinations of the MIP Half Function
(MHF) Creation status summary:
Dflt(I)
Implicit creation of a MIP on an existing MA when MA’s MHF Creation = defMHFdefault
or MA MHF Creation = defMHFdefer and MD MHF Create = defMHFdefault.
Expl(I)
Implicit creation of a MIP on an existing MA when MA MHF Creation = defMHFexplicit
or MA MHF Creation = defMHFdefer and MD MHF Creation = defMHFexplicit.
Dflt(D)
Implicit creation of a MIP via default MD table when default MD table MHF Creation = defMHFdefault.
Expl(D)
Implicit creation of a MIP via default MD table when default MD table MHF Creation = defMHFexplicit.
Dflt(E)
Explicit creation of a MIP on an MA by user.
Dflt(IE)
Implicit creation of a MIP on an existing MA when MA MHF Creation = defMHFdefault and explicit
creation of a MIP on an MA by user.
Expl(IE)
Implicit creation of a MIP on an existing MA when MA MHF Creation = defMHFexplicit and explicit
creation of a MIP on an MA by user.
MIP Half Function (MHF) is a CFM entity, associated with a single Maintenance Domain, and a single
MD Level and a set of VIDs, that can generate CFM PDUs in response to received CFM PDUs.
The example below creates a Maintenance Intermediate Point associated with Maintenance Association
“MA01” and Maintenance Domain “Domain1”.

> mip -a -p 1 -n Domain1 -l 7 -o MA01

To display created Maintenance Intermediate Points, use the mip -s command.

> mip –s

MD MA MIP MD Prim MHF Domain Name/


Idx Idx Idx Lvl Port Vlan Create MA Name/Evc Name
=========================================================================
1 2 7 1 1000 Dflt(E) Domain1/MA01/ServiceProvider

>

Page 136
5.1.39 Module Settings (MODULE)
The module command provides the ability to configure and display specific module settings. The serial
interface baud rate, chassis number and name, module identifier and system location can be configured
using the module command.
To configure the module setting, use the module command from the CLI prompt. A list of options is
displayed when the module -h command is entered.

> module -h

Description: Displays module global information


Format: module [-dall|-h [-ver]] [-s showType] [-con sysContact] [-loc sysLoc]
[-bau baudRate] [-id modId] [-nm chassisName] [-cn chassiNumber]
[-prompt pname] [{-dis|-ena} flow]
Switches:
-bau sets serial port baudrate [baudRate]: where 2=1200bps,
3=2400bps, 4=4800bps, 5=9600bps, 6=19200bps, 7=38400bps, 8=57600bps,
9=115200bps), default 9
-cn set chassis number: {1...19}, default 1
-con sets system contact [sysContact], 1-64 ASCII characters
-dall restore factory defaults
-dis disable function: {flow}, default
-ena enable function: {flow}
[flow] flow control (pause) enable/disable
-h display help information
-id sets module identification, 1-64 ASCII characters
-loc set system location [sysLoc], 1-64 ASCII characters
-nm sets chassis name,[chassisName], 1-64 ASCII characters
-prompt sets the prompt string, [pname], on the command line
-s shows the module global information [showType]: {led|env|mfg|mod|}
-ver verbose help

>

The options available using the module command are shown below.
The -bau switch configures the baud rate of the serial interface. The default rate is 115,200bps.
The -cn switch configures the chassis number. The default chassis number is 1.
The -con switch configures the system contact. The system contact name can be any 1-64 alphanumeric
character string.
The -dall switch restores the factory defaults of all module setting.
The -dis and -ena switches disable or enable flow control on the module.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -id switch configures the module identifier. The module identifier can be any 1-64 alphanumeric
character string.
The -loc switch configures the system location. The system location name can be any 1-64 alphanumeric
character string.
The -nm switch configures the chassis name. The chassis name can be any 1-64 alphanumeric character
string.
The -prompt switch configures the name associated with the module prompt.
The -s switch displays the module global configuration. Specific parameter can be displayed using the
led, env, mfg or mod command.

Page 137
led displays the status of the LEDs on the module.
env displays the voltage and temperature parameters.
mfg displays the manufacturing information.
mod displays the module specific information.
The -ver switch displays the extended help screen.
To display the module specific information, use the module -s mod command.

> module -s mod

Module Type: XM5 12xSFP/2xUTP/2xSFP+


Module Identification:
SysContact: Omnitron (949) 250-6510
SystemLoc: Irvine, CA USA
Chassis Name: XM5
Chassis Number: 1
Slot Number: 1
Baud rate: 115200 baud
Flow control: Disabled

>

To display the manufacturing information, use the module -s mfg command.

> module -s mfg

Model Number = 9620-C2-B1


Serial Number = 00710881
Manufacturing Date = 20141114
Product Revision = 10
Hardware Revision = 10
Software Revision = vx.x.x

>

To configure the system contact and location, use the following commands.

> module -con JSmith -loc Dallas


> module -s mod

Module Type: XM5 12xSFP/2xUTP/2xSFP+


Module Identification:
SysContact: JSmith
SystemLoc: Dallas
Chassis Name: XM5
Chassis Number: 1
Slot Number: 1
Baud rate: 115200 baud
Flow control: Disabled

>

NOTE: When configuring text based names, such as J Smith, the text name much be in “ “ for the
command to be valid (module -con “J Smith”). If the text based name does not have any spaces
between the words, then “ “ are not necessary (module -con JSmith).

Page 138
5.1.40 Ping (PING)
The ping command provides the ability to ping network devices connected to the module. This provides
a convenient way to verify connectivity through the CLI interface.
To configure ping, use the ping command from the CLI prompt. A list of options is displayed when the
ping -h command is entered.

> ping -h

Description: Generates a ping to a remote device


Format: ping [-t ipaddress] [-h [-ver]] [-n count] [-l size]
Switches:
-h display help information
-l send buffer [size], default is 32 bytes, maximum is 1472 bytes
-n number of ping requests [count] to send: {0..65536}, default is 3
-t ping the specified [ipaddress]
-ver verbose help

>

The options available using the ping command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -l switch defines the size of the ping frame.
The -n switch defines the number of pings frames sent. A value of 0 sends pings until interrupted.
The -t switch defines the destination IP address.
The -ver switch displays the extended help screen.
To ping an IP address, use the ping -t command.

> ping -t 192.168.1.110 -l 256 -n 5

Pinging 192.168.1.110 with 256 bytes of data:

Reply from 192.168.1.110: bytes=256 time=1ms


Reply from 192.168.1.110: bytes=256 time=1ms
Reply from 192.168.1.110: bytes=256 time=1ms
Reply from 192.168.1.110: bytes=256 time=1ms
Reply from 192.168.1.110: bytes=256 time=1ms

Ping statistics for 192.168.1.110:


Packets: Sent = 5, Received = 5, Lost = 0 (0 % loss),
Approximate round trip times in milli-seconds:
Minimum = 1ms, Maximum = 1ms, Average = 1

>

The command pings IP address 192.168.1.110 (-t) five times (-n), using a frame size of 256 bytes (-l).

Page 139
5.1.41 Port Attributes (PORT)
The port command provides the ability to configure each port with specific parameters.
To configure the attributes of a port, use the port command from the CLI prompt. A list of options is
displayed when the port -h command is entered.

> port -h

Description: Changes port attribute configuration


Format: port [-dall|-h|-s] [-p port] [-n portName] [-mo pmode]
[-sfp sfpmode] [-mtu fsize] [-looptimeout time] [-ver] [-tv tvval]
[{-dis|-ena} {als|color|flow|learning|loop|mirror,sp|mgtport|port}]
[-msrc portlist]
Switches:
-dall delete configured port attribute settings and restore defaults
-dis disable function: {als|color|flow|learning|loop|mirror|mgtport|port}
-ena enable function: {als|color|flow|learning|loop|mirror,sp|mgtport|port}
[als] auto link shutdown for the selected port, default disable
[color] color awareness for selected port, default disable
[flow] flow control for selected port, default enable
[learning] MAC learning for the selected port, default enable
[loop] local loopback for the selected port, default disable
[mgtport] dedicated management port selection, default enable port 17
[mirror] mirror source port, sp, to the selected port, default disable
[port] port output, default enable
-h display help information
-looptimeout loopback timeout [time]: {0...3600}, default 30 seconds
where 0 disables timeout
-mo port mode [pmode]: { [{1000|100|10},]{an|man}[,{fdx|hdx}] }
-msrc management traffic source port [portlist]: {1...17|all}, default all
-mtu ingress frame size [fsize]: {64...10056}, default 10056 bytes
-n defines the [portName] identifier, 1-45 ASCII characters
-p [portNum] selected: {1..17,mgt1|all}
-s shows the port attribute configuration
-sfp force SFP into the selected [sfpmode]: {auto|force100|force1000|sgmii}
[auto] examines diagnostic SFP ROM for speed & mode
[force100] force 100Mbps SERDES mode
[force1000] force 1000Mbps SERDES mode
[sgmii] force SGMII mode
-tv defines utilization threshold violation percentage value [tvval]:
{0.000...100.000}, default 100.000
-ver verbose help or show

>

The options available using the port command are shown below.
The -dall switch deletes all port configurations and restores factory default settings.
The -dis and -ena switches disable or enable the configuration of specific attributes on each port. These
include auto link shutdown, color awareness, flow control, laser output, MAC learning, local loopback,
dedicated management port, port mirroring and porrt output.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -looptimeout switch configures the amount of time the port will stay in loopback when loopback is
enabled on a port. Setting the looptimeout to 0, disables the timer. The module will stay in loopback until
it is manually disabled (-dis loop).
The -mo switch defines configuration of the negotiation, speed and duplex for the RJ-45 copper port.

Page 140
The -msrc switch defines the port that allows management traffic. The default is all ports.
The -mtu switch provides configuration of the maximum frame size allowed on the selected port.
The -n switch defines the name for the selected port.
The -p switch defines the port on the module to be used when configuring the attributes.
The -s switch displays the attributes associated with each port on the module.
The -sfp switch configures the operation of the installed SFP transceiver.
The -tv switch configures the port utilization threshold violation value. When the value is violated, an
SNMP trap is generated.
The -ver switch displays the extended help or show status screens.
The mo command provides configuration of the fixed RJ-45 port (speed, negotiation and duplex). The mo
command also provides configuration for the fiber ports (negotiation only).
The configuration of the RJ-45 and fiber ports can be changed using the mo command or through SNMP.
The RJ-45 port will operate per the Port Configuration Matrix below.
Port Attribute
Port Configuration RJ-45 Mode of Operation
mo setting
The RJ-45 port is set to auto-negotiation with the following modes advertised:
1000, AN, FDX Based on the link partner
1000FDX, 1000HDX, 100FDX, 100HDX, 10FDX, 10HDX
The RJ-45 port is set to auto-negotiation with the following modes advertised:
1000, AN, HDX Based on the link partner
1000HDX, 100FDX, 100HDX, 10FDX, 10HDX
The RJ-45 port is set to auto-negotiation with the following modes advertised:
100, AN, FDX Based on the link partner
100FDX, 100HDX, 10FDX, 10HDX
The RJ-45 port is set to auto-negotiation with the following modes advertised:
100, AN, HDX Based on the link partner
100HDX, 10FDX, 10HDX
The RJ-45 port is set to auto-negotiation with the following modes advertised:
10, AN, FDX Based on the link partner
10FDX, 10HDX
10, AN, HDX Based on the link partner The RJ-45 port is set to auto-negotiation and advertises: 10HDX
The RJ-45 port is set to auto-negotiation with the following modes advertised:
1000, Man, FDX Based on the link partner
1000FDX (When set to 1000, the port is always in AN mode)
The RJ-45 port is set to auto-negotiation with the following modes advertised:
1000, Man, HDX Based on the link partner
1000HDX (When set to 1000, the port is always in AN mode)*
100, Man, FDX Man, 100, FDX The RJ-45 port is set to manual negotiation and is forced to: 100FDX
100, Man, HDX Man, 100, HDX The RJ-45 port is set to manual negotiation and is forced to: 100HDX
10, Man, FDX Man,10, FDX The RJ-45 port is set to manual negotiation and is forced to: 10FDX
10, Man, HDX Man, 10, HDX The RJ-45 port is set to manual negotiation and is forced to: 10HDX

RJ-45 Port Configuration Matrix


*NOTE: The module only supports auto-negotiation when configured for 1000. So when the 1000,
Man, FDX or 1000, Man, HDX is used, the module still auto-negotiates with its link partner per the
table above.
When configuring a copper SFP transceiver for 1000M operation, use the -mo 1000, an command.
The copper transceiver will not accept a -mo 1000, man command. However, a fixed RJ-45 model
will accept the -mo 1000, man command.

Page 141
The SFP ports will operate per the Port Configuration Matrix below.
Port Attribute
Port Configuration Mode of Operation
mo setting
AN AN, 1000, FDX 1000M Fiber port set to AN with the followings mode advertised 1000FDX
Man Man, 1000, FDX 1000M Fiber port set to MAN and is forced to 1000FDX
Man Man, 100, FDX 100M Fiber port set to MAN and is forced to 100FDX

Fiber Port Configuration Matrix


The sfp command provides configuration of the fiber and copper SFP transceivers. The default configuration
is auto. The module will read the part number of the installed transceiver and if recognized will configure
the transceiver for speed and mode. An unrecognized transceiver will be configured for 1000BASE-X
SERDES.
The sfp command provides the ability to force a SFP transceiver to a specific speed and mode.
The mtu command configures the maximum size frames allowed on the port. The default size is 10,240
bytes on each port. The management port is set to 1,500 bytes and can not be changed.
To display the port attributes, use the port -s command.
> port -s

Port 1 is named “Port 1” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-41]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 2 is named “Port 2” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-42]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 3 is named “Port 3” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-43]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind

Page 142
Port 4 is named “Port 4” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-44]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 5 is named “Port 5” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-45]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 6 is named “Port 6” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-46]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 7 is named “Port 7” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-47]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 8 is named “Port 8” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-48]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 9 is named “Port 9” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-49]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind

Page 143
Port 10 is named “Port 10” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-4a]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 11 is named “Port 11” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-4b]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 12 is named “Port 12” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-4c]
Port mode is SFP AUTO: Fiber 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 13 is named “Port 13” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-4d]
Port mode is UTP: 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 14 is named “Port 14” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-4e]
Port mode is UTP: 1000, AN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 15 is named “Port 15” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-4f]
Port mode is XFP: Fiber 10000, MAN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind

Page 144
Port 16 is named “Port 16” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-50]
Port mode is XFP: Fiber 10000, MAN, FDX (No link)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Threshold violation: Not configured (100.000%)
Port is color blind
Port 17 is named “Port 17” is type UNI, MTU 10056 bytes [MAC 00-06-87-02-14-51]
Port mode is UTP: 1000, AN, FDX (Linked: 1000,FDX)
Port flow control is enabled: inactive
Port output is enabled
Port loopback is disabled, port loopback timeout is 30 seconds
MAC learning is enabled, aging set to 300s
ALS is disabled
Port Mirroring is disabled
Port is a dedicated management port
Threshold violation: Not configured (100.000%)
Port is color blind

Management port 1 is named “Mgt1” is type UNI, MTU 1570 bytes [MAC 00-06-87-02-14-40]
Management traffic source port(s): 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17

>

To set Port 1 into local loopback, use the -ena loop command.

> port -p 1 -ena loop

The example below forces Port 4 fiber SFP transceiver to 1000M.

> port -p 4 -sfp force1000

The example below configures the MTU size of Port 5 to 2,048 bytes.

> port -p 5 -mtu 2048

The example below disables MAC learning on all ports.

> port -p all -dis learning

The example below enables port mirroring of Port 6 to Port 7.

> port -p 7 -ena mirror,6

Page 145
5.1.42 Port Statistics (PORTSTAT)
The portstat command provides the ability to display the port statistics on the module.
To display the port statistics, use the portstat command from the CLI prompt. A list of options is displayed
when the portstat -h command is entered.

> portstat -h

Description: Displays and clears the port statistic counters


Format: portstat [-h|-s] [-ver] [-p portNum] [-clr]
Switches:
-clr clear current port statistics
-h display help information
-p [portNum] selected: {1...17}
-s shows the port statistics
-ver verbose extended show or help

>

The options available using the portstat command are shown below.
The -clr switch clears the current port statistics.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -p switch selects which port statistic will be displayed.
The -s switch displays the selected port statistics.
The -ver switch displays the extended help or show status screens.
To display the port statistics for Port 15, use the portstat -s -p 15 command.

> portstat -s -p 15

Transmission Counters Receive Counters Receive Packets by Size


Packets 30483 64 Octets 15061
Total Octets 2413657 Total Octets 2378450 65-127 15165
Good Pkts 30736 Good Pkts 30483 128-255 257
Pause Pkts 0 Pause Pkts 0 256-511 0
Unicast Pkts 15164 Unicast Pkts 15165 512-1023 0
Multicast Pkts 15487 Multicast Pkts 15318 1024-1518 0
Broadcast Pkts 85 Broadcast Pkts 0 1519-10056 0
Errored Pkts 0 Errored Pkts 0
Dropped Pkts 0 Dropped Pkts 0
Bad Events 0 FCS Errors 0
Deferred 0 Symbol Errors 0
Collisions: CRC/Alignment 0
Total 0 Undersized 0
Single 0 Oversized 0
Multiple 0 Fragments 0
Late 0 Jabber 0
Excessive 0 Alignment 0

Tx Throughput 0.000 Mbps Rx Throughput 0.000 Mbps


Tx Utilization 0.000% Rx Utilization 0.000%

>

Page 146
5.1.43 ITU-T Y.1731 Performance Monitoring
ITU-T Y.1731 Performance Monitoring tools provide statistics for delay, variation, loss and availability
between MEPs. There are five types of measurements that can be created between MEPs. Y.1731 uses
OAM PDUs to send/receive messages to measure the different performance parameters. When created,
the OAM PDUs run continuously until disabled. Each performance measurement uses different OAM
PDUs messages.
Y.1731 utilizes the same configuration parameters used by 802.1ag Connectivity Fault Management, defining
Maintenance Domains, Maintenance Associations and Maintenance Points.
5.1.43.1 Probe (PROBE)

There are five performance measurement types available:


Type 1: 2-way Delay/Variation (DMM/DMR)
Type 2: 1-way Delay Variation (1DM)
Type 3: Single-ended Loss/Availability (LMM/LMR)
Type 4: Dual-ended Loss/Availability (CCM)
Type 5: Single-ended Synthetic Loss (SLM/SLR)
Before a probe can be configured, global parameters must be defined. The global parameters include
bucket size and bins.
Performance monitoring data is collected during a predetermined time frame. The time frame is referred to
as the measurement interval or bucket size. During the measurement interval, the performance monitoring
data is grouped into bins inside each bucket. The default bucket size is 15 minutes. A bin counts the number
of data samples falling within the limits of the bin. Each bin has a minimum and a maximum value. If
one of the bins has a minimum value of 1ms and a maximum value of 2ms, then all the data that is greater
than or equal to 1ms, but less than 2ms is stored in that bin. The default bin times are: 5 (0 to 5msec), 10
(5 to 10msec) and greater than 10ms.
Y.1731 must be globally enabled on the initiator and responder module for a performance measurement to
run. Use the probe -ena command to enable Y.1731 performance monitoring.
The probe command provides the ability to configure and display the five types of Y.1731 probes on the
module. Probes are used to provide performance monitoring data to help validate service level agreements.
NOTE: Y.1731 probes are configured with a PBit priority of 0 by default. Probes can be configured
to verify performance measurements at different priority levels by changing the PBit value when
configuring a probe.
A total of 16 simultaneous LMM/LMR, CCM, DMM/DMR, 1DL and SLM/SLR probes (any combination)
are supported.

Page 147
To configure performance monitoring, use the probe option from the CLI prompt. A list of options is
displayed when the probe -h command is entered.

> probe -h

Description: Performance Metric Probe Configuration


Format: probe [-a|-clear|-d|-dall|-dis|-ena|-g|-h|-resp|-s] [-p portNum]
[-ty probeType] [-n domainName|-l domainLevel|-ni dindex]
[-o maName|-oi mindex] [-v primaryVid|-e evcName] [-mac macAddr|
-m mepid] [-pri pbits] [-i probeInterval] [-fr flvalue]
[-sz size|-fsz frameSize] [-bt bucketTime] [-bin bval1,...,bvaln]
[-bu][-cpp|-cpe|-cpo|-cph] [-pi pindex|all]
[-rt] [-tx] [-rx] [-vbin bval1,bval2,...,bvaln] [-ver] [-pn pName]
[-nosync] [-du dselect] [-tid testId] [-fd ftime] [-fdv ftime]
[-dat {ones|zeros}] [-avail aavail] [-v1|-v2] [-deltat numpdu]
[-ndeltat numdt]
Switches:
-a add performance metric probe
-avail acceptable availability percent, [aavail]: {0.0...100.0}, default 50.0
-bin delay bin sizes in ms, 1-15 values
-bt bucket size, [bucketTime], in minutes: {1...60}
-bu bucket show results
-clear clears specific probe history data
-cpe enables probe on a per EVC basis (default value)
-cph enables probe on a per hopping priority basis
-cpo disables responder
-cpp enables probe on a per fixed priority basis
-d delete performance metric probe
-dall deletes all probe instances
-dat selects data payload value: {ones|zeros}
[ones] selects a payload that is filled with ones
[zeros] selects a payload that is filled with zeros, default
-deltat number SOAM PDUs for defining delta t, [numPdu]: {1..10}, dflt 10
-dis disable Y.1731 compatibility mode
-du configures delay units, [dselect]: {ms|us|ns}, default ms
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-ena enable Y.1731 compatibility mode
-fd acceptable frame delay, [ftime]: {1...10000} ms, default 1000
-fdv acceptable frame delay variation, [ftime]: {1...10000} ms, default 1000
-fr acceptable frame loss percentage, for a time period to be listed as
Available, 0.1% resolution; default is 500 (50.0%)
-fsz specifies Ethernet [frameSize], uses data TLV to adjust length
-g probe metric global setup
-h display help information
-i [probeInterval] value: {3 is 100ms, 4 (default) is 1s, 5 is 10s,
6 is 1min, 7 is 10min}
-l maintenance [domainLevel]: {0...7}
-m destination mep ID, [mepid], unique within a MA: {1...8191}
-mac destination MAC Address, [macAddr]: {xx-xx-xx-xx-xx-xx}
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-ndeltat number of n delta t intervals used for availability, [numdt]:
{1..10}, dflt 10
-nosync disables using peer partner time of day (master clock)
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p [portNum] selected: {1...17}
-pi probe index value
-pn defines probe name [pName], 1-45 ASCII characters, default blank
-pri vlan priority bits, [pbits], for PDU sent if tagged; default value is 0
-resp probe responder setup

Page 148
-rt realtime show results
-rx enable receive for the 1DM (1 way delay/variation)
-s show performance metric probe results
-sz TLV packet [size]; filled with testData or random if not defined
-tid set test ID [testId] for SLM probes, default 1
-ty [probeType]: {1|2|3|4|5}
1 = 2-way delay/variation (DMM/DMR)
2 = 1-way delay/variation (1DM)
3 = single-ended loss/availability (LMM/LMR)
4 = dual ended loss/availability (CCM)
5 = single-ended synthetic loss (SLM)
-tx enables transmit for the 1DM (1 way delay/variation)
-v [primaryVid] associated with the MA: {0...4095}
-vbin delay variation bin sizes in ms, 1-15 values
-ver verbose help or show
-v1 enable Y.1731 v1 LMM/CCM counting
-v2 enable Y.1731 v2 LMM/CCM counting, default

>

The options available using the probe command are shown below.
The -a switch adds a probe.
The -avail switch configures the acceptable available in % allowed before a SNMP trap is generated. 50%
is the default value. Valid for type 3 (LMM/LMR) and type 4 (CCM) probes only.
The -bin switch defines the sizes of the bin.
The -bt switch defines the size of the bucket.
The -bu switch displays the bucket results when used with the -s switch.
The -clear switch clears the history data for a specific probe.
The -cpe, -cph, and -cpp switches define the type of frames counted during the probe measurement interval.
-cpe counts frames per EVC. -cph counts frames on a hopping priority. -cpp counts frames with a fixed
priority.
The -cpo switch disables the responder module from counting frames.
The -d switch deletes a specific probe.
The -dall switch deletes all configured probes.
The -dat switch configures the value of payload data used by the probe (all ones or all zeros).
The -deltat switch defines the period of time based on the number of SOAM PDUs that are used for a Δt
period. The default value is 10 seconds.
The -dis switch globally disables Y.1731.
The -du switch configures the delay units for the test results metrics. The default is milliseconds.
The -e switch associates a EVC with a probe.
The -ena switch globally enables Y.1731.
The -fd switch configures the maximum frame delay allowed before a SNMP trap is generated. 1000msec
is the default value. Valid for type 1 (DMM/DMR) probes only.
The -fdv switch configures the maximum frame delay variation allowed before a SNMP trap is generated.
1000msec is the default value. Valid for type 1 (DMM/DMR) probes only.

Page 149
The -fr switch defines the acceptable frame loss percentage. An SNMP trap will be generated if the measured
frame loss percentage is greater than the acceptable frame loss percentage. The -fr switch is not valid for
type 1 (DMM/DMR) probes.
The -fsz switch defines the frame size used in the performance testing.
The -g switch configures the bins and bucket times.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -i switch configure the time interval between probe OAM PDUs. Valid options are 100ms, 1 sec, 10
sec, 1 min and 10 min. The default value is 1 sec. The -i switch is not valid when type 4 (CCM) probe is
selected.
The -l, -n, and -ni switches indicate a specific level, domain name and index.
The -m switch defines the destination MEP.
The -mac switch defines the destination MAC address.
The -nodeltat switch defines the period of n Δt based upon the number of Δt intervals. The total time for
n Δt must be less than or equal to the measurement interval. The default value is 10 resulting in a nodeltat
value of 100 seconds (10 x 10).
The -nosync switch disables the use of the peer partner’s time of day indicator.
The -o and -oi switches indicate a specific maintenance association name and index.
The -p switch associates a specific port to a probe.
The -pi switch is the defined index number displayed in the probe table as a short attribute command for
deleting a probe.
The -pn switch defines the name of the probe.
The -pri switch defines the VLAN priority bits for the probe PDU.
The -resp switch configures the responder module for fixed priority and priority hooping configurations.
The -rt switch displays the real time results when used with the -s switch.
The -rx switch enables the port to receive 1 way delay/variation probe PDU.
The -s switch displays the probe results.
The -sz switch defines the frame size of the probe PDU.
The -tid switch sets the test ID value for SLM probes. The value is a thirty-two bit number. The default
value is 1. The -tid value is used by the SLM transmitter to send frames and recognize the SLR response.
The SLR response uses the -tid value found in the SLM. If the -tid values do not match the returned SLR
response is dropped/ignored by the SLM transmitter.
The -ty switch defines the probe type. Five probe types are available: DMM/DMR, 1DM, LMM/LMR,
CCM or SLM.
The -tx switch enables the port to transmit 1 way delay/variation probe PDU.
The -v switch associates a specific VID to the probe setup.
The -vbin switch defines the delay variation of the bin sizes.
The -ver switch displays the extended help or show status screens.
The -v1 switch configures Y.1731 LMM/LMR v1 counting (CCM not counted at same MD level).
For LMM/LMR and CCM probe types, all OAM frames higher than the MEP’s domain level are counted
with the Service Frames.
OAM frames transmitted at the MEP’s domain level or lower are NOT counted.

Page 150
The -v2 switch configures Y.1731 LMM/LMR v2 counting (CCM counted at same MD level).
For LMM/LMR and CCM probe types, all OAM frames higher than the MEP’s domain level are counted
with the Service Frames.
For LMM/LMR and CCM probe types, all OAM frames lower than the MEP’s domain level are NOT
counted.
For LMM/LMR probes, OAM frames at the MEP’s same domain level of type CCM, APS, and CSF
are counted.
For CCM probes, OAM frames at the MEP’s same domain level of type APS, and CSF are counted.
For both LMM/LMR and CCM probes, OAM frames at the MEP’s same domain level of type LBM/
LBR and LTM/LTR frames are NOT counted.
Probes can be configured on an EVC (-cpe), priority hopping (-cph) or fixed priority (-cpp) basis. EVC
(-cpe) is the default setting. LMM/LMR probe can only be configured with -cpe and -cph options.
-cpe enables counting of frames on a per EVC basis (default value)
-cph enables counting of frames on a per hopping priority basis
-cpp enables counting of frames on a per fixed priority basis
-cpo disables responder

When configured for EVC (-cpe), loss measurement probes count all the frames in the configured EVC.
When configured for priority hopping (-cph), loss measurement probes count frames based on a priority
hopping algorithm. The initiator module will be configured for priority hopping with a defined pbit priority
and the responder module will be configured for priority hopping with no pbit priority defined.
For example, if the incoming priority of the LMM probe is 1 and there is no corresponding probe responder
of any priority, a new probe responder “session” is created and starts the frame count on priority 1. If the
incoming LMM priority changes to 2, the session is “hopped” to start the frame count on priority 2.
When LMM with a new priority is received, it is considered as a “counter reset” and a new session is
created and all counters are reset.
When configured for fixed priority (-cpp), the loss measurement probes count all frames with the configured
priority. The initiator module will be configured for fixed priority with a defined pbit priority and the
responder module will be configured for fixed priority with the same defined pbit priority. Both the initiator
and responder modules must be configured using the -cpp command.
When the -cpo command is used, the frame counting algorithms are disabled and no replies are generated
by the responder module.
The example below configures a bucket time of 15 minutes with four bins.

> probe -g -bt 15 -bin 1,2,5,10

Each bin has the following range: 1 (0 to 1msec), 2 (1 to 2msec), 5 (2 to 5msec), 10 (5 to 10msec) and
greater than 10msec.
A maximum of sixteen bins can be defined.

Page 151
To display the global settings, use the probe -s command.

> probe -s

Probes disabled
Measurement Interval (Bucket size) = 15 min
Frame Delay Bins: Frame Delay Variation Bins:
Bin #1 Frame delay >= 0 and < 1 Bin #1 Delay variation >= 0 and < 5
Bin #2 Frame delay >= 1 and < 2 Bin #2 Delay variation >= 5
Bin #3 Frame delay >= 2 and < 5
Bin #4 Frame delay >= 5 and < 10
Bin #5 Frame delay >= 10

No probes defined

>

NOTE: Probes can be created before Y.1731 has been globally enabled on the module. If a probe
is created before Y,1731 is enabled, the probe will not run. Use the probe -ena command to enable
Y.1731 on the module.
The example below configures a Type 3 probe to count frames on a EVC basis on Port 15, Maintenance
Domain “MD1”, Maintenance Association “MA1A” and remote Maintenance End Point 921.

> probe -a -p 15 -ty 3 -n MD1 -l 1 -o MA1A -m 921 -cpe

The example below configures a Type 3 probe on Port 2 with a Maintenance Domain Level 2, VLAN ID
100, pbit priority 3, for remote Maintenance End Point 100.

> probe -a -p 2 -ty 3 -l 2 -v 100 -pri 3 -m 100 -cpp

To change the pbit priority of a created probe, the probe must be deleted and recreated with the new value.
Use the probe -d command to delete the probe.
For fixed priority configurations, the remote (responding) module must be configured. Use the -cpp
command to configure the remote module.

> probe -resp -p 2 -ty 3 -l 2 -cpp

For priority hopping configurations, the remote (responding) module must be configured. Use the -cph
command to configure the remote module.

> probe -resp -p 2 -ty 3 -l 2 -cph

Once a probe has been created, the probe will continue to run until it is deleted. Use the probe -d command
to delete a probe.

> probe -d -pi 1

When probes are created, they are given a probe number. The probe number is displayed when the probe -s
command is entered. -pi 1 command indicates probe #1 will be deleted.
If a probe has been created and the same command is re-entered, an error message will be displayed.

Page 152
> probe -a -p 1 -ty 1 -n MD1 -l 1 -o MA1A -m 921

Probe already exists for this MEP

>

To enable 1731 testing, use the probe -ena command.

> probe -ena

The configuration used for the examples in this section is shown below. The configuration assumes a
factory default module.

NID #1
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> cfm -ena all
> evc -a -e E2 -p 15,14,mgt1 -v 1000
> interface -a -p 15 -t nni
> interface -a -p 14 -t uni -e E2:200
> interface -a -p mgt1 -t uni -e E2:*
> evc -ena
> mdo -a -n Domain1 -l 4
> ma -a -n Domain1 -o MA01 -p 15 -e E2
> mep -a -n Domain1 -o MA01 -m 100 -p 15 -dn -e E2
> rmep -a -n Domain1 -o MA01 -m 101
> sntp -ena -ip1 192.168.1.254 -z PST
> probe -g -bt 5 -bin 1,2,5,10
> probe -ena
> probe -a -p 15 -ty 1 -n Domain1 -o MA01 -m 101
> probe -a -p 15 -ty 2 -n Domain1 -o MA01 -m 101 -rx
> probe -a -p 15 -ty 3 -n Domain1 -o MA01 -m 101
> probe -a -p 15 -ty 4 -n Domain1 -o MA01 -m 101

Page 153
NID #2
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> cfm -ena all
> evc -a -e E2 -p 15,14,mgt1 -v 1000
> interface -a -p 15 -t nni
> interface -a -p 14 -t uni -e E2:200
> interface -a -p mgt1 -t uni -e E2:*
> evc --ena
> mdo -a -n Domain1 -l 4
> ma -a -n Domain1 -o MA01 -p 15 -e E2
> mep -a -n Domain1 -o MA01 -m 101 -p 15 -dn -e E2
> rmep -a -n Domain1 -o MA01 -m 100
> sntp -ena -ip1 192.168.1.254 -z PST
> probe -g -bt 5 -bin 1,2,5,10
> probe -ena
> probe -a -p 15 -ty 2 -n Domain1 -o MA01 -m 100 -tx
> probe -a -p 15 -ty 4 -n Domain1 -o MA01 -m 100

Page 154
5.1.43.2 Type 1: 2-way Delay/Variation (DMM/DMR) Probe Example
Type 1 probe provides 1 and 2-way Frame Delay and Frame Delay Variations Measurements.
The example below configures a Type 1 probe for Port 15 with a Maintenance Domain “Domain1”,
Maintenance Association “MA01” and Maintenance Endpoint 101 on the local module.

> probe -a -p 15 -ty 1 -n Domain1 -o MA01 -m 101

To display the results, use the probe -s command.

> probe -s

Probes enabled
Measurement Interval (Bucket size) = 1 min
Frame Delay Bins: Frame Delay Variation Bins:
Bin #1 Frame delay >= 0 and < 1 Bin #1 Delay variation >= 0 and < 5
Bin #2 Frame delay >= 1 and < 2 Bin #2 Delay variation >= 5
Bin #3 Frame delay >= 2 and < 5
Bin #4 Frame delay >= 5 and < 10
Bin #5 Frame delay >= 10

--- Probe #1 -------------------------------------------------------------


Name:
Port 15 Type = 2-way delay/variation, DMR synchronization, 1 sec
Destination 00-06-87-01-37-71 (Domain Level = 4 ; VLAN = 1000 ; Priority = 0)
Acceptance Criteria: FD < 1000.0ms, IFDV < 1000.0ms

2-way Frame Delay Frame Variation Total Frames


Min Max Ave Min Max Ave Tx Rx
========================== ========================== ============
10s: 0.008 0.010 0.008 0.000 0.002 0.001 10 10
1 min: 0.008 0.010 0.008 0.000 0.002 0.001 60 60
5 min: 0.008 0.011 0.008 0.000 0.003 0.000 300 300
15 min: 0.008 0.011 0.008 0.000 0.003 0.000 900 900

Forward FD Frame Variation Total Frames


Min Max Ave Min Max Ave Tx Rx
========================== ========================== ============
10s: 0.004 0.005 0.004 0.000 0.001 0.000 10 10
1 min: 0.004 0.005 0.004 0.000 0.001 0.000 60 60
5 min: 0.004 0.006 0.004 0.000 0.002 0.000 300 300
15 min: 0.004 0.006 0.004 0.000 0.002 0.000 900 900

Backward FD Frame Variation Total Frames


Min Max Ave Min Max Ave Tx Rx
========================== ========================== ============
10s: 0.004 0.005 0.004 0.000 0.001 0.000 10 10
1 min: 0.004 0.005 0.004 0.000 0.001 0.000 60 60
5 min: 0.004 0.005 0.004 0.000 0.001 0.000 300 300
15 min: 0.004 0.006 0.004 0.000 0.002 0.000 900 900

>

Valid switch options for DMM/DMR:


probe -a -p [portNum] -ty 1 [-pn pName] [-n domainName|-l domainLevel|-ni dindex]
[-o maName|-oi mindex] [-mac macAddr|-m mepid]
[-v primaryVid|-e evcName] [-pri pbits] [-i probeInterval]
[-sz size] [-dat {ones|zeros}]
[-nosync] [-fd ftime] [-fdv ftime]

Page 155
To display the real time results, use the probe -s -rt command.

> probe -s -rt

Probes enabled
Measurement Interval (Bucket size) = 1 min
Frame Delay Bins: Frame Delay Variation Bins:
Bin #1 Frame delay >= 0 and < 1 Bin #1 Delay variation >= 0 and < 5
Bin #2 Frame delay >= 1 and < 2 Bin #2 Delay variation >= 5
Bin #3 Frame delay >= 2 and < 5
Bin #4 Frame delay >= 5 and < 10
Bin #5 Frame delay >= 10

--- Probe #1 -------------------------------------------------------------


Name:
Port 15 Type = 2-way delay/variation, DMR synchronization, 1 sec
Destination 00-06-87-01-37-71 (Domain Level = 4 ; VLAN = 1000 ; Priority = 0)

# Time TxTimeStampf RxTimeStampf TxTimeStampb RxTimeStampb


1 00:46:09.0305 00:46:09.0298 00:46:09.0298 00:46:09.0305 00:46:09.0305
2 00:46:08.0304 00:46:08.0297 00:46:08.0298 00:46:08.0304 00:46:08.0304
3 00:46:07.0303 00:46:07.0297 00:46:07.0297 00:46:07.0303 00:46:07.0303
4 00:46:06.0303 00:46:06.0296 00:46:06.0296 00:46:06.0303 00:46:06.0303
5 00:46:05.0302 00:46:05.0296 00:46:05.0296 00:46:05.0302 00:46:05.0302
6 00:46:04.0301 00:46:04.0295 00:46:04.0295 00:46:04.0301 00:46:04.0301
7 00:46:03.0300 00:46:03.0294 00:46:03.0295 00:46:03.0300 00:46:03.0300
8 00:46:02.0300 00:46:02.0294 00:46:02.0294 00:46:02.0300 00:46:02.0300
9 00:46:01.0300 00:46:01.0294 00:46:01.0294 00:46:01.0300 00:46:01.0300
10 00:46:00.0300 00:46:00.0293 00:46:00.0294 00:46:00.0299 00:46:00.0300
11 00:45:59.0300 00:45:59.0292 00:45:59.0292 00:45:59.0300 00:45:59.0300
12 00:45:58.0299 00:45:58.0291 00:45:58.0292 00:45:58.0299 00:45:58.0299
13 00:45:57.0299 00:45:57.0291 00:45:57.0291 00:45:57.0299 00:45:57.0299
14 00:45:56.0298 00:45:56.0290 00:45:56.0290 00:45:56.0297 00:45:56.0298
15 00:45:55.0297 00:45:55.0290 00:45:55.0290 00:45:55.0297 00:45:55.0297
16 00:45:54.0296 00:45:54.0289 00:45:54.0289 00:45:54.0296 00:45:54.0296
17 00:45:53.0296 00:45:53.0288 00:45:53.0289 00:45:53.0296 00:45:53.0296
18 00:45:52.0295 00:45:52.0288 00:45:52.0288 00:45:52.0295 00:45:52.0295
19 00:45:51.0295 00:45:51.0287 00:45:51.0287 00:45:51.0295 00:45:51.0295
20 00:45:50.0294 00:45:50.0287 00:45:50.0287 00:45:50.0294 00:45:50.0294

>

Page 156
To display the bucket time results, use the probe -s -bu command.

> probe -s -bu

Probes enabled
Measurement Interval (Bucket size) = 1 min
Frame Delay Bins: Frame Delay Variation Bins:
Bin #1 Frame delay >= 0 and < 1 Bin #1 Delay variation >= 0 and < 5
Bin #2 Frame delay >= 1 and < 2 Bin #2 Delay variation >= 5
Bin #3 Frame delay >= 2 and < 5
Bin #4 Frame delay >= 5 and < 10
Bin #5 Frame delay >= 10

--- Probe #1 -------------------------------------------------------------


Name:
Port 15 Type = 2-way delay/variation, DMR synchronization, 1 sec
Destination 00-06-87-01-37-71 (Domain Level = 4 ; VLAN = 1000 ; Priority = 0)

Type Min Max Ave Bin#1 Bin#2 Bin#3 Bin#4 Bin#5


1/1/2000 00:44:44.1801; Suspect=No; Initiated 300; Completed 300
FD 2-way 0.017 0.021 0.018 300 0 0 0 0 0
FD Fwd 0.008 0.011 0.009 300 0 0 0 0 0
FD Back 0.008 0.010 0.009 300 0 0 0 0 0
FDV 2-way 0.000 0.004 0.001 300 0
FDV Fwd 0.000 0.002 0.000 300 0
FDV Back 0.000 0.002 0.001 300 0
1/1/2000 00:39:44.1928; Suspect=No; Initiated 300; Completed 300
FD 2-way 0.017 0.021 0.018 300 0 0 0 0 0
FD Fwd 0.008 0.011 0.009 300 0 0 0 0 0
FD Back 0.008 0.010 0.009 300 0 0 0 0 0
FDV 2-way 0.000 0.004 0.001 300 0
FDV Fwd 0.000 0.002 0.000 300 0
FDV Back 0.000 0.002 0.001 300 0
1/1/2000 00:34:44.2055; Suspect=No; Initiated 300; Completed 300
FD 2-way 0.017 0.021 0.018 300 0 0 0 0 0
FD Fwd 0.008 0.011 0.009 300 0 0 0 0 0
FD Back 0.008 0.010 0.009 300 0 0 0 0 0
FDV 2-way 0.000 0.004 0.001 300 0
FDV Fwd 0.000 0.002 0.000 300 0
FDV Back 0.000 0.002 0.001 300 0

>

Page 157
5.1.43.3 Type 2: 1-way Delay/Variation (1DM) Probe Example
Type 2 probes provide 1-way Frame Delay and Frame Delay Variation Measurements.
For Type 2 probes, each module must be configured; one for transmit and the other for receive.
The example below configures a Type 2 probe for receive on Port 15 Maintenance Domain “Domain1”,
Maintenance Association “MA01” with a Maintenance Endpoint of 101.

> probe -a -p 15 -ty 2 -n Domain1 -o MA01 -m 101 -rx

The other module is configured for transmit on Port 1 Maintenance Domain “Domain1”, Maintenance
Association “MA01” with a Maintenance Endpoint of 100.

> probe -a -p 15 -ty 2 -n Domain1 -o MA01 -m 100 -tx

To display the results, use the probe -s command on the receive module.

> probe -s

Probes enabled
Measurement Interval (Bucket size) = 1 min
Frame Delay Bins: Frame Delay Variation Bins:
Bin #1 Frame delay >= 0 and < 1 Bin #1 Delay variation >= 0 and < 5
Bin #2 Frame delay >= 1 and < 2 Bin #2 Delay variation >= 5
Bin #3 Frame delay >= 2 and < 5
Bin #4 Frame delay >= 5 and < 10
Bin #5 Frame delay >= 10

--- Probe #1 -------------------------------------------------------------


Name:
Port 15 Type = 1-way delay/variation receive enabled, 1 sec
Destination 00-06-87-01-37-71 (Domain Level = 3 ; VLAN = 1000 ; Priority = 0)
Acceptance Criteria: FD < 1000.0ms, IFDV < 1000.0ms

Frame Delay Frame Variation Total Frames


Min Max Ave Min Max Ave Tx Rx
================= ================ =============
10s: 1 1 1.0 0 0 0.0 n/a 10
1 min: 1 14 9.9 0 13 0.2 n/a 60
5 min: 1 14 12.6 0 13 0.1 n/a 300
15 min: 1 15 12.6 0 14 0.1 n/a 900

>

NOTE: Type 2 performance monitoring probe requires clock synchronization between modules to
return accurate test results. The modules should be synchronized to the same Network Time Protocol
server.
Valid switch options for 1DM:
probe -a -p [portNum] -ty 2 [-pn pName] [-n domainName|-l domainLevel|-ni dindex]
[-o maName|-oi mindex] [-mac macAddr|-m mepid]
[-pri pbits] [-i probeInterval]
[-tx] [-rx] [-sz size] [-dat {ones|zeros}]
[-fd ftime] [-fdv ftime]

Page 158
5.1.43.4 Type 3: Single-Ended Loss/Availability (LMM/LMR) Probe Example
Type 3 probes provide single-ended Frame Loss and Availability Measurements.
The example below configures a Type 3 probe on Port 15 with a Maintenance Domain “Domain1”,
Maintenance Association “MA01” and Maintenance Endpoint 101.

> probe -a -p 15 -ty 3 -n Domain1 -o MA01 -m 101

Start a continuous ping to generate traffic across the connection.


To display the results, use the probe -s command.

> probe -s

Probes enabled
Measurement Interval (Bucket size) = 1 min
Frame Delay Bins: Frame Delay Variation Bins:
Bin #1 Frame delay >= 0 and < 1 Bin #1 Delay variation >= 0 and < 5
Bin #2 Frame delay >= 1 and < 2 Bin #2 Delay variation >= 5
Bin #3 Frame delay >= 2 and < 5
Bin #4 Frame delay >= 5 and < 10
Bin #5 Frame delay >= 10

--- Probe #1 -------------------------------------------------------------


Name:
Port 15 Type = frame loss and availability v2, single ended, EVC based, 1 sec
Destination 00-06-87-01-37-71 (Domain Level = 3 ; VLAN = 1000 ; Priority = 0)
Acceptance Criteria: FLR < 50.0%, Availability > 50%
Delta t = 10 (10s), n Delta t = 10

LMM Far-End (Forward)


Tx Sent Received Loss Avail
===== ========================================
10s: 10 20 20 0.0% 100.0%
1 min: 60 124 124 0.0% 100.0%
5 min: 300 617 617 0.0% 100.0%
15 min: 900 841 841 0.0% 100.0%

LMR Near-End (Backward)


Rx Sent Received Loss Avail
===== ========================================
10s: 10 20 20 0.0% 100.0%
1 min: 60 121 121 0.0% 100.0%
5 min: 300 606 606 0.0% 100.0%
15 min: 900 846 846 0.0% 100.0%

Valid switch options for LMM/LMR:


probe -a -p [portNum] -ty 3 [-pn pName] [-n domainName|-l domainLevel|-ni dindex]
[-o maName|-oi mindex] [-mac macAddr|-m mepid]
[-v primaryVid|-e evcName] [-pri pbits] [-i probeInterval]
[-fr flvalue] [-cpe|-cph] [-avail aavail] [-v1|-v2]

Page 159
5.1.43.5 Type 4: Dual Ended Loss/Availability (CCM) Probe Example
Type 4 probes provide dual-ended Frame Loss and Availability Measurements.
Type 4 probes require configuration of both modules.
The example below configures a Type 4 probe on Port 15 with a Maintenance Domain “Domain1”,
Maintenance Association “MA01” and Maintenance Endpoint 101.

> probe -a -p 15 -ty 4 -n Domain1 -o MA01 -m 101

The other module is configured for a Type 4 probe on Port 15 Maintenance Domain “Domain1”, Maintenance
Association “MA01” with a Maintenance Endpoint of 100.

> probe -a -p 15 -ty 4 -n Domain1 -o MA01 -m 100

Start a continuous ping to generate traffic across the connection.


To display the results, use the probe -s command.

> probe -s

Probes enabled
Measurement Interval (Bucket size) = 1 min
Frame Delay Bins: Frame Delay Variation Bins:
Bin #1 Frame delay >= 0 and < 1 Bin #1 Delay variation >= 0 and < 5
Bin #2 Frame delay >= 1 and < 2 Bin #2 Delay variation >= 5
Bin #3 Frame delay >= 2 and < 5
Bin #4 Frame delay >= 5 and < 10
Bin #5 Frame delay >= 10

--- Probe #1 -------------------------------------------------------------


Name:
Port 15 Type = frame loss and availability v2, dual ended, EVC based, 1 sec
Destination 00-06-87-01-37-71 (Domain Level = 3 ; VLAN = 1000 ; Priority = 0)
Acceptance Criteria: FLR < 50.0%, Availability > 50%

CCM Far-End (Forward)


Tx Sent Received Loss Avail
===== ========================================
10s: 10 20 20 0.0% 100.0%
1 min: 60 122 122 0.0% 100.0%
5 min: 300 627 627 0.0% 100.0%
15 min: 900 1844 1844 0.0% 100.0%

CCM Near-End (Backward)


Rx Sent Received Loss Avail
===== ========================================
10s: 10 20 20 0.0% 100.0%
1 min: 60 122 122 0.0% 100.0%
5 min: 300 630 630 0.0% 100.0%
15 min: 900 1845 1845 0.0% 100.0%

Valid switch options for CMM:


probe -a -p [portNum] -ty 4 [-pn pName] [-n domainName|-l domainLevel|-ni dindex]
[-o maName|-oi mindex] [-mac macAddr|-m mepid]
[-v primaryVid|-e evcName]
[-fr flvalue] [-cpe|-cph] [-avail aavail] [-v1|-v2]

Page 160
5.1.43.6 Type 5: Single-Ended Synthetic Loss (SLM) Probe Example
Type 5 probes provide single-ended Synthetic Loss Measurement. SLM measures frame loss using synthetic
frames, rather than data traffic. Frame loss is measured by calculating the difference between the number
of synthetic frames that are sent and received.
The example below configures a Type 5 probe on Port 1 with a Maintenance Domain “Domain1”,
Maintenance Association “MA01” and Maintenance Endpoint 101.

> probe -a -p 1 -ty 5 -n Domain1 -o MA01 -m 101

To display the results, use the probe -s command.

> probe -s
Probes enabled
Measurement Interval (Bucket size) = 5 min
Frame Delay Bins: Frame Delay Variation Bins:
Bin #1 Frame delay >= 0 and < 1 Bin #1 Delay variation >= 0 and < 5
Bin #2 Frame delay >= 1 and < 2 Bin #2 Delay variation >= 5
Bin #3 Frame delay >= 2 and < 5
Bin #4 Frame delay >= 5 and < 10
Bin #5 Frame delay >= 10

--- Probe #1 -------------------------------------------------------------


Name:
Port 1 Type = single-ended synthetic loss measurement, 1 sec
Destination 00-06-87-01-a1-41 (Domain Level = 4 ; VLAN = 1000 ; Priority = 0)
Acceptance Criteria: FLR < 50.0%, Availability > 50%
Test ID = 1; Delta t = 10 (10s), n Delta t = 10

SLM Far-End (Forward)


Tx Sent Received Loss Avail
===== ========================================
10s: 10 10 10 0.0% 100.0%
1 min: 60 60 60 0.0% 100.0%
5 min: 300 300 300 0.0% 100.0%
15 min: 900 900 900 0.0% 100.0%

SLR Near-End (Backward)


Rx Sent Received Loss Avail
===== ========================================
10s: 10 10 10 0.0% 100.0%
1 min: 60 60 60 0.0% 100.0%
5 min: 300 300 300 0.0% 100.0%
15 min: 900 900 900 0.0% 100.0%

>

Valid switch options for SLM/SLR:


probe -a -p [portNum] -ty 5 {-n domainName | -l domainLevel | -ni dindex}
{-o maName | -oi mindex |} {-mac macAddr | -m mepid}
{-v primaryVid | -e evcName} [-pri pbits] [-i probeInterval]
[-sz size | -fsz frameSize] [-dat ones,zeros]
[-fr flvalue] [-tid testId] [-deltat numpdu] [-ndelta numdt]

Page 161
5.1.44 Protocol Configuration (PROTOCOL)
The protocol command provides the ability to configure specific protocols available on the module. Telnet,
FTP, SNMP and IP can be configured using the protocol command.
To configure the protocols, use the protocol option from the CLI prompt. A list of options is displayed
when the protocol -h command is entered.

> protocol -h

Description: Protocol Configuration


Format: protocol [-h [-ver]|-s] [-snmpv1 prEn] [-snmpv3 prEn] [-ip prEn]
[-telnet prEn] [-telnetpw pw|-notelpw] [-ftp prEn] [-ftppw pw|-noftppw]
[-serpw pw|-noserpw] [-keepalive kpEn] [-keeptime kpTime]
Switches:
-ftp set FTP protocol [prEn]: {ena|dis}, default disabled
-ftppw set FTP protocol password [pw], 1-32 ASCII characters
-h display help information
-ip set IP protocol [prEn]: {ena|dis}, default enabled
-keepalive set keep alive trap [kpEn]: {ena|dis}, default disabled
-keeptime sets keep alive trap interval [kpTime]: {10...300}, default 10
-noftppw removes FTP password
-noserpw removes serial password
-notelpw removes Telnet password
-s shows current protocol settings
-serpw set serial port password [pw], 1-32 ASCII characters
-snmpv1 set SNMPv1/v2c agent [prEn]: {ena|dis}, default enabled
-snmpv3 set SNMPv3 agent [prEn]: {ena|dis}, default enabled
-telnet set Telnet protocol [prEn]: {ena|dis}, default enabled
-telnetpw set Telnet protocol password [pw], 1-32 ASCII characters
-ver verbose help

>

The options available using the protocol command are shown below.
The -ftp switch enables or disables the FTP protocol. The default setting is disabled.
The -ftppw switch configures the FTP password. No password is configured by default.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -ip switch enables or disables IP protocol. The default setting is enabled.
The -keepalive switch enables or disable the keepalive trap. The default setting is disabled.
The -keeptime switch configures the keepalive timer. The keepalive trap interval can be configured to send
the a trap in intervals of 10 to 600 seconds. The default setting is 10 seconds.
The -noftppw switch removes the FTP password.
The -noserpw switch removes the serial console password.
The -notelpw switch removes the Telnet password.
The -s switch displays the protocol configuration.
The -serpw switch configures the serial console password.
The -snmpv1 switch enables or disables the SNMPv1/v2c agent. The default setting is enabled.
The -snmpv3 switch enables or disables the SNMPv3 agent. The default setting is enabled.
The -telnet switch enables or disables Telnet. The default setting is enabled.
The -telnetpw switch configures the Telnet password. The default password is public.
The -ver switch displays the extended help screen.

Page 162
To display the current configuration, use the protocol -s command.

> protocol -s

IP protocol: enabled
Telnet protocol: enabled (inactive)
Telnet password: *****
FTP protocol: disabled
FTP password: *****
Serial password:
SNMPv1/v2c agent: enabled
SNMPv3 agent: enabled
Keep alive: disabled, interval=10s

>

To enable FTP, use the following command.

> protocol -ftp ena

To disable Telnet, use the following command.

> protocol -telnet dis

NOTE: Telnet and SSH share the same password.

Page 163
5.1.45 IEEE 1588 Precision Time Protocol (PTP)
Network Time Protocol (NTP) has been the traditional way to synchronize time over an Ethernet network.
NTP allows time synchronization up to 100 milliseconds. The IEEE 1588 Precision Time Protocol (PTP)
is required to achieve tighter synchronization. With the Precision Time Protocol (PTP), it is possible to
synchronize distributed clocks with an accuracy of less than 10 microsecond via an Ethernet network.
To configure PTP, use the ptp command from the CLI prompt. A list of options is displayed when the
ptp -h command is entered.

> ptp -h

Description: Precision Time Protocol (PTP) configuration


Format: ptp [-a|-d|-dall|-h|-m|-s] [-ver] [-ena|-dis] [-pi cindex] [-e evcName]
[-p portNum] [-proto protocol] [-mo pmode] [-ty {1,2}] [-ip serverNumIP]
[-ip2 serverNumIP] [-ctag cvid] [-pri pval] [-dom dnum] [-offset oValue]
[-ipsrc ipAddr] [-psrc portNum]
Switches:
-a add a PTP instance
-ctag C-TAG VID associated with the PTP PDUs [cvid]: {0..4095}, dflt 0
-d delete a PTP instance
-dall delete all PTP instances
-dis disable PTP or PTP instance, dflt
-dom PTP clock domain [dnum]: {0..128}, dflt 4
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-ena enable PTP or PTP instance
-h display help information
-ip time server IP address 1, [serverNumIP]
-ip2 time server IP address 2, [serverNumIP]
-ipsrc selects the source IP address, [ipAddr]
-m modify the existing PTP instance
-mo port mode: {boundary|master|slave|transparent}, dflt transparent
-offset clock offset from auto calculation, [oValue]: {0...32767} (ns), dflt 0
-p port number [portNum]: {1..17}, dflt 1
-pi PTP instance index [cindex]: {1..4}
-pri PTP clock priority 1 [pval]: {0..255}, dflt 100
-proto transport protocol, [proto]: {ethernet|ipmulti|ipuni}
-psrc PTP transmission source port [portNum]: {1..17}
-s show PTP configuration
-ty set clock step operation [tclk]: {1,2}, dflt 1
1 = one step; 2 = two step
-ver verbose help or show

>

The options available using the ptp command are shown below.
The -a switch adds a PTP instance.
The -ctag switch associates a C-TAG VLAN ID with the PTP PDUs.
The -d switch deletes a PTP instance
The -dall switch deletes all PTP instances.
The -dis and -ena switches disable or enable PTP on the module.
The -dom switch configures the PTP clock domain.
The -e switch associates a specific EVC to a MEP.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.

Page 164
The -ip switch configures the IP address of the PTP server.
The -ip2 switch configures the IP address of a secondary PTP server.
The -ipsrc switch configures the virtual IP address of the PTP configuration on the module.
The -m switch modifies an existing PTP instance by index number.
The -mo switch selects the type of PTP clock mode; boundary, master, slave or transparent.
The -offset switch adds an additional offset to the correction field.
The -p switch selects the port number.
The -pi switch identifies a specific PTP instance.
The -pri switch configures the PTP clock priority.
The -proto switch configures the transport mode for L2 Multicast (ethernet), IP/UDP Multicast (ipmulti)
or IP/UDP Unicast (ipuni).
The -psrc switch configures the PTP source port.
The -s switch displays the PTP configuration.
The -ty switch sets the transparent clock operation for one step or two step operation. One step is the default.
The -ver switch displays the extended help or show status screens.
Clock synchronization on the LAN requires at least one Master and one Slave device. The Master clock sends
synchronization messages used by the Slaves to adjust their local clocks. Precise timestamps are captured
at the Master and Slave clocks and are used to determine the network latency required to synchronize the
Slave to the Master.
A transparent clock measures the time that the packet is stored in the switch and adds the measured time
into the correction field of the follow-up message to the master. The slave clock uses the origin timestamp
and the correction field to adjust for packet delay. A boundary clock has multiple network connections and
can accurately synchronize one network segment to another.
Clock synchronization is provided through a series of messages between the master and slave clocks.
The master clock sends Sync messages with the time that the message leaves the master. This time can be
embedded in the Sync message (one-step operation) or in the Follow_Up message (two-step operation).
The slave receives the Sync message.
The slave sends the Delay_Req message with the timestamped indicating when it leaves the slave.
The master responds with a Delay_Resp message that contains time stamp total time.

Page 165
Use the ptp -s command to display the PTP configuration.

> ptp -s

PTP service is disabled and the onboard clock is free running

No instances are configured

PTP Count is 0
PTP Time (0) : 01/01/2000 03:59:21 AM 580,474,040

>

To configure the module for slave clock with two-step operation on EVC E1, use the following commands.

> ptp -a -mo slave -proto ethernet -ty 2 -ipsrc 192.168.1.200 -e E1 -ena -psrc 1

Use the ptp -s command to display the PTP configuration.

> ptp -s

PTP service is disabled

Instance #1
Instance: enabled
Mode: slave
PTP protocol: Ethernet
EVC name “E1”
Clock type: two step
Clock domain: 0
Clock priority: 100
C-TAG VID: 0
Clock offset: 0ns
Port 1 state is not available
Clock Status: free running

PTP Count is 0
PTP Time (0) : 01/01/2000 07:51:58 PM 217,690,680

>

Page 166
5.1.46 Restart Module (RESTART)
The restart command provide the ability to restart (warm boot) the module and enable/disable restart after
application firmware and/or FPGA code is upgraded.
Use the restart option from the CLI prompt to configure or restart the module. A list of options is displayed
when the restart -h command is entered.

> restart -h

Description: Restarts the module


Format: restart [-h [-ver]|-s] [-boot [-back]] [{-ena|-dis} {fw|fpga}]
Switches:
-back performs reboot from backup application image
-boot perform a warm boot of the module
-dis restart functions: {fw|fpga}
-ena restart functions: {fw|fpga}
[fw] auto restart after firmware upgrade, default enabled
[fpga] auto restart of FPGA after load of new image, default enabled
-h display help information
-s shows restart status
-ver verbose help

>

The options available using the restart command are shown below.
The -back switch performs a reboot from the backup application firmware stored on the module.
The -boot switch performs a warm boot on the module.
The -dis and -ena switches disable or enable the restart function when application firmware and/or FPGA
code is upgraded.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -s switch displays the restart status.
The -ver switch displays the extended help screen.
To restart the module, use the restart -boot command.

> restart -boot

To display the restart status, use the restart -s command.

> restart -s

sysUpTime: 264100
Date/Time: 12/31/1999 04:43:52 PM
Status: Operating normally
Auto restart after firmware upgrade: enabled
Auto restart after FPGA image upgrade: enabled

>

Page 167
5.1.47 Restore to Factory Defaults (RESTORE)
The restore command provides the ability to restore the factory default settings or to a configuration file
stored on the XM5.
Use the restore option from the CLI prompt to restore factory defaults. A list of options is displayed when
the restore -h command is entered.

> restore -h

Description: Restores defaults


Format: restore [-h [-ver]|-a|-d|-s] [-r rType] [-keepip]
Switches:
-a add a new local default settings file based upon current settings
-d deletes current local default settings file
-h display help information
-keepip restore all but IP based settings: IP address, subnet, gateway
-r restore to default [rType]: {factory|local|previous}
-s shows restore status
-ver verbose help

>

The options available using the restore command are shown below.
The -a switch creates a new local configuration file.
The -d switches deletes the current local configuration file.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -keepip switch maintains the current IP setting after the module has been restored to factory defaults.
The -r switch restores the module to factory defaults or to a configuration file stored on the module.
The -s switch displays the restore status.
The -ver switch displays the extended help screen.
To create a local configuration file based on the current configuration, use the restore -a command.

> restore -a

To restore the XM5 to factory default settings, use the restore -r factory command.

> restore -r factory

Restoring factory defaults...


Restarting module...

The XM5 will be rebooted and the factory default settings will be restored.

Page 168
5.1.48 IEEE 802.1ag Continuity Check Messages (RMEP)
MEPs exchange Continuity Check Message (CCM) packets with one or more remotely connected end
points. Remote MEP (RMEP) is used to connect a set of MEPs to be used for continuity check.
Use the rmep option from the CLI prompt to configure the remote MEP association. A list of options is
displayed when the rmep -h command is entered.

> rmep -h

Description: CFM remote MEP list configuration


Format: rmep [-a|-d|-h|-s|-auto {on|off}] [-n domainName|-l domainLevel]|
-ni dindex] [-o maName | -oi mindex] [-m mepid] [-ver] [-lmep mepid]
[-p portNum]
Switches:
-a add remote maintenance end point
-auto automatic learning of remote MEPs
-d delete remote maintenance end point
-h display help information
-l maintenance [domainLevel]: {0...7}
-lmep selects the local MEP [mepid] associated with the remote MEP: {1..8191}
-m mep ID, [mepid], unique within a MA: {1...8191}
-n defines [domainName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p [portNum] selected: {1...17}
-s show existing maintenance end point crosschecks
-ver verbose help or show

>

The options available using the rmep command are shown below.
The -a switch adds a remote MEP to a defined MD/MA/MEP.
The -auto switch automatically learns the remote MEP.
The -d switch deletes a defined remote MEP on a MD/MA/MEP.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -l, -n, and -ni switches indicate a specific level, domain name and index for the remote MEP.
The -lmep switch defines the local MEP that is associated with the remote MEP ID.
The -m switch defines remote MEP ID.
The -o and -oi switches indicate a specific maintenance association of the remote MEP.
The -p switch associates a specific port to a remote MEP.
The -s switch displays the configured remote MEPs and the running status.
The -ver switch displays the extended help or show status screens.
The rmep command only allows the pairing of one local MEP within the same MA. If more than one MEP
is configured locally within the same MA, only the first MEP will be paired with the remote MEP.

Page 169
The example below creates a remote MEP for Maintenance Domain “Domain1” and Maintenance Association
“MA01” Maintenance End Point 101.

> rmep -a -n Domain1 -o MA01 -m 101

To display created remote MEPs, use the rmep -s command.

> rmep -s

Local Remote MD MA MD Port Vlan Status/ MAC Domain Name/


MEPID MEPID Idx Idx Lvl Num Id Defect Addr Maint Assoc
========================================================================================
100 101 1 1 7 1 1000 OK/None 00-06-87-00-cf-f9 Domain1/MA01

>

The Status column indicates the condition of the connection.


Failed:
Continuity Check Messages (CCM) are not being received between end points.
RDI:
Remote end point is sending a Remote Defect Indication (RDI). This indicates a failure condition at
the far end (possibly a link down condition on the port).
OK:
CCMs have been received from the far end. Everything is OK.

Page 170
5.1.49 IEEE 802.1w Rapid Spanning Tree Protocol (RSTP)
The rstp command provides the ability to configure the parameters used by Rapid Spanning Tree Protocol.
The Rapid Spanning Tree Protocol (RSTP) is a network protocol that ensures a loop-free topology for any
bridged Ethernet local area network. The basic function of RSTP is to prevent network loops and provide
fast convergence after a topology change.
To configure Rapid Spanning Tree options, use the rstp command from the CLI prompt. A list of options
is displayed when the rstp -h command is entered.

> rstp -h

Description: Rapid Spanning Tree configuration


Format: rstp [-dall|-h [-ver]|-s] [-p port] [-maxage timeout]
[-hellotime time] [-fwddelay time] [-portpri portPriority]
[-pathcost value] [-aging ageTime] [-bridgepri bridgePriority]
Switches:
-aging set mac [ageTime] in sec: {10...630} default 300
-bridgepri set [bridgePriority]: {0...61440} in steps of 4096, default 32768
-dall delete all RSTP settings and restore defaults
-fwddelay forward delay [time] in sec to change port to forwarding: {4...30}
default 15
-h display help information
-hellotime the amount of [time] used between configuration messages: {1...5}
default 2
-maxage bridge maximum [timeout] sec: {6...40} default 20
-p [portNum] selected: {1...17,all}
-pathcost set port path cost [value]: {1...200,000,000} default 20000
-portpri set [portPriority]: {0...240} in steps of 16, default 128
-s show RSTP configuration
-ver verbose help

>

The options available using the rstp command are shown below.
The -aging switch defines the time period before the MAC addresses are removed from the table.
The -bridgepri switch defines the bridge priority ID for the port. The root bridge is the port with the lowest
bridge priority ID.
The -dall switch deletes all RSTP settings and restores factory defaults.
The -fwddelay switch defines the time before a port transitions to a forwarding state.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -hellotime switch defines the time period between hello-time Bridge Protocol Data Units (BPDUs).
The -maxage switch defines the time period before the port determines it has lost connectivity with its
direct neighbor.
The -p switch defines the port associated with spanning tree protocol.
The -pathcost switch defines the cost of the path. The path cost is based on the speed of the physical
interface speed.
The -portpri switch defines the priority of the port. The state of the port will be determined by the port
cost and port priority values.
The -s switch displays the current Rapid Spanning Tree configuration.
The -ver switch displays the extended help screen.

Page 171
Bridge Priority (-bridgepri):
The bridge with the lowest priority is elected as the root bridge for the domain. The Bridge Priority can
be modified in increments of 4096 from 0 to 61,440. The default Bridge Priority is 32,768.
Bridge Max Age Time (-maxage):
The amount of time a switch saves configuration BPDUs. A value from 6 - 40 seconds is valid. The
default Max Age Time is 20 seconds.
Hello Time (-hellotime):
The Root sends configuration BPDUs every 2 seconds. A value from 1 - 5 seconds is valid. The default
Hello Time is 2 seconds.
Forward Delay (-fwddelay):
The time interval for listening and learning states. A value from 4 - 30 seconds is valid. The default
Forward Delay is 15 seconds.
MAC Address Aging (-aging):
The time before the MAC address will be removed from the MAC table. A value from 10 - 630 seconds
is valid. The default MAC Aging Time is 300 seconds.
Port Priority (-portpri):
If two paths have the same port cost, the bridges must select a preferred path. Port Priority is used to
determine the preferred path. A value from 0 - 240, with 240 being the highest priority, is allowed. The
default Port Priority is 128.
Path Cost (-pathcost):
The cost of a port is typically based on port speed. The faster the port, the lower the port cost. See table
below. A value from 1 - 200,000,000 is valid. The default Path Cost is 20,000.
To configure port priority and path cost, use the -pathcost and -portpri commands.

> rstp -p 1 -pathcost 10000 -portpri 100

Spanning Tree Protocol uses path cost and port priority to determine the best path. The table below shows
the recommended path cost based on link speed.
Link Speed Recommended Value
10Mbps 2,000,000
100Mbps 200,000
1Gbps 20,000
10Gbps 2,000
100Gbps 200

Recommended Port Cost vs Link Speed


The port with the lowest path cost has the highest priority.

Page 172
To display spanning tree configuration, use the rstp -s command.

> rstp -s

Bridge Spanning Tree Global Configuration


============================================
UNI/NNI Bridge Id: 8000-00-06-87-01-e6-70
UNI/NNI Designated Root: 8000-00-06-87-01-e6-70
Bridge Priority: 32768
Bridge Max Age: 20
Hello Time: 2
Forward Delay: 15
MAC Address Aging Time: 300

Port 1 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 2 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 3 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 4 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 5 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 6 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 7 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Page 173
Port 8 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 9 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 10 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 11 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 12 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 13 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 14 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

Port 15 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 2000

Page 174
Port 16 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 2000

Port 17 Configuration
============================================
Rapid Spanning Tree Tunnel
RSTP Port State: N/A
Port Priority: 128
Path Cost: 20000

>

By default, Rapid Spanning Tree Protocol is tunneled. Use the l2cp command to change the way the
module handles the protocol.
5.1.50 Run a Script File (RUN)
The run command provides the ability to run a script file located on the module. The script file is a text file
with the .osf (Script File) extension. Use FTP to send the script file to the module. Once the file resides
on the module, use the run command to load the file.
To run a script file located on the module, use the run command from the CLI prompt. A list of options is
displayed when the run -h command is entered.

> run -h

Description: Executes a stored script file


Format: run [-h [-ver]]|[-l]|[-d scriptname.osf] | [-f scriptname.osf]
Switches:
-d delete script file, [scriptname.osf]
-f CLI script file name, [scriptname.osf]
-h display help information
-l list available script files
-ver verbose help

>

The options available using the run command are shown below.
The -d switch allows a script file to be deleted.
The -f switch defines the file name of the script file.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -l switch displays the available files on the module.
The -ver switch displays the extended help screen.

Page 175
To store a script file on the module, open a DOS command window and enter the following commands.
Bold lettering indicates information to be entered.
> ftp 192.168.1.220 (Enter the module’s IP address)
Connected to 192.168.1.220
220 You will be disconnected after 300 seconds of inactivity
User (192.168.1.220:(none)): admin (default login name)
331 User admin OK. Password required
Password: <enter ftp password> (from the protocol command configuration )
230 OK. Current directory is /flash
ftp> put <location and filename of the script file> <filename>.osf
200 OK
150-Connecting to 192.168.1.110:5028150
150 Ready to take file
226 File written successfully
ftp: 369 bytes sent in 0.00Seconds 369.00Kbytes/sec.
ftp>quit (exit FTP session)
221 Goodbye
The script file has been transferred to the module’s flash memory.
To display the available files on the module, use the run -l command.

> run -l

Available Script files


======================
<filename>.osf

>

To run a script file located on the module, use the run -f <filename>.osf command.
NOTE: The run command will only execute .osf files.

Page 176
5.1.51 Save (SAVE)
To save the changes when using the CLI, use the save command from the CLI prompt. A list of options is
displayed when the save -h command is entered.

> save -h

Description: Save configuration changes into permanent memory


Format: save [-h [-ver]|-s]
Switches:
-h display help information
-s show save status
-ver verbose help

>

The options available using the save command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -s switch displays the current state of the changes made to the module.
The -ver switch displays the extended help screen.
Use the save -s command to see if the recent changes have been made.

> save -s

Save status: some parameters have been changed and have not been stored into Permanent
memory

>

To save the changes, use the save command.

> save

> save -s

Save status: all parameters have been stored into Permanent memory

>

NOTE: If power is removed before the save command is initiated, the changes made with the CLI
will be lost.

Page 177
5.1.52 SFP Digital Diagnostic Information (SFP)
The sfp command displays the digital diagnostic information on the selected SFP port.
To display the digital diagnostic information, use the sfp command from the CLI prompt. A list of options
is displayed when the sfp -h command is entered.

> sfp -h

Description: Displays SFP port information


Format: sfp [-h [-ver]|-list|-s] [-p portNum]
Switches:
-h display help information
-list shows list of all SFP part numbers installed
-p [portNum] selected: {1...17}
-s shows the SFP information
-ver verbose help

>

The options available using the sfp command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -list switch lists the SFP transceivers installed in the module.
The -p switch selects the SFP port number.
The -s switch displays the current state of the changes made to the module.
The -ver switch displays the extended help screen.
To display the SFP transceivers installed in the module, use the sfp -list command.

> sfp -list

Port = 1: Omnitron, p/n 7207-1, s/n DB11100494


Port = 2: Omnitron, p/n 7207-1, s/n 8B24130005
Port = 3: Omnitron, p/n 7207-1, s/n 9903040177
Port = 4: Omnitron, p/n 7207-1, s/n 9C15060051
Port = 5: Omnitron, p/n 7207-1, s/n A528080377
Port = 6: Omnitron, p/n 7207-1, s/n C316260568
Port = 7: Omnitron, p/n 7206-0, s/n E703061880
Port = 8: Omnitron, p/n 7206-0, s/n E703061879
Port = 9: Omnitron, p/n 7206-0, s/n A319240115
Port = 10: Omnitron, p/n 7206-0, s/n AA25090411
Port = 11: Non-Omnitron pluggable, p/n LCP-1250RJ3SR-S, s/n 084504110227
Port = 12: Non-Omnitron pluggable, p/n LCP-1250RJ3SR-S, s/n 084504110228
Port = 15: Non-Omnitron pluggable, p/n FTLX8571D3BCL, s/n AS922E3
Port = 16: Non-Omnitron pluggable, p/n FTLX8571D3BCL, s/n AS91K8S

>

Page 178
To display the information for Port 1, use the sfp -p 15 -s command.

> sfp -s -p 15

Port = 15

Address A0 Page Contents


===================================================
00: 03 04 07 10 00 00 00 00 00 00 00 06 67 00 00 00 ............g...
10: 08 03 00 1E 46 49 4E 49 53 41 52 20 43 4F 52 50 ....FINISAR CORP
20: 2E 20 20 20 00 00 90 65 46 54 4C 58 38 35 37 31 . ...eFTLX8571
30: 44 33 42 43 4C 20 20 20 41 20 20 20 03 52 00 48 D3BCL A .R.H
40: 00 1A 00 00 41 53 39 32 32 45 33 20 20 20 20 20 ....AS922E3
50: 20 20 20 20 31 34 30 38 32 38 20 20 68 F0 03 B5 140828 h...
60: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
70: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
80: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
A0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
B0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
C0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
D0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
E0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
F0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................

Address A2 Page Contents


===================================================
00: 4E 00 F3 00 49 00 F8 00 90 88 71 48 8C A0 75 30 N...I.....qH..u0
10: 19 C8 07 D0 18 9C 09 C4 27 10 09 D0 1F 07 0C 5A ........’......Z
20: 27 10 00 64 1F 07 00 9E 00 00 00 00 00 00 00 00 ‘..d............
30: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
40: 00 00 00 00 3F 80 00 00 00 00 00 00 01 00 00 00 ....?...........
50: 01 00 00 00 01 00 00 00 01 00 00 00 00 00 00 1B ................
60: 21 29 81 56 0F 5A 17 CD 00 09 00 00 00 00 12 00 !).V.Z..........
70: 00 40 00 00 00 40 00 00 FF FF FF FF FF FF FF 01 .@...@..........
80: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
A0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
B0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
C0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
D0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
E0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
F0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................

Bit rate: 10300 Mbps


Vendor Name: FINISAR CORP.
Vendor Part Number: FTLX8571D3BCL
Vendor Serial Number: AS922E3
Date Code: 08/28/2014

Temperature: 33.2C
Vcc: -3.0v
Bias current: 7.0ma
Tx power: -2.2 dBm
Rx power: -30.5 dBm

>

Specific data has been decoded and displayed. All other data is displayed using hexadecimal values per
specification SFF-8472.

Page 179
5.1.53 Display the Common Configuration Parameters (SHOWCONFIG)
The showconfig command display the commonly configured parameters on the module. The parameters
that are displayed are: ver, ip, port, protocol, traphost, time, module, ethertype, evc, interface and bwp.
To display the parameters, use the showconfig command from the CLI prompt. A list of options is displayed
when the showconfig -h command is entered.
> showconfig -h

Description: Shows basic configuration information


Format: showconfig [-h [-ver]]|[-s]
Switches:
-h display help information
-s shows the standard configuration information
-ver verbose help

>

The options available using the showconfig command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -s switch displays the current state of the changes made to the module.
The -ver switch displays the extended help screen.
Use the showconfig -s command to display the configuration of the module.

Page 180
5.1.54 Simple Network Management Protocol (SNMP)
The snmp command provides the ability to configure the SNMP parameters on the module.
To configure the module to support Simple Network Management Protocol (SNMP), use the snmp command
from the CLI prompt. A list of options is displayed when the snmp -h command is entered.

> snmp -h

Description: SNMP Configuration


Format: snmp [-h [-ver]|-s] [-rdcomm pw] [-wrcomm pw] [-wr wrEn]
[-u1type uTyp] [-u1name uName] [-u1auth uPw] [-u1priv uPw] [-u1sec uSec]
[-u2type uTyp] [-u2name uName] [-u2auth uPw] [-u2priv uPw] [-u2sec uSec]
[-u3type uTyp] [-u3name uName] [-u3auth uPw] [-u3priv uPw] [-u3sec uSec]
[-u4type uTyp] [-u4name uName] [-u4auth uPw] [-u4priv uPw] [-u4sec uSec]
Switches:
-h display help information
-rdcomm set SNMPv1/2c read community name [pw], 1-32 ASCII characters
-s shows current SNMP settings
-u1auth set SNMPv3 user 1 authent password [uPw], 8-16 ASCII characters
-u1name set SNMPv3 user 1 name [uName], 1-32 ASCII characters
-u1priv set SNMPv3 user 1 privacy password [uPw], 8-16 ASCII characters
-u1sec set SNMPv3 user 1 security level [uSec]:
{noAuthNoPriv, authNoPriv, authPriv}
-u1type set SNMPv3 user 1 type [uTyp]: admin, deny, readonly, readwrite
-u2auth set SNMPv3 user 2 authent password [uPw], 8-16 ASCII characters
-u2name set SNMPv3 user 2 name [uName], 1-32 ASCII characters
-u2priv set SNMPv3 user 2 privacy password [uPw], 8-16 ASCII characters
-u2sec set SNMPv3 user 2 security level [uSec]:
{noAuthNoPriv, authNoPriv, authPriv}
-u2type set SNMPv3 user 2 type [uTyp]: admin, deny, readonly, readwrite
-u3auth set SNMPv3 user 3 authent password [uPw], 8-16 ASCII characters
-u3name set SNMPv3 user 3 name [uName], 1-32 ASCII characters
-u3priv set SNMPv3 user 3 privacy password [uPw], 8-16 ASCII characters
-u3sec set SNMPv3 user 3 security level [uSec]:
{noAuthNoPriv, authNoPriv, authPriv}
-u3type set SNMPv3 user 3 type [uTyp]: admin, deny, readonly, readwrite
-u4auth set SNMPv3 user 4 authent password [uPw], 8-16 ASCII characters
-u4name set SNMPv3 user 4 name [uName], 1-32 ASCII characters
-u4priv set SNMPv3 user 4 privacy password [uPw], 8-16 ASCII characters
-u4sec set SNMPv3 user 4 security level [uSec]:
{noAuthNoPriv, authNoPriv, authPriv}
-u4type set SNMPv3 user 4 type [uTyp]: admin, deny, readonly, readwrite
-ver verbose help
-wr set SNMP write enable [wren]: {ena|dis}, default enabled
-wrcomm set SNMPv1/2c write community name [pw], 1-32 ASCII characters

>

The options available using the snmp command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -rdcomm switch configures the SNMPv1/2c read community name. The SNMP Read Community Name
is necessary for reading (get) data from the module. The name can be any 1-32 alphanumeric character
string. The default setting is public.
The -s switch displays the SNMP configuration parameters.
The -u1auth switch configures the SNMPv3 authentication password for User 1. Authentication password
can be any 8-16 alphanumeric character string. The default setting is publicguest.

Page 181
The -u1name switch configures the SNMPv3 user name for User 1. The username can be any 1-16
alphanumeric character string. The default setting is guest.
The -u1priv switch configures the SNMPv3 privacy password for User 1. Privacy password can be any
8-16 alphanumeric character string. The default setting is publicguest.
The -u1sec switch configures the SNMPv3 security level for User 1. The module supports the three security
levels: noAuthNoPriv, authNoPriv and authPriv. noAuthNoPriv allows access without authentication and
without privacy. authNoPriv allows access with authentication, but without privacy. authPriv allows access
with authentication and with privacy. Authentication and privacy uses different algorithms for encrypting
and decrypting SNMPv3 packets. The default setting is noAuthNoPriv.
The -u1type switch configures the SNMPv3 user type for User 1. Each user name can be configured as:
admin, read-write, read-only or deny. An admin user has full read/write privileges including user name
and password changes. A read-write user has full read/write privileges with the exception of user name
and password operations. A read-only user can only view the configuration of the module and will not be
allowed to make any changes. A deny user does not have any access to the module. The default setting
is read-only.
NOTE: User 1 account is used when sending SNMPv3 traps.
The -u2auth switch configures the SNMPv3 authentication password for User 2. Authentication password
can be any 8-16 alphanumeric character string. The default setting is privateadmin.
The -u2name switch configures the SNMPv3 user name for User 2. The username can be any 1-16
alphanumeric character string. The default setting is admin.
The -u2priv switch configures the SNMPv3 privacy password for User 2. Privacy password can be any
8-16 alphanumeric character string. The default setting is privateadmin.
The -u2sec switch configures the SNMPv3 security level for User 2. The module supports the three security
levels: noAuthNoPriv, authNoPriv and authPriv. The default setting is noAuthNoPriv.
The -u2type switch configures the SNMPv3 user type for User 2. Each user name can be configured as:
admin, read-write, read-only or deny. The default setting is admin.
The -u3auth switch configures the SNMPv3 authentication password for User3 . Authentication password
can be any 8-16 alphanumeric character string. The default setting is publicguest.
The -u3name switch configures the SNMPv3 user name for User 3. The username can be any 1-16
alphanumeric character string. The default setting is guest1.
The -u3priv switch configures the SNMPv3 privacy password for User 3. Privacy password can be any
8-16 alphanumeric character string. The default setting is publicguest.
The -u3sec switch configures the SNMPv3 security level for User 3. The module supports the three security
levels: noAuthNoPriv, authNoPriv and authPriv. The default setting is noAuthNoPriv.
The -u3type switch configures the SNMPv3 user type for User 3. Each user name can be configured as:
admin, read-write, read-only or deny. The default setting is deny.
he -u4auth switch configures the SNMPv3 authentication password for User 4. Authentication password
can be any 8-16 alphanumeric character string. The default setting is publicguest.
The -u4name switch configures the SNMPv3 user name for User 4. The username can be any 1-16
alphanumeric character string. The default setting is guest2.
The -u4priv switch configures the SNMPv3 privacy password for User 4. Privacy password can be any
8-16 alphanumeric character string. The default setting is publicguest.
The -u4sec switch configures the SNMPv3 security level for User 4. The module supports the three security
levels: noAuthNoPriv, authNoPriv and authPriv. The default setting is noAuthNoPriv.

Page 182
The -u4type switch configures the SNMPv3 user type for User 4. Each user name can be configured as:
admin, read-write, read-only or deny. The default setting is deny.
The -ver switch displays extended help.
The -wr switch configures the slave writes function. Slave Writes provides the ability to change configuration
settings on the module when the module is not the chassis master and the module is directly accessed
through the Menu-Driven Interface or SNMP. The default setting is disabled.
The -wrcomm switch configures the SNMPv1/2c write community name. The SNMP Write Community
Name is necessary for writing (set) data to the module. The name can be any 1-32 alphanumeric character
string. The default setting is public.
To display the current configuration, use the snmp -s command.

> snmp -s

Read Community Name *****


Write Community Name *****
SNMP writes enabled

User 1 type read-only


User 1 name guest
User 1 Security level noAuthNoPriv
User 1 Authentication password *****
User 1 Privacy password *****

User 2 type admin


User 2 name admin
User 2 Security level noAuthNoPriv
User 2 Authentication password *****
User 2 Privacy password *****

User 3 type deny


User 3 name guest1
User 3 Security level noAuthNoPriv
User 3 Authentication password *****
User 3 Privacy password *****

User 4 type deny


User 4 name guest2
User 4 Security level noAuthNoPriv
User 4 Authentication password *****
User 4 Privacy password *****

>

To configure SNMPv3 User 1 login credentials, use the following commands.

> snmp -u1auth 12345 -u1name JSmith -u1priv 67890 -u1sec authNoPriv -u1type admin

Page 183
5.1.55 Simple Network Time Protocol (SNTP)
The sntp command provides the ability to configure the module to request the time and day from a SNTP
server.
To configure the module to support Simple Network Time Protocol (SNTP), use the sntp command from
the CLI prompt. A list of options is displayed when the sntp -h command is entered.

> sntp -h

Description: SNTP protocol configuration


Format: sntp [-dall|-h [-ver]|-s] [-ena|-dis] [-i interval] [-z zoneVal]
[-ip1 serverNumIP] [-ip2 serverNumIP]
Switches:
-dall delete all SNTP settings and restore defaults
-dis disable SNTP on the module
-ena enable SNTP on the module
-h display help information
-i time server requested every [interval] minutes: {1...60}
-ip1 time server IP address 1, [serverNumIP]
-ip2 time server IP address 2, [serverNumIP]
-s show SNTP configuration
-ver verbose help
-z set the time [zoneVal]

To get help screen on time zone values type “zone -h”

>

The options available using the sntp command are shown below.
The -dall switch deletes all settings and restores factory defaults.
The -dis and -ena switches disable or enable SNTP on the module.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -i switch defines the time interval between SNTP requests.
The -ip1 and -ip2 switches define the IP addresses of the SNTP servers.
The -s switch displays the SNTP configuration.
The -ver switch displays the extended help screen.
The -z switch defines the time zone.
To enable SNTP services and assign the SNTP server IP address, use the -ena and -ip1 commands.

> sntp -ena -ip1 192.168.1.240

To display the SNTP configuration, use the sntp -s command.

> sntp -s

SNTP service is enabled, query interval is 5 minutes


Time zone PST (Pacific Standard Time)
SNTP server 1 IP is 192.168.1.240
SNTP server 2 is 255.255.255.255 (not configured)

>

Page 184
5.1.56 Secure Shell Protocol (SSH)
Secure Shell (SSH) protocol provides authentication, encryption, and the integrity of data transmitted over
a network. SSH uses public-key cryptography to authenticate the remote devices and allows the remote
device to authenticate the user. The module supports SSH Version 2.
To configure SSH, use the ssh command from the CLI prompt. A list of options is displayed when the
ssh -h command is entered.

> ssh -h

Description: Secure shell configuration


Format: ssh [{-h|-s} [-ver]] [{-dis|-ena} {dsa|pwd|rsa|sftp|ssh}]
[-ato timeout] [-aretry count] [-kfn username,filename] [-lto timeout]
[-sto timeout] [-tcp tport] [-generatekeys] [-dall]
Switches:
-aretry set the number of authentication retries [count]: {1..5}, default 5
-ato set the authentication [timeout]: {0..300}, default 300 sec
-dall delete all SSH configuration settings and restore defaults
-dis disable function: {dsa|pwd|rsa|sftp|ssh}
-ena enable function: {dsa|pwd|rsa|sftp|ssh}, default all enabled
[dsa] DSA key authentication
[pwd] plain text password entry authentication
[rsa] RSA key authentication
[sftp] secure file transfer protocol (scp V2)
[ssh] secure shell protocol
-generatekeys regenerates the public/private keys
-h display help information
-kfn set the key file name [filename] for [username] to use
-lto set the lockout timeout value: {1..300}, default is 300 sec
-s show current configuration
-sto set session timeout value: {0..3600}, default is 300 sec
-tcp set the tcp port [tport], default 22
-ver verbose help or show public keys

>

The options available using the ssh command are shown below.
The -aretry switch defines the number of authentication attempts that a client is allowed to make before
authentication lockout.
The -ato switch defines the time allowed for the completion of an authentication attempt.
The -dall switch deletes all SSH configuration and restores the factory defaults.
The -dis and -ena switches disable or enable specific authentication methods and file transfer functions.
The -generatekeys switch generates the public/private key pair. It takes time to generate the public and
private keys. Please be patient when using this command.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -kfn switch defines the username and filename for a specific user.
The -lto switch defines how long the function will be locked out once in authentication lockout.
The -s switch displays the current configuration.
The -sto switch defines the session lockout value.
The -tcp switch defines the TCP port used for the SSH session.
The -ver switch displays the extended help or show status screens.

Page 185
The SSH function supports password (plain text) and public key authentication methods. Password is plain
text entered in the client application. RSA is a public key generated via the Rivest, Shamir and Adleman
algorithm and DSA is a public key generated via the Digital Signature Algorithm.
The default username is admin and the default password is public.
NOTE: SSH and Telnet share the same password. To change the SSH password, use the protocol
command.
To enable SSH, and set TCP Port 23, use the -ena and -tcp commands.

> ssh -ena ssh -tcp 23

To regenerate the public and private keys, use the -generatekeys command.

> ssh -generatekeys

NOTE: It takes time to generate the public and private keys. Please be patient when using this
command.
To display the SSH configuration, use the ssh -s command.

> ssh -s

Secure Shell (SSH) v2: enabled


RSA Fingerprint:
9e:41:15:99:0a:4b:df:17:94:cb:9a:97:ee:d8:7d:51
DSA Fingerprint:
7f:f7:b5:90:e5:55:b7:08:b6:24:66:6a:b4:27:49:10
TCP port number: 22
SFTP: enabled
Password (plain text) authentication: enabled
RSA authentication: enabled
DSA authentication: enabled
Authentication retries: 5
Authentication timeout: 300s
Session timeout: 300s
Lockout timeout: 300s
Keyfile name:
user “admin” file “admin_id.pub”
Session status:

>

Page 186
To display the public key configuration, use the ssh -s -ver command.

> ssh -s -ver

RSA public key:


AAAAB3NzaC1yc2EAAAADAQABAAAAgQCYGPutF+Y/XvalRw6YvGL9ksnFcBznVGKY/ZcV6GBN
cYYpRb6a/ugQGrFTpG3AkVrO6jcUSPy9+MhSg8npofyUrpUAxMKVDcc1O3hRIlNbnzd6rSEa
5O8evJsj+qkTFKQmIdy4BWWLAVHVlHN2S30n9R5sn62lwTR2oz70uXXmJw==

DSA public key:


AAAAB3NzaC1kc3MAAACBAK+DS/27Tyv0Q37AYKeCS7lrzCf+S+evk/rSsQgeYrAnfda1zIJH
9gvf2m0AwD+YQ5KQnmBTDK7D130Vn9JjTIN0sP+YKN15+A10fsXFAzn8oOgp2Sc3xli8Up0F
ffapQLE32REbSWHEdyT2kl2Ydb0eRnoYxGWykvEs2zJ31AQ1AAAAFQChYaiCm/BQseQh/rSB
sdXDli/NJwAAAIB17GW/im8vpdjtcyTKs05ivxaZh//cHoir2vMXX0eZzueOufYUKcOb/YMz
9jMm0A9MFmCWIwGebosMXMECGQdlFahIS8GfkY2L0uimBgqHPeL++s+yCh3tqMRhh7verGeg
te6xvvb0oyMG0qkcM6KsHhuMsLiYtXoQULz+ys4hhQAAAIAkOkbACq3HcOjIwlT/yCx6L7RJ
HukxBS7p58m2hpdoSNxgYaPexO8M3SGnNjV6hn6zCAoI/MFcjqe+ZiJkNurh4rooQ/qM7Amg
nw4ZMoliZihP7L9odsHUHSXrPCsQPNCnRyqQpepWnw+tyhIHwuTv8IA8U6joPxRvs9lAx3mV
TQ==

>

5.1.57 ITU-T G.8262 Synchronous Ethernet (SYNCE)


Synchronous Ethernet is a physical layer synchronization implementation for packet networks requiring
frequency synchronization.
The synce command provides the ability to configure a port for ITU-T G.8262 Synchronous Ethernet
operation.
To configure Synchronous Ethernet, use the synce command from the CLI prompt. A list of options is
displayed when the synce -h command is entered.

> synce -h

Description: Configure a port to operate in synchronous Ethernet mode


Format: synce [-h [-ver]|-s] [-mo cmode[,portNum]]
Switches:
-h display help information
-mo clock mode [cmode[,portNum]]:
[cmode] clock mode: {internal|extracted]; default [internal]
[portNum]: {1...17} port number when [extracted] selected
-s current configuration and status
-ver verbose help

>

The options available using the synce command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -mo switch selects the clock mode and port number to be used for port synchronization. The clock
mode can be internal (free running oscillator on the module) or extracted (extracted clock from the selected
Ethernet port). The default clock mode is internal.
The -s switch displays the configuration and status.
The -ver switch displays the extended help screen.

Page 187
To configure Port 1 for extracted clock mode, use the synce -mo extracted,1 command.

> synce -mo extracted,1

To display the SyncE configuration, use the synce -s command.

> synce -s

Using extracted clock from Port 1

>

5.1.58 Syslog Server Configuration (SYSLOG)


Syslog is a standard for message logging per RFC 5424. It is used to manage system logs and alerts.
To configure syslog, use the syslog command from the CLI prompt. A list of options is displayed when
the syslog -h command is entered.

> syslog -h

Description: Syslog Server Configuration and Log Access


Format: syslog [-h [-ver]|-s [-log lnum]]
[-ena|-dis] [-ip serverNumIP] [-erase] [-level slevel]
[-test slevel:message]
Switches:
-erase erase all current syslog local entries
-dis disable syslog on the module, default
-ena enable syslog on the module
-h display help information
-ip syslog server IP address, [serverNumIP], default 192.168.1.221
-level set the min level for syslog entries, [slevel]:
{alert,critical,debug,emergency,error,info,notice,warning}, default info
-log shows the last [lnum] local entries: {1..1000|all], default 10
-s show syslog configuration and current syslog entries
-test generate test syslog entry: [slevel] with [message]
-ver verbose help

>

The options available using the syslog command are shown below.
The -erase switch erases all the entries in the current syslog.
The -dis switch disables the syslog functionality.
The -ena switch enables the syslog functionality. This includes writing to the syslog server.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -ip switch configures the syslog server IP address.
The -level switch selects the syslog minimum severity error for logging errors.
The -log switch displays specific number of syslog entries. The default value is 10.
The -s switch displays the syslog configuration and the last 10 entries.
The -test switch generates a test syslog entry for a specific severity and a specific message.
The -ver switch displays the extended help screen.

Page 188
To display the syslog configuration and last 10 entries, use the syslog -s command.

> syslog -s

Status: enabled
Server IP address: 192.168.1.221
Severity logging level: informational
Number of local entries: 62

Number of entries:
Debug : 0
Info : 62
Notice : 0
Warning : 0
Error : 0
Critical : 0
Alert : 0
Emergency: 0
All : 62

ID Level Time Message


---------- -------- ---------------------- -------
62 Info 01/01/2000 07:01:24 PM Serial session started
61 Info 01/01/2000 07:01:24 PM Serial start set alarm
60 Info 01/01/2000 06:36:15 PM Serial session stopped
59 Info 01/01/2000 06:36:14 PM Serial stop clear alarm
58 Info 01/01/2000 06:28:57 PM Serial session started
57 Info 01/01/2000 06:28:57 PM Serial start set alarm
56 Info 01/01/2000 04:18:29 AM Serial session stopped
55 Info 01/01/2000 04:18:28 AM Serial stop clear alarm
54 Info 01/01/2000 04:13:18 AM Serial session started
53 Info 01/01/2000 04:13:18 AM Serial start set alarm

>

To configure the IP address of the syslog server, use the syslog -ip command.

> syslog -ip 192.168.1.100

Page 189
5.1.59 Ethernet Service Testing
5.1.59.1 Overview
Ethernet connections must be tested to ensure that they are operating correctly and performing to the required
levels. RFC 2544 specifies certain test criteria that allows Ethernet connections to validate operation and
service level agreements. RFC 2544 performs specific tests using standard frame sizes (64, 128, 256, 512,
1024, 1280 and 1518 bytes).
ITU-T Y.1564 is a Carrier Ethernet service activation test methodology for turning up, installing and
troubleshooting Ethernet-based services. The test methodology allows for complete validation of Ethernet
Service Level Agreements (SLAs) in a single test.
ITU-T Y.1564 defines test streams with specific attributes identified by different classifiers such as 802.1Q
VLAN, 802.1ad and Class of Service (CoS) profiles.
5.1.59.2 Third-Party Test Equipment
The module can be configured to respond to inband loop-up and loop-down commands from third party test
equipment, such as JDSU and VeEX. Configure the remote module using the testresp -remote command.
See Section 5.1.59.4 for configuration examples.
5.1.59.3 Built-in Test Initiator (TESTINIT)
The testinit command configures the built-in test-head to generate RFC 2544 and/or Y.1564 test measurements
traffic to a Test Responder module. The built-in test-head or Test Initiator will generate frames based on
the user-defined configuration. The Responder module receives the frames and loops the traffic back to
the Test Initiator.
RFC 2544 Test Initiator uses the -typ throughput/latency/loss/back commands to configure the built-in
test-head.. The Y.1564 Test Initiator uses the -typ service command to configure the built-in test-head.
NOTE: During a power cycle or reboot, testinit and testresp commands will need to be re-entered.
The testinit and testresp commands are not saved.

Page 190
To configure the module as a test initiator, use the testinit option from the CLI prompt. A list of options is
displayed when the testinit -h command is entered.

> testinit -h

Description: Configures and displays the results of the Test Initiator


Format: testinit [-a|-d|-dall|-h[-ver]|-s] [-p portNum] [-pn profileName] [-pi pindex|all]
[-ena|-dis {monitor|test}] [-clr] [-e evcName {-cn cName} |
-bn bname | {-n dName | -l dLevel | -ni dindex }
{-o maName | -oi mindex }] [-pri pbit] [-v evcVid]
{-mac macAddr | -mep mepid} [-pdu ptype]
[-typ ttype] [-r fcnt | -t tsec] [-frt frate | -bit brate | -rp prate
| -srate] [-fsz fsizemin[,fsizemaxm,fincr] | -fst | -fmx
fsize1,..fsize8] [-trial tnum] {-flr fratio | -flc nframes}
[-pe portNum] [-decr dval] [-restart] [-btype btypesel]
[-ipdst ipAddr] [-ipsrc ipAddr] [-fd ftime] [-remote rpro] [-fty fixed|binary]
[-fdv ftime] [-cir100] [-useeir] [-usepol on|off] [-perf] [-dists]
[-dat {ones|prbs|zeros}[,crc]]
Switches:
-a add test instance
-avail acceptable availability percent, [aavail]: {0.0...100.0}, default 50.0
-bit number of bits per seconds, [brate]: {25000...10000000000}, default=max
-bn bandwidth profile identifier name [bName], 1-45 ASCII characters
-btype bit rate selection type, [btypesel}: {L1,L2,L3}, default L1
-cir100 run the A.1 test. The default is to run the A.2 test
-clr clears specific test instance data
-cn class of service identifier name [cName], 1-45 ASCII characters
-d deletes test instance
-dall deletes all configured test instances
-dat selects data payload value: {ones|prbs|zeros}[,crc]
[ones] selects a payload that is filled with ones
[prbs] selects PRBS 2^-31 data pattern
[zeros] selects a payload that is filled with zeros, default
[crc] selects whether the last four bytes of the payload includes a CRC
-decr failure decrement step size [dval]: {1-100}, default 10
-dists turns off insertion of timestamp into Test/Data TLV
-dis disable function: {monitor|test}
-ena enable function: {monitor|test}
[monitor] selects test monitor function, default enabled
[test] test instance, default enabled
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-etype selects the data ethertype, [eval], default 0x9001
-fd acceptable frame delay, [ftime]: {1..1000000} us, default 100000
-fdv acceptable frame delay variation, [ftime]: {1..1000000} us, default 100000
-flc acceptable frame loss count, [nframes]: {0...65535}, default 10
-flr acceptable frame loss ratio percent, [fratio]: {0.000...100.000}
-fmx selects a mixed list of 1-8 frame sizes: {fsize1,..,fsize8}
-frt number of frames per second, [frate]: {10...14880952}
-fst selects standard frame sizes of 64, 128, 256, 512, 1024, 1280, 1518
-fsz selects test instance frame size range
[fsizemin] starting frame size: {64...10056}, default 64
[fsizemax] maximum frame size: {64...10056, must be >= fsizemin
if no ending size is selected only a single size is tested
[fincr] frame size increment value, multiple of 4, default is 4
-fty selects failure mechanism decrement type: {fixed|binary}
-h display help information
-ipdst selects the IP destination address, [ipAddr]
-ipsrc selects the IP source address, [ipAddr]
-l maintenance domain level, [dLevel]: {0...7}
-mac destination MAC Address, [macAddr]: {xx-xx-xx-xx-xx-xx}
default 00-00-00-00-00-01
-mep destination mep ID, [mepid], unique within a MA: {1...8191}

Page 191
-n defines domain name, [dName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p source [portNum] selected: {1...17}
-pdu test instance pdu type, [ptype]: {L2|L3|lbm|tst}
[L2] indicates standard layer 2 frame type, default
[L3] indicates standard layer 3 frame type
[lbm] indicates standard CFM frame type, needs md/ma/mep defined
[tst] indicates standard Y.1731 frame type, needs md/ma/mep defined
-pe egress [portNum]: {1...17}, default same as source port
-perf selects the service performance test. Default is the service config test
-pi test instance profile index [pindex]: {1..16} or [all] profiles
-pn defines [profileName], 1-45 ASCII characters
-pri selects frame priority bit, [pbit], default is 0
-r number of frames, [fcnt], to send: {0...2^32-1}, 0=no end
-remote remote protocol, [rpro]: {jdsu|twamp|veex}
[jdsu] indicates proprietary JDSU protocol
[twamp]indicates standard TWAMP protocol
[veex] indicates proprietary VeEX protocol
-restart restarts the indicated test instance
-rp rate in percentage of interface speed, [prate}: {0.001...100.000}
-s show current configuration
-srate selects the configured service rate of CIR/EIR and CBS/EBS
-t time in seconds [tsec] to run: {0...2^32-1}, 0=no end, 10=default
-trial number of trials, [tnum], for a particular test instance: {1..65535}
-typ test instance type, [ttype]:
[throughput] RFC 2544 throughput test
[latency] RFC 2544 latency test
[loss] RFC 2544 loss test, default
[back] RFC 2544 back-to-back test
[service] ITU-T Y.1564 service activation test
-useeir uses the EIR when running the CIR test
-usepol uses the policers before traffic generation: {on|off}
[on] uses policers before traffic generation, default
[off] policers are not used
-v [evcVid] associated with the test instance: {0...4095}
-ver verbose help

>

The options available using the testinit command are shown below.
The -a switch adds a test instance to the port, EVC, EVC+CoS, or MEP.
The -avail switch configures the acceptable availability for 1564 test.
The -bit switch defines the frequency the test PDUs are generated. -bit switch defines the bit rate.
The -bn switch indicates the specific test instance is associated with a bandwidth profile. -bn identifies the
bandwidth profile name.
The -btype switch defines how the bit rate will be determined: Layer 1, Layer 2 or Layer 3.
The -cir100 switch runs the 1564 A.1 test only. If not specified, the 1564 A.2 test is ran.
The -clr switch clears the test results.
The -cn switch associates the test instance with a class of service profile, defined using the cos command.
The -d switch deletes a test instance using the test instance name or identifier.
The -dall switch deletes all test instances.
The -dat switch selects the payload type: all zeros (default), all ones, or PRBS, all with or without a CRC.

Page 192
The -decr switch indicates the change in percentage on the amount of traffic sent during a test. During
a test, the amount of traffic sent is increased or decreased by the percentage value to find the maximum
throughput the module can pass (increasing or decreasing the percentage value is based on passing or failing
the present percentage value). The entered value is in percent of the initial rate.
The -dists switch turns off insertion of the timestamp for Data/Test TLVs. This is needed for one-way
measurements.
The -dis and -ena switches disable or enable specific functions or test instances.
The -e switch associates the test instance with an EVC.
The -etype switch configures the ethertype for the test instance. The default is 0x9001.
The -fd switch defines the acceptable frame delay.
The -fdv switch defines the acceptable frame delay variation.
The -flc and -flr switches define the number of errors before a failure condition is declared during a test.
-flr switch displays the errors in percentages, and the -flc switch displays the errors in number of frames.
The -frt switch defines the frame rate.
The -fmx, -fst and -fsz switches define the PDU frame sizes for the test instance. -fsz switch defines a range
of frame sizes, the -fst switch selects the standard seven frame sizes of 64, 128, 256, 512, 1024, 1280, and
1518, and -fmx switch allows the selection of up to 8 individual frame sizes.
The -fty switch indicates how the test will increment or decrement the throughput traffic levels to find the
maximum amount of traffic the module can pass (increasing or decreasing the percentage value is based on
passing or failing the present percentage value). A failure condition is defined by the -flr or -flc switches.
fixed indicates the increment or decrement value will be defined by the -decr switch.
binary indicates the percentage value is decreased or increased by 50% of the previous value but will
not continue if the percentage change is less then the -decr switch when the test fails.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -ipdst switch defines the destination IP address used when a L3 test is selected.
The -ipsrc switch defines the source IP address used when a L3 test is selected.
The -l, -n, and -ni switches associate a specific test instance with a maintenance domain.
The -mac switch associates the test instance with a specific unicast destination address and frames received
from the destination MAC address are ignored.
The -mep switch associates the test instance with a specific MEP ID.
The -o and -oi switches associate a specific test instance with a maintenance association.
The -p switch defines the initiating port. The combination of -p and -pe switches defines the logical starting
point of the test frames (-p) and the egress point of the test frame (-pe). This allows a test instance to be
defined on a UNI port and able to egress a NNI port double tagged.
The -pdu switch defines the type of test frame PDU.
The -pe switch defines the egress port where the test PDUs are generated. The initiating port is set via the
-p switch.
The -perf switch indicates the service performance test will be initiated. Without this switch the service
configuration test will be initiated.
The -pi or -pn switches identify (-pi) or name (-pn) a specific test profile.
The -pri switch associates the selected VLAN priority bits with a specific test instance.

Page 193
The -r switch defines the number of frames to send in a test; 0=unlimited.
The -remote switch indicates the communication protocol used with the remote partner.
jdsu indicates the JDSU proprietary loop up/down protocol will be used.
twamp indicates the TWAMP proprietary loop up/down protocol will be used
veex indicates the VeEx proprietary loop up/down protocol will be used.
The -restart switch restarts the selected tests by first clearing the current completed history information
and then starting the configured and selected tests.
The -rp switch defines the rate of the interface speed as a percentage.
The -s switch displays the current tests and results.
The -srate switch defines the configured service rate of CIR/EIR and CBS/EBS.
The -t switch defines the amount of time to run a test in seconds, 0=forever.
The -trial switch selects the number of trials to run for a particular test, size, rate and time.
The -typ switch configures the type of test: throughput, latency, loss, back to back and Y.1564.
The -useeir switch indicates the 1564 A.1/A.2 test will be initiated with EIR if CIR=0.
The -usepol switch indicates the rate-limiting policers will be used in the test.
The -v switch associates a test instance with a specific VLAN ID specified by an EVC (-e switch).
The -ver switch displays the extended help screen.
A test instance can be added to a port, EVC, EVC with CoS or Maintenance End Point (MEP). If a test
instance is defined on a port, a second test instance using an EVC or MEP will not be allowed. If a test
instance is defined on a EVC, a second test instance using port only will not be allowed.
NOTE: A test responder (testresp) module must be configured before a test can be initiated.
The example below creates a frame loss test instance on Port 1.

> testinit -a -p 1 -pe 15 -pn test -mac 00-06-87-00-cf-f9 -e E2

The command creates an initiator instance on Port 1 to a destination MAC address of 00-06-87-00-cf-f9
using test as the instance name. The default measurement type is: frame loss with a frame size of 64 bytes.

Page 194
Verify the test results by using the testinit -s command.

> testinit -s

Product: XM5
Firmware version: vx.x.xx, serial number: 710388, FPGA: vx.xx 03/26/2014 15:54:14
Date & Time: 01/01/1970 01:28:12 PM Pacific Standard Time (sysUpTime: 7729200)
Globals: Test Generator enabled, Test Monitor enabled

--- Test Initiator Instance #1 -----------------------------------------------


Test Name: Test, Source Port 1, Destination Port 15
Test Generator enabled, Test Monitor enabled, Out-of-Service
Test Status: Test iteration active for 4s
Test Type: 2544 Frame Loss
Frame sizes: 64
Acceptable frame loss: 10 frames/trial, fixed search (10%)
Number of trials: 1; test duration: 10s
Data payload: zeros
Test Association: EVC (ethertype 9001)
EVC name “E2” (VID 1000), PCP value 0, use policer:on
Test Partner: MAC 00-00-00-00-00-01
Remote Protocol: None
Initial Line Rate: 1,000,000,000 bits/sec (L1 rate calculation type)

Trial/ Frame -----Configured----- Transmit Receive Frame Frames Test


Iter Size (fps) (mbps) % Count Count Loss % Lost Status
*******************************************************************************
1/1 64 1488095 761.9 100 14880950 14880952 0.000 0 PASS

>

Delete the test instance by using the testinit -d command.

> testinit -d -pn test1

The example below creates a frame loss test instance on Port 1 using the standard frame sizes.

> testinit -a -p 1 -pe 15 -pn test1 -mac 00-06-87-00-cf-f9 -e E2 -fst

The example below creates a latency test instance on Port 1.

> testinit -a -p 1 -pe 15 -pn test1 -mac 00-06-87-00-cf-f9 -e E2 -typ latency

The example below creates a throughput test instance on Port 1.

> testinit -a -p 1 -pe 15 -pn test1 -mac 00-06-87-00-cf-f9 -e E2 -typ throughput

The example below creates a back-to-back test instance on Port 1.

> testinit -a -p 1 -pe 15 -pn test1 -mac 00-06-87-00-cf-f9 -e E2 -typ back

The example below creates a frame loss measurement to remote MEP 332.

> testinit -a -p 1 -pe 15 -pn test1 -e EVC1 -l 3 -pdu lbm -mep 332

Page 195
The example below creates a Y.1731 ETH-Test latency measurement to remote MEP 200.

> testinit -a -p 1 -pe 15 -pn test1 -n Domain -o MA00 -pdu tst -typ latency -mep 332

The example below creates a Y.1564 test instance on Port 2.

> testinit -a -p 2 -pe 15 -e EVC1 -pn test1 -typ service -mac 00-00-00-00-00-01

NOTE: A bandwidth profile must be defined on Port 2.


The example below restarts the test instance called test1.

> testinit -restart -pn test1

5.1.59.4 Test Responder (TESTRESP)


The testresp command configures the module to respond to RFC 2544, Y.1564 test measurements from the
Test Initiator module or 3rd party protocols (JDSU, VeEx and TWAMP).
The Test Initiator will generate frames based on the user-defined configuration. The Responder module
receives the frames and loops the traffic back to the Test Initiator.
The 3rd party test equipment will issue inband loop up and loop down commands that will be received by the
Responder module. When a loop up command is received, the port or EVC will loop all traffic back to the
test equipment. When a loop down command is received, the port or EVC will return to normal operation.
NOTE: During a power cycle or reboot, testinit and testresp commands will need to be re-entered.
The testinit and testresp commands are not saved.

Page 196
To enable responder mode, use the testresp option from the CLI prompt. A list of options is displayed when
the testresp -h command is entered.

> testresp -h

Description: Configures and displays the results of the Test Responder


Format: testresp [-a|-d|-dall|-h [-ver]|-s] [-p portNum] [-pn profileName]
[-pi pindex|all] [-clr] [-ena|-dis {mcast|monitor|reflect}]
[-po | -e evcName [-cn cName] | {-n dName | -l dLevel | -ni dindex }
{-o maName | -oi mindex} ] {-mac macAddr | -mep mepid}] [-rty rtype]
[-pe portNum] {-v evcVid} [-remote rpro] [-lmac] [-ipsrc ipAddr]
[-ipdest ipAddr] [-etype eval]
Switches:
-a add test instance
-clr clears specific test instance data
-cn class of service identifier name [cName], 1-45 ASCII characters
-d deletes test instance
-dall delete all test instances settings and restore defaults
-dis disable function: {mcast|monitor|reflect}
-ena enable function: {mcast|monitor|reflect}
[mcast] sets source MAC substitution for multicast, default disabled
[monitor] selects test monitor function, default enabled
[reflect] selects test reflector function, default enabled
-e [evcName] associated with the primary vlan id, 1-45 ASCII characters
-etype selects the data ethertype, [eval], default 0x9001
-h display help information
-ipdst selects the IP destination address, [ipAddr]
-ipsrc selects the IP source address, [ipAddr]
-l maintenance domain level, [dLevel]: {0...7}
-lmac frames received must match local module’s MAC address
-mac source MAC Address, [macAddr]: {xx-xx-xx-xx-xx-xx}
-mep source mep ID, [mepid], unique within a MA: {1...8191}
-n defines domain name, [dName], 1-43 ASCII characters
-ni domain name index, [dindex], for the md table
-o short maintenance association name,[maName], 1-45 ASCII characters
-oi short maintenance name index,[mindex], for the ma table
-p responding [portNum] selected: {1...17}
-pe egress [portNum]: {1...17}, default same as responding port
-pi test instance profile index [pindex]: {1..16} or [all] profiles
-pn defines [profileName], 1-45 ASCII characters
-po test instance associated with port
-remote remote protocol, [rpro]: {jdsu|twamp|veex}
[jdsu] indicates proprietary JDSU protocol
[twamp] indicates standard TWAMP protocol
[veex] indicates proprietary VeEX protocol
-rty reply type, [rtype]: {lbr|loop|macswap|tst}
[lbr] indicates an LBR is sent in response to a LBM
[loop] indicates egress is equal to ingress (L1)
[L3] indicates Layer 3 (IP) reply type, includes MAC/IP swap
[macswap] swaps the DA/SA of the frame, default (L2)
[tst] indicates standard Y.1731 ETH-Test
-s show current configuration
-v [evcVid] associated with the test instance: {0...4095}
-ver verbose help

>

The options available using the testresp command are shown below.
The -a switch adds a test instance to the port, EVC, EVC+CoS, or MEP.
The -clr switch clears the test results.

Page 197
The -cn switch associates the test instance with a class of service profile, defined using the cos command.
The -d switch deletes a test instance.
The -dall switch deletes all test instances.
The -dis and -ena switches disable or enable specific functions or test instances.
The -e switch associates the test instance with an EVC.
The -etype switch configures the ethertype for the test instance. The default is 0x9001.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -ipdst switch defines the virtual destination IP address of the responder used when a L3 test is selected..
The -ipsrc switch defines the source IP address used when a L3 test is selected.
The -l, -n, and -ni switches associate a specific test instance with a maintenance domain.
The -lmac switch defines the local module’s MAC address of the received frames.
The -mac switch associates the test instance with a specific unicast destination address and frames received
from the destination MAC address are ignored.
The -mep switch associates the test instance with a specific MEP ID.
The -o and -oi switches associate a specific test instance with a maintenance association.
The -p switch associates a port to a specific test instance.
The -pe switch defines the egress port where the test PDUs are generated. The responding port is set via
the -p switch.
The -pi or -pn switches identify or name a specific test profile.
The -po switch associates the test instance with a port.
The -remote switch indicates the communication protocol used with the remote partner.
jdsu indicates the JDSU proprietary loop up/down protocol will be used.
veex indicates the VeEX proprietary loop up/down protocol will be used.
twamp indicates the TWAMP proprietary loop up/down protocol will be used.
The -rty switch defines the type of reply by the responder unit.
The -s switch displays the current test configuration and status.
The -v switch associates the test instance with a specific VLAN ID.
The -ver switch displays the extended help screen.
The example below configures Port 1 on the module as a responder for test instance test1.

> testresp -a -p 1 -pn test1 -e E2

The example below configures EVC Data to respond to inband commands from a JDSU tester.

> testresp -a -p 1 -pn jdsu -e Data -remote jdsu

The example below configures EVC Data to respond to inband commands from a VeEx tester.

> testresp -a -p 1 -pn jdsu -e Data -remote veex

Page 198
The example below configures EVC Data to respond to inband commands using the TWAMP protocol.
Module> testresp -a -p 1 -pn twamp -e Data -remote twamp -ipdst 192.168.1.200

Verify the module has been configured by using the testresp -s command.

> testresp -s

Product: XM5
Firmware version: vx.x.xx, serial number: 710388, FPGA: vx.xx 03/26/2014 15:54:14
Date & Time: 01/01/1970 01:30:46 PM Pacific Standard Time (sysUpTime: 7744600)
Globals: Test Responder enabled, Test Monitor enabled

--- Test Responder Instance #1 -------------------------------------------


Test Name: Test, Responding Port 1, Destination Port 15
Test Responder enabled, Test Monitor enabled, Multicast Replacement disabled
Standard response disabled, Out-of-Service enabled
Reply Type: MAC Swap (Remote protocol: None)
Test Association: EVC(ethertype 9001)
EVC name “E2” (VID 1000)
Local MAC Match disabled

Received frame counts: 84821997


Transmitted frame counts: 84821997

>

NOTE: When using external test equipment to test the circuit and the far end is configured as a Test
Responder, the test equipment must be configured with an Ethertype of 9001. The Ethertype can be
modified using the -etype command.
The examples below show how to configure the test initiator and test responder for different test instances.
The diagram below illustrates the network configuration used for the test examples.

Page 199
The following script will be used in the test examples.
Test Initiator Setup
NID #1 - Test Initiator
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> evc -a -e EVC1 -p 15,14 -v 1000
> evc -a -e EVC2 -p 15,mgt1 -v 1001
> interface -a -p 15 -t nni
> interface -a -p 14 -t uni -e EVC1:*
> interface -a -p mgt1 -t uni -e EVC2:*
> bwp -a -p 14 -n CIR50M -cir 50000 -e EVC1
> mdo -a -n Domain4 -l 4
> ma -a -n Domain4 -o MA04 -e EVC1 -p 15
> mep -a -n Domain4 -o MA04 -e EVC1 -p 15 -m 230 -dn
> rmep -a -n Domain4 -o MA04 -m 231
> evc -ena
> cfm -ena all

Test Responder Setup


NID #2 - Test Responder
CLI Command
> evc -dis
> evc -dall
> ethertype -nni 88a8
> evc -a -e EVC1 -p 15,14 -v 1000
> evc -a -e EVC2 -p 15,mgt1 -v 1001
> interface -a -p 15 -t nni
> interface -a -p 14 -t uni -e EVC1:*
> interface -a -p mgt1 -t uni -e EVC2:*
> mdo -a -n Domain4 -l 4
> ma -a -n Domain4 -o MA04 -e EVC1 -p 15
> mep -a -n Domain4 -o MA04 -e EVC1 -p 15 -m 231 -dn
> rmep -a -n Domain4 -o MA04 -m 230
> evc -ena
> cfm -ena all

Page 200
Frame Loss - EVC
The example below creates a frame loss test instance on Port 1 across EVC1 using the standard frame sizes.
NID #2 - Test Responder
CLI Command
> testresp -a -p 15 -pn loss -e EVC1

NID #1 - Test Initiator


CLI Command
> testinit -a -p 15 -pn loss -mac 00-06-87-00-cf-f9 -e EVC1 -fst

Frame Loss - MEP


The example below creates a frame loss LBM test instance on Port 1 to remote MEP 231.
NID #2 - Test Responder
CLI Command
> testresp -a -p 15 -pn loss -e EVC1 -l 4 -rty lbr -mep 230

NID #1 - Test Initiator


CLI Command
> testinit -a -p 15 -pn loss -e EVC1 -l 4 -pdu lbm -mep 231

Frame Loss - ETH-Test


The example below creates a frame loss ETH-Test test instance on Port 1 to remote MEP 231 using the
standard frame sizes.
NID #2 - Test Responder
CLI Command
> testresp -a -pn loss -n Domain4 -o MA04 -p 15 -rty tst

NID #1 - Test Initiator


CLI Command
> testinit -a -p 15 -pn loss -n Domain4 -o MA04 -pdu tst -typ loss -mep 231 -fst

Page 201
5.1.60 Set/Display Time of Day (TIME)
The time command provides the ability to set or display the time of day on the module.
To configure the time on the module, use the time command from the CLI prompt. A list of options is
displayed when the time -h command is entered.

> time -h

Description: Displays the time of day


Format: time [-h [-ver]|-s] [-a timeOfDay] [-z zoneVal]
Switches:
-a sets the time of day, [timeOfDay]: month/day/year 24hr:min:sec
-h display help information
-s show current time of day
-ver verbose help
-z set the time [zoneVal]

>

The options available using the time command are shown below.
The -a switch sets the time of day.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -s switch displays the current time of day.
The -ver switch displays the extended help screen.
The -z switch defines the time zone.
The example below sets the time of day.

> time -a “12/3/2015 07:55:00”

To display the time of day, use the time -s command.

> time -s

Time of day: 12/03/2015 01:46:14 PM Pacific Standard Time


sysUpTime: 7837400 (0 days 21 hours 46 minutes 14 secs)

>

Page 202
5.1.61 SNMP Trap Host (TRAPHOST)
SNMP traps report events that occur during the operation of a network, and may require the attention of
the network administrator. The module is capable of sending SNMP traps to eight different SNMP Trap
Hosts (IP addresses).
The traphost command provides the ability to configure the IP addresses of the SNMP Trap Hosts.
To configure the Trap Hosts, use the traphost command from the CLI prompt. A list of options is displayed
when the traphost -h command is entered.

> traphost -h

Description: SNMP Trap Host Configuration


Format: traphost [-dall|-h [-ver]|-s] [-ip ipAddr] [-host hNum]
Switches:
-dall delete all SNMP trap hosts and set back to 255.255.255.255
-h display help information
-host select traphost number [hNum]: {1...8}
-ip selects the IP trap host address, [ipAddr]
-s shows current SNMP settings
-ver verbose help

>

The options available using the traphost command are shown below.
The -dall switch deletes are configured trap hosts and resets the setting to factory default. The default
setting is 255.255.255.255.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -host switch selects the Trap Host number to be configured. Eight different Traps Hosts can be
configured.
The -ip switch configures the IP address for the selected Trap Host.
The -s switch displays the SNMP Trap Host settings.
The -ver switch displays the extended help screen.
To configure the IP address for Trap Host 1, use the following command.

> traphost -host 1 -ip 192.168.1.250

To display the Trap Host configuration, use the traphost -s command.

> traphost -s

SNMP Trap Host #1 IP address = 192.168.1.250 (pending, Save required)


SNMP Trap Host #2 IP address = 255.255.255.255 (not configured)
SNMP Trap Host #3 IP address = 255.255.255.255 (not configured)
SNMP Trap Host #4 IP address = 255.255.255.255 (not configured)
SNMP Trap Host #5 IP address = 255.255.255.255 (not configured)
SNMP Trap Host #6 IP address = 255.255.255.255 (not configured)
SNMP Trap Host #7 IP address = 255.255.255.255 (not configured)
SNMP Trap Host #8 IP address = 255.255.255.255 (not configured)
>

Page 203
5.1.62 SNMP Traps (TRAPS)
The traps command provides the ability to enable/disable specific module traps. By default, all traps are
enabled.
To enable traps, use the traps option from the CLI prompt. A list of options is displayed when the traps -h
command is entered.

> traps -h

Description: Trap configuration


Format: traps [-dall|-h|-log [ltype]|-s [stype]] [-ver] [-clear] [-gen tnum]
[{-ena|-dis} tnum|-disall|-enaall] [-tbl ttype] [-portnum portnumber]
[-severity tnum,slevel]
[-type {snmpv1|snmpv2c|snmpv3}] [-modtype {normal|ap|sp}]
[-aclear anum] [-severitylevel slevel}
Switches:
-aclear clears standing alarm [anum]: {1..40|all}
-clear clears trap/alarm log
-dall restores trap defaults
-dis disable selected [tnum]
-disall disable generation of all traps
-ena enable selected [tnum]
-enaall enable generation of all traps
-gen generates the [tnum] trap number
-h display help information
-log shows last 10 log entries, [ltype]: {ahistory|tlog}, default tlog
-modtype selects module type: {normal|ap|sp}, default normal
-portnum SNMP trap [portnumber], default 162
-s show the current configuration, [stype]: {alarm|trap}, default trap
-severity selects the trap [tnum]: {1..159|all}, severity level,
[slevel]: {info,warning,minor,major,critical}
-severitylevel selects the severity levels for trap generation,
{slevel}: {all,info,warning,minor,major,critical}, default all
-tbl selects the trap table type, [ttype]:
{bridge|cfm|ent|entity|lldp|mef|rmon}
[bridge] selects Bridge MIB specific trap numbers
[cfm] selects 802.1ag trap numbers
[ent] select enterprise specific trap numbers, default
[entity] selects Entity MIB specific trap numbers
[lldp] selects LLDP trap numbers
[mef] selects MEF trap numbers
[rmon] selects RMON MIB specific trap numbers
-type selects SNMP trap generation type: {snmpv1|snmpv2c|snmpv3}
-ver verbose help

>

The options available using the traps command are shown below.
The -aclear switch clears any current alarms.
The -clear switch clears the current trap log entries.
The -dall switch restores all traps to default.
The -dis switch defines which trap types will be disabled.
The -disall switch disables all traps.
The -ena switch defines which trap types will be enabled.
The -enaall switch enables all traps.
The -gen switch generates a specific trap number. Traphost must be configured to receive the generated trap.

Page 204
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -log switch displays the last 100 trap entries.
The -modtype switch selects the module type to be displayed. The default module type is normal.
The -portnum switch defines the SNMP UDP trap port number.
The -s switch displays the current trap configuration.
The -severity switch selects the trap and severity level.
The -severitylevel switch selects the severity levels for trap generation.
The -tbl switch selects the trap type to be displayed.
The -type switch selects the generation type of the trap (snmpv1, snmpv2c, snmpv3).
The -ver switch displays the extended help screen.
The example below enables all traps.

> traps -ena all

Individual traps can be enabled or disabled by entering the name of the traps after the ena/dis command.
The example below disables linktrace traps.

> traps -dis linktrace

To display the traps, use the traps -s command.

> traps -s

SNMP trap source: IP 1


SNMP trap type: SNMPv2c
Module type: normal

Severity Level: all

Trap Type Status Severity


============================================================
1 module inserted Enabled Information
2 module restarted Enabled Information
3 module link down Enabled Information
4 module link up Enabled Information
5 switch change Enabled Information
6 software configuration change Enabled Information
7 module over temperature Enabled Information
8 module voltage out of range Enabled Information
9 power removed Enabled Information
10 power applied Enabled Information
11 authentication failure Enabled Information
13 chassis inserted Enabled Information
14 chassis removed Enabled Information
16 module removed Enabled Information
17 primary link up Enabled Information
18 primary link down Enabled Information
19 secondary link up Enabled Information
20 secondary link down Enabled Information
21 TELNET session started Enabled Information
22 TELNET session stopped Enabled Information
23 FTP session started Enabled Information

Page 205
24 FTP session stopped Enabled Information
25 standby link up Enabled Information
26 standby link down Enabled Information
27 password count exceeded Enabled Information
28 ROM checksum error Enabled Information
29 ROM file type incorrect Enabled Information
30 ROM program failure Enabled Information
31 ROM file checksum error Enabled Information
32 module programming completed Enabled Information
33 dying gasp Enabled Information
34 keep alive Enabled Information
35 VLAN parameter change Enabled Information
36 AIS detected Enabled Information
37 PRBS detected Enabled Information
39 chassis mastership acquired Enabled Information
40 secure mode change Enabled Information
41 chassis mastership lost Enabled Information
42 SFP device inserted Enabled Information
43 SFP device removed Enabled Information
44 ah event notification gen Enabled Information
45 ah event notification rcv Enabled Information
46 contact closure status change Enabled Information
47 ah link fault received Enabled Information
48 ah critical event gen Enabled Information
49 ah remote critical event rcvd Enabled Information
50 Remote dying gasp Enabled Information
51 Table Full Enabled Information
52 Loopback Reply Received Enabled Information
53 Loopback Reply Lost Enabled Information
55 CFM Loopback Complete Enabled Information
56 CFM Link Trace Complete Enabled Information
57 CFM MEP Up Enabled Information
58 CFM MEP Down Enabled Information
59 CFM Cross Connect Enabled Information
60 CFM Loop Enabled Information
61 CFM Configuration Error Enabled Information
62 CFM All MEPs Up Enabled Information
64 CFM Unknown MEP Enabled Information
73 SFP/XFP Tx Low Threshold Enabled Information
74 SFP/XFP Tx High Threshold Enabled Information
75 SFP/XFP Bias Low Threshold Enabled Information
76 SFP/XFP Bias High Threshold Enabled Information
77 SFP/XFP 3.3V Low Threshold Enabled Information
78 SFP/XFP 3.3V High Threshold Enabled Information
79 SFP/XFP Temp Low Threshold Enabled Information
80 SFP/XFP Temp High Threshold Enabled Information
81 XFP Aux 2 Low Threshold Enabled Information
82 XFP Aux 2 High Threshold Enabled Information
83 XFP Aux 1 Low Threshold Enabled Information
84 XFP Aux 1 High Threshold Enabled Information
85 SFP/XFP Rx Low Threshold Enabled Information
86 SFP/XFP Rx High Threshold Enabled Information
87 XFP 1.8V Low Threshold Enabled Information
88 XFP 1.8V High Threshold Enabled Information
89 XFP 5V Low Threshold Enabled Information
90 XFP 5V High Threshold Enabled Information
91 TDM Line Status Change Enabled Information
92 Configuration Change Enabled Information
93 Loopback Activation Enabled Information
94 Loopback Deactivation Enabled Information
95 Timing Error or Clock Slip Enabled Information

Page 206
96 Data Framing Overrun Enabled Information
97 Data Framing Under run Enabled Information
98 Remote Unit Found Enabled Information
99 Module Hardware Failure Enabled Information
100 Remote Unit Lost Enabled Information
101 Remote Unit Error Detected Enabled Information
102 Remote Unit Good Detected Enabled Information
103 External Clock Source Lost Enabled Information
104 Serial Session Started Enabled Information
105 Serial Session Stopped Enabled Information
106 SFP is consuming too much power Enabled Information
107 Remote Test Activation Enabled Information
108 Remote Test Deactivation Enabled Information
109 Local Test Activation Enabled Information
110 Local Test Deactivation Enabled Information
111 SSH Authentication Failure Enabled Information
112 SSH Session Started Enabled Information
113 SSH Session Stopped Enabled Information
114 File Corruption Enabled Information
115 Protection Switch Enabled Information
116 Protection Config Mismatch Enabled Information
117 Fan Rotation Not Detected Enabled Information
118 Fan Rotation High Threshold Enabled Information
119 FPGA Failure Enabled Information
120 Fan Rotation Normal Enabled Information
121 Unknown trap Enabled Information
122 Unknown trap Enabled Information
123 Unknown trap Enabled Information
124 Unknown trap Enabled Information
125 Unknown trap Enabled Information
126 Unknown trap Enabled Information
127 SYNCE Clock Source Gained Enabled Information
128 SYNCE Clock Source Lost Enabled Information
129 SYNCE Clock Holdover Lost Enabled Information
130 AIS State Change detected Enabled Information
131 LCK State Change detected Enabled Information
132 Performance Threshold Crossing Enabled Information
133 Performance Threshold Clear Enabled Information
134 TDM Clock Status Change Enabled Information
135 TDM Incorrect Ethernet frame count Enabled Information
136 XFP RX CDR Loss of Lock Enabled Information
137 XFP TX CDR Loss of Lock Enabled Information
138 DPOE warning Enabled Information
139 DPOE failure Enabled Information
140 XFP RX CDR Gained Lock Enabled Information
141 XFP TX CDR Gained Lock Enabled Information
142 Module Normal Temperature Enabled Information
143 Module Normal Voltage Range Enabled Information
144 Module Normal Data Detected Enabled Information
145 802.3AH Remote Link Normal Enabled Information
146 802.3AH Local Link Normal Enabled Information
147 XFP/SFP Normal Enabled Information
148 PoE PD Status Change Enabled Information
149 Y.1731 probe priority change Enabled Information
150 FTP Authentication Fail Enabled Information
151 ACL Access Denied Enabled Information
152 Link OAM Discovery Complete Enabled Information
153 Link OAM Discovery Lost Enabled Information
154 Service Activation Test Initiated Enabled Information
155 Service Activation Test Completed Enabled Information
156 Utilization Threshold Violation Enabled Information

Page 207
157 Utilization Threshold Normal Enabled Information
158 Loop Prevention Blocked Enabled Information
159 Loop Prevention Cleared Enabled Information

SNMP UDP Trap Port Number = 162

>

To view the trap log, use the traps -log command.

> traps -log


Chass/Slot Code Date/Time Trap_Type / Module Identifier
================================================================================
01/01 0 01/01/2000 01:59:47 AM 104: Serial Session Started /
01/01 0 01/01/2000 01:24:12 AM 104: Serial Session Started /
01/01 0 01/01/2000 01:18:00 AM 104: Serial Session Started /
01/01 0 01/01/2000 00:29:49 AM 104: Serial Session Started /
01/01 0 01/01/2000 00:04:10 AM 92: Configuration Change /
01/01 0 01/01/2000 00:03:34 AM 92: Configuration Change /
01/01 0 01/01/2000 00:02:31 AM 104: Serial Session Started /
01/01 1 01/01/2000 00:00:02 AM 04: module link up /
01/01 0 01/01/2000 00:00:01 AM 02: module restarted /
01/01 0 01/01/2000 00:00:01 AM 92: Configuration Change /

>

To clear the trap log, use the traps -log -clear command.
To view the alarm history log, use the traps -log ahistory command.

Module> traps -log ahistory

Chass/Slot Code Start Date/Time End Date/Time Alarm #/Desc


================================================================================
01/01 1 01/01/2000 21:05:18 01/01/2000 21:05:21 02: Link Down
01/01 1 01/01/2000 21:05:21 01/01/2000 21:05:21 16: MEP Error (md/ma/mep)

Module>

The alarm history log holds 1000 of the latest alarms entries.

Page 208
5.1.63 Firmware Version (VER)
The ver command provides the ability to display the firmware version currently running on the module.
A list of options is displayed when the ver -h command is entered.

> ver -h

Description: Displays the firmware version


Format: ver [-h [-ver]| -s]
Switches:
-h display help information
-s display version information
-ver verbose help

>

The options available using the ver command are shown below.
The -h switch displays the help screen presented above. It is static and provides help information for the
specific command.
The -s switch displays the firmware version on the module.
The -ver switch displays the extended help screen.
To display the firmware version on the module, use the ver -s command.

> ver -s

Model number: 9620-C2-B1


Firmware: vx.x.x Dec 10 2015, 17:35:46 caps(0x0 mtype 145)
Bootstrap: vx,x,x prodRev 10 hwRev 10
FPGA: vx.xx Oct 04 2015
>

Page 209
5.1.64 Time Zones (ZONE)
The zone command displays the list of time zone values.
To display the time zone values, use the zone -h command from the CLI prompt.

> zone -h

Zone Full name Location Time Adjustment


===============================================================================
GMT Greenwich Mean Time Europe UTC
UTC Coordinated Universal Time Europe UTC
WET Western European Time Europe UTC
Z Zulu Time Zone Military UTC
N November Time Zone Military UTC - 01 hour
O Oscar Time Zone Military UTC - 02 hours
HAT Heure Avancee de Terre-Neuve N America UTC - 02:30 hours
NDT Newfoundland Daylight Time N America UTC - 02:30 hours
ADT Atlantic Daylight Time N America UTC - 03 hours
HAA Heure Avancee de l’Atlantique N America UTC - 03 hours
P Papa Time Zone Military UTC - 03 hours
HNT Heure Normale de Terre-Neuve N America UTC - 03:30 hours
NST Newfoundland Standard Time N America UTC - 03:30 hours
AST Atlantic Standard Time N America UTC - 04 hours
EDT Eastern Daylight Time N America UTC - 04 hours
HAE Heure Avancee de l’Est N America UTC - 04 hours
HNA Heure Normale de l’Atlantique N America UTC - 04 hours
Q Quebec Time Zone Military UTC - 04 hours
EST Eastern Standard Time N America UTC - 05 hours
CDT Central Daylight Time N America UTC - 05 hours
HAC Heure Avancee du Centre N America UTC - 05 hours
HNE Heure Normale de l’Est N America UTC - 05 hours
R Romeo Time Zone Military UTC - 05 hours
MDT Mountain Daylight Time N America UTC - 06 hours
CST Central Standard Time N America UTC - 06 hours
HAR Heure Avancee des Rocheuses N America UTC - 06 hours
HNC Heure Normale du Centre N America UTC - 06 hours
S Sierra Time Zone Military UTC - 06 hours
PDT Pacific Daylight Time N America UTC - 07 hours
HAP Heure Avancee du Pacifique N America UTC - 07 hours
HNR Heure Normale des Rocheuses N America UTC - 07 hours
MST Mountain Standard Time N America UTC - 07 hours
T Tango Time Zone Military UTC - 07 hours
PST Pacific Standard Time N America UTC - 08 hours
AKDT Alaska Daylight Time N America UTC - 08 hours
HAY Heure Avancee du Yukon N America UTC - 08 hours
HNP Heure Normale du Pacifique N America UTC - 08 hours
U Uniform Time Zone Military UTC - 08 hours

Only a partial list is shown.

Page 210
6.0 SPECIFICATIONS
Description iConverter XM5 10G Aggregation Demarcation Device
IEEE 802.1Q, 802.1ad, 802.1AX, 802.1p, 802.3, 802.3ad,
802.3ah, 802.1ag, 1588v2
Standards RFC 2819 (RMON), 2863 (IF-MIB), 2131 (DHCP), 2544
Compliance
ITU-T G.8031, G.8032, G.8262, Y.1731, Y.1564
MEF 9, 14, 21, 31, Carrier Ethernet 2.0
Management Telnet, SNMPv1, SNMPv2c, SNMPv3, SSH, Serial Console
Regulatory UL, CE, FCC Class A, NEBS Level 3, RoHS2 (6/6), WEEE,
Compliance REACH
Frame Size Up to 10,056 bytes
Copper: 10/100/1000BASE-T (RJ-45)
Fiber: 1000BASE-X (SFP)
100BASE-X (SFP)
10GBASE-R (SFP+, XFP)
Port Types
Serial: RS-232 (RJ-45)
(Management)

Copper: 10/100/1000BASE-T (RJ-45)


(Management)
Copper: EIA/TIA 568 A/B, Category 5 and higher
Fiber: Multimode: 50/125um, 62.5/125um
Single-mode: 9/125um
Cable Types Serial: EIA/TIA 568 A/B, Category 3 and
(Management) higher
Copper:
EIA/TIA 568 A/B, Category 5 and higher
(Management)
AC Power 80-264VAC~ 50-60Hz
IEC 320 C14
Requirements 0.8A @ 110VAC
DC Power 20 to 60VDC
3-Pin Terminal
Requirements 1.2A @ 48VDC (56W Max)
Commercial: 0 to 50° C
Wide: -40 to 60° C
Temperature
Extended: -40 to 75° C
Storage: -40 to 80° C
W: 17.15” x D: 9.0” x H: 1.70”
Dimensions
L: 435.61mm x B: 228.6mm x H: 43.18mm
1 power supply: 7.5 lbs (3.41 kg)
Weight
2 power supplies: 9.0 lbs (4.1 kg)
Humidity 5% to 95% (non-condensing)
Altitude -100m to 4,000m (operational)
Warranty 3 year warranty

Page 211
7.0 APPENDIX A: BOOTLOADER, FIRMWARE AND FPGA CODE UPDATE
7.1 OVERVIEW
This document describes the procedure for updating the bootloader, firmware and FPGA code on the XM5.
7.2 SAVE CURRENT SETTINGS
Under normal circumstances the current configuration of the module will carry forward to the new version
during the update, however, extreme events such as a power outage can lead to settings being lost. Prior to
upgrading the module, it is recommended that the settings be recorded. The settings can be viewed using
the Command Line Interface (CLI) over either the serial or Telnet interfaces.
7.3 COPY THE MODULE FILES TO YOUR HARD DRIVE
The files should be copied to a convenient location on the hard drive of the workstation. The name of the
bootloader file is similar to xm5-redboot-vx.x.xx.img. The name of the firmware file is similar to xm5-app-
vx.x.x.dat. The name of the FPGA code file is similar to YYYYMMDDxxxx-xx.dat. The ‘x’s represent
the release revision of the firmware.
Depending on the operating system of the workstation and/or FTP installation, the name of the files may
need to be renamed to the “DOS 8.3 Format”. Rename the xm5-redboot-vx.x.xx.img to redboot.img,
xm5-app-vx.x.x.dat to xm5.dat and YYYYMMDDxxxx-xx.dat to fpga.dat and store the files in the root
or c:\ directory.
Renaming the files to redboot.img, xm5.dat and fpga.dat will allow the new files to overwrite the old files,
saving memory allocation space on the module.
7.4 UPDATE THE MODULE
The XM5 supports dual boot which protects the module from firmware corruption if the power is lost during
the process of upgrading the firmware. The XM5 has two copies of the firmware. One is the primary copy
and the other is the backup copy. When a firmware upgrade is performed, the backup copy is upgraded
with the new firmware. Once the firmware upgrade is complete and verified, the backup copy becomes
the primary running version and the previous primary (old version) becomes the backup. If the primary
becomes corrupt for any reason, the backup version will be restored.
The dual boot feature is supported with a bootstrap version v5.2 or greater. Contact Omnitron for upgrade
details.
The module files can be upgraded using FTP. When updating both the firmware and FPGA code, always
upgrade the FPGA first, then activate the FPGA code, then upgrade the firmware.
7.4.1 Updating the Bootloader, Firmware and FPGA Code Using FTP
FTP can be used to update the XM5 bootloader, firmware and FPGA code over a network. Verify the
following parameters:
• IP Protocol is turned On and the module has a valid IP Address
• FTP Protocol turned On and a password has been configured
Access the module through the serial console port. Verify the IP address of the module by using the ip
command.

Page 212
> ip -s

MAC address: xx-xx-xx-xx-xx-xx


IP Address: 192.168.1.220
Subnet mask: 255.255.255.0
Gateway address: 192.168.1.1

DHCP: Disabled

>

To enable FTP and configure a password, use the protocol command.

> protocol -ftp ena -ftppw <pw>

7.4.1.1 Update the Bootloader


To update the bootloader, open a DOS command window and enter the following commands. Bold lettering
indicates information to be entered.
> ftp 192.168.1.220 (Enter the module’s IP address)
Connected to 192.168.1.220
220 You will be disconnected after 300 seconds of inactivity
User (192.168.1.220:(none)): admin (default login name)
331 User admin OK. Password required
Password: <enter ftp password> (from the protocol command configuration )
230 OK. Current directory is /flash
ftp> bin
200 TYPE is now 8-bit binary
ftp> cd /ram/tmp
250 Changed to /ram/tmp
ftp> put <location and filename of the bootloader file> redboot.img
200 OK
150-Connecting to 192.168.1.110:5028150
150 Ready to take file
226 File written successfully
ftp: 2097184 bytes sent in 1.89Seconds 1109.62Kbytes/sec.
ftp>quit (exit FTP session)
221 Goodbye

Page 213
The bootloader file has been transferred to the module’s flash memory.
After the bootloader file has been transferred via FTP, the bootloader will need to be moved from flash
to the module. Access the CLI through the serial console port. Use the fwupdate command to finish the
update process..
The filename of the bootloader when using the fwupdate command must be the same as the filename used
during the FTP process.

> fwupdate -f redboot.img -t bootloader

firmware updating using firmware file :/ram/tmp/redboot.img


Waiting for firmware update to complete
Starting flash update - do not power off device!

Erasing image................................................

Programming image...............................................................
................................................................................
................................................................................
... Erase from 0x40fc0000-0x40ffffff: .
... Program from 0x87fbf000-0x87fff000 to 0x40fc0000: .
... Program from 0x87fbf00a-0x87fbf00c to 0x40fc000a: .
Flash update succeeded.

NOTE: Do not remove power during the upgrade procedure until the module has completed the
activation sequence and the module has restarted.

Page 214
7.4.1.2 Update the FPGA Code
To update the FPGA, open a DOS command window and enter the following commands. Bold lettering
indicates information to be entered.
> ftp 192.168.1.220 (Enter the module’s IP address)
Connected to 192.168.1.220
220 You will be disconnected after 300 seconds of inactivity
User (192.168.1.220:(none)): admin (default login name)
331 User admin OK. Password required
Password: <enter ftp password> (from the protocol command configuration )
230 OK. Current directory is /flash
ftp> bin
200 TYPE is now 8-bit binary
ftp> cd /ram/tmp
250 Changed to /ram/tmp
ftp> put <location and filename of the FPGA code> fpga.dat
200 OK
150-Connecting to 192.168.1.110:5028150
150 Ready to take file
226 File written successfully
ftp: 8388672 bytes sent in 4.22Seconds 1989.72Kbytes/sec.
ftp>quit (exit FTP session)
221 Goodbye
The FPGA code has been transferred to the module’s flash memory.
After the FPGA code has been transferred via FTP, the FPGA code will need to be moved from flash to the
FPGA. Access the CLI through the serial console port. Use the fpgaupd command to finish the update
process..
The filename of the FPGA code when using the fpgaupd command must be the same as the filename used
during the FTP process.

> fpgaupd -w fpga.dat -act

Reading fpga.dat
FPGA image ready to program
Warning: Do not remove power until update is completed!
FPGA update started
Erasing device (~30 seconds)..............................
Programming And Verifying Device (~2 minutes ............................................
............................
FPGA update complete
FPGA restarted

The filename of the FPGA code after the -w command must match the filename of the FPGA code that was
FTP’d in Section 7.4.1.2.
NOTE: Do not remove power during the upgrade procedure until the module has completed the

Page 215
activation sequence and the FPGA has restarted.

7.4.1.3 Update the Firmware


To update the application firmware, open a DOS command window and enter the following commands.
Bold lettering indicates information to be entered.
> ftp 192.168.1.220 (Enter the module’s IP address)
Connected to 192.168.1.220
220 You will be disconnected after 300 seconds of inactivity
User (192.168.1.220:(none)): admin (default login name)
331 User admin OK. Password required
Password: <enter ftp password> (from the protocol command configuration )
230 OK. Current directory is /flash
ftp> bin
200 TYPE is now 8-bit binary
ftp> cd /ram/tmp
250 Changed to /ram/tmp
ftp> put <location and filename of the firmware> xm5.dat
200 OK
150-Connecting to 192.168.1.110:5028150
150 Ready to take file
226 File written successfully
ftp: 5577367 bytes sent in 2.77Seconds 2011.31Kbytes/sec.
ftp>quit (exit FTP session)
221 Goodbye
NOTE: Do not remove power during the upgrade procedure until the module has rebooted with
the new firmware.
The firmware has been transferred to the module’s flash memory.
After the firmware has been transferred via FTP, the firmware will need to be activated. Access the CLI
through the serial console port. Use the fwupdate command to finish the update process..
Once the new firmware has been stored on the module, the firmware can be activated by using the following
command:

Page 216
> fwupdate -f xm5.dat

firmware updating using firmware file :/ram/tmp/xm5.dat


Waiting for firmware update to complete
Starting flash update - do not power off device!

Erasing image................................................

Programming image...............................................................
................................................................................
................................................................................
... Erase from 0x40fc0000-0x40ffffff: .
... Program from 0x87fbf000-0x87fff000 to 0x40fc0000: .
... Program from 0x87fbf00a-0x87fbf00c to 0x40fc000a: .
Flash update succeeded.

The filename of the firmware after the -f command must match the filename of the firmware that was FTP’d
in Section 7.4.1.3.
NOTE: Do not remove power during the upgrade procedure until the module has completed the
activation sequence and the module has restarted.

Page 217
8.0 CUSTOMER SERVICE INFORMATION
If you encounter problems while installing this product, contact Omnitron Technical Support:
Phone: (949) 250-6510
Fax: (949) 250-6514
Address: Omnitron Systems Technology, Inc.
38 Tesla
Irvine, CA 92618, USA
Email: support@omnitron-systems.com
URL: www.omnitron-systems.com

041-09620-001B 7/16

Page 218
9.0 WARRANTY AND COPYRIGHT
General and Copyright Notice
This publication is protected by U.S. and international copyright laws. All rights reserved. The whole or any part
of this publication may not be reproduced, stored in a retrieval system, translated, transcribed, or transmitted,
in any form, or by any means, manual, electric, electronic, electromagnetic, mechanical, chemical, optical or
otherwise, without prior explicit written permission of Omnitron Systems Technology, Inc.
The following trademarks are owned by Omnitron Systems Technology, Inc.: FlexPointTM, FlexSwitchTM, HybridNID®,
iConverter®, miConverterTM, NetOutlook®, OmniLightTM, OmniConverterTM, Omnitron Systems Technology, Inc.TM,
OSTTM and the Omnitron logo.
All other company or product names may be trademarks of their respective owners.
The information contained in this publication is subject to change without notice. Omnitron Systems Technology,
Inc. is not responsible for any inadvertent errors.
Warranty
This product is warranted to the original purchaser against defects in material and workmanship for a period
of two (2) years from the date of shipment. A THREE YEAR warranty (plus warranty extension purchased)
may be obtained by the original purchaser by registering this product within ninety (90) days from the date of
shipment at www.omnitron-systems.com/support. During the warranty period, Omnitron will, at its option, repair
or replace a product which is proven to be defective with the same product or with a product with at least the
same functionality.
For warranty service, the product must be sent to an Omnitron designated facility, at Buyer’s expense. Omnitron
will pay the shipping charge to return the product to Buyer’s designated US address using Omnitron’s standard
shipping method.
Limitation of Warranty
The foregoing warranty shall not apply to defects resulting from improper or inadequate use and/or maintenance
of the equipment by Buyer, Buyer-supplied equipment, Buyer-supplied interfacing, unauthorized modifications or
tampering with equipment (including removal of equipment cover by personnel not specifically authorized and
certified by Omnitron), or misuse, or operating outside the environmental specification of the product (including
but not limited to voltage, ambient temperature, radiation, unusual dust, etc.), or improper site preparation or
maintenance.
No other warranty is expressed or implied. Omnitron specifically disclaims the implied warranties of merchantability
and fitness for any particular purpose.
The remedies provided herein are the Buyer’s sole and exclusive remedies. Omnitron shall not be liable for any
direct, indirect, special, incidental, or consequential damages, whether based on contract, tort, or any legal theory.
Environmental Notices
The equipment covered by this manual must be disposed of in accordance with Directive 2002/96/EC of the
European Parliament and of the council of 27 January 2003 on waste electrical and electronic equipment
(WEEE). Such disposal must follow national legislation for IT and Telecommunication equipment in accordance
with the WEEE directive: (a) Do not dispose waste equipment with unsorted municipal and household waste.
(b) Collect equipment waste separately. (c) Return equipment using collection method agreed with Omnitron.
The equipment is marked with the WEEE symbol shown to indicate that it must be collected separately from
other types of waste. In case of small items the symbol may be printed only on the packaging or in this manual.
If you have questions regarding the correct disposal of equipment go to www.omniton-systems.com/support or
e-mail to Omnitron at intlinfo@omnitron-systems.com.

©2016 Omnitron Systems Technology, Inc.

Page 219