Managing Aeonts Cli Ae2-2

Managing Calix Active Ethernet
ONTs from the Command Line

Interface, AE R2.2
November 2012
#220-00527, Rev 10
Contents
About this Guide..................................................................... 12
Chapter 1: Active Ethernet Overview .................................. 15
AE Topology ............................................................................................................ 15
Key AE Attributes ............................................................................................ 16
AE Hardware Components ............................................................................. 17
AE Services Overview ............................................................................................. 19
Configuring AE ONT Voice Services............................................................... 19
Session Initiated Protocol (SIP) ...................................................................... 21
Calix TDM Gateway (CTG) ............................................................................. 23
Ground Start POTS Service ............................................................................ 24
Ethernet Data Services ................................................................................... 25
Business Ethernet Services ............................................................................ 34
Ethernet Services............................................................................................ 38
IPTV ................................................................................................................ 49
T1/E1 Services via PWE3 ............................................................................... 53
ONT Inventory ................................................................................................ 57
Calix AE ONTs ......................................................................................................... 58
ONT Models.................................................................................................... 58
AE ONT Features ........................................................................................... 59
ONT FSAN Serial Number .............................................................................. 63
ONT Optics Characteristics ............................................................................ 64
AE Optical Links ............................................................................................. 64
AE Deployment Scenarios ...................................................................................... 68
Managed ONT Basic Service - VLAN per Port ............................................... 68
ONT Basic Multi-service - VLAN per Service .................................................. 69
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
Calix. All Rights Reserved.
Chapter 2: Configuring an AE System ................................ 71

AE System Essentials ............................................................................................. 71
About DHCP ................................................................................................... 73
Notes on Configuring the DHCP Server.......................................................... 75
Notes on Configuring the NTP Server............................................................. 81
Notes on Configuring the Syslog Server ......................................................... 82
Notes on Configuring the SIP Server .............................................................. 82
Network Component Details ................................................................................... 83
Chapter 3: Understanding AE ONT Configuration Files .... 87

ONT Operational Overview ..................................................................................... 87
About Configuration Files....................................................................................... 88
Sample Configuration File ...................................................................................... 89
Configuration File Characteristics ......................................................................... 92
Configuration File Processing................................................................................ 93
Creating a Configuration File ................................................................................. 93
Sample Configuration Files - AE ONT.................................................................... 95
calix_700ge_sample.cfg ................................................................................. 96
calix_700sfu_sample.cfg............................................................................... 100
calix_760mdu_sample.cfg ............................................................................ 103
common_ge.cfg ............................................................................................ 108
common_sfu.cfg ........................................................................................... 111
common_mdu.cfg ......................................................................................... 114
hsi_setup.cfg................................................................................................. 117
pwe3_setup.cfg ............................................................................................. 118
tls_setup.cfg.................................................................................................. 123
video_mvr_port_setup.cfg............................................................................. 124
video_mvr_vlan_setup.cfg ............................................................................ 125
video_oui.cfg................................................................................................. 126
video_profile_mvr.cfg .................................................................................... 126
video_profile_no_mvr.cfg .............................................................................. 127
video_setup_no_mvr.cfg ............................................................................... 127
voice_setup.cfg ............................................................................................. 127
ctg_setup.cfg ................................................................................................ 128
Add VoIP Service to a Port ........................................................................... 129
Cascading CF ............................................................................................... 130
About SIP and the SIP Configuration File Retrieval ........................................... 135
SIP Configuration File Attributes ................................................................... 136
Chapter 4: AE Deployment Options .................................. 137

Residential Gateway Characteristics ................................................................... 138
Non-Residential Gateway Characteristics ........................................................... 139
External Router Characteristics ........................................................................... 140
Metering and Traffic Shaping ............................................................................... 141
Subscriber-VLAN to WAN-VLAN Mapping Overview ......................................... 142
Level 1: L2 Mapping Filter Table ................................................................... 143
Level 2: L2 Mapping/Filtering Table .............................................................. 143
VLAN Tagging Mapping and Conversion for Multicast Streams ................... 143
Chapter 5: Automatic ONT Creation - Smart Activate ..... 145

Setting up your PC for Web Activate ................................................................... 146
Configuring your Local PC for Web Activate - Windows XP ......................... 147
Configuring your Local PC for Web Activate - Windows 7 ............................ 149
Using Web Activate ............................................................................................... 151
Web Activate Field Definitions ...................................................................... 153
Turning up an ONT using DHCP Discovery .................................................. 154
Turning up an ONT using a Static IP Host .................................................... 155
Updating ONT Firmware Using Web Activate ..................................................... 158
Restoring Factory Default Settings ...................................................................... 159
Voice Activate Overview ....................................................................................... 160
Using Voice Activate ..................................................................................... 161
Master Reset ................................................................................................ 163
Assigning a Registration ID to an ONT ......................................................... 164
Assigning a Management VLAN to an AE ONT ............................................ 166
Configuring the Management VLAN .................................................................... 168
ONT Provisioning Persistence ............................................................................. 169
Local Provisioning Persistence ........................................................................... 170
ONT Inventory Management (Option-43) ............................................................. 171
Remote Management Interface Script ................................................................. 172
Retrieving Current Alarms............................................................................. 174
Resetting an ONT by Serial Number............................................................. 175
Chapter 6: Turning Up an AE ONT

via CLI using Custom Configuration Files ......................... 177
About the Command Line Interface (CLI) ............................................................ 178
Telnet Interface ............................................................................................. 179
Command Line Help ..................................................................................... 179
Command Line Conventions......................................................................... 181
Network Pre-requisites.......................................................................................... 184
Additional Considerations .................................................................................... 184
ONT Boot Process ................................................................................................. 186
Establishing a Link to the Switch .................................................................. 186
Obtaining an IP Address ............................................................................... 187
Provisioning the AE ONT .............................................................................. 187
About Auto-Detect Behavior on the ONT ...................................................... 187
Creating SNMP Trap Receivers ............................................................................ 188
Bridging .................................................................................................................. 188
VLAN per Port Bridge ................................................................................... 189
VLAN per Service Bridge .............................................................................. 189
IGMP Snoop VLAN per Service .................................................................... 190
IP Host .......................................................................................................... 191
MAC Forced Forwarding (MACFF) ....................................................................... 191
Creating a Layer-2 Pipe for HPNA Maintenance and Monitoring ...................... 193
Configuring the AE ONT for HPNA Deployment ........................................... 193
Chapter 7: System Maintenance and Troubleshooting .... 195

About File Permission ........................................................................................... 195
Download Failures ................................................................................................. 198
TFTP Server Not Responding....................................................................... 199
TFTP Server Responds "File not Found" ...................................................... 199
Download Transfer Interrupted ..................................................................... 199
Serviceability Characteristics............................................................................... 199
ONT Retry Behavior...................................................................................... 200
Viewing ONT Alarms and Events in CMS ............................................................ 203
Changing the Management VLAN ........................................................................ 204
Monitoring the ONT ............................................................................................... 205
About Syslog Events ..................................................................................... 206
Channel and Drop Testing .................................................................................... 207
Chapter 8: CMS Servicing, Performance Monitoring and

Alarm Aggregation ............................................................... 209
SNMP Monitoring: PM and Statistical MIBs ........................................................ 209
Troubleshooting AE ONT Ethernet Issues .......................................................... 210
Appendix A Command Reference ..................................... 213

Configuration Commands..................................................................................... 214
config vlan set ............................................................................................... 214
config ntp update .......................................................................................... 215
config syslog setup ....................................................................................... 216
config file....................................................................................................... 216
config label.................................................................................................... 217
config upgrade .............................................................................................. 218
config regid ................................................................................................... 219
config synce .................................................................................................. 219
config trap sink .............................................................................................. 220
config alarms ................................................................................................ 221
config supp alarm (Alarm Suppression) ........................................................ 235
config diag .................................................................................................... 235
Bridge Commands ................................................................................................. 237
bridge add (VLAN Bridge Add) ..................................................................... 237
bridge setup .................................................................................................. 238
bridge portadd (Associate Subscriber Ethernet Port to VLAN Bridge) .......... 241
Filtering and Mapping commands ................................................................. 242
DSCP Mapping ............................................................................................. 250
l2cp portmode ............................................................................................... 254
l2cp show ...................................................................................................... 255
IP Host Bridge(s)........................................................................................... 256
MACFF Commands ...................................................................................... 258
l2l (Learning Bridge)...................................................................................... 263
Meter Commands .................................................................................................. 264
meter set downstream .................................................................................. 264
meter set upstream ....................................................................................... 265
meter get downstream .................................................................................. 266
meter get upstream ....................................................................................... 266
meter attach downstream ............................................................................. 267
meter deattach downstream ......................................................................... 267
meter attach upstream .................................................................................. 268
meter deattach upstream .............................................................................. 269
meter attach mcast ....................................................................................... 270
meter deattach mcast ................................................................................... 271
DHCP Commands .................................................................................................. 271
dhcpl2 limit set .............................................................................................. 271
dhcpl2 limit show........................................................................................... 272
DHCP Relay - Option-82 Commands ........................................................... 273
DHCP Option-43 Configuration Process ....................................................... 276
dhcp lease show ........................................................................................... 280
Voice Service Commands ..................................................................................... 281

voip setup ..................................................................................................... 281
ctg setup ....................................................................................................... 286
h248 add ....................................................................................................... 290
mgcp add ...................................................................................................... 291
voip del ......................................................................................................... 293
IPTV Commands .................................................................................................... 294
Video Profiles................................................................................................ 294
Multicast VLAN Registration (MVR) Provisioning ......................................... 296
Multicast Range Filters ................................................................................. 298
Enable Multicast to Multicast Mode (default) ................................................ 299
Enable Multicast to Unicast Mode ................................................................. 299
Show Multicast or Unicast Modes ................................................................. 300
Multicast VLAN Registration (MVR) Provisioning Examples ........................ 300
Pseudowire Commands ........................................................................................ 309
pwe3 mac ..................................................................................................... 309
pwe3 tdmmode ............................................................................................. 310
pwe3 bridge create ....................................................................................... 310
pwe3 bridge add IP ....................................................................................... 312
pwe3 bridge delete........................................................................................ 312
pwe3 t1port ................................................................................................... 313
pwe3 e1port .................................................................................................. 314
pwe3 service create ...................................................................................... 315
pwe3 service delete ...................................................................................... 318
PWE3 PM Statistics ...................................................................................... 318
PWE3 SNMP Support ................................................................................... 324
PWE3 Provisioning Examples ...................................................................... 325
Interface Commands ............................................................................................. 331
IfTable Commands........................................................................................ 331
Ethert Commands ......................................................................................... 332
IP Host Configuration .................................................................................... 332
10
Serviceability and Troubleshooting Commands ................................................ 336

bridge show summary (bri sh sum) ............................................................... 336
bridge show drops (bri sh dr) ........................................................................ 337
bridge show bridges (bri sh bri) ..................................................................... 338
bridge glob .................................................................................................... 340
ip host show .................................................................................................. 341
iphost options ................................................................................................ 342
ver ................................................................................................................. 342
show ethertable ............................................................................................ 343
show iftable (sh ift) ........................................................................................ 344
show ifstats (sh ifs) ....................................................................................... 345
show ifpowermanagement ............................................................................ 347
config diag .................................................................................................... 348
config history ................................................................................................. 350
Loss Plan Commands ................................................................................... 352
show ipconfig (show ipc) ............................................................................... 354
mgconfig ....................................................................................................... 355
voipreq .......................................................................................................... 358
voipcc............................................................................................................ 359
voiprtp ........................................................................................................... 360
voipconfig...................................................................................................... 362
show voip mib ............................................................................................... 364
show voice status.......................................................................................... 368
show voice errors .......................................................................................... 370
opt82 show ................................................................................................... 371
os log dump .................................................................................................. 372
pmcat ............................................................................................................ 373
os dump force and os dump clear ................................................................. 374
os sys............................................................................................................ 374
show voice counters ..................................................................................... 375
vtst test bp x.................................................................................................. 377
Message Posting Protocol Commands ......................................................... 381
meter show info ............................................................................................ 384
meter show count.......................................................................................... 385
macff show.................................................................................................... 386
Filtering and Mapping Display Commands ................................................... 387
show video stats ........................................................................................... 393
m2u ............................................................................................................... 394
m2u age ........................................................................................................ 397
ping ............................................................................................................... 398
dhcpl2 trace .................................................................................................. 400
Proxy ARP Trace (parp trace)....................................................................... 400
Non-ONT Commands ................................................................................... 401
Glossary........................................................................................................ 403
11
Ethernet OAM Provisioning .................................................................................. 405

Ethernet OAM Overview ............................................................................... 405
Ethernet OAM Terminology .......................................................................... 407
802.1ag MAID and Y.1731 MEG ID Compatibility Enhancements................ 414
Overview of Configuration Steps .................................................................. 416
Creating a Maintenance Entity Group ........................................................... 418
Creating the Maintenance End Point ............................................................ 422
Enabling Continuity Checks .......................................................................... 427
Creating Maintenance Intermediate Points ................................................... 430
Sample OAM Configurations ........................................................................ 432
Link Trace (L2 Traceroute) ........................................................................... 434
OAM Loopback (Layer-2 ping) ...................................................................... 437
OAM Loopback Examples ............................................................................ 439
OAM Loopback Status .................................................................................. 440
RFC2544 Loopback ...................................................................................... 441
Delay Measurement Alarms.......................................................................... 442
Loss Measurement Alarms ........................................................................... 446
Initiating an 802.3ah Loopback Test and Viewing the Results (Link OAM) ... 450
12
About this Guide

Calix 700GE and 700GX model ONTs (7xxGE, 7xxGX) support operation in Active
Ethernet (AE) mode. This document describes how to configure AE ONT services, and
includes the following information:
Overview of AE Systems - Includes information on network topology, attributes, and

hardware components. It also describes AE services, inventory management, and
features/characteristics of the Calix 700GE and 700GX ONTs.
Configuring an AE System - Includes information on system requirements, and
requirements for DHCP, NTP, Syslog, and SIP server configuration.
Understanding AE ONT Configuration Files - Details provisioning characteristics,
hierarchy, processing, and creation of configuration files. Also includes sample
configuration files.
Remote ONT Activation - Provides a step by step process for turning up an AE ONT
via Remote ONT Activation (RONTA).
Turning up an AE ONT - Provides a step by step process for turning up an AE ONT.
Includes configuring the Management VLAN, controlling the ONT boot process, and
monitoring of the ONT after boot-up. This section also describes various management
tools designed to allow the ONT to communicate with a variety of hosts or devices.
AE ONT Deployment Options - Includes information on deploying in a residential
gateway or subscriber to WAN mapping environment.
System Maintenance and Troubleshooting - This section describes various
maintenance and troubleshooting techniques needed to manage the AE network.
Command Reference - Includes a complete AE CLI Command Reference including
command examples.
Intended Audience
This document is intended for personnel responsible for turning up carrier network systems
and services. This guide assumes that users are familiar with computer systems and software
and have some knowledge of telecommunications and engineering standards. Familiarity with
the Calix E7 or B6 AE OLT systems o(r other standards-based fiber Ethernet OLT
switching and aggregation platforms), as well as knowledge of fiber access and SFP optics
module technology is highly recommended.
13
Related Documentation
You can access Calix product documentation online from the Calix Resource Center at
www.calix.com.
The Calix Active Ethernet ONT R2.0 documentation set includes:
Calix 700 AE R2.0: Active Ethernet ONT Configuration Guide (this document)
Managing Calix 700 AE ONTs from CMS (11.3)
14
Chapter 1
Active Ethernet Overview
AE Topology
Active Ethernet is a point-to-point architecture that connects an Ethernet aggregation switch
and an ONT. This point-to-point topology uses dedicated fiber and bandwidth for each
element in the system.
AE terminology in this document is intended to differentiate this technology from the

GPON technology where ONTs freely share bandwidth over a fiber access network. The
Active terminology implies a point-to-point architecture with intelligent devices located at
each endpoint.
With AE release 2.0, all Calix 700GX and 700GE ONTs receive broadband data, VoIP (SIP,
TDM Gateway, or H.248) telephone service, and IP based video (IPTV) using point-to-point
fiber links within the network.
16
Key AE Attributes
The Calix AE 2.1 fiber access solution offers the following attributes:
Symmetrical Gigabit Ethernet data services using 700GX, 700GE, and 760GX ONTs
Fully compliant IEEE 802.3ah standard AE technology including 2000 byte frame size
Ethernet Operations, Administration, and Maintenance (OAM) in compliance with
IEEE 802.1ag, 802.3ah, ITU Y.1731, MEF17 and RFC 2544 Reflector
Integrated GE and 10GE aggregation and transport using C-Series (C7), E-Series (E5,
E7, E5-400), and B-Series (B6) platforms
ONTs for providing Single Family Unit (SFU) and Business services
Small Business Unit (SBU), Multi-Tenant Unit (MTU), and Mobile BackHaul (MBH)
applications
Indoor, outdoor, and rack mountable ONTs with auto-detect GPON/AE adaptive
optics
Ethernet data services, including high speed Internet access and MEF-compliant E-Line
and E-LAN Transparent LAN Services (TLS)
IGMP multicast switching, multicast address mapping and Multicast VLAN Registration
(MVR)
T1 and E1 leased line and private line services
ONT Port Security, MAC Forced Forwarding, and ARP Proxy
Support for Bi-Directional (BIDI) SFP modules and Compact SFP (CSFP) modules for
single fiber and high density AE applications
60 km network reach on a single fiber AE link using GX series ONTs
50 km network reach on a single fiber AE link using GE series ONTs
Layer-2 Differentiated Services Code Point (DSCP) p-bit mapping and Layer-2 Control
Protocol (L2CP) filtering for business services
Usability Attributes
Web Activate (GE ONTs) or Voice Activate (GX ONTs) remote ONT Registration
functionality
Static IP Addressing capability on all GE ONTs
17
Voice Attributes
GR-303/TR-08 mode II/GR-57 voice switch interfaces using the Calix C7 TDM Voice
Gateway
GR-303 and TR-08 TDM voice switch interfaces via the B6 Voice Gateway
SIP, H.248, and MGCP based VoIP solutions using integrated ONT clients
MGCP interop via the B6 Voice Gateway
International POTS functionality with T.38 fax interface
Provisionable country-specific POTS line parameters via updated VoIP Configuration
file (VoipConfig.txt)
International SIP switch interoperability (Metaswitch and other country specific vendors)
Ethernet Data Service Features
AE Subscriber Port Association functionality

High-speed data traffic shaping for 700GE ONTs
Enhanced OAM support (Y.1731 MEG ID/802.1ag MAID compatible) for 760GX and
740GE ONTs
Ethernet OAM, Continuity Fault Management, TLV enabled loopback testing with
expanded frames, interop with test equipment manufacturers.
AE Hardware Components
Each subscriber on an AE network is connected to the E7 optical network via a single fiber
at pre-determined aggregation points. A typical E7 AE network consists of the following
components:
Calix E7 system: The Calix E7 serves as the optical line terminal (OLT) and aggregation
switch for Active Ethernet services. The E7 terminates optical fiber service drops to the
Calix ONTs providing the service access interfaces at the customer premises. For AE
applications, the E7 is typically equipped with up to two of the following Gigabit
Ethernet line cards:
E7 GE-24 Card: Provides 24 GE interfaces per card, achieved using Compact SFP
(C-SFP) GE optics modules supporting up to 48 total 1GE point-to-point service
drops (48 ONTs) per E7-2 chassis. Each GE-24 card is also equipped with two
integrated 10GE ports for aggregation uplinks.
E7 GE-12 Card: Provides (12) GE interfaces per card, supporting up to 24 total

1GE point-to-point service drops (24 ONTs) per E7-2 chassis. The GE-12 card uses
bi-directional single fiber GE optics modules. Each GE-12 card is also equipped with
two integrated 10GE ports for aggregation uplinks.
Note: You can also use the GE ports on E7 10GE-4 and GPON-4 cards for AE
services delivery. However, by offering greater port density, the E7 GE-24 and GE-12
cards are optimized for AE network applications.
18
Calix 700GX/700GE SFU and 760GX MDU ONTs: The Calix 700 Series ONTs
reside at the customer premises. ONTs provide the subscriber access interfaces for
Ethernet High Speed Data, IPTV, T1/E1, and POTS services. Indoor, outdoor, and
rack-mount ONT options are available.
Calix C7 with TDM Gateway: The Calix C7 Multi-Service Access Platform (MSAP)
can provide gateway functionality for both TDM voice and T1/E1 data services. For
traditional GR303/TR-08 voice services delivered over AE access, calls are carried in
VoIP format over the Ethernet access infrastructure, and then converted to TDM format
at the C7 TDM gateway for delivery over a traditional switch interface to the PSTN.
19
AE Services Overview
Configuring AE ONT Voice Services
AE ONTs support four methods for providing voice services:
TDM Gateway - The TDM Gateway option interoperates with a C7 voice gateway,
which converts VoIP traffic back to TDM format for exchange on the PSTN.
SIP -A SIP agent/IAD function on Calix 700GX/GE ONTs converts voice signals on
its POTS ports into packetized format. The SIP service option operates as a traditional
VoIP offering, registering with a SIP softswitch. With AE Release 2.2, support for peerto-peer VoIP service that allows the ONT to operate with an E7 as a subtended SIP
voice gateway.
H.248 - H.248 is an application layer control protocol used for creating, modifying, and
terminating voice communication sessions over an IP network infrastructure. This
master/slave communication model separates the call control logic from the media
processing logic in a network gateway. Call control is handled by the Media Gateway
Controller while the processing function is handled by the Media Gateway. H.248 is
defined in IETF RFC 3525 Media Gateway Control (MEGACO) protocol.
MGCP - Similar to H.248, the Media Gateway Control Protocol is described in IETF
RFC 2805 and RFC 3435. MGCP consists of a Call Agent (call control intelligence) and a
media gateway which converts analog TDM voice to Voice over IP packets. MGCP
Gateways contain endpoints where the Call Agent creates, modifies, and deletes
connections with other endpoints. Endpoints automatically communicate changes in
service state to the Call Agent while the Call Agent audits endpoints and connections to
endpoints.
Each voice service option requires an IP host definition object that specifies an IP host
address for VoIP. (The definition references a tag action that specifies the classifying and
marking of packets from the subscriber port into the service VLAN).
Before starting
Before starting the services configuration process, check that the following conditions are
met:
1. The necessary system profiles that support AE applications are created.
Voice Service Profile (SIP, TDM Gateway, H.248, MGCP)
Interface Groups have been added to the AE Systems Setting page (TDM
Gateway only).
Service Tag action - For voice traffic the P-bit value must be set to 5, 6, or 7.
A SIP Configuration File (on page 135) has been created and its location defined in
the Global SIP Profile.
20
2. The AE voice port is configured.
ONT provisioning
3. The Provisionable POTS loss plan is set per your requirements.

Voice services configuration process
Assuming that the conditions stated above are met, the voice services can be added to the
ONT voice port, by selecting one of the following approaches:
TDM gateway service (GR-303, GR-08):

Ports tab approach:
Configure the ONT Voice port for service.
Create a TDM Gateway voice service on the ONT Voice port.
Services tab approach:
Open the Create dialog box to add a voice service to an ONT Voice port.
SIP service:
Ports tab approach:

Configure the ONT voice port for service.
Create a SIP voice service on the ONT Voice port.
Open the Create dialog box to add a voice service to an ONT Voice port.
H.248 service:
Ports tab approach:

Configure the ONT voice port for service
Create an H.248 voice service from the Ports tab
Create an H.248 voice service from the Services tab
MGCP service:
Ports tab approach:

Configure the ONT voice port for service
Create an MGCP voice service from the Ports tab
Create an MGCP voice service from the Services tab
21
Provisionable POTS Loss Plan

To improve performance of the ONT POTS interface, the system now includes POTS
signal-level loss plan settings. Voice signal-level loss is provisionable according to GR-909 or
ANSI specifications. Newer digital phones are typically designed per ANSI standards and
therefore receive the voice signal at a lower signal level than older GR-909 based phone.
Note: Prior to AE Release 2.1, POTS signal-level loss was fixed at the GR-909 standard.
When setting Signal-level loss, the following values are implemented:
GR-909: -2 dB Transmit and -4 dB Receive gain (loss)
ANSI: -3 dB Transmit and -9 dB Receive gain (loss)
The POTS Loss plan feature is provisioned using the any of the following commands:
voip add (on page 283)

ctg add (on page 288)
Several troubleshooting commands (on page 351) are also available to assist in loss plan control.
Session Initiated Protocol (SIP)

Provisioning SIP voice services requires the definition of a configuration file which details
basic voice service parameters in the ONT. Detailed VoIP provisioning is done in a separate
VoIP configuration file and is called out in the ONT configuration file. Information includes
the name of the VoIP configuration file, the VoIP configuration file server, and a secondary
VoIP configuration server (if desired).
Note: Because the SIP service works identically in both GPON and AE mode, the same
VoIP configuration file can be used to provision SIP services on either GPON or AE ONTs
simultaneously.
Note: SIP services are implicitly associated to an ONT IP-Host object. The IP-Host object
specifies a svc-tag-action, which provides the VLAN association.
SIP Provisioning Persistence
AE Release 2.0 supports SIP provisioning persistence within the AE ONT. After initial VoIP
configuration and provisioning, any ONT reboot causes the ONT to look to its SIP TFTP
provisioning server for current and/or revised configuration information. If the AE ONTs
request for a new configuration file times out, it uses the most recent configuration file
retained in the ONTs flash memory for service provisioning. When re-provisioning an ONT
in the field, Remote ONT Activation (RONTA) can be used to clear configuration
information.
A more complete description of the provisioning persistence feature is found in the ONT
provisioning section of this document.
22
Provisioning Peer-to-Peer VoIP Service

E Release 2.2 adds a peer-to-peer VOIP feature that allows the ONT to operate with an E7
platform as a subtended SIP voice gateway. The E7 platform can be used to configure the
SIP network using ONTs functioning as local SIP gateways.
A typical VoIP access network include a router (Layer 3 demarcation point) between the
access network (Layer 2) and the SIP Softswitch. The router isolates the soft-switch from the
access network broadcast domain.
In most applications the VOIP VLAN is configured with MAC Forced Forwarding enabled,
thereby forcing all IP traffic from the access network toward the router. In some small
network configurations the SIP softswitch may be linked directly to the Layer 2 access
network. This configuration can be used for small network segments which have a limited
number of VOIP subscribers per softswitch interface. The result is a lower cost network, at
the expense of reduced security and scalability. Since there is no network gateway (this is a
pure Layer 2 network), MAC Forced Forwarding cannot be performed. In this Layer 2
network each SIP host can communicate directly with each other, and all broadcast traffic
will be seen by each SIP host.
Note: The number of SIP hosts limits the scalability of the network. In the case of an E7
VDSL line card, one SIP host can represent up to 48 subscriber voice ports. For ONTs, each
SIP host often supports a single voice port; some MDU ONTs may support 4 or 8 voice
ports per SIP host.
A more common flat Layer 2 network would consist of a single network element providing
access to the softswitch. Note that a single E7-2 chassis populated with 2 GPON-4 line cards
contains 8 PON ports and 16 Ethernet ports. If fully populated with a 32-way split per PON,
and Active Ethernet ONTs subtended from each Access GE port, this chassis could support
(8*32)+16 = 272 ONTs. Although this is a very unlikely configuration it should be
considered as an absolute upper limit for the number of SIP hosts on a flat Layer 2
network. As a rule for designing a flat, Layer 2 SIP network, a maximum of 250 SIP hosts
should be considered the upper limit.
Peer-to-peer SIP service can be configured for either DHCP or Static IP Host environments.
To configure SIP service for Peer-to-Peer VoIP via CLI
1. The following parameters must be configured to configure static host SIP service:
a. The Host Protocol must be set to static (dhcp disable)
b. The Gateway Force option must be disabled.
c. Enter the desired Static IP Address for the Voice Service.
d. Enter the desired Static IP Mask (255.255.255.0).
e. Enter 0.0.0.0 in the Static IP Gateway field.
f. Specify the port.
23
g. Ensure the voice switch is configured on the same subnet.

h. From the CLI: iphost
create -dhcp=disable -gwf=disabled -static=10.23.26.2

-mask=255.255.255.0 -gateway=0.0.0.0 dev=iph=1
2. The following parameters must be configured to provision DHCP SIP service:

a. The Host Protocol must be set to dhcp (dhcp enable)
b. The Gateway Force option must be disabled.
c. The port must be specified.
d. From the CLI: iphost
create -dhcp-enable -wwf=disable dev=iph-1
3. Ensure the VoIP VLAN is configured with MAC Forced Forwarding enabled, forcing all
IP traffic from the access network to the router. The router then hairpins traffic back to
the access network for peer-to-peer communication.
4. Apply and Resync the ONT to save the changes.
Calix TDM Gateway (CTG)

The Calix C7 TDM gateway provides a gateway to the circuit-switched PSTN for TDM over
Ethernet lines on subtended Calix platforms. Calix service platforms that support a TDM
gateway client include the E-Series platforms and the 700 family of ONTs operating in
GPON or AE mode. These units interface to the C7 via an Ethernet link, and the C7 in turn
provides a GR-303, TR-08 or GR-57 switch interface to the PSTN for the subtended VoIP
lines.
Note: Although the TDM Gateway feature uses GR-303 to communicate with the C7 T1
card, the ONT SIP client employs a custom C7 protocol to communicate with the VIPR and
EGW server. In turn, the VIPR and EGW servers employ GR-303 to communicate with the
Class 5 switch via the C7 T1 card.
To support TDM gateway applications, the C7 must be equipped with at least one Voice
over IP Resource (VIPR) or Ethernet Gateway (EGW) plug-in card. The C7 VIPR card
hosts a gateway interface provisioned as a SIP voice concentration group (SIP VCG)
to perform the concentration and format conversion of voice traffic from the subtended
unit. The VIPR card receives encapsulated TDM over Ethernet packets from the E-Series
platform or ONT (via a C7 Ethernet downlink interface) and converts the voice content to
TDM format for delivery to a C7 GR-303, TR-08 or GR-57 switch interface. The C7 passes
ABCD signaling events (including ringing and loop-current events) between the VIPR and ESeries platform or ONT via RFC 2833 packets.
Note: CTG services are implicitly associated to an ONT IP-Host object. The IP-Host object
specifies a svc-tag-action, which provides the VLAN association
For additional information on TDM Gateway set-up, refer to VoIP Commands (on page 280)
in the Command Reference section of this guide.
24
Ground Start POTS Service

In AE 2.0, 7xxGX and 760GX ONTs support ground start signaling. Ground start is a
POTS signaling technique that is used to produce dial tone by momentarily grounding one
side of a two-wire circuit. The ring side of a wire pair is usually the side that is grounded.
Ground start signaling is often used for telephone lines connected to a PBX as well as many
pay phones use ground start signaling. The alternative to ground start is loop start.
Note: 700GE ONTs do not currently support ground start signaling.
SIP and C7 TDM gateway-based VoIP services support ground start, settable by a line in the
VoIP configuration file (establishing a choice between loop start and ground start POTS).
To set up ground start, the linemode command is used at the AE CLI:
-linemode=GroundStart
or
-linemode=LoopStart
The following AE CLI commands support the linemode option:
voip add (on page 283)
ctg add (on page 285)
voip setup (on page 281)
ctg setup (on page 285)
Note: Linemode syntax is case sensitive (uppercase "L", "G", and "S" must be used).
Note: In order to eliminate the need for updating existing ONTs using loopstart service, the
linemode command can be omitted and ONTs will continue to default to loopstart.
An example voip add script (on page 128) is included elsewhere in this document for reference.
25
Ethernet Data Services

AE 2.0's Ethernet Data Service model is based on either VLAN per service (on page 189) or
VLAN per port (on page 189). When connected to the network, Calix ONTs support
bandwidth management and Quality of Service (QoS). Whether connected to a C7, E5, or E7
OLT, the network provides up to 1 Gigabit of data to the ONT. In addition, DHCP relay
agent and PPPoE user agent are supported at the source (switch) and any 700GE ONT.
Business service, IPTV, and HSD services are supported simultaneously on any Calix ONT.
AE business data services deliver high bandwidth with traffic marking to prioritize business
traffic relative to residential service. Q-in-Q VLANs and TLS are used for business grade
services.
The tagging behavior and packet processing rates on the 700GE and 760GX ONTs assure
that the ONTs meet MEF 9 and 14 requirements independent of the OLT.
Active Ethernet supports features that allow a service provider using an E-Series platform to
aggregate traffic into a specific S-Tag VLAN. Enabling features include:
MAC address Organizationally Unique Identifier (OUI) - included in Release 1.0

C-Tag (incoming outer tag) - included in Release 1.0
P-bit value - included in Release 1.0
MAC Forced Forwarding - included in Release 1.1
New features in AE Release 2.0 include (described in detail below):
Add or remove S-Tag VLAN-ID (on page 25) on any Ethernet port
Layer-2 Marking (on page 25) based on MAC SA or MAC DA
Data Throughput (on page 26) in AE Mode of 1 Gbps on 700GE and 760GX ONTs
ONT MTU (on page 26) size of 1600 bytes
Independent security options (on page 238) for MACFF, DHCP, and SV
Add/Remove S-Tags
With AE Release 2.0, the service provider has the ability to add and remove S-Tag VLANIDs on any Ethernet port in order to provide clear traffic aggregation based on customer
defined conditions.
MAC SA or MAC DA
The Calix AE platform uses a Layer 2 filtering/mapping table based on MAC SA and DA.
This Layer 2 table operates on the subscriber side of the WAN Bridge for each Ethernet
port.
This Level 1 Layer 2 filtering/mapping table is typically used in the absence of managed
switches or RGs at the subscriber network. The table currently supports filtering/mapping
by MAC DA or MAC SA. The primary operations defined for the Level 1 table include:
26
Filter on MAC SA, Add a single VID, with explicit PBIT setting and defined Output
TPID, for example ethertype (result = single tag). This feature allows for mapping STBs
and external IADs to network provider VLANs .
Filter on MAC SA or MAC DA offers the ability to drop unwanted traffic (packets) at
the ONT.
Note: MAC DA/SA was part of an earlier AE software release.

MTU Frame Size
In AE Release 2.0, the Maximum Transmission Unit (MTU) for ONT services has been
increased to 1600 Bytes (1626 Bytes when factoring in Ethernet header and two tags). This
increase is designed to support applications such as mobile backhaul and business services.
In addition, various CLI reports allow you to view the state/status of MTU frame sizes by
port type. See the topics showiftable, (on page 343) bridgeshowdrops, (on page 336) and mpp ess
(on page 381) located in the appendix of this guide.
Note: With E7 Software Release 1.1, the platform system default MTU size was increased to
2000 bytes in anticipation of future MTU increases on ONTs. With AE R2.0, the maximum
MTU remains 1600 Bytes, the change to the E7 MTU system default does not result in
changes to any currently provisioned MTU on existing GE Ethernet interfaces.
Data Throughput
76xGX and 7xxGE ONTs support sustained 1 Gbps full duplex throughput simultaneously
on a single or multiple Ethernet ports.
76xGX ONT
Process up to 2.6 million packets per second (pps) in aggregate

Provide upstream and downstream policing of 1,000 Mbps per ONT
Support 64 kbps bi-directional traffic shapers up to 2 Mbps and 1 Mbps traffic shapers
after 2 Mbps, 8 Mbps traffic shapers above 100 Mbps
Support per VLAN metering
7xxGE ONT
Process up to 2.7 million pps (line rate) in aggregate

Support downstream policing of up to 1,000 Mbps
Support 64 kbps bi-directional traffic shapers up to 2 Mbps and 1 Mbps traffic shapers
after 2 Mbps, 8 Mbps traffic shapers above 100 Mbps
Support per VLAN metering
27
About Traffic Policing and Traffic Shaping

With AE R2.0, the concept of traffic policing is introduced on 7xxGE and 76xGX ONTs.
Unlike traffic shaping (used exclusively on 7xxGX SFU ONTs), traffic policing facilitates
bursts of data. When the traffic rate reaches the configured maximum rate, excess traffic is
dropped (or remarked), resulting in an output rate that appears saw-toothed with crests and
troughs.
In contrast to policing, traffic shaping is a storing/forwarding technique that retains excess
packets in a queue and then schedules any excess packets for transmission over increments
of time. The result of traffic shaping is a smoothed packet output rate, with zero packets lost.
Using any common TCP or UDP bandwidth performance monitoring tool, actual data rates
can be predicted per the methods used above.
Note: On 7xxGE ONTs using the traffic policing model, p-bit priority is ignored since
packets are not queued. Setting the p-bit value in a traffic shaping environment will have its
desired effect.
28
7xxGE or 76xGX ONT Sawtooth Bandwidth Pattern

GE ONT (20/20 Mbps Profile) (clear saw-tooth data rate):
[136] local 192.168.1.217 port 57029 connected with 192.168.1.73
port 5001
[ ID] Interval
Transfer
Bandwidth
[136] 0.0- 2.0 sec 8.05 MBytes 33.8 Mbits/sec
[136] 8.0-10.0 sec 5.10 MBytes 21.4 Mbits/sec
[160] local 192.168.1.217 port 5001 connected with 192.168.1.73 port
34570
[ ID] Interval
Transfer
Bandwidth
29
7xxGX SFU ONT Smooth Bandwidth Pattern

GX ONT (20/20 Mbps Profile):
[136] local 192.168.1.217 port 57248 connected with 192.168.1.73
port 5001
[ ID] Interval
Transfer
Bandwidth
[108] local 192.168.1.217 port 5001 connected with 192.168.1.73 port
53639
[ ID] Interval
Transfer
Bandwidth
30
Calculating 700GE ONT Policed Rates
With the addition of the 7xxGE family of ONTs, a configurable committed packet burst size
feature has been added. Refer to the meter set downstream (on page 264) and meter set upstream
(on page 265) for details.
By default, the minimum burst size is set to 80 kbytes. However, if the specified shaper
applied to the VLAN/ETH port is greater than 512 kilobytes per second, then the following
formula is applied to determine the appropriate burst size:
Burst (bytes) = (rate/(10 * 1000)) * 1875
Thus, if you are using 10 Mbps as your shaper, the burst size calculation is as follows:
1,875,000 (Burst in bytes) = (10000000/(10 * 1000)) * 1875
For example, assume the following configuration:
meter set upstream shaper=0 cir=10000000 pir=10000000
meter set downstream shaper=0 cir=10000000 pir=10000000
bridge add -lb=enable -mf=enable vid=115
bridge portadd vid=115 dev=eth-0
lev2 add -treatinpri=0 -treatinvid=115 dev=eth-0
meter attach downstream -vid=115 shaper=0
meter attach upstream -vid=115 shaper=0
set iftable adminstatus index=eth-0 adminstatus=up
Using the formula above, the burst size is automatically calculated by the AE ONT as shown
in the output of the meter get downstream (on page 265) and meter get upstream (on page 266)
commands as shown below:
CXNK0006CDA0> meter get downstream hwcfg shaper=0
shaper = 0
tci
= 115
rate
= 10
rate_u = 1
cbs
= 1875000
CXNK0006CDA0> meter get upstream hwcfg shaper=0
shaper
tci
rate
rate_u
cbs
=
=
=
=
=
0
115
10
1
1875000
Note: Calix recommends not setting the committed burst size smaller than the MTU of the
interface.
31
AE Data Rate Limiting and Traffic Shapers

AE R 2.0 implementation allows configuration of "per UNI" rate limiters or per VID rate
limiters in both the upstream and the downstream direction.
Number of rate limiters
7xxGE - 16
7xxGX - 32
76xGX - 64
7xxGE and 76xGX UNI Rate Limiting Granularity
Range
Granularity
0-2 MB
64 Kb
2-100 MB
1 MB
100 MB - 1 GB
8 MB
7xxGE and 76xGX per VID Rate Limiting Granularity

Range
Granularity
0-8 MB
64 Kb
8-255 MB
1 MB
256-511 MB
2 MB
512 MB - 1 GB
4 MB
The 7xxGX SFU ONTs use shaping to rate-limit up to 200 Mb/sec. The 7xxGE and 76xGX
ONTs use policing and both can rate limit from 0-1Gb/sec.
Shaping is actually a storing and forwarding technique which smooths delivery of packets and
does not force TCP to lose packets as policing does. When shaping is employed, TCP does
not exhibit a saw-tooth behavior during file transmissions.
32
High Speed Internet Traffic Shaping for 700GE ONTs

AE R2.2 provides a new shaping function for the 700GE and 740GE ONT on the HighSpeed Internet (HSI) VLAN. Shaping is applied to provisioned rates up to 250 Mbps before
reverting to policing. This type of shaping is best suited for classic single family unit "triple
play" environments and is not intended for applications where a high amount of bandwidth
is needed across a single ONT.
Note: The new HSI traffic shaping logic only applies to 700GE and 740GE ONTs in this
release. Support for 760GX ONTs will be available in a future release.
When implementing data services, knowing when to implement traffic shaping versus traffic
policing (discussed in the previous topic) is critical to ensuring uninterrupted traffic flow.
Calix has determined that policing is not optimal when attempting to rate-limit subscriber
data in certain throughput testing applications. TCP speed-test systems, such as the Ooklabased server used by many home users, do not tolerate packet loss caused by data policing
methods. When packet loss occurs, these speed-test systems report inconsistent data
throughput results, as opposed to reporting the provisioned rate.
Using buffers to shape subscriber data smoothes the peaks in data transfer without
discarding packets. Eliminating packet loss through shaping allows the speed-test systems to
record data rates in line with provisioned rates. Losing data packets during traffic peaks
(which significantly affects speed-test system results) is generally avoidable with shaping and
unavoidable when only using the policing option.
Before implementing data traffic, it is important to understand how 700GE ONTs process
data packets. With AE Release 2.2, traffic shaping on the 700GE ONTs is limited to a single
VLAN per ONT irrespective of the type of environment it is being deployed into (for
example, a single family unit versus multi-dwelling or business unit deployment).
Based on these deployment variations, it is helpful to know how the traffic shaper functions
in detail. Once known, these "qualifiers" suggest only extreme corner cases might impact
traffic shaping usefulness. The qualifiers for determining whether the new shaping logic is
applied are as follows:
1. Shaping is enabled by default and automatically selects a single VLAN if all of the
following criteria are met for typical HSI service:
a. MACFF is enabled
b. IP Src Verify is enabled
c. DHCP Snooping is enabled
d. IGMP Snooping is disabled
e. 250 Mbps or less bandwidth is provisioned for the service
2. If more than one port is configured for VLAN with traffic meeting the shaper
requirements, only the most recently configured VLAN will apply shaping to the port. All
other VLANs will revert to the policing model rather than shaping.
33
3. All policing is enabled even when shaping is in effect. However, it has no impact on
traffic that passes the shaping criteria (except as noted directly above) and only serves to
"protect" the network.
4. In this initial release, shaping control is limited to globally turning on or off the shaping
feature from the command line.
When configuring high speed internet services, the system will select the appropriate burst
size depending on the rate of the shaper. If you configure the burst size using an Ethernet
bandwidth profile, it may impact metering.
Note: It is possible to set the upstream burst size (UP-CBS) from 4 to 16000 kilobytes,
however, an extremely small value may prevent TCP transactions, causing the Ookla speed
test to not connect. In addition, configuring the upstream burst size to values to other than
system selected rates may cause varying and unpredictable results for the Ookla speed test.
About PPPoE Deployments
Since PPPoE does not meet a number of the qualifiers mentioned above, special provisions
are needed to allow the use of the traffic shaping logic. To ensure that PPPoE deployments
don't automatically revert to traffic policing, the traffic shaper can be enabled by specifying
the VLAN ID of the port carrying PPPoE traffic. This command (meter ookla vlan) is available
from the CLI only and must be executed after the VLAN has been attached to the shaper.
meter ookla vlan
The meter ookla vlan command adds shaper optimization to a specified attached VLAN (useful
in PPPoE environments where the single VLAN qualifiers are not met).
meter ookla vlanid
CXNK08900005> meter ookla vlan

Usage: meter ookla vlan vid=
Add Ookla optimized shaping on a specific VLAN, VLAN must already
be attached.
Parameters:
vid=
WAN VLAN Id value flow (1-4094)

type: Unsigned
Example: meter ookla vlanid 200
34
Business Ethernet Services

Effective with AE Release 2.1, Ethernet Business Services are enhanced with the addition of
Layer 2 p-bit Differentiated Services Code Point (DSCP) mapping and Layer-2 Control
Protocol Filtering (L2CP).
Differentiated Service Code Point (DSCP) P-Bit Mapping
DSCP uses a 6-bit field in the IP header for packet classification. DSCP enables different
levels of service to be assigned to different types of network traffic (for example, low-latency
critical network traffic such as voice or streaming video will be given one p-bit value, while
best-effort file transfer or web traffic is assigned a different value). Each packet is marked
with a DSCP code and a corresponding P-bit value.
Layer-2 P-Bit mapping based on a layer-3 DSCP value is needed for QoS when a gateway or
other network element set packet priority only on the Layer-3 level. Effective with AE
Release 2.1, Calix ONTs map the Layer-3 DSCP value to a p-bit value using a per port table
of DSCP values.
Untagged frames are classified into a VLAN by OUI filtering and Tag-on-Untagged frames.
A per port DSCP 2 p-bit table is used to set the p-bit for the untagged frame's QoS
classification.
Keep the following information in mind when working with DSCP P-Bit mapping:
DSCP P-Bit Mapping is a packet marking function and not packet classification.
DSCP mapping can be performed on a per subscriber, per port model.
The AE ONT still relies on the traffic shaping algorithms introduced in AE 1.0 (VLAN
or port dependent). DSCP P-Bit mapping does not affect traffic shaping.
DSCP mapping only applies to untagged traffic.
Mapping can be applied to lev1 and lev2 filters on the same port and can be applied to
two different VLANs.
Note: DSCP mapping is provisioned via CLI only (available in a future CMS release).
Common P-Bit mapping assignments are shown below:

DSCP P-Bit Mapping Assignments
pBit
DSCP
56
48
40
32
24
16
35
L2CP Filtering
With this release, support for filtering of L2CP packets from three pre-defined multicast
MAC address ranges has been added. L2CP filtering is a provisionable attribute (Pass/Block)
and applies to all ONTs. With this feature, service providers set the ONT to either discard
or pass the tunneling of the following Bridge Protocol Data Units (BPDU's):
Bridge blocking of protocols

GARP blocking of protocols
All Bridge protocols
Available on a per-ONT port or Ethernet Virtual Circuit (EVC) basis, filtered MAC address
ranges (starting and ending) are performed as shown here:
L2CP Filtering
L2CP Filter Range
Starting MAC
Ending MAC
Bridge Protocol Data Unit (BPDU)
01:80:C2:00:00:00
01:80:C2:00:00:0F
Generic Attribute Registration

Protocol (GARP)
01:80:C2:00:00:20
01:80:C2:00:00:2F
All LAN Bridge Management Group
01:80:C2:00:00:10
01:80:C2:00:00:10
Prior to AE 2.1, L2CP frames were handled based on data model and ONT type:
L2CP Filter Treatment by ONT type and Data Model
AE R2.0 and Below
SFU GX ONTs
HSI
TLAN
Passed
Passed
SFU GE ONTs
Passed
Passed
MDU GX ONTs
Discarded
Discarded
L2CP Filter Considerations

When implementing L2CP filtering in AE 2.1, keep the following information in mind:
L2CP is not a protocol in itself. Rather, L2CP is an acronym that identifies various Layer2 Control Protocol (BPDU, GARP, or LAN Bridge) tunneling characteristics.
After upgrading to AE 2.1, all L2CP frames are discarded by default.
Link OAM (IEEE 802.1ag) uses the 01:80:C2:00:00:30 through 01:80:C2:00:00:3F MAC
Address range. As such, Link OAM traffic is treated as data frame and passed by default.
For customers using the TLAN data model in AE 2.0 and below, the L2CP behavior may
create issues with filtered traffic. Refer to Layer 2 Control Protocol (L2CP) Handling in
TLAN Environments (on page 36) for additional information.
Note: For Calix MDU ONTs, L2CP Filtering is supported on 760GX, 766GX, and 767GX
ONTs only.
36
Configuration Steps
The provisioning of L2CP filters is performed via CMS.
The feature can be activated via CLI using the L2CP portmode (on page 253) command.
Output of this command can be viewed by running the L2CP show command.
L2CP Handling in TLAN Environments
Layer-2 Control Protocol Filtering (L2CP) is a Metro Ethernet Forum (MEF) driven
requirement for business services that use Bridge Protocol Data Unit (BPDU) tunneling.
When implemented with the Calix 700 ONT Active Ethernet solution, the service provider
can set the ONT to discard or pass the tunneling of various categories of data frames.
Note: If your application does not require the passing of BPDUs, GARPs, or ALL-LAN
frames, changes to L2CP Filtering options are not required when upgrading to AE R2.1.
When upgrading to AE R2.1, the default L2CP filtering behavior changes as follows:
AE R2.0 and
below (HSI, TLAN)
AE R2.1 and above

(HSI, TLAN)
700 GX SFU
Frames are Passed
Frames are Discarded
700 GE SFU
Frames are Passed
76x GX SBU
ONT Type
Upon upgrading to AE R2.1, the default behavior for L2CP filters will automatically change
to "discarded" on 700GX and 700GE ONTs. For this reason, if passing BPDU frames is
required, you must create ONT Ethernet Security Profiles that return the tunneling behavior
to "passed" prior to upgrading the AE R2.1 firmware.
Note: The behavior of L2CP frames on 76xGX ONTs are not affected when upgrading. By
default, frames are always discarded regardless of AE firmware release number.
Note: For Calix MDU ONTs, L2CP Filtering is supported on 760GX, 766GX, and 767GX
ONTs only.
Due to the change in default behavior of L2CP Filtering in AE R2.1, Calix recommends
creating new L2CP and ONT Ethernet Security Profiles for your in-service ONTs to
maintain existing services upon upgrade to AE R2.1. Perform the following steps to prepare
your AE ONTs before upgrading to 2.1 software.
To configure support for L2CP Filtering before upgrading to AE R2.1
1. Upgrade your CMS client to CMS 11.2.3xx or above. (This CMS version includes the
tunneling option when creating Ethernet Security Profiles. Refer to Calix Management
System (CMS) R11.2 Installation and Upgrade Guide - Linux for complete upgrade
instructions.)
37
2. Create an L2CP Profile to define filtering parameters based on frame type (BPDU,
GARP, and ALL-LANS)
a. Within CMS, navigate to CMS > Profile > ONT > L2CP Filter.
b. From the Work Area menu bar, click Create.
c. Accept the default ID Number (next available).
d. Name the New Global ONT Ethernet Security Profile (for example, "all-tunnel")
e. For each frame type listed, select discard.
f. Click Create.
3. Create an ONT security profile to enable the tunneling behavior established above:
a. Within CMS, navigate to CMS > Profile > ONT > Ethernet Security
b. From the Work Area menu bar, click Create.
c. Accept the default ID Number (next available).
d. Name the New Global ONT Ethernet Security Profile (for example, "L2CP-tunnel").
e. Set the DHCP Lease Limit (the maximum number of leases allowed on the ONT
Ethernet port).
f. Set the Upstream Broadcast, Multicast Limit (the maximum rate of Layer-2 broadcast
traffic per second on the ONT Ethernet port).
g. Choose the L2CP filter created above ("@all-tunnel").
h. Click Apply.
4. Apply the new AE ONTs Security settings to the AE ONT Ethernet port:
a. Within CMS, from the Ports Tab, select the Ethernet port to update.
b. In the Security Profile field, choose the newly created Ethernet Security Profile that
allows tunneling.
c. Click Apply.
Note: Do not perform a Sync All or reset the ONT at this time. Performing a reset now
(on AE R2.0 software) will create an error since the L2CP Filtering tunnel option is not
supported in this release).
5. Repeat step 3 for all ONT Ethernet ports that require tunneling.
6. Upgrade AE ONTs to AE R2.1. Refer to About Global Firmware Uploads for detailed
upgrade instructions.
38
Ethernet Services
This section describes how to create data services on an AE ONT.
Calix ONTs provide data interconnection between Internet service providers and subscribers
using Calix 700GX or 700GE ONTs. Data Service Profiles and Service Tag Actions provide
tiered service offerings by specifying how packets are classified and marked from the
subscriber port to the service VLAN.
Calix ONTs support VLAN per port or VLAN per Service data service environments.
Before you Begin
Before starting the data service configuration process, check that the following conditions are
met:
1. The necessary ONT system profiles that support AE ONT applications are
created.
Traffic Management Profiles:
Service match list to classify the subscriber traffic (VLAN tag action rule)
Service tag action
Ethernet Bandwidth Profile
(Optional) Ethernet Security Profile
Data services configuration process

Assuming that the conditions stated above are met, the data services can be added to the
ONT Ethernet port, by selecting one of the following approaches:
Ports tab approach:
Configure the ONT Ethernet port for service (on page 44)
Create a data service on the ONT Ethernet port (on page 46)
Add a data service to an ONT Ethernet port (on page 46)
Information you need

You must have the following information on hand to configure ONT data service:
A Service Match List

Ethernet Bandwidth Profile to use on the ONT Ethernet port.
Service tag action ID to use for the data service including definition of the VLAN ID
and p-bit priority.
39
Subscriber Ethernet Port Association

AE Release 2.2 adds a Subscriber Port Association (also known as Link Layer Discovery
Protocol [LLDP]) feature which provides complete traceability of CPE devices attached to
an AE ONT Ethernet port. These devices can be "traced back" by configuring the Option82 circuit identification token (circuitId or remoteID) for AE ONT Ethernet ports
connected to an E7 chassis.
Provisionable either through CMS or CLI, AE Subscriber Port Association is a vendorneutral Link Layer protocol in the Internet Protocol Suite used by network devices for
communicating their identity, capabilities, and neighbors. Calix AE ONTs provide a circuit
ID in its Option-82 field which identifies the subscribers port on the AE ONT and also
identifies the OLT port connected to the AE ONT.
With this feature, the E7 sends out LLDP frames from each port to any connected AE
ONTs (in 10 second intervals).
Note: The AE Subscriber Port Association feature is available on the following Calix ONTs
operating in AE mode: 700GE, 740GE, 700GX and 760GX ONTs
AE Subscriber Port Association is defined in IEEE 802.1AB and specifies a Protocol Data
Unit (PDU) format for all transmissions.
Note: The LLDP implementation on the E7 is specific to the AE ONT subscriber port
association feature. It is not a general LLDP implementation and therefore does not fully
comply with the 802.1ab standard.
Note: The MIB defined by Calix for passing the E7 Port is defined within the current Calix
enterprise MIB. This allows the definition to be shared with selected third-party equipment.
Note: This feature is a one-direction implementation of AE Subscriber Port Association.
While the E7 is required to send AE Subscriber Port Association messages to the AE ONT,
the AE ONTdoes not send any AE Subscriber Port Association messages back to the E7. As
such, this handshake does not constitute a compliant AE Subscriber Port Association
implementation on the AE ONT.
The following TLV is consumed by the AE ONT for the purpose of creating the Circuit or
Remote ID.
Note: The AE ONT does not need the Chassis ID for purposes of building the Circuit ID.
SysName TLV
TLV=5,
TLV Length (as appropriate),
System Name = E7 Globally Unique System Name (ASCII) non-null terminated
40
Port ID TLV
TLV=2,
TLV Length (as appropriate)
Port ID Type = 7 (locally administered)
Port ID = String with / delimiters identifying the port in the context of the E7
This allows for the AE ONT to support building a circuit or remote ID as per the definition
above. The table below is rewritten in the context of the above TLV values.
Note: With the format string method used on the AE ONT, there is no requirement as to
the specific ordering of the fields.
Circuit ID String Format using TLV
Port Type
AE ONT Port Identifier
TR-101 Option-82 String
ONT ETH
(Independent)
G3 VLAN 300
RONTA eth 0/g3:300
ONT ETH (Subtending)
G3 VLAN 300
FSAN|RONTA eth <SysName> < PortID>/g3:300 (for

example, RONTA eth E7-3354 4/1/1/3:300)
Subscriber Port Association Sequence of Operation
The sequence of events that provide Subscriber Port Association details (Option-82 string
has been populated) are as follows:
1. E7 Ethernet port sends out LLDP frames to the AE ONT connected to the port.
2. Customer configures Option-82 via CMS or CLI and provisions the ONT for service.
3. The AE ONT records the E7 port information based on the last LLDP message
received.
4. The subscriber attaches any DHCP-enabled CPE device to the ONT Ethernet port with
Option-82 and DHCP snooping enabled.
5. The AE ONT inserts relevant information learned from the LLDP message into the
Option-82 string.
41
Notes on Configuring Subscriber Port Associations
AE Subscriber Port Association is always on by default in the E7. For this specific
aspect of AE Subscriber Port Association, the primary use is on an E7 GE port hosting
an AE ONT. All of these ports will be configured as either ACCESS or EDGE ports.
While E7 TRUNK ports do not require specific support for circuit ID information
transmission, AE Subscriber Port Association will be of value on these ports.
Important: On upgrade from a prior release not supporting this AE Subscriber Port
Association feature, the E7 will enable AE Subscriber Port Association on all interfaces,
allowing any AE ONT to be reconfigured to use the AE Subscriber Port Association
information without requiring any configuration change to the E7.
The AE ONT can only receive LLDP messages - it cannot transmit messages up or
downstream.
Subscriber Port Associations apply only to bridged services such as data and video (not
IP Host configurations such as VoIP).
Subscriber Port Association can be configured via CMS or the Command Line Interface
(CLI).
Viewing of LLDP messages sent by the E7 can be readily viewed via wireshark capture or
similar recording device (see example below).
42
Option-82 Command Options and Parameters
The opt82 set string command has been modified to include new tokens (highlighted in bold)
for supporting Subscriber Ethernet Port Association:
CXNK0006CE4B> opt82 set string ?
Usage: opt82 set string [-circuitid=<str>] [-remoteid=<str>] vid=
[format=<str>]
Define string/tokens for option82 insertion
Options:
-circuitid=<str>
The DHCP option82 format string for circuit id.

Current supported tokens which the ONT will auto
insert are: %sn, %vlan, %iftype, %ontport,
%desc, %clab, %oltsystemid, %oltport, %ronta, %mac,
%macstr
-remoteid=<str>
type: Character String (80)

The DHCP option82 format string for remote id.
%macstr

Parameters:
vid=
format=<str>
WAN side VLAN ID identifying bridge to specify

DHCP option82 format upon
type: Unsigned
The DHCP option82 format string for remote id.
%macstr
43
Subscriber Port Association Troubleshooting Commands
Once the Option-82 string has been defined and enabled, the updated configuration can be
viewed via the configuration history (co hist) command:
CXNK0006CE4B> co hist
1 config upgrade -downok filename=calix_ae_700ge_r2.2.0.26.rto
2 config syslog setup -prisvr=10.45.10.4
3 config trap sink -community=public
4 config ntp update -prisvr=10.45.10.4 -dst offset=-21600
5 config label set label="GE_Ookla"
6 set iftable powermanagement index=eth-0 status=up
7 config suppress alarm alarmid=246 state=off
8 bridge setup -mf=enable -snoop=disable -macff=enable dcir=10000000 -dpir=10000000 -ucir=10000000 -upir=10000000 attach=vlan vid=100 dev=eth-0
9 opt82 set string -circuitid="CXNK0006CE4B %iftype %oltsystemid%oltport/%ontport:%vlan" -remoteid="CXNK0006CE4B" vid=100
10 opt82 enable remoteId -desc="Calix AE ONT CXNK0006CE4B" vid=100
11 lev2l2tag add -treatinpri=0 -treatinvid=100 dev=eth-0
12 set iftable powermanagement index=eth-1 status=up
13 set iftable adminstatus index=eth-0 adminstatus=up
In addition, the following commands are available for troubleshooting problems associated
with Subscriber Ethernet Port Association:
opt82 show
The opt82 show command displays circuitId and remoteId values by the specified VLAN.
CXNK0006CE4B> opt82 show ?
Usage: opt82 show vid=
Show defined string/togkens for option82 insertion for specified
VLAN ID
Parameters:
vid=
WAN side VLAN ID identifying the bridge

type: Unsigned
44
Example:
CXNK0006CE4B> opt82 show 100

Option 82 is enabled for VLAN 100. Format string is:
CircuitId: "CXNK0006CE4B %iftype %oltsystemid%oltport/%ontport:%vlan"
RemoteId:
"CXNK0006CE4B"
Option82 CircuitId total length is 37, String is:

CircuitId: "CXNK0006CE4B eth ric-e71-1/1/G1/0:100"
Option82 RemoteId total length is 12, String is:

RemoteId: "CXNK0006CE4B"
lldp show
The lldp show command displays pertinent Link Layer Discovery Protocol values sent to the
ONT.
Example:
CXNK0006CE4B> lldp show

LLDP Information Received from OLT:
OLT System ID : 'ric-e71'
OLT Port
: '1/1/G1'
Frame Received : 248
Last Received : Fri Jun 22 11:21:13
Last Updated
: Fri Jun 22 10:40:01
CXNK0006CE4B> lldp show
LLDP Information Received from OLT:
OLT System ID : 'ric-e71'
OLT Port
: '1/1/G1'
Frame Received : 250
Last Received : Fri Jun 22 11:21:32
Last Updated
: Fri Jun 22 10:40:00
2012 UTC-0500
2012 UTC-0500
2012 UTC-0500
2012 UTC-0500
Note that the values above are updated at 10 second intervals (the frames received value has
incremented as expected).
45
Configuring an ONT Ethernet Port (Ports Tab)

This topic describes how to configure an ONT Ethernet port for service.
Parameters
You can provision the following parameters for an ONT Ethernet port:
Parameter
Description
Valid Options
Subscriber ID
Subscriber ID information, such as name,

address, or account number
String up to 27 characters
(blank)
Description
Optional description field for the port or service
String up to 27 characters
(blank)
Speed
Data rate of the Ethernet port in Mb/s.

HPNA ports default to 100 Mb/s and cannot be
changed.
FE ports default to auto but can be changed to 10
and 100 Mb/s. GE ports can be changed to 1000.
auto
10
100
1000
Duplex
Duplex mode for an Ethernet port.

HPNA ports default to half-duplex and cannot be
changed.
FE ports default to duplex and cannot be
changed.
Full
Half
Disable on
BATT
Port operational state when the ONT is operating

on battery backup power (during a power outage).
N (No)
Y (Yes)
Security Profile
Apply a pre-defined Security Profile to traffic on

this port.
Pre-configured Ethernet Security Profile

system-default
Default
To configure an ONT Ethernet port for service

1. On the Navigation Tree, click AE ONTs.
2. In the Work Area, select the ONT to provision and click Ports to display the ONT
ports.
3. From the list of ONT ports, double-click the ONT port to provision.
Note: The appropriate number of ports specific to a given model of ONT are
automatically populated on the provisioning page.
4. In the ONT Ethernet port form, do the following:
5. In the Subscriber ID box, type a string to identify the subscriber, as required.
6. In the Description box, enter a description of the service.
7. In the Speed box, select a port speed or accept the default (auto).
8. In the Duplex box, select full or half duplex, as required.
9. In the Disable on BATT box, select whether to disable the port if an "on battery" event
occurs at the ONT.
46
10. In the Security Profile box, select a previously created security profile or leave the default
profile.
11. From the menu, click Apply to save changes within CMS.
12. From the menu, click Action > Save Configuration to upload changes to the ONT.
Creating Data Services on an AE ONT Ethernet Port (Services > Table Tab)
This topic describes how to configure a data service on an ONT port.
Transparent LAN data services
A Transparent LAN (TLAN) service is configured where a common outer tag is added to all
ports in the TLAN. The provisioning is similar to the VLAN-per-service data services model,
with the following details:
Add the data service to the ONT Ethernet port, specifying a service VLAN in the Out
Tag parameter that is unique to the Transparent LAN (TLAN).
Note: The default behavior for data services is to filter all multicast traffic upstream from
an ONT Ethernet port, unless the Multicast Filtering parameter is enabled on the VLAN.
Associate a service-tag action that includes the following:
A selection of Add Tag for the Tag Action parameter
A selection of Specified in Service for the Outer Tag parameter
A match list association where there are two match rule entries to match all traffic, if
desired:
Tagged rule with the selection of ignore for the Outer Tag parameter and pbitnone for the Outer P-Bit parameter to match all tagged frames
Note: The upstream and downstream values specified in the Ethernet Bandwidth Profile and
P-bit values defined in the service-tag action must be consistent with the class of service type.
47
Parameters
You can provision the following parameters for data services on an ONT port:
Parameter
Description
Valid Options
Subscriber Port
Drop Down list of available Subscriber ports on the ONT.
Text: Auto-populated based on

ONT type.
Subscriber ID
Subscriber ID associated with the AE ONT
Auto-populated from ONT ID or

update to create new ID.
Description
Description of the AE ONT.
Auto-populated from ONT

Description or update to create new
Description.
Service Name*
Name of service for the ONT port to use.
Data1 ... Data8
BW Profile*
Name of Ethernet bandwidth profile to apply to this port.
Any established bandwidth profile
Svc Tag Action*
The pre-defined Service Tag Action to apply to the data

service.
Existing Tag Action Profile
DHCP Snooping
Should DHCP Snooping occur on the port?
Yes, No
MAC Forced
Forwarding
Should MACFF be enforced on the port?
Yes, No
IP Source Verify
Does the IP source need to be verified on the port?
Yes, No
Description
Description of the Data Service.
text
*Required fields
To create data service on an ONT Ethernet port

1. On the Navigation Tree, click AE ONTs to display AE ONTs in the work area.
2. Select the AE ONT and Click Services from the Menu bar.
3. In the Work Area under Table view, click Create > Data Service.
4. From the list of ONT ports, double-click the ONT Ethernet port on which to add
services.
5. From the menu, click Create > Data Service.
6. In the Create Data Service dialog box, do the following:
a. In the Subscriber Port drop-down list, select the port to provision.
b. In the Subscriber ID box, accept the default Subscriber ID (from the ONT) or enter
a new Subscriber ID to be associated with the port.
c. In the Subscriber Description box, accept the default Description (from the ONT) or
enter a new description to be associated with the port.
d. In the Service Name list, select an Ethernet service name to apply to the port (Data1
to Data16).
e. In the BW Profile list, select a pre-configured Ethernet bandwidth profile to apply to
the port.
f. In the Svc Tag Action box, select a pre-configured service tag action to apply to the
port.
48
g. In the DHCP Snooping box, choose whether to enable DHCP Snooping on the port.
h. In the MAC Forced Forwarding box, choose whether to enable MACFF on the port.
i.
In the IP Src Verify box, choose whether to enable IP Src Verify.
7. Click Create to apply the service to the port.

8. From the top menu, click Action > Save Configuration to upload changes to the ONT.
Creating Data Services on an AE ONT Ethernet Port (Services > Form Tab)
Parameters
You can provision the following parameters for data services on an ONT port:
Parameter
Description
Valid Options
BW Profile*
Name of Ethernet bandwidth profile to apply to this port.
Any established bandwidth

profile
Svc Tag Action*
The pre-defined Service Tag Action to apply to the data service.
Existing Tag Action Profile
DHCP Snooping
Should DHCP Snooping occur on the port?
Yes, No
MAC Forced
Forwarding
Should MACFF be enforced on the port?
Yes, No
IP Source Verify
Does the IP source need to be verified on the port?
Yes, No
*Required fields
To create data service on an ONT Ethernet port

1. On the Navigation Tree, click AE ONTs to display AE ONTs in the work area.
2. Select the AE ONT and Click Services from the Menu bar.
3. In the Work Area under Form view, scroll down to the Ethernet port to configure.
Note: Expand or contract the details of each port by clicking the inverted orange triangle
next to the port ID.
4. In the Data Service section of the Gig-Ethernet port, do the following:
a. In the BW Profile list, select a pre-configured Ethernet bandwidth profile to apply to
the port.
b. In the Svc Tag Action box, select a pre-configured service tag action to apply to the
port.
c. In the DHCP Snooping box, choose whether to enable DHCP Snooping on the port.
d. In the MAC Forced Forwarding box, choose whether to enable MACFF on the port.
e. In the IP Src Verify box, choose whether to enable IP Src Verify.
5. Click Apply to save the changes to the port.
6. From the menu, click Apply to save changes within CMS.
7. From the top menu, click Action > Save Configuration to upload changes to the ONT
49
Data Service Example

From a provisioning perspective, the following attributes are written to the ONT
configuration based on the values entered within CMS. Refer to Creating ONT Global
Profiles for AE Services for command details and definitions.
#Svc Tag Actions
bridge setup \
-mf=enable \
-snoop=disable \
-macff=enable \
-dcir=10000000 \
-dpir=10000000 \
-ucir=2000000 \
-upir=2000000 \
-attach=vlan \
vid=201 \
dev=eth-0
#Untagged Match Rule
lev2 add \
-treatinpri=0 \
-treatinvid=201 \
dev=eth-0
IPTV
Active Ethernet supports IPTV with multiple VLANs per port, VLAN per service or VLAN
per subscriber models. Current features specific to IPTV include:
IGMP snooping support for IPTV

Multicast to Unicast IPTV flow conversion (not supported by the 7xxGE ONTs)
With the support of MAC SA, Calix ONTs support mapping untagged traffic on the
subscriber side. An example of this filter/mapping operation is to identify by OUI the settop boxes used for IPTV service. All other untagged traffic is mapped to the data VLAN
defined for the ONT. Thus, the ONT supports triple-play service mapping of untagged
subscriber traffic without L3 mapping.
New features added to AE Release 2.0 include:
Multicast VLAN Registration (MVR) (on page 51)

IPTV provisioning enhancements including per port multicast-to-unicast control
Defined Multicast Ranges to "allow" and filter IGMP joins
Single Multicast VLAN ID for upstream and downstream IGMP packets, downstream
multicast, and STB control traffic
Isolation of broadcast/multicast traffic distribution of unicast IPTV traffic.
50
IPTV Video Profiles

AE Release 2.0 adds additional provisioning capabilities to the video profiles and enables per
port multicast-to-unicast control. The video profile now contains attributes to control perport channel limits, query interval and multicast-to-unicast control.
For a detailed description of video profile commands, refer to IPTV Commands (on page 271)
Multicast VLAN Registration (MVR)
Multicast VLAN Registration (MVR) is used at the ONT to merge the common multicast
VLAN content into the subscribers untagged service on the ONT UNI. The E7 MVR
implementation allows up to 4 independent multicast VLANs to be merged into the
subscribers unicast service. These multicast VLANs can be used to segregate various content
(e.g. HD, SD, Audio, local channels) or facilitate additional video content that a service
provider distributes to end users.
Multicast VLAN Registration (MVR) is designed for distribution of multicast traffic on a
dedicated multicast VLAN across segregated access networks, while allowing subscribers
who are on different VLANs to join and leave the multicast groups carried in the Multicast
VLAN. MVR isolates the network multicast VLAN used to facilitate efficient transport of
multicast data from the subscriber. Typical applications include:
Distribution of multicast VLAN and merging multicast traffic into subscribers untagged
"single service" associated with a residential gateway
Distribution of multicast VLAN and converting to a common "Video VLAN" preconfigured on all STBs
Distribution of multiple multicast VLANs (e.g. high definition IPTV, standard definition
IPTV, and digital audio) and merge into a single subscriber service
MVR works in conjunction with IGMP. Subscribers join and leave multicast groups via
IGMP. However, both the IGMP messages and multicast content are mapped from the
subscribers service into the isolated network side multicast VLAN. AE R2.0 allows ONTs to
map the subscribers IGMP and multicast traffic into multiple network multicast VLANs.
For a given video VLAN, up to 4 MVR VLANs can be defined. Each MVR VLAN can
further contain up to 4 multicast ranges. An upstream IGMP will have its VLAN changed
based on matching any one of these MVR multicast ranges. In order to support MVR,
separate bridges must be created for each MVR VLAN. IGMP snooping must be enabled on
MVR VLAN bridges.
Refer to the IPTV Commands section of this guide for MVR provisioning (on page 295)
syntax.
51
About MVR
Multicast VLAN Registration (MVR) is designed for applications using wide-scale

deployment of multicast traffic across a ring-based Ethernet service-provider network (for
example, the broadcast of multiple television channels over a service-provider network).
MVR allows a subscriber on a port to subscribe (join) and unsubscribe (leave) to a multicast
stream on the network-wide multicast VLAN. It allows the single multicast VLAN to be
shared in the network while subscribers remain in separate VLANs. MVR provides the ability
to continuously send multicast streams in the multicast VLAN, while at the same time
isolating the streams from the subscriber VLANs for bandwidth and security reasons.
MVR assumes that subscriber ports join and leave these multicast streams by sending out
IGMP messages. These messages originate from an IGMP compatible host with an Ethernet
connection. MVR operates in conjunction with IGMP snooping with both MVR and IGMP
snooping operating together on the AE ONT. MVR reacts only to join and leave messages
from multicast groups configured under MVR. Join and leave messages from all other
multicast groups are managed by IGMP snooping.
The host processor on the AE ONT identifies the MVR IP multicast streams and their
associated IP multicast group in the switch forwarding table, intercepts the IGMP messages,
and modifies the forwarding table to include or remove the subscriber as a receiver of the
multicast stream, even though the receivers might be in a different VLAN from the source.
This forwarding behavior selectively allows traffic to cross between different VLANs.
In a multicast television application, a PC or a television with a set-top box receives the
multicast stream. Multiple set-top boxes or PCs can be connected to one subscriber port,
which is a switch port configured as an MVR receiver (see the illustration below). DHCP
assigns an IP address to the set-top box or the PC. When a subscriber selects a channel, the
set-top box or PC sends an IGMP report to the ONT to join the appropriate multicast. If
the IGMP report matches one of the configured IP multicast group addresses, the host
processor on the AE ONT modifies the hardware address table to include this receiver port
and VLAN as a forwarding destination of the specified multicast stream when it is received
from the multicast VLAN.
52
When a subscriber changes channels or in some cases powers down the STB sending it into
standby mode, the set-top box sends an IGMP leave message for the multicast stream. The
router sends a group-specific query and the ONT forwards that frame through the receiver
port VLAN. If there is another set-top box in the VLAN still subscribing to this group, that
set-top box must respond within the maximum response time specified in the query. If the
AE ONT does not receive a response, it eliminates the receiver port as a forwarding
destination for this group. If the AE ONT never receives a leave, the channel pruned from
the receiver port as a forwarding destination for the group based on the pre-configured query
interval.
MVR eliminates the need to duplicate television channel multicast traffic for subscribers in
each VLAN. Multicast traffic for all channels is only sent around the VLAN trunk once (and
only on the multicast VLAN). The IGMP leave and join messages remain in the VLAN to
which the subscriber port is assigned. These messages dynamically register for streams of
multicast traffic in the multicast VLAN on the AE ONT. The AE ONT modifies the
forwarding behavior to allow the traffic to be forwarded from the multicast VLAN to the
subscriber port in a different VLAN, selectively allowing traffic to cross between two
VLANs.
IGMP reports are sent to the same IP multicast group address as the multicast data. The AE
ONT captures all IGMP join and leave messages from receiver ports and forwards them to
the multicast VLAN of the source (uplink) port, based on the MVR profile.
53
Additional Notes on MVR Profiles
Receiver ports can only be access ports (for example, the Ethernet interface on an
ONT).
Receiver ports must be in a different VLAN than the ONT WAN interface.
MVR does not currently support IGMP v3 messages.
The maximum number of multicast entries (or MVR group addresses) on an ONT is
128.
Refer to the provisioning examples (on page 300) for additional information on MVR.
T1/E1 Services via PWE3

With AE Release 2.0, Calix ONTs provide T1/E1 services over point-to-point GE links
using pseudowire emulation technology. IETF RFC 3985 and RFC 4197 define the
pseudowire edge-to-edge emulation (PWE3) architecture and provide a standards-based
approach to T1/E1 service delivery over a packet switched network (PSN).
Note: T1 digital transmissions in North America includes total speeds of 1.544 Mbps with 24
discrete DS0s (64 kbps). E1 digital transmissions in regions outside North America include
total speeds of 2.048 Mbps with 32 DS0s (64 kbps).
A pseudowire connects two TDM circuits over a packet switched Ethernet network. In the
most basic example, two T1/E1 endpoints are connected together, converting a data signal
into Ethernet frames and transported over an asynchronous Ethernet network. On the
receiving end, the Ethernet frames are converted back to TDM T1 or E1. This technology is
often referred to as pseudowire End-to-End Emulation, or PWE3.
The 766GX and 767GX-R ONTs support unstructured, asynchronous T1s and E1s on a per
port basis with port independence.
Note: Only SAToP unstructured service with asynchronous timing on each port is
supported is this release.
TDM transport benefits from its inherent internal signal timing mechanism. Ethernet packet
networks however do not have this same timing mechanism (asynchronous delivery) so
PWE3 must accommodate this disparity via other methods. The Calix PWE3 solution
supports both adaptive and differential timing for PWE3 T1s. It also supports loopback
timing on the T1/E1 interface. The ONTs have an internal Stratum 3 clock reference and
will revert to the internal clock during a holdover condition. The solution meets T1 timing
requirements of G.824.
Note: T1/E1 PWE3 services are implicitly associated to an ONT IP-Host object. The IPHost object specifies a svc-tag-action, which provides the VLAN association.
Please refer to the Calix Application Note Pseudowire Applications for MDU ONTs for complete
information on PWE3 support.
Note: Provisioning of PWE3 services on Calix ONTs via CMS is not currently supported.
Calix recommends manually creating configuration files for ONTs supporting PWE3. Refer
to the configuration examples as required.
54
Timing over Ethernet

With the E7 Platform Release 1.1 which is independent of AE Release 2.0, the E7
synchronizes the GE ports on the GPON-4 line card to the same internal clock reference
used by the E7. For AE, the eight GE ports can therefore be synchronized and differential
timing clock recovery is extended from ONT to ONT without regard for whether the optical
layer is GE or GPON.
In this scenario, the E7 may be using its local Stratum 3 clock or an external BITS input as its
timing reference. Up to ten E7 shelves can be connected together to share a local BITS
input. A BITS Chaining Cable available from Calix includes connectors to attach the
redundant BITS output pins from one E7 shelf to the redundant BITS input pins on a
second E7 shelf, and so on.
The figure below shows a model for building synchronous networks using the E7 and Calix
766GX ONT. All E7 units are synchronized using the E7s BITS IN/OUT pins on the back
of the unit to create a traceable network clock reference between the E7 systems and the
ONTs. The E7 systems can be tied to a local BITS clock or allowed to free run on the E7s
STRATUM 3 local oscillator. The remote subscriber ONT may be configured for differential
clock recovery. The CO network end can use either loopback (lowest jitter) or differential
(lowest delay) clock recovery.
55
About Differential Clock Recovery

Differential clock recovery is possible in AE mode when the WAN uplink Ethernet port is
synchronous (when the upstream switch/router is sourcing SyncE (on page 219) towards the
ONT). The ONT contains a global flag indicating the current state of SyncE on the WAN
interface. When SyncE is not active, PWE3 is utilizing the local oscillator as its clock source
(local oscillator implies the local PWE3 is running asynchronously to the remote PWE3). In
this case, differential clock recovery will not function properly since differential clock
recovery requires both ends to have common (the same) timing both ends are
synchronous. When SyncE is active, PWE3 will utilize the WAN clock as its clock source.
The WAN clock, when SyncE is active, is assumed to be traceable and is trusted. Assuming
both ends of the pseudowire have SyncE active, differential clock recovery is possible as long
as the SyncE is traceable to the same source.
The PWE3 subsystem periodically monitors the ONT SyncE state and adjusts the PWE3
clock source appropriately with respect to the SyncE state. PWE3 is considered to be
misconfigured if differential clock recovery is active when SyncE is inactive. This results in
an SNMP provisioning mismatch trap.
By nature, adaptive clock recovery is an asynchronous clock recovery mechanism. As such,
only adaptive clock recovery is possible when SyncE is inactive. However, adaptive clock
recovery can always be used when SyncE is active.
T1/E1 PWE3 Planning
Before implementing PWE3 services in an AE network, keep the following general
guidelines in mind:
When delivering SAToP service, the AE Release 2.0 solution supports RFC 5087
(TDMoIP), PWE3 RFC 5086 (CESoPSN) and Layer 2 (CESoETH) provisioning. In a
properly configured system, the combination of the IP address and UDP port number
uniquely identifies the pseudowire path (the associate pseudowire "label"). TDMoIP,
CESoPSN, and CESoETH are three unique provisioning methods used to associate the
terminal one T1/E1 port and UDP port number in order to direct the pseudowire
payload to the associated end-point port. The UDP port number must be agreed upon by
both ends of the pseudowire in order to identify the bi-directional payload.
Within a Layer-2 network, PWE3 services from an ONT are typically placed in a single
VLAN for transport between the remote pseudowire devices and the IP gateway.
Multiple remote locations may be split into separate VLANS for ease of network
planning and operation.
Transport of T1/E1 services over a packet network requires a CoS priority and sufficient
bandwidth allocation within the packet network to reduce latency and packet loss. Service
VLANS should be given a high IEEE 802.1p priority "p-bit" value.
Each Calix ONT is provisioned with a static IP address for the SAToP interworking
function (an IP host). Each pseudowire end point thus has a unique source and
destination IP address corresponding to the ONT with a UDP port ID for the individual
T1/E1 circuit on the ONT.
56
T1/E1 pseudowire can be transported through an open IP network or closed E7

Ethernet network. If two pseudowire ONT end points are within the same IP subnet and
Layer 2 broadcast domain (VLAN), they will discover each other using Address
Resolution Protocol (ARP). The T1/E1 service will not transit through the IP default
gateway and no manual configuration is required for each end point to discover their
respective destinations.
If two pseudowire circuits have IP addresses in different IP subnets, the data path
between the end points must transit through a router external to the E7 network even if
there is a direct Layer-2 path between the two ONTs confined within the E7 network.
For details on PWE3 provisioning (including examples), refer to Pseudowire Commands (on
page 309) in the Appendix of this guide.
E1 Services
With AE Release 2.0 Calix MDU ONTs that support PWE3 support E1 data services as
well. E1 circuits, common in Latin America and other international markets including the
Caribbean, are similar to T1 circuits but operate with a line rate of 2.048 Mbps full duplex.
An E1 circuit is divided into 32 timeslots with each time slot representing 8 bits of data. An
E0 channel is 64 kbps, and a framed E1 packet is designed to carry 30 E0 data channels + 1
signaling channel. The timeslots are numbered from 0 to 31.
The control of jitter and wander within an E1 networks based on the 2.048 Mbps hierarchy is
described in ITU-T G.823. Calix has designed the ONT hardware and an E7 network
topology to support these requirements suitable for the synchronization of a PSTN network.
Assuming an E7 network with 10GE links for transport, an operator can deploy up to 16 line
cards supporting AE links to ONTs (line cards can be co-located in an E7 shelf, two per
shelf, or distributed in different E7 shelves throughout a network).
Note: If the service provider requires a 75-ohm unbalanced cable (an international standard
often used in E1 networks), a 120 ohm balanced to 75 ohm unbalanced adapter cable is
required. Refer to the 766GX/767GX MDU ONT Installation Guide for additional ordering
and wiring information.
Note: E1 provisioning via CMS is scheduled for availability with CMS Software Release 11.2.
57
ONT Inventory
DHCP Option-43
Calix ONTs currently populate DHCP Option-60 and 61. Option-60 identifies the ONT as a
Calix ONT. Option-61 includes the FSAN serial number and if available, the RONTA ID.
DHCP Option-43 is commonly used to carry detailed inventory information about a device
including the ONT model number. Calix ONTs have integrated host components such as
VoIP and PWE3 which require an IP address. Correlating these ONT integrated
components to the ONT through the DHCP server makes troubleshooting easier for the
service provider. To accomplish this, Calix defines a different DHCP Option-43 for the
IADs and identifies the ONT MAC address as part of this structure. The advantage of the
Option-43 approach is that it enables the use of relay treatment upstream of the ONT.
Note: AE R2.0 (GX and GE) supports firmware upgrade through CLI and DHCP Option43.
Note: In AE Rev 2.0, there are 3 ONT firmware image types, GX SFU, GX MDU and GE.
Refer to the AE Release Notes for specific upgrade instructions using either CLI or Option-43.
ONT Firmware Upgrades using Option-43
The use of Option-43 can be used for firmware upgrades during the ONT ranging sequence.
To enable this feature the operator must populate the DHCP server with Option-43 entries
listing Calix ONT firmware image filenames. During ONT boot-up, the DHCP client on the
ONT will request Option-43 structure. If DHCP Option-43 structure is available, the ONT
pulls the image header for each Option-43 firmware entry until it finds the right ONT type
match. Once the ONT finds an image with the right type match but with a version
mismatch, it proceeds to pull the entire firmware image file and upgrade itself. If the version
of the matching image is equal or lower to the ONT running version, the ONT continues
through the configuration process by pulling down the assigned configuration file.
Note: The default Option-43 setting is <Upgrade Only> however this feature can be
disabled.
During configuration file processing the ONT reacts differently to the firmware upgrade CLI
command depending on the prior processed DHCP Option-43. If a DHCP Option-43
firmware entry is dictating the ONT firmware version (entry with matching firmware type),
the ONT simply ignores the firmware upgrade CLI command; DHCP Option-43 firmware
upgrade takes precedence over the CLI command. If no DHCP Option-43 firmware entry
with matching firmware type, the ONT executes the firmware matching/upgrade as
instructed by the CLI command.
For additional details see the DHCP Option-43 (on page 276) section in Command Reference
section of this guide.
58
Calix AE ONTs
ONT Models
The AE Release 2.2 is a platform independent software release that supports Calix 76xGX
and 7xxGE ONTs. In release 2.2, new ONT types (74xGE series) are supported as well as
adding web based ONT activation support (Smart Activate), International POTs support,
enhanced data policing and shaping, and enhanced OAM functionality.
The following ONT models are supported as part of this release
SFU ONTs
711GE ONT (2 POTS, 2 GE)
721GE ONT (2 POTS, 2 GE, 1 RF*)
716GE-I ONT (2 POTS, 4 GE) - Indoor ONT
742GE ONT (2 POTS, 2 GE-SFP)
743GE ONT (2 POTS, 2 GE-SFP, 2 T1/E1)
744GE ONT (2 POTS, 2 GE-RJ45, 2 T1/E1)
726GE-I ONT (2 POTS, 4 GE, 1 RF*) - Indoor ONT
The listed SFU ONTs offer the following AE features:
Adaptive AE auto-detect Optics
All AE features supported by 7xxGX SFU ONTs (except m2u)
1 Gbps symmetrical throughput
Upstream and Downstream bandwidth management (policing) up to 1000 Mbps per

ONT
64 Kbps bi-directional traffic management (shaping) up to 2,048 Mbps
Ethernet OAM support for all 74xGE ONT models
Dual SFP module (optical Ethernet service port) configuration standard on model
742GE and 743GE ONTs
MGCP and H.248 Voice service support (static or DNS provisioning)
VoIP Interop with MetaSwitch R17 and GENBAND C15 R5 for MGCP
B6 TDM Gateway Support ***
Layer-2 mapping based on Differentiated Services Code Points (DSCP) and Layer 2
Control Protocol (L2CP) filtering
59
MDU ONTs
760GX ONT (8 POTS, 4 GE, 4 SFU RF*, 1 MDU RF*)

762GX ONT (8 POTS, 8 GE, 4 SFU RF*< 1 MDU RF*)
763GX ONT (8 POTS, 8 GE, 8 SFU RF/RF RETURN*)**
766GX ONT (8 POTS, 4 GE, 8 T1/E1, 4 SFU RF*, 1 MDU RF*)**
766GX ONT (8 POTS, 4 GE, 8 T1/E1, 4 SFU RF*, 1 MDU RF*) 24 VDC
767GX ONT (8 POTS, 4 GE, 8 T1/E1, 3 SFU RF/RF RETURN*)**
* - RF overlay and RF Return services are not supported in AE mode.

** - Also available in rack mount versions.
The listed MDU ONTs offer the following AE features:
T1 support via PWE3 on 766GX and 767GX-R ONTs
Adaptive, Differential, and Line Timing on AE uplinks
Unstructured per port with port independence
RFC 5086 UDP/IP PWE3 provisioning (CESoPSN)
MEF8 Layer-2 PWE3 provisioning (CESoETH)
Upstream and Downstream policing up to 1 Mbps per ONT
64 Kbps bi-directional traffic shapers up to 2,048 Mbps
Note: For a complete description on ONT functionality, refer to the Product Literature
Section under Documentation on the Calix Resource Center.
AE ONT Features
The Calix AE ONTs conform to the following standards:
Full Service Access Network (FSAN)

ITU-T GPON
IEEE AE compliant
Compliant with mandatory MEF 9 and MEF 14 standards
The form factor of the Model 7xxGE SFU ONT is identical to that of the 7xxGX ONTs:
Environmentally hardened to withstand the outside elements

Same 120 VAC, 60 Hz Uninterruptible Power Supply (UPS) with battery back-up for
delivering life-line services in the event of a power outage
Same enclosure options and accessories
Same power requirements (supports 8.0 hours of battery backup)
Identical power cords as the 7xx and 7xxG ONTs.
60
The form factor of the Model 7xxGE-I Indoor SFU ONTs includes:
Dual POTS and 4 GE Ethernet ports

Digital RF Video Port (726GE-I only)
120 VAC or 240 VAC, 50/60 Hz Uninterruptible Power Supply (UPS) with battery backup for delivering life-line services in the event of a power outage
Table-top mount, Wall Mount, Structured Wiring Enclosure (SWE) mounting options
available
Supports up to 8.0 hours of battery life upon loss of power
Power cord options for 120VAC and 240VAC in North American and European cordplug configurations.
Voice Services Features
Includes 2 or 4 POTS ports with Provisionable POTS Loss Plans
SIP interoperability with a variety of vendor soft switches
DTMF dialing
Dial Pulse detection
SIP VoIP, TDM Gateway, MGCP VoIP, and H.248 Voice services available
International POTS capability with T.38 fax interface
Peer-to-Peer VoIP Service
Subscriber Data Port Features
Single GE (10/100/1000TX) subscriber Ethernet port
Optional second 10/100TX port
Optional integrated HPNAv3.1 over coax management
Note: For additional information on provisioning HPNA on the GX ONT, refer to

Creating a Layer-2 Pipe for HPNA Maintenance and Monitoring (on page 193)
System Management Features
Can be managed remotely from a Linux, Windows, or Solaris station
Remotely configurable using the Calix Smart Activation technology
Secure management VLAN for all control traffic
Hierarchical Configuration File (auto generated within CMS) for all services with
optional access to command line interface
Redundant TFTP download of configuration files or upgrade images
Automatic version control and software upgrades
Support for primary and secondary management servers
61
Remote logging of events (Syslog)
SNMP traps and "GETS" for alarm and event monitoring
Ethernet OAM, Continuity Fault Management: TLV enabled loopback testing with
large frames, interop with various test equipment manufacturer's.
Enhanced Ethernet OAM to support Y.1731 MEG ID and 802.1ag MAID on the
same device.
Serviceability Features
Error logging information perpetuated in flash memory
Syslog and SNMP traps for alarm and event reporting
Automatic ONT resets on loss of link and watchdog timeouts
Per bridge and per port PM counters
Ethernet Service Features
AE Subscriber Port Association
Ethernet port independence for multiple subscribers
High-speed Internet traffic shaping for 700GE ONTs
Per subscriber Ethernet mode configuration, 10/100/1000/auto
Per subscriber Ethernet port upstream/downstream rate limiting up to 1 Gb/s in

each direction (200 Mb/s on 7xxGX SFU ONTs)
Per VLAN ID upstream/downstream rate limiting
Per VLAN ID upstream multicast/broadcast rate limiting (DoS security)
Per subscriber upstream multicast filtering (DoS security)
Full 802.1p QoS support
IP Host Termination for AE ONT Management
Redundant DHCP IP Address acquisition for management channel
DHCP Layer-2 relay using Option-82 for subscriber identification
VLAN per subscriber Ethernet port (1:1)
VLAN per service (N:1)
IGMP snooping support for IPTV
Multicast to Unicast IPTV flow conversion
Subscriber to subscriber hair pinning for TLS
Transparent LAN Services (TLS)
62
Note: Implementation is dependent on access platform; refer to E5-400 or switch

system documentation for TLS capabilities.
External IADs
PPPoE pass-through
Extensive Layer-2 Mapping of subscriber traffic and VLANs to network service

provider (NSP) VLANs
To support "triple play services", (for example VoIP, IPTV, and HSI [high speed
internet])
With a residential gateway (RG) tagged subscriber traffic supported
Without an RG, untagged subscriber traffic is supported
63
ONT FSAN Serial Number

Each AE ONT requires its own configuration file that uses either the FSAN serial number or
the Registration ID as the root of the configuration file name.
If using the serial number method, it is displayed on the external label of the ONT (see
below). For example, an ONT that has the serial number CXNK0002B70E expects
(requires) a config file by the name CXNK0002B70E.cfg on the TFTP file server.
64
ONT Optics Characteristics

The 7xxGX or 7xxGE ONT exhibits the same optical capabilities and characteristics
whether in AE or GPON mode.
The ONT optics are rated for a Class B+ PON and support either diplexer or triplexer
applications.
Note: In AE mode, the WAN side optical interface supports 1000Base-T, single strand,
single mode fiber optical connections. It does not support 10/100 Ethernet applications.
Downstream digital data content is received on a wavelength of 1490 nm. In a triplexer
application in which downstream analog video is supported, this content is received on the
1550 nm wavelength. Upstream data is transmitted at a wavelength of 1310 nm.
AE Optical Links
Calix GX ONTs communicate in the network via a single fiber that attaches to a Small
Form-Factor Pluggable (SFP) optics module installed in the upstream device, such as the
Calix E5-400 Ethernet Transport and Aggregation Platform.
Calix GE ONTs communicate in much the same way however the optics can now co-exist
with 10 GE GPON wavelengths.
When these ONTs are operating in AE mode (without the optical loss associated with
splitters and combiners as is often the case in GPON deployments), the point to point
system's optical transmitter may require additional attenuation. Adding attenuation avoids
over-saturating the optical receivers when ONTs are located close to the upstream device.
For additional information on optical link power levels and recommendations for the amount
of attenuation that may be needed, refer to Managing AE Optical Link Power Levels (on page
64) located in the Appendix of this guide. Information on SFP installation and best practices
is available in the Calix E5-400 Installation Guide.
65
Managing AE Optical Link Power Levels

Choosing the Proper Attenuator
Calix recommends that Small Form Pluggable (SFP) or Compact Small Form Pluggable
(CSFP) attenuators be located in the Central Office at or near the E-Series SFPs, so that
adjustments can easily be made if an ONT is moved from one location to another. When
necessary, an attenuator can be placed in the ONT enclosure.
In determining the proper attenuation levels, the following minimum and maximum transmit
and receive values were used:
Attenuation Guidelines
Range (km)
Transmit Min
(dBm)
Transmit Max
(dBm)
Receive Min
(dBm)
Receive Max
(dBm)
10 CSFP
-9.0
-3.0
-19.5
-3.0
20 CSFP
-9.0
-3.0
-22.5
0.0
20 SFP
-7.0
-1.0
-22.0
0.0
40 SFP
-5.0
0.0
-22.0
0.0
60 SFP
-2.0
4.0
-26.0
0.0
7xxGE AE ONT (60

km)
-5.0
0.0
-22.0
-3.0
7xxGX AE ONT (50

km)
.50
5.0
-27.0
-8.0
Note: The maximum reach can be increased slightly by deploying premium grade attenuation
fiber.
66
7xxGE ONTs
When 7xxGE ONTs are operating in Active Ethernet mode, the system's optical transmitters
may require attenuation to avoid saturating the optical receivers. The following chart details
the relationship between distance (from the SFP to the ONT) and the appropriate E-Series
SFP or CSFP module to use.
7xx GE ONT AE Attenuation Requirements
Calix E-Series SFPs
SFP Rated Reach
SFP Part Number
Optical fiber
Link Length
(km)
Attenuation Value
to Prevent SFP
Saturation
10 km CSFP
100-01791
0 to 10 km
0 db
20 km CSFP
100-01792
0 to 20 km
0 db
20 km SFP
100-01669
0 to 10 km
5 db
20 km SFP
100-01699
10 to 20 km
0 db
40 km SFP
100-01671
0 to 20 km
5 db
40 km SFP
100-01671
20 to 30 km
0 db
40 km SFP
100-01671
30 to 40 km*
0 db
60 km SFP
100-01673
0 to 10 km
10 db
60 km SFP
100-01673
10 to 30 km
5 db
60 km SFP
100-01673
30 to 50 km
0 db
60 km SFP
100-01673
50 to 60 km**
Not Recommended
* - The optical fiber plant performance characteristics determine whether the combination of
the 40 km SFP and 7xxGE ONT works effectively up to 40 km.
** - The 60 km SFP and 7xxGE ONT combination only works reliably up to 50 km (actual
reach depends on outside plant fiber and connector loss). This is due to the 7xxGE ONTs
reduced output power which is optimized to allow the 10 and 20 km CSFPs to operate
without attenuation.
67
7xxGX ONTs
When 7xxGX ONTs are operating in Active Ethernet mode, the system's optical transmitters
may require attenuation to avoid over-saturating the optical receivers. The following chart
details the relationship between distance (from the SFP to the ONT) and the appropriate ESeries SFP module to use.
7xx GX ONT AE Attenuation Requirements
Calix E-Series SFPs
SFP Rated Reach
SFP Part Number
Optical fiber
Link Length
(km)
Attenuation Value to
Prevent SFP Saturation
0 to 10 km
10 db
10 km CSFP
100-01791
20 km CSFP
100-01792
0 to 10 km
10 db
20 km CSFP
100-01792
10 to 20 km
5 db
20 km SFP
100-01669
0 to 10 km
10 db
20 km SFP
100-01699
10 to 20 km
5 db
40 km SFP
100-01671
0 to 20 km
10 db
40 km SFP
100-01671
20 to 30 km
5 db
40 km SFP
100-01671
30 to 40 km
0 db
60 km SFP
100-01673
0 to 10 km*
15 db
60 km SFP
100-01673
10 to 20 km
10 db
60 km SFP
100-01673
20 to 30 km
10 db
60 km SFP
100-01673
30 to 40 km
5 db
60 km SFP
100-10673
40 to 50 km
5 db
60 km SFP
100-10673
50 to 60 km
0 db
* - Calix recommends using the 60 km rated SFP only for 7xxGX ONT links longer than 10
km. This eliminates the need for a 15 db attenuator and simplifies attenuator inventory.
68
AE Deployment Scenarios
Due to the inherent flexibility of AE design, the number of possible network topologies and
configuration options are far too numerous to mention. This section describes possible
customer deployment scenarios presented as the most basic to the most complex.
The following deployment scenarios are outlined below:
Managed ONT Basic Service - VLAN per Port

Managed ONT Basic Multi-service - VLAN per Service
Managed ONT Basic Service - VLAN per Port

In this next example, only high speed internet (HSI) is provided to the subscriber using a
single VLAN per port model. The ONT is managed by a single RMI station with no
redundancy.
Deployment Characteristics
The characteristics of this model include:
Only HSI service is being delivered

The system is managed from a single RMI station
Each subscriber is provided service on separate VLANs
DHCP server for ONT management is separate from DHCP server for subscriber's
premises equipment (note that the need for separate DHCP servers can be avoided by
using a DHCP relay agent)
This configuration supports tagged or untagged traffic
DHCP Handling
In this configuration DHCP IP address assignments are required on both the ONT
management VLAN and the subscriber's HSI VLAN. One approach is to have two discrete
DHCP servers - one for the management VLAN and one for the HSI VLAN.
In reality, you need not deploy individual DHCP servers. One method is to configure a
DHCP relay agent on the DHCP server which is designed to forward any DHCP request to
the actual DHCP server. This is typically accomplished by use of a managed switch at the
headend or central office. Another method is to configure the DHCP server to be on
multiple VLANs directly. See Notes on Configuring the DHCP Server (on page 75) for additional
information.
69
Supported Features
The features available over the managed ONT include:
Rate limiting upstream and downstream bandwidth

802.1p QoS support
Security
Multicast filtering
Multicast/Broadcast upstream shaping
Station filtering
DHCP L2 Relay via Option-82
DHCP Lease Limiting
An example of this model is illustrated below.
ONT Basic Multi-service - VLAN per Service

In this example, both high speed internet and IPTV service is provided to the subscriber on
separate VLANs.
70
Deployment Characteristics
The characteristics of this model include:
HSI and IPTV are provided on separate VLANs

MACFF required for security/isolation across subscriber networks.
Subscriber premise may have a gateway device (RG) or unmanaged switch
Separate Management VLAN, VoIP VLAN, and TLS VLANs are implemented
Supported Features
The features available over the VLAN per service model include:
IGMP snooping (only channels being viewed by subscriber are delivered)
QoS per VLAN (rate limiting and traffic shaping per service)
Multicast and Multicast-to-Unicast conversion
Subscriber to subscriber hair pinning for TLS (from the ONT to the switch to the ONT)
MAC Forced Forwarding (MACFF)
DHCP Lease Limiting
Multi-cast/Broadcast Filtering and Rate Limiting
IP Source verify, Station Validation
If the subscriber has an unmanaged switch, the device is classified via Organizationally
Unique Identifier (OUI) for set-top box identification
If the subscriber has a Residential Gateway (RG), the device is classified via tagging
An example of this model is illustrated below.
Chapter 2
Configuring an AE System
Calix AE ONTs rely on a pre-defined (or modified) configuration file to define its behavior
and services offered.
In addition to the ONT configuration files, there are several services that must be provided
by the network to fully support a Calix AE ONT deployment. These services must be
directly accessible on the management Virtual Local Area Network (VLAN).
AE System Essentials
The foundation for the Calix AE ONT solution incorporates a simple operational model:
Obtain an IP address from a DHCP server
Required for ONT initialization (provides IP address and other ONT inventory
information)
Required for VoIP port initialization
Obtain a configuration file from a TFTP server
Required for ONT download of the appropriate runtime image
Required for ONT download of the specific configuration file to use
Required for ONT download of VoIP configuration file (softswitch dependent)
Provide subscriber service
72
In addition, when an AE ONT comes on line, the ONT looks for other services specified in
its configuration file:
The Network Time Protocol (NTP) server in order to obtain an accurate reference for
the ONTs time-of-day clock.
The SYSLOG server in order to send any generated alarms, operational messages, or
alarms
A SIP server if Calix VoIP services are being implemented (optional)
An SNMP Trap Receiver for monitoring alarms and events generated by the ONT
(optional)
All services used by the AE ONT can be provided on a single Remote Management Interface
(RMI) if desired because the actual overhead required to support these services is quite small.
However, there is no requirement that a single management platform be used. In fact, each
of the services used by the ONT could exist on independent, geographically separated
platforms.
Important: Each service must be available on the management VLAN that the AE ONT is
using.
Prior to coming on-line, each ONT must download a configuration file from the TFTP
server. A unique configuration file is required for each ONT which is identified by the ONT
FSAN serial number of the RONTA ID as the configuration file name.
Note: An ONT may also be configured via the buttset interface. For additional information,
refer to the chapter entitled Remote ONT Activation. (on page 145)
Important: AE requires that each ONT have its own IP control address. ONTs are assigned
their IP address via the DHCP server. DHCP is also used to provide initial provisioning
information such as the location and name of the ONT's configuration file.
The ONT provisions itself each time it boots based on the parameters established above. As
a result, modifications to the configuration file only take effect when the ONT is reset. A
utility is provided to reset a single ONT or all ONTs associated with a given configuration
server. ONTs may also be reset using Simple Network Management Protocol (SNMP).
Note: For customers using Calix CMS, refer to Managing Active Ethernet ONTs from CMS.
73
About DHCP
From the client's perspective, DHCP is an extension of the BOOTP mechanism. This
behavior allows existing BOOTP clients to interoperate with DHCP servers without
requiring any change to the clients' initialization software. RFC 1542 [2] details the
interactions between BOOTP and DHCP clients and servers.
The format of a DHCP message is shown below with associated field definitions for a
DHCP message. The numbers in parentheses indicate the size of each field in octets.
0
01234567890123456789012345678901
op (1)
htype (1)
hlen (1)
hops (1)
xid (4)
secs (2)
flags (2)
ciaddr (4)
yiaddr (4)
siaddr (4)
giaddr(4)
chaddr (16)
sname (64)
file (128)
options (variable)
74
DHCP Message Field Definitions

Field
Octets
Description
op
Message op code/message type.
htype
Hardware address type.
Example: 1=BOOTREQUEST, 2=BOOTREPLY

Example: 1 = 10 mb Ethernet
hlen
Hardware address length.

Example: 6 = 10 mb Ethernet
hops
Client sets to zero, optionally used by relay agents when

booting via a relay agent.
xid
Transaction ID, a random number chosen by the client,

used by the client and server to associate messages and
responses between a client and a server.
secs
Populated by client, seconds elapsed since client began

address acquisition or renewal process.
flags
Used to enable acceptance of IP unicast stream.
ciaddr
Client IP address; only populated if client is in BOUND,

RENEW, or REBINDING state and can respond to ARP
requests.
yiaddr
Client IP address
siaddr
IP address of next server to use in bootstrap; returned in

DHCPOFFER, DHCPACK by server.
giaddr
Relay agent IP address, used in booting via a relay

agent.
chaddr
16
Client hardware address.
sname
64
Optional server host name, null terminated string.
file
128
Boot file name, null terminated string; "generic" name or

null in DHCPDISCOVER, fully qualified directory-path
name in DHCPOFFER.
options
var
Optional parameters field.
With the latest release of software, AE ONTs support DHCP Option 17, 66 and 67. These
three options are defined below:
option root-path text (Option 17)
This option specifics the path-name to the TFTP server where the ONT configuration file is
located. The path is formatted as a character string consisting of characters from the NVT
ASCII character set.
TFTP Server Name (Option 66)
This option is used to identify a primary TFTP server when the "sname" field in the DHCP
header has been used for other DHCP options. Option 66 has a minimum length of 1 and
allows you to assign TFTP server IP addresses to the message header for packet routing.
Note: For information on configuring a secondary TFTP Server, refer to DHCP Option-43
Configuration Process (on page 276).
75
TFTP Bootfile Name (Option 67)

This option is used to identify a bootfile when the "file" field in the DHCP header has been
used for other DHCP options. Option 67 has a minimum length of 1 and allows you to
assign TFTP server IP addresses to the message header for packet routing.
Notes on Configuring the DHCP Server

Calix supports the following RMI platforms:
Linux: ISC DHCP (open source DHCP server)

Solaris: Standard Solaris DHCP server.
The user may specify alternate configuration file names or TFTP addresses that the ONT
should use to obtain its provisioning. By default, the ONT uses the DHCP's address to
request its configuration file.
Note: Calix recommends using the ONT serial number or registration ID for identifying AE
ONT configuration files.
Note: If you find it necessary to deviate from the naming convention above, contact Calix
TAC for additional information on updating the DHCP configuration file.
DHCP Options
The AE ONT uses DHCP Option-60 (Vendor Class Identifier) and Option-61 (Client
Identifier) to facilitate custom configuration by the DHCP server. The DHCP server uses the
information in these option fields to look for DHCP messages that come from Calix AE
ONTs and uniquely identify each ONT individually.
Option-60: The AE ONT assigns the value "CALIX ONT" to the DHCP Option60 string in the DHCP Discovery message and the DHCP Request message. For
example, "CALIX ONT".
Note: In AE Release 1.1, the Option-60 string used the "CALIX AE <model#>" for
DHCP discovery. For existing ONTs upgrading to AE 2.0. THE less specific vendor
class identifier must be re-configured ("CALIX ONT").
Option-61: The AE ONT assigns the value "[serial number]" to the DHCP Option61 in the DHCP Discovery message and the DHCP Request message. For example,
"CXNK11900001".
Note: If a Registration ID has been provisioned on the ONT, a single character ("-") is
appended to the Registration ID indicating length followed by the Registration ID value
(numeric up to 10 characters).
76
Configuration File Server

A TFTP server provided on a Linux or Solaris platform is required on the system. The
minimum configuration specifications are:
Space for ONT Images: 4MB - 6MB for each ONT type (SFU and MDU)
Space for ONT Configuration Files: 1 Kb for each ONT configuration
Space for VoIP Configuration Files: 6 Kb for each unique VoIP configuration
Note: All SFU ONTs (for example 710GX, 711GX, 712GX, and 714GX) use the same
image. By default, the AE ONT attempts to download its configuration file from the DHCP
server that sent the ONT its IP address. However, the DHCP server is configured to provide
the ONT a different IP address to use as its TFTP server.
Configuring the CMS Server for DHCP Service
The CMS server can be configured for DHCP service for Calix Active Ethernet (AE) ONTs.
This topic covers these high-level steps:
Verify that you have the Red Hat DHCP or CentOS package.
Configure an Ethernet port for use by the DHCP server.
Enable the Calix AE ONTs to use the CMS server for DHCP service.
Verifying that the DHCP package is installed

By default the DHCP package is installed on CMS Appliance servers running CentOS.
Installing the DHCP package (Red Hat Linux 5)
To verify DHCP is installed, log in to the host server as the root user and run the
command:
yum info dhcp
If DHCP is not yet installed, you can install the latest version by running the
command:
yum install dhcp
If DHCP is already installed, you can update to the latest version by running the
command:
yum update dhcp
77
Configuring an Ethernet port for use

Before enabling DHCP service on the host server, you may need to configure an Ethernet
port (such as eth1) for the DHCP server. A separate Ethernet port is recommended, for
example, if your CMS deployment will manage more than 250 AE ONTs.
Consult with an IT professional to determine your port setup and requirements.
Tip: To determine what interface to use, you can run the ifconfig command to view all
configured Ethernet interfaces, and select the appropriate interface based on the IP address.
If you have not yet created a port for this purpose and your circumstances require one,
complete the following procedure.
Adding a second port for the DHCP server
1. On the Linux server monitor, close any open Terminal windows.
2. On the menu bar, open the Network Configuration dialog box:
(Red Hat 5) On the menu bar, click System > Administration > Network. In the
Network Setup screen, click Change Network Configuration.
3. In the Devices tab, Create a new Ethernet device:
In the tool icon bar, click New.
In the Select Device Type dialog box, the Ethernet Connection option is highlighted
by default. Click Forward.
Select the Ethernet card to use for the DHCP server (for example, if eth0 is already
created, select eth1), and then click Forward.
4. In the Configure Network Settings dialog box, accept the default setting (radio button
selected to the left of Automatically Obtain IP Address Settings with, and DHCP
displaying in the drop-down list):
Click Forward.
In the Create Ethernet Device dialog box, click Apply.
The Ethernet device displays in the Network Configuration dialog box Devices tab with
an Inactive status.
5. In the top right corner of the dialog box, click the Close button (or in the menu bar, click
File > Quit) to close the Network Configuration dialog box.
6. Open a terminal window, and verify the correct Ethernet port has been assigned to the
DHCP server in the sysconfig/dhcpd file. If necessary, add the Ethernet port to the end
of the line that begins DHCPDARGS=
In the following example, vi is used to open and edit the file.
78
Example
[root@cmshost1 ~]# cd /etc
[root@cmshost1 etc]# vi sysconfig/dhcpd
# Command line options here
DHCPDARGS=eth1
.
.
.
:wq
[root@cmshost1 etc]#
Enabling Calix devices to use the CMS server for DHCP service
Enabling Calix devices to use the CMS server as the DHCP service requires editing the
dhcpd.conf file, restarting the dhcp daemon, and turning on the DHCP service. You can
then verify that DHCP service is running.
For instructions on how to configure the DHCP server options at the network element level,
refer to the Calix user guide for the device.
The following procedure is applicable for Red Hat ES5.
To configure the CMS server for DHCP service
1. Log in on the host server as the root user. For tips and examples, see Accessing the Host
Server.
2. Navigate to the /etc directory.
Example
[root@cmshost1 ~]# cd /etc
3. Edit the dhcpd.conf script:

Tip: For a list of basic vi commands, see vi Editor Commands.
a. At the command prompt, type: vi
dhcpd.conf
to open the script file.
b. Specify the subnet and mask, broadcast address, and pool range.
Note: Recommended settings for the default and maximum lease times are shown in the
following example. Adjust these settings for your setup.
79
c. (Conditional, when routing to an outside network) Specify the IP address of the

router. If this step is not required for your setup, remove or uncomment the option
routers line (as shown in the following example).
d. (Conditional, for processing syslog messages) Specify the location for sending syslog
messages.
e. Press <Esc> to finish editing.
f. Type :wq and press <enter> to save the changes and close the script file.
Example
[root@cmshost1 etc]# vi dhcpd.conf
# DHCP Server Configuration file.
#
see /usr/share/doc/dhcp*/dhcpd.conf
ddns-update-style interim;
ignore client-updates;
# If this DHCP server is the official DHCP server for the local
# network, uncomment the authoritative directive.
authoritative;
# Use this to send dhcp log messages to a different log file.
# Use syslog.conf to complete the redirection).
log-facility local7;
#AE-ONT Directly connected Mgmt Network
subnet 172.26.31.0 netmask 255.255.255.0 {
# option routers
172.26.31.1;
option broadcast-address 172.26.31.255;
default-lease-time 3600;
max-lease-time 7200;
range 172.26.31.100 172.26.31.199;
}
:wq
4. After editing the file, restart the DHCP server. At the command prompt, type: service
dhcpd restart
5. Configure the daemon to run on startup. At the command prompt, type: chkconfig
dhcpd on
80
Example
[root@cmshost1 etc]# service dhcpd restart
[root@cmshost1 etc]# chkconfig dhcpd on
Starting dhcpd:
6. Verify that DHCP service is running:

a. Navigate to the /etc/init.d directory.
b. Run the command: ./dhcpd
status
Example
[root@cmshost1 ~]# cd /etc/init.d
[root@cmshost1 init.d]# ./dhcpd status
dhcpd (pid 2210) is running...
About DHCP Lease Expiration and Service Recovery

AE ONTs remain connected to the network based on the DHCP lease time. Depending on
the version of AE ONT software you are using, the following behavior can be expected:
AE ONT R2.0 - AE ONTs continue to provide services even if the DHCP renewal for the
management interface occurs but fails. When the lease time expires, the AE ONT resets and
attempts to recover a management IP address. If the DHCP server remains unreachable,
services on the AE ONT will cease. In addition, the "Management Interface DHCP Renewal
Failure" alarm is raised.
AE ONT R2.1 - AE ONTs continue to provide services even if the DHCP renewal for the
management interface occurs but fails. When the lease time expires, the AE ONT does not
reset while services on the AE ONT remain intact. In addition, the "Management Interface
DHCP Renewal Failure" alarm is raised.
81
Configuring Option-82
Option-82 is used to facilitate ONT management and is inserted by the headend switch the
ONT is attached to.
If the ONT is deployed on a switch that supports Option-82 insertion, there is an alternative
approach to identifying an ONT configuration file and IP address to the ONT each time it
boots.
Using Option-82, you specify the switch MAC address, the switch port number, and the
Management VLAN ID to be inserted for all DHCP traffic originating from subtending
ONTs. The DHCP server then uses that information to specify to the ONT the same IP
address each time it boots as well as the configuration file to use.
With Option-82 configured, when an ONT is replaced at a customer premises, it receives the
same IP address and configuration file as the previous ONT.
Notes on Configuring the NTP Server

A standards based NTP server provided on a Linux or Solaris platform is required on the
system for providing timing to the AE ONTs. The NTP server address is provided to the
ONT in the ONT configuration file. The service provider may add redundancy by adding a
backup NTP server and specifying a second address in the ONT's configuration file. The AE
ONT provides for primary and secondary NTP servers.
Note: Any loss of communication with the NTP server results in a warning message logged
to the Syslog server(s). However, failure to get NTP updates is not considered critical in
which case no further action is required.
The NTP server provides the time stamp necessary for alarms and error messages. The ONT
requests a time reference from the NTP server during the configuration process and
automatically adjusts its local time (and continues to monitor the NTP's time and updates the
ONT as necessary).
82
Notes on Configuring the Syslog Server

At least one Syslog server address must be provided to support ONT logging. The service
provider may specify a second Syslog server address in the ONT configuration file if
redundancy is required.
Note: In a dual Syslog server environment, the AE ONT sends every log message to both
server locations.
The ONT uses Syslog (per RFC3164 specifications) for reporting information events as well
as alarms (on page 221) or errors. Syslog messages are sent asynchronously as best effort
UDP packets to a designated server on the management VLAN. At boot-up, the ONT
recognizes the DHCP server as the Syslog server (prior to receiving any of its provisioning
information).
Note: Monitoring the Syslog server for alarms, events, or errors is an essential process for
ensuring ONT stability and overall network health.
Notes on Configuring the SIP Server

Note: The actual configuration of a SIP server is dependent on the softswitch chosen and is
beyond the scope of this document.
The initial configuration of the ONT is a single line in the ONT's configuration file that
contains the following VoIP service information:
ONT voice port to be enabled for SIP

The name of the VoIP configuration file (contains detailed SIP configuration
information specific for the softswitch, calling services to be supported, and the like)
The primary and secondary IP addresses of the TFTP server that is storing the VoIP
configuration file.
Username and password
URI string
Note: Because the SIP service works identically in either GPON or AE mode, the same
VoIP configuration file can be used to provision SIP services on either GPON or AE ONTs
simultaneously.
83
Network Component Details

Each AE ONT typically communicates with management services (for example, DHCP and
TFTP servers) through a dedicated Management VLAN on the Wide Area Network (WAN)
side of the connection. For security purposes, any subscriber side access to the management
VLAN is filtered out by the AE ONT. The ONT ships from the factory configured to
automatically create a default management VLAN with VLAN ID of 85.
Remote Management Interface (RMI) Station
The Remote Management Interface (RMI) is used to send commands collectively to the
ONT via a configuration file. The configuration file may be a flat ASCII file or a hierarchical
set of files that contain all the provisioning commands necessary to set up any ONT for
voice, data, and IP video traffic.
At a minimum, the RMI interface requires a DHCP Server, a TFTP Server, a SYSLOG
Server, and an NTP Server (see definitions below).
Important: This provisioning is downloaded every time the ONT boots no provisioning is
retained in the ONTs memory.
The RMI offers a flexible and expandable configuration file model that provides the
following capabilities:
Configuration File Naming: The ONT configuration file name is based on the FSAN
serial number (the same number appears on the external label of the ONT) or the
assigned Registration ID. The DHCP server can optionally override the configuration file
name.
Hierarchical File Structure: A hierarchical file structure allows any number of ONT
configuration files to reference one or more global configuration file(s). Up to 3 levels of
file nesting are provided. This allows global provisioning to be kept in a single file; and all
ONTs of the same service class refer to that file. Example: global configuration files that
are Bronze, Silver or Gold service profiles.
Separate VOIP Configuration: The same VOIP configuration file approach that is used
for GPON is used for AE ONTs. This allows a mixed GPON/AE ONT deployment to
use the same VOIP configuration file.
The provisioning commands in the configuration file are one per line but they support
commands that span multiple lines. The ONT processes the commands one at a time. If a
command fails due to syntax errors or during the application of the provisioning action, the
ONT sends an Event message to the Syslog server as well as an SNMP event trap. At that
point an alarm is generated indicating the configuration process encountered a CLI
command error. If the ONT successfully processes all commands without errors, it sends a
message to the Syslog server and CMS declaring the completion of the ONT configuration as
it moves into the operational state.
84
The Calix AE ONT communicates with the RMI platform across a dedicated management
VLAN. The ONT software comes from the factory configured to automatically create a
default management VLAN with VLAN ID of 85. The service provider has the option of
changing this VLAN ID on the ONT during installation using a buttset device (explained
later in this guide).
Note: See also the config vlan (on page 214) command for information on changing the
management VLAN.
For additional information, refer to Remote Management Interface Script (on page 172) in chapter
5.
DHCP Server
The Calix AE network supports Linux and Solaris platforms running their standard DHCP
server software.
The system requires a default DHCP configuration file which specifies various DHCP
Options or an alternate TFTP address for the ONTs use. By default, the ONT uses the
DHCP Server address to request its configuration file. To specify a different DHCP
configuration file or TFTP server address, simply update the DHCP configuration file with
the information.
For example, on a Linux system, you define the TFTP address in the /etc/dhcpd.conf file as
shown below.
next-server 192.168.7.100;
For additional information on DHCP, refer to About DHCP (on page 72).
TFTP Server
The TFTP Server hosts all configurations files for the AE network. Any Linux or Solaris
server can be used provided it has sufficient space to hold the ONT image (one for each
ONT type), as well as all ONT Configuration files and VoIP Configurations files.
Note: AE ONTs download their configuration file from the DHCP server that delivered the
IP address to the ONT. However, the DHCP server must be configured to provide a
different IP address if the TFTP Server resides elsewhere (dedicated TFTP Server).
NTP Server
The AE ONT requires an external resource to maintain an accurate time of day clock. This is
important for time stamping alarms and error messages. In AE mode the ONT uses the
standard Network Time Protocol to provide this function. The NTP protocol requires an
NTP server. The ONT requests time reference from the NTP Server during the
configuration process and adjusts its local time accordingly. Periodic requests and
adjustments keep the ONTs clock from drifting.
85
SYSLOG Server
The AE ONT requires a server resource for notifying the service provider when issues arise
that may impact the operation of the ONT. In AE mode the ONT uses the standard
network logging facility Syslog to log alarms, events, or errors detected by the ONT.
Note: The system operator must monitor the Syslog log file to determine if alarms, events,
or errors have been reported by any ONT.
The ONT uses SNMP traps and standard Syslog to notify the service provider when issues
arise that may impact the operation of the ONT. By default, the AE ONT sends alarm,
event, and informational messages to a Syslog server address. In addition, the customer has
the option of configuring up to 4 SNMP trap receivers as well to receive alarm and event
notification.
Note: All event and alarm messages are also forwarded to CMS provided the ONT has the
CMS IP address configured as an SNMP trap receiver. For additional information on
configuring the CMS IP Address, see DHCP Option-43 Configuration Process (on page 276).
SIP Server
A network based SIP server is required to complete the VoIP subsystem and provide voice
services.
86
Chapter 3
Understanding AE ONT Configuration
Files
ONT Operational Overview
AE ONTs obtains an IP address through a DHCP server and are configured and managed
remotely via an AE configuration file.
Services provided by the AE ONT include voice via SIP, IPTV, High Speed Internet (HSI),
and Business Ethernet.
Note: An ONT running in AE mode does not support legacy RF video services.
Note: For additional information on ONT Configuration Files, refer to Understanding AE
ONT Configuration Files (on page 401).
88
About Configuration Files

AE ONTs rely on a configuration file for providing all management and provisioning
instructions. Configuration files are flat ASCII text consisting of CLI command strings
containing provisioning information necessary to set up ONT voice, data, and IP video
services. This provisioning is automatically downloaded each time the ONT boots.
Configuration files are available pre-configured or generic configuration files can be
created/modified to meet your specific needs:
Pre-configured Configuration file templates are included with the AE ONT firmware.
These configuration files are accessible through the Command Line Interface and can be
modified using any commercially available text editor. For additional information on
managing/editing configuration files through the CLI, refer to Turning up an AE ONT via
CLI. (on page 177)
Configuration files can be developed as a set of multiple configuration file pieces that are
assembled into one common configuration file (cascading configuration files). In this
scenario, a top-level file calls out sub-tending configuration files and executes each file in
sequence.
All configuration files are flexible and scalable for any deployment size and offers the
following capabilities:
Serial Number Naming: ONT configuration file names are based on the FSAN serial
number (this number is displayed on the external label of each ONT). Alternatively, the
assigned Registration ID can be used provided the Registration ID is assigned to that
ONT. The DHCP server can also over-ride the configuration file name.
Hierarchical File Structure: A hierarchical file structure that allows any number of ONT
configuration files to reference one or more global configuration file (up to 3 levels of file
nesting is supported). This allows global provisioning to be kept in a single file with all
ONTs providing the identical class of service referencing that same file.
Separate VoIP Configuration File: The same VoIP configuration file approach that is
used for GPON systems is used for AE ONTs. This allows a mixed GPON/AE ONT
deployment using the same VoIP configuration file.
The provisioning commands in the configuration file consume one line per command and
support commands that span multiple lines. The ONT processes the CLI commands one at a
time. If a command fails due to syntax errors or during the application of the provisioning
action, the ONT sends a message to the Syslog server, the SNMP trap receiver, and generates
an alarm describing the error.
If the ONT successfully processes all commands without errors, it sends a message to the
Syslog server declaring the completion of the ONT configuration as it moves into
operational state.
89
Sample Configuration File

The samples shown below explain how configuration files are created for common system
elements and reference these elements in cascading configuration files. This helps simplify
the management of a large number of ONTs, where any given configuration file may
reference another configuration file, providing service parameters specific to that ONT.
The configuration file show below defines the management configuration being used by the
ONT, defines a custom label, and assigns voice, video, and data profile parameters to ONT
CXNK0002B70E.
Note: For additional information on the commands shown in the configuration files, refer to
the Appendix in the back of this guide.
90
internet_gold.cfg
This configuration file establishes upstream and downstream bandwidth.
Note this configuration file also calls the internet_common.cfg file that establishes upstream
and downstream traffic parameters for the Ethernet port.
91
video_gold.cfg
This configuration file establishes a VLAN per service model and creates service
authentication filters for set-top boxes attached to this port.
voice_setup.cfg
This configuration file establishes a VLAN Host Bridge for SIP services on the ONT.
92
In the examples shown above, the relationship of one configuration file to another is
portrayed as shown below. Two nesting levels are used (three are allowed) where the
internet_gold.cfg file is using a global internet_common file for establishing data bandwidth.
Configuration File Characteristics

A configuration files is an ASCII based text file incorporating a series of commands and
comments. ONT configuration files can be edited with any commercially available text
editor.
Keep the following in mind when working with configuration files:
Lines in a configuration file are terminated only after pressing the Enter key. Use the
back slash key to continue a line that extends past the visible screen area.
Any line beginning with a "#" symbol denotes a comment and is not interpreted as a
provisioning command at the ONT.
When building configuration files, use the backslash command ("\") for command line
continuation (screen wrap).
Specify the ONT's image name early. The name of the ONT's software image should
always be specified in the configuration file and should be one of the first provisioning
statements. This allows the ONT to always verify that it is running the correct version of
software early in the boot process. An example ONT image name:
CALIX_AE_ONT:R1]
The "include" command is used to call sub-tending configuration files (cascading)
The configuration file name must be the provisioned Calix FSAN Serial Number or the
Registration ID followed by the ".cfg" file extension (for example, CXNK0002B70E.cfg).
Note: If the input value for an ONT on the network begins with a number, it is assumed
to be a Registration ID and is validated as having up to 10 numeric digits. If the input
value starts with an alphabetic character, it is assumed to be an FSAN Serial Number, and
is validated to consist of the prefix "CXNK" followed by exactly 8 alphanumeric
characters.
93
Configuration File Processing

All Calix ONTs support recursive scripting (code that is used to perform basic maintenance
functions within the system) by implementing the include keyword followed by the
configuration file name. For example:
include common.cfg
The include common.cfg command instructs the ONT to retrieve the common.cfg file from
the TFTP server and process it.
Parameters are added to any command in the include file. Parameter values are specified after
the include filename. Parameters must be space or double quote delimited. Parameters are
referenced based on the numeric positioning of their appearance within the include
command (starting at zero). Up to 10 parameters can be defined from $0 to $9.
For example:
include management.cfg "200 Lake Street" ont_firmware.img
config label set label=$0
config upgrade -prisvr=192.168.0.1 filename=$1
In the code above, "200 Lake Street" is parameter $0 and is named label while
ont_firmware.img is parameter $1 and is named filename. Notice the space delimiter between
the two parameters. You can include up to 8 additional parameters before executing another
include statement.
Creating a Configuration File

In an AE environment, a hierarchy of configurations files is established to allow craftpersons
to pick and choose which configuration files to use for a given ONT.
Cascading configuration files routinely share the following attributes:
1. Top level files are unique to each ONT on the system ("ONT serial number".cfg or
"Registration ID".cfg).
2. Sub-files are specific in addressing an individual service type. For example, you might
expect to have a number of separate video configuration files based on the various tiers
of service that are available.
3. Sub-files should be generic enough where one configuration file is used for many
individual ONTs.
4. Template files are created to facilitate making minor changes to an ONT configuration.
5. Each Configuration file can call up to three additional levels of configuration files.
94
Example Cascading Configuration File templates appear later in this chapter. Service
providers can use these templates as a starting point and modify the template by
uncommenting the line that provides the specific level of service for that subscriber. For
example, the gold configuration in the hsi_setup.cfg file may provide 40 Mbps of high speed
data and the bronze configuration may only provide 5 Mbps.
Note: The names gold, silver, bronze are only examples. The actual file names, levels of
service, and any other specific information are entirely up to the service provider to define.
95
Sample Configuration Files - AE ONT

When managing your AE network, configuration files are used to specify service offerings on
AE ONTs. Sample Configuration Files (CF) are shown here and can be used as templates for
designing your own set of configuration files.
The configuration files shown below are included with the AE ONT software distribution
and are downloadable from the Calix Software Center.
Top Level AE ONT Configuration Files
Config File Name
Description
calix_700ge_sample.cfg (on page 96)
This configuration file example sets up triple play services on a Calix

7xxGE ONT.
calix700sfu_sample.cfg (on page 99)

7xxGX SFU ONT.
calix_760mdu_sample.cfg (on page

103)

76xGX MDU ONT.
Common Configuration Files

Config File Name
Description
common_ge.cfg (on page 107)*
Configures Syslog server location, SNMP traps, NTP server location,

and TFTP server location for ONT firmware upgrade (if upgrade is
needed). Also includes generic data "level of service" profiles, a
generic video VLAN bridge using Option-82, and voice service VLAN
bridge using the "bridge add" command.
common_sfu.cfg (on page 110)*
Same as common_ge.cfg
common_mdu.cfg (on page 113)*
Same as common_ge.cfg with the following additional parameter:

Low speed traffic shaper to regulate upstream broadcast for security
(meter set command) on the High Speed Internet (HSI) VLAN.
* - Script errors and warnings are sent to the Syslog server. To ensure errors are easily found during initial
configuration, Calix recommends the common_xx.cfg file be the first command executed in the top level AE
ONT configuration file.
Data Service Creation Configuration Files

Config File Name
Description
hsi_setup.cfg (on page 116)
Sets up the VLAN bridge for data services and appropriate traffic
filtering.
pwe3_setup.cfg (on page 118)
Adds end to end Pseudowire service (PWE3) to a T1/E1 port.
tls_setup.cfg (on page 118)
Sets up the VLAN bridge for Transparent LAN Services with

appropriate traffic filtering.
96
Video Service Creation Configuration Files

Config File Name
Description
video_mvr_port_setup.cfg (on page

124)
Creates a video VLAN bridge (port) and applies OUI filtering to the
port.
video_mvr_vlan_setup.cfg (on page

124)
Creates a content VLAN bridge and adds an MVR profile.
video_oui.cfg (on page 125)
Adds Level 1, Layer-2 filtering for set-top boxes attached to the video
VLAN.
video_profile_mvr.cfg (on page 126)
Creates the appropriate video profile for either video_setup.cfg or

video_mvr_setup.cfg
video_profile_no_mvr.cfg (on page

127)
Creates the video profile with MVR support.
video_setup_no_mvr.cfg (on page

127)
Adds subscriber port to video VLAN bridge and applies appropriate

OUI filtering
* - When using MVR, the video_setup.cfg file must be disabled.
Voice Service Creation Configuration Files

Config File Name
Description
voice_setup.cfg (on page 127)
Adds voice service to an Ethernet port.
VoipConfig.txt
an example SIP Configuration File.
calix_700ge_sample.cfg
[CALIX_AE_ONT:R1]
#
# This configuration file example sets up triple play services on an
# Calix 700GE series ONT. The following WAN VLANs are defined in
this
# example:
#
#
VLAN 85
- ONT Control/Configuration VLAN (default from
#
factory)
#
VLAN 900 - Transparent LAN Services
#
VLAN 3001 - VOIP/SIP VLAN
#
VLAN 4001 - Per subscriber High Speed Internet VLAN (HSI)
#
VLAN 4090 - IPTV VLAN
#
#
# Common housekeeping tasks and service VLAN bridge setup
#
include common_ge.cfg
#
# Assign a custom label to this ONT
#
97
config label set label="16305 36th Ave N Plymouth"
#
# === High Speed Internet service setup ===
#
#
All available service package levels are listed below.
#
Only one can be active at a time. The ones that are not
#
currently active are prefixed with leading "# ".
#
To enable a different service level, simply append the
#
leading "# " to the line referring to the current service
#
level, and remove the leading "# " from the line referring
#
to the desired service level.
#
#
Script parameters:
#
$0 = HSI VLAN assigned for this subscriber
#
$1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type
#
$2 = Shaper profile 0=40Mb/s 1=20Mb/s 2=10Mb/s (defined in
#
common.cfg)
#
# First Ethernet port #1 (eth-0)
#
include
hsi_setup.cfg
4001 eth-0 0
# include hsi_setup.cfg
4001 eth-0 1
4001 eth-0 2
#
#
#
#
#
Second Ethernet port #2 (eth-1)

include hsi_setup.cfg
4002 eth-1 0
4002 eth-1 1
4002 eth-1 2
#
# === Transparent LAN Services setup ===
#
#
#
#
#
#
#
#
#
#
#
#
Bridge creation for TLS VLAN (carrier tag 900), hair-pin enabled
in case another port on the same ONT is ever added in the same
TLAN
bridge add -fw=enable vid=900
Add subscriber Ethernet port to the TLS VLAN

Script parameters:
$0 = TLS VLAN assigned for this subscriber
98
#
#
#
#

common.cfg)

#
include tls_setup.cfg 900 eth-0 0
# include tls_setup.cfg 900 eth-0 1
#
#
#
#
#

include tls_setup.cfg
900 eth-1 0
900 eth-1 1
900 eth-1 2
#
# === Video service setup ===
#
#
Configure the subscriber Ethernet ports participating in
#
video service. The ones that are disabled are prefixed
#
with leading "# ".
#
#
To enable a subscriber Ethernet port for video service,
#
simply remove the leading "# " from the line referring
#
to the subscriber Ethernet port.
#
#
Script parameters:
#
#
include
video_setup_no_mvr.cfg
eth-0
# include video_setup_no_mvr.cfg
eth-1
# TO DO MVR video, delete the above 2 line and replace with the
# following:
# #Add an MVR content VLAN
# include video_mvr_vlan_setup.cfg 3210
# #Add a port for the MVR video service
# include video_mvr_port_setup.cfg eth-0 3210
#
# # Add an additional port as needed:
# #include video_mvr_port_setup.cfg eth-1 3210
# # Add another content VLAN for MVR as needed:
# #include video_mvr_vlan_setup.cfg 3211
99
#
# === Voice service setup ===
#
#
Add voice service to POTS ports
#
#
Script parameters:
#
$0 = POTS port number (0, 1, .. etc)
#
$1 = VOIP port label, alphanumerical label
#
$2 = VOIP registration username
#
$3 = VOIP registration password
#
$4 = URI
#
#
Add voice service to POTS line 1
#
include voice_setup.cfg 0 Name_Line1 7635551011 password 7635551011
#
#
#
# === Ethernet port enabling ===
#
#
All Ethernet ports are administratively disabled by default.
#
Each Ethernet port needs to be specifically enabled before any
#
data traffic can pass through.
# Enable Ethernet port #1
# set iftable adminstatus index=eth-1 adminstatus=up
100
calix_700sfu_sample.cfg
[CALIX_AE_ONT:R1]
#
# Calix 700GX series SFU ONT. The following WAN VLANs are defined
# in this example:
#
#
VLAN 85
#
factory)
#
#
#
#
#
#
#
include common_sfu.cfg
#
#
#
#
#
#
#
#
#
#
#
#
#
Script parameters:
#
#
#
#
common.cfg)
#
#
include
hsi_setup.cfg
4001 eth-0 0
4001 eth-0 1
101
4001 eth-0 2
#
#
#
#
#
4002 eth-1 0
4002 eth-1 1
4002 eth-1 2

#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
TLAN

Script
$0 =
$1 =
$2 =
parameters:
TLS VLAN assigned for this subscriber
Ethernet port eth-0, eth-1 .. eth-X depending on ONT type
Shaper profile 0=40Mb/s 1=20Mb/s 2=10Mb/s (defined in
common.cfg)

#
#
#
#
#
#

900 eth-1 0
900 eth-1 1
900 eth-1 2
#
#
#
#
#
with leading "# ".
102
#
#
#
#
#
#
Script parameters:
#
#
include
eth-0
eth-1
# TO DO MVR video, delete the above 2 line and replace with the
# following:
# #Add an MVR content VLAN
# include video_mvr_vlan_setup.cfg 3210
# #Add a port for the MVR video service
# include video_mvr_port_setup.cfg eth-0 3210
#
# # Add an additional port as needed:
# # include video_mvr_port_setup.cfg eth-1 3210
# # Add another content VLAN for MVR as needed:
# # include video_mvr_vlan_setup.cfg 3211
#
#
#
#
#
Script parameters:
#
#
#
#
#
$4 = URI
#
#
#
#
#
#
103
#
#
#
#


calix_760mdu_sample.cfg
[CALIX_AE_ONT:R1]
#
# Calix 76xGX series MDU ONT. The following WAN VLANs are defined
# in this example:
#
#
VLAN 85
#
factory)
#
#
#
#
#
#
#
include common_mdu.cfg
#
#
#
#
#
#
#
#
#
#
#
#
104
#
#
#
#
#
#
Script
$0 =
$1 =
$2 =
parameters:
HSI VLAN assigned for this subscriber
Ethernet port eth-0, eth-1 .. eth-X depending on ONT type
Shaper profile 0=40Mb/s 1=20Mb/s 2=10Mb/s (defined in
common.cfg)
# Ethernet port #1 (eth-0)

#
include
hsi_setup.cfg
4001 eth-0 0
4001 eth-0 1
4001 eth-0 2
#
#
#
#
#
Ethernet port #2 (eth-1)
#
#
#
#
#
#
#
#
#
#
4002 eth-1 0
4002 eth-1 1
4002 eth-1 2
4003 eth-2 0
4003 eth-2 1
4003 eth-2 2
4004 eth-3 0
4004 eth-3 1
4004 eth-3 2
#
#
#
#
#
#
#
#
#
#
#
#
#
#
TLAN

Script parameters:
105
#
#
#

common.cfg)
# Ethernet port #1 (eth-0)

#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
900 eth-1 0
900 eth-1 1
900 eth-1 2
900 eth-2 0
900 eth-2 1
900 eth-2 2
900 eth-3 0
900 eth-3 1
900 eth-3 2
#
#
#
#
#
with leading "# ".
#
#
#
#
#
#
Script parameters:
#
#
include
eth-0
eth-1
eth-2
eth-3
106
#
#
#
#
#
#
#
#
#
#
#
#
#
TO DO MVR video, delete the above 4 lines and replace with the
following:
#Add an MVR content VLAN
include video_mvr_vlan_setup.cfg 3210
#Add a port for the MVR video service
include video_mvr_port_setup.cfg eth-0 3210
#
#
#
#
#
#
Add an additional port as needed:

Add another content VLAN for MVR as needed:
include video_mvr_vlan_setup.cfg 3211
#
#
#
#
#
Script parameters:
#
#
#
#
#
$4 = URI
#
#
Add voice service to port 1
#
#
#
#
#
#
#
#
#
107
#
#
#
#
#
#
#
# === PWE3 service setup ===
#
# include pwe3_setup.cfg
#
#
#
#
#
108
common_ge.cfg
[CALIX_AE_ONT:R1]
####################################################################
##
# Management tasks
####################################################################
##
#
# Configure Syslog server address
#
#
Since all script errors and warnings are piped to the Syslog
#
server, this needs to be the first command in the overall
#
configuration to capture any possible problems in the scripts.
#
#
TODO: Update primary and secondary (optional) Syslog server
#
addresses
#
config syslog setup \
-prisvr=172.26.31.3 \
-secsvr=172.26.31.4
#
# SNMP trap sinks
#
config trap sink \
-s1=172.26.31.3 \
-s2=172.26.31.4
#
# Configure NTP server address
#
#
TODO: Update primary and secondary (optional) NTP server
#
addresses
#
config ntp update \
-prisvr=172.26.31.3 \
-secsvr=172.26.31.4 \
offset=-18000
#
# Upgrade ONT firmware if needed
#
#
#
TODO: Update primary and secondary (optional) TFTP server
#
addresses
#
109
config upgrade \
-prisvr 172.26.31.3 \
-secsvr 172.26.31.4 \
filename=calix_ge.rto
####################################################################
##
# High Speed Internet (HSI) Service
####################################################################
##
#
# Common service profiles setup
#
# Gold level
# 40 Mbps upstream, 40 Mbps downstream on all traffic on an Ethernet
# port
# Silver level
# port
# Bronze level
# port
#
# Low speed shaper for upstream broadcast as security for the HIS
# VLAN
#
####################################################################
##
# IPTV service
####################################################################
##
#
# Create VLAN bridge for IPTV service on VLAN 4090
#
include video_profile_no_mvr.cfg
110
# To support MVR video, replace the above with the following to
# fulfill a pre-requisite:
# include video_profile_mvr.cfg
#
# (optional) set up the option82 format string for the IPTV bridge
#
# opt82 set string vid=4090 format="%sn - %vlan - %clab - %iftype# %ontport - %desc"
#
# (optional) enable option82 on IPTV bridge
#
The following option82 would be produced...
#
CXNK03010101 - 4090 - 16305 36th Ave N Plymouth - eth-0
#
John Doe
#
# opt82 enable remote vid=4090 -frame=1stag -desc="John Doe"
####################################################################
##
# Voice service
####################################################################
##
#
# Create a VLAN IP Host Bridge for both voice ports using iph-1,
# mark
# PBITs with 5 on VLAN 3001
#
bridge addiph -pbit=5 vid=3001
bridge portadd vid=3001 dev=iph-1
#
# Create the IP Host (iph-1) to use the default DHCP method of
# getting an address
#
iphost create dev=iph-1
111
common_sfu.cfg
[CALIX_AE_ONT:R1]
####################################################################
##
# Management tasks
####################################################################
##
#
#
#
#
#
#
#
addresses
#
-prisvr=172.26.31.3 \
-secsvr=172.26.31.4
#
# SNMP trap sinks
#
config trap sink \
-s1=172.26.31.3 \
-s2=172.26.31.4
#
#
#
#
addresses
#
config ntp update \
-prisvr=172.26.31.3 \
-secsvr=172.26.31.4 \
offset=-18000
#
#
#
#
#
addresses
#
112
config upgrade \
-prisvr 172.26.31.3 \
-secsvr 172.26.31.4 \
filename=calix_sfu.rto
####################################################################
##
####################################################################
##
#
#
# Gold level
# port
# Silver level
# port
# Bronze level
# port
#
# Low speed shaper for upstream broadcast as security for the HIS
# VLAN
#
####################################################################
##
# IPTV service
####################################################################
##
#
#
113
#
#
#
# The following option82 would be produced...
# CXNK03010101 - 4090 - 16305 36th Ave N Plymouth - eth-0 - John
# Doe
#
####################################################################
##
# Voice service
####################################################################
##
#
# mark PBITs with 5 on VLAN 3001
#
#
#
114
common_mdu.cfg
[CALIX_AE_ONT:R1]
####################################################################
##
# Management tasks
####################################################################
##
#
#
#
#
#
#
#
#
addresses
#
-prisvr=172.26.31.3 \
-secsvr=172.26.31.4
#
# SNMP trap sinks
#
config trap sink \
-s1=172.26.31.3 \
-s2=172.26.31.4
#
#
#
#
addresses
#
config ntp update \
-prisvr=172.26.31.3 \
-secsvr=172.26.31.4 \
offset=-18000
#
#
#
#
#
addresses
#
115
config upgrade \
-prisvr 172.26.31.3 \
-secsvr 172.26.31.4 \
filename=calix_mdu.rto
####################################################################
##
####################################################################
##
#
#
# Gold level
# port
# Silver level
# port
# Bronze level
# port
#
# Low speed shaper for upstream broadcast as security for the HSI
# VLAN
#
####################################################################
##
# IPTV service
####################################################################
##
#
#
116
#
#
#
#
The following option82 would be produced...
#
CXNK03010101 - 4090 - 16305 36th Ave N Plymouth - eth-0 - John
#
Doe
#
####################################################################
##
# Voice service
####################################################################
##
#
# mark PBITs with 5 on VLAN 3001
#
#
#
117
hsi_setup.cfg
[CALIX_AE_ONT:R1]
#
# Example setup script for High Speed Internet (HSI) Services
#
# It sets up the VLAN bridge for HSI and the appropriate traffic
# filtering.
#
# Script parameters:
#
#
#
#
common.cfg)
#
#
# Create VLAN Per port HSI (High speed Internet Service Bridge) on
# VLAN $0
# - $1, for debugging enable learning bridge and filter all upstream
# multicast
#
bridge add -lb=enable -mf=enable vid=$0
#
# (optional) set up the option82 format string for the HSI bridge
#
# opt82 set string vid=$0 format="%sn - %vlan - %clab - %iftype# %ontport - %desc"
#
#
The following option82 would be produced...where $0 = eth-x and
#
$1 = VLAN id
#
CXNK03010101 - $1 - 16305 36th Ave N Plymouth - $0 - John Doe
#
# opt82 enable remote vid=$0 -frame=1stag -desc="John Doe"
#
# Attach subscriber Ethernet port to VLAN bridge
#
bridge portadd vid=$0 dev=$1
#
# Add a Level 2 filter such that all other untagged traffic from
# subscriber is mapped to HSI, VLAN $1 on $0
#
lev2 add -treatinpri=0 -treatinvid=$0 dev=$1
118
#
# Attach low speed shaper for upstream multicast as security
#
meter attach mcastup vid=$0 shaper=10
#
# Attach service profile to HSI VLAN
#
meter attach downstream -vid=$0 shaper=$2
meter attach upstream -vid=$0 shaper=$2
pwe3_setup.cfg
[CALIX_AE_ONT:R1]
#
# Add PWE3 service to a T1/E1 port.
#
# SAToP (unstructured) encapsulation is supported.
# CESoPSN (structured) encapsulation is not supported at this time.
#
# PWE3 supports transport at Layer 3 (UDP/IP) or Layer 2 (MEF).
# For UDP/IP, PWE3 supports UDP demultiplexing (UDP port number
# usage) as defined in RFC 5086 and RFC 5087. The UDP port numbers
# represent the PW labels. The PW label correlates the packet with
# the T1/E1 port.
# The UDP mode must be the same for all PWs on an ONT. The ONT
# defaults to "5087" mode and the ONT will reset when the mode is
# changed.
# "5086" mode: Destination UDP port number = remote PW label, Source
# UDP port = local PW label. In this mode, the PW labels can be
# different. This mode will interoperate with Telco, Axerra, and RAD
# Gmux.
# "5087" mode: Destination UDP port number = 2142, Source UDP port
# number = PW label. In this mode, the PW label must be the same at
# each endpoint. This mode will interoperate with the RAD IPmux and
# Gmux.
# For MEF, PWE3 follows MEF 8. The ECID represents the PW label.
# MEF transport can be provisioned by specifying either the
# destination MAC address or the destination IP address.
# If the destination IP address is provisioned, PWE3 will ARP to
# resolve the destination MAC address. Payload transport is purely
# Layer 2.
# MEF and UDP/IP can be run at the same time on an ONT.
#
# All PWs on an ONT are either T1 or E1.
#
# PWE3 supports RTP and both absolute and differential timestamps.
119
# The RTP timestamp mode must be the same for all PWs on an ONT. The
# ONT will reset when the RTP timestamp mode is changed.
#
# Conventions used in this file:
#
"#--" denotes a command
#
"-parameter" the dash preceding a parameter name denotes
#
an optional parameter
#
"< >" denotes parameter values
#
IP addresses are entered as xxx.xxx.xxx.xxx notation
#
MAC addresses are entered as xx:xx:xx:xx:xx:xx notation
#
##############################
# Provision the TDM mode of the ONT.
#
This only needs to be executed once since all PWs will run in
#
the same mode.
#
The ONT will reset when the mode is changed.
#-- pwe3 tdmmode -mode=<t1 | e1>
#
##############################
# Provision the bridge interworking function.
#
All PWs utilize the same interworking function so this only
#
needs to be executed once.
#
The static IP address is required for UDP/IP and optional for
#
MEF.
#
The gateway is optional. If the destination IP address is on a
#
different subnet, the gateway address must be specified.
#
In this case, the gateway address must be on the same subnet as
#
the static IP address.
#
PWE3 only supports a subnet mask of 255.255.255.0 so it is not
#
necessary to provision the subnet mask.
#-- pwe3 bridge create -staticip=<ipaddress> -gateway=<ipaddress>
vid=<1..4094> pbit=<0..7>
#
If the bridge has been provisioned for MEF without a static IP
#
address, this command can be used to add the IP address
#
information for PWE3. This would be necessary when adding a
#
UDP/IP PW after a MEF PW has been provisioned.
#-- pwe3 bridge addip -gateway=<ipaddress> staticip=<ipaddress>
#
##############################
# Provision a T1 port.
#
This command only applies when the TDM mode is T1.
#
The T1 port defaults to the proper configuration to support
#
SAToP.
#
Options:
#
-frameformat=<unframed | esf | sf>
#
default unframed (esf and sf not supported in SAToP)
#
-linecoding=<ami | b8zs>
#
default b8zs
120
#
-linebuildout=<0_110 | 110_220 | 220_330 | 330_440 | 440_550
#
| 550_660> default 0_110
#
-loopbackmode=<none | facility | equipment | payload>
#
default none (payload not supported in SAToP)
#
-inbandloopback=<disabled | enabled>
#
default disabled
#
-adminstate=<disabled | enabled>
#
default enabled
#-- pwe3 t1port port=<1..8>
#
##############################
# Provision an E1 port.
#
This command only applies when the TDM mode is E1.
#
The E1 port defaults to the proper configuration to support
#
SAToP.
#
Options:
#
-frameformat=<unframed>
#
default unframed
#
-linecoding=<hdb3>
#
default hdb3
#
-loopbackmode=<none | facility | equipment | payload>
#
default none (payload not supported in SAToP)
#
-inbandloopback=<disabled | enabled>
#
default disabled
#
-adminstate=<disabled | enabled>
#
default enabled
#
-impedance=<75 | 120>
#
default 120 ohm balanced (75 ohm is unbalanced)
#-- pwe3 e1port port=<1..8>
#
##############################
# Provision PWE3 service on a T1/E1 port.
#
While both the destination IP and destination MAC are optional
#
parameters, one is always required but both are not allowed.
#
Options:
#
-mef=<disable | enable>
#
default disable (UDP/IP is the default transport)
#
-destip=<ipaddress>
#
required for UDP/IP, optional for MEF
#
-destmac=<macaddress>
#
optional for MEF
#
-remotelabel=<1024..65535 | 1..1048575>
#
UDP range 1024..65535, ECID range 1..1048575
121
#
-locallabel=<1024..65535 | 1..1048575>
#
UDP range 1024..65535, ECID range 1..1048575
#
-satpacketsize=<80..1450>
#
default 204 bytes
#
-jitterbuffer=<1000..512000>
#
default 1500 usec
#-- pwe3 service create -destip=<ipaddress> -locallabel=<nnn>
#port=<1..8> rtpheader=<disable | enable> rtpmode=<absolute |
#differential> timingmode=<adaptive | differential | loop>
#
# UDP/IP "5086" example
#
By provisioning both the local and remote labels, "5086" mode is
#
selected. All remaining PWs must now be either "5086" mode or
#
MEF.
#-- pwe3 service create -destip=100.1.1.1 -locallabel=20001
#remotelabel=30001 port=1 rtpheader=disable rtpmode=absolute
#timingmode=adaptive
#
# UDP/IP "5087" example
#
By provisioning only the local label, "5087" mode is selected.
#
All remaining PWs must now be either "5087" mode or MEF.
#-- pwe3 service create -destip=100.1.1.1 -locallabel=20001 port=1
#rtpheader=disable rtpmode=absolute timingmode=adaptive
#
# MEF MAC address example
#
MEF requires both the local and remote labels (ECIDs) to be
#
provisioned.
#-- pwe3 service create -mef=enable -destmac=00:11:22:33:44:55
#locallabel=333 -remotelabel=444 port=1 rtpheader=disable
#rtpmode=absolute timingmode=adaptive
#
# MEF IP address example
#
The destination MAC address will be resolved via ARP.
#-- pwe3 service create -mef=enable -destip=100.1.1.1
#locallabel=333 -remotelabel=444 port=1 rtpheader=disable
#rtpmode=absolute timingmode=adaptive
#
##############################
# End-to-End examples
#
# UDP/IP "5086" mode with loop timing at ONT1 and adaptive timing at
ONT2. T1 mode.
#
ONT1
#-- pwe3 tdmmode -mode=t1
#-- pwe3 bridge create -staticip=100.1.1.1 vid=101 pbit=5
#-- pwe3 t1port port=1
122
# timingmode=loop
#
ONT2
#timingmode=adaptive
#
# UDP/IP "5087" mode with loop timing at ONT1 and adaptive timing at
# ONT2. T1 mode.
#
ONT1
#rtpheader=disable rtpmode=absolute timingmode=loop
#
ONT2
#rtpheader=disable rtpmode=absolute timingmode=adaptive
#
# MEF with loop timing at ONT1 and adaptive timing at ONT2. E1 mode.
# 1 packet every msec is 256 bytes for E1.
#
ONT1
#-- pwe3 tdmmode -mode=e1
#-- pwe3 e1port port=1
#locallabel=2000 -remotelabel=2001 -satpacketsize=256 port=1
# rtpheader=disable rtpmode=absolute timingmode=loop
#
ONT2
#-- pwe3 tdmmode -mode=e1
#-- pwe3 e1port port=1
#locallabel=2001 -remotelabel=2000 -satpacketsize=256 port=1
# rtpheader=disable rtpmode=absolute timingmode=adaptive
123
tls_setup.cfg
[CALIX_AE_ONT:R1]
#
# Example script for Transparent LAN Services (TLS)
#
# This script sets up the VLAN bridge for TLS and the appropriate
# traffic filtering
#
#
#
#
#
common.cfg)
#
#
# Create VLAN bridge for TLS service
#
bridge add vid=$0
#
#
#
# Attach service profile to TLS VLAN
#
# The following is a filter command which would be used for Q in Q
# TLS.
# Any frame arriving with a tag of 0x8100 gets another tag added to
#it (carrier tag). The incoming PBITs are propagated to the carrier
#tag.
# QoS in the ONT is enforced at all blocking points based on PBIT
#priority.
# result = double tag, Add VID ($1) from incoming ANY VID (with a
# ethertype default InputTPID (0x8100)), propagate incoming PBIT
# from incoming tag, use default outputTpid (0x8100)
lev2l2tag add \
-filtinpri=8 \
-filtintpidde=5 \
-treatoutpri=8 \
124
-treatoutvid=$0 \
-treatinpri=8 \
-treatinvid=4096 \
dev=$1
video_mvr_port_setup.cfg
[CALIX_AE_ONT:R1]
#
# Setup IPTV service on subscriber Ethernet port with MVR
#
# ***************************
# IMPORTANT!!!!
#
# To be used in PLACE of video_setup.cfg. DO NOT use together with
# video_setup.cfg!!!
#
# Pre-requisite video_profile_mvr.cfg must have completed its run at
# an earlier time!!!
# Pre-requisite video_mvr_vlan_setup.cfg must have completed its run
# at an earlier time!!!
# ***************************
#
#
#
$1 = VLAN ID of the "content" VLAN for MVR video
# Add subscriber port to IPTV VLAN bridge
bridge portadd vid=4090 dev=$0
# Set up appropriate OUI filtering for set top boxes
include video_oui.cfg 4090 $0
125
video_mvr_vlan_setup.cfg
[CALIX_AE_ONT:R1]
#
# Setup IPTV service on subscriber Ethernet port with MVR
#
# ***************************
# IMPORTANT!!!!
#
# To be used in PLACE of video_setup.cfg. DO NOT use together with
# video_setup.cfg!!!
#
# Pre-requisite video_profile_mvr.cfg must have completed its run at
# an earlier time!!!
# ***************************
#
#
$0 = VLAN ID of the "content" VLAN for MVR video.
# TODO - Script parameters:
#
Optionally, an IP address range could be passed in via $1, and
#
$2 parameters to specify ipstart and ipend...?
# Create a Content VLAN bridge

bridge add -snoop=enable -onlydhcp=ena vid=$0
# Bind a content VLAN to
mvrprofile add vlan=4090
# optionally set a range
mvrprofile set vlan=4090
ipend=0.0.0.0
the MVR control VLAN (a.ka. 4090)

mvrvlan=$0
limit for the content VLAN
mvrvlan=$0 index=1 ipstart=0.0.0.0
126
video_oui.cfg
[CALIX_AE_ONT:R1]
#
# Add Level 1 layer 2 filter for OUI (STBs) map to IPTV VLAN
#
#
$0 = IPTV VLAN
#
#
# Example:
#
# 00:02:02
Amino MAC prefix
#
lev1 add \
-filtmac=sa \
-filtmacmask=ff:ff:ff:00:00:00 \
-filtmacmatch=00:02:02:00:00:00 \
-treatinpri=4 \
-treatinvid=$0 \
dev=$1
video_profile_mvr.cfg
[CALIX_AE_ONT:R1]
#
# Setup IPTV service profiled for either video_setup.cfg or
# video_mvr_setup.cfg
#
# TODO - Script parameters:
# optionally, a IP address range could be passed in via $0, and $1
# parameters to specify ipstart and ipend...?
#create basic Video profile
videoprofile create -maxchannels=16
-queryinterval=160 name=TZbasic
#Multicast address range

mcrange create vlan=4090
mcrange set vlan=4090 index=1 ipstart=224.0.1.0
ipend=239.255.255.255
#MVR Profile
mvrprofile create vlan=4090
# Delete the above line, if MVR video is NOT desired, video content
# can still be delivered on 4090.
#Set up control bridge for MVR video service
bridge add -snoop=enable -onlydhcp=ena -vprofile=TZbasic vid=4090
127
# note if MVR is not being used, then this is also the content
# bridge as well
video_profile_no_mvr.cfg
[CALIX_AE_ONT:R1]
#
# Setup IPTV service profile
bridge add -snoop=ena vid=4090
[CALIX_AE_ONT:R1]
#
# Setup IPTV service on subscriber Ethernet port
#
#
# Add subscriber port to IPTV VLAN bridge
bridge portadd vid=4090 dev=$0
include video_oui.cfg 4090 $0
voice_setup.cfg
[CALIX_AE_ONT:R1]
#
# Add VOIP service to a port
#
#
#
#
#
#
$4 = URI
#
# TODO: Update primary and secondary TFTP server address and
# VOIP configuration filename
#
voip add \
board=i-pots \
port=$0 \
iphost=1 \
display=$1 \
file=VoipConfig.txt \
prisvr=172.26.203.16 \
128
secsvr=172.26.203.16 \
user=$2 \
password=$3 \
uri=$4
ctg_setup.cfg
[CALIX_AE_ONT_R1]
#
# Example GR-303 Voice Profile
#
# Add GR-303 Voice Service to a port
#
# $0 = POTS port number (0, 1 . . .)
# $1 = LINEAID
#
ctg setup \
-pbit=5 \
-linemode=LoopStart \
board=i-pots \
port=$0 \
ctgserver=10.12.8.5 \
lineaid=$1 \
vid=703
Recommended Naming Conventions for the C7 TDM Gateway Configuration

File
The ASCII string GR303 should appear at the beginning of the profile name
The ASCII string designating the GR-303 Interface Group should appear at the end of
the profile name
GR303_N140-1-IG1.cfg
GR303_N140-1-IG1.cfg
The profile name is case sensitive and Calix recommends using all capital letter in the profile
name.
129
Add VoIP Service to a Port

The following configuration file (voice_setup.cfg) adds VoIP service to an individual port on the
ONT. In this file, the location (primary and secondary server) and file name for the VoIP
Configuration file are called out.
[CALIX_AE_ONT:R1]
#
# Add VOIP service to a port
#
#
$0 = POTS port number (0, 1, . . . and so on)
#
#
$2 = VOIP registration user name
#
#
$4 = URI
#
# TODO: Update primary and secondary TFTP service address and VOIP
# configuration filename
#
voip add \
linemode=GroundStart \
board=i-pots \
port=$0
iphost=1 \
display=$1 \
file=VoipConfig.txt \
prisvr=172.26.203.16 \
secsvr=172.26.203.16 \
user=$2 \
password=$3 \
uri=$4
130
Cascading CF
The cascading configuration file approach employs several files which are "nested" together
under a top level main configuration file.
[CALIX_AE_ONT:R1]
#
# This configuration file example sets up triple play services on a
# Calix 710GX ONT. The following WAN VLANs are defined in this
# example:
#
#
VLAN 85
#
factory)
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
Script parameters:
#
#
#
#
common.cfg)
#
# First Ethernet port (eth-0)
#
4001 eth-0 0
4001 eth-0 1
4001 eth-0 2
#
#
#
#
#
Second Ethernet port (eth-1)

4002 eth-1 0
4002 eth-1 1
4002 eth-1 2
131
#
#
#
# Bridge creation for TLS VLAN (carrier tag 900), hair-pin enabled
# in case another port on the same ONT is added in the same TLAN
#
# bridge add -fw=enable vid=900
#
#
#
#
Script parameters:
#
#
#
#
common.cfg)
#
#
#
=== TLS with Q in Q ===
#
# This script sets up the VLAN bridge for TLS and the appropriate
# traffic filtering
#
#
#
#
#
# The following is a filter command which would be used for Q in Q
# TLS.
# Any frame arriving with a tag of 0x8100 gets another tag added to
# it (carrier tag). The incoming PBITs are propagated to the
# carrier tag.
# QoS in the ONT is enforced at all blocking points based on PBIT
# priority.
# result = double tag, Add VID ($1) from incoming ANY VID (with a
# ethertype default InputTPID (0x8100)), propagate incoming PBIT
# from incoming tag, use default outputTpid (0x8100)
132
lev2l2tag add \
-filtinpri=8 \
-filtintpidde=5 \
-treatoutpri=8 \
-treatoutvid=$0 \
-treatinpri=8 \
-treatinvid=4096 \
dev=$1
#
# Attach service profile to TLS VLAN
#
#
#
#
video service. The ports that are disabled are prefixed
#
with leading "# ".
#
#
#
#
#
#
Script parameters:
#
#
include video_setup.cfg
eth-0
# include video_setup.cfg
eth-1
#
#
#
#
#
Script parameters:
#
#
#
#
#
$4 = URI
#
include voice_add.cfg 0 Name_Line1 7635551011 password 7635551011
#
#
#
#
Script parameters:
#
#
#
#
133
#
$4 = URI
#
include voice_add.cfg 1 Name_Line2 7635551013 password 7635551013
#
#
#
#
#
data traffic passes through.
# Enable eth-0
# Enable eth-1
134
The table below provides a visual reference as to the configuration files needed to support
this network and how each configuration file interacts.
Sample Cascading Configuration File Definitions
Configuration
File Name
Hierarchy
Included
Configuration Files
Defined Parameters
common.cfg
ONT Control VLAN (Default 85)
or
hsi_setup.cfg
TLS VLAN 900
"registrationid.cfg"
video_setup.cfg
SIP/VoIP VLAN 3001
voice_add.cfg
HSI VLAN 3001
IPTV VLAN 4090
Assigns Label to ONT
Enables two Ethernet ports
Configures SYSLOG Server
Defines Trap Receivers
Configures NTP Server
Defines TFTP server addresses if firmware

upgrade is required
Defines HSI Bandwidth allocation
Defines Traffic shaper for VLAN Security (HSI

VLAN)
"serialnumber.cfg"
common.cfg
hsi_setup.cfg
video_setup.cfg
Main
Included in Main
Configuration File
Included in Main
Configuration File
Included in Main
Configuration File
None
None
video_oui.cfg
Creates VLAN bridge for IPTV
Creates VLAN IP Host Bridge for both voice ports
Creates VLAN bridge for HSI and appropriate

traffic filtering
Attaches ONT Ethernet port to VLAN bridge
Adds Level 2 filtering for untagged traffic (maps to

VLAN bridge)
Defines upstream mcast traffic shaper for VLAN

Security
Attaches service profile for HSI VLAN
Sets up IPTV service on ONT Ethernet port
Adds ONT Ethernet port to IPTV VLAN Bridge
Sets up OUI filtering
video_oui.cfg
Included in
video_setup.cfg
None
Adds desired filter for STB - routes to appropriate

IPTV VLAN
voice_setup.cfg
Included in Main
Configuration File
None
Adds VoIP service to a port
VoIPConfig.txt
Called out in
voice_setup.cfg file
None
Defines all VoIP service parameters
135
About SIP and the SIP Configuration File

Retrieval
Calix SIP service is an integrated, multi-service IP network based telephony system designed
for use with the AE system. Calix SIP supports a full range of advanced voice features and
simplifies management of the system.
SIP, by design, bypasses legacy TDM networks and allows customers to begin phasing out
Class 5 switches and moving to an all Ethernet (AE) environment. SIP compliant VoIP
delivers high quality, uninterrupted static-free voice service as TDM along with typical calling
features including caller ID, call waiting, and three-way calling.
The SIP Configuration file details the variables necessary for setting up voice services to the
ONT. A single configuration file is used for multiple ONT ports provided all ports deliver
identical service options.
AE deployments support SIP exclusively to provide voice service from the ONT.
Provisioning of the voice service is done by defining the basic voice service parameters in the
ONT configuration file. The detailed SIP provisioning is done in a separate configuration
file. Required SIP provisioning parameters includes the name of the configuration file, the
SIP file server, and a redundant configuration server if desired.
Calix GX and GE ONTs come equipped as standard to deliver SIP services. All ONTs
provide built-in Integrated Access Device (IAD) functionality to perform call handling and
IP packetization for SIP functions. At the ONT, calls are carried over existing in-home
wiring and phone sets with standard GR-909 interfaces (POTS).
Note: In the current release of Calix 700GE ONTs, only the SIP T0 model is supported.
VoIP from Calix is fully inter-operable with the following switch vendors:
BroadSoft
MetaSwitch
Nortel PGI (DMS10)
Nortel CS2K
Nortel CS1500
Taqua T7000
GenBand M6 (M6 sold to BroadSoft)
CopperCom
Sonus
XCAST (GTT)
136
Unsupported Switches
Calix provides a standard SIP test plan to service providers for testing interoperability with
unsupported switches. This test plan should be run prior to turning up end users. Contact
your Calix sales engineer for additional information.
SIP Configuration File Attributes

SIP Configuration Files share the following basic attributes:
A single Configuration File can be used for multiple AE ONT SIP ports provided all ports
deliver identical service options.
The specific location of the configuration file must be defined and referenced in the
Global ONT SIP Profile.
For customers that have unique SIP service offerings, a separate Configuration File is
required.
The Configuration File can be created using a supplied template provided on the
software CD and then customized for your particular deployment and service offerings.
After all changes have been made to the Configuration File, the file is placed on the
TFTP server which is identified during ONT provisioning.
The default location for the SIP Configuration file is $CMS/ae
Most of the options in the Configuration File are common defaults and should not be
changed but each field should be examined and modified as required.
The ONT SIP port TFTP downloads a Configuration File upon creation, after reset, and
when requested by the system.
For detailed information on the SIP Configuration File, refer to the Calix Application Note:
Using the 700 ONT VoIP Configuration File.
https://portal.calix.com/portal/site/documentation/documentationhome/
Chapter 4
AE Deployment Options
There are three primary deployment scenarios supported by the AE ONT:
Customer premises network containing a residential gateway (RG)

Customer premises network without an RG
Customer premises network managed with an external Router for VLAN mapping with
Quality of Service (QoS)
138
Residential Gateway Characteristics

In deployment scenarios that include a residential gateway in the subscriber network, the RG
provides VLAN mapping and QoS functions. In this configuration, the ONT acts as a pipe
between the WAN and subscriber network. VLAN mapping still occurs between the
subscriber VLANs and the WAN interface VLANs as pictured below:
139
Non-Residential Gateway Characteristics

In deployment scenarios that do not include a residential gateway in the subscriber network,
the ONT provides VLAN mapping and QoS functions. In this configuration, the ONT acts
as the RG on the subscriber network for partitioning traffic, shaping, QoS, VLANs, and the
like.
140
External Router Characteristics

In this deployment scenario, the service provider manages the subscriber traffic via an
external router. In this case, the ONT may provide a single VLAN per port and either tagged
or untagged traffic is passed between the WAN and LAN interfaces.
The diagram below illustrates the case of a single customer VLAN managing multiple
services via an external router. It also shows alternate data service models are supported on
each ONT Ethernet port independently.
141
Metering and Traffic Shaping

Support is provided for the following options:
802.1p QoS traffic shaping

QoS per subscriber data rate shaping
QoS per VLAN Id data rate shaping
An AE ONT supports a specific number of independent traffic shapers. Each GX SFU

ONT traffic shaper consists of 8 upstream and 8 downstream 802.1p queues (in other words,
8 priorities in each direction). Packets are queued to the shaper queues based on the outer
802.1p pbit field of each WAN packet. Packets are removed from the queue from the highest
priority to the lowest in each shaper direction. All 700 AE ONTs support 16 bi-directional
traffic shapers.
Note: 802.1p priority ranges from binary 000 (0) for low priority to binary 111 (7) for high
priority
Each direction of a traffic shaper is programmed to provide a specific rate for the shaper.
Two values are specified to designate the rate:
Committed information rate (CIR). The CIR value is the minimum guaranteed rate the
ONT will limit flows for each direction of the shaper.
Peak information rate (PIR). The PIR is reserved for future use. It allows peak rates up to
this value if bandwidth is unused or available.
Note: PIR must always equal the CIR.
Note: The minimum metered rate is 0 Kbps (disabled), the maximum metered rate is
200000000 (200 Mbps for the 70xGX SFU ONTs and 1GBps for 7xxGE ONTs).
Traffic flows are attached to a traffic shaper based on the classification of the flow. One of
three classification options are chosen for each direction of a traffic shaper. Attachment
mechanisms are as follows:
By subscriber Ethernet device name (eth-0, eth-x)
One or more devices are attached to a given shaper direction.
By the WAN side outer VLAN ID value
One or more VIDs are attached to a given shaper direction.
Note: Only one mechanism at a time is used per shaper direction.

Upstream multicast and broadcast rate limiting support is provided. In addition to the traffic
flows described above, the administrator may optionally attach an additional upstream shaper
to separate outgoing broadcast or multicast traffic and limit those discrete flows from the
subscriber premises unicast upstream traffic. This is a security feature limiting DoS attacks on
an IPTV or HSI network. It also limits the rate of multicast joins entering an IPTV network.
142
Subscriber-VLAN to WAN-VLAN Mapping

Overview
The Layer-2 (L2) mapping functions of the ONT are an important feature for isolating
services or subscribers into separate VLANs on the network provider's side of the network.
This allows the network provider to manage these services and subscribers independently.
The ONT supports mapping to WAN VLANs both with and without a RG:
Upstream mapping of RG VID/Classification to outer WAN VID occurs on the

subscriber side ingress via L2 classification/marking and Layer-3 (L3)
classification/marking tables.
Automatic inverse downstream re-mapping from outer WAN Tag to RG/Subscriber side
occurs on subscriber side egress based on the upstream table entries.
Note: The automatic inverse mapping operations are generally more forgiving in terms
of filtering criteria (important for minimizing issues with configuring upstream routers).
The ONT supports mapping of traffic via the MAC SA to facilitate initial support for
mapping untagged traffic on the subscriber side. An example of this filter/marking
operation would be to identify by OUI the set-top boxes used for IPTV service. All other
untagged traffic is mapped to the HSI VLAN defined for the ONT. Thus, the ONT
supports triple-play service mapping of untagged subscriber traffic without L3 mapping
in the initial release of software.
The L2 mapping operations are used to form the resultant VID for the WAN bridging
(upstream) or the resultant VID for the subscriber network (downstream). This VID
must match the VID used in one of the VLAN Bridges created for the AE ONT. The
TPID (for example, 0x8100) associated with the VIDs are configurable for each network.
Lev1 filtering support for 700GE and 76xGX ONTs is restricted to a 3 OUI or 6 byte
mask (. . . filtmacmask=ff:ff:ff:00:00:00 or ff:ff:ff:ff:ff:ff)
There are two L2 mapping/filtering tables defined that are operated on the subscriber side of
the WAN bridge for each Ethernet port.
143
Level 1: L2 Mapping Filter Table

The Level 1 L2 Mapping/Filtering table is the first table processed on the subscriber
ingress/egress. A separate table with 16 entries exists in the downstream and upstream
direction for each Ethernet port. Entries are added to the table one at a time using data
contained in the ONT configuration file. When an entry is added, the system constructs an
automatic "inverse" operation for the downstream processing if the action requires it.
Important: The terminology used to describe a tag is either "inner" or "outer". The inner tag
filter rules are for single or double tag packets. The outer tag filter rules are only used on
double tagged frames coming from or to a subscriber. With respect to the treatment side, the
inner tag refers to the first tag on a single tag or no tag frames. On a double tag frame, it is
the inner tag, in other words, the second tag. Examples are provided later in this guide
clarifying these conventions.
Example Mapping and Filtering Tables (on page 247) are available for reference.
Level 2: L2 Mapping/Filtering Table

If no match occurs in the Level 1 L2 Mapping/Filtering table the Level 2 L2
Mapping/Filtering table is processed. The Level 2 L2 Mapping/Filtering table is the second
table processed on the subscriber ingress/egress.
double tagged frames coming from or to a subscriber. With respect to the treatment side, the
inner tag refers to the first tag on a single tag or no tag frames. On a double tag frame, it is
the inner tag, in other words, the second tag. Examples are provided later in this guide
clarifying these conventions.
Example Mapping and Filtering Tables (on page 247) are available for reference.
VLAN Tagging Mapping and Conversion for Multicast Streams

The AE ONT performs the associated tag conversion on downstream multicast packets if
the Level 1 and Level 2 Layer-2 Mapping tables are populated with entries. Currently, there is
a limitation in that all tagging must be the same on each Ethernet port if multiple ports are
present on the ONT. That is, if IPTV is tagged on the subscriber side it must be tagged the
same way (same VID) on all Ethernet ports. Similarly, if data is untagged on the subscriber
side it must be untagged on all subscriber ports.
Chapter 5
Automatic ONT Creation - Smart Activate
With Active Ethernet Release 2.2, Calix has developed a family of Remote ONT creation
tools known as Smart Activate. Depending on the ONT being deployed, installers can
activate ONTs in one of two ways:
Web Activate is an enhanced version of the previously available Remote ONT

Activation (RONTA) feature. This new web browser based ONT activation tool
allows the field installer to use a laptop (plugged into the first Ethernet port on the
ONT) to activate the ONT. New features available in this tool include a Static IP
configuration option for AE ONT deployments as well as ONT firmware upgrade
and factory reset options. Web Activate is currently available for use with the 740GE
family of ONTs as well as 700GE-I Indoor ONTs.
Note: Smart Activate will be available on additional 700GE ONT models in the future
however it is not supported on 700GX or 760GX ONTs.
Voice Activate (previously known as RONTA) - The Calix Voice Activate feature
simplifies the installation and turn-up of any Calix ONT. Commands are entered via
buttset at the customer premises, which allows configuration of an ONT in a variety
of environments, without assistance from the central office, or the need for special
equipment. The Voice Activate feature can be used to reset the ONT to its factory
defaults, locally provision service, or assign a registration ID as part of the preprovisioning process. The Voice Activate feature is activated when the ONT is
powered with the drop fiber disconnected. The ONT leaves Voice Activate mode as
soon as an optical signal is detected, leaving the Registration ID on the ONT
disabled once a successful link has occurred. Voice Activate is available for use with
all 7xxGX ONTs and earlier.
146
Setting up your PC for Web Activate

Using Web Activate on your local PC requires that all existing network connections be
temporarily disabled. Once that is accomplished, your local PC must boot to the IP address
of the ONT to be activated.
Prior to turning up an ONT using Web Activate, the following steps must be completed:
1. The ONT must be pre-provisioned within CMS. Refer to Manually Creating an ONT for
complete instructions.
2. A PC with network access is available.
3. An Ethernet cable is available for connecting the ONT Ethernet port to the network PC.
Note: Existing network connections must be temporarily disabled to allow your PC to
boot directly to the ONT to be activated.
Depending on your operating system, refer to the appropriate instructions below for setting
up your PC for Web Activation.
147
Configuring your Local PC for Web Activate - Windows XP

To configure your PC for Web Activate - Windows XP
1. From the Windows shell, navigate to Start > Control Panel > Network Connections >
Local Area Connection
2. Click the Properties button
3. Under, "This connection uses the following items:", highlight Internet Protocol
(TCP/IP) from the list
4. Click the Properties button
5. From the Internet Protocol (TCP/IP) Properties window, do the following:

a. Select the radio button for "Use the following IP address:"
b. Enter IP address 192.168.100.5 and then press the tab key
c. Accept the default subnet mask of 255.255.255.0
148
d. Click OK
6. Connect an Ethernet cable to Ethernet port 1 of the ONT.

7. Connect the other end of the cable to the network switch.
8. Reboot your PC.
9. Apply power to the ONT (or disconnect/reconnect power to an existing ONT) and
allow it to complete it's boot-up sequence.
10. Open a browser on your PC and enter IP Address 192.168.100.100
11. At the Authentication Required screen, enter the login and password:
a. Login: admin
b. password: fiber1ttx
The main Smart Activate screen is displayed.
149
Configuring your Local PC for Web Activate - Windows 7

To configure your PC for Web Activate - Windows 7
1. From the Windows shell, navigate to Start > Control Panel > Network and Internet
2. Select View Network Status & Tasks
3. Under View your active networks, click the link for Local Area Connection.
4. In the Local Area Connection Status window, select Properties.
5. In the Local Area Connection Properties window, highlight Internet Protocol Version 4
(TCP/IPv4) and then click Properties.
6. From the Internet Protocol Version 4 (TCP/IPv4) Properties window, do the following:
a. Select the radio button for "Use the following IP address:"
b. Enter IP address 192.168.100.5 and then press the tab key
c. Accept the default subnet mask of 255.255.255.0
150
d. Click OK.
7. Connect an Ethernet cable to Ethernet port 1 of the ONT.

8. Connect the other end of the cable to the network switch.
9. Apply power to the ONT (or disconnect/reconnect power to an existing ONT) and
allow it to complete its boot-up sequence.
10. Reboot your PC.
Note: If your PC is configured to automatically activate wireless networks at boot-up,
disable any available wireless networks before rebooting.
11. Open a browser on your PC and enter IP Address 192.168.100.100
12. At the Windows Security screen, enter the login and password:
a. Login: admin
b. password: fiber1ttx
The main Smart Activate screen is displayed.

151
Using Web Activate

The Calix ONT Web Activate feature is used to pre-register ONTs as they are deployed in
the field. The application and activation process is similar to the butt-set Voice Activate
feature. During the ONT power-up boot process, the ONT enables the first Ethernet port
and creates an IP host that accepts a static IP address of 192.168.100.100. The field
technician connects the first Ethernet port to a PC and configures the PC Ethernet port to
the static address 192.168.100.1 and the subnet mask 255. 255. 255. 0. The technician opens a
web browser using the address http://192.168.100.100 and is prompted for a username and
password. The technician then enters the factory default credentials ("admin", "fiber1ttx")
and is presented with the following page:
The Web Activate section of the page is shown in the lower panel, where the traditional
Voice Activate (RONTA) and static IP configuration parameters can be entered by the user.
Traditional Voice Activate (RONTA) parameters:
Registration ID (AE and GPON)
Management VLAN (AE)
Static IP Configuration parameters (for AE):
Configuration TFTP server addresses (2)
Configuration filename
CMS IP address
NTP server addresses (2)
NTP time offset and daylight saving flag
Syslog server addresses (2)
Certain parameter entry fields are automatically shown or hidden depending on the selections
made by the user. For example, all static IP configuration entry fields are shown only if the
user has selected "Management IP Address Mode" or "Static".
152
Web Activate - DHCP Discovery
Web Activate - Static IP Discovery
153
Web Activate Field Definitions

The following values can be provisioned/edited from the Smart Activate interface:
Web Activate Provisioning Options
Option
Description
Registration ID
The Registration ID or the 12-digit FSAN serial number for the

AE ONT.
Valid Options
Numeric or Alphanumeric
Note: If the input value for an ONT begins with a number, it is

assumed to be a Registration ID and is validated as a 10 digit
numeric value. If the field begins with a letter (alpha-numeric), it
is assumed to the FSAN serial number and is validated to
consist of the prefix "CXNK" followed by exactly 8 alpha-numeric
characters.
Management VLAN
Active Ethernet ONT Deployments only -
Numeric - 4 digits Default = 85
Management IP Address Mode
ONTs can be activated in either DHCP Discovery Mode or in a

Static Host IP address schedule (assign a specific IP address to
the ONT).
DHCP, Static
The remaining fields below only apply to Static IP Host provisioning

IP Address*
The permanent IP Address of the upstream device (not

dynamically assigned)
dot delimited x.x.x.x

Null
Network Mask*
Static address mask for narrowing list of allowed static IP

addresses.

Null
Gateway*
The static IP Gateway of the upstream device.
Configuration Server IP
Addresses*
A primary and secondary Configuration Server IP Address can

be entered for AE ONT Configuration file look-up.
Configuration File Name
The file name of the ONT Configuration file can be entered for
use by the ONT. This .cfg file provides necessary instructions to
the ONT for all subscriber service functions and provisioning.
The file typically resides at the CMS root directory ($CMS/ae).
alphanumeric
MIC Mandated
MIC (Message Integrity Code) is the last line in the file and is
calculated as a hash algorithm such as MD5 or SHA-1.
The hash is calculated over the entire file including the line
before the hash.
CMS IP Addresses
A primary and secondary CMS server IP address can be

entered for use by the ONT.
NTP Server IP Addresses
A primary and secondary Network Time Protocol (NTP) server

IP address can be entered for use by the ONT.
Note: NTP Server address settings for AE ONTs are mandatory

to ensure proper network timing at the ONT.
NTP Time Offset (seconds)
Syslog Server IP Addresses
A Syslog Server IP address can be entered to specify where

Syslog events are stored.
dot dellimited x.x.x.x
Note: For single Syslog server environments, use the Option-43

declaration (see AE release notes). For dual Syslog server
environments, you must specify both addresses here.
*Denotes Required Field
Note: Any invalid, out-of-range, or missing "required" value returns a Parameter error with a context sensitive message
detailing the error.
154
Turning up an ONT using DHCP Discovery

To remotely activate an ONT via Web Activate, perform the following steps:
1. Make sure power is disconnected at the ONT.
2. Make sure the network fiber (pigtail) is disconnected at the ONT.
3. Reapply power to the ONT and wait approximately 30 seconds for the ONT to complete
its boot-up sequence.
4. Launch the Web Activate application as described in the previous topic based on the
Windows operating system you are using.
5. Enter a Registration ID of your choosing (up to 10 alpha-numeric characters in length),
followed by the # (pound) key.
Note: When using the Web Activation, make sure all Registration ID numbers are
unique.
6. Accept the Default Management VLAN ID of 85 unless you specifically want to change
it.
7. Ensure the DHCP radio button is selected in the Management IP Address Mode field.
8. Click Submit.
If successful, a Completed message is displayed and prompts the user to reattach the optical
fiber at the ONT.
Note: Any invalid, out-of-range, or missing "required" value returns a Parameter error with a
context sensitive message detailing the error. Clicking the Back Button returns you to the
previous page, allowing for error correction.
Once complete, the following operational behavior is expected:
The DHCP Server assigns an IP Address to the ONT, making the ONT available for
service provisioning via CMS.
The Registration ID is persisted in flash memory and is erased only when the ONT is
re-set to factory default.
The Registration ID is included in Option-61 searches during DHCP discover

requests.
If the DHCP server does not respond with a configuration file name, the ONT
requests its configuration file using the following name: "<registrationID>.cfg"
155
With the Registration ID now embedded, pre-provisioning is allowed without knowing the
ONT serial number.
Turning up an ONT using a Static IP Host

In instances where you may not have access to a DHCP server or if DHCP processing is
controlled outside your network domain, assigning a Static IP Host can be used for Web
Activation of the ONT.
To turn up an ONT using the Static IP Host method
1. Make sure power is disconnected at the ONT.
2. Make sure the network fiber (pigtail) is disconnected at the ONT.
3. Reapply power to the ONT and wait approximately 30 seconds for the ONT to complete
its boot-up sequence.
4. Launch the Web Activate application as described in the previous topic based on the
Windows operating system you are using.
156

Note: When using the Web Activation, make sure all Registration ID numbers are
unique.
6. Accept the Default Management VLAN ID of 85 unless you specifically want to change
it.
7. Ensure the Static radio button is selected in the Management IP Address Mode field.
8. Enter an IP Address to assign to the ONT.
9. Enter a subnet MAC Mask to filter the list of allowable IP addresses.
10. Enter the Default network Gateway for the ONT IP address you are assigning.
11. Enter the primary and secondary TFTP server IP addresses for the ONT.
12. Enter the appropriate ONT Configuration filename for the ONT (if known),
Note: If the MIC Mandated checkbox is selected, the Message Integrity Code is
recalculated and updated every time a provisioning change is made (and a new
configuration file is saved to memory.
13. Enter the IP Address of the CMS server.
14. Enter the primary and secondary NTP server addresses for the AE system.
15. Enter any NTP Time Offset values required.
Note: Select the Daylight saving checkbox if you want the system to adjust for Daylight
Savings Time.
16. Enter the primary and secondary SYSLOG server IP Address if used.
17. Click Submit.
The DHCP Server assigns an IP Address to the ONT, making the ONT available for
service provisioning via CMS.
The Registration ID is persisted in flash memory and is erased only when the ONT is
re-set to factory default.

requests.
157
ONT serial number.
To provision the IP Host for a static host configuration, you must do the following:
a. Select static for the Host Protocol parameter.
b. Enter the Static IP address, Mask, and Gateway addresses.
To provision the IP Host for a DHCP host protocol configuration, you must select dhcp
for the Host Protocol parameter. Any previously assigned Static IP, Static IP Mask, and
Static IP Gateway addresses are ignored, yet preserved.
For the Static IP, Static IP Mask, and Static IP Gateway addresses to take effect, you
must also set the Host Protocol parameter to static.
For voice and pseudo-wire services the static IP gateway and subnet mask attribute are
only required when static IP addresses are in use.
The gateway address and subtending IP addresses must belong to the same subnet, as
indicated by the mask.
The static IP address must not be the same as the gateway address.
158
Updating ONT Firmware Using Web Activate

The ONTs firmware can be upgraded through the "Firmware Upgrade" page.
To upgrade ONT firmware

1. From the Main screen, click the Firmware Upgrade link near the center of the page.
2. Click the Browse button under Firmware Upgrade and locate the updated ONT firmware
file (.rto file extension)
3. Select the file and click Submit. The screen displays an "upload in process" message.
4. Once the upload is complete and the new firmware has been validated, the ONT
automatically reboots with the new ONT firmware activated.
5. Once the ONT reboot is complete, selecting the "Click here" link displays the Web
Activate Main screen.
159
Restoring Factory Default Settings

As part of the Smart Activate utility, ONTs can be stored to factory default settings. This
may be useful if an error was made during initial Web Activation, or if an ONT needs to be
switched to the Static IP or the DHCP discovery model, or vice versa.
To reset an ONT to factory default settings
1. From the Main screen, click the Factory Reset link near the center of the page. The
Factory Reset Page is displayed.
2. Check the "Check here to confirm the factory reset" checkbox to open the Reset
confirmation page.
Note: Failing to check the confirmation box produces an error as shown below. Click
the back button to return to the Reset confirmation page.
160
3. Once the reboot is complete, click the "Click this" link to return to the Web Activate
screen.
Voice Activate Overview

The Calix Voice Activate feature simplifies the installation and turn-up of any Calix ONT.
Commands are entered via buttset at the customer premises, which allows the craftsperson
to configure an ONT in a variety of environments, without assistance from the central office
or the need for special equipment.
The Voice Activate feature is used to reset the ONT to its factory defaults, locally provision
service, or assign an AE subscriber ID as part of the pre-provisioning process. The feature is
activated when the ONT is powered with the drop fiber disconnected. The ONT will leave
Voice Activate mode as soon as an optical signal is detected.
The following features are available:
AE ONT Voice Activate Commands
Function
Command
Keystrokes
Master Reset for an AE ONT (on page 162)
***#
Assigning a Registration ID (GPON Mode)
***0
Assigning a Registration ID (AE Mode) (on page

164)
***0
Assigning an AE Management VLAN to an ONT

(on page 165)
***1
Note: Attempts to configure a non-AE capable ONT for Management VLAN, or AE Voice
Activate (Subscriber ID) are ignored by the ONT.
161
Using Voice Activate

Keep in mind the following when working with Voice Activate:
ONT Registration Rules
Follow these rules when using the voice activation feature:
Voice activation can only be used on Calix ONTs

The ONT must have a physical POTS port in order to connect the buttset. The buttset
must be connected to the first POTs port on the ONT.
By default, the ONT is assigned a Management VLAN ID of 85. See Assigning a
Management VLAN to an AE ONT for instructions.
The Registration ID must be unique for each ONT on the network.
The ONT must be powered off when connecting the buttset. Reapplying power initiates
the voice activation sequence.
The fiber pigtail (SC-APC connector) must be disconnected from the ONT when using
this feature. Reconnect the pigtail once voice activation is completed and confirmed.
To turn-up an AE ONT using Voice Activation

1. Disconnect power to the ONT.
2. Disconnect the network fiber (pigtail) from the ONT.
3. Connect an RJ-11 terminated buttset to the first (LINE ONE) voice port on the ONT.
Note: For buttset devices using alligator clips, back-out the Tip and Ring screws and clip
the buttset leads to the T and R posts (black to Tip, red to Ring).Verify that the network
fiber is disconnected from the ONT.
4. Reapply power to the ONT.
5. For 700G or 700GX ONTs, listen to the buttset and wait until you hear a click sound
(approximately 10 seconds for SFU ONTs or 15-20 seconds for MDU ONTs).
6. For 700GE ONTs, wait for the OFF HOOK LED on the ONT to start blinking
(approximately 50 seconds for 2 POTS ONTs, 60 seconds for 4 POTS ONTs).
Note: If digits are entered prior to the ONT being ready (click sound or OFF HOOK
Blink), those digits are ignored.
7. Press "*", "*", "*" ,"0" (star, star, star, zero) keys on the buttset key pad. The buttset
sounds DTMF tones as the keys are pressed.
8. A voice prompt occurs: "Please enter [PON or AE] Registration ID followed by pound".
162
Note: When using the voice activation technique for turn-up, make sure all Registration
ID numbers are unique.
10. The voice prompts: "You entered 'xxxx'. If correct, enter 1, otherwise enter 0".
11. If you pressed 1, the voice prompt responds: "Registration ID saved".
12. If you pressed 0, the system returns to step 6 above.
The Registration ID is persisted in flash memory.
The Registration ID is erased only when the ONT is re-set to factory default via a
buttset.

requests.
ONT serial number.
Note: Reattach the network fiber (pigtail) to the ONT before securing the ONT enclosure.
163
Master Reset
The AE ONT buttset master reset procedure returns the ONT settings to the factory default,
meaning the ONT operates in managed mode using VLAN 85 as the default Management
VLAN and the AE Subscriber ID is deleted.
To reset the ONT to factory default
7. Press "*", "*", "*" and "#" (star, star, star, pound) keys on the buttset key pad. The
buttset sounds DTMF tones as the keys are pressed.
8. A voice prompts to acknowledge your selection of requesting an ONT master reset.
9. After the confirmation prompt, press '1' to confirm the reset. A voice prompt replies,
"ONT Master Reset is completed".
10. Press '0' to abort. A voice prompt replies, "ONT Master Reset is cancelled".
11. Continue entering new RONTA commands as required.
12. Re-connect the network fiber to the ONT and wait for the ONT to come on line.
164
Assigning a Registration ID to an ONT

Buttset provisioning via the Voice Activate feature allows the craftsperson to install any Calix
ONT from inventory at the subscriber site. Conversely, pre-provisioning an ONT serial
number requires a craftsperson to install a specific ONT from inventory at the subscriber
site. After using the management interface to assign a Registration ID and pre-provision
services to the ONT, the Voice Activate feature is used to install and turn-up a Calix ONT at
the subscriber site. Using a buttset, the craftsperson enters the same Registration ID into the
ONT allowing the installation and the service activation to be under the complete control of
the installer at the subscriber site.
Note: The Registration ID must be unique.
The Registration ID is inserted into the DHCP Option-61 field (Client Identifier) by the
ONT and used by the DHCP server to send the ONT the correct configuration file. A
configuration file named with the Registration ID is sent to the ONT.
Important: You must enter the Subscriber ID into the ONT before it is connected to the
fiber and detected on the network.
To turn up an AE ONT using Voice Activate
Note: Ensure you listen to the entire voice prompt prior to pressing any keys on the
buttset.
7. Press "*", "*", "*" ,"0" (star, star, star, zero) keys on the buttset key pad. The buttset
sounds DTMF tones as the keys are pressed.
8. A voice prompt is heard: "Please enter [PON or AE] Registration ID followed by
pound".
165
9. Enter a Registration ID of your choosing (up to 10 alpha numeric characters in length)

Note: When using the RONTA technique for turn-up, make sure all Registration ID
numbers are unique.
10. The voice prompts: "You entered 'xxxx'. If correct, enter 1, otherwise enter 0".
11. If you pressed 1, the voice prompt responds: "Registration ID saved".
12. If you pressed 0, the system returns to step 6 above.
The Registration ID is persisted in flash memory.
The Registration ID is erased only when the ONT is re-set to factory default via a
buttset.

requests.
ONT serial number.
Note: Reattach the network fiber (pigtail) to the ONT before securing the ONT enclosure.
1. Re-attach the network fiber (pigtail) to the ONT.
166
Assigning a Management VLAN to an AE ONT

The ONT, as shipped, is configured with a default VLAN ID of 85. If you need to change
the default VLAN ID, use a buttset device to change the Management VLAN:
Note: The Management VLAN ID value must be between 1 and 4094.
To change the management VLAN
7. Press *, *, * and 1 (star, star, star, 1) on the buttset key pad. The buttset sounds
DTMF tones as the keys are pressed. A voice prompt is heard, "Management VLAN is
'VLAN ID NUMBER'. If correct, enter 1, otherwise enter 0".
8. Skip to step 9 if MVLAN is correct.
9. If 0 was pressed, a voice prompt is heard, "Please enter Management VLAN followed by
#". After entering the new VLAN ID, a voice prompt is heard, "You entered 'VLAN ID
NUMBER'. If correct, enter 1, otherwise enter 0".
10. At the confirmation voice prompt, press 1 if correct. The system responds with
Management VLAN saved.
Note: At this point the newly entered VLAN ID is saved to the ONT flash memory.
11. Continue entering new RONTA commands as required.
167
Changing the Management VLAN

As the ONT completes the boot-up sequence, it configures a management VLAN and
immediately attempts to obtain an IP address from a DHCP server. By default, the ONT
uses VLAN 85.
The VLAN ID on the ONT can be changed in the field during installation using a buttset
device.
Note: Unless there is a definite conflict in your network with VLAN 85, there is no need to
change the management VLAN on the ONT.
2. Verify the network fiber (pigtail) is disconnected from the ONT.
Note: For buttset devices using alligator clips, back-out the tip and ring screws and clip
the buttset leads to the T and R posts (black to Tip, red to Ring).
4. Reconnect power to the ONT.
5. Listen for a click sound coming from the buttset (about 10 seconds after power has been
re-applied).
168
Configuring the Management VLAN

uses VLAN 85.
device.
re-applied).
169
ONT Provisioning Persistence

AE Release 2.0 now includes local provisioning persistence. This feature is applied when the
ONT is provisioned through RONTA, or remotely provisioned via RMI or CMS. During a
loss of power or loss of network connectivity (AE link), the configuration state is retained in
the ONTs flash memory. Upon restoration of power or AE link, the ONT performs a
DHCP discover to obtain an IP address.
Note: The ONTs IP address is not persisted, meaning the DHCP server must be available in
order for the ONT to come back on-line.
The ONT then compares the locally stored configuration with the TFTP server and updates
if necessary.
Determining the ONT recovery method
1. The ONT first attempts to access its ONT specific configuration file (FSAN serial
number or RONTA Id number) from the primary TFTP server.
2. If the file is found it will be used to provision the ONT.
3. If the TFTP server is not available or the file is not provided before the time-out cutoff is
reached, the secondary TFTP server is accessed and the process is repeated.
4. If the secondary TFTP server is not available or the configuration file is not provided
before the time-out cutoff, the ONT uses its cached configuration file to bring it into
service.
5. If the first attempt to connect to the ONT's configuration file on the returns "cannot be
found" (servers are considered to be in sync so there is no need to try both servers if the
specific ONT file is not on the primary server), the ONT attempts to retrieve a generic
configuration file ("Calix-ONT.cfg").
6. If the ONT experiences a time-out condition on the TFTP server, it continues to try the
same TFTP server until it succeeds, receives an error or timeout cutoff is reached.
7. After a minute the ONT re-initiates the process with the primary TFTP server.
As additional background information, the following characteristics apply to local
provisioning persistence:
If the ONT fails to retrieve its specific TFTP configuration file, it uses the last-known
good configuration file (cached locally by the ONT). The ONT will make five attempts
to retrieve its specific configuration file at each TFTP server. This results in a two-minute
per-server delay before using the cached file.
The ONT removes its saved configuration if it is forced to factory defaults through the
RONTA process.
170
In the case where there is no locally cached configuration, or the TFTP server IP address
has changed, the ONT uses a 5 minute re-attempt timer after it reaches the cutoff
timeout value for the second TFTP server .
The ONT generates a SYSLOG and SNMP trap when it uses the cached configuration
file.
The ONT generates a SYSLOG and SNMP trap when it uses the generic configuration
file.
The CMS supports provisioning persistence for voice, data, video and T1 services after initial
Configuration File download and set-up. It also supports provisioning persistence for SIP
Configuration Files after initial SIP Configuration File download.
Local Provisioning Persistence

With AE release 2.0, local provisioning of ONTs is persisted in the system to allow for
immediate retrieval of stored information in the event of a power failure or loss of signal.
During a loss of power or loss of AE link, the configuration state is retained in the ONT's
flash memory. Upon restoration of power or AE link the ONT first performs a DHCP
discover to obtain its IP address.
Note: The ONTs IP address is not persisted and a DHCP server needs to be available on the
network.
Assuming the ONT has obtained its IP address, the ONT then compares the locally stored
configuration with the TFTP server and updates if necessary.
The configuration recovery steps the ONT uses to determine the proper provisioning
recovery state after loss of power or link is as follows:
The ONT first attempts to access its ONT specific configuration file (FSAN serial number
or RONTA ID number) from the primary TFTP server. If the file is found it will be used to
provision the ONT; however if the TFTP server is not available or the file is not provided
before the time-out cutoff is reached, the secondary TFTP server is accessed and the process
is repeated. If the secondary TFTP server is not available or the configuration file is not
provided before the time-out cutoff, the ONT uses its cached configuration file to bring it
back into service.
If during the first attempt the TFTP server reports to the ONT that the ONTs specific
configuration file "cannot be found" (servers are considered to be in sync so there is no need
to try both servers if the specific ONT file is not on the primary server), the ONT attempts
to retrieve a generic configuration file ("Calix-ONT.cfg"). If the ONT experiences a time-out
condition on the TFTP server, it continues to try the same TFTP server until it succeeds,
receives an error or timeout cutoff is reached. After a minute the ONT will re-initiate the
process with the primary TFTP server.
171
Notes on Local Provisioning Persistence
For ONT configuration files, the system attempts to determine the ONTs
configuration every 10 seconds (by pinging the TFTP server), and repeats this
process at 10, 20, and 30 second intervals until a response is received. If no response
is received, this process is repeated 5 times, alternating between the primary and
secondary TFTP server.
If the ONT fails to retrieve its specific TFTP configuration file, it uses the lastknown good configuration file (cached locally by the ONT). The ONT will make five
attempts to retrieve its specific configuration file at each TFTP server. This results in
a two-minute per-server delay before using the cached file.
The ONT removes its saved configuration if it is forced to factory defaults through
the RONTA process
In the case where there is no locally cached configuration, or the TFTP server IP
address has changed, the ONT uses a 5 minute re-attempt timer after it reaches the
cutoff timeout value for the second TFTP server
The ONT generates a SYSLOG and SNMP trap when it uses the cached
configuration file
The ONT generates a SYSLOG and SNMP trap when it uses the generic
configuration file
For VoIP configuration files, the system attempts to determine the ONTs VoIP
configuration every 10 seconds however the process is repeated indefinitely until the
configuration is acquired. Retry intervals occur at 14, 18, 22, 26, 30, and every 30
seconds thereafter Assuming both primary and secondary TFTP servers are present,
the ONT alternates between the two after each retry cycle.
ONT Inventory Management (Option-43)

From an ONT inventory perspective, Calix has implemented several options for managing
ONT inventory remotely.
Calix ONTs currently populate DHCP Option-60 (model number) and Option-61 (FSAN
serial number and RONTA ID [if known]). Including this information in the DHCP options
is beneficial to companies that use their DHCP server to analyze their ONT inventory.
DHCP Option-43 is commonly used to carry detailed inventory information about a device.
Calix ONTs have integrated host components such as VoIP and PWE3, both of which
require an IP address. Correlating these ONT integrated components to the ONT through
the DHCP server makes troubleshooting easier for the service provider. To accomplish this,
Calix defines a different DHCP Option-43 for the IADs and identifies the ONT MAC
address as part of this structure. The advantage of this approach is that it enables the use of
relay treatment upstream of the ONT.
172
The use of Option-43 can also be used for firmware upgrades during the ONT ranging
sequence. To enable this feature the operator must populate the DHCP server with Option43 entries listing Calix ONT firmware image filenames. During ONT boot-up, the DHCP
client on the ONT will request Option-43 structure. If DHCP Option-43 structure is
available, the ONT will pull the image header for each Option-43 firmware entry until it finds
the right ONT type match. Once the ONT finds an image with the right type match but with
a version mismatch, it proceeds to pull the entire firmware image file and upgrade itself. If
the version of the matching image is equal or lower to the ONT running version, the ONT
will continue to the configuration process by pulling down the assigned configuration file.
Note: The default Option-43 setting is <Upgrade Only> however this feature can be
disabled.
During configuration file processing the ONT reacts differently to the firmware upgrade CLI
command depending on the prior processed DHCP Option-43. If a DHCP Option-43
firmware entry is dictating the ONT firmware version (entry with matching firmware type),
the ONT will simply ignore the firmware upgrade CLI command.
Note: DHCP Option-43 firmware upgrade takes precedence over the CLI command.
If no DHCP Option-43 firmware entry with matching firmware type, the ONT will execute
the firmware matching/upgrade as instructed by the CLI command.
For details see the Option-43 section in the AE R 2.0 release notes or DHCP Option-43
Configuration Process (on page 276) in the Command Reference section of this guide.
Remote Management Interface Script

The Remote Management Interface Script is provided to address basic system management
tasks. This script runs on Linux and Solaris platforms and provides the following basic
capabilities:
List all ONTs active on the service providers management network

Reset one or all of the active ONTs
Display a summary status of one or all active ONTs
Display all active alarms on one or all active ONTs
Display diagnostic information, error messages, or post-mortem crash information from
the ONT(s)
This script reads the Internet Systems Consortium (ISC) DHCP Server lease database for the
current inventory of ONTs on the network.
Note: In order for the script to be executed properly, the workstation must have access to
the Management VLAN.
The name of the ISC DHCP servers database file is provided on the command line.
173
Note: The script has been written to work with the open ISC DHCP server log format.
However, it can be modified to work with any other DHCP server log file format.
The management script MUST be run on the DHCP platform. The syntax for the script is
shown below:
Usage
calix_ae_ont [-a|-s serial_num|-i regex|-p ip] [-l|-r|-m|-d|-x
command]
ONT selection methods
-a
select all Calix ONTs
-s
select single Calix ONT given a serial number
-b
select ONTs based on regular expression matching on ONT
Labels
-p
select single Calix ONT given the management interface IP
address
Operations
-l
display info summary (ONT type, firmware version, etc)
-r
reboot ONTs
-m
list currently active alarms
-g
dump recent log events
-d
display service diagnostic info
-u
display post-mortem crash info
-x
execute CLI command
In the following examples, one ONT is currently active on the network, and another ONT
was previously on the network but is no longer active.
174
Retrieving Current Alarms

The following command requests that all outstanding alarms from all active ONTs be
reported.
DHCP_desktop./calix_ae_ont -a -m
Serial Num
Assigned IP
FW Ver
ONT Label
-------------
--------------
--------
----------
CXNK000004E5
177.0.0.58
6.0.Z.101
16306 36th Ave N
CXNK11900002
177.0.0.59
<NOT CURRENTLY ACTIVE>
The following ONTs are selected:

CXNK000004E5
Dispatching command to ONT
config alarms
CXNK000004E5
at
177.0.0.58
...
All currently ACTIVE alarms:

[ 58] UPS Missing
CXNK000004E5
Done
In this example, all ONTs (-a) on the system were scanned and filtered for ONTs with
outstanding (active) alarms (-m).
175
Resetting an ONT by Serial Number

The following command resets a single ONT identified by its serial number.
DHCP_desktop
./calix_ae_ont
Serial Num
CXNK000004E5
* CXNK11900002
-s CXNK000004E5 -r
Assigned IP
FW Ver
177.0.0.58
6.0.z.101
177.0.0.59
ONT Label
16306 36th Ave N
<NOT CURRENTLY ACTIVE>
Upon executing the script, the following ONTs are selected:

CXNK000004E5
Resetting ONT CXNK000004E5
Done
at
177.0.0.58
...
In the example above, a single ONT (-s) was specified in the script and was ordered to
reboot (-r).
176
Chapter 6
Turning Up an AE ONT via CLI using
Custom Configuration Files
AE ONTs can be managed through a Command Line Interface (CLI). All functions of AE
ONTs can be added or modified via CLI.
Topics Covered
This chapter covers the following tasks:
About the Command Line Interface

Network Pre-Requisites and Considerations
Configuring the Management VLAN
The ONT Boot Process
Monitoring the ONTs Status via CLI
Creating an SNMP Trap Receiver for Capturing Alarms and Events
AE ONT Network Bridging Options
The Remote Management Interface (RMI) Script
Creating a Layer-2 Pipe for HPNA Maintenance and Monitoring
178
About the Command Line Interface (CLI)

Diagnostic and debugging commands are input into the system using the Command Line
Interface (CLI) that is included with the Linux, Solaris, and Windows operating systems. The
configuration shell is accessible via the Management VLAN path. This shell is automatically
invoked when a user telnets to the 23 port of any AE ONT. When the user exits the CLI via
the "exit" command, the telnet session ends.
Note: Once a telnet session is launched, the session remains active indefinitely (no inactivity
time-out). The telnet session will disconnect when the telnet window is closed.
The ONT CLI is accessed by telneting directly to the ONT command shell across the point
to point fiber WAN interface.
Note: Accessing a specific ONT is only supported across the secure management VLAN
(default VLAN 85).
When accessing the CLI, all commands must be entered manually and one at a time. In
addition, any provisioning done using the CLI is not persisted (stored in memory) meaning
the ONT loses all provisioning if it resets.
Important: Because commands must be entered sequentially (one at a time), Calix
recommends that the CLI interface be avoided as a primary provisioning interface. The use
of configuration files allows you to fully configure an ONT with only a few keystrokes.
This document describes both commands to configure subscriber services and display
managed entities within the AE ONT. The scope of the CLI commands described here is
limited to what is required by Network Service Providers (NSP) of the CLI for AE ONT
applications. The CLI provides features which are relevant to network system engineers and
customer service personnel for AE ONTs as well as GPON/BPON ONTs. Although the
scope of this document focuses strictly on the AE ONT, commands do appear in the list that
may be specific to GPON/BPON deployments exclusively.
Note: CLI commands not discussed in this document must be avoided to prevent potential
service interruptions at the ONT.
Information on building configuration files is discussed in a following chapter.
179
Telnet Interface
The CLI interface is accessed through any Telnet program using special port 22 through the
WAN fiber interface. Login is required for Telnet CLI access.
Login: admin
password: fiber1ttx
Note: Both login and password are case sensitive.
Command Line Help

The CLI provides a help facility to aid in understanding or formatting CLI input. The user
may enter a "?" at any point in the command sequence to understand a particular command,
similar to a wild card selection. For example, if the user enters the "?" at the highest level of
the CLI, a list of base-level shell commands pertaining to the Calix AE network is displayed:
CXNK03010101>?
add
...
bridge
...
delete
...
disable
Disable maintenance mode
enable
Enable maintenance mode
help
Display shell help
history
Display command history.
hpna
ONT HPNA support shell
iphost
...
lev1l2tag ...
lev2l2tag lll
log
Logger filter controls
meter
...
mpp
...
multi
...
ntp
...
omci
...
opt82
...
ping
ICMP Ping
pingstop
Stop the previously started ping re
set
...
show
...
snmp
SNMP Agent shell commands
tp
ONT Transport Commands
trm
ONT Transport Manager Commands
voip
...
The "" notation indicates that there are additional parameters following a command
(which may or may not be optional).
180
Context Sensitive Help

To determine the definition of additional parameters of a specific command, the "help" may
be invoked as in the following example:
CXNK03010101>add ?
voip
add voip driver service board
To understand additional parameters associated with the command the help may be
additionally invoked such as:
CXNK03010101>add voip driver service board ?
Command Recognition
Note that, in the previous example, the entire command "ipconfigtable" did not have to be
entered. The CLI only requires that the token be "un-ambiguous" to resolve it. For
example, if the user enters the following, the system returns:
CXNK03010101> add ip
add ip
Ambiguous command
Thus, the output of the "add ipconf ?" would be as follows:

add ipconf ?
Usage: add ipconfigtable [-crossconnectid=<n>] <ifindex=<ifname>
<address=<ipaddr> <netmask=<ipmask>
Add ipConfig group ipConfigTable row
Options:
-crossconnectid <n>
Parameters:
ifindex=<ifname>
address=<ipaddr>
netmask=<ipmask>
...
type: Integer
...
type: Interface Name
...
type: IP Address
...
type: IP Mask (0,32)
Note: Parameters enclosed in [ .. ] are optional.
181
Command Line Conventions

When using the CLI interface, the following conventions apply:
Integer parameters may be entered in decimal or hexadecimal. A hexadecimal value must

be preceded by 0x. Values without a preceding 0x are assumed to be decimal.
Interface names are always designated by a prefix-XX where XX is a zero relative
instance value. For example, eth-0 is the first subscriber Ethernet interface, eth-1 is the
second subscriber interface, and so on. See "iftab" in section Show iftab for a complete
list of devices.
IP addresses and IP Masks are always designated in IP dot notation (for example,
192.168.100.1)
MAC addresses are designated by the dash notation, e.g., 00-01-02-03-05-03.
182
Some commands list explicit literal values for parameter types. For example, the "fw"
parameter requires the type: enable, disable in a bridge add command.
CXNK0002ACDE> bridge add ?
vlan bridge add
Usage
bridge add [-lb=<enum>] [-mf=<enum>] [-fw=<enum>] [-snoop=<enum>] [-sv=<enum>] [-macff=<enum>] vid=
Add a Subscriber Port VLAN Bridge
Options
-lb=<enum>
learning bridge - enable/disable. Default = disable
type: enable, disable

-mf=<enum>
Enable/Disable multicast filtering in the UPSTREAM direction,
default = disable

-fw=<enum>
subscriber2subscriber forwarding - enable/disable, default =disable

-snoop=<enum>
Turn on IGMP snooping, default = disable

-sv=<enum>
Station validation - enable/disable DHCP station validation, default = disable

-macff
Enable/Disable MAC forced forwarding support, default = disable
Parameters
vid=
WAN side VLAN Id for this VLAN (0 - 4094), 0 == untagged

type: Unsigned
183
An example bridge creation command is as follows:

CXNK03010101>bridge add -fw=enable vid=100
Optional Parameters
Optional parameters are denoted by an "-xxx=<xval>" notation. For example:
meter attach downstream
Usage
meter attach downstream [-dev=<fname>] [-vid=] [-portid=] shaper=
Attach downstream shaper to flow
Options
-dev=<fname>
eth device name flow (eth-0 - eth-n)

-vid=
WAN VLAN ID value flow (0 - 4094)

type: Unsigned
-portid=
WAN GEM PortId value flow (0-4094)

type: Unsigned
Parameters
shaper=
Downstream shaper number (0-31)

type: Unsigned
Note: The parameters -vid, -dev, and -portid are all optional.
Multiple Repeating Parameters
Some commands require multiple repeating parameters at the end of the command. For
example in the previous section, the <pmap> parameter is a list of subscriber interface
names at the end of the command, as in pmap=eth=0 pmap=eth-1. A repeating parameter at
the end must always be denoted by the "<>" notation.
184
Network Pre-requisites
As part of any AE network set-up, it is assumed that the following components and software
have already been installed and are connected to the network:
A DHCP server running Linux or Solaris

A primary and secondary TFTP server for managing AE Configuration files
Note: TFTP server set-up is managed via CMS. For additional information, refer to
Configuring Primary and Secondary TFTP Servers
A TFTP server for managing VoIP Configuration files (which resides on a separate
VLAN).
An NTP server for providing network timing services
A Syslog server for capturing SNMP trap information and various ONT logging features
A SIP server for handling VoIP set-up and options
Additional Considerations
With configuration files defined, the following information must be available prior to
bringing up a Calix ONT in AE mode.
Management VLAN ID that the ONT will use to communicate with DHCP, TFTP,
NTP, and Syslog servers (default VLAN ID = 85)
Note: To change the Management VLAN, ref to Changing the Management VLAN (on
page 167) in the System Maintenance and Troubleshooting section of this guide.
IP address on Management VLAN for NTP and Syslog server

VLAN IDs for other services such as high speed data, IPTV, and VoIP
Prior to turning up the ONT, keep the following information in mind:
Ensure a DHCP server is configured to respond to DHCP discovery requests on the

ONTs management VLAN.
Make sure the TFTP server is configured to respond to requests on the management
VLAN and has the ONT configuration file(s) in its search directory.
Make sure that DHCP servers and relays are properly configured on each of the service
VLANs (HSI, IPTV, and VoIP). These may be shared or separate DHCP servers
depending on the network providers configuration.
185
About the ONT Firmware Image

A required component of the ONT configuration file is the specification for the name and
optionally the location of the ONT runtime image. On a new deployment, the ONT
automatically downloads this file and then resets to start executing the image. On any other
power cycle or reset by the ONT, the ONT validates the image that it is currently running
against the image that is specified in the configuration file. This ensures that the ONT is
always running the correct version of software.
In the event that a new AE ONT runtime image is released, a new image must be specified in
the ONT configuration file. For convenience, this can be specified in one configuration file
and all ONT configuration files refer to that file for the name and location of the latest
runtime image.
The AE ONT maintains the concept of a committed and uncommitted runtime image.
When the ONT downloads a new image, the image is copied into an unused region of flash
memory. If the ONT is able to switch to the new image and obtain its IP address from the
DHCP server, then the image is committed and is executed whenever the ONT resets
(reboots). If the ONT fails to establish communication with a DHCP server, it resets and
reverts back to the previously committed image.
This process protects the ONT from downloading an improper image (service affecting issue
requiring a truck roll. In addition, the runtime image is validated with a Cyclic Redundancy
Check (CRC) before it is written to flash. This further validates that the image has not been
corrupted on the RMI station or during the image transfer.
186
ONT Boot Process

The Calix AE ONT boot process is accomplished in three phases:
1. Establish Link to Switch
2. Obtain an IP Address
3. Provision the AE ONT
The AE ONT must complete all phases successfully before reaching the operational state
providing services to the subscriber. If an unrecoverable error occurs at any point after the
second phase of the boot up process (see below), the ONT reports the error to the Syslog
server and then reboots. Prior to the completion of the second phase, the ONT is not
connected to the Syslog server and only takes recovery actions such as a looping reboot
sequence.
Establishing a Link to the Switch

The ONT establishes a link with the switch. If this is the first time the ONT has been turned
up on this network, the ONT goes through the autosensing sequence in order to determine
the correct transport protocol for the headend device (GPON or AE). Once it determines
that it is an AE device, subsequent resets default to AE mode which results in a much faster
link and boot time.
Once the link has been established, the ONT creates its control/management VLAN on the
WAN interface. Unless changed by buttset provisioning, the default VLAN ID (VID) is 85.
It is assumed that this VLAN is private and secured by the Network Service Provider (NSP)
to prevent un-authorized access to ONT management.
Note: The ONT does not allow any subscriber network traffic on the management VLAN.
187
Obtaining an IP Address
The ONT initiates a DHCP Discover on the management network. If the ONT obtains an
IP address from a DHCP server, it proceeds to Phase 3. If the ONT fails to receive an IP
address or gets rejected by the DHCP server, it reboots and restarts Phase 1 again
(establishing a link to the switch).
Provisioning the AE ONT

The ONT initiates a TFTP GET command for the proper ONT configuration file. While
obtaining an IP address during phase 2:
If the ONT does not receive the file name from the DHCP server, the ONT uses the
registration ID (for example, 3453453459.cfg)
If the registration ID is not set, the serial number is used. (for example,
CXNK11900011.cfg)
It also assumes that the TFTP server is running on the same computer as the DHCP server
host. Alternatively, if the DHCP server included the information in the DHCP Response
message, the ONT uses the TFTP server address and configuration file name provided by
the DHCP server.
The AE ONT downloads its configuration file and processes the commands one at a time in
the CLI. Failures in the provisioning process result in the ONT generating an error message
to the Syslog server with as much description as possible. Once the syslog error is sent, the
ONT attempts to reboot. If the ONT successfully processes all commands without errors, it
sends a message to the Syslog server declaring the completion of the ONT configuration and
provisioning and switches to operational state.
About Auto-Detect Behavior on the ONT

When an auto-detect 700GX ONT ships from the factory, or the ONT is switched from one
OLT type to another (GPON versus AE), it does not contain a "runtime image". This
software image exists to provide subscriber services based on the headend type that it is
attached to. The runtime image must be downloaded from the headend that the ONT finds
itself attached to when it is first powered up.
In the AE ONT case, phase 3 is slightly different in that the ONT is instructed to download
the configuration file in order to obtain the file name and address of the proper runtime
image. The ONT then downloads the runtime image, verifies the image, stores it into flash
memory, and then resets. The process starts over again by attempting to establish a link to
the switch.
188
Creating SNMP Trap Receivers

The AE ONT allows SNMP-based element management systems to become aware of ONTs
using registration traps. These traps are sent to all receivers specified in the ONTs
configuration file. The registration notification trap is disabled in the ONT configuration file
by setting the notification frequency to zero (0):
config trap sink freq=0
Important: If the customer is not running the Calix CMS, it is recommended that this
capability be disabled.
Note: The AE ONT supports the SNMP SET command for resetting the ONT.
Bridging
Bridges are used on the AE ONT to transfer data between the AE WAN port (fiber
interface), the subscriber Ethernet ports, the AE ONT control processor, and the SIP ports.
Each ONT bridge is always associated with a single VLAN and associates this VLAN with a
VLAN ID on the WAN side of the AE ONT.
Note: More than one bridge can be configured on each Ethernet port if the subscriber port
trunks multiple VLANs or if the ONT is mapping untagged traffic to multiple WAN
VLANs.
The ONT supports data flow mapping from subscribers to the various VLANs defined on
the WAN trunk. The Ethernet subscriber side (customer premises) of the ONT may define a
different set of VLANs or untagged traffic which is then mapped to the carrier side VLANs
via classification mechanisms. The AE ONT supports both Layer-2 and Layer-3 mapping
(classification) functions to map subscriber traffic on VLANs to the various WAN VLANs
defined by an ONT WAN bridge. See the section Subscriber VLAN to WAN VLAN Mapping
(on page 142) for a description of these functions.
The ONT supports creation of several different bridge types:
VLAN per Port Bridge

VLAN per Service Bridge
IGMP Snoop VLAN per Service Bridge
IP Host Bridge
189
VLAN per Port Bridge

The VLAN per port (1:1 VLAN implementation) model is used when each subscriber port
on the ONT is associated with a separate, single WAN VLAN. The ONT does not perform
a "learning bridge" function when operating in this mode. Instead, it maps and forwards data
between the WAN port and a single subscriber port.
Note: Provisioning is provided in that the bridge is configured to "learn" MAC addresses on
each side for debugging purposes.
VLAN per Service Bridge

The VLAN per Service (N:1 VLAN implementation) model is used when more than one
Ethernet port is associated with a single WAN side VLAN. The scope of this VLAN may be
either within the ONT or spread across multiple subscribers (ONTs). An example of this
usage within the ONT might be IPTV services where the ONT must multicast a single
downstream channel to more than one Ethernet port. Another example of this may be a
Transparent LAN Service (TLS) in a multi-dwelling unit where the ONT may hair-pin
between two separate subscriber ports which are member of the same carrier VLAN. In nonTLS VLANs, this type of configuration simplifies subscriber provisioning but requires
security features such as "MAC Forced Forwarding" in the ONT (or above it), preventing
subscribers from directly communicating via Layer-2 in the VLAN. Other security features
associated with non-TLS N:1 VLANs, include:
IP SCR Verify
DHCP Lease Limiting
Upstream Multicast Filtering
Multicast/Broadcast Rate Limiting
The first and last case described above does not allow hair-pinning between the subscriber
ports. Each VLAN per-service bridge in the ONT may optionally be configured to support
learning or hair-pinning between subscriber ports. In the default mode, the VLAN perservice bridge never forwards data directly between subscriber ports. If a packet is received
upstream from a subscriber with a MAC destination that is routed out another subscriber
port, the packet is dropped unless the "hair-pin" option is enabled.
Note: The AE ONT always performs a learning bridge function on VLAN per-service
bridge types.
190
IGMP Snoop VLAN per Service

The AE ONT enables IGMP V2 snooping on the Ethernet ports in this bridge type. This
capability insures that only multicast channels joined by a particular STB appear on the
subscriber network. Channels not joined are dropped at the WAN port of the ONT.
When a VLAN-per-service bridge is created with this option the ONT transfers data on the
subscriber network as Layer-2 multicast or unicast traffic. Unmanaged Layer-2 switches
propagate multicast traffic to all ports on the subscriber's network (by default, the ONT
sends multicast as Layer-2 multicast packets). The ONT supports the sending of multicast as
Layer-2 unicast packets, replicating the unicast traffic to only those STBs that have joined a
particular channel on the subscriber's network.
The "-snoop=enable" option on "VLAN Bridge Add" enables IGMP V2 snooping on the
Ethernet ports in this bridge. This capability insures that only multicast channels which are
joined by a particular STB appear on the subscriber network. Channels not joined are
dropped at the WAN port of the ONT.
The ONT snoops upstream traffic but does not act as an IGMP query agent. The query
functionality is required by the AE ONT and MUST be done by an upstream switch or
router. If a query agent is not present, the ONT channel timeout features triggers at 180
seconds.
When a VLAN-per-service bridge is created with this option, the ONT transfers data on the
subscriber network as Layer-2 multicast or unicast traffic. Unmanaged Layer-2 switches
propagate multicast traffic to all ports on the subscriber's network. By default, the ONT
sends multicast traffic as Layer-2 multicast packets. The ONT supports the capability to
send multicast as Layer-2 unicast packets, replicating the unicast traffic only to those STBs
which have joined a particular channel on the subscriber's network. There are two CLIs
available to manage the Ethernet port modes. All Ethernet ports on the ONT must be set to
the desired mode.
Bridges configured with the -snoop option pass off multicast data transfers such that they are
not subject to the ONT shapers as discussed in section Metering Commands/Overview (on page
263).
191
IP Host
IP Host ports on the ONT are pseudo-devices allowing bridge port paths for IP Host
termination at the ONT. These types of bridges are used to define data paths for SIP and
future services such as T1 over Ethernet (PWE-3). In this configuration, each IP Host
interface is configured with a unique IP address, subnet mask, and gateway address (or the
host obtains its DHCP client protocol).
Note: Each IP Host must have a dedicated MAC address.
The ONT creates a default IP Host bridge (iph-0) on the Management VLAN that is used
for the ONT control path and also may be used to attach SIP ports. Additional IP Host
bridges are also provisioned if needed to isolate VoIP data or other services. Typically, a
single bridge is used for all SIP ports if all of the POTs ports are serviced by the same SIP
provider.
The creation of the Layer-3 attributes of an IP host is accomplished via provisioning options
in the ONT configuration file. In order to terminate a path between the WAN interface and
an IP host, a bridge must be created with one or more associated IP Host ports.
MAC Forced Forwarding (MACFF)

MACFF is a network security feature that prevents subscribers on the same VLAN (VLAN
per service) from directly communicating with each other via a layer 2 access pipe. With
MACFF, all subscriber communication is forced upstream to an access router (at the layer 2
level) where a layer 3 or higher decision is made at the router as to whether to route a given
packet between subscribers or to the network. MACFF prevents all layer 2 communication
which might occur directly between subscribers in a shared VLAN per service model. In
addition, MACFF only allows IP protocol packets to traverse towards the network (access
router) on a provisioned VLAN.
Using the CLI, MACFF commands are added to the Master ONT configuration file as
needed. Prior to provisioning MACFF, A VLAN Bridge must be created with the
appropriate commands entered into the ONT configuration file.
Note: Clicking the links below redirects you to the appropriate command with complete
descriptions and options.
Show MAC Bridging information details (on page 338): bridge show bridge [-bid=] .Use this
command to view detailed information on all bridges (or a single bridge using the "bid=x" option).
VLAN Bridge Add (on page 237): bridge add [-lb=<enum>] [-mf=<enum>] [-fw=<enum>] [snoop=<enum>] [-sv=<enum>] [-macff=<enum>] vid=. Use this command to create a
new VLAN bridge.
192
MACFF is physically enabled by setting the '"-macff" option to enabled in the bridge add
command. (Default is disabled). This automatically enables MACFF support for all
subscriber stations which acquire addresses via DHCP.
MACFF is constrained by the following:
MAC Forced Forwarding Limits
Maximum # of bridges/vlans with MACFF enabled (per ONT)
64
Maximum # of access routers per VLAN
Maximum # of MACFF stations per ONT
128
Maximum # of MACFF static entries
/16
Large networks may have difficulty restricting access from host to host. When Layer-2
switches are used, this becomes even more difficult:
Broadcast traffic is sent to all ports on a VLAN

If the Layer-2 destination cannot be found, traffic is flooded across the network
Communications within a single host are always permitted within the same VLAN
Layer-2 switches cannot determine who is, or is not allowed access to the stream.
Using MACFF in conjunction with DHCP snooping eliminates these common network
security risks and gives you full control of traffic on your network.
With AE 2.0, DHCP snooping is used to maintain a database of hosts that may use each
switch port. When a host attempts to access the network, DHCP snooping checks the hosts
IP address against the database to ensure the host is valid. MACFF then uses DHCP
snooping to check whether the host is an Access Router (AR). If an AR is found, MACFF
applies a proxy ARP to reply to any ARP requests, sending the AR's MAC address. This
forces the host to send all traffic to the AR. The AR receives the traffic and makes
forwarding decisions based on forwarding rules set down in advance.
193
Notes
MACFF is implemented by an ARP proxy function that prohibits MAC address

resolution between hosts located within the same subnet and originating at different
customer premise locations.
MACFF is enabled on a per VLAN basis.
Manually configured access routers take precedence over dynamically learned

locations.
For security purposes, the ONT includes a built-in timing mechanism that ensures
that static host MAC addresses do not change too often. Because the ONT itself
does not ARP for a static MAC, downstream devices may flood the network
continuously ARP'ing for a gateway address. To minimize excessive ARPing from
the downstream device, upstream learning bridges (static host MAC addresses) may
only be updated at 5 minute intervals.
Creating a Layer-2 Pipe for HPNA Maintenance

and Monitoring
For downloading new firmware and for performance monitoring of HPNA devices, you
must create a Layer-2 pipe from the ONT to the subscribers network. With this pipe, third
party HPNA vendor tools (such as Coppergate or ReadyLinks) allows downloads of new
firmware or reading of HPNA statistics on HPNA devices connected to the subscribers
network (referred to as "in network" upgrades).
These upgrades are accomplished using a layer 2 pipe from a control computer (on the
providers network) to the ONT(s) equipped with a HPNA option card.
Note: The control computer may also run HPNA network diagnostic tests across the Layer2 pipe.
The download/diagnostic utility is provided by the manufacturer of the HPNA interface
device.
Configuring the AE ONT for HPNA Deployment

The following configuration specifies the setup required to test that the third party HPNA
utility functions when the HPNA device and the Windows based PC are located on the same
AE VLAN network.
Note: External clients must be attached to the ONT HPNA option card for this
configuration to function properly. If zero clients are recognized, the link operation state
switches to DOWN with no packets being passed across the interface. In this case, a shell
command must be executed to override the operational state such that the HPNA utility
communicates with the HPNA expansion card.
194
The Layer-2 pipe needed for the support of HPNA upgrade and diagnostic utilities through
the AE ONT is achieved using TLS services on the AE ONT. This TLS Layer-2 pipe and its
associated VLAN ID must NOT be used to provide end user services.
For the sample configuration below, the VLAN ID of 4002 is dedicated to the TLS VLAN
used for constructing the Layer-2 pipe.
Important: The example shown is NOT a complete AE ONT configuration. In order for
this Layer-2 pipe to function properly, the filtering rules used to set up the Layer-2 pipe must
not be superseded by other filtering rules, and as such, may also conflict with normal end
user services.
To configure the AE ONT for HPNA
1. A VLAN per service bridge must be created to transport the TLS service for the Layer-2
pipe matching the Layer-2 pipes VLAN ID (for example, 4002). In this deployment, the
wan-0 instance of the Layer-2 pipe is tagged with the Layer-2 VLAN ID.
Note: The HPNA port must always be the second Ethernet port (eth-1 given that
eth-0 is the actual Ethernet port).
2. A filtering rule must be created to map all tagged traffic and packets to the Layer-2 pipes
VLAN ID.
3. A filtering rule must be created to map all untagged traffic/packets to the Layer-2 pipes
VLAN ID.
A sample configuration of an AE ONT bridge with appropriate filtering rules:
#create a TLS VLAN per service for all traffic on eth-1
#map all tagged traffic to common TLS vlan on eth-1
lev2l2tag add -filtinpri=8 -filtintpidde=5 -treatoutpri=8 treatoutvid=4002 -treatinpri=8 -treatinvid=4096 eth-1
#map all untagged traffic to common TLS vlan on eth-1
Chapter 7
System Maintenance and
Troubleshooting
About File Permission
Permissions are assigned by the system whenever you create a new file or directory.
Permissions for a particular file can be viewed by running the "ls -l" command from the
system command line:
196
ls -l Command Output
Permissions
Includes information on type of file and the current permissions settings for that file.
If the first digit =
d: The entry is a directory
b: The entry is a block special file.
c: The entry is a character special file.
l: The entry is a symbolic link
p: The entry is a first-in, first-out (FIFO) special file.
s: The entry is a local socket
-: The entry is an ordinary file.
Links
Displays the number of links to this file.
Owner Account
Name
Displays the Owner Account Name for the file.
Group Account
Name
Displays the Group Account Name for the file.
Size of File
Displays the size of the file in bytes.
Date/Time of File
Displays the date and time of last update to the file.
File Name
Includes the file name and any permission file changes (umask).
The permissions string in any file is based on file type, owner permissions, group
permissions, and other user permissions.
Unless setup by yourself or the system administrator, your default umask setting will be 000
which means that new files that are created will have read and write permissions for everyone
(666 or -rw-rw-rw). New directories will have read, write and execute permissions for
everyone (777 or drwxrsxrwx).
197
Permissions are numerically controlled within the system using a 3-digit umask number. Each
digit sequentially removes permissions for each of the three classes of owner, group, and
others. The values for any one digit are derived from adding the value of the permissions
from the following list:
0 = no permission (-)
1 = execute permission only (x)
2 = write permission only (w)
4 = read permission only (r)
By adding all three digits together, the result is 7. This represents read, write, and execute
permissions for the group the digit is applied to. Therefore, a umask value of 777 would give
full read, write, and execute permissions to all owners, groups, and others.
The number given as a parameter to the umask command "masks" permissions as opposed
to granting them. That is, the digits in the umask number are subtracted for files (666) when
creating initial permissions. For example, suppose you enter:
umask 022
Files created using this umask will have default permissions of 644 (666 - 022, or -rw-r--r--).
New directories will have default permissions of 755 (drwxr-xr-x). if the umask value is set to
077, your default file permissions would be 600 (-rw------) and your default directory
permissions would be 700 (drwx------).
You can change the default permissions by using the umask command.
198
Download Failures
There are several possible download failure cases that must be handled by the AE ONT
upgrade process:
Primary and secondary TFTP servers do not respond (on page 198)
TFTP server responds with file not found (on page 199)
Download transfer is interrupted (on page 199)
Download image is corrupted
By default, any configuration action that is not executed properly stops the boot process.
This includes the ability to download a new runtime image or verify the current runtime
image against the image contained on the TFTP server. It is possible to circumvent this
process by setting a flag in the ONTs configuration file instructing the ONT to continue to
boot. The ONT continues to boot if it has a valid runtime image (even if it is unable to
validate the embedded image against the one stored on the TFTP server).
Note: Effective with AE Release 2.0,
In all image download cases, the AE ONT attempts to access the download image 3 times
from the primary TFTP server before attempting to download from the secondary server (if
a secondary TFTP server is specified in the configuration file). The following reboot process
continues indefinitely until the ONT obtains operational status:
1. Attempt to retrieve runtime image 3 times from Primary TFTP server
2. Error logged to Syslog if unsuccessful
3. Attempt to retrieve runtime image 3 times from Secondary TFTP server
4. Error logged to Syslog if unsuccessful
5. Checks flag to see if continue-on-error has been set. If yes:
a. The ONT continues to process the configuration file and attempts to become
operational
6. Checks flag to see if continue-on-error has been set. If no:
a. Message to indicate that ONT is resetting
b. Reset ONT (boot process starts over)
When attempts to resolve the download failure prove unsuccessful, ONT replacement may
be required.
199
TFTP Server Not Responding

In this case, the ONT is booting and attempting to download a runtime image from the
TFTP server. In this scenario, one of the following occurs:
The boot process pauses until both the new image is downloaded and the ONT switches
The ONT determines that the image it is currently running is the same version as the
image stored on the TFTP server.
Note: In the latter case, the ONT is unable to communicate with the TFTP server.
TFTP Server Responds "File not Found"

The "File not Found" error is generated under the following conditions:
If the ONT is given an incorrect image name
The ONT is given an incorrect TFTP server address

The TFTP server is unable to find the file
Download Transfer Interrupted

If the ONT begins the TFTP transfer of a new runtime image and then loses
communication, the TFTP request times out.
Serviceability Characteristics
Serviceability and truck-roll prevention is addressed in all Calix ONTs focusing on the
following primary areas:
Inaccessible ONT: an ONT that becomes inaccessible from the service provider for
other reasons besides a catastrophic hardware failure or fiber cut.
ONT that faulted: an ONT that took an exception, software panic, or failed a sanity test
ONT with incorrect operation: an ONT that is running but not providing service as
expected
In order to prevent an inaccessible ONT,at a minimum, resets and returns to the phase 1 boot
state (on page 186) defined in the ONT Boot Process Section. In the case of a fault,
exception, software panic, or sanity test failure, the ONT collects information about the state
of the ONT, saves the information into memory, and then resets. In the case of Operations,
Administration and Maintenance (OAM) failures, an attempt is made to send error
information to the Syslog server prior to resetting.
200
Below is a list of conditions in which the ONT protects itself from requiring a truck roll to
recover. In each case, the ONT returns to a known state where it attempts to re-provision
itself and recover to a valid service state:
Loss of WAN link after the link has been established

Hardware watchdog expiration
Software watchdog expiration (postmortem dump saved)
Software exception (postmortem dump saved)
Hardware exception (postmortem dump saved)
Explicit reset via control path
Loss of DHCP control address
In-ability to successfully complete configuration
A few cases exist where the ONT is operational but is exhibiting incorrect or unexpected
behavior. The 7xxGX provides the ability for customer service or engineering personnel to
log directly to the ONT via telnet. From the password-protected telnet command shell,
debug commands are issued, logs dumped, tracing turned on, and console debug messages
monitored.
Important: To gain access to the ONT command shell, the user name is "admin" and
password is "fiber1ttx".
ONT Retry Behavior

Although catastrophic events such as a direct lightning strike cannot be entirely avoided,
(events that would indeed require a truck roll), it is a primary goal of the hardware and
software design to avoid this action in all but the most extreme cases.
As a rule, if the ONT detects that it is in a state that it cannot recover from "gracefully", it
collects information about its current state and then resets to get back to a known,
recoverable state.
There exists a class of failures that are external to the ONT that are still manageable by the
ONT. In these cases (for example, if the RMI is unavailable), the ONT may retry requests,
try an alternate server, or finally reset in an attempt to recover or complete an action.
201
Below are the scenarios in which the ONT attempts to gracefully recover without a reset or
panic:
Phase 1 boot sequence - failure to obtain the DHCP management IP address
Retry Count: DHCP client retries up to 5 times at incrementing intervals
Retry Interval: Interval increase for each retry: 4/8/16/32/64 seconds
Secondary Server: Service provider may add resiliency by adding backup DHCP
servers
Final Action: Reset
Comment: The standard DHCP client protocol is followed for maintaining the control
path IP address lease. This standard is followed for retries, discovery, loss of lease, and
lease expiration.
TFTP Requests - unable to contact TFTP file server for ONT image download or SIP
configuration files
Retry Count: 3 times
Retry Interval: 10 seconds
Secondary Server: Service provider may add resiliency by adding backup DHCP
servers that specify alternative TFTP configuration servers. The AE ONT provides
for primary and secondary TFTP servers for SIP configuration files and ONT
runtime download images.
Final Action: Reset
Tip: If the ONT goes into a permanent retry loop state, disable the TFTP Server such
that the ONT cannot be re-discovered. At this point, you may gain access to the ONT
through a TELNET or similar connection.
Comment: The ONT resets in the case that the provider accidentally put the wrong
TFTP information in the configuration file. Resetting after some interval allows the ONT
to get the latest configuration file. For SIP recovery, a different count, interval and
recovery mechanism is used and defined elsewhere.
NTP Requests - unable to contact NTP time server to obtain ONT time-of-day
Retry Count: 3 times
Retry Interval: 10 seconds
Secondary Server: Service provider may add resiliency by adding a backup NTP
server and specifying the second address in the ONT's configuration file. The AE
ONT provides for primary and secondary NTP servers.
Final Action: Retry indefinitely
Comment: Any loss of communication with the NTP server results in a warning
message logged to the Syslog server(s). Failure to get NTP updates is not considered
critical and therefore no further action is required.
202
Syslog Messages - since logged messages are User Datagram Protocol (UDP) based and
therefore no guarantee of delivery. The service provider may specify a second Syslog
server address. The AE ONT sends each log message to both locations.
SNMP Traps - traps are UDP based and therefore no guarantee of delivery. The current
list of outstanding alarms may be retrieved from the ONT using an SNMP GET
operation.
DHCP Renewal - unable to renew an IP lease (DHCP server not responding)
The ONT makes periodic attempts to renew its IP address until its lease expires. In
the event that the lease expires:
Retry Count: DHCP client retries up to 5 times at incrementing intervals
Retry Interval: Interval increase for each retry: 4/8/16/32/64 seconds
Secondary Server: Service provider may add resiliency by adding backup

DHCP servers
Final Action: Reset
Comment: The standard DHCP client protocol is followed for maintaining the control
path IP address lease. The standard is followed for retries, discovery, loss of lease, and
lease expiration
203
Viewing ONT Alarms and Events in CMS

In this release of the AE ONT software, GX ONTs can be viewed within CMS with any
associated alarms or events that are generated.
To view an ONT in CMS
1. From the Navigation tree, drill down to the Network Group where the switch is known
to reside.
2. Click the Network Group name to display an image of the Ethernet device (for example,
E5-400).
3. From the Work Area menu, click Network Details.
4. From the Work Area menu, click AE ONT Nodes.
The work area displays ONTs connected (or previously connected) to the network group
device as well as any alarms in the standing alarm panel.
Note: Clicking the Events tab in the Alarm Menu Bar displays events rather than alarms.
204
Changing the Management VLAN

uses VLAN 85.
device.
re-applied).
205
Monitoring the ONT

The AE ONT uses SNMP traps and standard Syslog messaging to notify the service provider
when operational issues arise. By default, the AE ONT sends alarms, events, and
informational messages to a Syslog server address. Up to 4 SNMP trap receivers are
configurable in order to receive alarm and event notification.
Note: If SNMP traps are not configured (only the Syslog provisioned), you must manually
check the Syslog log file to determine if alarms, events, or errors have been reported by an
ONT.
In an AE system, SNMP alarming is defined with the following capability:
The AE ONT sends an SNMP alarm trap to each receiver when an alarm condition is
raised or cleared
SNMP GET is supported for retrieving standing alarms on the ONT
SNMP GET is supported for obtaining additional information such as ONT model type,
software version, and the like.
206
About Syslog Events

The complete list of Syslog events reported by an AE ONT is listed in the table below.
Syslog Events
Type
Event
Description
Info
Auto-committing new firmware image
ONT commits the newly downloaded firmware image.
Warning
Failed to update time with any configured NTP

servers
ONT is unable to update its network time with any configured

server address(es).
Warning
ONT cannot load config file despite retires,

resetting
ONT is unable to load the ONT configuration file after multiples

retries.
Info
ONT will retry config file loading in approximately 5

minutes.
The ONT did not successfully retrieve its configuration file and
will retry after the mentioned interval.
Warning
ONT has been configured with problems.
Errors occurred during configuration file processing.
Info
ONT has been configured successfully
The ONT is up and running with the loaded configuration.
Info
ONT is running in Unmanaged mode.
ONT is running in Unmanaged mode.
Info
ONT is running firmware version VERSION
Displays the ONT firmware version.
Info
ONT regained IP address from the DHCP server
ONT regained an IP address after losing the DHCP lease.
Info
None of the DHCP Option-43 firmware entries

apply to this ONT
DHCP Option-43 commands do not apply to this ONT model

type.
Error
Cannot renew DHCP lease for ONT management

port
The ONT has timed out trying to renew the DHCP lease.
Info
Firmware image has been downloaded previously,

resetting. . .
New firmware has been loaded to the ONT previously. The ONT
will boot to the new firmware without performing another
download.
Info
Firmware version VERSION download in progress
ONT firmware download is in progress.
Info
Firmware upgrade complete. Booting to new

version
ONT completed the upgrade of firmware image. ONT rebooting

to the new firmware.
Warning
Firmware image FILENAME not found on server

IP_ADDRESS
The ONT firmware image is not available on the specified TFTP

server.
Warning
TFTP server IP_ADDRESS timeout during firmware

upgrade
ONT times out trying to retrieve ONT firmware image from the
TFTP server.
Info
Retrieving file FILENAME from server

IP_ADDRESS
ONT was attempting to retrieve the named ONT configuration

file at the specified TFTP server.
Warning
File FILENAME on server IP_ADDRESS is not a

valid firmware image
Requested file(s) is not an ONT firmware image.
Warning
Firmware image FILENAME on server

IP_ADDRESS is corrupted
ONT firmware image is corrupted.
Info
Firmware upgrade command ignored in

configuration file due to DHCP Option-43
The firmware upgrade CLI command is ignored since firmware

check has been performed due to DHCP OPTION-43 firmware
entry.
Info
Retrieving file FILENAME from server

IP_ADDRESS
The ONT is retrieving named configuration file from the named

server.
Warning
Retrying file FILENAME from server IP_ADDRESS
ONT failed to retrieve the named FILENAME from the TFTP

server and is re-trying.
Info
ONT is attempting to load config file FILENAME at

IP_ADDRESS
ONT is attempting to load named configuration file at named

TFTP server
Warning
Config file FILENAME not found at server

IP_ADDRESS, attempting Calix-ONT-cfg
The named configuration file is not available on TFTP server.

ONT will try to retrieve the generic ONT configuration file.
Error
Config file FILENAME exceeds size limit.
Configuration file FILENAME is over the size limit of 16384

characters
207
Syslog Events
Error
Configuration file FILENAME is not found at the

TFTP server
ONT configuration file is not available on the TFTP server
Error
Cannot get config file FILENAME due to server

IP_ADDRESS timeout
The ONT cannot load the configuration due to TFTP server

timeout despite retries.
Warning
ONT will load previously used configuration file

backup.
ONT now uses the cached configuration due to a TFTP server

timeout.
Warning
Configuration file FILENAME invalid authentication

MIC ignored
Loaded configuration file does not pass MIC check. ONT will
continue to process the configuration file.
Error
Configuration file FILENAME failed authentication

check.
The loaded configuration file does not pass MIC check, ONT will
attempt to reload configuration file after delay.
Info
ONT is being reset administratively.
ONT will reset due to operator issued reset command.
Channel and Drop Testing

The channel and drop test feature provides a means of testing for line faults on a POTS or
UVG line. The test also determines whether that fault is within the service provider's
network or at the subscriber's location.
The Calix 7xxGX and 7xxGE ONT is the point of demarcation between the service
provider's network and the subscriber's premises wiring. The purpose of the channel test is
to verify that the service providers equipment and network is operational between the voice
switch and the ONT. The purpose of the drop test is to verify the subscriber's wiring and
telephone equipment.
The test is initialized from the CLI using the vtst test command.
208
Chapter 8
CMS Servicing, Performance Monitoring and
Alarm Aggregation
AE Release 2.0 supports autonomous alarm generation through SNMP for all 700GX,
760GX, and 700GE ONTs. The system presents the alarm to the SNMP manager as Critical,
Major or Minor alarms. The default value is set to OFF.
CMS deployed with 700GX, 760GX and 700GE ONTS supports ONT PM Counters,
Ethernet PM Counters, and PWE3 PM Counters.
Performance Management and Fault Management are supported with SNMPv2 traps.
Performance Monitoring SNMP MIBs are listed below and available upon request. None are
supported by the CMS. The only external access is through a MIB Browser/Viewer. They are
also visible at the ONT Debug Shell.
SNMP Monitoring: PM and Statistical MIBs

AE 2.0 provides SNMP support for PM collection and monitoring of interface statistics. The
following information is available through all standard management interfaces.
Ethernet Interface (Data/IPTV)
Interface RFC-1213 (compatible with 2233)
RFC-1213 interfaces and ifTable both status and running counters [although
these stats are in GPON ONTs, they are not accessible through OMCI]
RMON etherStats RFC-2819 - etherStatsTable running counters
RMON etherStatsHighCapacity RFC-3273 - etherStatsHighCapacityTable - running

counters
210
Voice Services
aeVoiceStatus Calix Enterprise Voice (VoIP) Status
aeVoiceCounters - Calix Enterprise Voice (VoIP) Counters - running counters

w/reset
aeVoiceErrors - Calix Enterprise Voice (VoIP) Errors - running counters w/reset
T1/E1 (PWE3) Services
T1/E1 Line fault statistics Calix Enterprise PWE3 T1/E1 Line fault - binned PM
counters
PWE3 aggregate statistics - Calix Enterprise PWE3 aggregate - binned PM counters
PWE3 bundle statistics - Calix Enterprise PWE3 bundle binned PM counters
RFC-1406 DSX1 binned PM counters dx1Current, dx1Interval, dx1Total
Troubleshooting AE ONT Ethernet Issues

Use the following commands to assist in isolating AE ONT Ethernet issues.
config history
The command "config history" is used to review the commands issued to the ONT in
sequence. This is helpful when troubleshooting basic ONT configuration file problems or if
a parameter was changed inadvertently and the ONT did not automatically reboot.
Note: The command "history" displays the identical information.
CXNK0002B723> config history
1 config syslog setup -prisvr=10.21.12.100
2 config trap sink -s1=10.21.0.18 -s2=172.22.93.3 s3=172.23.43.11 -community=public
3 config upgrade -prisvr=10.21.12.100 filename=Build-11b7090810/img/g_nhmont_ae.rto
4 config ntp update -prisvr=10.21.60.2 -freq=300 offset=-28800
5 config label set label=Jane_AE_ONT3
6 bridge create vlanps vid=250 -mf=enable -snoop=disable
pmap=eth-0
7 set iftab adminstatus index=eth-0 adminstatus=up
8 set iftab adminstatus index=eth-1 adminstatus=up
9 bridge add vid=600
10 bridge portadd vid=600 dev=eth-1
11 lev2 add -treatinvid=600 dev=eth-1
12 config regid display
13 config regid display
211
bridge show bridges

The "bridge show bridges" displays:
All of the configured bridges on an AE ONT

Unicast and multicast statistics for the bridge (counts slow path protocol processing only
on 7xxGE and 76xGX MDU ONTs)
DHCP Snooping statistics for the bridge
Additional settings for the bridge.
This information is particularly valuable when passing routing protocol updates via multicast
(by setting the upstream multicast filter to false). This and other parameters that apply to
various applications can also be verified here.
CXNK000370EE> bridge show bridges
Bridge:
00c815b8-1f
Type:
VLANIPH
Members:
2
VID:
0x0055 (0085)
PBIT:
(5)
learningInd:
TRUE
sub2subFwInd:
FALS
stationValidation:
FALS
DHCPSnoop:
FALS
Option82Enabled:
FALS
MacFF:
FALS
igmpSnoopInd:
FALS
filtUpMcastInd:
FALS
DHCPSnoopOffset:
0
dhcpUpstreamSnoopHits: 0
dhcpDnstreamSnoopHits: 0
station_valid_Count:
0
filtUpMcastCnt:
0
option82ProcessErrors: 0
Idx
SID
Ecp FCS BkUn UP DP ucast_in
ucast_out mcast_in
mcast_out
--- --------- --- --- ---- -- -- ---------- ---------- ---------- ---------0
wan
NUL NUL TRUE 5 5
48114
63518
1326207
199879
0
iph
NUL NUL TRUE 40 40
63538
48126
199879
1033868
212
Bridge:
Type:
VLAN
Members:
2
VID:
0x0fa0 (4000)
PBIT:
(0)
learningInd:
FALS
sub2subFwInd:
TRUE
igmpSnoopInd:
FALS
filtUpMcastInd:
FALS
EthMcastUnkCnt:
0
filtUpMcastCnt:
0
option82ProcessErrors: 0
Idx
SID
Ecp FCS BkUn UP DP ucast_in
ucast_out mcast_in
mcast_out
--- --------- --- --- ---- -- -- ---------- ---------- ---------- ---------0
eth
NUL NUL TRUE 0 0
66
554375
87883
455314
0
wan
NUL NUL TRUE 0 0
554375
66
455314
87883
Resolving Configuration Errors

If end devices are not configured correctly, you can use the following commands:
For example, to find tagging errors, you can look at the individual queues to spot packets
with that particular tag.
mpp q
This command displays all memory locations for all interfaces:
CXNK000370EE> mpp q
MPP Ingress List Info:
List
Begi End Push
--------- ---- ---- ---FREE
4096 8191 4232
ETH0Rx
512 767 626
ETH1Rx
768 1023 1014
WAN0Rx
1024 1279 1215
MPP Egress List Info:
List
Begi End Push
--------- ---- ---- ---ETH0Tx
1
255 45
ETH1Tx
256 511 496
WAN0TxQ0 1280 1535 1525
ETHTXREP0 1536 2047 1658
ETHTXREP1 1536 2047
0
Pop popCount
HWM Pendi overF under
---- ---------- ----- ----- ----- ----4236
143
3835 4095
0
0
626
114
2
0
0
0
1014
246
4
0
0
0
1216
194
255
0
6
0
Pop popCount
HWM Pendi overF under
---- ---------- ----- ----- ----- ----45
38
21
0
0
0
496
240
54
0
0
0
1527
249
7
0
0
0
1658
122
1
0
0
0
1658
122
2
0
0
0
Appendix A
Command Reference
A complete list of CLI commands is provided here for reference. Each command is listed
with the appropriate usage, any available options or required parameters, and an example if
needed for further clarification.
214
Configuration Commands
A single command is provided which is used to configure basic ONT operation. This
command is called config.
config vlan set

This command modifies the Management VLAN ID. The value is stored in the ONT flash
memory. An ONT reboot is needed for the new VLAN ID to take effect. This command
should not be used in the ONT configuration script as it overwrites the default VLAN ID of
85 prior to broadcasting the ID to the system.
config vlan set
Usage
config vlan set vlanid=<n>
Assign Management VLAN ID
Parameters
vlanid=<n>
VLAN ID
type: Integer (0-4094)
Note: There is also a command for displaying the current Management VLAN ID value
(config vlan display).
215
config ntp update

This command performs time updates with an NTP server. The NTP server is identified by
an IP address. By default, the ONT repeats time update every 24 hours. config ntp update
resets the NTP configuration and performs a time update.
Note: Information on the current ntp configuration can be viewed by executing the "config
ntp display" command.
config ntp update
Usage
config ntp update [-prisvr=<ipaddr>] [-secsvr=<ipaddr>] [-dst] [-freq=<n>] offset=<n>
Reset NTP configuration and perform time updates
Options
-prisvr=<ipaddr>
Primary NTP server IP address

type: IP Address
-secsvr=<ipaddr>
Secondary NTP server IP Address

type: IP Address
-dst
Enable daylight savings time adjustment

type: Enable, Disable
-freq=<n>
Initial time update frequency in seconds (0 to disable)

type: integer (0,86400)
Parameters
offset=<n>
Time offset (in seconds from UTC, -43199 to +43200)

type: Integer (-43199, 43200)
216
config syslog setup

By default, the ONT assumes that the DHCP server and the Syslog server are located on the
same machine. The config syslog command overrides the default setting and assigns a new
Syslog server address.
config syslog setup
Usage
config syslog setup [-prisvr=<ipaddr> -secsvr=<ipaddr>] [-facility=<n>]
Syslog client setup
Options
-prisvr=<ipaddr>
Primary Syslog server IP address

type: IP Address
-secsvr=<ipaddr>
Secondary Syslog server IP address

type: IP Address
-facility=<n>
Syslog local facility number

type: integer (0,7)
Note: Executing the "config syslog status" command displays current syslog setup
parameters.
CXNK0002B65A> config syslog status
Number of Syslog servers configured: 2
Server 1: 10.83.4.152
Server 2: 10.83.4.90
config file
This command displays the current information on TFTP server IP address locations as well
as information on the active ONT configuration.
CXNK0002B71D> config file
TFTP server #1 = 10.83.4.152
TFTP server #2 = 0.0.0.0
TFTP server used = 10.83.4.152
Configuration file used = "CXNK0002B71D.cfg"
217
config label
This command provides for the addition of a label to an ONT. The label can be a street
address or any value useful for identifying the ONT. The label value is displayed by the
calix_ae_ont script for each ONT along with their serial numbers and IP addresses. The
ONT does not store the label value in its flash memory so it must be set inside the ONT
configuration file.
config label
Usage
config label set label=<str>
Assign label to the ONT
Parameters
label=<str>
ONT Label
type: Integer (-43199, 43200)type: Character String (32)
Note: There is also a command for displaying the current label (config label display)
218
config upgrade
This command performs firmware version checking and upgrade. It initiates a TFTP GET
command on a firmware image file. It assumes the firmware image file is located at the same
TFTP server that is holding the ONT configuration file. It compares the image header
against the running firmware version. If the firmware image file is newer, it proceeds to
retrieve the entire firmware image. After successful data validation and flash programming, it
reboots the ONT and starts running the new firmware.
config upgrade
Usage
config upgrade [-prisvr=<ipaddr>] [-secsvr=<ipaddr>] [-downok][-nofail] filename=<str>
Upgrade firmware image
Options
-prisvr=<ipaddr>
Primary TFTP server IP address

type: IP Address
-secsvr=<ipaddr>
Secondary TFTP server IP address

type: IP Address
-downok
Downgrade allowed
-nofail
Continue configuration process despite upgrade failure
Parameters
filename=<str>
firmware image filename

Example
CXNK11900002> config upgrade g_nhmont_ae.rto
retrieving firmware image g_nhmont_ae.rto from server 177.0.0.161
version of new image
6.0.z.4
version of running image 6.0.z.3
downloading to FLE0xBC060000L0x00780000
download completed
downloaded image is valid
Set FPGA config address 0xBCB20200
sys_boot_one_shot: boot one-shot image = b
219
config regid
The config regid command provides the ability to set or display a Registration ID string for
an ONT.
config regid
Usage
config regid set [-id=<str>]
Set the Registration ID for an ONT
CXNK0002B71D> config regid set 6125555555

ONT Registration ID (old) is disabled
ONT Registration ID (new) = "6125555555"
Erasing before save...done
writing to flash...done
Also saving Reg ID at 0xBC820000 ...done
Pgming...update flag...Erasing before save...done
writing to flash...done
Also save Reg ID Flag at 0xBC820000
Note: Executing "config regid display" returns the current registration ID of the ONT. If the
registration ID has not been provisioned, the system returns, "Registration ID is not set".
config synce
When configuring differential clock recovery on a PWE3 network, the WAN uplink Ethernet
port must be synchronous with the ONT. Setting the SyncE flag to active ensures both the
source and endpoint share the same synchronous timing, a necessary component of proper
PWE3 provisioning. (Setting the SyncE flag to inactive changes the PWE3 clock to the local
oscillator which is asynchronous).
CXNK0004A3CC> config synce set
SyncE is ON.
Note: Executing the "config synce show" command displays the current state of the SyncE
clock.
220
config trap sink

This command configures up to 4 SNMP trap receiver (sink) addresses for receiving
Registration, Alarm and Event traps.
config trap sink
Usage
config trap sink [-community=<str>] [-s1=<ipaddr>] [-s2=<ipaddr>] [-s3=<ipaddr>] [-s4=<ipaddr>] [-freq=<n>]
Configure SNMP trap sink address
Options
-community=<str>
SNMP community string

-s1=<ipaddr>
Trap sink #1 IP address

type: IP Address
-s2=<ipaddr>

type: IP Address
-s3=<ipaddr>

type: IP Address
-s4=<ipaddr>

type: IP Address
-freq=<n>
Initial registration frequency in seconds (0 to disable)

type: Integer (0,3600)
221
Executing the "config trap status" command displays the current trap receiver settings.
CXNK0002B65A> config trap status
Number of SNMP trap sinks configured: 2
Sink 1: 10.83.4.90
Sink 2: 10.83.4.172SNMP community string: "public"
Initial registration Trap frequency: 300 seconds
Registration trap frequency after registration: 600 seconds
Registration traps are currently sent every 600 seconds
SNMP agent is running
Registration Trap Info:
Serial Number: CXNK0002B65A
ONT Label:
Management Host IP: 10.83.5.136
Management Host MAC: 00-06-31-14-30-98
Registration State: Registered
Registration ID:
ONT Model: 712GX
ONT Firmware Version: 2.0.20.5
Loaded Configuration File: CXNK0002B65A.cfg
Configuration File Marker: CMS R11.2.52, 2011-02-10 13:55:51,
rootgod.
Configuration File MIC: 00000000000000000000000000000000
CMS IP: 10.83.4.90
Device Status: Running with specific configuration file
Config Status: Configured
config alarms
The AE system offers several features and commands for monitoring ONT activity.
Primary Alarm Conditions
All AE ONTs report and log to the Syslog server the following alarm conditions:
On Battery
Battery Missing
Battery Failing (replace)
Battery low
Laser Failing (End of Life)
Data Port Link Down (provisionable)
Note: For a detailed description of the above alarm conditions, see the Alarm Definitions (on
page 223) section of this guide.
222
When VoIP services are offered, several additional error conditions are reported to the
Syslog Server as follows:
Unable to retrieve the Configuration File from the TFTP server

Configuration File execution errors
Cannot communicate with the SIP server
Lost communications with the SIP server (separate event)
Unable to obtain a DHCP assigned IP address
SIP registration failure due to bad or unknown ONT User ID or URI
SIP registration failure due to incorrect ONT Authentication (incorrect USER ID or
Password)
config alarms
The config alarms command displays alarm information associated with an ONT.
CXNK0006D9A2> config alarms -a
All reportable alarms:
[ 1]
On Battery Power
[ 2]
Battery Missing
[ 3]
Battery Failing
[ 5]
TX Laser Fault
[ 6]
Video Sig Fault
[ 57]
Battery Low
[ 58] ACTIVE UPS Missing
[238]
RF Return Laser end-of-life
[246]
Ethernet Port 1 (eth-0) link DOWN
[247]
[248]
[249]
[250]
[251]
[252]
[253]
[239]
Mgmt Intf DHCP Lease Renewal Failure
[240]
Firmware Upgrade Failure
[241]
NTP Time Update Failure
[242]
VOIP DHCP Lease Renewal Failure
[243]
VOIP Config File TFTP Failure
[244]
VOIP Registration Failure
[245]
VOIP Reg Authentication Failure
[256]
Configuration File Command Error
[257]
Configuration File Authentication Error
[258]
Cached ONT Configuration File Is In Use
[259]
Cached VOIP Configuration File Is In Use
CXNK0006D9A2>
223
Note: In the example above, only Alarm #58 (UPS Missing) is displayed when running the
"config alarms" command (only active alarm).
config alarms
Usage
config alarms [-all]
Displays a list of current active alarms
Options
-all
Includes a complete list of all alarms, including inactive.

Note: Executing the "config alarms" command displays active alarms associated with a
specific ONT.
Note: Executing the "config alarms -a" command displays active and inactive alarms
associated with an ONT.
Alarm Definitions
The table below details all alarms included in the config alarms command with their
definitions. All alarms below are reported via the SNMP trap receivers.
Descriptions and recommended troubleshooting steps for each alarm follow.
Note: These alarms are also captured by the Syslog server.
Note: All Ethernet Interface alarms are disabled until after the first port activation.
Note: The number of available Ethernet and T1/E1 ports (up to 8) varies depending on the
ONT model.
224
Alarms
Alarm #
76xGX
MDU
ONTs
70xGE/
70xGX
SFU
ONTs
Displayed Description
Main Power Failure ("On Battery" alarm)
Battery Missing
Battery Failing
TX Laser End-of-Life
RF-Signal Bad ("RF Video Signal Fault" alarm)
9, 14, 112, 121, 130,

139, 148, 157
TDM #1 through TDM #8 LOS (T1-L1 through T1-L8 Loss of Signal)
10, 15, 113, 122, 131,

140, 149, 158
TDM #1 through TDM #8 AIS (T1-L1 through T1-L8 Alarm Indication

Signal)
13, 18, 116, 125, 134,

143, 152, 161
TDM #1 through TDM #8 Loopback (T1-L1 through T1-L8 in

Loopback)
57
Low Battery
58
UPS Missing
76, 77, 117, 126, 135,

144, 153, 162
TDM #1 through TDM #8 Powerdown (T1-L1 through T1-L8 Power

Down)
100, 102, 120, 129,

138, 147, 156, 165
TDM #1 through TDM #8 PWE3 LOS (Tx R-bit) (T1-L1 through T1-L8
PWE3 Loss of Signal)
166, 169, 172, 175,

178, 181, 184, 187
TDM #1 through TDM #8 PWE3 Remote LOS (Rx R-bit) (T1-L1

through T1-L8 PWE3 Far-End Loss of Signal)
167, 170, 173, 176,

179, 182, 185, 188
TDM #1 through TDM #8 Remote LOS (Rx L-bit) (T1-L1 through T1L8 Far-End Loss of Signal)
168, 171, 174, 177,

180, 183, 186, 189
TDM #1 through TDM #8 PWE3 Malformed Packet (T1-L1 through

T1-L8 PWE3 Malformed Packet)
190 to 197
TDM #1 through TDM #8 Provisioning Mismatch (T1-L1 through T1L8 PWE3 Provisioning Mismatch)
238
RF-Return Laser E-O-L (RF Return Laser End-of-Life)
239
Management Interface DHCP Renewal Failure
240
Firmware Upgrade Failure
241
NTP Time Update Failure
242
VoIP IP Host DHCP Renewal Failure
243
VoIP Configuration File TFTP Failure
244
VoIP Port Registration Failure
245
VoIP Port Authentication Failure

Ethernet Port 1 (eth-0) Link Down
246, 247

248, 259, 250, 251,
252, 253

225
Alarm #
76xGX
MDU
ONTs
70xGE/
70xGX
SFU
ONTs
Displayed Description

254
ONT T1/E1 Equipment Failure ("T1 Heartbeat" alarm)
256
Configuration File Command Error
258
Cached ONT Configuration File In Use
259
Cached VoIP Configuration File In Use
badBattery (Battery Failing)
This alarm indicates that the On Battery alarm is active and the battery voltage has
discharged, typically to less than 11.7 V. (For the specific voltage break point, refer to the
UPS manufacturer specifications.)
Recommended action
Recharge or replace the battery.
Severity
Minor, Non-service-affecting
cachedConfigFileInUse (Cached ONT Configuration File In Use)
The ONT cannot retrieve the ONT configuration file from the Management TFTP server.
The ONT is currently providing services based on the most recently downloaded ONT
configuration File.
Recommended action
Check the Management TFTP server.
Severity
Major, Non-service-affecting
226
cachedVoipConfigInUse (Cached VoIP Configuration File In Use)
The ONT cannot retrieve the VoIP configuration file from the VoIP TFTP server. The
ONT is currently providing VoIP services based on the most recently downloaded VoIP
configuration File.
Recommended action
Check the VoIP TFTP server.
Severity
configFileCommandError (Configuration File Command Error)
An error occurred with a CLI command in ONT configuration file.

The error may or may not be service-affecting, depending on the CLI command.
Recommended action
Check the Event Log for specific error details.
Severity
Major
firmwareUpgradeFail (Firmware Upgrade Failure)
The ONT is unable to update the firmware image as specified in the Configuration File
during boot-up.
Recommended action
Check the Management TFTP Server.
Severity
laserEOL (Tx Laser End-of-Life)
The ONT laser module is not operating within specification.

Recommended action
Replace the ONT laser.
Severity
227
linkDownPort1 to 8 (Ethernet Port 1 to 8 Link Down)
The alarmed Ethernet port (1 to 8, or eth-0 to eth-7) link is down, and is configured to be up.
This alarm typically indicates that the Ethernet link is disconnected at the subscriber
premises.
Recommended action
Troubleshoot and correct the condition:
Verify that the subscriber PC or switch directly connected to the ONT is powered up.
Verify that the cable is connected.
Severity
Major, Service-affecting
lowBattery (Low Battery)
The ONT is running on UPS battery power and the battery level has fallen below allowable
limits.
Recommended Action
Resolve the AC power failure issue which caused an On Battery condition.

Replace the battery.
Severity
lowSigLevel (RF-Signal Bad)
The downstream RF video signal is not operating within allowable limits.

Recommended action
Check the Video signal source.
Severity
228
mgmtDhcpRenewal (Management Interface DHCP Renewal Failure)
The ONT cannot renew its Management IP host DHCP lease. When the DHCP lease
expires, the customer loses the ability to service the ONT remotely. The ONT continues to
attempt Management IP Host DHCP lease renewal despite the failure.
Recommended action
Check the Management DHCP server.
Severity
MICMismatch (MIC Mismatch)
The provisioning on the alarmed AE ONT is out of sync with CMS. The AE ONT may not
connected to or may have lost communication with CMS following a Save Configuration
action on the AE ONT.
Note: This alarm is only raised in Calix Management System (CMS).
Recommended action
After troubleshooting the AE ONT connection status with CMS, perform a Save
Configuration action, and then reset the AE ONT.
Severity
missingBattery (Battery Missing)
The UPS battery is not connected or reports a low voltage, typically less than 0.3 V. (For the
specific voltage break point, refer to the UPS manufacturer specifications.)
Recommended action
Connect or replace the battery.
Severity
229
onBattery (Main Power Failure)
An On Battery alarm indicates that the ONT is reporting a loss of AC power and that the
ONT is running on battery power.
Recommended Action
Determine the cause of the loss of power, such as a local power failure.
Restore AC power as soon as possible.
Severity
ontT1E1HardwareFail (ONT T1/E1 Equipment Failure)
Also known as a T1 Heartbeat alarm, this alarm indicates that a hardware failure has occurred
within the T1/E1 subsystem.
Recommended action
Reset the ONT.

If this action does not clear the problem, replace the ONT.
Severity
RF Return Laser End-of-Life
The RF Return module has reached End-of-Life.

Recommended action
Replace the ONT.
Severity
t1l1AIS to t1l8AIS (T1-L1 to T1-L8 Alarm Indication Signal)
The equipment connected to the ONT via the alarmed T1/E1 port has an alarm (for
example, LOS).
Recommended action
Perform a loopback test to isolate and correct the fault.
The AIS alarm clears when the AIS defect is absent for 10 seconds.
Severity
230
t1l1FELOS to t1l8FELOS (T1-L1 to T1-L8 Far-End Loss of Signal)
The alarmed ONT T1/E1 port is receiving PWE3 packets with the L-bit asserted, indicating
an LOS condition on the remote, or far end. This condition is paired with a corresponding
T1 LOS alarm.
Recommended action
Verify that both ends of the circuit are properly configured.
Investigate and correct the LOS condition in the packet network.
Severity
t1l1Loopback to t1l8Loopback (T1-L1 to T1-L8 in Loopback)
An autonomous or manually-activated loopback (for example, an inband loopback) is active

on the alarmed ONT T1/E1 port.
Recommended action
After the loopback is removed, the alarm clears.
Severity
Major, Service-Affecting
t1l1LOS to t1l8LOS (T1-L1 to T1-L8 Loss of Signal)
The alarmed ONT T1/E1 port is reporting a local Loss-of-Signal or Out-of-Frame (OOF)
condition.
Recommended action
Check the status of the PWE3 circuit.

Check cables and connectors.
Severity
231
t1l1Powerdown to t1l8Powerdown (T1-L1 to T1-L8 Powerdown)
The alarmed ONT T1/E1 port is in power conservation mode.

T1/E1 ports are considered critical service and by default remain operational when operating
on battery backup. This alarm indicates that the ONT is operating on battery backup power
and is configured to power down T1/E1 ports when on battery.
Recommended action
Disable power conservation mode on ONT T1/E1 ports, and restore commercial power as
soon as possible.
Severity
t1l1PWE3FELOS to t1l8PWE3FELOS (T1-L1 to T1-L8 PWE3 Far-End Loss of
Signal)
The alarmed T1/E1 port on the ONT is receiving PWE3 packets with the R-bit asserted
from the far end of the circuit, indicating that the remote, or far end of the circuit has an
LOS condition. This condition is paired with a T1 PWE3 LOS alarm.
Recommended action
Verify that both ends of the of the PWE3 circuit are properly configured.
Severity
t1l1PWE3LOS to t1l8PWE3LOS (T1-L1 to T1-L8 PWE3 Loss of Signal)
The alarmed ONT T1 port is not receiving PWE3 packets. When the ONT stops receiving
PWE3 packets, the R-bit is asserted in transmitted packets so the paired PWE3 endpoint is
aware of the condition.
Recommended action
Verify that both ends of the of the PWE3 circuit are properly configured.
Severity
232
t1l1PWE3Malformed to t1l8PWE3Malformed (T1-L1 to T1-L8 PWE3

Malformed Packet)
The ONT has detected a packet size mismatch for a configured bundle.
Recommended action
Verify that RTP is configured at both ends of the PWE3 circuit.

Delete or reconfigure the bundle at either end so the packet sizes are the same.
Severity
t1l1PWE3Mismatch to t1l8PWE3Mismatch (T1-L1 to T1-L8 PWE3 Mismatched
Provisioning)
A PWE3 provisioning mismatch has been detected on the alarmed ONT T1 port.
If a differential RTP timestamp mode is provisioned and SyncE is not active, the alarm is
raised.
Recommended action
Configure SyncE for differential timing (recommended) or re-configure for adaptive timing.
Severity
timeUpdateFail (NTP Time Update Failure)
The ONT is unable to update the current time with any specified NTP server(s). The ONT
continues to attempt NTP updates despite the failure.
Recommended action
Check the NTP server.
Severity
233
upsMissing (UPS Missing)
The ONT cannot detect the presence of the UPS module. The UPS may be unplugged or
non-operational.
Recommended Action
Reconnect the UPS.

Check signal wiring from the ONT to the UPS.
Severity
voipConfigTftpFail (VoIP Configuration File TFTP Failure)
The ONT has failed to retrieve the SIP Configuration File for establishing SIP service. The
ONT continues to attempt SIP Configuration File retrieval despite the failure.
Recommended action
Check the VoIP TFTP server.
Severity
voipDhcpRenewal (VoIP IP Host DHCP Renewal Failure)
The ONT cannot renew the VoIP IP Host DHCP lease. When the DHCP lease expires,
VoIP-related servicesSIP or Calix TDM Gateway (CTG)are disabled. The ONT
continues to attempt VoIP IP Host DHCP lease renewal despite the failure.
Recommended action
Check the VoIP DHCP server.
Severity
234
voipRegAuth (VoIP Port Authentication Failure)
The ONT has failed to authenticate with the SIP server (cannot establish SIP Services). The
ONT continues to attempt SIP server registration with the same credentials despite the
failure.
Recommended action
Check the SIP server.
Severity
voipRegistration (VoIP Port Registration Failure)
The ONT has failed to register with the SIP server (cannot establish SIP Services). The ONT
continues to attempt SIP server registration despite the failure.
Recommended action
Check the SIP server.
Severity
235
config supp alarm (Alarm Suppression)

The config supp alarm command allows for the suppression of individual alarms (useful for
turning Ethernet port alarming on or off based on port connection status:
config supp alarm
Usage
config suppress alarm alarmid= state=<enum>
Suppress forwarding of individual alarms
Parameters
alarmid=
Alarm ID number*.
type: Unsigned
state=<enum>
Suppression state On/Off

type: off, on
* For a list of alarms, run the Alarm List command (am l)

Note: Suppressed alarms will have the letter "S" appended to the alarm ID
Example
config supp alarm 246 on
In the example above, the alarm for Ethernet Port # 1 (eth-0) is suppressed as follows:
246*S Ethernet Port 1 (eth-0) link DOWN
- 0 0 0 (0)
config diag
The config diag command displays a pre-defined list of elements on an ONT.
Note: Prior to calling Calix Customer Service, it is recommended you run this command and
capture it's contents for reference.
The following commands are executed as part of the config diag command:
ver (on page 342)

config history (on page 349)
show iftab (on page 343)
show ifstats (on page 344)
mpp rates (on page 381)
show ethert (on page 342)
bridge show bridge (on page 338)
bridge show drops (on page 336)
236
mpp queues (system developer use only)

bridge glob (on page 340)
meter show info (on page 384)
meter show count (on page 385)
iphost show (on page 340)
mpp ess (on page 381)
mpp show (system developer use only)
show voip mib (on page 364)
voipreg (on page 357)
voiprtp (on page 360)
voipcc (on page 359)
os sys (on page 374)

macff show (on page 386)
dhcp lease show
config ntp display (on page 214)
config alarms -all (on page 222)
show video stats (on page 393)
show ifpowermanagement
config trap status (on page 219)
os perf show
levxl2tag show eth-x (on page 387) (where levx is lev1 (on page 387) or lev2 (on page 389)
and eth-x corresponds to all Ethernet ports on the ONT)
237
Bridge Commands
AE bridges are used to transfer data between the AE WAN port, the subscriber Ethernet
ports, the AE control processor, and SIP ports. Each ONT bridge is associated with a single
VLAN and associated VLAN ID on the WAN side of the AE ONT. More than one bridge
may be configured on each Ethernet port if the subscriber port trunks multiple VLANs or
the ONT is mapping untagged traffic to multiple WAN VLANs. For more detailed
information, refer to the section entitled Subscriber VLAN to WAN VLAN Mapping (on page
142).
bridge add (VLAN Bridge Add)

Use this command when adding a subscriber port VLAN bridge.
Note: For VLAN per port configurations, also include the bridge portadd (on page 240)
command once for the port associated with the VLAN.
Note: For VLAN per service configurations, include the bridge portadd (on page 240)
command once for each port to be added to the service VLAN.
vlan bridge add
Usage
bridge add [-lb=<enum>] [-mf=<enum>] [-fw=<enum>] [-snoop=<enum>] [-sv=<enum>] [-onlysv=<enum>] [macff=<enum>] [-onlymacff=<enum>] [-onlydhcp=<enum>] [-vprofile=<str>] vid=
Add a Subscriber Port VLAN Bridge
Options
-lb=<enum>
learning bridge - enable/disable.

Default = disable
Note: If the VLAN on an ONT is assigned to more than one port, the ONT automatically
turns on the learning bridge.
-mf=<enum>
Enable/Disable multicast filtering in the UPSTREAM direction, default = disable

-fw=<enum>
subscriber2subscriber forwarding - enable/disable, default =disable

-snoop=<enum>
Turn on IGMP snooping, default = disable

-sv=<enum>
Station validation - enable/disable DHCP station validation, default = disable

-macff=<enum>
Enable/Disable MAC force forwarding support, default = disable

238
vlan bridge add
-onlysv=<enum>
Enable/Disable DHCP station validation independent of any other feature, default = disable
-onlymacff
Enable/Disable MAC force forwarding support independent of any other feature, default disable
-onlydhcp
Enable/Disable DHCP snooping independent of any other feature, default - disable

-vprofile
Name of video profile when snooping is enabled, default = none

type: Unsigned
Parameters
vid=

type: Unsigned
Note: References to the -snoop command refer to IGMP snooping.
bridge setup
The bridge setup command is used to facilitate the provisioning of objects within CMS.
bridge setup
Usage
bridge setup [-lb=<enum>] [-mf=<enum>] [-fw=<enum>] [-snoop=<enum>] [-sv=<enum>] [-macff=<enum>] [onlysv=<enum>] [-onlymacff=<enum>] [-onlydhcp=<enum>] [-vprofile=<str>] [-dcir=] [-dpir=] [-ucir=] [upir=] [-ucbs=] [-dcbs=] [-mshaper=] [-attach=<enum>] vid= dev=<ifname>
Setup a VLAN bridge along with subscriber port association for CMS provisioning
Options
-lb=<enum>
Learning Bridge - enable/disable. Default = Disable.

Note: If the VLAN on an ONT is assigned to more than one port, the ONT automatically
turns on the learning bridge.
-mf=<enum>
Enable/Disable multicast filtering in the UPSTREAM direction. Default = Disable.

-fw=<enum>
Subscriber to subscriber forwarding. Default - disable

-snoop=<enum>
Turn on IGMP snooping. Default = disable
239
bridge setup
-sv=<enum>
Enable/disable DHCP station validation. Default = disable

-macff=<enum>
Enable/disable MAC force forwarding support. Default - disable

-onlysv=<enum>
Enable/disable DHCP station validation independent of any other feature. Default =

disable.
-onlymacff=<enum>
Enable/disable MAC force forwarding support independent of any other feature. Default =
disable.
-onlydhcp=<enum>
Enable/disable DHCP snooping independent of any other feature. Default = disable.

-vprofile=<str>
Name of video profile when snooping is enabled. Default = None.

type: Character string (14)
-dcir=<enum>
Committed downstream unicast traffic rate

-dpir=<enum>
Peak downstream unicast traffic rate

-ucir=<enum>
Committed upstream unicast traffic rate

-upir=<enum>
Peak upstream unicast traffic rate

-ucbs=
Committed burst size in bytes. Total size of upstream and downstream packets collected
prior to beginning any meter shaping.
type: Unsigned
-dcbs=
Committed burst size in bytes. Default = Current downstream traffic rate.

type: Unsigned
-mshaper=
Upstream shaper number (0-310 for upstream multicast traffic (VLAN attached only).
240
bridge setup
type: Unsigned
-attach=<enum>
Shaper attachment type for upstream and downstream unicast traffic

type: vlan, eth
Parameters
vid=
WAN side VLAN ID for this VLAN (0-4094)

type: Unsigned
dev=
Ethernet device name

type: Interface name
The following attributes are checked and/or created as part of the bridge setup command:
Ensures a VLAN bridge has been created for the VLAN ID's "vid" parameter. If the
VLAN bridge does not exist, it uses the existing "lb", "mf", "-fw", "-snoop", "-sv", and "macff" option values to create the bridge. Reference the "bridge add (on page 256)"
command.
If the VLAN bridge already exists, the bridge setup options are ignored.
Adds the provided Ethernet device to the VLAN bridge. Reference the 'bridgeport add (on
page 256)" command.
Creates a pair of downstream and upstream traffic shapers and attaches them to the
VLAN bridge. Reference "meter set downstream" (on page 264), "meter set upstream (on page
265)", and "meter attach (on page 267)" commands.
The committed burst size parameter is supported on 7xx GE ONTs only.
Attaches the multicast upstream shaper to the VLAN bridge if the "-mshaper" option is
provided. Reference "meter attach mcastup (on page 270)" command.
241
bridge portadd (Associate Subscriber Ethernet Port to VLAN

Bridge)
This command can be called repeatedly for each member port in a VLAN.
bridge portadd
Usage
bridge portadd vid= dev=<ifname>
Associate a port with an already created VLAN Bridge
Parameters
vid=

type: Unsigned
dev=<ifname>
eth device name

242
Filtering and Mapping commands

lev1l2tag add
The Level 1 L2 Mapping/Filtering table is the first table processed on the subscriber
ingress/egress. A separate table with 16 entries exists in the downstream and upstream
direction for each Ethernet port. Entries are added to the table one at a time with the "lev1l2
tag add" command. Entries are processed by the forwarding paths in the order they are added
to the table. When an entry is added, the system constructs an automatic "inverse" operation
for the downstream processing if the action requires it.
Note: Currently only no tag operations are supported for the level 1 table.
lev1l2 mapping add entry
Usage
lev1l2tag add [-filtmac=<enum>][-filtmacmask=<mac>] [-filtmacmatch=<mac>] [-treattagremdrop=][treatoutpri=] [-treatoutvid=] [-treatouttpidde=] [-treatinpri=] [-treatinvid=] [-treatintpidde=]
dev=<ifname>
Add Level 1 - Layer2 filter/tagging entry upstream, an inverse operation is automatically performed downstream
Options
-filtmac=<enum>
Which MAC address to filter on, default = disable

type: disable, da, sa
-filtmacmask=<mac>
Mask of MAC address bytes used to compare with filtermacmatch, the bits
that are significant
type: MAC address
-filtmacmatch=<mac>
MAC address to match on

type: MAC address
-treattagremdrop=
method to remove tags or drop frames or do nothing, skip = 0, dropframe = 3,

default = 0(skip)
type: Unsigned
-treatoutpri=
Method to handle outer priority, 0-7 = explicit setting, 8 = copy PBITs from
inner tag, 9 = copy PBITS from outer tag, 15 = don't add outer tag, default =
15
type: Unsigned
-treatoutvid=
Method to treat outer Vlan Id, less than 4095 = value of VID for outer tag, 4096
= copy outer VID from inner VID, 4097 = copy outer VID from outer VIDi,
default = 0
-treatouttpidde=
Method to treat outer ethertype and discard eligibility bit, TPID and DE copied
from inner = 0, TPID and DE copied from outer = 1, TPID is OutputTPID, DE
copied from inner = 2, TPID is OutputTPID, DE copied from outer = 3, TPID is
0x8100 = 4, TPID is default OutputTPID = 5, TPID is OutputTPID and DE bit is
0 = 6, TPID is OutputTPID and DE bit is 1 = 7i, default = 6
type: Unsigned
type: Unsigned
-treatinpri=
Method to handle inner priority, 0-7 = explicit setting, 8 = copy PBITs from
inner to outer tag, 9 = copy PBITS from outer to inner tag, 15 = don't treat but
keep inner tag, default = 15
type: Unsigned
243
-treatinvid=
Method to treat inner Vlan Id, less than 4095 = value of VID for inner tag, 4096
= copy inner VID from inner VID, 4097 = copy inner VID from inner VID,
default = 0
type: Unsigned
-treatintpidde=<u
Method to treat inner ethertype and discard eligibility bit, TPID and DE copied
from inner = 0, TPID and DE copied from outer = 1, TPID is OutputTPID, DE
copied from inner = 2, TPID is OutputTPID, DE copied from outer = 3, TPID is
0x8100 = 4, TPID is default OutputTPID = 5, TPID is OutputTPID and DE bit is
0 = 6, TPID is OutputTPID and DE bit is 1 = 7i, default = 6
type: Unsigned
Parameters
dev=<ifname>
Ethernet device name to add the table entry (eth-0--eth-n)

lev2l2tag add
If no match occurs in the Level1 Layer-2 Mapping/Filtering table the Level 2 L2
Mapping/Filtering table is processed. The Level 2 L2 Mapping/Filtering table is the second
table processed on the subscriber ingress/egress. Entries are added to the table one at a time
with the "lev2l2 add" command and are processed in the order they are added. When an entry
is added, the system constructs an automatic "inverse" operation for the downstream
processing if the action requires it. The interface supports no tag, 1 tag, and 2 tag operations.
double tagged frames coming from a subscriber.
244
With respect to the treatment side, the inner tag refers to the first tag on single tag or no tag
frames. On a double tag frame it is the inner tag, or in other words, the second tag. The
command is defined as follows:
Usage
lev2l2tag add [-filtoutpri=] [-filtoutvid=] [-filtouttpidde=] [-filtinpri=] [-filtinvid=] [-filtintpidde=] [filtetype=] [-treattagremdrop=] [-treatoutpri=] [-treatoutvid=] [-treatouttpidde=] [-treatinpri=] [treatinvid=] [-treatintpidde=] dev=<ifname>
Add Level 2 - Layer2 filter/tagging entry upstream, an inverse operation is automatically performed downstream
Options
-filtoutpri=
Method to filter outer priority, 0-7 = filter on explicit match of outer priority, 8 = do
not filter outer priority, 14 = default when no 2-tag rule applies, 15 = no double tag
rule, default = 15
type: Unsigned
-filtoutvid=
Method to filter outer Vlan Id, less than 4095 = value of VID to match, 4096 = do
not filter on outer VID, default = 0
type: Unsigned
-filtouttpidde=
Method to filter outer ethertype and discard eligibility bit, Do not filter on outer
TPID_DE = 0, outer TPID is 0x8100 = 4, outer TPID is default InputTPID - don't
care about DE bit = 5, Outer TPID is default InputTPID - DE bit is 0 = 6, Outer
TPID is default InputTPID - DE bit is 1 = 7, default = 6
type: Unsigned
-filtinpri=
Method to filter inner priority, 0-7 = filter on explicit match of inner priority, 8 = do
not filter inner priority, 14 = default when no 1-tag rule applies, 15 = no tag rule,
default = 15
type: Unsigned
-filtinvid=
Method to filter inner Vlan Id, less than 4095 = value of VID to match, 4096 = do
not filter on inner VID, default = 0
type: Unsigned
-filtintpidde=
Method to filter inner ethertype and discard eligibility bit, Do not filter on inner
TPID_DE = 0, inner TPID is 0x8100 = 4, inner TPID is default InputTPID - don't
care about DE bit = 5, inner TPID is default InputTPID - DE bit is 0 = 6, inner TPID
is
default InputTPID - DE bit is 1 = 7, default = 6
type: Unsigned
-filtetype=
Method to filter on ethertype, 0 = Do not filter on ethertype,

match on, default = 0
> 0 = ethertype to
type: Unsigned
-treattagremdrop=
Method to remove tags or drop frames or do nothing, skip = 0, remove1tags = 1,

remove2tags = 2, dropframe = 3, default = 0
type: Unsigned
-treatoutpri=
Method to handle outer priority, (0-7 = explicit setting, 8 = copy PBITs from inner
tag, 9 = copy PBITS from outer tag, 15 = don't add outer tag, default = 15)
-treatoutvid=
Method to treat outer Vlan Id, less than 4095 = value of VID for outer tag, 4096 =
copy outer VID from inner VID, 4097 = copy outer VID from outer VID, default = 0
type: Unsigned
type: Unsigned
245
-treatouttpidde=
Method to treat outer ethertype and discard eligibility bit, TPID and DE copied from
inner = 0, TPID and DE copied from outer = 1, TPID is default OutputTPID, DE
copied from inner = 2, TPID is default OutputTPID, DE copied from outer = 3, TPID
is 0x8100 =
4, TPID is default OutputTPID = 5, TPID is default
OutputTPID and DE bit is 0 = 6, TPID is OutputTPID and DE bit is 1 = 7, default =
6
type: Unsigned
-treatinpri=
Method to handle inner priority, 0-7 = explicit setting, 8 = copy PBITs from inner to
outer tag, 9 = copy PBITS from outer to inner tag, 15 = don't treat but keep inner
tag, default = 15
type: Unsigned
-treatinvid=
Method to treat inner Vlan Id, less than 4095 = value of VID for inner tag, 4096 =
copy inner VID from inner VID, 4097 = copy inner VID from inner VID, default = 0
type: Unsigned
-treatintpidde=
Method to treat inner ethertype and discard eligibility bit, TPID and DE copied from
inner = 0, TPID and DE copied from outer = 1, TPID is OutputTPID, DE copied
from inner = 2, TPID is OutputTPID, DE copied from outer = 3, TPID is 0x8100 = 4,
TPID is default OutputTPID = 5, TPID is OutputTPID and DE bit is 0 = 6, TPID is
OutputTPID and DE bit is 1 = 7, default = 6
type: Unsigned
Parameters
dev=<ifname>
Ethernet device name to add the table entry (eth-0--eth-n)

246
lev1l2tag set
The following command is used to set the default TPID (ethertype) values on a per Ethernet
port basis. The following commands are used for both level 1 and level 2 tables.
lev1 set
Usage
lev1l2tag set [-outtpid ] [-intpid ] <dev>
Set Level 1 - Layer2 filter/tagging Table inputTpid/outputTpid default values
Options
-outtpid=
Default resulting/treated (network side) ethertype for frames, default = 0x8100

type: Unsigned
-intpid=
Default incoming/filtered (subscriber side) ethertype for frames, default = 0x8100

type: Unsigned
Parameters
dev
Ethernet device name to add to the table entry (eth-0 - eth-n)

lev2 set
Usage
lev2l2tag set [-outtpid ] [-intpid ] <dev>
Set Level 2 - Layer2 filter/tagging Table inputTpid/outputTpid default values
Options
-outtpid=
Default resulting/treated (network side) ethertype for frames, default = 0x8100

type: Unsigned
-intpid=
Default incoming/filtered (subscriber side) ethertype for frames, default = 0x8100

type: Unsigned
Parameters
dev
Ethernet device name to add to the table entry (eth-0 - eth-n)

247
Example Filtering and Mapping Tables

Level 1 L2 Table
This table is primarily used in the absence of managed switches or RGs at the subscriber
network. This table currently supports mapping/filtering by MAC DA/SA. The following
commands are supported in Level 1:
Action
lev1l2tag add -filtmac=sa -filtmacmask=ff:f:f:ff:00:00:00 filtmacmatch=00:01:04:00:00:00 -treatinpri=4 -treatinvid=100
dev=eth-0
Result
Adds single tag (lev1l2tag), with filter on source address SMAC OUI (-filtmac=sa), adds
VID=100, with explicit PBIT value (4)
Action
lev1l2tag add -filtmac=da -filtmacmask=ff:f:f:ff:00:00:00 filtmacmatch=00:01:07:00:00:00 -treatinpri=4 -treatinvid=100
dev=eth-0
Result
Adds single tag (lev1l2tag), with filter on destination address DMAC OUI (-filtmac=da), adds
VID=100, with explicit PBIT value (4)
Action
lev1 add -filtmac=da -filtmacmask=ff:ff:ff:00:00:00 filtmacmatch=00:01:05:00:00:00 -treattagremdrop=3 eth-0
Result
Drops all frames matching DMAC OUI (-filtmac=da), fully qualified DMAC can be
specified as well
Action
lev1 add -filtmac=sa -filtmacmask=ff:ff:ff:00:00:00 filtmacmatch=00:01:07:00:00:00 -treattagremdrop=3 eth-0
Result
Drops all frames matching SMAC OUI (-filtmac=da), fully qualified SMAC can be specified
as well.
248
Level 2 L2 Filtering/Mapping Table

The second table processed is called the Level 2 L2 filtering/mapping table. It is used in the
presence of managed switches or RGs at the subscriber network. This table supports the
ability to re-map VLAN tags on the subscriber side or to add additional tags for TLS, as well
as many other operations. The following commands are supported in Level 2:
Action
lev2l2tag add -filtinpri=5 -filtinvid=100 -treatinpri=4 treatinvid=210 eth-0
Result
Adds single tag, with VID translation from VLAN 100/PBIT=5 to VLAN 210/PBIT=4,
uses default output Tpid
Action
lev2l2tag add -filtinpri=8 -filtinvid=300 -treatinpri=8 treatinvid=400 eth-0
Result
Adds single tag, VID translation from VLAN 300 to VLAN 400, propagates incoming PBIT
from incoming tag, uses default outputTpid
Action
lev2l2tag add -filtinpri=8 -filtinvid=600 -treatoutpri=8 treatoutvid=500 -treatinpri=8 -treatinvid=4096 eth-0
Result
Adds double tag, Adds VID (500) from incoming VID match (600), propagates incoming
PBIT from incoming tag, uses default outputTpid
Action
lev2l2tag add -filtinpri=8 -filtinvid=700 -treatoutpri=4 treatoutvid=800 -treatinpri=8 -treatinvid=4096 eth-0
Result
Adds double tag, Adds VID (800) from incoming VID match (700), explicit PBIT, uses
default outputTpid
Action
lev2l2tag add
-filtetype=0x8863 -treatinpri=5 -treatinvid=200 eth-0
Result
Adds single tag, Adds tag if etype = 0x8863 , sets explicit PBITs, uses default TPID
249
Action
lev2l2tag add
-treatinpri 5 -treatinvid 200 eth-0
Result
Adds single tag, Adds tag, sets explicit PBITs, uses default TPID
Action
lev2l2tag add -filtinpri=8 -filtintpidde=5 -filtinvid=800 treatoutpri=0 -treatoutvid=901 -treatinpri=8 -treatinvid=810 eth-0
Result
Creates double tag, translates incoming (ctag) VID 800 to VID 810, propagates incoming
PBIT value from incoming ctag, adds outer s-tag 901 with defined pbit = 0
250
DSCP Mapping
dscp set
Use the following commands to assign DSCP P-Bit mapping values to an ONT Ethernet
port:
DSCP Set
Usage
dscp set [-dscp2=] dev=<ifname> dscp1= pbit=
Set DSCP P-Bit values on a per subscriber port basis.
Options
-dscp2=
Optional 2nd or range ending 6-bit DSCP value, if defining a DSCP range. Default=dscp1
type: Unsigned (0,63)
Parameters
dev=<ifname>
Ethernet device name to set the table entries (eth-0 through eth-n)
dscp1=
6-bit DSCP value to designate a PBIT value or the start of the DSCP range.
pbit=
The PBIT value to set for the DSCP(s)

Note: Unspecified P-Bit values default to zero.

Example
CXNK0005434C > dscp set dev=eth-0 dscp1=48 pbit=6
# result = Ethernet port 0 on this ONT has assigned a pbit value of
6 to dscp1-48
251
dscp show
Use the dscp show command to view current Layer-2 mapping assignments of DSCP values
on a per-port basis.
CXNK0005345C> dscp show dev=eth-0
DSCP2PBIT Table for eth-0
00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -06 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Lev 1 Example
lev1l2tag add -filtmac=untag_sa -filtmacmask=ff:ff:ff:00:00:00
filtmacmatch=00:01:05:00:00:00 -treatinpri=13 -treatinvid=100
dev=eth-0
# result = single tag, filter on OUI add VID 100, apply DSCP2PBIT
mapping tables from port
Lev 2 Example
lev2l2tag add
-treatinpri =13 -treatinvid 200 eth-0
# result = single tag, Add tag to untagged frame, treat PBIT based
on DSCP2PBIT mapping table on port, use default TPID
dscp set with Range

Use the following command to set of range of p-bit values to more than one DSCP.
CXNK0005345C> dscp set -dscp2=63 dev=eth-0 dscp1=56 pbit=7
#result: For Ethernet port 1, assigns a p-bit value of 7 to all
DSCP's between 56 and 63.
252
By executing the dscp show command against this Ethernet port, the following results are
expected:
CXNK0005345C> dscp show dev=eth-0
DSCP2PBIT Table for eth-0
00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -06 00 00 00 00 00 00 00 07 07 07 07 07 07 07 07
253
Data Service Example with DSCP

#Data service section
#Svc Tag Actions
bridge setup \
-mf=enable \
-snoop=disable \
-macff=enable \
-dcir=20000000 \
-dpir=20000000 \
-ucir=10000000 \
-upir=10000000 \
-attach=vlan \
vid=201 \
dev=eth-1
#DSCP/pBit Mapping Section
dscp set dev=eth-1 dscp1=56 pbit=7
#Untagged Match Rule
lev2l2tag add \
-treatinpri=13 \
-treatinvid=201 \
dev=eth-1
254
l2cp portmode
The following CLI command activates the L2CP feature:
l2cp portmode
Usage
l2cp portmode [-allans=<enum>][-brblk=<enum>][-garp=<enum>] dev=<ifname>
Set the Ethernet port L2CP control. System default = discard.
Options
-allans=<enum>
This attribute controls the processing of the All LANs Bridge Management Group protocols
with destination MACaddress 0x0180c2000010, default = discard
Type: discard, pass
-brblk=<enum>
This attribute controls the processing of the Bridge Block of protocols with destination MAC
addresses, 0x0180c2000000 through 0x0180c200000f, default = discard
Type: discard, pass
-garp=<enum>
This attribute controls the processing of the GARP Block of protocols with destination MAC
address 0x0180c2000020 through 0x0180c200002f, default = discard
Type: discard, pass
Parameters
dev=<ifname>
Ethernet device name to apply (eth-0 through eth-n)

255
l2cp show
Run the l2cp show command to validate the L2CP filter has been setup as required:
l2cp show
Usage
l2cp show[-allans=<enum>][-brblk=<enum>][-garp=<enum>] dev=<ifname>
Set the Ethernet port L2CP control. System default = discard.
Options
-allans=<enum>
This attribute controls the processing of the All LANs Bridge Management Group protocols
with destination MACaddress 0x0180c2000010, default = discard
Type: discard, pass
-brblk=<enum>
This attribute controls the processing of the Bridge Block of protocols with destination MAC
addresses, 0x0180c2000000 through 0x0180c200000f, default = discard
Type: discard, pass
-garp=<enum>
This attribute controls the processing of the GARP Block of protocols with destination MAC
address 0x0180c2000020 through 0x0180c200002f, default = discard
Type: discard, pass
Parameters
dev=<ifname>
Ethernet device name to apply (eth-0 through eth-n)

256
IP Host Bridge(s)
IP Host ports on the ONT are pseudo-devices that allow bridge port paths for IP Host
Termination at the ONT.
The ONT creates a default IP Host bridge (iph-0) on the Management VLAN which is then
used for the ONT control path and may also be used to attach SIP ports. If additional IP
Host Bridges are needed to isolate VoIP data or other services a separate command
described below is used to create or delete them.
In order to terminate a path between the WAN interface and an IP host, a bridge must be
created with one or more IP Host ports associated with it. The command to facilitate IP
Host Bridge creation is bridge setup (on page 238).
bridge add (IP Host Bridge Create)
This command creates an IP host VLAN Bridge
bridge add
Usage
bridge addiph [-pbit=] vid=
Add an IP host VLAN Bridge
Options
dev
Ethernet device name to apply (eth-0 - eth-n)

Parameters
vid=
WAN side VLAN ID for this VLAN (0-4094), 0 = untagged

type: Unsigned
257
bridge portadd (Add IP Host to VLAN Bridge)

This command can be called repeatedly for each member IP host in a VLAN.
bridge portadd
Usage
bridge portadd vid= dev=<ifname>
Parameters
vid=

type: Unsigned
dev=<ifname>
eth device name

IP Host Bridge Delete

This command tears down an IP Host VLAN Bridge
bridge delete
Usage
bridge delete vid=
Parameters
vid=

type: Unsigned
258
MACFF Commands
Use the following commands to manage and provision Mac Forced Forwarding on an AE
ONT Network:
macff set index
The macff set index command is used to define static IP stations for use with MACFF
security as well as to define static stations/subnets using IP SRC verification (station
validation) without having macff enabled (see -onlysv).
Note: If two unique static addresses are resolved to the same MAC address during macff set,
only the latest association is maintained. If this should occur, previous static IP and MAC
address associations will not pass upstream traffic.
macff set index
Usage
macff set index= vid= gateway=<ipaddr> subip=<ipaddr> mask=<ipaddr>
Statically specify a MACFF entry*
Parameters
index=
Index to the MACFF static configuration station validation table entry

type: Unsigned
vid=
Specify the participating VLAN ID for this MACFF entry

type: Unsigned
gateway=<ipaddr>
IP address of the access router to be used for MACFF

type: IP Address
subip=<ipaddr>
Subscriber IP address to be used for MACFF

type: IP Address
mask=<ipaddr>
Subnet mask encompassing both the access router and the subscriber
type: IP address
* Note: If the entry is not statically assigned, DHCP will populate values as required.
259
macff del index
macff delete
Usage
macff del index=
Removes a statically specified MACFF entry
Parameters
index=
Index to the MACFF static configuration station validation table entry

type: Unsigned
Sample MACFF Command String

Follows are two examples of a MACFF CLI application:
MACFF Basic Configuration
The following commands enable MACFF on a single VLAN:
[CALIX_AE_ONT:R1]
#Include FIT-management.cfg and Label output
include FIT-management.cfg
config label set label="Basic Table 1"
#Set-up MACFF on VLAN 4002 and add the VLAN to the 1st Ethernet port
bridge add -lb=ena -mf=ena -sv=ena -macff=ena vid=4002
#Now map all untagged as data traffic on data vlan for eth-0
#Time to turn on the ports
set iftab admin eth-0 up
#Assign IP addresses to new MACFF entry to VLAN ID, gateway,
subscriber, and subnet mask
macff set 0 4002 172.26.61.2 172.26.61.33 255.255.255.0
260
MACFF Multiple VLAN Configuration

The following commands enable MACFF on multiple VLANs:
[CALIX_AE_ONT:R1]
#Include FIT-management.cfg and Label output
include FIT-management.cfg
config label set label="Basic Table 2"
#Set-up MACFF on VLAN 4002 and add the VLAN to the 1st Ethernet port
#Set-up MACFF on VLAN 4090 and add the VLAN to the 2nd Ethernet port
#Now map all untagged as data traffic on data vlan for eth-0
#Time to turn on the ports
#Assign IP addresses to new MACFF entry to VLAN ID, gateway,
subscriber, and subnet mask
macff set 0 4090 172.26.61.2 172.26.61.33 255.255.255.0
macff set 1 4090 172.26.61.2 172.26.61.33 255.255.255.0
Using MACFF to Configure Static Subnets

The following commands configure a static subnet on an AE ONT. The subnet may be
configured to use -macff or -onlysv (if MACFF is not required and station validation is
required). In this release, the number of subnets supported must be between /24 and /30.
#Assign IP subnet to new MACFF entry to VLAN ID, gateway,
subscriber, and subnet mask. In order to configure a static subnet,
the "host" portion of the ipaddr must be zero.
macff set 0 4090 17226.61.2 172.26.61.0 255.255.255.0
261
Removing MACFF Entries

MACFF entries are persisted in the system until lease expiration. For this reason, MACFF
entries are viewable regardless of the state of the associated ONT Ethernet ports.
To remove these entries prior to lease expiration, perform the following:
To forcibly remove MACFF entries
1. Run the macff show command to view all current entries:
CXNK0003A028> macff show
** Access Routers Entries: **
MAC Address
vid
IP Address
ref
state
----------------- ---- --------------- --- ---------00-00-00-00-00-00 11
10.99.4.254
1 unresolved
00-00-00-00-00-00 11
216.196.71.254 1 unresolved
00-1b-0d-ed-85-80 2030 10.244.239.254 1
resolved
** Subscriber Station Validation Entries: **
MAC Address
vid
IP Address
MASK
AR/Gateway
Por
----------------- ---- --------------- --------------- --------------- --00-1e-37-cb-a9-d9 11
10.99.4.13
255.255.255.0
10.99.4.254
1
00-1e-37-cb-a9-d9 11
216.196.71.248 255.255.255.0
216.196.71.254 1
00-03-91-be-a7-35 2030 10.244.224.33
255.255.240.0
10.244.239.254 0
** Learning Bridge L2Table Entries: **
MAC Address
vid
IP Address
L2Table
----------------- ---- --------------- ----------------00-1e-37-cb-a9-d9 11
10.99.4.13
sv-00d02c64-1e
00-03-91-be-a7-35 2030 10.244.224.33
sv-00d088b8-1d
** Static MACFF configuration Entries: **
idx vid
IP Address
AR/Gateway
MASK
--- ---- --------------- --------------- --------------0
11
216.196.71.248 216.196.71.254 255.255.255.0
1
-1
N/A
N/A
N/A
2
-1
N/A
N/A
N/A
3
-1
N/A
N/A
N/A
4
-1
N/A
N/A
N/A
5
-1
N/A
N/A
N/A
6
-1
N/A
N/A
N/A
7
-1
N/A
N/A
N/A
8
-1
N/A
N/A
N/A
9
-1
N/A
N/A
N/A
10 -1
N/A
N/A
N/A
11 -1
N/A
N/A
N/A
12 -1
N/A
N/A
N/A
13 -1
N/A
N/A
N/A
14 -1
N/A
N/A
N/A
15 -1
N/A
N/A
N/A
262
2. Issue the macff clear command to eliminate a single or all entries. An example of clearing a
single entry is shown below:
CXNK0003A028> macff clear -vid=11 -ip=10.99.4.13
3. Verify the entry has been removed by re-running the macff show command:
CXNK0003A028> macff show
MAC Address
vid
IP Address
ref
state
----------------- ---- --------------- --- ---------00-02-3b-01-fd-31 11
216.196.71.254 1
resolved
00-1b-0d-ed-85-80 2030 10.244.239.254 1
resolved
MAC Address
vid
IP Address
MASK
AR/Gateway
Por
----------------- ---- --------------- --------------- --------------- --00-1e-37-cb-a9-d9 11
216.196.71.248 255.255.255.0
216.196.71.254 1
00-03-91-be-a7-35 2030 10.244.224.33
255.255.240.0
10.244.239.254 0
MAC Address
vid
IP Address
L2Table
----------------- ---- --------------- ----------------00-03-91-be-a7-35 2030 10.244.224.33
sv-00d088b8-1d
idx vid
IP Address
AR/Gateway
MASK
--- ---- --------------- --------------- --------------0
11
216.196.71.248 216.196.71.254 255.255.255.0
1
-1
N/A
N/A
N/A
2
-1
N/A
N/A
N/A
3
-1
N/A
N/A
N/A
4
-1
N/A
N/A
N/A
5
-1
N/A
N/A
N/A
6
-1
N/A
N/A
N/A
7
-1
N/A
N/A
N/A
8
-1
N/A
N/A
N/A
9
-1
N/A
N/A
N/A
10 -1
N/A
N/A
N/A
11 -1
N/A
N/A
N/A
12 -1
N/A
N/A
N/A
13 -1
N/A
N/A
N/A
14 -1
N/A
N/A
N/A
15 -1
N/A
N/A
N/A
263
l2l (Learning Bridge)

The learning bridge table keeps track of the MAC addresses associated with a given bridge.
The maximum entries stored in a MAC learning bridge table is dependent on the ONT type:
700GX SFU - 256 entries
76xGX MDU - 500 entries
700GE SFU - 4000 entries
When the learning bridge is full, the logic currently waits for an entry to be aged out before
another one is added. Packets are sent out via the broadcast/unknown path when an address
is not known to the learning bridge. Entries are aged out on 5 minutes of inactivity.
Note: Inactivity is determined by not receiving a packet from the source MAC address in the
time period.
CXNK03010101>l2l
L2TABLE - 0242bba0-1f:
hash
Port
MAC Address
Minutes
source_hit
dest_hits
hw_act_hit
----
-----
-----------------
-------
----------
---------
---------
eth-0
00-01-02-03-05-03
wan-0
00-01-02-03-04-08
l2l Field Definitions

Value
Description
hash
This index is used internally by the hash lookup mechanism.
Port
The WAN or the Ethernet/IP Host port device defining the interface the MAC address is known to
be on.
MAC Address
The IEEE MAC address of the device.
Minutes
The number of minutes remaining on the entry.
source_hit
The number of times a packet was received and the SRC MAC address in the packet matched
the entry.
dest_hit
The number of times a destination MAC look up was done on a packet and a match was found
for this entry in the learning bridge.
264
Meter Commands
The meter command facility provides a mechanism for supporting 802.1p QoS, per
subscriber, and per VLAN ID rate shaping. For additional details regarding ONT metering
capability, refer to the section entitled Metering and Traffic Shaping (on page 140).
Metering provisioning is executed using the 'meter' command. The meter subcommands are
listed below.
This command is used to show the summarized information on each traffic shaper. It is used
as a debug or sanity checking mechanism. The output of the command is as follows:
meter set downstream

This command is used to set up the downstream rate for a particular traffic shaper.
Note: To disable a shaper, both the upstream and downstream rates (cir/pir) must be set to
zero.
Note: The -ucbs and -dcbs commands are only supported on 700GE ONTs.
meter set downstream
Usage
meter set downstream [-cbs=] <shaper> <cir> <pir>
Set downstream shaper rate
Options
-cbs=
Committed burst size in bytes. Default = Based on current shaper rate.

type: Unsigned
Parameters
shaper
Shaper number (0 - 31)

type: Unsigned
cir
Committed information rate in bits per second. (0 - x). 0 = disable metering

type: Unsigned
pir
Peak information rate in bits per second. (0 - x, x must be >=cir). 0 = disable metering
type: Unsigned
265
meter set upstream

This command is used to set up the upstream rate for a particular traffic shaper.
Note: To disable a shaper both the upstream and downstream rates (cir/pir) must be set to
zero.
meter set upstream
Usage
meter set upstream [-cbs=] <shaper> <cir> <pir>
Set upstream shaper rate
Options
-cbs=
Committed burst size in bytes. Default = based on current shaper rate.

type: Unsigned
Parameters
shaper
Shaper number (0 - 31)

type: Unsigned
cir
Committed information rate in bits per second. (0..x). 0 = disable metering

type: Unsigned
pir
Peak information rate in bits per second. (0..x, x must be >=cir). 0 = disable metering
type: Unsigned
266
meter get downstream

This command is used to display current information on downstream hardware configuration
settings.
Usage: meter get downstream hwcfg shaper=0
shaper
tci
rate
rate u
cbs
-------
---
-----
--------
----
115
10
1875000
meter get downstream

Value
Description
shaper
Traffic shaper number.
tci
Outer Tag Control Information (Pbit + VID) of the network VLAN ID.
rate
Rate of flow
rate u
Rate of flow in units where if unit = 0, rate = Kbps, if unit = 1, rate = Mbps.
cbs
Committed downstream burst size (bytes)
meter get upstream

This command is used to display current information on upstream hardware configuration
settings.
Usage: meter get upstream hwcfg shaper=0
shaper
tci
rate
rate u
cbs
-------
---
-----
--------
----
115
10
1875000
meter get upstream

Value
Description
shaper
Traffic shaper number.
tci
Outer Tag Control Information (Pbit + VID) of the network VLAN ID.
rate
Rate of flow
rate u
Rate of flow in units where if unit = 0, rate = Kbps, if unit = 1, rate = Mbps.
cbs
Committed upstream burst size (bytes)
267

This command is used to attach a flow mechanism to an individual traffic shaper in the
downstream direction. Multiple attachments of the same mechanism are allowed on a given
shaper.
Usage
meter attach downstream [-dev=<fname>] [-vid=] [-portid=] shaper=
Attach downstream shaper to flow
Options
-dev=<fname>

-vid=

type: Unsigned
-portid=

type: Unsigned (Applies to GPON implementations only)
Parameters
shaper=

type: Unsigned
meter deattach downstream

This command is used to de-attach a flow mechanism from an individual traffic shaper in the
downstream direction.
meter deattach downstream
Usage
meter deattach downstream [-dev=<fname>] [-vid=] [-portid=] shaper=
De-attach downstream shaper to flow
Options
-dev=<fname>

-vid=

type: Unsigned
Parameters
shaper=

type: Unsigned
268
meter attach upstream

This command is used to attach a flow mechanism to an individual traffic shaper in the
upstream direction. Multiple attachments of the same mechanism are allowed on a given
shaper.
meter attach upstream
Usage
meter attach upstream [-dev=<fname>] [-vid=] [-portid=] shaper=
Attach upstream shaper to flow
Options
-dev=<fname>

-vid=

type: Unsigned
-portid=

type: Unsigned
Parameters
shaper=
Upstream shaper number (0-31)

type: Unsigned
269
meter deattach upstream

This command is used to de-attach a flow mechanism to an individual traffic shaper in the
upstream direction.
meter deattach upstream
Usage
meter deattach upstream [-dev=<fname>] [-vid=] [-portid=] shaper=
Attach upstream shaper to flow
Options
-dev=<fname>

-vid=

type: Unsigned
-portid=

type: Unsigned
Parameters
shaper=

type: Unsigned
270
meter attach mcast

This command facilitates isolating both broadcast and multicast upstream flows and provides
a mechanism to prevent DOS attacks to the provider network for both IPTV VLANs and
HSI VLANs. The ability to effectively limit this type of traffic from the subscriber is critical
to ensure ongoing network integrity.
One or more upstream shapers per ONT are used to facilitate this feature, in other words,
one per VID, per ONT, or one per port, depending on how the provider wants to limit this
traffic.
If a multicast or broadcast packet arrives from a subscriber for a WAN VID which has a
"mcast" shaper attached to it, the ONT always directs the packet to the attached mcast/bcast
shaper. This attachment has precedence over other per port or per VID attachments on
these types of packets.
The attachment command is defined as follows:
meter attach mcast
Usage
meter attach mcast shaper= vid=
Attach upstream shaper to all multicast/broadcast flows
Parameters
shaper=

type: Unsigned
vid=

type: Unsigned
271
meter deattach mcast

This command is used to de-attach a multicast shaper from a WAN VID.
meter deattach mcast
Usage
meter deattach mcastup vid=
Detach upstream shaper from multicast/broadcast flows
Parameters
vid=

type: Unsigned
DHCP Commands
dhcpl2 limit set
The DHCP Limit Set command (dhcpl2) allows for limiting the number of DHCP leases on
any internet drop.
DHCP lease limits apply at the port level provided the associated VLAN has DHCP
Snooping enabled. For example, if the lease limit is set to 8 and there are two service VLANs
(each with DHCP Snooping enabled), up to 8 leases can be reserved between the two
VLANs. If all 8 leases are reserved for a single VLAN, no additional leases can be obtained
for the 2nd VLAN (in other words, this is a per-port lease limit).
Usage: dhcpl2 limit set port=<ifname> max=

Set DHCP lease limit on port
Parameters:
port=<ifname>
max=
Subscriber ethernet port

Maximum number of leases. A value of 0 means use
the overall system limit (256)
272
dhcpl2 limit show

The dhcpl2 limit show command provides information on lease limits on a per port basis.
CXNK00051B66> dhcp limit show
Usage: dhcpl2 limit show
Display DHCP L2 MAC addresses
Port Limit Count
---- ----- ----0
0
1
1
0
2
3
0
2
7
0
3
Count Port
Mac
Lease Expiry Q
----- ---- ----------------- ----- ------ 1
0 00-02-02-84-ac-fa
1
0
0
2
1 00-ae-db-2f-ae-42
1
0
0
3
1 00-ae-db-2f-e0-42
1
0
0
4
3 00-02-02-84-ac-fd
1
0
0
5
3 00-ae-ae-2f-e0-45
1
0
0
6
7 00-00-0b-2f-ae-49
1
0
0
7
7 00-00-0b-2f-e0-49
1
0
0
8
7 00-02-02-84-ad-01
1
0
0
dhcp limit show
Usage
dhcp limit show
Display DHCP Lease Limits by port
Parameters
Port
Ethernet port ID
Limit
DHCP Lease Limit assigned to the Port
Count
Number of DHCP leases on this subscriber port.
Mac
MAC address of the DHCP host on this subscriber port.
Lease
If lease is active (current), then "1", otherwise "0".
Expiry
Expiration time of the lease.
Number of entries in a queue.
273
DHCP Relay - Option-82 Commands

The AE ONT supports the ability to add DHCP remote agent-id or circuit-id Option-82
strings to upstream subscriber DHCP packets on a per WAN VLAN basis. On downstream
DHCP packets, these strings are removed prior to sending out the subscriber port as per the
RFC. Any type of ONT bridge or VLAN configuration supports Option-82 insertion, for
example, VLAN per port, VLAN per service, and IP Host bridges.
Note: AE ONTs prior to version 2.0 only support remote-ID Option-82 insertion.
The ONT facility supports options for automatic insertion of strings based on pre-defined
tokens. This allows the operator the freedom to configure ONTs identically without any
operator defined information. The network provider specifies which tokens appear in the
Option-82 string by specifying a format string for the Option-82 result. The following tokens
may automatically be inserted by the ONT into the Option-82 string:
Option-82 Commands
Field Name
IFType
Description
Rendered As
The defined values and their associated strings must include

(at a minimum):
String (predefined values of no more than 3

char)
Ethernet, eth
IP Host, iph
VLAN
The VLAN number on the receive port associated with the

Request message.
All valid VLAN numbers (0-4094)
SN
The FSAN Serial number of the device
String (16 characters maximum)
ONTPORT
The ONT interface number relative to zero where the packet

was received.
Integer
DESC
This operator specified description string associated with a

physical port.
CLAB
The operator specified configuration label for the AE ONT
The token are specified using a %token notation. The user defined must be configured prior
to enabling Option-82 on the bridge. In addition, the bridge must be created prior to Option82 configuration. The following sequence of configuration commands enables Option-82 for
an IPTV bridge:
274
Option-82 Example: AE ONT Release 2.0 and above

#
# Create VLAN Per Service Bridge for IPTV service on VID 4090, eth# 0, eth-1
#
bridge add -snoop=ena vid=4090 pmap=eth-0 pmap=eth-1
bridge portadd vid=4090 dev=eth=1
config label sete label="Doe"
#
# Example #1: Set up the option82 format string for the IPTV bridge
# using circuit id only
#
opt82 set string -circuitid="%clab - %sn - %vlan - %iftype-%ontport
- %desc" vid=4090
#
#
opt82 enable remote vid=4090 -desc="John Doe, Anytown USA"
# enable option82 on IPTV bridge
# The following option82 would be produced...
# circuit-id: "Doe - CXNK03010101 - 4090 - eth-0 - John Doe, Anytown
# USA"
#
# Example #2: Set up the Option-82 format string for the IPTV bridge
# using circuit id and remote-id
#
opt82 set string -circuitid="%clab - %vlan - %iftype-%ontport %desc" -remoteid="%sn" vid = 4090
#
# set up a config label for this ONT
#
opt82 enable remote vid=4090 -desc="John Doe, Anytown USA"
#
# enable option82 on IPTV bridge
# the following option82 would be produced:
275
# circuit-id: "Doe - 4090 - eth-0 - John Doe, Anytown USA"
# remote-id: "CXNK03010101"
Note: For either AE 1.1 or 2.0, the command checks to ensure at least one circuit ID or one
remote ID is specified. If -circuitid or -remoteid is present, the AE 1.1 Option-82 setstring
syntax is ignored.
The complete description of Option-82 configuration commands follows:
opt82 set
The following configuration command is defined as follows:
opt82 set
Usage
opt82 set string [-circuitid=<str>] [-remoteid=<str>] vid=
[format=<str>]
Define string/tokens for option-82 insertion
Options
-circuitid=<str>
The DHCP Option-82 format string for the circuit ID. current supported tokens which the
ONT will automatically insert include: %sn, %vlan, %iftype, %ontport, %desc, %clab
-remoteid=<str>
The DHCP Option-82 format string for the remote ID. Currently supported tokens wich the
ONT will automatically insert include: %sn, %vlan, %iftype, %ontport, %desc, %clab
Parameters
vid=
WAN side VLAN ID identifying bridge to specify for the DHCP Option-82 format.
type: Unsigned
format=<str>
The DHCP Option-82 format string, current supported tokens which the ONT will
automatically insert are:
%sn, %vlan, %iftype, %ontport, %desc, %clab
276
enable opt82
The following command is used after all Option-82 token values have been specified and the
ONT Bridge for a particular VLAN has been created:
enable opt82
Usage
opt82 enable remoteId [-frametype=<enum>] [-desc=<str> vid=
Enables upstream Option-82 insertion, downstream Option-82 removal on a designated WAN VLAN, the bridge must
already exist and opt82:string:set called.
Options
frametype=<enum>
Designates the type of WAN DHCP frame to snoop on. Default=1stag

type: 1stag, 0stag, 2tag
-desc=<str>
Defines the optional %desc string for this Option-82 remote ID

Parameters
vid=
WAN side VLAN ID identifying bridge to enable DHCP Option-82 remote ID insertion
on
type: Unsigned
DHCP Option-43 Configuration Process

In order to more efficiently manage ONT inventory, DHCP Option-43 commands can be
used. The information below details how the AE 2.0 system uses the Option-43 structure.
DHCP Option-43 Command Elements
To configure your DHCP server for Option-43 via DHCP server software, apply the DHCP
options at the global level, and within the subnet declaration using the following Option-43
commands:
option CALIX-ONT-SERVER.cms-address: Specifies the trap location for
the CMS server.
option CALIX-ONT-SERVER.second-tftp-address: Specifies the second
TFTP server for downloading firmware and AE configuration files to
the ONT.
277
In AE R1.x, the following rules apply when determining the TFTP server location:
The ONT checks for the server name from either the sname field in the DHCP header
or Option 66 (sname takes precedence over Option 66).
If the server name is not available, the ONT checks for the IP address of the next server
in the DHCP header siaddr field.
If the siaddr field is not defined, the ONT falls back to the DHCP address.
Note: AE R2.0 uses the same rules to identify the TFTP server, and in addition, includes
the option CALIX-ONT-SERVER.second-tftp-address command to specify a second
TFTP IP address.
Configure the default global DHCP options at the DHCP server as follows:
option
option
option
option
option
option
option
space CALIX-ONT-SERVER;
CALIX-ONT-SERVER.cms-address code 1 = ip-address;
CALIX-ONT-SERVER.second-tftp-address code 2 = ip-address;
CALIX-ONT-SERVER.syslog-address code 4 = ip-address;
CALIX-ONT-SERVER.firmware1 code 101 = text;
Configure specific values for DHCP options within a subnet declaration, as shown in the
following example:
# AE-ONT Management Network
subnet xxx.xxx.xxx.x netmask xxx.xxx.xxx.x{
vendor-option-space CALIX-ONT-SERVER;
option CALIX-ONT-SERVER.cms-address xxx.xxx.xxx.xxx;
option CALIX-ONT-SERVER.syslog-address xxx.xxx.xxx.xxx;
option CALIX-ONT-SERVER.firmware1 "calix_ae_700ge_r2.x.x.x.rto";
option CALIX-ONT-SERVER.firmware2 "calix_ae_700sfu_r2.x.x.x.rto";
option CALIX-ONT-SERVER.firmware3 "calix_ae_700mdu_r2.x.x.x.rto";
278
Global Option-43 Field Definitions

Option Name
Definition
option CALIX-ONT-SERVER.cmsaddress
In R1.1, the ONT used the CLI command config trap sink to specify the trap location for the
CMS server. In R2.0, this Option-43 element is used to configure the ONT.
option CALIX-ONTSERVER.secondtftp-address
This designates the IP address of the second TFTP server that the ONT must use to
download firmware and the configuration. In AE R1.1, the following rules applied when
determining the TFTP server location:
1. The AE ONT first looks for the server name from either the sname field
or option 66. sname takes precedence over option 66.
2. If the server name is not available, the ONT looks for the siaddr field and uses that value.
3. If the siaddr field is not defined, the ONT falls back to the DHCP server address.
The above rules still apply for R2.0, however a method was required to specify a second
TFTP server address. Thus, the Option-43 syntax specifying the second TFTP address was
added.
option CALIX-ONTSERVER.validateMIC
When set to "On", the ONT checks that the "Message Integrity Code" is correct before
downloading the main configuration file (<FSAN#>.cfg or <RegID#>.cfg). Note: This is a
CMS feature only and is not employed as part of CLI configuration file provisioning.
option CALIX-ONT-SERVER.forcefirmware
This flag is used to force load C7 or manufacturing ONT images onto the ONT.
DHCP-43 Firmware Inventory Upgrade Process

The following general information applies to AE ONTs and the inventory upgrade process.
1. Prior to turning up ONTs, the operator populates the designated DHCP server with
Option-43 entries listing Calix ONT firmware image filenames.
2. After ONTs have been upgraded to AE 2.0 firmware, the DHCP client on the ONT
requests any available Option-43 data. If DHCP Option-43 data is available, the ONT
pulls (via a TFTP get) the image header for each Option-43 firmware entry until it finds
the right ONT type match.
3. Once the ONT finds an image with the right ONT type match but with a firmware
version mismatch (default is upgrade only, override-able), the ONT retrieves the entire
firmware image file and upgrades itself. If the version of the matching image is equal or
lower to the ONT running version, the ONT continues on to the configuration process
(retrieving the appropriate configuration file).
4. During configuration file processing, the ONT includes built-in intelligence to determine
whether the Option-43 data should be used or if the ONT should rely on the firmware
upgrade CLI command. If a DHCP Option-43 firmware entry is dictating the ONT
firmware version (entry with matching firmware type), the ONT ignores the firmware
upgrade CLI command. In other words, the ONT processes any DHCP Option-43
information first before processing any firmware CLI commands. If a matching DHCP
Option-43 firmware entry is not found, the ONT executes the firmware
matching/upgrade as instructed by the CLI command.
279
DHCP Option-43 Example
Follows is an example of a completed Option-43 configuration:

authoritative;
ddns-update-style none;
option domain-name "tac.calix.com";
# 30 days
# 30 days
allow bootp;
option space CALIX-ONT-SERVER;
option CALIX-ONT-SERVER.cms-address code 1 = ip-address;
option CALIX-ONT-SERVER.second-tftp-address code 2 = ip-address;
option CALIX-ONT_SERVER.syslog-address code 4 = ip-address;
option CALIX-ONT-SERVER.firmware1 code 101 = text;
# AE-ONT Management Network
subnet 192.168.254.0 netmask 255.255.255.0 {
vendor-option-space CALIX-ONT-SERVER;
option CALIX-ONT-SERVER.cms-address 192.168.254.254;
option CALIX-ONT-SERVER.syslog-address 192.168.254.253;
option CALIX-ONT-SERVER.firmware1
"calix_ae_700ge_r2.0.21.1.rto";
"calix_ae_700sfu_r2.0.20.7.rto";
"calix_ae_700mdu_r2.0.20.7.rto";
range 192.168.254.10 192.168.254.252;
}
280
dhcp lease show

The dhcp lease show command displays a list of all actives leases on all ports of the ONT.
CXNK0005DA51> dhcp lease show

Count
----1
2
Vlan
chaddr
---- ----------------4001 00-10-04-08-40-01
4001 00-10-94-08-40-02
ip
-----------192.85.1.4
192.85.1.5
port
---0
0
expiry otag
------ ----10030
1501
10799
1501
dhcp lease show Field Definitions

Value
Description
Count
Represents the order in which the lease was established. Count 1 = first lease
established.
VLAN
VLAN in use for the DHCP client.
chaddr
DHCP Client MAC Address.
ip
IP Address allocated by the DHCP Server to the client.
port
Associated Ethernet port of the lease.
expiry
Time left in milliseconds of the DHCP lease.
otag
The outer tag (network side) for the circuit.
281
Voice Service Commands

CLI commands are available to facilitate the provisioning of SIP,TDM Gateway, H.248, and
MGCP voice services.
Voice services are provisioned by defining an IP Host, assigning a VLAN, and adding the
service type to the voice port.
Note: For SIP and TDM Gateway service, a "setup" command is available for establishing all
three parameters via one command. For MGCP and H.248 services, individual commands
must be executed to establish the service (iphost create, h248 add or mgcp add, and bridge
add).
voip setup
The voip setup command is used to facilitate the provisioning of SIP phone service objects
within CMS.
The following attributes are checked and/or created as part of the voip setup command:
VLAN bridge does not exist, it uses the existing "-pbit" option values to create the IP
host VLAN bridge.
If the VLAN bridge does exists, the "-pbit" option is ignored.
Creates an IP host using "-dhcp", "-ping", "-tracert", "-rsh", "-staticip", "-gwf", "-mask",
and "-gateway" options.
Note: Reference the 'iphost create" command.
Adds the IP host to the VLAN bridge.

Note: Reference "bridge add" command.
Sets up VoiP service on the IP host using the supplied "display", "file", "prisvr", "secsvr",
"user", "password", and "uri" parameters.
Note: Reference "voip add" command.
voip setup
Usage
voip setup [-pbit=] [-dhcp=<enum>] [-ping=<enum>] [-tracert=<enum>]
[-rsh=<enum>] [staticip=<ipaddr>] [-mask=<ipaddr>] [-gwf=<enum>] [-gateway=<ipaddr>] [-mgmt] [linemode=<enum>] [lossplan=<enum>] vid= board=<enum> port=<n> display=<str> file=<s] [-treatinpri=] [-treatinvid=]
[-treatintpidde=] dev=<ifname>
Setup VoIP port along with the corresponding IP host and VLAN bridge (for CMS provisioning)
282
Options
-pbit=
PBIT value to be applied to frames (0..7, default = 0), ignored if VLAN

bridge is already created
type: Unsigned
-dhcp=<enum>
DHCP enable/disable, default=enable

type: enable/disable
-ping=<enum>
ICMP ping enable/disable, default = enable

-tracert=<enum>
ICMP tracert enable/disable, default = enable

-rsh=<enum>
Telnet/rsh enable/disable, default = disable

-staticip=<ipaddr>
Static IP Host Address, must specify <-dhcp disable>, <-mask>, and <gateway>
-mask=<ipaddr>
IP Host Mask, must specify <-dhcp disable>, <-staticip>, and <-gateway>
type: IP Address
type: IP Address
-gwf=<enum>
Gateway forwarding, enable/disable,

Default (iph-1 through iph-n = enable), (iph-0 = disable)
-gateway=<ipaddr>
IP Host Gateway Address, must be same subnet as <-staticip>, must

specify <-dhcp disable>and <-mask>
type: IP ADDress
-mgmt
Retrieve VoiP configuration file from ONT configuration TFTP server on

management VLAN
-linemode=<enum>
POTS port line mode: Loop start or Ground Start

type: LoopStart, GroundStart, default=LoopStart*
Note: Both values case sensitive
-lossplan=<enum>
Voice port Loss Plan

type: GR909, ANSI
283
Parameters
vid=

type: Unsigned
board=<enum>
Board (SLC) ID
type: i-pots, n-exp1, n-exp2
port=<n>
POTS Port number

type: Integer (0-7)
display=<str>
Display Name
file=<str>
Name of file to retrieve to configure VoIP Server

prisvr=<ipaddr>
IP Address of primary TFTP server

type: IP Address
secsvr=<ipaddr>
IP Address of secondary TFTP server

type: IP Address
user=<str>
Registration User Name

type: IP Address
password=<str.
Registration Password
uri=<str>
VoIP URI
* - If loopstart is the desired mode, this command can be omitted.
284
voip add
The "voip add" command is used to create the VOIP SIP service on a binding post. This
command should run after IP Host has been created.
voip add
Usage
voip add [-mgmt] [linemode=<enum>] [-lossplan=<enum>] board=<enum> port=<n> iphost=<n> display=<str>
file=<str> prisvr=<ipaddr> secsvr=<ipaddr> user=<str> password=<str> uri=<str>
Add a VoIP port
Options
-mgmt
Retrieve VoIP configuration file from ONT configuration TFTP server on the
management VLAN
-linemode=<enum>
POTS port line mode

Type: LoopStart, GroundStart Default=LoopStart*
-lossplan=<enum>
Voice port loss plan

Type: GR909, ANSI
285
Parameters
board=<enum>
board=<enum>
port=<n>
POTS Port number

type: Integer (0-7)
iphost=<n>
IP Host index
type: Integer (0-7)
display=<str>
Display Name
file=<str>
Name of file to retrieve to configure VoIP Server

prisvr=<ipaddr>
IP Address of primary TFTP server

Note: This option ignored if -mgmt option is specified.
type: IP Address
secsvr=<ipaddr>
IP Address of secondary TFTP server

Note: This option ignored if -mgmt option is specified.
type: IP Address
user=<str>
Registration User Name

type: IP Address
password=<str.
Registration Password
uri=<str>
VoIP URI
* - If Loopstart is the desired linemode, this command can be omitted.
286
ctg setup
The ctg setup command is used to facilitate the provisioning of TDM Gateway phone service
objects within CMS. The ctg setup command combines the functions of "bridge addiph",
"bridge portadd", "iphost create", and "ctg add"
The following attributes are checked and/or created as part of the ctg setup command:
VLAN bridge does not exist, it uses the existing "-pbit" option values to create the IP
host VLAN bridge.
If the VLAN bridge does exists, the "-pbit" option is ignored.
Creates an IP host using "-dhcp", "-ping", "-tracert", "-rsh", "-staticip", "-gwf", "-mask",
and "-gateway" options.
Note: Reference the 'iphost create" command.
Adds the IP host to the VLAN bridge.

Note: Reference "bridge add" command.
Sets up TDM Gateway service on the IP host using the supplied "-pktrate", "ctgsvr", and
"lineaid" parameters.
Note: Reference "ctg add" command.
ctg setup
Usage
ctg setup [-pbit=] [-dhcp=<enum>] [-ping=<enum>] [-tracert=<enum>]
[-rsh=<enum>] [-staticip=<ipaddr>]
[-mask=<ipaddr>] [-gwf=<enum>] [-gateway=<ipaddr>] [-pktrate=<enum>] [linemode=<enum>] [lossplan=<enum>] vid= board=<enum> port=<n> ctgsvr=<ipaddr> lineaid=<str>
Setup C7 TDM Gateway service along with the corresponding IP host and VLAN bridge (for CMS provisioning)
287
Options
-pbit=
PBIT value to be applied to frames (0..7, default = 0), ignored if VLAN

bridge is already created
type: Unsigned
-dhcp=<enum>
DHCP enable/disable, default=enable

-ping=<enum>

-tracert=<enum>

-rsh=<enum>
Telnet/rsh enable/disable, default = disable
-staticip=<ipaddr>
type: IP Address
-mask=<ipaddr>
type: IP Address
-gwf=<enum>

-gateway=<ipaddr>
IP Host Gateway Address, must be same subnet as <-staticip>, must

specify <-dhcp disable>and <-mask>
type: IP Address
-pktrate=<enum>
Voice Packetization Rate

type: 10ms, 20ms
-linemode=<enum>
POTS port line mode: Loop start or Ground Start

type: LoopStart, GroundStart, default=LoopStart*
Note: Both values are case sensitive
-lossplan=<enum>
Voice port loss plan

Type: GR909, ANSI
Note: Both values are case sensitive
288
Parameters
vid=

type: Unsigned
board=<enum>
Board (SLC) ID
port=<n>
POTS Port number

type: Integer (0-7)
ctgsvr=<ipaddr>
IP Address of C7 TDM Gateway server on VIPR card

type: IP Address
lineaid=<str>
Line CRV in C7 AID format

* - If loopstart is the desired linemode, this command can be omitted.
289
ctg add
The "ctg add" command is used to create the TDM Gateway phone service on a binding
post. This command is run after the IP Host has been created.
ctg add
Usage
ctg add [ctgsvr=<ipaddr>] [-pktrate=<enum>] [linemode=<enum>] [-lossplan=<enum>] board=<enum> port=<n>
iphost=<n> lineaid=<str>
Add C7 TDM Gateway service to an existing IP host.
Options
-ctgsvrs=<ipaddr>
IP Address of C7 TDM Gateway server on VIPR card

type: IP Address
-pktrate=<enum>
Voice packetization rate

type: 10msec, 20msec
-linemode=<enum>
POTS port line mode

type: LoopStart, GroundStart Default=LoopStart*
-lossplan=<enum>
Voice port loss planh

type: GR909, ANSI
Parameters
board=<enum>
board=<enum>
port=<n>
POTS Port number

type: Integer (0-7)
iphost=<n>
IP Host index
type: Integer (0-7)
lineaid=<str>
Line CRV in C7 AID format

* - If Loopstart is the desired linemode, this command can be omitted.
290
h248 add
The "h248 add" command is used to create the H.248 voice service. This command should
run after the IP Host (on page 256) has been created.
h248 add
Usage
h248 add [-pbit=<n>] [-dscp=<n>] iphost=<n> udpBasePort=<n> mgcAddr=<str> mgcAddr2=<str>
termPrefix=<str> ephemPrefix=<str> maxActCall=<n> percallTerm=<n> switchtype=<enum>
adminState=<enum>
Add H248 Gateway service to existing IP host
Options
-pBit=<n>
PBit value used (0 - 7, default = 5)

Type: Integer
-dscp=<n>
IP DSCP value to be used (default = 46)

Type: Integer
Parameters
iphost=<n>
IP Host index used for H.248

Type: Integer
udpBasePort=<n>
RTP UDP base port (default=3000)

Type: Integer
mgcAddr=<str>
IP Address/Domain name of primary Media Gateway Controller

Type: Character String (48)
mgcAddr2=<str>
IP Address/Domain name of secondary Media Gateway Controller

termPrefix=<str>
Termination prefix appended to each TermID (default = "TP")

ephemPrefix=<str>
String to identify ephemeral terminations (Default = "RTP")

maxActCall=<n>
Maximum number of active calls

Type: Integer
perCallTerm=<n>
Maximum number of allowed terminations in context

Type: Integer
switchType=<enum>
Switch type of primary Media Gateway Controller

Type: None, CS-2000, CS-1500, Metaswitch, Sonus, Genband-G2,
Genband-G9
adminState
Administrative state of the Media Gateway

Type: disabled, enabled
291
mgcp add
The "mgcp add" command is used to create the Media Gateway Controller Protocol voice
service. This command should run after the IP Host (on page 256) has been created.
mgcp add
Usage
mgcp add [-pbit=<n>] [-dscp=<n>] [-retrytimeout=] [-restartdly=] [-persistEvt=<enum>] [persistEvtFlashhook=<enum>] [-persistEvtOnhook=<enum>] [-persistEvtOffhook=<enum>] [-rfc2833=<enum>]
iphost=<n> udpBasePort=<n> mgcAddr=<str> mgcAddr2=<str> eptPrefix=<str> adminState=<enum>
Add MGCP service to existing IP host
Options
-pBit=<n>
PBit value used (0 - 7, default = 5)

Type: Integer
-dscp=<n>
IP DSCP value to be used (default = 46)

Type: Integer
-retrytimeout=
Media Gateway retry timeout

Type: Unsigned
-restartdly=
Media Gateway restart delay

Type: Unsigned
-persistEvt=<enum>
This option not currently available.

Type: enable, disable
-persistEvtFlashook=<enum>
MGCP persistent event Flashhook enable or disable

-persistEvtOnhook=<enum>
MGCP persistent event Onhook enable or disable

-persistEvtOffhook=<enum>
MGCP persistent event Offhook enable or disable

-rfc2833=<enum>
Support for RFC2833 signaling for MGCP. Default=disabled.

292
Parameters
iphost=<n>
IP Host index used for MGCP

Type: Integer
udpBasePort=<n>
RTP UDP base port (default=3000)

Type: Integer
mgcAddr=<str>
IP Address/Domain name of primary Media Gateway Controller

Note: When provisioning MGCP services, both the Global MGCP
Gateway Profile and the actual ONT media gateway value must be
specified as FQDN or IP Address. In other words, if the Global MGCP
Gateway Profile specifics an FQDN, then the ONT media gateway must
also use FQDN.
mgcAddr2=<str>
IP Address/Domain name of secondary Media Gateway Controller

Note: When provisioning MGCP services, both the Global MGCP
Gateway Profile and the actual ONT media gateway value must be
specified as FQDN or IP Address. In other words, if the Global MGCP
Gateway Profile specifics an FQDN, then the ONT media gateway must
also use FQDN.
eptPrefix=<str>=<str>
String identifying the prefix to be prepended to each endpoint

(default="aaln")
adminState
Administrative state of the Media Gateway

Type: disabled, enabled
293
voip del
The voip del command is used to delete the voice service on a binding post (SIP or TDM).
Note: The voip del command can be used to delete SIP, TDM Gateway, H.248, or MGCP
voice port provisioning.
voip del
Usage
voip del board=<enum> port=<n>
Delete VoIP ports (SIP, TDM Gateway, H.248, MGCP)
Parameters
board=<enum>
Board (SLC) ID
port=<n>
POTS port number

type: integer (0,7)
294
IPTV Commands
The following commands are available for provisioning IPTV within the system.
Video Profile commands

Per port channel limiting
Provisionable query interval
Per port Multi-cast to Uni-cast control (m2u)
Note: Supported on 700GX and 76xGX ONTs only
MVR Provisioning
Multi-cast range filtering (IGMP joins outside the Multi-cast range are dropped).
Video Profiles
The video profile command contains attributes that control per-port channel limits, query
intervals, and m2u controls.
Note: Multicast to unicast (m2u) functionality is only supported on 7xxGX and 76xGX
ONTs.
videoprofile create
Usage
videoprofile create [-maxchannels=] [-queryinterval=] [-m2u=<enum>] name=<str>
Create a video service profile for IPTV
Options
-maxchannels=
Sets maximum number of channels that can be joined (0 = no limit).

type: Unsigned (0 - 512)
-queryinterval=
Router query interval (in seconds)

type: Unsigned (30 - 3600)
-m2u=<enum>
Enable Multicast to Unicast conversion? True = 1, False = 0

type: enum
Parameters
name=<str>
Provide a video profile name

type: charstring (14)
295
Additional Supported Commands

Action
videoprofile delete name=<str>
Result
Delete an existing video profile
Action
videoprofile show
Result
Displays all video profiles created
296
Multicast VLAN Registration (MVR) Provisioning Commands

Multicast VLAN Registration profiles identify the optional MVR address ranges associated
with specified multicast VLANs. This feature allows for distribution of multicast traffic on a
dedicated multicast VLAN across separate access networks, while allowing subscribers who
are on different VLANs to join and leave the multicast groups carried in the Multicast
VLAN. MVR works in conjunction with IGMP. The subscriber continues join and leave
multicast groups via IGMP. However, both the IGMP messages and multicast content are
mapped from the subscribers service into the isolated network multicast VLAN. The E7
GPON ONT supports the ability to map the subscribers IGMP and multicast traffic into
multiple network multicast VLANs.
MVR allows the downstream video content to flow from one or more VLANs that are
separate from the set-top control VLAN. This is beneficial in instances where a set-top
control VLAN bridge is created to classify all traffic from the set-top-boxes, including
IGMP. With MVR enabled, the VLAN is changed on the IGMP packets before packets are
sent upstream. The corresponding video content then flows downstream on the MVR
VLAN.
For a given video VLAN, up to 4 MVR VLANs can be defined. In addition, each MVR
VLAN can contain up to 4 multicast ranges. An upstream IGMP has its VLAN changed
based on matching one of these MVR multicast ranges.
This command creates an MVR profile (on page 300)
mvrprofile create
Usage
mvrprofile create vlan=
Create a new MVR profile to support downstream video on a specific VLAN
Options
vlan
Define VLAN ID for transporting downstream video

type: unsigned
Additional MVR Commands

Action
mvrprofile delete vlan=
Result
Deletes an mvrprofile)
297
Action
mvrprofile add vlan= mvrvlan=
Result
Adds an MVR VLAN to an existing profile
Action
mvrprofile remove vlan= mvrvlan=
Result
Removes an MVR VLAN from an existing profile.
Action
mvrprofile set vlan= mvrvlan= index= ipstart=<ipaddr>
ipend=<ipaddr>
Result
Establishes a range for a given MVR VLAN. Up to 4 ranges can be specified per MVR
VLAN. Ranges cannot overlap within a given MVR profile, in other words, a given range
must uniquely identify a particular MVR VLAN. One MVR VLAN can contain a range
specified as ipstart=0.0.0.0 and ipend=0.0.0.0. Unspecified IP addresses act as a wildcard and
match any range not otherwise given
Action
mvrprofile clear vlan= mvrvlan= index=
Result
Clears a range for a given MVR VLAN
Action
mvrprofile show
Result
Displays the defined MVR profiles
298
Multicast Range Filters

Multicast ranges act as "allow" filters and are setup on a per video VLAN basis. The video
VLAN is the "vid" specified in the bridge setup command (where IGMP snooping is
enabled).
mcrange create
Usage
mcrange create vlan=
Create a multicast range associate with a video vlan
Parameters
vlan=
VLAN ID (0 - 4094)
type: unsigned
Additional Supported Commands

Action
mcrange delete vlan=
Result
Delete an existing multicast range
Action
mcrange set vlan= index= ipstart=<ipaddr> ipend=<ipaddr>
Result
Sets a range at the specified index value starting and ending IP addresses.
Note: Up to 8 ranges are supported per video VLAN.
Action
mcrange clear vlan= index=
Result
Clears a specified range of multicast range filters
Action
mcrange show
Results
Displays all currently defined multicast ranges
299
Enable Multicast to Multicast Mode (default)

The multi mode multicast function sets the Ethernet ports to multicast to multicast mode.
multi mode multicast
Usage
multi mode multicast <dev>
Set ethernet port multicast mode to multicast to multicast
Parameters
dev

Enable Multicast to Unicast Mode

The multicast to Unicast mode sets the Ethernet ports to unicast from multicast mode.
Note: The multi mode unicast command is not currently supported on 700GE ONTs.
multi mode unicast
Usage
multi mode unicast <dev>
Set ethernet port multicast mode to multicast to unicast
Parameters
dev

300
Show Multicast or Unicast Modes

The following command displays the current mode setting for all Ethernet ports on the
ONT.
Usage: multi mode show
dev
mode
-----
-------
eth-0
unicast
eth-1
multicast
Multicast VLAN Registration (MVR) Provisioning Examples

Creating an MVR Bridge
In order to support (MVR), separate bridges must be created for each MVR VLAN.
Note: IGMP snooping must be enabled on MVR VLAN bridges.
This example shows how to setup a video VLAN 800 using VLAN 26 as the MVR VLAN.
To create an MVR bridge
1. Create a basic video profile specifying max channels and query interval
video create maxchannels 16 queryinterval 240 name=basic
2. Create a multicast address ranges for allowed channels

mcrange set vlan=800 index=1 ipstart=238.0.0.0 ipend=239.255.255.255
3. Create an MVR profile to support downstream video on VLAN 26

mvr create vlan=800
mvr add vlan=800 mvrvlan=26
mvr set vlan=800 mvrvlan=26 index=1 ipstart=0.0.0.0 ipend=0.0.0.0
4. Create the bridge associated with the video VLAN 800

bridge setup snoop enabled video basic vid=800 dev=eth-0
5. Create the bridge associated with the MVR VLAN 26

bridge setup snoop enabled vid=26 dev-eth-0
301
MVR Video Profile for Untagged CPE

[root@k2intsolsrv1 video]# cat MvrVideo_5Channels.cfg
[CALIX_AE_ONT:R1]
#
# Example MVR Video profile for untagged CPE
#
#
MVR Video Script parameters:
#
$0 = Subscriber Unicast Video VLAN assigned for this subscriber
#
#
500 = Video VLAN delivering all multicast video content
#
#
Create subscriber unicast video VLAN
mvrprofile create vlan=$0
#
Associate the unicast VLAN with the MVR VLAN
mvrprofile add vlan=$0 mvrvlan=500
#
Create multicast allow range (Do not need if full range is allowed)
mcrange create vlan=$0
mcrange set vlan=$0 index=1 ipstart=224.0.1.0 ipend=239.255.255.255
#
Add multicast allow range to allow all multicast addresses
mvrprofile set vlan=$0 mvrvlan=500 index=1 ipstart=0.0.0.0
ipend=0.0.0.0
#
Create a video profile to limit streams and set query interval
videoprofile create -maxchannels=5 -queryinterval=180 -m2u=false
name=5_Channels
#
Create bridge associated with unicast video VLAN
bridge setup -vprofile=5_Channels -snoop=enable -macff=enable vid=$0
dev=$1
#
Create bridge associated with MVR VLAN
bridge setup -snoop=enable vid=500 dev=$1
#
#
include inc/video_oui.cfg $0 $1
Notes on Above Configuration
All multicast content is expected on VLAN 500 of the AE ONT WAN interface
The VLAN for all unicast content is specified based on an input from the CMS GUI.
By using the VLAN variable, it allows the user to specify multiple unicast video
VLANs. If you have a large video subscriber base, this would be the optimal method
of configuration since it is likely multiple unicast video VLANs would be available on
a geographic basis. If not, the $0 variable could be removed and simply hard coded;
thus, ignoring the VLAN value passed in via the CMS GUI.
When an IGMP message is received from the CPE, the IGMP snooping code adds a
tag of VID 500 and sends the REPORT, LEAVE, and the like upstream.
By using the Level 1 L2 map/filter, all untagged traffic that matches the specified
video OUI is directed to the unicast video VLAN unless it is multicast content.
302
Ranges cannot overlap within a given MVR profile, in other words, a given range
must uniquely identify a particular MVR VLAN. One MVR VLAN can contain a
range specified as ipstart=0.0.0.0 ipend=0.0.0.0. This acts as a wildcard and matches
any range not otherwise given.
MVR Video Profile for Tagged CPE

[root@k2intsolsrv1 video]# cat MvrVideoVid700_5Channels.cfg
[CALIX_AE_ONT:R1]
#
# Example MVR Video profile for tagged CPE
#
#
#
#
#
#
#
#
#
#
Add multicast allow range to allow all multicast addresses
ipend=0.0.0.0
#
name=5_Channels
#
dev=$1
#
Create bridge associated with MVR VLAN
#
# Add a Level 2 L2 tag action to handle the tagged traffic from the RG
# and change the priority bit to a more appropriate value
#
lev2l2tag add -filtinvid=700 -treatinvid=$0 -treatinpri=3 dev=$1
303
All multicast content is expected on VLAN 500 of the AE ONT WAN interface.
When an IGMP message is received from the CPE, the IGMP snooping code adds a
tag of VID 500 and sends the REPORT, LEAVE, and the like upstream.
must uniquely identify a particular MVR VLAN. One MVR VLAN can contain a
range specified as ipstart=0.0.0.0 ipend=0.0.0.0. This acts as a wildcard and matches
any range not otherwise given. One MVR VLAN can contain a range specified as
ipstart=0.0.0.0 ipend=0.0.0.0. This acts as a wildcard and matches any range not
otherwise given.
This method allows a customer to deploy all residential gateway devices preconfigured with a video VLAN of 700 and the tag action changes all unicast content
to the specified VLAN and uses a pre-determined priority.
Snooping is required on each MVR VLAN.
304
Multiple MVR VLANs for Untagged CPE

[root@k2intsolsrv1 video]# cat MvrVideo_SD_HD_5Channels.cfg
[CALIX_AE_ONT:R1]
#
# Example Multiple MVR VLANs Video profile for untagged CPE
#
#
#
#
#
#
#
#
#
#
SD Content
#
HD Content
#
Add multicast allow range to specify multiple MVR VLANs
#
SD Content
ipend=227.255.255.255
#
HD Content
ipend=235.255.255.255
#
name=5_Channels
#
dev=$1
#
Create bridge associated with MVR VLANs
#
#
include inc/video_oui.cfg $0 $1
305
All SD multicast content is expected on VLAN 500 on the ONT WAN interface.
All HD multicast content is expected on VLAN 600 on the ONT WAN interface.
When an IGMP message is received from the CPE, the IGMP snooping code will
add a tag for VID 500 or VID 600 and send the REPORT, LEAVE, and like
messages upstream to the appropriate VLAN based on the DA of the IGMP frame.
must uniquely identify a particular MVR VLAN.
A separate bridge is required for each MVR VLAN.
Snooping is required on each of the MVR VLANs.
306
MVR Video Configuration on an ONT

The example below depicts a typical video set-up using the MVR model of video
provisioning. The commands displayed in italic pertain to the MVR video setup.
CXNK0006CDA0> hist
1 config syslog setup
-prisvr=172.16.73.1
-secsvr=172.16.73.1
2 config trap sink
-s1=172.16.73.1
-s2=172.16.73.1
community=public
3 config ntp update
-prisvr=172.16.73.1
-secsvr=172.16.73.1
offset=-21600
4 config upgrade
-prisvr 172.16.73.1
-secsvr 172.16.73.1
downok
filename=calix_ae_700sfu_r1.1.2.1.rto
5 config label set label="711GE"
6 bridge setup -mf=enable -macff=enable -dcir=100000000 -dpir=100000000
-ucir=10000000 -upir=10000000 vid=125 dev=eth-0
7 lev2 add -treatinpri=0 -treatinvid=125 dev=eth-0
8 mvrprofile create vlan=225
9 mvrprofile add vlan=225 mvrvlan=500
10 mcrange create vlan=225
11 mcrange set vlan=225 index=1 ipstart=224.0.1.0 ipend=239.255.255.255
12 mvrprofile set vlan=225 mvrvlan=500 index=1 ipstart=0.0.0.0
ipend=0.0.0.0
13 videoprofile create -maxchannels=5 -queryinterval=180 -m2u=false
name=5_Channels
14 bridge setup -vprofile=5_Channels -snoop=enable -macff=enable vid=225
dev=eth-0
15 bridge setup -snoop=enable vid=500 dev=eth-0
16 lev1 add
-filtmac=sa
-filtmacmask=ff:ff:ff:00:00:00
filtmacmatch=00:02:02:00:00:00
-treatinpri=4
-treatinvid=225
dev=eth-0
17 voip setup -pbit=5
-gwf = disable vid=95 board=i-pots port=0
display="GE ONT" file=inc/VoipConfig.txt prisvr=172.16.74.1
secsvr=172.16.74.1 user="1002" password="1002" uri="1002"
18 set iftable adminstatus index=eth-0 adminstatus=up
Note: For additional information on video provisioning, refer to the appropriate command
307
MVR Provisioning Examples

Commands required to provision MVR Video services are recapped here with example
syntax:
Video Profile Create - establishes a multi-cast profile for use by the ONT. Controls port
channel limits, query intervals, and m2u controls.
name="@30_Stream_MVR"
Multicast Range Filter - establishes a range of allowable IP addresses for use by the
specified VLAN
mcrange set vlan=127 index=1 ipstart=224.0.0.1 ipend=239.255.255.255
MVR Profile - creates a downstream video VLAN assignment

MVR Profile Add - Adds an MVR VLAN to an existing VLAN

mvrprofile add vlan=127 mvrvlan=3000
MVR Profile Set - Establishes a range for an MVR VLAN. 0.0.0.0 acts as wild card and
match all possible values.
mvrprofile set vlan=127 mvrvlan=3000 index=1 ipstart=0.0.0.0
ipend=0.0.0.0
Bridge setup - Binds the specified Ethernet port to the global multicast VLAN ID
bridge setup -vprofile="@30_Stream_MVR" -snoop=enable vid=3000
dev=eth-0
Bridge setup - Binds the specified Ethernet port to the downstream video VLAN
bridge setup -snoop=enable -macff=enable -vprofile="@30_Stream_MVR"
-attach=vlan vid=127 dev=eth-0
Option-82 syntax - Enables Option-82 circuit ID and remote ID strings (if DHCP
snooping is enabled for video)
opt82 set string -circuitid="716 %iftype %ontport :%vlan" remoteid="%desc" vid=127
opt82 enable remoteId -desc="Calix AE ONT 716" vid=127
308
Service Tag Actions - Defines untagged match rules for the Ethernet Port
lev1l2tag add -filtmac=sa -filtmacmask=FF:FF:FF:00:00:00 filtmacmatch=00:03:91:00:00:00 -treatinpri=4 -treatinvid=127
dev=eth-0
dev=eth-0
dev=eth-0
Enable the Ethernet Interface - Administratively enable (up) or disable (down) the
Ethernet port
set iftable powermanagement index=eth-1 status=up
The following is an excerpt from an ONT configuration file (for example,

CXNK00030565.cfg). The section shown below relates to video service provisioning in an
MVR environment, where the ONT has MVR video services provisioned on both eth-0 and
eth-1.
Note: Row numbers on the left are included for clarity in the related discussion section
below.
09
10
11
12
13
14
15
16
17
18
19
20
21
videoprofile create -maxchannels=30 -queryinterval=240 m2u=false name="@30_Stream_MVR"

mcrange set
vlan=127
index=1
ipstart=224.0.0.1
ipend=239.255.255.255
mvrprofile add
vlan=127
mvrvlan=3000
mvrprofile set
vlan=127
mvrvlan=3000
index=1
ipstart=0.0.0.0
ipend=0.0.0.0
bridge setup
-vprofile="@30_Stream_MVR"
-snoop=enable
vid=3000
dev=eth-0
bridge setup -snoop=enable
-macff=enable vprofile="@30_Stream_MVR" -attach=vlan vid=127 dev=eth-0
lev1l2tag add
-filtmac=sa
filtmacmask=FF:FF:FF:00:00:00
-treatinpri=4
treatinvid=127
dev=eth-0
lev1l2tag add
-filtmac=sa
-treatinpri=4
treatinvid=127
dev=eth-0
lev1l2tag add
-filtmac=sa
-treatinpri=4
treatinvid=127
dev=eth-0
set iftable powermanagement
index=eth-0
status=up
bridge setup
-vprofile="@30_Stream_MVR"
-snoop=enable
vid=3000
dev=eth-1
309
22
23
24
25
26
bridge setup -snoop=enable

-macff=enable vprofile="@30_Stream_MVR" -attach=vlan vid=127 dev=eth-1
lev1l2tag add
-filtmac=sa
-treatinpri=4
treatinvid=127
dev=eth-1
lev1l2tag add
-filtmac=sa
-treatinpri=4
treatinvid=127
dev=eth-1
lev1l2tag add
-filtmac=sa
-treatinpri=4
treatinvid=127
dev=eth-1
set iftable powermanagement
index=eth-1
status=up
In the above configuration, upstream STB IGMP packets from eth-1 are allowed in the
Multicast VLAN 127. In the downstream direction, IGMP general queries are sent onto both
eth-0 and eth-1.
Note: Verify the IGMP packet behavior by running the "show video stats" command against
the ONT.
Pseudowire Commands
Several commands are available for managing PWE3 services.
pwe3 mac
The "pwe3 mac" provides a convenient method for determining the PWE3 MAC address for
MEF. With MEF, you can provision pure Layer-2 services and define destination MAC
addresses instead of destination IP addresses. This command provides an easy way to
determine the PWE3 MAC address of an ONT since the ONT MAC Address is used when
provisioning the "other" end.
Usage: pwe3 mac

Displays the PWE3 MAC address of the ONT being provisioned.
310
pwe3 tdmmode
Prior to provisioning any PWE3 ports or services, you must set TDM services to run in
either T1 or E1 mode.
Note: Upon switching the TDM mode, the ONT automatically resets. The default TDM
mode is T1.
Note: This command must be executed before provisioning any PWE3 ports or services
since running this command sets certain flags for one service type or the other, which may
conflict with previously provisioned parameters.
Usage: pwe3 tdmmode [-mode=<enum>]

Get/Set the TDM operating mode for the ONT.
Options:
-mode=<enum>
T1 or E1
type: t1, e1
pwe3 bridge create

This bridge command is designed to facilitate the following:
Creates the layer 2 bridge on the ONT for carrying all PWE3 traffic between the WAN
interface and the PWE3 Ethernet interface (for example, eth-4).
Defines the VLAN tag for the PWE3 traffic (tagged VLANs are a required element for
PWE3 transport).
Defines the PWE3 traffic p-bit priority (for example, p-bit 7).
Defines the source IP address used for all PWE3 traffic on the ONT.
Note: The ONT PWE3 implementation supports a subnet mask of 255.255.255.0. If the two
ends of the pseudowire (source and destination IP address) are on the same subnet, then a
default gateway is not necessary. If the destination IP address of the pseudowire is on a
different subnet, then the default gateway must be defined for the subnet that the source IP
address resides on.
311
Usage: pwe3 bridge create [staticip=<ipaddr>][-mask=<ipaddr>] [gateway=<ipaddr>] vid= pbit=
Provision the Bridge and static IP address for PWE3 (AE mode
only).
Options:
-staticip=<ipaddr> The static IP address for PWE3 traffic.
type: IP Address
-mask=<ipaddr>
The subnet mask for PWE3 traffic (default
255.255.255.0).
type: IP Address
-gateway=<ipaddr> The default gateway for PWE3 traffic (default
0.0.0.0).
type: IP Address
Parameters:
vid=
The VLAN ID used for PWE3 traffic (1..4094).

PWE3 traffic
must be tagged and should use a unique VLAN.
type: Unsigned
pbit=
The priority of the PWE3 traffic (0..7)
type: Unsigned
Note: Calix recommends entering a high p-bit value for PWE3
services.
312
pwe3 bridge add IP

When provisioning MEF using the bridge create command, it is not necessarily required to
define the local IP address for PWE3 (for example, when provisioning Layer-2 MEF using
the MAC address method for bridge creation). To update an existing bridge that did not
require an IP address at creation, use the pwe3 bridge addip command to define the IP
address after bridge creation.
Usage: pwe3 bridge addip [-mask=<ipaddr>] [-gateway=<ipaddr>]
staticip=<ipaddr>
Add the static IP address to an existing PWE3 bridge. (AE mode only)
Options:
-mask=<ipaddr>
-gateway=<ipaddr>
Parameters:
staticip=<ipaddr>
The subnet mask for PWE3 traffic (default

255.255.255.0).
type: IP Address
The default gateway for PWE3 traffic (default
0.0.0.0).
type: IP Address
The static IP address for PWE3 traffic.

type: IP Address
pwe3 bridge delete

This bridge command deletes the PWE3 bridge on the ONT. Since there is only a single
bridge for PWE3 traffic on the ONT, no other parameters are required.
Note: The bridge cannot be deleted if PWE3 service is provisioned.
Usage: pwe3 bridge delete
Delete the bridge for PWE3 (AE mode only).
313
pwe3 t1port
The T1 port command configures the T1 attributes for the port. The default T1 port settings
satisfy most PWE3 applications.
Note: For this release, PWE3 only supports SAToP encapsulation. As such, only the
"unframed" frame format is required.
Line coding and line build out are T1 physical layer attributes that are dependent upon
the particular application.
The loopbackmode attribute provides capabilities to test the line.
The inbandloopback attribute enables/disables the inband loopback detection
mechanism.
Once the PWE3 service is provisioned, only the loopbackmode, inbandloopback,

linebuildout, and adminstate attributes can be modified.
Usage: pwe3 t1port [-frameformat=<enum>][-linecoding=<enum>]
[-linebuildout=<enum>][-loopbackmode=<enum>]
[-inbandloopback=<enum>][-adminstate=<enum>] port=
Provision the T1 port for PWE3 (AE Mode only).
Options:
-frameformat=<enum>
Frame Format: unframed, esf, sf (default

unframed).
type: unframed, esf, sf
-linecoding=<enum>
Line Encoding: b8zs, ami (default b8zs).
type: b8zs, ami
-linebuildout=<enum>
Line Build Out: 0_110, 110_220, 220_230,
330_440, 440_550, 550_660 (default 0_110).
type: 0_110, 110_220, 220_330, 330_440,
440_550, 550_660
-loopbackmode=<enum>
Loopback Control: none, facility, equipment,
payload (default none).
type: none, facility, equipment, payload
-inbandloopback=<enum> Inband Loopback Enable: disabled, enabled
(default disabled).
type: disabled, enabled
-adminstate=<enum>
Administrative State: enabled, disabled
(default enabled).
Parameters:
port=
T1 Port (1..8)
type: Unsigned
314
pwe3 e1port
The e1port command configures the E1 attributes for the port. The default E1 port settings
satisfy most PWE3 applications.
Note: For this release, PWE3 only supports SAToP encapsulation. As such, only the
"unframed" frame format is required.
Line coding is supported via High Density Bipolar 3 (HDB3) only.

Line buildout does not apply to E1 mode.
The loopbackmode attribute provides capabilities to test the line.
The inbandloopback attribute enables/disables the inband loopback detection
mechanism.
Once the PWE3 service is provisioned, only the loopbackmode, inbandloopback, and
adminstate attributes can be modified.
Usage: pwe3 e1port [-frameformat=<enum>] [-linecoding=<enum>]
[-loopbackmode=<enum>] [-inbandloopback=<enum>] [adminstate=<enum>]
port=
AE Mode - Provision the E1 Port for PWE3.
Options:
-frameformat=<enum>
-linecoding=<enum>
-loopbackmode=<enum>
-inbandloopback=<enum>
-impedance=
-adminstate=<enum>
Parameters:
port=
Frame Format: unframed (default unframed).

type: unframed
Line Encoding: hdb3 (default hdb3).
type: hdb3
Loopback Control: none, facility,
equipment, payload (default none).
type: none, facility, equipment, payload
Inband Loopback Enable: disabled, enabled
(default disabled).
E1 line impedance: 75 or 120 (default
120).
type: Unsigned
Administrative State: enabled, disabled
(default enabled).
T1 Port (1..8).
type: Unsigned
315
pwe3 service create

This service command creates the PWE3 service. This command includes the following
attributes:
The default packet size is set to a value that yields an approximate packet creation time of
1 msec.
The recommended jitter buffer size, assuming negligible network packet delay variation,
is typically 1.5 times the packet creation time. The default of 1500 sec corresponds to
the default packet size.
Defaults are chosen to minimize end-to-end delay for the T1 circuit. For ease of
provisioning, the packet creation time (msec) can be calculated as follows:
packet size 193 (for T1, packet size is divided by 193. For E1, packet size is divided by 256)
Note: The packet size must match at both ends of the pseudowire (source and
destination).
The remotelabel and locallabel parameters are used to associate a particular packet stream
with a T1/E1 port. For UDP/IP, the local/remote labels correspond to the UDP port
numbers. For MEF, they correspond to the ECIDs (emulated circuit IDs). For MEF,
both the local and remote labels are required. For UDP/IP, the local label is required and
the remote label is optional. If only the local label is specified, RFC5087 TDMoIP
protocol is used for the UDP demultiplexing layer. If both the local and remote labels are
specified, RFC5086 CESoPSN protocol is used for the UDP demultiplexing layer. The
UDP demultiplexing layer defines how the UDP port numbers are utilized for PWE3.
Note: All locallabel values (local PW label) must be unique.
The RTP header attribute establishes whether or not RTP headers are added to the
beginning of the packets. If RTP headers are enabled, the RTP mode attribute defines
how the RTP timestamp is generated.
Note: Differential timing (clock recovery) requires differential timestamps and RTP
headers to be enabled. Adaptive timing (clock recovery) requires absolute timestamps and
can be configured with RTP headers either enabled or disabled. Loop timing does not
utilize clock recovery. Instead the T1 receive clock is utilized for timing.
Note: The ONT only supports a single RTP timestamp mode. For clock recovery, all
PWE3 services must be configured for either absolute or differential timing.
316
Usage:
pwe3 service create [-mef=<enum>][destip=<ipaddr>]

[destmac=<mac>][-remotelabel=][-locallabel=]
[-satpacketsize=] [-jitterbuffer=]port=
rtpheader=<enum> rtpmode=<enum> timingmode=<enum>
Provision the PWE3 Service on the T1 Port (AE mode only).

Options:
-mef=<enum>
Enable MEF.8. Default is disabled (transport
using UDP/IP).
type: disable, enable
-destip=<ipaddr>
The destination IP address for this PWE3
service.
type: IP Address
-destmac=<mac>
The destination MAC address for this PWE3
service.
type: MAC Address
-remotelabel=
The remote PW LABEL. For UDP/IP, this is the
UDP port number (1024..65535). For MEF.8, this
is the ECID (1..1048757).
type: Unsigned
-locallabel=
The local PW LABEL. For UDP/IP, this is the
UDP port number (1024..65535). For MEF.8, this
is the ECID (1..1048757).
type: Unsigned
-satpacketsize=
SAToP Packet Size: 80..1450 bytes (default 204
bytes).
type: Unsigned
-jitterbuffer=
Jitter Buffer Size: 1000..512000 usec (default
1500 usec).
type: Unsigned
Parameters:
port=
T1 Port (1..8).
type: Unsigned
rtpheader=<enum>
RTP Header Control: enable, disable.
rtpmode=<enum>
RTP Timestamp Generation Mode: differential,
absolute.
type: absolute, differential
timingmode=<enum>
PWE3 Timing Mode: adaptive, differential,
loop.
type: adaptive, differential, loop
Note: When Layer-2 MEF is enabled, you can include either the destination MAC address or
the destination IP address, but not both.
317
About Demultiplexing Mode

When provisioning locallabel and remotelabel attributes of the pwe3 service create
command, keep the following basic information in mind.
Note: All UDP demultiplexing options conform to RFC 5086 (CESoPSN) and RFC 5087
(TDMoIP). MEF options conform to the ECIDs (Emulated Circuit IDs).
The UDP demultiplexing mode defines how the UDP port numbers in the UDP header
are interpreted. If only the local label is specified, the ONT operates in TDMoIP mode
(as defined by RFC5087). If both the local and remote labels are specified, the ONT
operates in CESoPSN mode (per RFC 5086).
The UDP demultiplexing mode is derived from the first "pwe3 service" that is
provisioned and cannot be changed when PWE3 services are provisioned.
Note: Changing the UDP demultiplexing mode always results in an ONT reset to
activate the changes.
MEF8 is used only if the -mef attribute is enabled in the pwe3 service create command.
TDMoIP Mode
Packets received at the ONT are directed to the proper T1/E1 port if the destination
(DST) = 2142 (the well known TDMoIP port number), and the source (SRC) = local
label (defining which T1/E1 port is being configured).The PW label is always specified in
the SOURCE UDP port field of the UDP header and the DESTINATION UDP port
field is 2142 (TDMoIP). RX/TX: DST=TDMoIP, SRC=label (local=remote).
Packets transmitted to the ONT are sent with DST = 2142 and SRC = local label.
Note: This assumes the PW label is identical at each end of the pseudowire.
CESoPSN Mode
Packets received at the ONT are directed to the proper T1/E1 port if the destination
(DST) = local label, and the source (SRC) = remote label.
The remote PW label is always specified in the DESTINATION UDP port field of the
UDP header while the local PW label is always specified in the SOURCE UDP port field
of the UDP header.
Packets transmitted at the ONT are sent with DST = remote label and SRC = local label.
Note: This follows the more conventional UDP port number strategy.
318
pwe3 service delete

This service command deletes the PWE3 service from the specified T1 port.
Usage: pwe3 service delete port=
Delete the PWE3 Service on the T1 Port (AE mode only).
Parameters:
port= T1 Port (1..8)
type: Unsigned
PWE3 PM Statistics
Bundle Configuration Status
The Bundle Configuration Status command provides a quick summary of the currently
provisioned bundles.
Note: The Bundle ID value is generated internally and is displayed with this command. The
Bundle Configuration Status can be used to get information on specific bundles.
Usage: pwe3 prov get bundle
Summary of
T1 Link
T1 Link
T1 Link
T1 Link
provisioned bundles:
: 1 Bundle ID : 100 (Index
:
:
:
:
0)
1)
2)
3)
SAToP
SAToP
SAToP
SAToP
Alternate: pwe3 prov get bundle -bundle 100

T1 Link : 1 Bundle ID : 100 (Index : 0)
Tx Port#........... 49153
Rx Port#........... 49153
Destination........ 11.1.1.200
Next Hop........... 0.0.0.0
Recovery........... Enabled
RTP................ Disabled
Jitter Buffer...... 1000 usec
Bytes in Packet.... 80
Payload............ Data
SAToP
319
Jitter Buffer Status

The Jitter Buffer Status command displays information for all currently provisioned jitter
buffers. Each provisioned PWE3 service that is provisioned uses a separate jitter buffer.
The provisioned depth of the jitter buffer is what is provisioned via the service command.
This value defines the amount of data to be stored in the jitter buffer to compensate for
network delay variation. The provisioned maxdepth of the jitter buffer is calculated internally
based on the provisioned depth and the provisioned packet size as:
(2 * provisioned depth) + (2 * packet creation time)
When the jitter buffer reaches the maxdepth, an overflow condition occurs (whereby packets
arrive faster than the data is being converted to the TDM stream). When the jitter buffer
reaches 0, an underflow condition occurs (data is being converted to the TDM stream faster
than packets arrive). The min/max/current values represent the status of the jitter buffer at
the time the command was executed. The history low/high values are watermarks of the
highest and lowest the level has gotten since the last time the values were cleared. The values
are cleared via the bundle performance status command that follows.
Usage: pwe3 pm buffer
Jitter Buffer Statistics:
Provisioned
Current
History
----------------- -------------------------- ----------------ID
Depth MaxDepth
Min Current
Max
Low
High
---- -------- -------- -------- -------- -------- -------- -------100
1000
2832
932
1197
1492
808
1512
OK
200
1000
2832
932
1365
1450
704
1450
OK
300
1000
2832
911
1155
1471
683
1471
OK
400
1000
2832
808
1134
1326
642
1326
OK
320
Bundle Performance Status

The Bundle Performance Status command provides a summary of how the bundle is
running.
Note: If the Bundle ID is not specified, all bundles are reported. To report on a specific
bundles performance, enter the Bundle ID number as [-bundle=<enum>]
Usage: pwe3 pm bundle
Bundle PM Summary:
ID T1
Type
----- -- -------100
1
SAToP
TX Packets
-----------31195970
RX Packets
-----------31195970
Alm/Cnt
-------
Recovery
--------------TRACKING 2
200
SAToP
31195967
31195966
TRACKING 2
300
SAToP
31195957
31195958
TRACKING 2
400
SAToP
31195952
31195953
TRACKING 2
Alternate: pwe3 pm bundle -bundle 100

Bundle Statistics : T1 Link : 1 Bundle ID : 100 (Index : 0)
Packets TX Ok.........................32923656
Packets RX Ok.........................32923656
RX Packets Lost.......................0
RX Packets Discarded (overrun)........0
RX Packets Reordered..................0
RX Packets Jumped.....................0
Jitter Buffer Underrun................0
Max Jitter Buffer Level...............1471 (hi - 1512)
Min Jitter Buffer Level...............911 (lo - 808)
Current Jitter Buffer Level...........1134 OK
Packet Creation Time (PCT)............416
Current Packet Delay Variance (PDV)...144
Longest PDV...........................268
Clock Recovery........................TRACKING 2
SAToP
Alternate 2: pwe3 pm bundle clr

Alternate 3: pwe3 pm bundle bundle 100 -clr
Alternate displays the statistics for a specific bundle ID

Alternate 2 clears the statistics for all provisioned bundle IDs
Alternate 3 clears the statistics for a specific bundle ID
321
Bundle Performance Status Notes
A normally running bundle has transmit and receive packet counts that are virtually the
same and incrementing at the same rate.
If Clock Recovery is disabled, recovery is listed as "NO RECOVERY".
The Alm/Cnt column is used to alert the user if any abnormalities have been detected.
The Recovery column displays the current state of clock recovery, if clock recovery is
enabled. The clock recovery states are: IDLE, ACQUISITION, TRACKING 1,
TRACKING 2, RECOVER FROM UNDERRUN/OVERRUN, and NOT ACTIVE. If
clock recovery is disabled, recovery is NOT ACTIVE. When the bundle is provisioned
with clock recovery enabled, the clock recovery state machine will transition from IDLE
to ACQUISITION to TRACKING 1 and finally TRACKING 2. The TRACKING 2
state indicates the clock recovery is fully phase tracking.
Note: It may take several minutes for clock recovery to transition to TRACKING 2 and
significant network delay variation will cause it to take longer.
322
Bundle Error Conditions

The pwe3 alm bundle command provides a summary of the error conditions for all
provisioned bundles. Some conditions may be currently active while others may have been
detected at some point and have cleared (may have to clear the conditions and display again
to determine if conditions are active vs. were detected but have now cleared).
Usage: pwe3 alm bundle
Bundle Alarm Summary:
ID T1
Type Tx-R Tx-L Rx-R Rx-L Dscd Len JBOV JBUN JBRS
----- -- -------- ---- ---- ---- ---- ---- ---- ---- ---- ---100 1
SAToP
200
SAToP
300
SAToP
400
SAToP
Alternate: pwe3 alm bundle -bundle 100

Bundle Alarms : T1 Link : 1 Bundle ID : 100 (Index : 0)
Not Receiving Packets (TX R-bit).............OFF
Local TDM Failure (TX L-bit).................OFF
Local Modifier (TX M-bits)...................OFF
TDM Packet Discard (TX low bundle buffers)...OFF
Packet Length Mismatch.......................OFF
Remote Not Receiving Packets (RX R-bit)......OFF
Remote TDM Failure (RX L-bit)................OFF
Remote Modifier (RX M-bits)..................OFF
Jitter Buffer Overrun........................OFF
Jitter Buffer Underrun.......................OFF
Jitter Buffer Reset..........................OFF
SAToP
Alternate 2: pwe3 alm bundle clr

Alternate 3: pwe3 alm bundle bundle 100 -clr
Alternate displays details for a specific bundle ID

Alternate 2 clears the details for all bundles
Alternate 3 clears the details for a specific bundle ID
323
Ethernet Performance Status

While the ONT does not contain a physical Ethernet port for PWE3, internally the ONT
does contain a switch that directs all PWE3 traffic to the PWE3 chip. The pwe3 pm ethernet
command displays information regarding the aggregate Ethernet interface (all bundle and
control traffic) for the PWE3 chip. The statistics of most value are the counters for the
number of packets being transmitted and received. When the pseudowires are running
normally, these counts will be incrementing at the same rate. The PWE3 chip contains an
extensive packet classifier that determines how received packets are to processed and where
the packets are destined. Any packet that does not satisfy packet classification can be
considered a stray packet. Under normal conditions, the classified packet count will be
incrementing at the same rate as the received packet count. If the unclassified/stray count is
incrementing steadily, then the packet flow to the PWE3 chip is receiving stray packets. Stray
packets are most likely to occur when the far-end of the pseudowire is transmitting prior to
the near-end pseudowire being provisioned (for example, only half of the pseudowire is
provisioned).
Usage: pwe3 pm ethernet

PWE3 Ethernet Statistics
Packets TX OK...................139342032
Packets RX OK...................139342040
Classified Packets (RX).........139342040
unclassified/stray)
Pause Packets RX OK.............0
Pause Packets TX OK.............0
FCS Errors (RX).................0
Alignment Errors (RX)...........0
Single Collisions (TX)..........0
Multiple Collisions (TX)........0
Symbol Errors (RX)..............0
Deferred Packets (TX)...........0
Excessive Length Packets (RX)...0
Underrun (TX)...................0
Jabber Errors (RX)..............0
Excessive Collisions (TX).......0
Undersize Packets (RX)..........0
Late Collisions (TX)............0
IP Checksum Errors (RX).........0
Carrier Sense (TX)..............0
Sequence Test Errors (TX).......0
(934262126 bytes)
(934282186 bytes)
(0
Alternate: pwe3 pm ethernet -clr
All Ethernet statistics can be cleared using the alternate command

324
PWE3 SNMP Support

The ONT in AE mode provides SNMP support for gathering performance monitoring
statistics. The SNMP support includes both enterprise and standard MIBs.
Standard MIBs
The following standards are supported. Refer to the standard RFCs for complete definitions.
RFC 5601 PW-STD-MIB
pwPerfCurrentTable The current 15-minute period.

pwPerfIntervalTable The previous 96 15-minute periods.
pwPerf1DayIntervalTable The current 24-hour period and the previous 24-hour
period.
pwPerfTotalErrorPackets A scalar indicating the total number of packet errors
encountered at the PWE3 interface.
RFC 5604 PW-TDM-MIB
pwTDMPerfCurrentTable The current 15-minute period.

pwTDMPerfIntervalTable The previous 96 15-minute periods.
pwTDMPerf1DayIntervalTable The current 24-hour period and the previous 24-hour
period.
RFC 1406 RFC1406-MIB
dsx1CurrentTable The current 15-minute period.

dsx1IntervalTable The previous 96 15-minute periods.
dsx1TotalTable The previous 24-hour period.
Enterprise MIBs
See AE-PM-TABLE-MIB.mib for complete definitions.
Bundle PM (individual pseudowire PM) Statistics such as packets transmitted and
received and error conditions such as lost packets and jitter buffer underruns.
aePwe3BunCurrent15Table The current 15-minute period.

aePwe3BunInterval15Table The previous 96 15-minute periods.
aePwe3BunCurrent24Table The current 24-hour period.
aePwe3BunInterval24Table The previous 24-hour period.
325
Aggregate PM (aggregate PWE3 interface) Statistics such as packets transmitted and

received and classified packets.
aePwe3AggCurrent15Table The current 15-minute period.

aePwe3AggInterval15Table The previous 96 15-minute periods.
aePwe3AggCurrent24Table The current 24-hour period.
aePwe3AggInterval24Table The previous 24-hour period.
T1 PM Statistics such as ES (errored seconds), UAS (unavailable seconds), and LCV (line
code violations)
aePwe3T1Current15Table The current 15-minute period.

aePwe3T1Interval15Table The previous 96 15-minute periods.
aePwe3T1Current24Table The current 24-hour period.
aePwe3T1Interval24Table The previous 24-hour period.
PWE3 Provisioning Examples

Regardless of what provisioning method used, the TDM mode must be established first.
When provisioning PWE3, services must be created in the following order:
1. The bridge must always be configured first, and only once, on the ONT.
2. The T1 port must be configured (simply enabled if all of the default values apply).
3. The pseudowire service must be created.
Once the three steps above have been accomplished, then and only then can subsequent T1
ports and services be added.
Note: The first time the service is configured, the ONT must ARP for the destination MAC
address prior to establishing the pseudowire connection and passing T1 payload. The ONT
will continue to ARP until either the other end responds or the service is deleted.
326
TDMoIP Mode Example

For the example directly below, the UDP demultiplexing mode is configured to TDMoIP
mode since only the local PW label is specified:
pwe3 tdmmode -mode t1
pwe3 bridge create 101 5 11.1.1.199
pwe3 t1port 1
pwe3 service create -locallabel 2001 1 11.1.1.200 disable absolute
adaptive
pwe3 t1port linebuildout 110_220 2
pwe3 service create -locallabel 2002 2 11.1.1.200 disable absolute
adaptive
The provisioning steps above for t1 transport are summarized in the following table:
Provisioning Example
Command
Function
pwe3 tdmmode - mode t1
The ONT TDM mode is established for T1

transport. This is a one-time only event and
applies to any future services or ports created.
pwe3 bridge create 101 5

11.1.1.199
The bridge is created with the PWE3 traffic

utilizing VLAN 101 with priority 5. The IP
address for the t1 PWE3 traffic on the ONT is
11.1.1.199.
pwe3 t1port 1
The first T1 port is enabled. The port defaults to

unframed, B8ZS, 0-133 feet, no loopback, with
inband loopback detection disabled.
pwe3 service create locallabel 2001 1

11.1.1.200 disable absolute
adaptive
The service on port 1 is created with a default

packet size of 204 bytes and a jitter buffer of
1500 sec. RTP headers are disabled and since
adaptive clock recover is being used, the RTP
timestamp mode is absolute. The far end of the
pseudowire has an IP address of 11.1.1.200 and
uses UDP port number 2001.
pwe3 t1port linebuildout

110_220 2
The second T1 port is enabled. The same

defaults are used except this line assumes a longer
drop so the line build out is specified as 110-240
feet
pwe3 service create locallabel 2002 2

adaptive
The service on port 2 is created identically to the

service on port 1 except the UDP port number is
changed (must be unique to the port).
327
CESoPN Mode Example

In the following example, the TDM mode is set to E1 and the UDP demultiplexing mode is
configured to CESoPSN mode since both the local and remote PW labels are specified:
pwe3
pwe3
pwe3
pwe3
tdmmode -mode e1
bridge create 101 5 11.1.1.99
e1port 1
service create -remotelabel 4000 -locallabel 3000
-satpacketsize 216 1 12.1.1.10 disable absolute adaptive
The provisioning steps above for e1 transport are summarized in the following table:
Provisioning Example
Command
Function
pwe3 tdmmode - mode e1
The ONT TDM mode is established for E1

transport. This is a one-time only event and
applies to any future services or ports created.

11.1.1.199
The bridge is created with the PWE3 traffic

utilizing VLAN 101 with priority 5. The IP
address for E1 PWE3 traffic on the ONT is
11.1.1.199.
pwe3 e1port 1
The first E1 port is enabled. The port defaults

to unframed, HDB3, no loopback, with inband
loopback detection disabled.
pwe3 service create remotelabel 4000 locallabel 3000 satpacketsize 216 1

adaptive
Service is created with a packet size of 216

bytes. Packets are received on UDP port 3000
and transmitted to UDP port 4000.
328
MEF Example
Directly below, MEF provisioning examples are provided for PWE3 services with a known
IP address and services when the MAC address only is specified.
Note: Reference the pwe3 service create command (on page 315) for a complete list of field
definitions.
MEF with IP Address
Note: Local and remote labels are required for MEF
pwe3 bridge create 101 5 11.1.1.199
pwe3 t1port 1
pwe3 service create mef enable destip 11.1.1.200 -locallabel 40000
remotelabel 40001 1 disable absolute adaptive
MEF with MAC Address

pwe3 t1port 1
pwe3 service create mef enable destmac 00:06:31:AB:12:34 locallabel 40000 remotelabel 40001 1 disable absolute adaptive
329
PWE3 Timing Configuration Examples

Note: Calix strongly recommends that you familiarize yourself with PWE3 provisioning by
reviewing the sample configuration file (pwe3_setup.cfg) provided with the AE software
distribution. This file includes notes and full explanations for required provisioning
components.
Loop Timing Example
ONT Specific Configuration File:
[CALIX_AE_ONT:R1]
include inc/common.cfg
include inc/PWE3_51F01.cfg
config label set label="51F01"
PWE3 Configuration File:
[CALIX_AE_ONT:R1]
### Provision the TDM mode of the ONT
### Define the PWE3 IP address, VLAN, and p-bit value. This will create the
### bridge for PWE3.
### pbit is typically 5-7 for PWE3
pwe3 bridge create -staticip=11.11.11.1 vid=10 pbit=5
### Provision the T1 port if TDM mode is T1. Provision the E1 port if TDM
### mode is E1.
### T1 defaults: unframed, B8ZS, 0-133 feet, no loopback, inband loopback
### disabled, admin enabled
pwe3 t1port port=1
### Provision the PWE3 service.
pwe3 service create -destip=11.11.11.2 -locallabel=40001 -remotelabel=30001
port=1 rtpheader=disable rtpmode=absolute timingmode=loop
330
Adaptive Timing Example

ONT Specific Configuration File:
[CALIX_AE_ONT:R1]
include inc/common2.cfg
include inc/PWE3_51ED6.cfg
config label set label="51ED6"
PWE3 Configuration File:
[CALIX_AE_ONT:R1]
### Provision the TDM mode of the ONT
### Define the PWE3 IP address, VLAN, and p-bit value. This will create the
### bridge for PWE3.
### pbit is typically 5-7 for PWE3
pwe3 bridge create -staticip=11.11.11.2 vid=10 pbit=5
### Provision the T1 port if TDM mode is T1. Provision the E1 port if TDM
### mode is E1.
### T1 defaults: unframed, B8ZS, 0-133 feet, no loopback, inband loopback
### disabled, admin enabled
pwe3 t1port port=1
### Provision the PWE3 service.
pwe3 service create -destip=11.11.11.1 -locallabel=30001 -remotelabel=40001
port=1 rtpheader=disable rtpmode=absolute timingmode=adaptive
331
Interface Commands
IfTable Commands
The AE ONT supports the standard MIB-II (RFC 1213) ifTable. Both physical (Ethernet
ports and WAN uplink port) and logical interfaces are defined by the AE ONT. They include
the IP loop-back device and the logical IP Host devices which terminate IP interfaces for use
by VoIP on the ONT. The table is displayed through the sh iftab CLI command.
set iftable adminstatus
The following command is used to administratively enable (up) or disable (down) an
individual Ethernet interface:
Note: All ports affected by this command default to a "down" state.
set iftable adminstatus
Usage
set iftable admin <index> <adminstatus>
Set INTERFACES group ifTable ifAdminStatus object
Parameters
index
type: Interface Name (eth-0, eth-1)
adminstatus
type: up, down
332
Ethert Commands
Various Ethernet commands are available to monitor the physical Ethernet ports.
setethert adminstatus
This command is used to set the desired Ethernet mode in the Ethernet table. In most
general uses, the default mode of "auto" is recommended to configure both sides of the
home/business interface. The 700 AE ONTs are designed to auto-negotiate with MDIX
capability to support both straight through cables or cross-over cables. The command to
explicitly set Ethernet mode is described as follows:
setethert adminstatus
Usage
set ethertable adminmode ifindex=<ifname> adminmode=<enum>
Set ETHER group etherTable etherAdminMode object
Parameters
index=<ifname>
...
type: Interface Name (eth-0, eth-1)
adminmode=<enum>
...
type: unknown, auto, 10-half, 10-full, 100-half, 100-full, 1000-half, 1000-full
IP Host Configuration
IP Hosts are used for Layer-3 services that are terminated at the ONT. By default, the ONT
creates such a service for the first IP Host interface defined in the ONT, for example, iph-0.
The iph-0 Host is used by the ONT for the Management VLAN and may also be used for
SIP if desired. Subsequent IP Hosts are created by the network provider for use in services
such as SIP/VoIP/T1. IP Host interface transfers are not subject to ONT traffic shapers as
discussed in the Metering Commands (on page 263) section of this guide.
Important: IP Host interface transfers are not subject to ONT traffic shapers.
The command used to manage the Layer-3 definition for IP Hosts are described as follows:
333
IP Host Security Considerations

ONT IP Hosts require the use of a gateway router. The router must be resident in the service
provider's VLAN on each ONT IP Host subnet, including the control VLAN. The ONT
always directs packets destined to the WAN from an IP host to each respective IP Host's
gateway, even if the destination is in the same subnet as the IP Host.
Note: ICMP redirects must be disabled on the router interface for the ONT.
The IP Host gateway address is either statically configured or is obtained via the DHCP
server for each IP Host. This feature allows the network provider to set up access control
lists in the gateway to prevent unwanted access to the ONT control plane as well as provide a
means to monitor SIP and control security on call data through the router interface.
If the -gfw option is set to "disable", the IP Host behaves like a normal host. In other words,
if the source and destination IP addresses are in the same subnet, these peers communicate
directly without going through the gateway router.
Note: If two SIP phones on the same ONT communicate with one another, the
communication is confined to the ONT. By default, the ONT control channel (iph-0)
behaves like a "normal" host (-gfw=disable).
334
iphost create
The IP Host used for Layer-3 services destined for the ONT is defined by the IP Host
Create command.
Note: When provisioning downstream static IP service, use the macff set 1 command.
iphost create
Usage
iphost create [-dhcp=<enum>] [-ping=<enum>][-tracert=<enum>] [-rsh=<enum>] [-gwf=<enum>][staticip=<ipaddr>][-mask=<ipaddr>][-gateway=<ipaddr>] dev=<ifname>
Create IP Host
Options
-dhcp=<enum>
DHCP enable/disable, default = enable

-ping=<enum>

-tracert=<enum>

-rsh=<enum>
Telnet/rsh enable/disable, default = enable.
-gwf=<enum>
-staticip=<ipaddr>
type: IP Address
-mask=<ipaddr>

type: IP Address
-gateway=<ipaddr>
IP Host Gateway Address, must be same subnet as <-staticip>, must specify

<-dhcp disable>, and <-mask>
type: IP Address
Parameters
dev=<ifname>
IP Host device name flow (iph-1 - iph-n)

The macff set index command is used to define static IP stations for
use with MACFF security as well as to define static stations/subnets
using IP SRC verification (station validation) without having macff
enabled (see -onlysv).Note: If two unique static addresses are resolved
to the same MAC address during macff set, only the latest association is
maintained. If this should occur, previous static IP and MAC address
associations will not pass upstream traffic.macff set indexUsagemacff
set index= ...
335
iphost delete
To delete an IP Host entry:
iphost delete
Usage
iphost delete dev=<ifname>
Delete IP Host
Parameters
dev=<ifname>

ip host set hostname

The following command sets the hostname string used for DHCP Option-81 resolution
(when DHCP is enabled) and the media gateway hostname (endpoint name). Available for
use on all IP Hosts including iph-0 prior to VoIP configuration.
iphost set hostname
Usage
iphost set hostname dev=<ifname> hostname=<str>
Set the string for the domain name for this IP host, for DHCP Option-81 and media gateway hostname.
Parameters
dev=<ifname>

hostname=<str>
Fully qualified domain name for this IP host, for DHCP Option-81 and Media
Gateway hostname.
336
Serviceability and Troubleshooting Commands

The following commands are useful for obtaining basic information about an ONT while it
is running. These commands may be issued to the ONT via the management utility or
directly by first using telnet to log into the ONT.
Note: Entering a "?" at the ONT command prompt provides a list of all available CLI
commands.
Note: Entering a "??" at the ONT command prompt provides a list of all available CLI
commands with complete multi-level syntax.
bridge show summary (bri sh sum)

This CLI command is used to dump a summary of all bridges configured on an ONT. The
following is a sample output:
bri sh sum
BID
Type
Member
VID
upUcast
dnUcast
upNUcast
dnNUcast
----
-----
--------
----
--------
--------
----------
----------
31
VLANIPH
85
30
VLANPS
300
16
17
Bridge Show Summary Command

Value
Description
BID
The ONT's internal Bridge ID. This is used to display detailed bridge information with the "bri show
bri -bid=x" command (optional).
Type
The type of bridge as it was created
Member
The number or port members on this bridge
VID
The VLAN ID assigned to the bridge
upUcast
The number of unicast packets sent out the WAN side of the bridge
dnUcast
The number unicast packets sent out the subscriber side of the bridge
upNUcast
The number of non-unicast packets sent out the WAN side of the bridge
dnNUcast
The number of non-unicast packets sent out the subscriber side of the bridge
337
bridge show drops (bri sh dr)

This shell command displays all dropped packet counters associated with the Layer-2
bridging functions.
CXNK03010101> bridge show drops
Bridge:
007f2d78
Type:
VLANPP
Members:
3
PonInd:
FALSE
McastUnkDrops: 0
DnNoEthMDrops: 0
Idx
SID
bKuNK
ingress
egress
ponInd
dstSrc
mtu
filtere
l2cp
--0
-----
------
--------
--------
----------
---------
-----
--------
-----
eth
TRUE
16
wan
FALSE
bridge show drops Field Definitions

Value
Description
McastDrops
The number of broadcast/multicast/unknown packets dropped for various reasons.
DnNoEthMDrops
The number of broadcast/multicast/unknown packets received on an PON Connection that were

dropped because no Ethernet port existed as a forwarding member.
Idx
The port number (relative 0) if the port member is a WAN, Ethernet port or IP Host port.
SID
The segment identifier.
BkUnk
The Boolean value indicating whether broadcast/unknown packets can be sent to the port.
ingress
The total number of packets dropped on the ingress side of the interface.
egress
The total number of packets dropped on the egress side of the interface.
ponInd
The number of uni-cast packets dropped which were forward to an ATM port where
ponPortBridgingInd has been set to FALSE.
dstSrc
The count of packets received from an interface where the destination interface has been
determined to be out the same interface it was received on.
mtu
The number of packets dropped at the destination egress side because the packet to be
forwarded exceeded the max MTU provisioned for the port.
filtere
The number of packets dropped due to not matching filter options in Lev1 and Lev2 tables).
Applies to GPON only.
l2cp
The number of l2cp packets dropped on subscriber ingress due to filter/discard options for the
l2cp protocol.
338
bridge show bridges (bri sh bri)
Note: All counters associated with the bri sh bri command are maintained by the software
protocol's forwarding path. They do not reflect packet counts processed by any hardware
forwarding feature associated with the ONT.
The bri sh bri command, executed at the command line, is used to dump detailed
information about all bridges (or a single bridge [-bid=x]) configured at the ONT. An
example of the output is shown below:
CXNK03010101> bri sh bri
Bridge:
026f96e8-1f
Type:
VLANIPH
Members:
2
VID:
0x0055 (0085)
PBIT:
5
learningInd:
TRUE
sub2subFwInd:
FALS
stationValidation:
FALS
DHCPSnoop:
FALS
option82Enabled:
FALS
MacFF:
FALS
igmpSnoopInd:
FALS
filtUpMcastInd:
FALS
DHCPSnoopOffset:
0
station_valid_count:
0
filteredMulticastUp:
0
EthMcastUnkCnt:
0
Idx
SID
----
----
----
iph
NUL
wan
NUL
NUL
Ecp
FCS
BkUn
UP
DP
ucast_in
ucast_out
mcast_in
mcast_out
-----
------
----
----
---------
-----------
-----------
------------
NUL
TRUE
TRUE
Bridge:
Type:
Members:
VID:
PBIT:
learningInd:
sub2subFwInd:
stationValidation:
DHCPSnoop:
option82Enabled:
MacFF:
igmpSnoopInd:
filtUpMcastInd:
DHCPSnoopOffset:
dhcpUpstreamSnoopHits:
dhcpDnstreamSnoopHits:
station_valid_count:
filteredMulticastUp:
EthMcastUnkCnt:
2b17e500-1e
VLANIPH
2
0x0bb9 (3001)
5
TRUE
FALS
FALS
FALS
FALS
FALS
FALS
FALS
0
0
0
0
0
0
339
Idx
SID
Ecp
FCS
BkUn
UP
DP
ucast_in
ucast_out
mcast_in
mcast_out
----
----
-----
-----
------
----
----
---------
-----------
-----------
------------
0
0
eth
wan
NUL
NUL
NUL
NUL
TRUE
TRUE
0
0
0
0
16
17
17
16
1
0
0
1
bridge show bridge Field Definitions

Value
Description
Bridge
This is a unique bridge handle (X) used by the internal mechanisms.
Type
The Bridge type defined for the AE ONT.
Members
The current number of port members. Members are either PON SIDs, Ethernet ports, or
IP Hosts.
VID
The VLAN ID used by this bridge.
PBIT
The PBIT value for an IPHost Bridge (if applicable).
learningInd
Boolean value indicating whether MAC learning is turned on for this bridge.
sub2subFwInd
Allows subscriber to forward packets directly to another subscriber.
stationValidation
Enable/Disable station validation. If stationValidation is true, then MACFF is enabled at

bridge creation.
DHCPSnoop
Enable/Disable DHCP Snooping.
option82Enabled
Indicates whether Option-82 is inserted onto upstream DHCP requests
MACFF
Enable/Disable MAC Forced Forwarding
igmpSnoopInd
Boolean value indicating whether IGMP snooping is enabled.
filtUpMcastInd
Boolean value indicating whether the topion to filter upstream multicast is enabled.
DHCPSnoopOffset
Internal Use Only.
dhcpUpstreamSnoopHits
The number DHCP upstream packets detected during snooping.
dhcpDnstreamSnoopHits
The number of DHCP downstream packets detected during snooping.
station_valid_count
Increments for each successful IP Source verification.
filteredMulticastUp
The number of multicast packets that have been filtered out when "filtUpMcastInd" is
TRUE.
EthMcast UnkCnt
The number of multicast/broadcast/unknown destination packets which have been sent to

the Ethernet port members of the bridge.
Idx
The FPGA connection index if the segment/port is a PON SID or the port number (relative
0) if the port member is an Ethernet port or IP Host port.
SID
The segment Id. If the segment is on the PON side the "wan" are used or the letters "eth"
if the port is an Ethernet port or "iph" if an IP Host port.
Encap
Unused by the AE ONT
FCSId
Unused by the AE ONT
BkUnk
The Boolean value indicating whether broadcast/unknown packets can be sent to the
port.
UP
The Ndab packet upstream send priority. A value of 7 is the highest priority. A value of 0
is the lowest priority.
DP
The Ndab packet downstream send priority. A value of 7 is the highest priority. A value of
0 is the lowest priority.
ucast_in
The number of uni-cast packets received on the interface port.
ucast_out
The number of uni-cast packets sent to the interface port.
mcast_in
The number of multicast/broadcast/unknown packets received on the interface port.
mcast_out
The number of multicast/broadcast/unknown packets sent to the interface port.
340
bridge glob
The bridge glob command displays global forwarding counters not attributed to any
particular bridge.
Executing command "bridge glob"
Global Drop Counters:
ffwd_downstream_no_bridge
ffwd_upstream_no_bridge
ffwd_downstream_no_ports
ffwd_send_error_ae
1181465
0
1086631
3
bridge glob Field Definitions

Field name
Description
ffwd_downstream_no_bridge
Downstream packets dropped without bridge definitions.
ffwd_upstream_no_bridge
Upstream packets dropped without bridge definitions.
ffwd_downstream_no_ports
Downstream packets dropped with no port definitions assigned.
ffwd_send_error_ae
Forwarded packets dropped due to send errors.
341
ip host show
This command is used to display current information about IP Hosts. It displays all allocated
iphost interfaces and any associated VIDs. DHCP lease information is also displayed if the
iphost is configured for DHCP.
Note: Most customer deployments will use DHCP for VoIP iphost interfaces.
Usage: iphost show
U
Vid
MacAddr
CurrIpAddr
CurrMask
CurrGateway
---
----
---
----------
-------------
-----------
----------------
85
00-01-03-01-01-10
10.1.2.3
255.255.0.0
10.1.2.1
Server:172.26.31.3 Lease:120secs Remaining:94secs
iphost show Command

Value
Description
The IP Host unit number.
Vid
The VLAN ID where this IP Host is located.
The PBIT value applied to packets sent from this host.
MacAddr
The IEEE MAC Address of this IP Host.
CurrIpAddr
The static or dynamically obtained IP address of this IP Host.
CurrMask
The subnet mask used by this host.
CurrGateway
The default gateway used to route packets not on this IP Host subnet.
342
iphost options
This command displays which options are currently enabled for all IP Hosts.
Usage: iphost options
Unit
Option
-----
--------
iph-0
DHCP PINGS TRACEROUTE RSH
ver
The "ver command is used to show current software and hardware version information. An
example output is as follows:
CXNK11900011> ver
FiberPoint 720G (2 POTS, 1 GE)
Main Board Mod ID : 78 (0x4E)
Optics Mod ID
: 75 (0x4B)
Exp Board Mod ID : 0 (0x00)
Serial Number
: "0807119000", 0x3080711900011000
[080711900011
]
FSAN Serial No
: CXNK11900011
Software Version : 6.0.z.116
Board Rev
: 1
App Version
: 6.0.z.115 Built Apr 29 2008, 10:59:16
XIP-Boot Version : 6.0.z.1
BootStrap Version : 6.0.z.116
MONT FPGA
: 12.1.0.5
MONT Exp FPGA
: x.x.x.x (not loaded)
343
show ethertable
The sh ethertable command is used to show basic Layer-2 information about an Ethernet port
as follows:
CXNK03010101> show ethertable
I/F
AdminMode
OperMode
PhysAddress
----
---------------
------------
-------------------
eth-0
auto
100-full
00-01-02-03-99-00
eth-1
auto
100-full
00-01-02-03-99-01
iph-0
auto
100-full
00-01-03-01-01-00
iph-1
auto
100-full
00-01-03-01-01-10
iph-2
auto
100-full
00-01-03-01-01-11
iph-3
auto
100-full
00-01-03-01-01-12
iph-4
auto
100-full
00-01-03-01-01-13
wan-4
auto
100-full
00-01-02-03-99-01
Show ethert Command Field Definitions

Value
Description
I/F
The Interface Name
AdminMode
The desired "Ethernet mode" mode of the interface, unknown, auto, 10-half, 10-full, 100-half, 100-full,
1000-half, 1000-full. The default mode for all interfaces is "auto".
OperMode
The current operating Ethernet mode of the interface, unknown, 10-half, 10-full, 100-half, 100-full,
1000-half, 1000-full.
PhysAddress
The IEEE MAC address of the interface
344
show iftable (sh ift)

The following CLI capture shows the display on a 714GX ONT:
CXNK03010101> show iftable
I/F
Type
MTU
Speed
PhysAddress
Admn
Oper
LastChg
----
-----
-----
--------
---------------
--------
------
---------
eth-0
ether
1500
00-01-02-03-99-00
up
up
100
eth-1
ether
1500
00-01-02-03-99-01
up
up
100
loop-0
loop
1500
00-00-00-00-00-00
up
up
100
iph-0
ether
1500
00-01-03-01-01-00
up
up
100
iph-1
ether
1500
00-01-03-01-01-10
up
up
100
iph-2
ether
1500
00-01-03-01-01-11
up
up
100
iph-3
ether
1500
00-01-03-01-01-12
up
up
100
iph-4
ether
1500
00-01-03-01-01-13
up
up
100
wan-0
ether
1500
00-01-02-03-99-01
up
up
100
Show iftable Field Definitions

Value
Description
I/F
The Interface Name
Type
The Interface Type
MTU
The maximum transmission unit of the IP payload
PhysAddress
The IEEE MAC address of the interface
Speed
Unsupported. See "show ethert" to get the current operable link speed.
Admn
The desired administrative state, "up" or "down"
Oper
The operational state. If the "link" is up and the admin state is up the operational state is deemed
"up", otherwise it is deemed down.
LastChg
The time in seconds since "epoch" when the last change in operational state occurred.
345
show ifstats (sh ifs)

The AE ONT supports the standard MIB-II ifStats (RFC 1213) for each interface. These
may be used to determine data flow, lost packets, and the like for serviceability and
debugging by the operator.
CXNK03010101> sh ifs
I/F
InOctets
InUcastPkt
InNUcastPk
outOctets
OutUcastPk
OutNUcastP
----
---------
------------
-------------
----------
------------
------------
eth-0
10864
78
6768
75
15
eth-1
2280
13
20
1334
15
loop-0
32
32
iph-0
iph-1
iph-2
iph-3
iph-4
wan-0
I/F
InDiscards
InErrors
InUnknwnPr
outDiscard
OutErrors
OutQLen
----
-----------
---------
-------------
---------------
----------
--------
eth-0
eth-1
loop-0
iph-0
iph-1
iph-2
iph-3
iph-4
wan-0
346
Show ifstats Field Definitions

Value
Description
I/F
The Interface Name
ifInUcastPkts
The number of subnetwork-unicast packets delivered to a higher-layer protocol.
ifInNUcastPkts
The number of non-unicast (i.e., subnetwork-broadcast or subnetwork-multicast)

packets delivered to a higher-layer protocol.
ifInDiscards
The number of inbound packets which were chose to be discarded even though no
errors had detected to prevent their being deliverable to a higher-layer protocol. One
possible reason for discarding such a packet could be to free up buffer space.
ifInErrors
The number of inbound packets that contained errors preventing them from being
deliverable to a higher-layer protocol.
ifInUnknownProtos
The number of packets received via the interface which were discarded because of an
unknown or unsupported protocol
ifOutOctets
The total number of octets transmitted out of the interface, including framing
characters
ifOutUcastPkts
The total number of packets that higher-level protocols requested be transmitted to a

subnetwork-unicast address, including those that were discarded or not sent.
ifOutNUcastPkts
The total number of packets that higher-level protocols requested be transmitted to a

non unicast (i.e., a subnetwork-broadcast or subnetwork-multicast) address, including
those that were discarded or not sent.
ifOutDiscards
The number of outbound packets which were chosen to be discarded even though no
errors had be detected to prevent their being transmitted. One possible reason for
discarding such a packet could be to free up buffer space.
ifOutErrors
The number of outbound packets that could not be transmitted because of errors.
ifOutQLen
The length of the output packet queue in packets.
347
show ifpowermanagement
In conventional deployments, Ethernet ports are not typically aware of state changes in the
ONT's "Health Management" (HM) system. In Active Ethernet 2.0, support was added to
make ONT Ethernet ports Health Management aware. The show ifpowermanagement
command displays the current state and status of each Ethernet port of the ONT.
The HM state of each Ethernet port is set based on the results of the integrated power
management algorithm.
ifpowermanagement
ONT HM State
normal
5-minute delay
Ethernet Port HM State
N/A
normal
conserve
Less than 5 minutes since

conserve state is started
normal
conserve
Greater than or equal to 5 minutes

since conserve state is started
conserve
Result
CXNK0005DA51> show ifpowermanagement
Power Management for Ethernet Ports
===================================
HM State for ONT: normal
HM State for Eth: normal
Timer for Eth Conserve: idle
index
----eth-0
eth-1
eth-2
eth-3
eth-4
eth-8
normal
-----up
down
down
down
up
down
conserve
-------up
up
up
up
down
down
admin
----up
down
down
down
up
down
oper
---down
down
down
down
up
down
348
show ifpowermanagement Definitions

Value
Description
Index
Ethernet port number
normal
If HM is normal this configured setting will be used to control admin
conserve
If HM is conserve, this configured setting will be used to control admin
admin
Displays the current admin state of the Ethernet port as determined by normal or conserve setting
depending on Health Manager state.
oper
Displays the current operation state of the Ethernet interface as determined by admin and "link" status.
config diag
When executed, the config diag command displays a number of AE system parameters that can
be analyzed for possible corrective action. This command runs a series of scripts that will
often be requested by Calix Service Engineers during the troubleshooting process.
The config diag command outputs the following in sequence:
ver (on page 342) - displays information on the AE ONT being queried.
config history (on page 349) - displays all previously performed configuration commands
("config", "set", "add", "create") for the AE ONT.
show iftab (on page 343) - displays interface, administrative state, and operational state
information for the AE ONT.
show ifstats (on page 344) - displays data flow, lost packets, and the like for serviceability and
debugging by the operator.
mpp rates (on page 381) - displays data (in Mb/sec granularity) and packet rates (in packets per
second) on each interface as observed over the last 5 seconds of operation.
show ethert (on page 342) - displays basic Layer-2 information about the AE ONT Ethernet
port.
bridge show bridge (on page 338) - displays detailed information about all bridges (or a single
bridge [-bid=x]) configured at the ONT.
bridge show drops (on page 336) - displays all dropped packet counters associated with the
Layer-2 bridging functions configured on the ONT.
bridge glob (on page 340) - displays forwarding statistics not attributed to any particular bridge.
349
meter show info (on page 384) - This command summarizes information on each traffic shaper.
It is used as a debugging or sanity check mechanism.
iphost show (on page 340) - This command is used to display current information about IP
Hosts.
mpp ess (on page 381) - displays the ingress and egress Ethernet port statistics by MAC
Address
show voip mib (on page 364) - displays pertinent information for the VoIP service by port.
voipreg (on page 360) - displays the VoIP addressing parameters for each VoIP port.
voiprtp (on page 360) - displays the RTP Packet and error information.
voipcc (on page 359) - displays the current call state by port.
lev1l2tag show eth-0 - displays upstream and downstream tagging history for each Ethernet
port.
lev2l2tag show eth-0 (on page 389) - displays upstream and downstream tagging history for each
Ethernet port if no history is returned from the level1 Layer 2 tag.
Note: mpp queues and mpp show commands are also processed as part of the config diag
script. The outputs of these two commands are for use by system developers only and are
not included here.
350
config history
This command displays all previously performed config commands for the AE ONT. The
file also captures any commands entered from the command line shell.
config history
Executing command "config history"
1
config syslog setup
config trap sink
-prisvr=172.26.31.3
-secsvr=172.26.31.4
config ntp update -prisvr=172.26.31.3 -secsvr=172.26.31.4 offset=-18000
config upgrade -prisvr 172.26.31.3 -secsvr 172.26.31.4 filename=calix_ae_sfu.rto
meter set upstream -cbs=500000 shaper=0 cir=40000000 pir=40000000
meter set downstream -cbs=500000 shaper=0 cir=40000000 pir=40000000
10
11
12
13
14
15
16
17
bridge add -lb=enable -mf=enable vid=2501
18
19
20
meter attach mcastup vid=2501 shaper=10
21
meter attach downstream -vid=2501 shaper=0
22
meter attach upstream -vid=2501 shaper=0
-s1=172.26.31.65 -s2=10.83.1.4
23
24
lev1 add -filtmac=sa -filtmacmask=ff:ff:ff:00:00:00 -filtmacmatch=00:02:02:00:00:00 -treatinpri=4

treatinvid=4090 dev=eth-0
25
lev1 add -filtmac=sa -filtmacmask=ff:ff:ff:00:00:00 -filtmacmatch=00:14:F8:00:00:00 -treatinpri=4 treatinvid=4090 dev=eth-0
26
m2u age 1
27
voip add board=i-pots port=0 iphost=1 display=Name_Line1 file=VoipConfig.txt prisvr=172.26.203.16

secsvr=172.26.203.16 user=7635551012 password=password uri=7635551012
28
voip add board=i-pots port=1 iphost=1 display=Name_Line2 file=VoipConfig.txt prisvr=172.26.203.16

secsvr=172.26.203.16 user=7635551014 password=password uri=7635551014
29
30
show iftab
351
config history
31
show ifstats
32
mpp rates
33
show ethert
34
bridge show bridge
35
bridge show drops
36
mpp queues (system developer use only)
37
bridge glob
38
meter show info
39
meter show count
40
iphost show
41
mpp ess
42
mpp show (system developer use only)
43
show voip mib
44
voipreg
45
voiprtp
46
voipcc
47
lev1l2tag show eth-0
48
lev2l2tag show eth-0
49
config diag
50
show iftab
51
show ifstats
52
mpp rates
53
show ethert
352
Loss Plan Commands

Calix 700GX ONTs include the following Provisionable POTS Loss commands.
Note: When viewing loss plans, plan 1 refers to ANSI, plan 0 refers to GR-909.
Note: Calix 700GX ONTs allow for provisioning (enabling or disabling) of the Non-Linear
Processor (NLP) within the POTS circuit. For 700GE ONTs, NLP is always on and cannot
be disabled.
The following commands are executed from the Command Line Interface.
voice loss show (on page 353) - displays the current loss plan settings for all ports on the
ONT.
voice loss nlp - Display the current NLP setting. This is a global setting for all ports on the
GX ONT.
Example:
CXNK0004B7F1> voice loss nlp
NLP enable: 1
voice loss init plan 1 bp 0 - This reinitializes the 1st port (BP 0) to ANSI (plan 1) on any
700GX ONT. This command does not change the NLP setting.
Example:
CXNK0004B7F1> voice loss init plan 1 bp 0
reinit BP 0:0
Init INF port 0:0 with loss plan 1
Saving reg settings
voice loss set plan 1 bp 0 - This reinitializes the 1st port (BP 0) to ANSI (plan 1) on any
700GE ONT. This command does not change the NLP setting.
Example:
CXNK0006D9A2> voice loss set plan 1 bp 0
set BP 0:0 with loss 1. . .done (0)
voice loss plan 0 bp 0 - This reinitializes the 1st port (BP 0) to GR909 (plan 0). This
command does not change the NLP setting.
353
Example:
CXNK0006D9A2> voice loss plan 0 bp 0
0:0::
0:1::
0:2::
0:3::
0
0
0
0
GR-909
GR-909
GR-909
GR-909
voice loss nlp enable y - This activates the NLP for all subsequent calls (GX ONTs).
Example:
CXNK0005DA51> voice loss nlp enable y
NLP enable now: 1
NLP enable: 1
voice loss nlp enable n - This de-activates the NLP for all subsequent calls (GX ONTs).
Example:
CXNK0005DA51> voice loss nlp enable y
NLP enable now: 0
NLP enable: 0
voice loss show

Executing the voice loss show command yields the following results:
CXNK0006D9A2> voice loss show
0:0::
0:1::
0:2::
0:3::
0
0
1
0
GR-909
GR-909
ANSI
GR-909
Note: When executing this command on a GX ONT, the NLP status (enabled/disabled) is
also displayed.
354
Slot
BP
PLAN #
DESCRIPTION
-----
-----
---------
-----------------
GR-909
GR-909
ANSI
GR-909
voice loss show

Value
Description
Slot
Slot number of the ONT. This is normally slot zero unless ONT has multiple voice cards.
Binding Post
(BP)
Port number of ONT Voice port
Loss Plan
(PLAN #)
Loss Plan
Description
Displays the Loss Plan Number

0 = GR-909, 1 = ANSI
GR-909 or ANSI
show ipconfig (show ipc)

The show ipconfig command displays critical IP information
pertaining to an ONT.
CXNK03010101> show ipc
I/F
Address
NetMask
MHomeIndex
xIndex
-----
-----------
-----------
-----------------
---------
loop-0
127.0.0.1
255.0.0.0
iph-0
192.168.102.2
255.255.255.0
iph-1
192.168.102.3
255.255.255.0
iph-2
192.168.102.4
255.255.255.0
iph-3
192.168.102.5
255.255.255.0
355
The show route command displays IP routing of each ONT interface.

CXNK03010101>show route
IpDest
IpMask
IpNextHop
I/F
Type
Proto
-----
-----------
-----------
------
--------
--------
127.0.0.0
255.0.0.0
127.0.0.1
loop-0
local
local
192.168.102.0
255.255.255.0
192.168.102.2
iph-0
local
local
192.168.102.0
255.255.255.0
192.168.102.3
iph-0
local
local
192.168.102.0
255.255.255.0
192.168.102.4
iph-0
local
local
192.168.102.0
255.255.255.0
192.168.102.5
iph-0
local
local
mgconfig
The following command is useful when troubleshooting H.248 and MGCP voice services:
CXNK08900005> mgconfig
Usage: mgconfig [mgId=<n>] [term=<n>]
Display MGCP/H248 information
Parameters:
mgId=<n>
Display MGCP/H248 information per mgId

type: Integer
term=<n>
Always set term=1, show termination information

type: Integer
Note: If services are not provisioned, "MG 1 not in service" is

returned.
356
Example
CXNK00040C3B> mgconfig
MG Idx
: 0
MG iph
: 1
MG IP
:
MG Domain
:
rtpBase
: 30000
MGC pri IP
:
MGC pri Domain :
MGC sec IP
:
MGC sec Domain :
SwitchType
: none
Term Prefix
: aaln
Epherm TermId
:
Service state
: 1
Max Active calls: 0
Per call termns : 0
eth priority
: 0
ipdscp val
: 0
mgCreated
: 0
mgProvisioned
: 0
assncreated
: 0
primaryTried
: 0
secondaryTried : 0
protoType
: MGCP
endPtPrefix
:
endPtSuffix
:
retryTimeout
: 30
restartDelay
: 1
mgcpPersistEvt : 0
mgConfigRead=0 mgIPAllocated=0
MG Mgmt(1 ): active, dhcpAcquire,
(2042),DHCP,DIS,ASN_DIS(unknown),Retry -- changes:0000-----------------------------------
357
mgconfig Field Definitions

Field Name
Description
MG Idx
Index of the H248/MGCP association in the DCL stack.
MG Iph
IP Host associated with the service
MG IP
IP Address of the Media Gateway
MG Domain
Doman name of the Media Gateway
rtpBase
Base port for the RTP connection
MGC pri IP
IP address of the primary controller
MGC pri Domain
Domain name of the primary controller
MGC sec IP
IP address of the secondary controller
MGC sec Domain
Domain name of the secondary controller
SwitchType
Controller switch type (i.e., Meta, CS15) for H.248
Term Prefix
Termination prefix used for configuring the service
Epherm TermId
Prefix for ephemeral terminations (H.248 only)
Service State
Admin state of the gateway
Max Active calls
Maximum active calls allowed on the gateway
Per call termns
Number of terminations in a call
eth priority
P-bit priority of the service
ipdscp val
DSCP value of the service
mgCreated
Flag to establish whether service is running (DCL Stack created?)
mgProvisioned
Media Gateway provisioning complete?
assncreated
Association is created in the DCL Stack?
primaryTried
Has the Primary controller established a connection?
secondaryTried
Has the secondary controller established a connection?
protoType
Protocol type of the service: MGCP or H248
endPtPrefix
Debug command - not used.
endPtSuffix
Debug command - not used.
retryTimeout
Retry timeout in seconds (delay between switching from primary to

secondary controller)
restartDelay
Send RSIP after the specified delay here (MGCP only)
mgcpPersistEvt
Are persistent events enabled (MGCP only)
mgConfigRead=0
Media Gateway is configured (Y/N)
mgIPAllocated
Does the IP Host have a valid IP address? (Y/N)
358
voipreq
The voipreq command returns registration and IP address information for each port of the
ONT.
Note: Attempts to execute this command on an ONT that has not been configured for VoIP results
in an Invalid Line number error.
Executing command "voipreg"
Line
1: SIP
SIP
SIP
SIP
SIP
SIP
DNS
DNS
SIP
seconds
ONT URI
:
ONT IP
:
Contact IP :
Shadow IP :
Proxy Server:
Domain Name :
Primary
:
Alternate
:
Registration:
7635551012
172.26.203.136
172.26.203.136
172.26.203.136
172.26.203.16
172.26.203.16
192.168.1.27
192.168.1.29
REGISTERED. Period: 60
Re-Registration in 10
Line
ONT URI
:
ONT IP
:
Contact IP :
Shadow IP :
Proxy Server:
Domain Name :
Primary
:
Alternate
:
Registration:
7635551014
172.26.203.136
172.26.203.136
172.26.203.136
172.26.203.16
172.26.203.16
192.168.1.27
192.168.1.29
REGISTERED. Period: 60
Re-Registration in 10
2: SIP
SIP
SIP
SIP
SIP
SIP
DNS
DNS
SIP
seconds
incall attpts:0
incall complts:0
incall busy:0
incall peerdisc:0
incall ontdisc:0
outcall attpts:0
outcall complts:0
outcall busy:0
outcall peerdisc:0
outcall ontdisc:0
359
voipreg Field Definitions

Field Name
Description
SIP ONT URI
The assigned registration ID number for the port.
SIP ONT IP
The IP Address for the port.
SIP PRoxy Server
The IP Address for the SIP proxy server.
SIP Domain Name
The IP Address for the Sip switch.
DNS Primary
The primary DNS IP address.
DNS Alternate
The secondary DNS IP address (optional).
SIP Registration
Displays the Registration state of the port and the length of time
until the next lease renewal.
incall attpts
Total incoming calls received.
incall complts
Total incoming calls completed successfully.
incall busy
Total incoming calls received when the line was busy.
incall peerdisc
Incoming calls disconnected by far end peer (calling party).
incall ontdisc
Incoming calls disconnected by local ONT hangup (on hook).
outcall attpts
Total outgoing calls attempted.
outcall complts
total outgoing calls completed successfully.
outcall busy
Total outgoing calls that received a busy reply.
outcall peerdisc
Total outgoing calls that were disconnected by far end peer

(calling party).
outcall ontdisc
Total outgoing calls disconnected by local ONT hangup (on

hook).
voipcc
The voipcc command displays the current call state by port.
CXNK0002B2E3> voipcc
Line 1:
CCState (1)
IDLE
Msg Waiting: NO
remoteIP
remoteIP2
waitingIP
localport: 16384
crv=0 crvWaiting=0 crvHold=0 Threeway=0

Line2:
CCState(1)
IDLE
MsgWaiting: NO
remoteIP
remoteIP2
waitingIP
localport: 16386
crv=0 crvWaiting=0 crvHold=0 Threeway=0
360
voipcc Field Definitions

Field Name
Description
CCState
Current Call State of the port
Msg Waiting
Message waiting indicator (yes or no).
remote IP
IP address of the inbound calling party.
remote IP2
IP address of any secondary inbound calling party.
waiting IP
IP address of any inbound call in the call waiting queue.
crv
The Call Reference Value (CRV) of the current call.
crvWaiting
The CRV of any inbound call in the waiting queue.
crvHold
The CRV of a current called placed on hold.
Threeway
Status of current three way call. possible states????
voiprtp
The voiprtp command returns VoIP RTP statistics for specific lines on an ONT.
Note: To clear existing counts, run the voiprtp c command.
Note: Append the voiprtp command with the port number (voiprtp 1)
CXNK0006CE1F> voiprtp
voiprtp - Display RTP Packet & error info.
Line 1:
ONT URI: 7632679700

Local IP: 10.75.220.170
Port: 16384
Remote IP: 10.75.220.173
Port: 16386
Channel Port: 16386
QOS: a0
fd = 31 Status:
ACTIVE
SEND RECEIVE
Totals Packets:
Recv
:
588661
Recv Errors:
0 EncodeType: 0 Packet Size=80
Xmit
:
590535
Xmit Errors:
0
Missing :
0
Sequence Errs:
0 Dropouts:
0
Underruns:
0
Listens :
0
Fast_VoIP_Handle: 0 Recv Bad Src Port:
1
Line 2:
ONT URI: N1-1-IG2-182

Local IP: 10.75.222.175
Port: 16386
Remote IP: 10.22.254.4
Port: 49642
Channel Port: 49642
QOS: a0
fd = 32 Status:
ACTIVE
SEND RECEIVE
Totals Packets:
Recv
:
725196
Recv Errors:
0 EncodeType: 0 Packet Size=80
Xmit
:
729648
Xmit Errors:
0
Missing :
0
Sequence Errs:
0 Dropouts:
0
Underruns:
0
Listens :
0
Fast_VoIP_Handle: 0 Recv Bad Src Port:
0
361
voiprtp Field Definitions

Field Name
ONT URI
Description
The assigned registration ID number for the port.
Local IP and UDP Port
Specific port information for receiving RTP voice packets.
Remote IP and UDP Port
Specific port information for sending RTP voice packets.
Channel Port
Port information the service is currently connected to.
QOS
POS/TOS/DSCP setting stamped into the IP RTP voice packet

(TOS/DSCP byte).
fd
Internal file descriptor (GE ONT only)
Status
Port Status for the ONT:

ACTIVE - Line is provisioned
INACTIVE - Line is not provisioned
SEND - Line is enabled to send RTP packets
RECEIVE - Line is enabled to receive RTP packets
Packet Statistics
Recv
Total packets received since last reboot.
Recv Errors:
Total packets received with errors.
EncodeType
Packet Size
Default packets size
Xmit
Total packets sent since last reboot.
Xmit Errors
Total packets received with errors.
Missing
Miss RTP packets for all calls on this line.
Sequence Errs
RTP packets whose RTP sequence number did not match the
expected value for all calls on this line. A value in this field
implies at least one missing packet or packets received were out
of sequence.
Dropouts
Occurrences where 10 or more packets were missing in the

RTP sequence.
Underruns
Receive packet buffer is empty, No packet to play out for this 10

or 20 msec interval.
Listens
Count of RTP Receive trys to get a packet on this port (Activity

counter)
Fast VoIP Handle
Internal file descriptor (GX ONT only). See "fd" above.
Recv Bad Src Port
Count of RTP packets received whose UDP source port does

not match the expected value.
Notes:
All values are running counts since last reboot.
Clear all counters by executing the following: voiprtp c
362
voipconfig
The voipconfig command includes all SIP provisioning parameters for the voice service.
Note: Running the voipconfig command is especially useful when attempting to verify voip
configuration file changes.
CXNK00047A20> voipconfig
Line
2: SIP ONT URI

: 7635551013
SIP ONT IP
: 172.26.203.148
SIP Contact IP : 172.26.203.148
SIP Proxy Server: 172.26.203.16
SIP Domain Name : 172.26.203.16
DNS Primary
: 192.168.1.27
DNS Alternate
: 192.168.1.29
TFTP Primary
: 172.26.203.16
TFTP Secondary : 172.26.203.16
TFTP Filename
: VoipConfig.txt
TFTP Filename
: VoipConfig.txt
SIP Proxy Port : 5060
SIP Registration: ON
SIP Register User: OFF
SIP Registration Period: 3600 sec
SIP T1 Timer: 500 msec
SIP T2 Timer: 4000 msec
Reorder Tone Delay: 10 sec
Warning Tone Delay: 60 sec Warning
Tone Timeout: 600 sec
RTP Base Port: 16384
RTP TOS/DSCP: 160 (0xa0)
RTP Codec: G.711 u-law
RTP Packet Rate: 10 msec
Options: SIP E.164: OFF FlashINFO: OFF E911CalledPartyHold: ON
Call Waiting: ON
CallerID: ON
DTMF playout: ON
Pulse Dial: ON GroundStart: OFF CSIP: OFF
ThreeWayCall: OFF ContactHeaderPort: OFF
Dial Digit Timeout: 8 sec
Dial Plan IntraLATA Area Codes: 952 763 651 612 507 240 561
Dial Plan: ^911|^411|^S[0-9]{2}|^1[0-9]{10}|^[2-9][0-9]{9}|^011[0-9]*T
363
voipconfig Field Definitions

Field Name
Description
SIP ONT URI
SIP Uniform Resource Identifier (typically telephone number)
SIP ONT IP
IP Address of the ONT
SIP Contact IP
Secondary IP Address of the ONT (if used)
SIP Proxy Server
UDP or IP address of the Border Controller or the SIP Proxy Server.
SIP Domain name
IP address or a Fully Qualified Domain Name (FQDN).
DNS Primary
Primary DNS IP Address for the ONT port being provisioned.
DNS Alternate
Secondary DNS IP Address for the ONT port being provisioned.
TFTP Primary
IP Address of Primary TFTP Server
TFTP Secondary
IP Address of Secondary TFTP Server
TFTP Filename
Filename of SIP Configuration file
SIP Proxy Port
UDP Port number for SIP Proxy server
SIP Registration
Enter 0 to disable SIP Registration.
SIP Register
Enter 0 to disable SIP Register.
SIP Registration Period
Enter the maximum registration period for the SIP connection.
SIP T1 Timer
SIP Timer Time-out Values in milliseconds.
SIP T2 Timer
SIP Timer Time-out Values in milliseconds.
Reorder Tone Delay
Enter the delay in seconds before playing a fast busy tone after far end hangup or
far end off hook.
Warning Tone Delay
Enter the delay in seconds before playing a warning tone (howler) for off hook.
Warning Tone Timeout
Enter the amount of time to play the "howler".
RTP Base Port
Input the start port number of a range of ports that are allowed access to the RTP
service. Each ONT VoIP port requires two RTP port numbers.
RTP TOS/DSCP
Enter the TOS bits for RTP packet stamping (0-255)
RTP Codec
Enter the voice encoding option. Always set to zero.
RTP Packet Rate
Input the expected RTP packetization rate sent by the ONT. choose between 10,
20, or 30 msecs.
364
Options
SIP E.164
Format to add the country code to all SIP messages. enter 0 to use local format,
enter 1 to use E.164 global format.
FlashINFO
For Flash Hook messages, send a SIP INFO message.
E911CalledPartyHold
Options to allow E911 hang-up.
Call Waiting
Enter the softswitch signaling pattern for call waiting.
Caller ID
Needed to disable Caller ID at the ONT.
DTMF playout
Enable or disable the playing of the DTMF SIP INFO message.
Pulse Dial
Enable or disable pulse dialing.
GroundStart
Enable GroundStart POTS.
CSIP
Enable or Disable TDM Gateway
ThreewayCall
Allows for configuring 3-way calling.
ContactHeaderPort
Enable or Disable ContactHeaderPort
Dial digit Timeout
Enter a value (seconds) for a partial match "pause" until all digits have been
collected (slow dialers).
Dial Plan IntraLATA Area

codes
Enter area code toll free exceptions.
Dial Plan
Enter the type of dial plan to enable. For additional information, reference the VOIP
Configuration File example.
Note: Any single dial plan string cannot exceed 20 digits.
show voip mib

The show voip mib command displays pertinent information for the VoIP service by port.
Much of this information is also included in the VoIP configuration file.
Executing command "show voip mib"
VoIP data for board:0, port:0
(binding post present)
cfg file pri:VoipConfig.txt
cfg file sec:VoipConfig.txt
cfg srvr pri:172.26.203.16 - sec:172.26.203.16
Reg name:7635551012, password:password
URI:7635551012
display name:Name_Line1
DHCP Profile:0, Opt 82:
static addr:0.0.0.0, mask:0.0.0.0, gateway:0.0.0.0
MAC address:00-06-31-14-38-a0
in-use addr:172.26.203.136, mask:255.255.255.0,
gateway:172.26.203.16
DNS primary:0.0.0.0, DNS secondary:0.0.0.0
rowStatus:active
365
state:registered
status:(a0fd)MAC,DHCP-acq,FILE,EN,PRES,RUN
hook state:on hook, call status:idle
action:(none)
dhcp attpts:1
dhcp acks:1
dhcp nacks:0
reg attpts:72424
reg challenges:868
reg rejects:871
reg grants:72227
incall attpts:0
incall complts:0
incall busy:0
incall peerdisc:0
incall ontdisc:0
outcall attpts:0
outcall complts:0
outcall busy:0
outcall peerdisc:0
outcall ontdisc:0
911 attpts:0
911 complts:0
911 busy:0
911 peerdisc:0
911 onhooks:0
vmwi sub attpts:0
vmwi sub fails:0
vmwi sub succs:0
vmwi notify(msgs):0
vmwi notify(nomsgs):0
rtp pkts sent:0
rtp pkts recv:0
null IPs sent:0
null IPs recv:0
jitter buf oflow:0
jitter buf urun:0
VoIP data for board:0, port:1

(binding post present)
cfg file pri:VoipConfig.txt
cfg file sec:VoipConfig.txt
cfg srvr pri:172.26.203.16 - sec:172.26.203.16
Reg name:7635551014, password:password
URI:7635551014
display name:Name_Line2
DHCP Profile:0, Opt 82:
366
static addr:0.0.0.0, mask:0.0.0.0, gateway:0.0.0.0
MAC address:00-06-31-14-38-a0
in-use addr:172.26.203.136, mask:255.255.255.0,
gateway:172.26.203.16
DNS primary:0.0.0.0, DNS secondary:0.0.0.0
rowStatus:active
state:registered
status:(a0fd)MAC,DHCP-acq,FILE,EN,PRES,RUN
hook state:on hook, call status:idle
action:(none)
dhcp attpts:0
dhcp acks:0
dhcp nacks:0
reg attpts:72434
reg challenges:820
reg rejects:822
reg grants:72254
show voip mib Field Definitions
Field Name
Voip data for board
Description
Displays the binding post and port for the VoIP service
Example: board: 0, port: 1
cfg file pri
Primary configuration file name
cfg file sec
Secondary configuration file name
Example: VoipConfig.txt
Example: VoipConfig_bu.txt
cfg srvr pri
Location of the primary and secondary tftp server.
cfg srvr sec
Example: cfg srvr pri:172.26.203.16

cfg srvr sec: 172.26.203.16
Reg name
VoIP service name and optional password for changing.

Example: 7655551012, password:password
URI
Uniform Resource Identifier.

Example: 7655551012
display name
Name that appears on a caller ID string.
DHCP Profile
Name of DHCP Profile being used for this line.
Example: Name_Line1
Example: dhcp_sip2
static addr
Static, mask, and gateway IP address.

Example: 0.0.0.0, mask: 0.0.0.0, gateway:0.0.0.0
MAC address
MAC address for the DHCP Profile

Example: 00-06-31-14-38-a0
in-use addr
???
Example: 172.26.203.136, mask: 255.255.255.0, gateway: 172.26.203.16
DNS primary and

secondary
Domain Name primary and secondary IP addresses.

Example: DNS primary: 0.0.0.0, DNS secondary: 0.0.0.0
367
hook state
Current hook state and call status.

Example: hook state: on hook, call status: idle
dhcp attpts
Total cumulative usage of the SIP line. This counter increments every 100 seconds a
call is active.
Example: dhcp attps: 59383
dhcp acks
Total cumulative Acknowledgement Packets.

Example: dhcp acks: 4865
dhcp nacks
Total cumulative Negative Acknowledgement Packets.

Example: dhcp nacks: 0
reg attpts
Total registration attempts on the line.

Example: reg attpts: 25889
reg challenges
Total registration challenges on the line.

Example: reg challenges: 0
reg rejects
Total registration rejections on the line.

Example: reg rejects: 0
reg grants
Total SIP REGISTER message requested granted (OK).

Example: reg grants: 1788
incall attpts

Example: incall attpts: 25122
incall complts

Example: incall complts: 24915
incall busy
Total incoming calls received when line was busy.

Example: incall busy: 45
incall peerdisc

Example: incall peerdisc: 9
incall ontdisc

Example: incall ontdisc: 14
outcall attpts

Example: outcall attpts: 94
outcall complts
Total outgoing calls completed successfully.

Example: outcall complts: 125
outcall busy
outcall peerdisc
Total outgoing calls that were disconnected by far end peer (calling party).
Example: outcall busy: 3

Example: outcall peerdisc: 7
outcall ontdisc
Total outgoing calls disconnected by local ONT hangup (on hook).

Example: outcall ontdisc: 4
911 attpts
Emergency 911 Call Attempts on the line.

Example: 911 attpts: 4
911 complts
Emergency 911 Call Attempts completed successfully.

Example: 911 complts: 4
911 busy
Emergency 911 Call Attempts that received a busy reply.

Example: 911 busy: 0
911 peerdisc
Emergency 911 calls disconnected by far end E911 operator.

Example: 911 peerdisc: 0
368
911 onhooks
Emergency 911 Call attempts with local On hook condition.

Example: 911 onhooks: 5
vmwi notify(msgs)
SIP NOTIFY messages received with Messages-Waiting set to Yes.

Example: vmwi notify(msgs): 2
mnwi notify (nomsgs)
SIP NOTIFY message received with Messages-Waiting set to No.

Example: vmwi notify(nomsgs): 0
rtp pts sent
Total RTP Packets sent

Example: rtp pts sent: 25411
rtp pkts recv
Total RTP Packets received

Example: rtp pts recv: 25411
null IPs sent
Total RTP Packets sent with 0.0.0.0 as the destination address (sent to put remote on
hold).
Example: rtpNullIPSent: 17369
null IPs recv
Total RTP Packets received with 0.0.00 for the destination address (sent to put local end
on hold).
Example: rtpNullIPRecv: 579
show voice status

The show voice status command displays the current voice status of all voice ports on the
ONT.
CXNK0006CE93> show voice status
Srvc
---1
2
ConfigStatus ServerStatus
callstate
hookSt iplinesta
------------ -------------- ------------- ------- --------active
registered
idle
onHook active
inactive
none
disabled
onHook inactive
Srvc
---1
2
rtpPktSiz Active911 LocUdpPort

RemIpAddr
RemUdpPort
--------- ---------- ---------- --------------- ---------0
0
49408
0.0.0.0
0
0
0
0
0.0.0.0
0
Srvc
SecRemIpAddr SecRemPort
---- --------------- ---------1
0.0.0.0
0
2
0.0.0.0
0
rtpEncTyp
--------ulaw
ulaw
QoS
--104
0
369
show voice status field definitions
Value
Description
Srvc
The voice port number.
ConfigStatus
The SIP Configuration status. Active (provisioned), Inactive (not provisioned)
ServerStatus
SIP Registration Status of the SIP client. Registered with the SIP server or registration failed due to
invalid Registration number of bad password.
callstate
The current voice port SIP call state: Idle, Ringing, Active, or Disabled.
hookSt
Hook state of the Voice port (OnHook or Offhook).
iplinesta
IP address line state: active (knows it's IP address), inactive (IP address unknown)
rtpEncTyp
RTP encoding type; ulaw (North America) or alaw (International)
rtpPktSiz
RTP Packet Size: 80 10 msec pkts, 160 20 msec pkts
Active911
911 call detected currently active (SIP only)
LocUdpPort
The Local UDP port number in use to receive RTP voice packets.
RemIPAddr
The Remote IP address in use to send RTP packets to.
RemUdpPort
The Remote UDP port number in use to send RTP packets to.
SecRemIPAddr
The Second Remote IP address in use to send RTP packets to. (used for Call Waiting Calls and
Three Way Calls.
SecremPort
The Second Remote port number in use to send RTP packets to. (used for Call Waiting Calls and
Three Way Calls.
QoS
Quality of Service: The RTP TOS/DSCP value used to stamp RTP packets with.
370
show voice errors

The show voice errors command displays voice errors.
CXNK0006CE93> show voice errors
Srvc
---1
2
RecvErrors
---------0
0
XmitErrors
---------0
0
MissingRtp
---------0
0
SequenceEr DropOuts
UnderRuns
---------- ---------- ---------0
0
0
0
0
0
Srvc
Listens RecvComfor
---- ---------- ---------1
0
0
2
0
0
RecvBadSrc
---------0
0
ClrErrs
------idle
idle
show voice errors field definitions

Value
Description
Srvc
The voice port number.
RecvErrors
Count of RTP Packet Receive Errors on this line
XmitErrors
Count of RTP Missing Receive Packets on this line
MissingRTP
Count of RTP Missing Receive Packets on this line
SequenceEr
Count of RTP Receive Sequence Errors on this line
DropOuts
Count of Block( 10 or more) RTP Missing Receive Packets on this line
UnderRuns
Count of No Receive Packet Present on this line
Listens
Count of RTP of Receive trys to get a Packet on this line Activity counter
RecvComfor
Count of RTP Packet Comfort Noise Packets on this line
RecvBadSrc
Count of RTP Source UDP port mismatches in Receive Packets on this line
ClrErrs
371
opt82 show
Executing the "opt82 show" command displays all current opt82 settings.
CXNK0002B65A> opt82 show vid=
Usage: opt82 show vid=
Show defined string/tokens for option82 insertion for specified VLAN
ID
Parameters: vid= WAN side VLAN Id identifying the bridge
type: Unsigned
Note: When executing the opt82 show command on an ONT that has not completed initial
DHCP discovery, the MAC Address string is displayed as 00:00:00:00:00:00.
Example
The output of the opt82 show command before DHCP Discovery
CXNK00040C91> opt82 set string vid=3001 format="macstr"
CXNK00040C91> opt82 enable remote vid=3001 -frame=1stag desc="macstr"
CXNK00040C91> opt82 show vid=3001
CircuitId: ""
RemoteId: "%macstr"
NO option82 CircuitId string has been defined (0)
RemoteId: "00:00:00:00:00:00"
The output of the opt82 show command after DHCP Discovery
CXNK00040C91> opt82 show vid=3001
CircuitId: ""
RemoteId: "%macstr"
NO option82 CircuitId string has been defined (0)
RemoteId: "00:06:31:43:01:1e"
372
os log dump
This command displays the ONT log file as it is persisted in the internal ONT flash. The log
file contains informational text that was logged by the ONT. This command is useful for
debugging configuration issues. Example output of a booted/configured AE ONT is as
follows:
CXNK03010101>os log dump

016, (CXNK11900011) [INFO], Sat Jan 01 00:00:25 2000,
AlarmMgr, Data Port #0 link DOWN(107) being set
017, (CXNK11900011) [INFO], Sat Jan 01 00:00:26 2000,
AlarmMgr, Data Port #0 link DOWN(107) clearing msg. rcvd.
AE Config Host MAC: 00-06-31-07-e6-2a
MONT AE Config Init done
018, (CXNK11900011) [WARNING], Sat Jan 01 00:00:32 2000,
AlarmMgr, , 1401, UPS Missing(58) being set
019, (CXNK11900011) [INFO], Sat Jan 01 00:00:57 2000,
aeconfig, Use default config filename: calix_ont_CXNK11900011.cfg
020, (CXNK11900011) [INFO], Sat Jan 01 00:00:57 2000,
aeconfig, retrieving file calix_ont_CXNK11900011.cfg from
server 172.26.31.3
processing file calix_ont_CXNK11900011.cfg line 3:"explicit -off"
processing file calix_ont_CXNK11900011.cfg line 4:bridge create vlanpp eth0 4001 -lb=enable"
processing file calix_ont_CXNK11900011.cfg line 5:"include

business_gold_eth-0_700.cfg"
021, (CXNK11900011) [INFO], Sat Jan 01 00:00:59 2000,
aeconfig, retrieving file business_gold_eth-0_700.cfg from
server 172.26.31.3
processing file business_gold_eth-0_700.cfg line 3:
"meter set upstream 0 300000000 300000000"

"meter set downstream 0 400000000 400000000"

"meter attach downstream -dev eth-0 0"
373
"meter attach upstream -dev eth-0 0"
022, (CXNK11900011) [INFO], Sat Jan 01 00:01:01 2000,
aeconfig, ONT has been configured successfully
023, (CXNK11900011) [INFO], Sat Jan 01 00:01:26 2000,
AlarmMgr, Data Port #0 link DOWN(107) being cleared
024, (CXNK11900011) [INFO], Sat Jan 01 00:04:03 2000,
, remoteSrvd: Connection request from address: ac1a1f03
025, (CXNK11900011) [INFO], Sat Jan 01 00:05:44 2000,
, Can't get peer name.
026, (CXNK11900011) [INFO], Sat Jan 01 00:05:44 2000,
, remoteSrvd->end_session: Close connection request to
address: 000000000.0.0.0
000, (NMONT) [INFO], Sat Jan 01 00:00:22 2000,
, VidMgr: board presence change = video slot full
172.26.31.3
Note: The "explicit" command is for use by system developers only and should not be
changed.
pmcat
In the event of an ONT software failure, the ONT captures information related to the failure
and stores the information in its FLASH memory. After the ONT reboots, it is possible to
retrieve this information for Calix customer service personal. The following command
provides information to determine whether post-mortem crash information exists:
CXNK03010101> pmcat -h
Checking addr 0xbc820000 for valid dump image: found dump:
UNPROCESSED!
Dump Size
: 59553 bytes (adjusted length: 59553)
....
*
********************************************************************
************
** No Panic Yet **
Uptime.................0 yrs, 0 days, 00:51:52
Panic Task.............OSAB_Shell [panic'd in TASK mode]
Panic Time.............Sat Jan 01 00:52:19 2000Panic
Code.............0x0
Panic Register.........0
********************************************************************
************
* Stack traceback
*
374
********************************************************************
************
**************************
*******SYSTEM PANIC*******
**************************
CAUSE: Machine Check
GENERAL REGISTERS:
In order to retrieve the entire contents of the post-mortem information the following
command should be entered to capture all text:
CXNK03010101> pmcat
Note: If there is no dump image found in memory, a "no dump found" message is displayed.
os dump force and os dump clear

When executed, os dump force forces the ONT to provide a core dump on any AE ONT reset.
Executing os dump clear releases the flag forcing the core dump.
os sys
When executed, the os sys command displays various system statistics:
CXNK00040BB9> os sys
**** Kernel Configuration Information - System Wide ****
Max Tasks...........176
Max Queues..........160
Max Semaphores......200
Clock Ticks/second..100
Remote Console Active: Yes, Global Stdin: 940, Stdout: 940
SysInfo size
Boot Cause
Boot Mode
Panic Message
:
:
:
:
4096 bytes
Unknown
POWER UP
*** No Panic Yet ***
Error Code
Panic Time
Up Time
Current Time
: 0x0
:
: 0 years, 0 days, 15:29:14.40 (tot tics: 5575440)
: Thu Nov 4 20:30:58 2010
375
Card Type
: 0x0
Running Task : Remote_Shell
Context
: TASK
Running State : [0x10040] Runtime|Application Mode
Memory Range : 0x0 - 0xffffffff (4095MB)
Dump Flag
: dump on panic (default)
Boot Version :
OS
Version : 1.0.a.165
Release Version:
Load Image
:
Last Interrupt: -1
Task Table Adr: 0x2a002e30
Boot Partition: 00000000
Boot Attempts : 0
Clock Rate
: 0
CXNK00040BB9>
show voice counters

The show voice counters command displays various voice counter information (organized
format of show voip mib).
CXNK0006CE93> show voice counters

Srvc
---1
2
DhcpAttemp DhcpAcks
DhcpNacks
---------- ---------- ---------0
0
0
0
0
0
Srvc RegGrants InAttempts

---- ---------- ---------1
14405
0
2
0
0
RegChallen
---------0
0
RegRejects
---------0
0
InCompleti
InBusy
InPeerDisc
---------- ---------- ---------0
0
0
0
0
0
InOntDisco
---------0
0
Srvc
---1
2
OutAttempt
---------0
0
Srvc
---1
2
E911Comple E911Busy E911PeerDi

---------- ---------- ---------0
0
0
0
0
0
RegAttempt
---------14405
0
OutComplet
OutBusy OutPeerDis
---------- ---------- ---------0
0
0
0
0
0
E911OnHook
---------0
0
OutOntDisc
---------0
0
E911Attemp
---------0
0
VmwiMsgsWa
---------0
0
VmwiNoMsgs
---------0
0
376
show voice counters Command Field Definitions
Value
Description
Srvc
The voice port line number.
dhcp attpts
Total cumulative usage of the SIP line. This counter increments every 100 seconds a call is
active.
Example: dhcp attps: 59383
dhcp acks
Total cumulative Acknowledgement Packets.

Example: dhcp acks: 4865
dhcp nacks
Total cumulative Negative Acknowledgement Packets.

Example: dhcp nacks: 0
reg attpts
Total registration attempts on the line.

Example: reg attpts: 25889
reg challenges
Total registration challenges on the line.
reg rejects
Total registration rejections on the line.
Example: reg challenges: 0

Example: reg rejects: 0
reg grants
Total SIP REGISTER message requested granted (OK).

Example: reg grants: 1788
incall attpts

Example: incall attpts: 25122
incall complts
incall busy
Total incoming calls received when line was busy.
Example: incall complts: 24915

Example: incall busy: 45
incall peerdisc

Example: incall peerdisc: 9
incall ontdisc

Example: incall ontdisc: 14
outcall attpts
outcall complts
Total outgoing calls completed successfully.
outcall busy
outcall peerdisc
Total outgoing calls that were disconnected by far end peer (calling party).
Example: outcall attpts: 94

Example: outcall complts: 125
Example: outcall busy: 3
Example: outcall peerdisc: 7
outcall ontdisc
Total outgoing calls disconnected by local ONT hangup (on hook).

Example: outcall ontdisc: 4
911 attpts
Emergency 911 Call Attempts on the line.
911 complts
Emergency 911 Call Attempts completed successfully.
911 busy
Emergency 911 Call Attempts that received a busy reply.
Example: 911 attpts: 4

Example: 911 complts: 4
Example: 911 busy: 0
377
show voice counters Command Field Definitions
911 peerdisc
Emergency 911 calls disconnected by far end E911 operator.

Example: 911 peerdisc: 0
911 onhooks
Emergency 911 Call attempts with local On hook condition.

Example: 911 onhooks: 5
vmwi
notify(msgs)
SIP NOTIFY messages received with Messages-Waiting set to Yes.
mnwi notify
(nomsgs)
SIP NOTIFY message received with Messages-Waiting set to No.
Example: vmwi notify(msgs): 2

Example: vmwi notify(nomsgs): 0
vtst test bp x
The vtst test bp x command performs a channel and drop test on a phone line. When
performing this test, the subscriber phone must be on-hook or inaccurate data will result.
Note: The vtst test bp x command does provide a result indicating a phone is off-hook or
there is a fixed line short.
Perform this test when the premises wiring is suspect. The "x" value refers to the zero-based
voice port number.
CXNK0006CE93> vtst test bp 0
start test 0001FFFE on BP 0 in slot 0
DIAG:VOICEPATH:PASS:VRinging:slot0:BP1:Not run, no hardware
DIAG:VOICEPATH:PASS:RingTrip:slot0:BP1:Not run, no hardware
DIAG:VOICEPATH:PASS:DialTone:slot0:BP1:Not run, no hardware
DIAG:VOICEPATH:PASS:LoopCur:slot0:BP1:Pass:27.4mA
DIAG:VOICEPATH:PASS:VACFEMF:slot0:BP1:Pass:0.3VACt
DIAG:VOICEPATH:PASS:VDCFEMF:slot0:BP1:Pass:0.1VDCt
DIAG:VOICEPATH:PASS:VTipRing:slot0:BP1:Pass:58.6VDCl
DIAG:VOICEPATH:PASS:VBATH:slot0:BP1:Pass:59.7VDCh
DIAG:VOICEPATH:PASS:TGres:slot0:BP1:Pass:Open
DIAG:VOICEPATH:PASS:RGres:slot0:BP1:Pass:Open
DIAG:VOICEPATH:PASS:TRres:slot0:BP1:Pass:Open
DIAG:VOICEPATH:PASS:RENload:slot0:BP1:Pass:0.3REN
DIAG:VOICEPATH:PASS:Final:slot0:BP1:Pass
#
step
res
lvl
min
actual
max
---
------
----
----
------
--------
-----
1: VRinging
[3]
2: RingTrip
[5]
3: DialTone
[4]
!3
None
4: LoopCur
[13]
0.0 VACr
20.0VAC
5: VACFEMF
[6]
0.8 VACl
60.0VDC
378
6: VACFEMF
[7]
7: VTipRing
[2]
43.0VDC
51.2VDCh
8: TGres
[8]
150kohm
Open
9: RGres
[9]
150kohm
Open
10: TRres
[10]
150kohm
11: RENload
[12]
12: Offhook
[11]
13: Final
[0]
!3
75.0VDC
Open
0.0REN
5.5REN
Dial Tone
Channel and Drop Testing Options

Value
all
Description
Specifies to run all channel and drop tests.
Example: vtst test 0 all
cd
Run channel and drop test.

Example: vtst test 0 cd
ch
Run channel test only.

Example: vtst test 1 ch
drop
Run drop test only.

Example: vtst test 0 drop
vbat
Runs battery voltage tests including ringing voltage, low voltage supply, and high voltage supply.
Example: vtst test 0 vbat
drop+
Run drop test with VBAT, TGres, RGres, TRres, RENload, and Offhook.
test
Specify a specific test to run. See below for a list of available test codes.
Example: vtst test 0 drop+

Example: vtst test 0 test 00002
ren1
Forces VRinging with 1 REN on drop. These are tests run by manufacturing only and provide no
meaningful user data when run.
Example: vtst test 0 ren1
ren5
Forces VRinging with 1 REN on drop. These are tests run by manufacturing only and provide no
meaningful data user when run.
Example: vtst test 0 ren5
minren
Run minimum REN test. These are tests run by manufacturing only and provide no meaningful user
data when run.
Example: vtst test 1 minren
extra
Runs all tests and shows additional results for voltage tests.
Example: vtst test 0 extra
379
Test Output Descriptions

VRinging
With a 1 Ren load on the circuit during ringing, the AC voltage is displayed.
RingTrip
With a 600 ohm load with an isolation relay, displays the ring trip voltage.
Note: This test supported on MDU ONTs only.

DialTone
With a 600 ohm load or a forced off-hook, measures whether a dial tone is detected.
LoopCur
With a 600 ohm load, current is read and reported while the binding post is forced into "forward
active low".
VACFEMF
Measures the AC voltage of the tip and ring when in a high impedance state.
VDCFEMF
Measures the DC voltage of the tip and ring when in a high impedance state.
VDD
Measures the internal operating voltage of the circuit (VDC).
VBATR
Measures and reports the ringing voltage supply (VDC).
VBATL
Measures and reports the low voltage supply (VDC).
VBATH
Measures and reports the high voltage supply (VDC).
TGres
Tip to ground resistive value is measured and displayed.
RGres
Ring to ground resistive value is measured and displayed.
TRres
Reports the mean resistance across the tip and ring lead in both directions.
RENload
If no resistive faults are detected, a ringing signal is initiated and the REN load is calculated.
OffHook
If offhook is detected (tip to ring less than 1001 ohms), resistance is calculated to determine if the
phone is offhook.
Results Table Definitions

#
Test sequence number with name of test
step
Internal value of test (from specific test option).
res
Results Code:
0 = Pass
1 = Not run, no hardware
2 = Not run
3 = Fail
lvl
Indicates severity of failure:

-1 = Unknown
0 = Normal
1 = Warning
2 = Caution
3 = Hazardous
min
Minimum value to compare for passing test.
actual
Actual value captured during the test.
max
Maximum value to compare for passing test.
380
Specific Test Options

The "test" commands provides the ability to run a specific test against a circuit. Follows is a
list of tests available with their appropriate step code:
Test Codes
Test
Number
Test
Code
Test Name
[00001]
Final
[00002]
VDD
[00004]
VTipRing
[00008]
VRinging
[00010]
DialTone
[00020]
RingTrip
[00040]
VACFEMF
[00080]
VDCFEMF
[00100]
TGres
[00200]
RGres
10
[00400]
TRres
11
[00800]
OffHook
12
[01000]
RENload
13
[02000]
LoopCur
14
[04000]
VBATR
15
[08000]
VBATH
16
[10000]
VBATL
Note: Used to Reset sequence only (not a valid test).
381
Message Posting Protocol Commands

mpp rates
The mpp rates command displays data and packet rates on each interface as observed over the
last 5 seconds of operation.
ifDesc upUcastPps dnUcastPps upMcastPps dnMcastPps
upMbps
dnMbps
------ ---------- ---------- ---------- ---------- ---------- ---------eth-0
0
0
0
0
0
0
TOTAL
0
0
0
0
0
0
ifDesc upUcastPps dnUcastPps upMcastPps dnMcastPps
upMbps
dnMbps
------ ---------- ---------- ---------- ---------- ---------- ---------wan-0
0
0
0
5239
0
57
TOTAL
0
0
0
5239
0
57
mpp Rates Field Definitions
Field name
Description
IFDesc
The interface type description
upUcastPps
Upstream Unicast packets per second
dnUcastPps
Downstream Unicast packets per second
upMcastPps
Upstream multicast packets per second
dnMcastPps
Downstream multicast packets per second
upMbps
Overall upstream Mbps
dnMbps
Overall downstream Mbps
382
mpp ess
The mpp ess command displays the ingress and egress Ethernet port statistics by MAC
address. Statistics are kept for both Egress and Ingress traffic.
EGRESS Ethernet Statistics:
Counter
mac-0
mac-1
mac-2
-------------------- ---------- ---------- ---------NUM_GOOD_FRAMES
1478819
0
609292
NUM_BC_FRAMES
400004
0
80385
NUM_MC_FRAMES
838932
0
0
NUM_UNDERRUN
0
0
0
NUM_CONTROL_FRAMES
0
0
0
BYTES_GOOD_FRAMES
288905817
0
159418724
BYTES_BC_FRAMES
43675163
0
6265422
BYTES_MC_FRAMES
70246947
0
0
BYTES_VLAN_FRAMES
0
0
159420665
NUM_VLAN_FRAMES
0
0
609364
NUM_TX_DEFERRALS
0
0
0
NUM_EXCESSIVE_DEFERR
0
0
0
NUM_LATE_COLLISIONS
0
0
0
NUM_EXCESSIVE_COLLIS
0
0
0
NUM_PAUSE_FRAMES
0
0
0
NUM_TX_ATTEMPTS
0
0
0
NUM_TOTAL_FRAMES
1478819
0
609420
mpp ess Egress Field Definitions
Field Name
Description
NUM_GOOD_FRAMES
Number of frames received error free.
NUM_BC_FRAMES
Number of broadcast packet frames processed.
NUM_MC_FRAMES
Number of multicast packet frames processed.
NUM_UNDERRUN
Number of data underruns during transmit.
NUM_CONTROL_FRAMES
Number of frames processed which include a control frame identifier.
BYTES_GOOD_FRAMES
Number of bytes processed in error free frames.
BYTES_BC_FRAMES
Number of bytes processed for broadcast frames.
BYTES_MC_FRAMES
Number of bytes processed for multicast frames.
BYTES_VLAN_FRAMES
Number of bytes for frames which include a VLAN identifier (tag).
NUM_VLAN_FRAMES
Number of frames processed which include a VLAN identifier (tag).
NUM_TX_DEFERRALS
Number of transmitted frames that were deferred.
NUM_EXCESSIVE_DEFERRALS
Number of frames that were deferred past the maxDeferTime constant.
NUM_LATE_COLLISIONS
Number of frames that had collisions during transmit.
NUM_EXCESSIVE_COLLISIONS
Number of frames that had at least 16 attempts to transmit.
NUM_PAUSE_FRAMES
Number of pause frames detected.
NUM_TX_ATTEMPTS
Number of attempts to transmit the previous frame.
NUM_TOTAL_FRAMES
Total number of frames processed.
383
INGRESS Ethernet Statistics:
Counter
mac-0
mac-1
mac-2
-------------------- ---------- ---------- ---------NUM_GOOD_FRAMES
222225
0
2576489113
NUM_BAD_FRAMES
0
0
0
NUM_FCS
0
0
0
NUM_BC_FRAMES
7695
0
1440115
NUM_MC_FRAMES
36237
0
2574249529
BYTES_GOOD_FRAMES
37195110
0
1005363075
BYTES_BC_FRAMES
1290951
0
118469573
BYTES_MC_FRAMES
2319168
0
518002283
BYTES_VLAN_FRAMES
0
0
931140783
NUM_CTRL_FRAMES
0
0
0
NUM_OUT_OF_BOUNDS
0
0
0
NUM_VLAN_FRAMES
0
0
2575328421
NUM_ALIGNMENT_ERROR
0
0
0
NUM_FLOW_CTRL
0
0
0
NUM_BAD_OPCODE
0
0
0
NUM_LT_OUT_OF_RANGE
0
0
0
NUM_TOTAL_FRAMES
222225
0
2576489543
NUM_RESOURCE_ERROR
0
0
0
mpp ess Ingress Field Definitions
Field Name
Description
NUM_GOOD_FRAMES
Number of frames received error free.
NUM_BAD_FRAMES
Number of frames received with errors.
NUM_FCS
Number of inserted Frame Check Sequence bits.
NUM_BC_FRAMES
Number of broadcast packet frames processed.
NUM_MC_FRAMES
Number of multicast packet frames processed.
BYTES_GOOD_FRAMES
Number of bytes processed in error free frames.
BYTES_BC_FRAMES
Number of bytes processed for broadcast frames.
BYTES_MC_FRAMES
Number of bytes processed for multicast frames.
BYTES_VLAN_FRAMES
Number of bytes for frames which include a VLAN identifier (tag).
NUM_CTRL_FRAMES
Number of frames processed which include a control frame identifier.
NUM_OUT_OF_BOUNDS
Number of frames processed which exceeded the maximum legal length.

Note: Only applies if jumbo frames are disabled.
NUM_VLAN_FRAMES
Number of frames processed which include a VLAN identifier (tag).
NUM_ALIGNMENT_ERROR
Number of frames received with an incorrect FCS value.
NUM_FLOW_CTRL
Number of Ethernet flow control type packets as identified by the

Length/Type (LT) field.
NUM_BAD_OPCODE
Number of frames processed that contains an unsupported OPCODE.

Note: only applies to non-Pause type frames
NUM_LT_OUT_OF_RANGE
Number of frames processed where the Length exceeds max_mtu or is

less than 64 bytes.
NUM_TOTAL_FRAMES
Total number of frames processed.
NUM_RESOURCES_ERRORS
Number of total resource errors detected.
384
meter show info

This command summarizes information on each traffic shaper. It is used as a debugging or
sanity check mechanism. The output of the command is as follows:
******Upstream Shaper Info******
Idx
CIR
PIR
RunAvg
Drops
pmap
attachments
----
----
----
---------
-------
-------
--------------
10000
10000
0000
mv4001
100000000
100000000
0000
v4001 v4002
100000000
100000000
0000
eth-0
30000000
30000000
0000
UNASSIGNED
200000
200000
0000
v100
Idx
CIR
PIR
RunAvg
Drops
pmap
attachments
----
----
----
---------
-------
-------
--------------
100000000
100000000
0000
v4001 v4002
100000000
100000000
0000
eth-0
30000000
30000000
0000
UNASSIGNED
200000
200000
0000
v100
******Downstream Shaper Info******
Note: Executing the "meter clear shaper" command clears all upstream and downstream
shaper data.
Note: Executing the "meter show count" command displays upstream and downstream
shaper data.
meter show info Field Definitions
Value
Description
IDx
The shaper index value
CIR
The committed information rate of the shaper
PIR
The peak information rate of the shaper
RunAvg
The current running average rate of information passing through this shaper.
Drops
The number of packets dropped on this shaper due to queue full conditions.
Pmap
A bit map of occupied priority queues in hexadecimal. The least significant bit is priority 0.
Attachments
The flow mechanism and designated attachments for the shaper. Up to 4 are displayed.
mv(xx) - multicast/broadcast VLAN Id flow attachment
v (xx) - VLAN Id flow attachment
eth-x - Ethernet port flow attachment
385
meter show count

Executing the "meter show count" command displays upstream and downstream data rate
shaping of the processor.
Note: Values for 700GX Series ONTs include all rate limiting (any configured shaper).
Values for 700GE or 76xGX ONTs include multicast or broadcast data rate shapers only.
meter show count
Unshaped packets passed = 1808
******Upstream Shaper Info*******
Idx
bytes
drops
hwm
pmap
run_avg sleep_mult
to_send
--- ---------- ---------- --- -------- ---------- ---------- ---------31
0
0
0
0
0
1
12501
******Downstream Shaper Info*******
Idx
bytes
drops
hwm
pmap
run_avg sleep_mult
to_send
--- ---------- ---------- --- -------- ---------- ---------- ---------31
0
0
0
0
0
1
12501
meter show count Field Definitions
Value
Description
IDx
The shaper index value
Bytes
Total bytes that were rate limited
Drops
Packets dropped due to exceeding packet queuing resources
Hwm
High Water Mark - The highest number of packets queued in shaper
Pmap
Bit map of ports with packets currently queued (bit0 - eth0, bit1 - eth1, and so
forth)
Run_avg
The current observed data rate traversing this shaper
Sleep_mult
System Developer Use Only
To_send
System Developer Use Only
386
macff show
Note: The MACFF command displays both static and dynamic MACFF station/subnet
entries currently known in the ONT Ethernet network. This includes stations/subnets on
VLANS that do not have -macff enabled (in other words, stations and subnets subject to IP
SRC verify (-onlysv)).
macff show
Usage
macff show [-vid=] [filter=<enum>]
Show MACFF settings by IP address
Options
vid=
Limit MACFF listing to those of the bridge specified by the VLAN ID

type: Unsigned
filter=<enum>
Filter display to only access router (ar), subscribers (sub), static entries (stat), learning
bridge (lb), or none (no filter - shows all entries)
type: ar, sub, stat, lb, none
CXNK000004E6> macff show

MAC Address
vid
IP Address
ref
state
----------------- ---- --------------- --- ---------00-16-c8-bc-a4-cb 4002
172.26.61.2
3
resolved
MAC Address
vid
IP Address
MASK
AR/Gateway
Por
----------------- ---- --------------- --------------- --------------- --00-00-44-2e-ca-81 4002
172.26.61.33
255.255.255.0
172.26.61.2
0
00-03-03-ae-ae-02 4002 172.26.61.122
255.255.255.0
172.26.61.2
0
00-00-06-82-3b-1d 4002 172.26.61.128
255.255.255.0
172.26.61.2
0
MAC Address
vid
IP Address
L2Table
----------------- ---- --------------- ----------------00-03-03-ae-ae-02 4002 172.26.61.122
sv-00d02c14-1e
00-00-06-82-3b-1d 4002 172.26.61.128
sv-00d02c14-1e
00-00-44-2e-ca-81 4002
172.26.61.33
sv-00d02c14-1e
idx vid
IP Address
AR/Gateway
MASK
--- ---- --------------- --------------- --------------0 4002
172.26.61.33
172.26.61.2
255.255.255.0
1
-1
N/A
N/A
N/A
2
-1
N/A
N/A
N/A
387
3
-1
4
-1
5
-1
6
-1
7
-1
8
-1
9
-1
10 -1
11 -1
12 -1
13 -1
14 -1
15 -1
CXNK000004E6>
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
Filtering and Mapping Display Commands

Level 1 - L2 Mapping/Filtering Table Show
This command is used to examine the Level 1 - L2 Mapping/Filtering Table for the purpose
of debugging or interrogation. Assume the following filter operation has been added for the
level 1 table:
CXNK03010101> lev1l2tag add -filtmac=sa filtmacmask=ff:ff:ff:00:00:00

-treatinpri=4 -treatinvid=100 dev=eth-0
The lev1l2 show command displays the following:

Level 1 Upstream Tagging Entry Table: unit = 0
outputTpid = 8100
inputTpid = 8100
i
ac
fm
filtermacmask
filtermacmatch
trd
top
tov
totp
tip
tiv
titp
hits
---
----
----
--------------------
--------------------
-----
-----
-----
------
-----
-----
------
-----
ff-ff-ff-00-00-00
00-01-04-00-00-00
15
100
Level 1 Downstream Tagging Entry Table: unit = 0

outputTpid = 8100
inputTpid = 8100
i
ac
fm
filtermacmask
filtermacmatch
trd
top
tov
totp
tip
tiv
titp
hits
---
----
----
--------------------
--------------------
-----
-----
-----
------
-----
-----
------
-----
ff-ff-ff-00-00-00
00-01-04-00-00-00
388
Note: Hits counters only reflect traffic forwarded via software. For information on hardware
table forwarding, contact the Calix Technical Assistance Center for details.
L2 Mapping/Filtering Table Show
Value
Description
outputTpid
Default Tpid/ethertype for frame output operations
inputTpid
Default Tpid/ethertype for input frame filtering operations on Tpid.
The table index entry number
ac
An internally defined code for the operation

filterSAAdd1VidExpPbitDefaultOutputTpid=0,
Lev1RemoveVidOnVidMatchTreatmentInner=1,
filterSADrop=2,
filterDADrop=3
fm
filterMac Value
FILTER_MAC_DA 1
// Filter on MAC DA
FILTER_MAC_SA 2
// Filter on MAC SA
INVERSE_SA_ADD1 3
// Inverse of 2
filtermacMask
The significant bits of the MAC to match on
filtermacmatch
The value to match on after the mask has been applied to the incoming MAC DA/SA
trd
The treatment/remove/drop field value

0 - Don't remove tags or drop frame
1 - remove one tag
2 - remove two tags
3 - drop frame
top
The treatment outer priority field

7 - The value less than or equal to this is used as outer priority
8 - Copy outer priority from inner
9 - Copy outer from outer
15 - Do not add an outer tag
tov
The treatment outer VID

4094 - This value and lower is the VID for outer tag
4096 - Copy outer VID from inner VID
4097 - Copy Outer VID from Outer VID
totp
The treatment outer TPID value

0 - TPID and DE copied from inner
1 - TPID and DE copied from outer
2 - TPID - OutputTPID, DE copied from inner
3 - TPID - OutputTPID, DE copied from outer
4 - TPID - 0x8100
6 - TPID - OutputTPID, DE bit = 0
tip
The treatment inner priority field

389
L2 Mapping/Filtering Table Show
tiv
The treatment inner VID

4094 - This value and lower is the VID for inner tag
4096 - Copy Inner VID from inner VID
4097 - Copy Inner VID from Outer VID
titp
The treatment inner TPID value

4 - TPID - 0x8100
hits
Number of filtered packet matches that occurred on the table entry.

Displayed in hex format.
Level 2 - L2 Mapping/Filtering Table Show

Level 2- L2 Mapping/Filtering Table Show
This command is used to examine the Level 2 L2 Mapping/Filtering Table for the purpose
of debugging or interrogation.
CXNK03010101> lev2 show eth-0
lev2 show eth-0
Level 2 Upstream Tagging Entry Table: unit = 0
upstream_filter_drops = 0
outputTpid = 8100
inputTpid = 8100
ac
fop
fov
fotp
fip
fiv
fitp
feth
tr
top
tov
totp
tip
tiv
titp
hits
--
---
----
-----
-----
-----
-----
-----
------
---
-----
-----
------
-----
-----
-----
-----
15
4096
100
15
210
15
4096
300
15
400
15
4096
600
500
4096
15
4096
700
800
4096
15
4096
15
4096
8863
15
200
15
4096
15
4096
15
200
15
4096
4096
900
4096
Level 2 Downstream Tagging Entry Table: unit = 0

dnstream_filter_drops = 0
outputTpid = 8100
inputTpid = 8100
390
I
ac
fop
fov
fotp
fip
fiv
fitp
feth
tr
top
tov
totp
tip
tiv
titp
hits
---
----
----
-----
----
-----
----
-----
---
----
----
------
-----
-----
-----
-----
15
210
15
100
15
400
15
300
500
4096
15
15
600
800
4906
15
15
700
15
200
8863
15
15
4096
15
200
15
15
4096
900
4096
15
15
4096
Note: Hits counters only reflect traffic forwarded via software. For information on hardware
table forwarding, contact the Calix Technical Assistance Center for details.
Valid Level 2 - L2 Mapping/Filtering Table Entry Adds
upstream filter
drops
Number of upstream frames dropped due to "drop" treatment
downstream
filter drops
Number of downstream frames dropped due to "drop" treatment
outputTpid
Default Tpid/ethertype for frame output operations
inputTpid
Default Tpid/ethertype for input frame filtering operations on Tpid.
The table index entry
ac
An internally defined code for the operation specified

Add1VidOnUntaggedExpPbitDefaultOutputTpid=0,
VidPbitTranslationExpPbitDefaultOutputTpid=1,
VidTranslationPbitPropIncomingDefaultOutputTpid=2,
AddVidFromIncomingVIDMatchPbitPropIncomingDefaultOutputT=3,
AddVidFromIncomingVIDMatchExpPbitDefaultOutputTpid=4,
AddVidFromIncomingEthertypematchExpPbitDefaultOutputTpid=5,
RemoveVidOnVidMatchInner=6,
RemoveVidOnVidMatchOuter=7,
NoOperation
fop
ilter Outer Priority value

7 - This number and below is used as outer priority
8 - Do not filter on outer priority
14 - The default when no outer 2 tag rule applies
15 - No double tag rule, ignore all outer filters in this rule
fov
filter Outer VID

4094 - This number and below is used as the given filter VID
4096 - Do not filter on outer VID
fotp
Filter Outer TPI/DE

0 - Do not filter on outer TPID_DE
4 - Outer TPID - 0x8100
5 - Outer TPID - InputTPID, don't care about DE bit
6 - Outer TPID - InputTPID, DE bit = 0
7 - Outer TPID - InputTPID, DE bit = 1
fip
Filter Inner Priority value

7 - This number and below is used as inner priority
8 - Do not filter on inner priority
14 - the default when no other 1 tag rule applies
391
15 - No tag rule
fiv
Filter Inner VID

4094 - This number and below is used as the given filter VID
4096 - Do not filter on inner VID
fitp
Filter Inner TPID/DE

0 - Do not filter on inner TPID_DE
4 - Inner TPID - 0x8100
5 - Inner TPID - InputTPID, don't care about DE bit
6 - Inner TPID - InputTPID, DE bit = 0
7 - Inner TPID - InputTPID, DE bit = 1
feth
Filter ethertype
0 - Do not filter ethertype
>0 - ethertype to match on
trd
The treatment/remove/drop field value

0 - Don't remove tags or drop frame
1 - remove one tag
2 - remove two tags
3 - drop frame
top
The treatment outer priority field

8 - copy outer priority from the inner
9 - copy outer from outer
tov
The treatment outer VID

4094 - This value and lower is the VID for outer tag
4096 - Copy outer VID from inner VID
4097 - Copy Outer VID from Outer VID
totp
The treatment outer TPID value

4 - TPID - 0x81000
6 - Output TPID, DE bit=0 7 - TPID - OutputTPID, DE bit=1
tip
The treatment inner priority field

tiv
The treatment inner VID

4094 - This value and lower is the VID for inner tag
4096 - Copy Inner VID from inner VID
4097 - Copy Inner VID from Outer VID
392
titp
The treatment inner TPID value

4 - TPID - 0x8100
6 - TPID - OutputTPID, DE bit=0
7 - TPID - OutputTPID, DE bit=1
hits
Number of filtered packet matches that occurred on the table entry.

Displayed in hex format.
Level 2 - L2 Mapping Examples
The following examples illustrate all of the current valid Level 2 operations which are
permitted on the AE ONT at this time:
# result = single tag, filter on OUI add VID 100, set explicit PBIT(4)
lev1l2tag add -filtmac=sa -filtmacmask=ff:ff:ff:00:00:00 filtmacmatch=00:01:04:00:00:00 -treatinpri=4 -treatinvid=100 dev=eth-0
# result = single tag, VID translation from VLAN 100/PBIT=5 to VLAN
210/PBIT=4, use default outputTpid
lev2l2tag add -filtinpri=5 -filtinvid=100 -treatinpri=4 -treatinvid=210 eth0
# result = single tag, VID translation from VLAN 300 to VLAN 400, propagate
incoming PBIT from incoming tag, use default outputTpid
lev2l2tag add -filtinpri=8 -filtinvid=300 -treatinpri=8 -treatinvid=400 eth0
# result = double tag, Add VID (500) from incoming VID match (600),
propagate incoming PBIT from incoming tag, use default outputTpid
lev2l2tag add -filtinpri=8 -filtinvid=600 -treatoutpri=8 -treatoutvid=500 treatinpri=8 -treatinvid=4096 eth-0
# result = double tag, Add VID (800) from incoming VID match (700), explicit
PBIT, use default outputTpid
lev2l2tag add -filtinpri=8 -filtinvid=700 -treatoutpri=4 -treatoutvid=800 treatinpri=8 -treatinvid=4096 eth-0
# result = single tag, Add tag if etype == 0x8863 , set explicit PBITs, use
default TPID
lev2l2tag add -filtetype=0x8863 -treatinpri 5 -treatinvid 200 eth-0
# result = single tag, Add tag to untagged frame, set explicit PBITs, use
default TPID
lev2l2tag add -treatinpri 5 -treatinvid 200 eth-0
393
# result = double tag, Add VID (900) from incoming ANY VID (with a ethertype
default InputTPID), propagate incoming PBIT from incoming tag, use default
outputTpid
lev2l2tag add -filtinpri=8 -filtintpidde=5 -treatoutpri=8 -treatoutvid=900 treatinpri=8 -treatinvid=4096 eth-0
# result = double tag, xlate incoming (ctag) VID 800 to VID 810, propagate
incoming PBIT from incoming ctag, add outer stage 901 with pbit 0 (change
and add tag action)
nhmont-1 lev2l2tag add - filtinpri=8 -filtintpidde=5 -filtinvid=800 treatoutpri=0 -treatoutvid=901 -treatinpri=8 -treatinvide=810 eth-0
show video stats

The show video stats command displays IGMP statistics for upstream and downstream video
traffic on ONT IPTV video ports.
CXNK0006CE93> show video stats

Upstream Statistics:
Port MC Drops FiltDrops MvrDrops ReportV1 ReportV2 Leaves V3 Drops
LimitDrop
---- --------- --------- -------- -------- -------- -------- -------- -------1
0
0
0
0
68494
240
0
0
2
0
0
0
0
0
0
0
0
3
0
0
0
0
0
0
0
0
4
0
0
0
0
0
0
0
0
Downstream Statistics:
Port ReportDrop LeaveDrop
Ignored GroupQuery GenQuery
---- ---------- ---------- ---------- ---------- ---------1
0
0
0
0
17146
2
0
0
0
0
0
3
0
0
0
0
0
4
0
0
0
0
0
394
show video stats Command Field Definitions

Value
Description
Upstream Statistics
Port
The ONT Ethernet Port running video.
MC Drops
Bad multicast packets dropped.
Filt Drops
Multicast packets dropped due to multicast range filter.
MvrDrops
Multicast packets dropped tu to mvr range filter.
ReportV1
IGMPV1 report messages received.
ReportV2
IGMPV2 report messages received.
Leaves
Leave messages received.
V3 Drops
IGMPV3 packets dropped.
Limit Drop
Reports dropped due to channel limit being exceeded.
Downstream Statistics
ReportDrop
IGMP report messages dropped.
LeaveDrop
IGMP leave messages dropped.
Ignored
Other IGMP messages dropped.
GroupQuery
IGMP group specific queries received.
GenQuery
IGMP general queries received.
m2u
The m2u command provides a convenient method for determining which set top boxes are
watching what specific channels in an IPTV network. As the number of set-top boxes joining
a video stream increases, this command allows for careful monitoring of each STB in the
stream.
Note: m2u works on a "1:n" relationship where 1 = the number of video channels and "n"
corresponds to any set-top boxes listening to the stream (up to 128).
The output of the m2u command displays IGMP query and report results for provisioned
video channel addresses.
395
CXNK00040B73:0> m2u
Port:0 -- MAC:00-06-31-1e-d3-a9
Port:1 -- MAC:00-06-31-1e-d3-aa
Port:2 -- MAC:00-06-31-1e-d3-ab
Port:3 -- MAC:00-06-31-1e-d3-ac
Port:4 -- MAC:00-06-31-1e-c9-97
Port:5 -- MAC:00-06-31-1e-c9-98
Port:6 -- MAC:00-06-31-1e-c9-99
Port:7 -- MAC:00-06-31-1e-c9-9a
M2U
M2U
M2U
M2U
M2U
M2U
M2U
M2U
mode:0
mode:0
mode:0
mode:0
mode:0
mode:0
mode:0
mode:0
M2U Forwarding IP to MAC mapping Table

IP Address
MAC Address
MacLen Port MIdx
Aging
--------------- ----------------- ------ ---- ---- -----------224.0.17.103 01-00-5e-00-11-67
14
2
19
Q:0:N/A:92317:360
1
* 00-02-5d-00-22-cf <- captured downstream source mac [137500]
00-02-02-16-9e-76
14
2
18
R:741:125:70:335
224.0.17.104 01-00-5e-00-11-68
14
7
13
Q:0:N/A:92317:360
1
00-02-02-16-89-9f
14
7
12
R:741:125:86:335
224.0.17.107 01-00-5e-00-11-6b
14
3
15
Q:0:N/A:15995:360
1
00-02-02-16-89-8f
14
3
14
R:131:124:82:334
14
6
17
Q:0:N/A:15995:360
1
224.0.17.108 01-00-5e-00-11-6c
00-02-02-16-89-9a
14
6
16
R:131:124:75:334
224.0.17.111 01-00-5e-00-11-6f
14
0
29
Q:0:N/A:92316:360
1
00-02-02-0a-fc-61
14
0
28
R:741:125:70:335
225.10.10.10 01-00-5e-0a-0a-0a
14
3
31
Q:0:N/A:84:360
0
* 00-06-31-1e-d3-ac <- default source mac [45000]
00-02-02-16-89-8f
14
3
30
R:1:N/A:84:360
01-00-5e-0a-0a-0a
14
7
27
R:1:N/A:83:360
00-02-02-16-89-9f
14
7
26
R:1:N/A:83:360
01-00-5e-0a-0a-0a
14
6
25
R:1:N/A:80:360
00-02-02-16-89-9a
14
6
24
R:1:N/A:80:360
01-00-5e-0a-0a-0a
14
0
23
R:1:N/A:79:360
00-02-02-0a-fc-61
14
0
22
R:1:N/A:79:360
01-00-5e-0a-0a-0a
14
2
21
R:1:N/A:70:360
00-02-02-16-9e-76
14
2
20
R:1:N/A:70:360
Port 0 has 3 sm and 125 total free entries
1320 IGMP LEAVE packets processed
396
m2u Field Definitions

Field Name
Description
IP Address
The IP address of the multicast video channel being monitored.
MAC Address
Three discrete MAC addresses are listed:

1) Generic Multicast MAC Address
2) The MAC address of the actual upstream video source.
3) The MAC address of the STB being monitored. (Up to 128 MAC
addresses possible per video channel).
MacLen
The length (in bytes) of the media header.
Port
The ONT Video Port Number.
MIdx
Media Index Header (internal reference only).
Aging
Aging statistics are gathered independently of queries and reports as follows:

ex: Q:0:N/A:92317:360 1
1) Query or Report
2) Number of queries or reports
3) Average interval between queries (secs)
4) Age of query or report (secs)
5) Threshold before exiting stream (secs)
6) This is the number of packets forwarded by software. If 0, no video
stream packets were forwarded through the software path. If 1, video stream
packet processing is functional on 700GE or 76xGX ONTs. If on 700GX, the
actual number of video stream packets forwarded. This counter remains at 0
for hardware only forwarding.
Note: Once the Age of the query is greater than the established threshold,
the video stream will be queued to be dropped.
Based on the ONT type, the information returned for packet counts is as follows:
700 GX - The 700GX processes video packets exclusively in the SW path. Thus, the counter increments
as multicast packets are processed.
700 GE - The 700GE processes video packets exclusively in the HW path. Thus, this counter doesn't
apply to 700 GE ONTs.
760 GX - The 760GX uses both the SW and HW path. However, only the first few packets are counted.
Thus, you will see a 1 or a digit slightly higher if video is being processed. If 0, then no packets were ever
forwarded.
397
m2u age
For IGMP snooping, the ONT always assumes the querier is on the video VLAN within the
WAN interface. In this scenario, snooping never ages. At the subscriber end, the ONT
pruning mechanism examines all query intervals and averages the interval results. Calix adds a
cushion to this average interval (referred to as the pruning timer) as follows:
Average Interval
Added Cushion to Average
< 30 seconds
15 seconds
< 60 seconds
20 seconds
< 90 seconds
25 seconds
>= 90 seconds
30 seconds
If adjustments to the pruning timer are necessary, the m2u age command can be added to the
video profile (reference the queryinterval option within the videoprofile create command).
CXNK0004FC4F> m2u age 30
Aging mode was configured to: 0
Aging mode is now configured to: 30
398
ping
To verify an AE ONT with a single host (iph-0) is communicating on the network, use the
"ping" command to confirm communications with the ONT. The ping command has the
following options:
ping
Usage
ping <ipaddr>
Send a packet to an IP address and validate response
Options
-t
Ping until stopped via pingstop command.

type: . . .
-n=<n>
Number of ping requests to send

type: Integer
-l=<n>
Bytes of data to send

type: Integer
=w=<n>
Timeout in milliseconds to wait for each reply

type: Integer
-src=<ipaddr>
Source iP Address
type: IP Address
Parameters
destination=<ipaddr>
destination IP Address
type: IP Address
Sample Output
CXNK000025F7B> ping <ipaddr>
Pinging <ipaddr> with 32 bytes of data:
Reply from <ipaddr>: bytes=32 time<1ms TTL=63
Ping statistics for <ipaddr>:
Packets; Sent = 4, received = 4, Lost = 0 (0% loss)<
Approximately round trip times in milli-seconds:
Minimum = 0ms, maximum = 1ms, Average = 0ms
399
For AE ONTs with more than one host, you must specify the Gateway address associated
with the ONT in order to verify a connection.
To ping a multi-host ONT
From the command line, run "vf rpif"
CXNK00030F7B> vf rpif
The "vf rpif" command shows per-interface routing entries:

Route Per IF Info:
name re
localIP
subMask
Gateway
rtePtr
----- -- ----------------- ----------------- ----------------- -------iph-0 0
10.100.100.200
255.255.255.0
10.100.100.1
a9ad68
iph-1 0
66.231.10.55
255.255.255.192
66.231.10.1
dddff0
0
0.0.0.0
0.0.0.0
0.0.0.0
0
0
0.0.0.0
0.0.0.0
0.0.0.0
0
0
0.0.0.0
0.0.0.0
0.0.0.0
0
The "show route" command shows routing entries that are used when the source interface is not
specified:
CXNK00030F7B> show route
IpDest
IpMask
--------------- --------------10.100.100.0
255.255.255.0
66.231.10.0
255.255.255.192
127.0.0.0
255.0.0.0
IpNextHop
I/F
Type
Proto
--------------- ------ ------ ---------10.100.100.200 iph-0 local local
66.231.10.55
iph-1 local local
127.0.0.1
loop-0 local local
After you have checked these tables, re-ping the ONT using the -src command:
CXNK00030F7B> ping -src=10.100.100.200 64.33.247.229
Pinging 64.33.247.229 with 32 bytes of data:
Reply from 64.33.247.229: bytes=32 time<10ms
Ping Statistics for 64.33.247.229:
Packets: Sent = 4, Received = 4, Lost = 0 (0% loss),
Approximate round trip times in milli-seconds:
Minimum = 0ms, Maximum = 0ms, Average = 0ms
Note: iph-0 in AE mode is always the management IP host and it is always bridged to the
management VLAN. NTP, Syslog and SNMP Traps also uses iph-0. The AE ONT software
binds to the iph-0 interface while transmitting.
400
dhcpl2 trace
The dhcpl2 trace command provides a DHCP Snoop tracing facility as a reference tool.
Usage: dhcpl2 trace level=<enum>

DHCP Snoop tracing facility
Parameters:
level=<enum>
options
Select one or more options for tracing: entering no

returns selected tracing
type: api, debug, error, pkt, none
Proxy ARP Trace (parp trace)

The Proxy ARP Trace command displays events, errors, and packet information.
Usage: parp trace level=<enum>
Proxy ARP tracing facility
Parameters:
level=<enum>
options
Select one or more options for tracing: entering no

returns selected tracing
type: none, event, error, packet
401
Non-ONT Commands
The following commands are available as reference and should be executed from the Linux
shell layer.
SNMP Commands
Various SNMP commands are available to monitor trap receivers on the system.
Usage: snmp send
Send the SNMP registration trap information to all listeners.
Usage: snmp set
Set the SNMP Debug Levels
Usage: snmp show
Show the status of the SNMP Agent
402
umask Command
Applying a mask to limit permissions is accomplished by removing permissions based on the
umask value.
A summary of the most frequently used umask commands is included here for reference:
umask000 - Assigns permissions such that all files have full read/write access for
everyone.
umask002 - Assigns permissions such that only you and members of your group have
read/write access to files, and read/write/search access to directories you own. All others
have read access only to your files, and read/search to your directories.
umask011 - No affect on files, but sets the create directories xbit for group and everyone
else.
umask022 - Assigns permissions such that only you have read/write access for files, and
read/write/search for directories you own. All others have read access only to your files,
and read/search access to your directories.
umask077 - Assigns permissions such that you you have read/write access for files, and
read/write/search for directories you own. All others have no access permissions to your
files or directories.
To view current umask settings

1. From the command line, navigate to the directory where the files exist.
2. Type the word "umask" at the command line:
[root@cmshost01 ae]# umask
0022
The current umask setting being applied to this directory is displayed (022).
To update umask settings
1. From the command line, navigate to the directory where the vsftpd.conf file is located.
2. Insert the following comments and commands into the file:
# Change default file permissions via the umask command - from 077
to 022.
local_umask=022
Note: Read permissions must always be applied to the OTHERS group in order to
ensure that the ONTs TFTP request for the .cfg file has permission.
403
Glossary
Glossary of Terms
Term
Definition
Active Ethernet (AE)
The term Active Ethernet (AE) refers to a point-to-point Ethernet topology between an ONT and an
aggregation switch. The Active. term is used to differentiate the technology from the FSAN Passive.
optical network technology in which a number of Optical Network Terminals (ONTs) share bandwidth over
a fiber network. The Active. implies active components in the field, a point-to-point network topology, and
an intelligent termination point.
ARD
Architecture Requirements Document Defines a piece of the architecture for the product. The ARD also
provides a response to the PSA.
ARP
Address Resolution Protocol The protocol TCP/IP uses to map an IP address to a MAC address.
BRAS
Broadband Remote Access Server A IP network element that aggregates user sessions from the access
network, provides policy management, and provides QoS.
E5
Calixs remote IP DSLAM platform.
C7
Calixs multi-service, multi-protocol DSLAM/BDLC platform.
CPE
Customer Premise Equipment The device in the end-users premise which terminates the local loop. The
CPE typically bridges xDSL to/from an IP LAN.
DHCP
Dynamic Host Configuration Protocol Manages the assignment of IP addresses within a network.
Downstream
The direction of traffic flow from the central office and the customer premise.
EPG
Electronic Programming Guide These represent the multicast channel data generated by a middleware
server. It contains the information necessary for channel lineup and STB boot up.
ERD
Engineering Requirements Document A document that describes the engineering specifications of a

product or part of a product. The ERD also contains a response to the PSA and/or ARD.
FE
Fast Ethernet 100 Mbps Ethernet (SMII or 100base-T)
FTTP
Fiber to the Premise A fiber transmission scheme to deliver broadband access between the central office
and customer premise.
GBIC
Gigabit Interface Converter A high speed transceiver that interfaces electrical/digital signals with
optical/fiber signals.
GE
Gigabit Ethernet
IGMP
Internet Group Management Protocol A protocol that allows for multicasting.
IPOTS
Integrated POTS A method within the E5 for integrating voice and data service onto a single digital
network.
IPTV
Internet Protocol Television Video delivery for televisions using the Internet Protocol
LLDP
Link Layer Discovery Protocol IEEE 802.1ab draft standard defines a protocol used to do device
discovery using Ethernet.
LACP
Link Aggregation Control Protocol Provides the control protocol that allows for multiple physical
connections to be shared and treated as a single Ethernet link (802.3ad).
MAC
Media Access Control MAC address is the physical address of a network element.
MEF
Metro Ethernet Forum.
MPEG-X
Motion Picture Experts Group Video compression/encoding formats.
MC
Multicast A packet that has a Multicast Ethernet address
PHY
Physical Interface In a DSLAM, the xDSL interface.
PPPoX
Point-to-Point Protocol A protocol used to connect 2 points in a network. Often used to connect a
modem onto a service providers network.
PSTN
Public Switched Telephone Network A voice-band telephone network.
POTS
Plain Old Telephone System A voice-band telephone network (PSTN).
PSA
Product Specifications Agreement Defined the market requirements for the product.
QoS
Quality of Service
404
Glossary of Terms
RED
Random Early Discard A method of discarding packets during network congestion.
RTSP
Real Time Streaming Protocol A protocol used as the data packetization method for VOIP packets.
SerDes
Serializer/Deserializer Converts between parallel and serial data. Extra bits are added/removed from the
serial stream to embed/synthesize a clock.
SFP
Simple Form Factor Pluggable A pluggable module that interfaces digital circuitry to optical fiber.
SIP
Session Initiation Protocol A protocol used to establish, modify, or terminate multimedia applications,
such as voice-over-IP and video conferencing.
SLIC
Subscriber Line Interface Circuit Provides the analog POTS interface on the local telephone loop.
SMII
Serial Media Independent Interface An interface definition to transport 10/100 Ethernet.
SGMII
Serial Gigabit Media Independent Interface An interface definition to transport Gigabit Ethernet.
SONET
Synchronous Optical Network An ANSI standard, fiber optic transmission system.
STB
Set Top Box The device which terminates video service at a customer premise.
Tail-Drop
A method of discarding packets during network congestion.
TDMoIP
Time Division Multiplexed over Internet Protocol A method for trunking raw voice data over an IP
connection.
TLAN
Transparent Local Access Network Provides a single LAN (or VLAN) between multiple end-points on
different xDSL connections.
Upstream
The direction of traffic flow from the customer premise to the central office.
Utopia
Universal Test and Operations Interface for ATM. A synchronous physical interface bus used to transport
fixed-length packets.
VLAN
Virtual Local Access Network A logical grouping of LAN devices.
VoD
Video on Demand Unicast video for television.
VoIP
Voice over Internet Protocol A real-time protocol that allows voice delivery over IP networks (e.g. SIP).
xDSL
Any number of DSL flavors. In this case, xDSL primarily implies ADSL, ADSL2, ADSL2+, VDSL2, which
are different physical layer standards for delivering broadband service across last mile networks.
405
Ethernet OAM Provisioning

Ethernet OAM Overview
Operation, Administration and Maintenance (OAM) defines a set of functions designed to
monitor network operation, detect and localize network faults, and provide a measure of
Network performance. The AE system supports Ethernet OAM within the Calix 760GX and
740GE ONT series. Ethernet OAM on the ONT can be divided into three classes: Ethernet
Service OAM (802.1ag and Y.1731 standards), Link OAM (also known as Ethernet First Mile
[EFM] following the 802.3ah standard, and RFC 2544.
Key features of the 802.1ag Connectivity Fault Management standard include:
Continuity Check with Remote Defect Indication

Link Trace (MAC traceroute)
Loopback (MAC ping)
Features of the Y.1731 Performance Monitoring Standard include:
Loss Measurements
Delay and Delay Variation (Jitter) Measurements
Threshold Crossing Events
Features of the 802.3ah standard include:
OAM Discovery
Remote Failure Indication (Dying Gasp)
Remote Loopback
Network performance is verified using an RFC2544 test head:
Out of Service SLA Verification

Reflector with MAC swap per VLAN (to enable remote endpoint roundtrip testing)
406
The following diagram shows a point-to-point Ethernet fiber access network supporting
Ethernet OAM on the 760GX family of ONTs.
Note: Ethernet OAM for Calix AE MDU ONTs is supported in AE 2.1 via the Command
Line Interface. OAM is also supported on the E-series platform using CMS. Ethernet OAM
for Calix MDU ONTs will be supported in CMS in a future release. For additional
information on provisioning Ethernet OAM from CMS, refer to the E7 GPON Application
Guide, or the E7 AE Application Guide.
407
Ethernet OAM Terminology

Throughout this guide, reference is made to many acronyms specific to OAM Terminology.
OAM - Operations, Administration and Maintenance
Includes the processes and standards involved in the operation, administration, and
maintenance of computer networks.
OAM Domain
An OAM Domain is defined as a network or sub-network operating at the Ethernet layer
and belonging to the same administrative entity within which OAM frames can be
exchanged. Each service provider and/or the operator network can be associated with an
administrative boundary. A service may be realized across single or multiple networks. An
OAM domain determines the span of an OAM flow across administration boundaries, and
can be hierarchical but should not overlap from an implementation prospective.
A subscriber OAM domain may be end-to-end and overlap multiple service providers
domains. These service provider domains may be transparent to the subscriber. A service
providers OAM domain may also overlap multiple network operators domains, which may
be transparent to the service providers domain or domains.
ME - Maintenance Entity
An OAM Maintenance Entity (ME) represents an OAM entity that supports or requires
management. Multiple MEs may be involved in different OAM domains. MEs correspond
purely to the Ethernet layer and are an association between two maintenance end points
within an OAM domain.
MEG - Maintenance Entity Group
A ME Group (MEG) is the logical domain within the Ethernet network. The MEG consists
of the MEs that belong to the same service inside a common OAM domain. A MEG is
associated to a specific VLAN, with several MEGs able to use the same VLAN value. For a
point-to-point circuit, a MEG contains two MEs. For a multipoint services, or multipoint-tomultipoint EVC services a MEG would contain multiple MEs.
Note that there is a terminology difference between ITU Y.1731 and IEEE 802.1ag. Where
Y.1731 uses MEG for the logical domain, 802.1ag uses Maintenance Association (MA) to
define the OAM domain containing MEs. For the purposes of this document, MEG will be
used to describe features in Y.1731 and 802.1ag.
408
MEP - Maintenance End Point

A MEG End Point (MEP) defines an edge of an Ethernet OAM domain. It is a provisioned
OAM reference point which can initiate and terminate proactive OAM frames. For an ONT
the MEP is an ONT port. A MEP can also initiate and react to diagnostic OAM frames.
A domain will have at least two MEPs within it though more are allowed. A point-to-point
application has two MEPs, one on each end point of the ME. A multipoint-to-multipoint
EVC service with n UNI interfaces has n MEPs, one on each end point. The domain may
extend beyond the ONT or E7 system in such cases where the MEP resides in a customer
CPE device or other element.
Note: Configuration of MEPs on IP Hosts is currently not supported on 740GE ONTs.
MEG Level - Maintenance Entity Group Level (0-7)
MEG Level is used to distinguish between OAM frames belonging to different nested MEs.
MEs belonging to the same MEG share a common MEG Level. Eight MEG Levels are used
for the purposes of Ethernet OAM in both Y.1731 and 802.1ag.
When a subscriber, service provider(s), and operator(s) share the MEG levels assignment, the
assignment of MEG Levels can be negotiated among the different parties. For most
applications the default MEG level for a subscriber is Level 7, 6 or 5, for service providers
Level 3 or 4, and for operator MEs Levels 2, 1, or 0.
MEG Levels are broken into groups to further define the administrative level of the MEG.
MEG Level Definitions
Level
Domain*
5-7
Customer
3-4
Service Provider
0-2
Network Operator
*Domains can be nested with the longest

path having the highest level
MIP - Maintenance Intermediate Point

MEG Intermediate Point (MIP) is a point within the domain that the user wants to monitor.
It is a provisioned OAM reference point which is capable to react to diagnostic OAM frames
initiated by MEPs. A MIP does not initiate proactive or diagnostic OAM frames. A MIP is
represented by a "circle" symbol in Figure 2.
Unlike MEPs, the MIPs cannot be associated to an ONT IP Host since the Ethernet
protocol does not continue past the IP Host. To support a network design where the MEP
extends past the ONT Ethernet port requires that the ONT act as both a MIP and MEP.
The number of MIPs in a point-to-point circuit or multipoint-to-multipoint Ethernet EVC
service is dependent on the specific deployments.
409
Service OAM
Within the Service OAM (SOAM), a ME includes the customer domain between two CPE's
(MEG Level 5-7), the Service provider Domain (UNI to UNI) between ONT GE ports, and
the Operator domain (end to end access provider's network or ENNI to UNI).
In the illustration below, the MEG includes a collection of:
Customer Domains between 2 CPE's at MEG-Level 5 through 7

Service Provider Doman (UNI to UNI between the ONT GE Ports
Individual Operator Domains (ENNI to UNI which includes the access provider's total
span)
SOAM Endpoints
SOAM Endpoints include Maintenance Endpoints (MEP) and Maintenance Intermediate
Points (MIP).
The MEP is an OAM reference point at the end of the Ethernet Virtual Circuit (EVC).
MEPs can initiate and terminate OAM frames, such as a link trace or loopback.
The MIP is an intermediate reference point with the OAM path. These intermediate points
only respond to OAM frames being sent - they cannot initiate or terminate a frame.
410
ONT MEP and MIP Interaction

Calix MDU ONT's interact with OAM frames as follows:
Service Provider MEPs are on the UNI-N interface located on the ONT.
Customer MEPs reside on the CPE equipment while MIPs reside on the ONT. This
intermediate endpoint provides access to the end of the service provider's domain.
As stated earlier, Calix 760GX and 740GE ONTs support OAM via 802.1ag CFM and
Y.1731 PM. In addition, RFC2544 Performance Verification provides out of service SLA
verification as well as provides a reflective feature with MAC swap per VLAN (enables
remote endpoint roundtrip testing).
SOAM MIBs
OAM stacks are fully defined and supported by SNMP MIBs. On the AE ONT, direct
control of on-demand SOAM test features are supported by SNMP agents while the PM
information being stored is retrievable via SNMP GET commands. Traps for Alarms and
Events as well as threshold crossing events use this same SNMP mechanism.
411
Note: A separate trap-receiver must be provisioned to capture these events.
412
Enabling Ethernet SOAM/CFM

To enable Ethernet OAM/CFM on a 740GE or 766GX ONT, run the cfm enable command
from the CLI.
Example
cfm enable
Ethernet Service OAM/CFM is enabled
Note: Running cfm disable disables SOAM functionality.

Defining Ethernet Service OAM Parameters
This topic describes how to configure the system Ethernet OAM object that controls the
Ethernet OAM functionality over the entire node. Type, Length, and Value (TLVs) are
described in the IEEE 802.1ag standard for Connectivity Fault Management (CFM) as a
method of encoding variable-length and/or optional information in a Packet Data Unit
(PDU). You can configure the TLVs to include additional information in the various CFM
PDUs:
Continuity Check Messages (CCM) with RDI-remote defect indication

Delay Measurement Messages (DMM)
Link Trace Message (LTM) (MAC trace-route)
Loopback Message (LBM) (MAC ping)
Note: Not every TLV is applicable for all types of CFM PDUs.
Defining Ethernet OAM domain parameters accomplished by running the cfm opttlv set
command from the CLI. Parameters can be enabled or disabled independently by applying
the cfm opttlv set command to the CCM, DMM, LTM, and LBM messages mentioned
above.
413
Ethernet OAM domain parameters

You can provision the following parameters for an Ethernet OAM domain:
cfm opttlv set
Usage
cfm opttlv set
Set optional TLV information for various message types (see Options below)
Options
cc
CC Messages
dm
Delay Measurement
lb
Loopback Messages
lt
Linktrace Messages
Parameters
tlv=<enum>
TLV to update
type: senderid, portstatus, ifstatus
enableordisable=<enum>
Enable or disable TLV

Example
cfm opttlv set cc tlv=senderid enableordisable=enable
Viewing current status

To display the current/updated SOAM settings, run the cfm opttlv show command
Example
cmf opttlv show
Optional TLV Parameters for Continuity Checks
SenderId
: Enabled
Port Status
: Enabled
Interface Status
: Enabled
Optional TLV Parameters for Link Trace Commands
SenderId
: Enabled
Optional TLV Parameters for Loopback Commands
SenderId
: Enabled
Data
: Enabled
Optional TLV Parameters for Delay Measurement Commands
Data
: Enabled
414
802.1ag MAID and Y.1731 MEG ID Compatibility Enhancements

In AE Release 2.2, Ethernet OAM capabilities have been enhanced to include functions that
improve compatibility with standard OAM test equipment and procedures:
The identifier compatibility issue of 802.1ag Maintenance Association ID (MAID) and

Y.1731 Maintenance Entity Group ID (MEG ID) standards has been addressed.
Enabling the Data TLV feature used to perform Y.1731 delay measurement tests with
large data frames (test systems suppliers such as EXFO and Spirent use this feature).
Note: Ethernet OAM is only supported on the 740GE and 760GX ONTs; it is not currently
supported on the 700GE and 700GX SFU ONTs.
802.1ag MAID and Y.1731 MEG ID Compatibility
The ITU and the IEEE are two standards organizations that define the terms and
requirements for Ethernet OAM testing and monitoring. Service OAM is defined by IEEE
802.1ag and ITU-T Y.1731 standards and deals with Ethernet services over any path: single
link, end-to-end, and intermediate point. Within these paths are groups of network elements
that must be identified during test and monitoring procedures. Unfortunately the IEEE
802.1ag and ITU-T Y.1731standards use incompatible identifiers (and different names) for
this string of network elements: 802.1ag Maintenance Association ID (MAID) and Y.1731
Maintenance Entity Group ID (MEG ID).
The MAID has two parts: the Maintenance Domain Name, and the Short Maintenance
Association Name that use up to 43 characters for identification. A MAID is equivalent to a
MEG ID but the MEG ID field is limited to 13 characters. The MEG ID or MAID is
unique over the OAM domain and each Continuity Check Message contains one of these
identifiers.
Calix supports an interoperability mode allowing a Y.1731 Stack to Interoperate with an
802.1ag Stack. This feature addresses the issue of the differing MEG ID and MAID formats.
When a Y.1731 Stack is enabled for 802.1ag interoperability it will support the 802.1ag
MAID format with up to 43 characters instead of the 13 character format.
Calix ONTs run the Y.1731 OAM Stack with 802.1ag Interoperability Mode disabled by
default. In release AE Release 2.1, when 802.1ag Interoperability Mode was enabled, Calix
ONTs send CCM messages using the short name only format for the MAID name. In AE
Release 2.2, in order to facilitate interoperability with 802.1ag implementations which do not
support the short name only format, OAM functionality was enhanced to support a fully
qualified MAID name.
415
The fully qualified MAID format includes a Maintenance Domain (MD) Name and MA
Name string. The MD name can optionally be specified when the MEG is created by
separating the MD and MA names with a | character. If a | is specified, all preceding
characters identify the MD name, and all subsequent characters identify the MA name. If the
| is specified when the MEG is created, CCM messages are sent with a fully qualified
MAID name. If the MEG is created without a | character, CCM messages are sent with the
short name only MAID name. The character string for either MAID formats cannot exceed
43 characters.
Note: For additional information on name formats, refer to tables 21-17 and 21-18 in section
21.6.5 of the 802.1ag specification.
The CLI configuration code for this feature is as follows:
cfm meg create 1 "adomain|anassoc 3 88 -ag
Note: The -ag must be specified to force continuity check interoperability in 802.1ag
mode.
Note: Name format provisioning is only supported in 802.1ag mode.
416
Data TLV Support for Y.1731 Delay Measurement

Type, Length, and Value (TLVs) are described in the IEEE 802.1ag Continuity Fault
Management (CFM) standard as a method of encoding variable-length, optional information
in a Protocol Data Unit (PDU). With AE Release 2.2, the Data TLV delay measurement
feature is automatically enabled on the ONT allowing it to respond to delay measurement
tests using data frames up to 1480 bytes. Test system manufacturers are using the Data TLV
to perform delay measurement tests with packets that are larger than the 64 bytes specified in
Y.1731. An example Delay Measurement Message (DMM) wireshark capture is show directly
below.
The ONT only responds to received delay-measurement messaged (DMM) by duplicating

the TLV in the delay-measurement response (DMR). It cannot create and initiate a DMM
containing a Data TLV.
Overview of Configuration Steps

Configuring Ethernet OAM functionality and initiating various actions and data retrievals
from the Ethernet network consists of the following process:
1. Enable Ethernet Service OAM/CFM (Using 802.1ag with Y.1731 extensions).
2. Create a Maintenance Entity Group (MEG) and assign a name, VLAN, and MEG level
(0-7) that represents where it logically resides within the network.
If the MEG auto-discovery parameter is disabled, Remote Maintenance Endpoints

should be defined to avoid alarms caused by detecting unknown MEPs.
Enable Remote MEP Autodetection
Set MEG Permissions
(Optional) Statically Provision MEP IDs
417
3. Specify the ONT port or IP host for each reference point to allow continuous
monitoring of the paths between the reference points and facilitate fault localization and
diagnosis:
The ONT ports or IP hosts at the edge of each MEG will be Maintenance Endpoints
(MEPs).
The ONT ports within each MEG will be Maintenance Intermediate Points (MIPs).
4. The continuity checks begin immediately after the MEP is created, if the Continuity
Check parameter is enabled.
5. Initiate a link trace from any MEP to determine what MIPs and MEPs are passed
through to get to a specified location.
6. Initiate one of two types of loopbacks:
To test the Ethernet OAM protocol, use the Ethernet OAM loopback.
To test actual service, use the service loopback.
After performing the procedures in this section, see Viewing OAM Link Trace and
Loopback Test Results.
418
Creating a Maintenance Entity Group

This topic describes how to create a Maintenance Entity Group (MEG) that consists of
Operation, Administration, and Maintenance (OAM) Maintenance Entities (ME), where an
ME is an association between two Maintenance End Points (MEP) within an OAM Domain.
Each MEP corresponds to a provisioned reference point at the edge of the MEG that
requires management.
The MEG defines a logical domain within the Ethernet network. A MEG is associated with a
specific VLAN. It is possible to have several MEGs using the same VLAN value.
Ethernet OAM maintenance entity group creation
You can provision the following parameters for an Ethernet OAM maintenance entity group:
cfm meg create
Usage
cfm meg create [-y1731] [-ag] megid= megname=<str> level= [vlan=]
Creates a Maintenance Entity Group
Options
-y1731
NEG Name Format is Y.1731
-ag
MEG Name format is 802.1ag
Parameters
megid=
Local handle to assign to MEG ID

megname=<str>
MEG Name
level=
MEG Level
vlan=
VLAN ID (omitted if vtype = none)

type: Unsigned (1, 4095)
419
Example
cfm meg create -ag megid=1 megname=B2B405 level=4 vlan=405
Note: Reference Sample OAM Configurations (on page 431) for additional examples.
Enable Remote MEP Autodetection
You must now enable Remote MEP Auto-detection to ensure remote MEPs are recognized.
cfm meg set autormep
Usage
cfm meg set autormep megid= enableordisable=<enum>
Set MEG autodetect and add remote MEPs.
Parameters
megid=
Local MEG ID
Enable or Disable
Example
CXNK0005DA51> cfm meg set autormep megid=1 enableordisable=enable
Result
CXNK0005DA51> cfm meg show
MEG ID
Level
VLAN
MEG Name
------ ---------- ---------- -------------------------------------------1
4
201
B2B201
MEG ID Permission CCM Intvl AD Timeout Auto RMEP CC Introp
------ ---------- ---------- ---------- ---------- ---------1
None
1 sec
100
True
Y.1731
420
Set MEG Permissions

The appropriate permissions that the MEG is bound by need to be established for OAM
frames at the ONT.
For each MEG, set the permission to "chassis". This ensures the chassis ID (ONT serial
number) is included in continuity check messages.
In AE mode, the ONT currently sends the IP address of the WAN port (but not serial
number) if the permission in the MEG is set to mgmtaddr. It will send both the serial
number and IP address of the WAN port if the permission is set to cmgmtaddr.
cfm meg set permission
Usage
cfm meg set permission megid= permission=<enum>
Set MEG permission level
Parameters
megid=
Local MEG ID
permission=<enum>
Permission Level
type: none, chassis, mgmtaddr, cmgmtaddr
Example
CXNK0005DA51> cfm meg set permission megid=1 permission=chassis
Result
MEG ID
Level
VLAN
MEG Name
------ ---------- ---------- --------------------------------------------1
4
201
B2B201
------ ---------- ---------- ---------- ---------- ---------1
Chassis
1 sec
100
True
Y.1731
421
Statically Provisioning MEGs

You can optionally static provision the identity of the remote MEP.
Note: MEP autodiscovery must be disabled to statically provision the remote MEP.
With remote MEP autodiscovery disabled, you can provision the remote MEP ID.
Note: If autodiscovery is turned on, autodiscovered MEPs will be displayed using the cfm
meg rmep show command along with locally configured MEPs.
If auto-discovery of MEPs is enabled, there will be no loss of continuity alarms when
continuity with a discovered MEP is lost. So the benefit of auto-discovery is you don't have
to provision remote MEPs, the downside is you aren't notified if continuity is lost.
Example
CXNK0005DA51> cfm meg set autormep megid=1 enableordisable=disable
CXNK0005DA51> cfm meg rmep add megid=1 mep=2012
Result
MEG ID
Level
VLAN
MEG Name
------ ---------- ---------- --------------------------------------------1
4
201
B2B201
------ ---------- ---------- ---------- ---------- ---------1
Chassis
1 sec
100
False
Y.1731
CXNK0005DA51> cfm meg rmep show megid=1

List of MEPs configured for MEG 1
MEP ID
-----2011
2012
Type
-----Static
Static
422
Creating the Maintenance End Point

This topic describes how to identify an ONT port as a Maintenance End Point (MEP) to a
specified Maintenance Entity Group (MEG), allowing continuous monitoring of the paths
between the end points and facilitating fault localization and diagnosis.
A MEP is a provisioned OAM reference point that can initiate and terminate proactive or
diagnostic OAM frames. A MEP defines an edge of an Ethernet OAM domain that could
extend beyond the system.
For alarm reporting to occur when MEPs are detected as missing, the initiating MEP must
have an accounting of the MEPs from which it is expecting to receive response Continuity
Check Messages (CCM). When MEPs are located outside of the system, the initiating MEP
can compile a MEP ID list using one of the following methods:
Reading a remote MEP ID list that you create

Detecting the MEPs through auto-discovery
See Adding a Remote Maintenance Entity Point for instructions on provisioning a remote
MEP.
See Creating a Maintenance Entity Group for instructions on setting the Auto-discovery
parameter.
Configuration guidelines
A domain must have at least two MEPs within it, although more are allowed.
A MEP inherits the VLAN assignment from the associated MEG.
To change the MEP ID, you must remove it, and then enter the new value for the MEP
ID.
Identifying an ONT port as a Maintenance End Point (MEP) for a specified Maintenance
Entity Group (MEG) allows for continuous monitoring of the paths between the end points
and facilitating fault localization and diagnosis.
A MEP is a provisioned OAM reference point that can initiate and terminate proactive or
diagnostic OAM frames. A MEP defines an edge of an Ethernet OAM domain that could
extend beyond the network.
For alarm reporting to occur when MEPs are detected as missing, the initiating MEP must
have an accounting of the MEPs from which it is expecting to receive response Continuity
Check Messages (CCM).
423
Notes on Creating MEPs
MEP ID must be unique within the MEG.

Direction of a MEP refers to the orientation of the physical device:
Down MEPs flow out of an interface to attached equipment.
Up MEPs flow inward to the switch fabric of the device.
Note: The MEP direction is Up if facing the network (WAN) or Down if facing the CPE
(ETH).
Priority refers to the p-bit of the OAM PDUs.

Continuity Check, Delay Measurement, and Loss Measurement can each be
or disabled.
The following parameters are configurable when creating a MEP:

cfm mep create
Usage
cfm mep create megid= mepid= direction=<enum> ifindex=<ifname>
Create a Maintenance End Point
Parameters
megid=
Local MEG ID
Unsigned (0,4095)
mepid=
Maintenance End Point ID

type:Unsigned (1,8191)
direction=<enum>
Up or down MEP
type: down, up
findex=<ifname>
Interface name (e.g., eth-0)

Example
CXNK0005DA51> cfm mep create megid=1 mepid=2011 direction=up ifindex=eth-1
Use the cfm mep show command to view existing MEPs
enabled
424
Example
CXNK0005DA51> cfm mep show
Result
MEP ID MEG ID
Dir
State
CC
I/F
VLAN
Priority
------ -------- -------- -------- -------- -------- -------- ------2011
1
up
Enabled Disabled
eth-1
201
7
MEP ID DM Resp Low Def CCM LM
Flt Det Flt Rst DM Act
LM Act
------ -------- -------- -------- -------- -------- -------- ------2011
Enabled
3
Disabled
2500
10000
False
False
Set MEP Priority

With the MEP created, you must now set the priority of the OAM Packet Data Unit (PDU).
Ideally, the user should set the pbit with the same priority as the data traffic.
cfm mep set priority
Usage
cfm mep set priority megid= mepid= priority=
Set priority (p-bit) for CC and LT messages
Parameters
megid=
Local MEG ID
Unsigned (0,4095)
mepid=

priority=
Priority of the OAM PDU

Example
CXNK0005DA51> cfm mep set priority megid=1 mepid=2011 priority=4
425
Result
MEP ID MEG ID
Dir
State
CC
I/F
VLAN
Priority
------ -------- -------- -------- -------- -------- -------- -------2011
1
up
Enabled Disabled
eth-1
201
4
LM Act
------ -------- -------- -------- -------- -------- -------- -------2011
Enabled
3
Disabled
2500
10000
False
False
Enable the MEP

By default, MEPs are enabled upon creation. However, if a MEP is disabled, use the
following commands to enable the MEP once again.
cfm mep set state
Usage
cfm mep set state megid= mepid= enableordisable=<enum>
Set admin state
Parameters
megid=
Local MEG ID
Unsigned (0,4095)
mepid=

Enable or Disable the MEP

Example
CXNK0005DA51> cfm mep set state megid=1 mepid=2011
enableordisable=enable
426
Result
MEP ID MEG ID
Dir
State
CC
I/F
VLAN
Priority
------ -------- -------- -------- -------- -------- -------- -------2011
1
up
Enabled Disabled
eth-1
201
4
LM Act
------ -------- -------- -------- -------- -------- -------- -------2011
Enabled
3
Disabled
2500
10000
False
False
(Optional) Specify the Alarm Threshold

Maintenance End Points can be modified to specify the minimum level of defect detection
for alarm triggering purposes. Each MEP can be modified as follows:
Threshold Values
Defect
Number
Defect
Name
Defect Definition
None
rdi
mac
Alarm MAC status defects
remote
Alarm remote MEP defects
error
Alarm receipt of CCM with incorrect time interval
xcon
Alarm cross-connect defects
Do not alarm continuity check defects

Alarm remote defect indications
cfm mep set lowpridefect

Usage
cfm mep set lowpridefect megid= mepid= defect=
Set the lowest priority defect to alarm.
Parameters
megid=
Local MEG ID
Unsigned (0,4095)
mepid=

defect=
Lowest priority defect number

427
Example
CXNK0005DA51> cfm mep set lowpridefect megid=1 mepid=2011 defect=5
Result
MEP ID MEG ID
Dir
State
CC
I/F
VLAN
Priority
------ -------- -------- -------- -------- -------- -------- -------2011
1
up
Enabled Enabled
eth-1
201
4
LM Act
------ -------- -------- -------- -------- -------- -------- -------2011
Enabled
5
Disabled
2500
10000
False
False
Enabling Continuity Checks

Continuity check messages (CCM) are generated and sent periodically in order to determine
network integrity. The interval for CCM is adjustable at the MEG level.
cfm mep set cc
Usage
cfm mep set cc megid= mepid= enableordisable=<enum>
Enable/disable continuity check messages
Parameters
megid=
Local MEG ID
Unsigned (0,4095)
mepid=

Enable or Disable Continuity Check Messages

findex=<ifname>
Interface name (e.g., eth-0)

428
Example
CXNK0005DA51> cfm mep set cc megid=1 mepid=2011
enableordisable=enable
Result
CXNK0005DA51> cfm mep cc show megid=1 mepid=2011
MEP ID
: 2011
MEG ID
: 1
MEG Level
: 4
Meg Name
: B2B201
MEP ID MEG ID
Dir
State
CC
I/F
VLAN
Priority
------ -------- -------- -------- -------- -------- -------- -------2011
1
up
Enabled Enabled
eth-1
201
4
LM Act
------ -------- -------- -------- -------- -------- -------- -------2011
Enabled
3
Disabled
2500
10000
False
False
429
Verifying Continuity Check Messages

From the command line, you can confirm that Continuity Check messages are being sent.
CXNK0005DA51> cfm mep stats show
Stats for MEP 2011 in MEG B2B201 on interface eth-1
-----------------------------------------------------------CCM Received
: 0
CCM Sent
: 538
CCM RDI Received
: 0
CCM RDI Sent
: 0
CCM SenderId Invalid
: 0
CCM Port Status Invalid
: 0
CCM Interface Status Invalid : 0
CCM Sequence Errors
: 0
Loopback Msgs Received
Loopback Msgs Sent
Loopback Msg Bad SenderId
: 0
: 0
: 0
Loopback
Loopback
Loopback
Loopback
Loopback
:
:
:
:
:
0
0
0
0
0
:
:
:
:
:
:
0
0
0
0
0
0
LinkTrace
LinkTrace
LinkTrace
LinkTrace
LinkTrace
LinkTrace
Resp
Resp
Resp
Resp
Resp
Received
Sent
Out of Order
Bad Msdu
Bad SenderId
Msg Received
Msg Sent
Bad Mac
Resp Received
Resp Sent
Resp Rx Unexpected
Loss Measurement Msg Received: 0

Loss Measurement Msg Sent
: 0
Loss Measurement Resp Rx
Loss Measuerment Resp Sent
: 0
: 0
Delay Measurement Msg Rx

Delay Measurement Msg Sent
: 0
: 0
Delay Measurement Resp Rx

Delay Measuerment Resp Sent
: 0
: 0
Note: To clear MEP statistics, run the cfm map stats clear command.
430
If wireshark is used on OAM frames, the follow filters should be used:
Display filter = cfm

Capture filter = ether host 01:80:c2:00:00:3x (where x = Meg Level of Continuity Check
Message [0 through 7]).
Creating Maintenance Intermediate Points

Maintenance Intermediate Point (MIP)s create a relationship to a Maintenance Entity Group
(MEG). A MIP is a provisioned OAM reference point that reacts to diagnostic OAM frames
initiated by Maintenance Entity Points (MEPs). A MIP does not initiate proactive or
diagnostic OAM frames.
Keep the following information in mind when working with MIPs:
At a minimum, MIPs require a MIP ID, an associated MEG, and a port.

MIP stats also available.
cfm mip create
Usage
cfm mip create megid= mipid= ifindex=<ifname>
Create a Maintenance Intermediate Point.
Parameters
megid=
Local MEG ID
Unsigned (0,4095)
mepid=

ifindex=<ifname>
Interface name for the Intermediate Point.

Example
CXNK0005DA51> cfm mip create megid=1 mipid=2011 ifindex=wan-0
Results
CXNK0005DA51> cfm mip show
MIP ID Interface
MEG ID
------ ---------- ---------2011
wan-0
1
431
Statistics
CXNK0005DA51> cfm mip stats show
Note: A No MIPs configured error is returned when attempting to run this command when
no MIPs are configured.
UP MHF Stats for MIP 2011 in MEG B2B201 on interface wan-0
----------------------------------------------------------------UP MHF Loopback Msgs Received
: 0
UP MHF Loopback Resp Sent
: 0
UP MHF LinkTrace Msg Received
: 0
UP MHF LinkTrace Msg Forwarded
: 0
UP MHF LinkTrace Resp Sent
: 0
UP MHF SenderId Invalid
: 0
UP MHF OAM Frames Discarded
: 0
DN MHF Stats for MIP 2011 in MEG B2B201 on interface wan-0
----------------------------------------------------------------DN MHF Loopback Msgs Received
: 0
DN MHF Loopback Resp Sent
: 0
DN MHF LinkTrace Msg Received
: 0
DN MHF LinkTrace Msg Forwarded
: 0
DN MHF LinkTrace Resp Sent
: 0
DN MHF SenderId Invalid
: 0
DN MHF OAM Frames Discarded
: 0
432
Sample OAM Configurations

The configurations below are examples of basic Connectivity Fault Management (CFM) with
Continuity Check Messaging (CCM) enabled. ONTs in this configuration are set-up for autodetection of the remote Maintenance Entity Point (MEP).
ONT #1
cfm enable
cfm meg create -y1731 megid=1 megname=B2B201 level=4 vlan=201
cfm meg set autormep megid=1 enableordisable=enable
cfm meg set permission megid=1 permission=chassis
cfm
cfm
cfm
cfm
mep
mep
mep
mep
create megid=1 mepid=2011 direction=up ifindex=eth-1

set priority megid=1 mepid=2011 priority=4
set state megid=1 mepid=2011 enableordisable=enable
set cc megid=1 mepid=2011 enableordisable=enable
cfm mip create megid=1 mipid=2011 ifindex=wan-0
ONT #2
cfm enable
cfm meg create -y1731 megid=1 megname=B2B201 level=4 vlan=201
cfm meg set autormep megid=1 enableordisable=enable
cfm meg set permission megid=1 permission=chassis
cfm
cfm
cfm
cfm
mep
mep
mep
mep

The configurations below are examples of basic Connectivity Fault Management (CFM) with
Continuity Check Messaging (CCM) enabled. Remote MEPs in these examples are predefined and auto-detection is disabled.
ONT #1
cfm enable
cfm
cfm
cfm
cfm
meg
meg
meg
meg
create -y1731 megid=1 megname=B2B201 level=4 vlan=201

set autormep megid=1 enableordisable=disable
set permission megid=1 permission=chassis
rmep add megid=1 mep=2012
433
cfm
cfm
cfm
cfm
mep
mep
mep
mep

ONT #2
cfm enable
cfm
cfm
cfm
cfm
meg
meg
meg
meg
create -y1731 megid=1 megname=B2B201 level=4 vlan=201

set autormep megid=1 enableordisable=disable
set permission megid=1 permission=chassis
rmep add megid=1 mep=2011
cfm
cfm
cfm
cfm
mep
mep
mep
mep

434
Link Trace (L2 Traceroute)

Link Trace is a user-initiated action that identifies the hops between the initiating MEP and a
specified reference point within the same domain. Link Trace is a Layer-2 trace route and will
display all MIPs on the path from source to destination.
Link Trace functions as follows:
All MIPs respond to the Link Trace Message (LTM) with a Link Trace Reply (LTR) and
forwards the LTM to the destination MEP. Once received, the destination (far end) MEP
responds as well.
The Trace command can be configured for the remote MEP ID or MEPs MAC address.
When using wireshark to capture traces, the follow filters are available:
LTM = cfm.opcode == 5
LTR = cfm.opcode == 4
cfm linktrace send
Usage
cfm linktrace send [-mac=<mac>] [-mep=] [-ttl=] [-usefdbonly]
[-nowait] [-wait] megid= mepid=
Send a link trace message.
Options
-mac=<mac>
MAC Address
type: MAC Address
-mep=
Destination MEP ID
type: Unsigned
-ttl=
Time to live (default = 8).

-usefdbonly
If set, set the useFdbOnly flag in linktrace message
-nowait
Do not wait for results to get displayed (default)
-wait
Wait for results to get displayed
Parameters
megid=
Local MEG ID
mepid=
MEP ID
435
Example
Note: The example below generates a linktrace message from MEP 2011 to MEP 2012 in
MEG 1 (B2B201) and waits for all replies (or 5 second timeout, whichever occurs first). As
shown, (2) MIPs replied and the terminal MEP replied.
CXNK0005DA51> cfm linktrace send megid=1 mepid=2011 -mep=2012 -wait
CXNK0005DA51> Linktrace replies for transaction 1
TTL
Responder MAC Address
LTM was forwarded
Terminal MEP was reached
:
:
:
:
63
00-06-31-2c-1b-c0
Yes
No
TTL
LTM was forwarded
:
:
:
:
62
00-06-31-26-8e-ef
Yes
No
TTL
LTM was forwarded
:
:
:
:
61
00-06-31-26-8e-eb
No
Yes
436
Link Trace Status

The CFM linktrace status command offers additional linktrace details if needed. This
"verbose" output includes the Chassis ID where each "hop" of the linktrace can be readily
identified.
CXNK0005DA51> cfm linktrace status -verbose megid=1 mepid=2011
Linktrace replies for transaction 1
TTL
LTM was forwarded
Use FDB Only
Last Egress ID
Last Egress MAC Address
Next Egress ID
Next Egress MAC Address
Relay Action
Ingress Port ID SubType
Ingress Port ID
Ingress Action
Ingress Address
Egress Port ID SubType
Egress Port ID
Egress Action
Egress Address
Sender ID TLV SubType
Sender ID TLV Chassis ID
Management Domain
Management Addr
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
63
00-06-31-2c-1b-c0
Yes
No
No
0
00-06-31-2c-1b-bc
0
00-06-31-2c-1b-c0
Relay Undefined
Reserved
NULL
Unknown
00-00-00-00-00-00
Reserved
NULL
OK
00-06-31-2c-1b-c0
Locally Assigned
CXNK0005DA51
NULL
NULL
TTL
LTM was forwarded
Use FDB Only
Last Egress ID
Last Egress MAC Address
Next Egress ID
Next Egress MAC Address
Relay Action
Ingress Port ID SubType
Ingress Port ID
Ingress Action
Ingress Address
Egress Port ID SubType
Egress Port ID
Egress Action
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
61
00-06-31-26-8e-eb
No
Yes
No
0
00-06-31-26-8e-ef
0
00-06-31-26-8e-eb
Relay Undefined
Reserved
NULL
Unknown
00-00-00-00-00-00
Reserved
NULL
OK
437
Egress Address
Sender ID TLV SubType
Sender ID TLV Chassis ID
Management Domain
Management Addr
:
:
:
:
:
00-06-31-26-8e-eb
Locally Assigned
CXNK0004B7F1
NULL
NULL
OAM Loopback (Layer-2 ping)

A Loopback Message (LBM) can be used to identify and localize a specific fault within a
network. Through the CMS or using the CLI a service provider can generate an on-demand
loopback request to a specific remote MEP ID or to the MAC address of a MIP.
The Link Trace database contains a list of all MIPs between its MEP and a remote MEP. The
CC database contains a list of all Remote MEP ID MAC addresses in the MEG. The user
can use the information contained in the Link Trace and/or CC database to determine a
unicast Destination Address (DA) for the loopback message, or the loopback message can be
sent with a Multicast DA (same as would be used for CC Message) in which case all MEPs in
the MEG will reply.
The MEP generates a loopback message addressed to a specific MIP or MEP within an
MEG. The destination MIP or MEP will respond with a Loopback Reply (LBR).
Initiating an Ethernet OAM multicast loopback test sends packets through the OAM domain
for viewing.
Running a multicast loopback test consists of the following:
Specifying and initiating MEP, only.

The initiating MEP sends the request and receives responses from all MEPs, MIPs do
not respond.
The results of the loopback test show the current remote MEP ID list.
Loopback messages (LBM) can be multicast or unicast and receive responses from multiple
remote MEPs. P-bit priority and a "discard eligible" bit are configurable in the VLAN
header.
438
cfm loopback send

Usage
cfm loopback send [-mac=<mac>] [-mep=] [-mc] [-pbit=]
[-dropEnable] [-nowait] [-wait] megid= mepid= [count=]
[length=<n>] [pattern=]
Send a loopback message.
Options
-mac=<mac>
MAC Address
type: MAC Address
-mep=
Destination MEP ID
type: Unsigned
-mc
Destination Multicast
-pbit=
P-Bit setting if VLAN MEP
-dropEnable
Sets the DE bit in the VLAN tag to 1 (default = 0)
-nowait
Do not wait for results to be displayed
-wait
Wait for results to be displayed
Parameters
megid=
Local MEG ID
mepid=
MEP ID
count=
Number of messages to send

length=<n>
Length of Data TLV

type: Integer (0,1400)
pattern=
Data TLV pattern (repeated for specified length)

type: Unsigned
Note: An error is reported if destination MAC or MEP ID is not specified.
439
OAM Loopback Examples

The following examples are offered to increase your understanding of the methodology:
The example immediately below generates 6 loopback messages to MEP 2012 and waits 5
seconds for responses.
CXNK0005DA51> cfm loopback send megid=1 mepid=2011 count=6 -mep=2012
-wait
Looback Status
Loopback Messages sent
Loopback Responses received
Loopback Reply MAC Addresses:
:
:
:
:
Complete
6
6
00-06-31-26-8e-eb
The example below generates a single loopback message using a multi-cast destination and
waits 5 seconds for any responses.
CXNK0005DA51> cfm loopback send megid=1 mepid=2011 -mc -wait
Looback Status
:
:
:
:
Complete
1
1
00-06-31-26-8e-eb
The example below generates a single loopback message to the specified MAC address and
waits 5 seconds for any responses.
CXNK0005DA51> cfm loopback send megid=1 mepid=2011 mac=00:06:31:26:8e:eb -wait
Looback Status
:
:
:
:
Complete
1
1
00-06-31-26-8e-eb
440
OAM Loopback Status

The loopback status command is useful to display the status of the previously initiated
loopback.
Note: Loopback Status is the only method of retrieving loopback history if the "-wait"
option is not specified.
cfm loopback status
Usage
cfm loopback status megid= mepid=
Display status of previously sent loopback
Parameters
megid=
Local MEG ID
Unsigned (0,4095)
mepid=

Example
CXNK0005DA51> cfm loopback status megid=1 mepid=2011
Looback Status
: Complete
: 1
: 1
: 00-06-31-26-8e-eb
441
RFC2544 Loopback
An RFC 2544 Loopback (Reflector) test is used to verify a circuit's performance and
compliance prior to turning the circuit on. This "out of service" test does not use the
Ethernet OAM loopback packets. Instead, a VLAN associated with an ONT port is
identified for being placed into service loopback mode where it returns all received nonOAM packets to the central monitor point by swapping the source/destination MAC
addresses.
The AE ONT is not able to generate traffic to test the loopback. Therefore, an external test
head or traffic generator must be provided to perform this loopback test.
Note: Management of the AE ONT IP Host is suspended during RFC2544 testing. In
addition, the IP Host interface can be used for the ifindex value, allowing for jitter testing on
VoIP traffic.
rfc2544 add
Usage
rfc2544 add ifindex=<ifname> vlan= [macaddr=<mac>]
Add a RFC 2544 Loopback Reflector
Parameters
ifindex=<ifname>
Interface name (for example, eth-0)

vlan=
VLAN ID
macaddr=<mac>
MAC address (defaults to interface MAC)

type: MAC Address
Example
CXNK0005DA51> rfc2544 add ifindex=eth-1 vlan=201
Result
RFC 2544 Reflector added for VLAN 201, MAC 00-06-31-2c-1b-bc on eth1
To view the status of any existing rfc2544 reflector tests, use the rfc2544 show command.
442
Example
CXNK0005DA51> rfc2544 show
Result
RFC 2544 Reflector Active for VLAN 201, MAC 00-06-31-2c-1b-bc on
interface eth-1
Delay Measurement Alarms

Additional Service OAM features are added by Y.1731 Performance Monitoring (PM), which
are also included in MEF 17. These features provide real-time feedback for Service Level
Agreements and in-service Ethernet Virtual Circuits (EVCs). OAM PM enables the provider
to monitor and report on service performance.
By default, delay measurement alarms are generated and cleared after thresholds exceed 10
consecutive samples.
Frame Delay Measurement
Frame delay measurements are enabled using the cfm dm start command. By specifying the
MAC address, the MEP and MEG level, delay measurement frames are sent at predetermined intervals. Alarms are generated based on the maximum round trip exceeding
defined parameters.
Note: Only one delay measurement session for a given MEP may be active at any one time.
The frame that is measured defaults to the first MEP in the CCM database if not specified in
the command.
443
cfm dm start
Usage
cfm dm start [-mac=<mac>] [-mep=] [-pattern=] [-length=]
megid= mepid= priority= interval=<enum> maxdelaysetthr= avgdelaysetthr=
maxvariationsetthr= avgvariationsetthr= [maxdelayclrthr=] [avgdelayclrthr=]
[maxvariationclrthr=] [avgvariationclrthr=]
Start delay measurement threshold check.
Options
-mac=<mac>
MAC Address
type: MAC Address
-mep=
Destination MEP ID
type: Unsigned
-pattern=
Data pattern to measure

type: Unsigned
-length=
Data length
type: Unsigned
444
Parameters
megid=
Local MEG ID
mepid=
MEP ID
priority=
P-Bit Setting
interval=<enum>
Message Interval
type: i1sec, i10sec
maxdelaysetthr=
Max Delay Set Threshold (seconds)

type: Unsigned
avgdelaysetthr=
Average Delay Set Threshold (seconds)

type: Unsigned
maxvariationsetthr=
Max Delay Variation Set threshold (seconds)

type: Unsigned
avgvariationsetthr=
Average Delay Variation Set Threshold (seconds)

type: Unsigned
maxdelayclrthr=
Max Delay Clear threshold (defaults to maxdelaysetthr).

type: Unsigned
avgdelayclrthr=
Average Delay Variation Clear Threshold (defaults to maxvariationsetthr)

type: Unsigned
maxvariationclrthr=
Average Delay Variation Clear Threshold (defaults to maxvariationsetthr)

type: Unsigned
avgvariationclrthr=
Average Delay Variation Clear Threshold (defaults to avgvariationsetthr)

type: Unsigned
445
In the example below, delay measurement is enabled for MEP 2011 in MEG1 (B2B201).
Delay measurement frames are sent with a p-bit value of 5 every second. Alarms are
generated if the max round trip delay exceeds 2 milliseconds, average round trip delay
exceeds 1 millisecond, and max round trip delay variation (jitter) exceeds 1 millisecond or
average round trip delay variation exceeds 500 seconds.
Example
CXNK0005DA51> cfm dm start megid=1 mepid=2011 priority=5
interval=i1sec maxdelaysetthr=2000 avgdelaysetthr=1000
maxvariationsetthr=1000 avgvariationsetthr=500
Delay Measurement started for MEP ID 2011
Frame Delay Statistics

Running the cfm dm show command provides frame delay statistics from a MEG ID
perspective. Minimum, maximum, and average statistics are displayed and reflect all counters
since the last time counters were cleared.
cfm dm show
Usage
cfm dm show megid= mepid=
display running frame delay measurement counters.
Parameters
megid=
Local MEG ID
mepid=
MEP ID
446
Example
CXNK0005DA51> cfm dm show megid=1 mepid=2011
Ongoing Delay Measurement Results and Statistics
Current Delay Measurement State
Local MEP ID
Remote MEP ID
Remote MAC Address
Priority
Interval
Minimum Round Trip Delay
Maximum Round Trip Delay
Average Round Trip Delay
Minimum Round Trip Delay Variation
Maximum Round Trip Delay Variation
Average Round Trip Delay Variation
Minimum Far End Processing
Maximum Far End Processing
Average Far End Processing
Max Delay Set Threshold
Max Delay Clear Threshold
Average Delay Set Threshold
Average Delay Clear Threshold
Max Delay Variation Set Threshold
Max Delay Variation Clear Threshold
Average Delay Variation Set Threshold
Average Delay Variation Clear Threshold
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
Enabled
2011
2012
00-06-31-26-8e-eb
5
1 Second
11 usec
14 usec
11 usec
0 usec
2 usec
0 usec
257 usec
345 usec
325 usec
2000 usec
2000 usec
1000 usec
1000 usec
1000 usec
1000 usec
500 usec
500 usec
Loss Measurement Alarms

Additional Service OAM features are added by Y.1731 Performance Monitoring (PM), which
are also included in MEF 17. These features provide real-time feedback for Service Level
Agreements and in-service Ethernet Virtual Circuits (EVCs). OAM PM enables the provider
to monitor and report on service performance.
By default, loss measurement alarms are generated and cleared after thresholds exceed 10
consecutive samples.
Frame Loss Measurement
Frame loss measurements are enabled using the cfm lm start command. By specifying the
MAC address, the MEP and MEG level, loss measurement frames are sent at pre-determined
intervals. Alarms are generated based on the measured frame loss exceeding the defined
parameters.
447
Note: Loss measurement is only supported on point to point MEGs (in other words, only 2
end points are defined).
Single vs. dual ended loss measurement statistics are available as follows:
Loss is measured by passing sent and received frame counts for a specific VLAN
between two entities. The main difference between single and dual ended loss
measurement is how these frame counts are passed back and forth. Single ended uses
LMM and LMR messages while dual ended piggybacks this info in the CCM messages.
Also, single ended measures loss on a specific vlan/p-bit. Dual ended loss measurement
measures on a VLAN (aggregate of all p-bit counts) basis.
Single ended only requires LM to be enabled on a single MEP to be effective (sends a
LMM message and receives a LMR from remote MEP). Dual ended requires both sides
since CCM messages only go one direction (i.e., there is no CCR (CC reply message)).
cfm lm start
Usage
cfm lm start [-mac=<mac>] [-mep=] [-pattern=] [-length=]
megid= mepid= priority= interval=<enum> maxdelaysetthr=
avgdelaysetthr= maxvariationsetthr= avgvariationsetthr= [maxdelayclrthr=]
[avgdelayclrthr=] [maxvariationclrthr=] [avgvariationclrthr=]
Start loss measurement threshold check.
Options
-single
initiate single-ended Loss measurement using

LMM/LMR messages (default)
-dual
Initiate double-ended loss measurement as part of

Continuity Check
-mac=<mac>
MAC Address
type: MAC Address
-mep=
Destination MEP ID
type: Unsigned
448
Parameters
megid=
Local MEG ID
mepid=
MEP ID
priority=
P-Bit Setting
interval=<enum>
Message Interval
type: i1sec, i10sec
nearendlossmaxsetthr=
Near end maximum loss ratio set threshold (in 1/10000

of a percent. For example, 90000 = 9.0000%)
type: Unsigned
nearendlossavgsetthr=
Near end average loss ratio set threshold (in 1/10000 of

a percent. For example, 90000 = 9.0000%)
type: Unsigned
farendlossmaxsetthr=
Far end maximum loss ratio set threshold (in 1/10000 of

type: Unsigned
farendlossavgsetthr=
Far end average loss ratio set threshold (in 1/10000 of a

percent. For example, 90000 = 9.0000%)
type: Unsigned
nearendlossmaxclrthr=
Near end maximum loss ratio clear threshold (in 1/10000

type: Unsigned
nearendlossavgclrthr=
Near end average loss ratio clear threshold (in 1/10000

type: Unsigned
farendlossmaxclrthr=
Far end maximum loss ratio clear threshold (in 1/10000

type: Unsigned
farendlosssavgclrthr=
Far end average loss ratio clear threshold (in 1/10000 of

type: Unsigned
449
Example
CXNK0005DA51> cfm lm start megid=1 mepid=2011 priority=4
interval=i1sec nearendlossmaxsetthr=50000 nearendlossavgsetthr=30000
farendlossmaxsetthr=50000 farendlossavgsetthr=30000
Loss Measurement started for MEP ID 2011
Frame Loss Statistics

Running the cfm lm show command provides frame loss statistics from a MEG ID
perspective. Minimum, maximum, and average statistics for near end and far end frames are
displayed and reflect all counters since the last time counters were cleared.
cfm lm show
Usage
cfm lm show megid= mepid=
Display running frame loss measurement counters.
Parameters
megid=
Local MEG ID
mepid=
MEP ID
Example
CXNK0005DA51> cfm lm show megid=1 mepid=2011
Ongoing LM Session Results and Statistics:
Current Loss Measurement State
Local MEP ID
Remote MEP ID
Remote MAC Address
Priority
Interval
Loss Measurement Type
Near End Frame Loss Minimum
Near End Frame Loss Maximum
Near End Frame Loss Average
Near End Frame Loss Current
Far End Frame Loss Minimum
Far End Frame Loss Maximum
Far End Frame Loss Average
:
:
:
:
:
:
:
:
:
:
:
:
:
: Enabled
2011
2012
00-06-31-26-8e-eb
4
1 Second
Single-Ended
0.0000%
0.0000%
0.0000%
0.0000%
0.0000%
0.0000%
0.0000%
450
Far End Frame Loss Current
Current Near End Lost Packets
Current Far End Lost Packets
Current Rx Frame Count
Current Tx Frame Count
Near End Max Loss Set Threshold
Near End Max Loss Clear Threshold
Far End Max Loss Set Threshold
Far End Max Loss Clear Threshold
Near End Avg Loss Set Threshold
Near End Avg Loss Clear Threshold
Far End Avg Loss Set Threshold
Far End Avg Loss Clear Threshold
:
:
:
:
:
:
:
:
:
:
:
:
:
0.0000%
0
0
0
0
5.0000%
5.0000%
5.0000%
5.0000%
3.0000%
3.0000%
3.0000%
3.0000%
Initiating an 802.3ah Loopback Test and Viewing the Results (Link

OAM)
IEEE Standard 802.3ah is often called Ethernet in the First Mile (EFM). EFM OAM is
associated with a single Ethernet link. It defines Ethernet delivery over copper, fiber and
PON and provides specifications for the following link management OAM functions:
Discovery and Link Monitoring, with messages to MAC client or CMS

Remote Failure Indication (RFI), including Link Fault, Dying Gasp (see below) and other
critical events.
Remote Loopback testing to benchmark link performance (service affecting)
Management Information Base (MIB) variable retrieval
Organization-specific functions
Link OAM provides loopback test capability between two individual Ethernet links. Using
this method, the "Source" device sends out a request to the "Destination" device to verify
link integrity between the two components. The Destination responds and switches to
loopback mode awaiting packet delivery. Once the loopback traffic is sent, the Destination
sends the packet back to the Source where it is verified and discarded.
This section describes how to initiate an 802.3ah loopback test that monitors individual
Ethernet links, link status, and link faults.
Note: The 802.3ah loopback test can only be executed and results viewed from the
Command Line Interface.
451
About Dying Gasp Messages

A critical requirement of 802.3ah is to notify any device on the network that a loss of power
has occurred. A Dying Gasp message, whether generated at the subscriber end (equipment
attached to an ONT Ethernet port has issued a dying gasp) or at the ONT itself (the ONT
has lost power and issued a dying gasp), is intended to notify the provider via an alarm
message. This alarm advises the provider that an outage has occurred, allowing the provider
to decide whether a truck roll is in order.
Note: Dying Gasp messages issued by subscriber equipment connected to an ONT Ethernet
port will generate an rxDyingGaspEth"x" alarm within CMS (where "X" refers to the ONT
Ethernet port number where the Dying Gasp message was received).
Note: Due to hardware capacitance issues, 76xGX and 74xGE ONTs shut down too quickly
creating a situation where the Dying Gasp message does not have enough time to be sent.
For this reason, ONT Dying Gasp messages are triggered when a Low Battery condition
exists on these ONTs (which generates its own "low battery" alarm within CMS).
Configuring Link OAM
Link OAM is enabled using the efm device mode set command.
efm device mode set
Usage
efm device mode set ifindex=<ifname> mode=<enum>
Set Link OAM Mode
Parameters
ifindex=<ifname>
Interface name (for example, eth-0)

type: Interface name
mode=<enum>
Link OAM/EFM Mode

type:active, passive
Note: Link OAM is supported on MDU ONTs with 4 Ethernet ports or less. Link OAM is
not currently supported on 762GX or 763GX ONTs.
Example
CXNK0005DA51> efm device mode set ifindex=eth-3 mode=active
CXNK0005DA51> efm device state set ifindex=eth-3 state=enable
Link OAM/EFM Admin State for eth-1 set to Enabled
452
Link OAM is activated on a per-port basis. When configuring Link OAM, each port can be
set to active (initiates the discovery process) or passive (waits for discovery messages). Set the
subscriber port to active and then enable link OAM.
Link OAM Capabilities
Capability
Active DTE
Passive DTE
Initiates OAM Discovery Process
Yes
No
Reacts to OAM discovery Process
Yes
Yes
Required to send information OAMPDUs
Yes
Yes
Permitted to Send Event Notification OAMPDUs
Yes
Yes
Permitted to Send Variable Requests OAMPDUs
Yes
No
Permitted to Send Variable Response OAMPDUs
Yes*
Yes
Permitted to Send Loopback Control OAMPDUs

Reacts to Loopback Control OAMPDUs
Permitted to Send Organization Specific OAMPDUs
Yes
No
Yes
Yes
Yes
Yes
* - Requires the peer DTE to be in Active mode.
Link OAM Service and Port Status

To check the current status of Link OAM port status, use the efm device show command.
CXNK0005DA51> efm device show
I/F
-----eth-0
eth-1
eth-2
eth-3
wan-0
Admin
Mode
In Svc
Engaged
Local Disc
Remote Disc
-------- -------- -------- -------- --------------- --------------Disabled Active Disabled Disabled
N/A
N/A
Disabled Active Disabled Disabled
N/A
N/A
Disabled Active Disabled Disabled
N/A
N/A
Enabled Active
Enabled Enabled
Send Any
Complete
Disabled Active
Enabled Disabled
N/A
N/A
To verify the current status of Link OAM, use the efm show command. To toggle Link OAM, use
the efm enable and efm disable command.
CXNK0005DA51> efm show
Ethernet Link OAM is
disabled
CXNK0005DA51> efm enable

Ethernet Link OAM is enabled
CXNK0005DA51> efm show
Ethernet Link OAM is
Power Status is
Dying Gasp is
enabled
normal
disabled
453
Additional Link OAM Commands

By Default, an ONT Ethernet port will not allow itself to be placed in remote loopback
mode. To over-ride the default behavior, enable the capability as follows:
CXNK0005DA51> efm device capabilities set ifindex=eth-3
capability=loopback enableordisable=enable
Remote Loopback Mode enabled for eth-1
To view the status of each individual port, run the following command:
CXNK0005DA51> efm device capabilities show
I/F
Mode
Unidirect Loopback
Link Mon Var Retrvl
------ ---------- ---------- ---------- ---------- ---------eth-0
Active
no
no
yes
no
eth-1
Active
no
no
yes
no
eth-2
Active
no
no
yes
no
eth-3
Active
no
yes
yes
no
wan-0
Active
no
no
yes
no
To initiate a remote loopback session with a peer device, run the following command:
efm remote loopback set ifindex=eth-3 state=enable
To stop a remote loopback session with a peer device, run the following command:
efm remote loopback set ifindex=eth-3 state=disable
To display the current remote loopback status and display interface state changes since the
loopback was started, run the following command:
CXNK0005DA51> efm remote loopback show eth-3
Remote Loopback Status for 'eth-3' is: on
Loopback Statistics for eth-3
InOctets
InUcastPkts InNUcastPkts
OutOctets OutUcastPkts OutNUcastPkt
------------ ------------ ------------ ------------ ------------ -----------3456
0
0
3456
0
0
InDiscards
InErrors
InUnkwnProt OutDiscards
OutErrors
OutQLen
------------ ------------ ------------ ------------ ------------ -----------0
0
0
0
0
0
454

Managing Aeonts Cli Ae2-2

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Managing Aeonts Cli Ae2-2

Hochgeladen von

Copyright:

Verfügbare Formate

Managing Calix Active Ethernet

ONTs from the Command Line

Chapter 2: Configuring an AE System ................................ 71

Chapter 3: Understanding AE ONT Configuration Files .... 87

Chapter 4: AE Deployment Options .................................. 137

Chapter 5: Automatic ONT Creation - Smart Activate ..... 145

Chapter 6: Turning Up an AE ONT

Chapter 7: System Maintenance and Troubleshooting .... 195

Chapter 8: CMS Servicing, Performance Monitoring and

Appendix A Command Reference ..................................... 213

Voice Service Commands ..................................................................................... 281

Serviceability and Troubleshooting Commands ................................................ 336

Ethernet OAM Provisioning .................................................................................. 405

About this Guide

Overview of AE Systems - Includes information on network topology, attributes, and

AE terminology in this document is intended to differentiate this technology from the

Ethernet Data Service Features

AE Subscriber Port Association functionality

E7 GE-12 Card: Provides (12) GE interfaces per card, supporting up to 24 total

Voice Service Profile (SIP, TDM Gateway, H.248, MGCP)

2. The AE voice port is configured.

3. The Provisionable POTS loss plan is set per your requirements.

TDM gateway service (GR-303, GR-08):

Ports tab approach:

Ports tab approach:

Ports tab approach:

Provisionable POTS Loss Plan

voip add (on page 283)

Session Initiated Protocol (SIP)

Provisioning Peer-to-Peer VoIP Service

g. Ensure the voice switch is configured on the same subnet.

create -dhcp=disable -gwf=disabled -static=10.23.26.2

2. The following parameters must be configured to provision DHCP SIP service:

create -dhcp-enable -wwf=disable dev=iph-1

Calix TDM Gateway (CTG)

Ground Start POTS Service

The following AE CLI commands support the linemode option:

voip add (on page 283)

ctg add (on page 285)

voip setup (on page 281)

ctg setup (on page 285)

Ethernet Data Services

MAC address Organizationally Unique Identifier (OUI) - included in Release 1.0

New features in AE Release 2.0 include (described in detail below):

Note: MAC DA/SA was part of an earlier AE software release.

Process up to 2.6 million packets per second (pps) in aggregate

Process up to 2.7 million pps (line rate) in aggregate

About Traffic Policing and Traffic Shaping

7xxGE or 76xGX ONT Sawtooth Bandwidth Pattern

7xxGX SFU ONT Smooth Bandwidth Pattern

Calculating 700GE ONT Policed Rates

AE Data Rate Limiting and Traffic Shapers

7xxGE and 76xGX per VID Rate Limiting Granularity

High Speed Internet Traffic Shaping for 700GE ONTs

CXNK08900005> meter ookla vlan

WAN VLAN Id value flow (1-4094)

Example: meter ookla vlanid 200

Business Ethernet Services

Common P-Bit mapping assignments are shown below:

Bridge blocking of protocols

Bridge Protocol Data Unit (BPDU)

Generic Attribute Registration

All LAN Bridge Management Group

L2CP Filter Considerations