AE ONT Config Guide R20

Active Ethernet ONT Configuration Guide, R2.
November 2010
#220-00372, Rev 10
Contents
About this Guide .................................................................... 10 Chapter 1: Active Ethernet Overview .................................. 13
AE Topology ............................................................................................................ 13 Key AE Attributes ........................................................................................... 14 AE Components ............................................................................................. 15 AE Features ............................................................................................................. 16 Voice Services ............................................................................................... 17 Ethernet Data Services .................................................................................. 20 IPTV ............................................................................................................... 23 T1 Services via PWE3 ................................................................................... 26 ONT Inventory ................................................................................................ 29 Calix ONTs............................................................................................................... 31 ONT Models ................................................................................................... 31 ONT Optics Characteristics ............................................................................ 32 AE Optical Links ............................................................................................. 33
Chapter 2: AE Configuration ................................................ 35

ONT Operational Overview .................................................................................... 35 AE Configuration Overview ................................................................................... 36 AE Architecture Overview .............................................................................. 37 Configuration Example ................................................................................... 38 Network Component Overview .............................................................................. 39
Proprietary Information: Not for use or disclosure except by written agreement with Calix. Calix. All Rights Reserved.
AE Services Overview ............................................................................................ 42 AE Deployment Scenarios ..................................................................................... 43 Unmanaged Pass-through ONT ..................................................................... 43 Unmanaged Single VLAN Mapping................................................................ 45 Managed ONT Basic Service - VLAN per Port ............................................... 46 ONT Basic Multi-service - VLAN per Service ................................................. 48
Chapter 3: Configuring an AE System ................................ 49

AE System Requirements ...................................................................................... 49 Notes on Configuring the DHCP Server ................................................................ 50 About DHCP................................................................................................... 51 Configuring the CMS Server for DHCP Service (Red Hat Linux) ................... 53 Notes on Configuring the NTP Server................................................................... 58 Configuring the CMS Server as the NTP Source (Red Hat Linux) ................. 58 Notes on Configuring the Syslog Server .............................................................. 62 Notes on Configuring the SIP Server .................................................................... 63 Notes on Configuring FTP ..................................................................................... 64 File Permission Basics ................................................................................... 64 About the umask Command ........................................................................... 67
Chapter 4: Understanding AE ONT Configuration Files .... 69

Active Ethernet Provisioning ................................................................................. 69 About Configuration Files ...................................................................................... 70 AE ONT Turn-up Pre-Requisites ............................................................................ 71 Configuration File Structure .................................................................................. 72 Configuration File Locations ................................................................................. 73 Synchronizing AE ONT Configuration Files ......................................................... 74 Configuration File Characteristics ........................................................................ 75 Configuration File Hierarchy .................................................................................. 76 Sample Configuration File ..................................................................................... 77
Configuration File Processing ............................................................................... 80 Creating a Configuration File ................................................................................. 81 Building Cascading Configuration Files.......................................................... 81 Building Monolithic Configuration Files .......................................................... 81 About VoIP and the VoIP Configuration File ........................................................ 82 Creating the VoIP Configuration File .............................................................. 83 ONT SIP Configuration File Parameters ........................................................ 84
Chapter 5: Turning Up an AE ONT via CMS ........................ 89

CMS Appliance ........................................................................................................ 90 Configuring Primary and Secondary TFTP Servers............................................. 91 Synchronizing AE ONT Configuration Files ......................................................... 92 Local Provisioning Persistence ...................................................................... 93 ONT Creation ........................................................................................................... 95 Configuring the Management VLAN...................................................................... 95 Pre-provisioning an AE ONT .................................................................................. 97 ONT Discovery ........................................................................................................ 98 CLI Cut-Through ................................................................................................... 100
Chapter 6: Provisioning Services on an AE ONT via CMS101

About the Provisioning Screens.......................................................................... 101 Provisioning an ONT Ethernet Port for Data ...................................................... 102 Provisioning an ONT Ethernet Port for Video .................................................... 103 Provisioning DS0 Voice Ports ............................................................................. 103 About Voice Port Configuration Files ........................................................... 103 Provisioning a CTG Voice Port..................................................................... 104 Provisioning a SIP Port ................................................................................ 105
Chapter 7: Managing AE ONTs through CMS ................... 107

Performing AE ONT Searches ............................................................................. 108 Moving an AE ONT in the Navigation Tree ......................................................... 113 Working in Map View ............................................................................................ 114 Removing AE ONT Services ................................................................................ 116 Resetting an AE ONT ............................................................................................ 117
Chapter 8: Turning Up an AE ONT via CLI ........................ 119

Network Pre-requisites ......................................................................................... 120 Additional Considerations ................................................................................... 120 Configuring the Management VLAN.................................................................... 122 ONT Boot Process ................................................................................................ 123 Establishing a Link to the Switch .................................................................. 124 Obtaining an IP Address .............................................................................. 124 Provisioning the AE ONT ............................................................................. 124 About Auto-Detect Behavior on the ONT ..................................................... 125 Configuring Option-82 .................................................................................. 125 Monitoring the ONT .............................................................................................. 126 About Syslog Events .................................................................................... 126 About Alarms................................................................................................ 127 Creating SNMP Trap Receivers ........................................................................... 128 Bridging ................................................................................................................. 128 VLAN per Port Bridge ................................................................................... 129 VLAN per Service Bridge ............................................................................. 129 IGMP Snoop VLAN per Service ................................................................... 130 IP Host ......................................................................................................... 130 Remote Management Interface Script ................................................................. 131 Retrieving Current Alarms ............................................................................ 132 Resetting an ONT by Serial Number ............................................................ 132 Creating a Layer-2 Pipe for HPNA Maintenance and Monitoring ...................... 133 Configuring the AE ONT for HPNA Deployment .......................................... 133
Chapter 9: AE Deployment Options ................................... 135

Residential Gateway Characteristics .................................................................. 136 Non-Residential Gateway Characteristics .......................................................... 137 External Router Characteristics .......................................................................... 138 Metering and Traffic Shaping .............................................................................. 138 Subscriber-VLAN to WAN-VLAN Mapping Overview ......................................... 140 Level 1: L2 Mapping Filter Table .................................................................. 143 Level 2: L2 Mapping/Filtering Table ............................................................. 143 VLAN Tagging Mapping and Conversion for Multicast Streams................... 143
Chapter 10: Command Line Interface (CLI) ....................... 145

Overview ................................................................................................................ 145 Telnet Interface ..................................................................................................... 146 Command Line Help ............................................................................................. 146 Command Line Conventions ............................................................................... 148
Chapter 11: Remote ONT Activation .................................. 151

RONTA Overview .................................................................................................. 151 Master Reset ................................................................................................ 152 Assigning a Registration ID to an ONT (AE Mode) ...................................... 153 Assigning a Management VLAN to an AE ONT ........................................... 154 Assigning an ONT to Unmanaged Mode...................................................... 155 Assigning a Registration ID to an AE ONT ................................................... 157 ONT Provisioning Persistence ............................................................................ 158 ONT Inventory Management (Option-43) ............................................................ 159
Chapter 12: System Maintenance and Troubleshooting . 161

Configuration File Back-up .................................................................................. 161 Download Failures ................................................................................................ 162 TFTP Server Not Responding ...................................................................... 163 TFTP Server Responds "File not Found" ..................................................... 163 Download Transfer Interrupted..................................................................... 163 Serviceability Characteristics .............................................................................. 164 ONT Retry Behavior ..................................................................................... 165 Viewing ONT Alarms and Events in CMS ........................................................... 167 Channel and Drop Testing ................................................................................... 168 Pinging AE ONTs .................................................................................................. 169 Diagnostic Commands ......................................................................................... 171 CMS Performance Monitoring and Alarm Aggregation ..................................... 172 SNMP Monitoring: PM and Statistical MIBs ........................................................ 172 Troubleshooting AE ONT Ethernet Issues - CLI................................................. 173 Troubleshooting AE ONT Ethernet Issues - CMS .............................................. 177 Sample Configuration Files - AE ONT ................................................................. 178 Cascading CF .............................................................................................. 179 Sample SIP Configuration File ..................................................................... 193 Sample Configuration Files - CMS ...................................................................... 205 AE ONT CF .................................................................................................. 205 Common CF ................................................................................................. 206 Data Service CF ........................................................................................... 207 Bandwidth Profile CF ................................................................................... 208 Video CF ...................................................................................................... 210
Appendix A ........................................................................... 211

Glossary ................................................................................................................ 211 Command Reference ............................................................................................ 214 Viewing Commands ..................................................................................... 215 Config Commands ....................................................................................... 215 IfTable Commands ....................................................................................... 220 Ethert Commands ........................................................................................ 223 Meter Commands......................................................................................... 224 Bridge Commands ....................................................................................... 232 DHCP Relay - Option-82 Commands........................................................... 259 pwe3 e1port ................................................................................................. 273 pwe3 service create ..................................................................................... 274 pwe3 service delete ..................................................................................... 275 PWE3 PM Statistics ..................................................................................... 276 Pseudowire Commands ............................................................................... 282 PWE3 Provisioning Example........................................................................ 287 IPTV Commands .......................................................................................... 291 Troubleshooting Commands ........................................................................ 302 Channel and Drop Testing (vtst test)............................................................ 304 VoIP Commands .......................................................................................... 308 DHCP Option-43 Configuration Process ...................................................... 328 Message Posting Protocol Commands ........................................................ 331 Miscellaneous Serviceability Commands ..................................................... 335
10
About this Guide

The Calix Active Ethernet (AE) ONT Configuration Guide includes information on the following: AE System Overview - Includes information on AE versus GPON topology, and details the features and characteristics of the Calix GX ONT. AE System Configuration - Details ONT operation, various AE configurations, AE network components, AE services, and various AE deployment scenarios. 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. 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, subscriber to WAN mapping, and in Unmanaged mode (pass-through). Command Line Interface (CLI) - Details the CLI, the syntax used, and various conventions used for provisioning an AE ONT. System Troubleshooting - This section describes various TFTP errors, ONT Retry behavior if boot-up is unsuccessful, and the Viewing of AE ONT alarms in CMS. Appendix - Includes a glossary of terms, an AE CLI Command Reference, as well as sample configuration files that may be used as templates. 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 E5-400 Ethernet Transport and Aggregation Platform, other standards based third party Ethernet switching platforms, as well as knowledge of Small Form-factor Pluggable (SFP) fiber technology is highly recommended.
11
Related Documentation You can access the complete set of Calix user documentation from the Calix Resource Center, accessible online at www.calix.com. The Calix Active Ethernet ONT documentation set includes: Calix 700GX SFU ONT Installation Guide Calix 700GE SFU ONT Installation Guide Calix ONT Maintenance and Troubleshooting Guide Calix Customer Premises Equipment Grounding Guide Calix ONT Battery Calculator Guide Calix Management System (CMS) Guide Calix 700GX Active Ethernet Quick Start Guide
12
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, 700GE, and 760GX ONTs receive broadband data, VoIP (SIP or TDM) telephone service, and IP based video (IPTV) using point-to-point fiber links within the network.
14
Key AE Attributes
The Calix AE 2.0 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 Integrated GE and 10GE aggregation and transport using C-Series (C7) and E-Series (E5, E5-400) platforms Single family (SFU) and Multi-Dwelling (MDU) services Small business, multi-tenant, and mobile backhaul applications Indoor and outdoor mountable ONTs with auto-detect GPON/AE adaptive optics Loop start and ground start voice services SIP and H.248 VoIP services with integrated ONT clients GR-303, GR-57, and TR-08 Model II TDM voice switch interfaces using the Calix C7 TDM Voice Gateway Ethernet data services, including high speed Internet access and ME-compliant E-Line and E-LAN (TLS) services 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 BIDI SFP modules and Compact SFP modules for single fiber and high density AE applications 60 Km network reach on a single fiber link MAC Forced Forwarding (MFF) allowing for additional network security
15
AE Components
Each subscriber on an AE network is connected to the optical network via a single fiber at pre-determined aggregation points. A typical AE network consists of the following components: 700GX, 760GX and 700GE ONTs: The ONTs mount at the subscriber's premises. It provides subscriber interfaces for POTS, Ethernet High Speed Data, IPTV and T1/E1 services from the network. Indoor, outdoor, and rack-mount configurations are deployable. E7 GPON-4 Card: The Calix E7 GPON-4 card provides multi-service capability over eight GE ports for high-bandwidth, point-to-point Ethernet services to individual subscribers, as well as four GPON ports that can subtend up to 64 ONTs each for a card capacity of 256 GPON ONTs (512 per E7 1 RU chassis). The card can also be used to aggregate other Ethernet devices including the Calix E5 platform. Four 10GE ports per card provide integrated transport and uplink capability. The GPON-4 card is used when supporting AE applications that require projecting synchronized timing to ONTs in support of T1 or E1 circuits. E7 10GE-4 Card: The 10GE-4 card includes twelve GE ports and four 10GE ports for use as uplinks and transport for the local E7 system, or the card can subtend additional E7 chassis's from the primary E7 system. Multiple E7's can be linked together using 10GE SFP+ copper cables creating a high-speed 10Gbps ring with aggregated, highdensity point-to-point Ethernet services. E7 GE-12 Card: Provides twelve GE interfaces, as well as two integrated 10GE ports for supporting up to 24 AE ONTs per chassis. The card delivers residential, point-to-point 1GE service drops in 12 port increments with integrated, standards-based, 10GE transport on the same line card. The GE-12 supports bi-directional single fiber GE optics modules designed for use with any Calix GX or GE ONT. C7 with TDM Gateway: The C7 is a Multi-Service Access Platform (MSAP) that can be used for subscriber access services as well as Ethernet aggregation. It also provides gateway functionality for both voice and T1/E1 data services. For GR303/TR-08 voice services over AE links, the subscriber calls are terminated via the C7 TDM gateway at a C7 VIPR or Ethernet Gateway (EGW) card. CMS Appliance: CMS Appliance is a Unified Access service management platform that bundles all the hardware and software necessary for turn-key deployments. Features include dual power and four Ethernet connections with redundant hard drives. CMS Appliance is pre-configured with software templates that enable AE activation using Calix Remote ONT Activation (RONTA) simplifying residential and commercial fiber deployments.
16
AE Features
With AE Release 2.0, Calix ONTs provide T1 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 services delivery over a packet switched network (PSN). A pseudowire connects two TDM circuits over a packet switched Ethernet network. In the most basic example, two T1 endpoints are connected together, converting a T1 signal into Ethernet frames and transported over an asynchronous Ethernet network. On the receiving end, the Ethernet frames are converted back to TDM T1 signaling. This technology is often referred to as pseudowire End-to-End Emulation, or PWE3. The 766GX and 767GX-R ONTs support unstructured, asynchronous T1s 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 line timing on the WAN interface (optical link) and loopback timing on the T1 interface. The ONTs have an internal Stratum 3 clock reference and reverts to the internal clock during a holdover condition. The solution meets the T1 timing requirements of G.824. Please refer to the Calix Application Note T1 Pseudowire Applications for MDU ONTs for complete information on PWE3 support.
17
Voice Services
AE Release 2.0 packet-voice services are supported by SIP and GR303/TR-08/GR-57 voice using the Calix C7 TDM voice gateway. POTS ports look like GR-909 compliant ports and support all CLASS services. Calix AE voice services use the GPON SIP service and provisioning model which requires generating a SIP configuration file for each SIP Interface Group (IG) and loading these files on a TFTP server. 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.
18
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. 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 Note: For complete instructions on provisioning SIP or TDM Gateway services on an AE ONT, refer to the Calix VoIP Services Guide.
19
Ground Start POTS Service In AE 2.0, 700GX 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 310) ctg add (on page 312) voip setup (on page 308) ctg setup (on page 312)
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 continue to default to loopstart. An example voip add script is included elsewhere in this document for reference.
20
Ethernet Data Services

AE 2.0's Ethernet Data Service model is based on either VLAN per service or VLAN per port. 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 a 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 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) Add or remove S-Tag VLAN-ID on any Ethernet port Layer 2 marking based on MAC SA or MAC DA Layer 3 priority marking based on Access Control Lists Data throughput in AE Mode of 1 Gbps on 700GE and 760GX ONTs
New features in AE Release 2.0 include (described in detail below):
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.
21
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: 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. Filter on upstream treatment VID, Remove 1 Tag (For downstream inverse of operation 1 above) (result = no tag)
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. 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 760GX and 700GE ONTs support sustained 1 Gbps full duplex throughput simultaneously on a single or multiple Ethernet ports. 760GX 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 and statistics
22
700GE 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 and statistics 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 700GE - 16 700GX - 32 760GX - 64
700GE and 760GX UNI Rate Limiting Granularity Range Granularity
0-2 MB 2-100 MB 100 MB - 1 GB
64 Kb 1 MB 8 MB
700GE and 760GX per VID Rate Limiting Granularity Range Granularity
0-8 MB 8-255 MB 256-511 MB 512 MB - 1 GB
64 Kb 1 MB 2 MB 4 MB
The 700GX ONTs use shaping to rate-limit up to 200 Mb/sec. The 700GE and 760GX ONTs use policing and both can rate limit from 0-1Gb/sec. Shaping is actually a storing and forwarding technique which smoothes 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. Note: Calix internal studies of LAN TCP traffic show only a 5% increase per TCP flow due to re-transmission loss when policing. However, Calix has not extensively studied WAN TCP behavior and has not seen such numbers published. If a 5% increase holds across the WAN, this does not seem like a significant network overhead to use policing rather than shaping. Shaping is a much less scalable technique.
23
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 700GE ONTs)
With the support of MAC SA, Calix ONTs can support mapping untagged traffic on the subscriber side. An example of this filter/mapping operation is to identify by OUI the set-top 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 Replication (MVR) 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 Per port multicast-to-unicast Isolation of broadcast/multicast traffic distribution of unicast IPTV traffic.
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 the Command Line Reference section of this guide.
24
Multicast VLAN Registration (MVR) 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 STB 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 support the ability 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 has 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 syntax.
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.
25
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.
26
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. 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 295) for additional information on MVR.
T1 Services via PWE3

With AE Release 2.0, Calix ONTs provide T1 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 services delivery over a packet switched network (PSN). A pseudowire connects two TDM circuits over a packet switched Ethernet network. In the most basic example, two T1 endpoints are connected together, converting a T1 signal into Ethernet frames and transported over an asynchronous Ethernet network. On the receiving end, the Ethernet frames are converted back to TDM T1 signaling. This technology is often referred to as pseudowire End-to-End Emulation, or PWE3.
27
The 766GX and 767GX-R ONTs support unstructured, asynchronous T1s 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 line timing on the WAN interface (optical link) and loopback timing on the T1 interface. The ONTs have an internal Stratum 3 clock reference and reverts to the internal clock during a holdover condition. The solution meets the T1 timing requirements of G.824. Note: T1 PWE3 services are implicitly associated to an ONT IP-Host object. The IP-Host object specifies a svc-tag-action, which provides the VLAN association. Please refer to the Calix Application Note T1 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. 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.
28
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.
T1 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 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 T1 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.
29
Transport of T1 services over a packet network requires a CoS priority and sufficient bandwidth allocation within the packet network to reduce latency and packet loss. T1 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 T1 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 circuit on the ONT. T1 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 discover each other using Address Resolution Protocol (ARP). The T1 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.
ONT Inventory
DHCP Option-43 Calix ONTs currently populate DHCP Option-60 and 61. Option-60 identifies the ONT as a Calix ONT with the model number included in brackets. Option-61 includes the FSAN serial number and if available, the RONTA ID. When registering with the CMS, AE ONTs include additional information such as model number and firmware revision. 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 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 Rev 2.0 Release Notes for specific upgrade instructions using either CLI or Option-43.
30
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 requests 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 244) section in Command Reference section of this guide.
31
Calix ONTs
ONT Models
The AE Release 2.0 is a platform independent software release that supports Calix 760GX and 700GE ONTs. In release 2.0, new ONT types are supported as well as adding voice ground start, enhanced Ethernet services, and T1 support using PWE3 technology. 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 ONT (2 POTS, 4 GE) 726GE ONT (2 POTS, 4 GE, 1 RF*) 717GE ONT (4 POTS, 4 GE) 727GE ONT (4 POTS, 4 GE, 1 RF*) Adaptive AE Optics All AE features supported by 700GX ONTs (except m2u) 1 Gbps symmetrical throughput Upstream and Downstream policing up to 1 Mbps per ONT 64 Kbps bi-directional traffic shapers up to 2,048 Mbps
The listed SFU ONTs offer the following AE features:
32
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
ONT Optics Characteristics

The 700GX or 700GE 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, and 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.
33
AE Optical Links
Calix GX ONTs communicate in the network via a single fiber that attaches to a Small FormFactor Pluggable (SFP) optics module installed in the upstream device, such as the Calix E5400 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 248) located in the Appendix of this guide. Information on SFP installation and best practices is available in the Calix E5-400 Installation Guide.
34
Chapter 2 AE Configuration
ONT Operational Overview
The AE ONT obtains an IP address through a DHCP server and is 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.
36
AE Configuration Overview
All 700GX provisioning is accomplished via preset configuration files. Note: This method of provisioning is hereafter referred to as Remote Management Interface (RMI) configuration. Prior to coming on-line, each ONT must download a configuration file from a remote TFTP server. Note: An ONT may also be configured via the buttset interface. For additional information, refer to the chapter entitled Remote ONT Activation. (on page 151) In addition to the ONT configuration files, there are several services that must be provided by the Service Providers network to fully support an AE ONT deployment. These services must be directly accessible on the management Virtual Local Area Network (VLAN). These services include the following: DHCP Server(s) Required for ONT initialization (provides IP address and the like) Required for VoIP port initialization 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)
TFTP Server(s)
NTP Server: Required for ONT's accurate time of day clock Syslog Server: Optional for logging alarms, events, and system errors SNMP Trap Receiver: Optional for monitoring alarms and events generated by the ONT SIP Server: Required for VoIP support
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).
37
AE Architecture Overview
The following diagram provides a high-level view of a basis AE network:
38
Configuration Example
All AE deployments tend to be unique as there are sure to be differing platforms for multicast video, VoIP services, DHCP server functions, and the like (not to mention redundant configurations). It would be prohibitive to document every possible configuration option so this document focuses on a few specific examples that cover the breadth of options that are most likely to be encountered. The illustration below depicts a complete AE deployment using a single platform:
The management VLAN ID is re-configurable using a buttset. For additional information, refer to the chapter entitled, Remote ONT Activation (on page 151).
39
Network Component Overview

Several components are required, regardless of deployment topology, to effectively manage an AE network. Note: 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 a message to the Syslog server and CMS describing the error and then reboots. 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.
40
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). For additional information, refer to Remote Management Interface Script (on page 130) 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 configuration file name and TFTP address in the /etc/dhcp.conf file as shown below.
filename "CXNK00012345.cfg"; next-server 192.168.7.100;
For additional information on DHCP, refer to About DHCP (on page 51). 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). Note: Prior to configuring FTP server information into CMS, you must first set up appropriate file transfer permissions. For additional information, see Notes on Configuring FTP (on page 63).
41
NTP Server The 700GX 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. SYSLOG Server The 700GX 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. SIP Server A network based SIP server is required to complete the VoIP subsystem and provide voice services.
42
AE Services Overview
Voice Capability Two types of voice ports are supported on AE ONTs. Session Initiation Protocol (SIP) voice port By selecting the appropriate profile, CMS automatically displays the appropriate fields required to provision the service. AE deployments support VoIP (SIP) to provide voice service off the ONT. Provisioning of the voice service is done by defining the basic voice service parameters in the ONT configuration file. Detailed VoIP provisioning is done in a separate VoIP configuration file. Basic VoIP provisioning contained in the ONT configuration file 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 either GPON or AE mode, the same VoIP configuration file can be used to provision SIP services on either GPON or AE ONTs simultaneously. Calix TDM Gateway (CTG) voice port The Calix C7 TDM gateway solution provides a gateway to the circuit-switched PSTN for VoIP lines on subtended Calix platforms. Calix service platforms that support a TDM gateway client for VoIP include the E5-111, E5-121, and 700-series ONTs operating in AE mode. These units interface to the C7 via an Ethernet link, and the C7 in turn provides a GR303 or GR-8 switch interface to the PSTN for the subtended VoIP lines. To support TDM gateway applications, the C7 must be equipped with at least one Voice over IP Resource (VIPR) 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 AAL5encapsulated VoIP packets from the E5 or ONT (via a C7 Ethernet downlink interface) and converts the voice content to TDM format for delivery to a C7 GR-303 or GR-8 switch interface. The C7 passes ABCD signaling events (including ringing and loop-current events) between the VIPR and E5 or ONT via RFC 2833 packets. Note: For complete instructions on provisioning SIP or TDM Gateway services on an AE ONT, refer to the Calix VoIP Services Guide.
43
Data Capability A wide variety of data service capability is provided in the AE ONT. The AE ONT has been designed to be deployed in subscriber networks that may or may not have residential gateways, tagged or untagged traffic, stringent QoS, VLAN per service or port, TLS hair pinning, DoS protection, and full triple play service out of a single Ethernet port. IPTV Capability Multicast support for IPTV is supported with IGMP snooping. In addition, Calix's multicast to unicast IPTV flow conversion is provided as well.
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: Unmanaged Pass-through ONT Unmanaged Single VLAN Mapping Managed ONT Basic Service - VLAN per Port Managed ONT Basic Multi-service - VLAN per Service
Unmanaged Pass-through ONT

In an unmanaged pass-through deployment, the design is simplistic in nature in that it does not require a management station or configuration files to provide data services. Deployment Characteristics The characteristics of an unmanaged pass-through configuration include: Management VLAN to monitor the ONT is optional ONT has no configuration file Simple turn-up for quick demonstration or for a simple deployment model Requires buttset device only for ONT activation No filtering, classification, mapping or metering (QoS)
44
In this scenario, the ONT passes all data traffic (tagged and untagged) between the fiber WAN interface and the base Ethernet port. Note that only one ONT Ethernet port is supported in this configuration. For additional information, refer to Remote ONT Activation. (on page 151)
To configure the ONT to pass all traffic between the WAN and LAN interfaces, follow the procedure in the Remote ONT Activation (on page 151) section. Once the VLANs have been defined using the buttset device and the ONT is attached to the headend switch, the ONT passes data through the ONT and out the single GE port. If the VLAN IDs for all subscriber Ethernet ports are configured to be zero, then the ONT automatically reverts back to operating in default boot-up mode (using a Management VLAN and configuration files).
45
Configuration Rules Follow the rules listed below when configuring Ethernet ports in pass-through mode: The 1st Ethernet port on any ONT can be disabled, assigned to a single VLAN, or configured for pass-through mode. If the 1st Ethernet port is set to pass-through, the 2nd Ethernet port is disabled (in other words, the RONTA prompting stops after the 1st Ethernet port is set to pass-through) If the 1st Ethernet port is not set to pass-through, the 2nd Ethernet port can be set to disabled, or assigned to a single VLAN, provided the VLAN IDs are not identical at each ONT).
Unmanaged Single VLAN Mapping

In an unmanaged single VLAN mapping deployment, a single VLAN may be assigned to each ONT Ethernet port (the base GE and the expansion Ethernet port). VLAN traffic is then mapped between the fiber WAN interface and one or both ONT Ethernet ports. Only one VLAN may be assigned per ONT Ethernet port.
46
If the ONT has two subscriber Ethernet ports, each port must be configured for a different VLAN; however no two Ethernet ports can be configured for the same VLAN. To assign a VLAN to a specific ONT port, follow the procedure in the Remote ONT Activation (on page 151) section. Once the VLANs have been defined using the buttset device and the ONT is attached to the headend switch, the ONT passes data through the ONT and out one or both Ethernet ports. If the VLAN IDs for all subscriber Ethernet ports are configured to be zero, then the ONT automatically reverts back to operating in default boot-up mode (using a Management VLAN and configuration files).
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 57) for additional information.
47
Supported Features The features available over the managed ONT include: Quality-of-Service (Traffic Shaping) Rate limiting upstream and downstream bandwidth 802.1p QoS support Security Multicast filtering Multicast/Broadcast upstream shaping Station filtering DHCP L2 relay using Option-82
An example of this model is illustrated below.
48
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. Deployment Characteristics The characteristics of this model include: HSI and IPTV are provided on separate VLANs 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) 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 3 Configuring an AE System

AE System Requirements
The foundation for the Calix AE solution incorporates a simple operational model: Obtain an IP address from a DHCP server Obtain a configuration file from a TFTP server Provide subscriber service
In addition, when an AE ONT comes on line, the ONT looks for two other services specified in its configuration file: The NTP server in order to obtain its time-of-day The SYSLOG server in order to send any generated alarms, operational messages, or alarms to SNMP Trap Receivers (optional)
All services used by the AE ONT can be provided on a single management station (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. The ONT configuration file defines the location and address of each service.
50
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. As an alternative, the CMS server can be configured for DHCP services to support AE ONTs. Refer to Configuring the CMS Server for DHCP Service (Red Hat Linux) (on page 52) for additional information. 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 AE [model]" to the DHCP Option-60 string in the DHCP Discovery message and the DHCP Request message. For example, "CALIX AE 710GX". 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, an 8 bit value is appended to the Registration ID indicating length followed by the Registration ID value (numeric up to 10 characters).
51
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.
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 1 2 3 01234567890123456789012345678901 op (1) htype (1) xid (4) secs (2) ciaddr (4) yiaddr (4) siaddr (4) giaddr(4) chaddr (16) sname (64) file (128) options (variable) flags (2) hlen (1) hops (1)
52
DHCP Message Field Definitions Field

op htype hlen hops xid secs flags ciaddr yiaddr siaddr giaddr chaddr sname file options
Octets
1 1 1 1 4 2 2 4 4 4 4 16 64 128 var Message op code/message type.
Description
Example: 1=BOOTREQUEST, 2=BOOTREPLY Hardware address type. Example: 1 = 10 mb Ethernet Hardware address length. Example: 6 = 10 mb Ethernet Client sets to zero, optionally used by relay agents when booting via a relay agent. 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. Populated by client, seconds elapsed since client began address acquisition or renewal process. Used to enable acceptance of IP unicast stream. Client IP address; only populated if client is in BOUND, RENEW, or REBINDING state and can respond to ARP requests. Client IP address IP address of next server to use in bootstrap; returned in DHCPOFFER, DHCPACK by server. Relay agent IP address, used in booting via a relay agent. Client hardware address. Optional server host name, null terminated string. Boot file name, null terminated string; "generic" name or null in DHCPDISCOVER, fully qualified directory-path name in DHCPOFFER. Optional parameters field.
With the latest release of software, AE ONTs support DHCP Option 66 and 67. These two options are defined below: TFTP Server Name (Option 66) This option is used to identify a 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. 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.
53
Configuring the CMS Server for DHCP Service (Red Hat Linux)
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 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 The procedures in this section assume that you have the Red Hat DHCP package installed on the CMS server. By default the DHCP package is installed on CMS2GODell servers running Red Hat ES 5. Installing the DHCP package (Red Hat Enterprise System 5) Tip: If your host server is running Red Hat 4, search on the Internet for instructions on how to install the Yum installation utility. 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
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 manages 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.
54
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 4) On the menu bar, click Applications > System Tools > Network Device Controls. (Red Hat 5) On the menu bar, click System > Administration > Network. In the Network Setup screen, click Change Network Configuration. 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.
3. In the Devices tab, Create a new Ethernet device:
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. Example
[root@cmshost1 ~]# cd /etc [root@cmshost1 etc]# vi sysconfig/dhcpd
# Command line options here DHCPDARGS=eth1
:wq [root@cmshost1 etc]#
55
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 [root@cmshost1 etc]#
56
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. 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 [root@cmshost1 etc]#

57
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
Example
[root@cmshost1 etc]# service dhcpd restart [root@cmshost1 etc]# chkconfig dhcpd on Starting dhcpd: [root@cmshost1 etc]#
6. Verify that DHCP service is running: a. Navigate to the /etc/init.d directory. b. Run the command: ./dhcpd Example
[root@cmshost1 ~]# cd /etc/init.d [root@cmshost1 init.d]# ./dhcpd status dhcpd (pid 2210) is running...
status
58
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. As an alternative, the CMS server can be configured for DHCP services to support AE ONTs. Refer to Configuring the CMS Server as the NTP Source (Red Hat Linux) (on page 58) for additional information.
Configuring the CMS Server as the NTP Source (Red Hat Linux)
The CMS server can be configured as the NTP source for Calix E5-100 and Calix E5-400 nodes and Calix Active Ethernet (AE) ONTs, enabling these elements to function as SNTP clients. The procedure in this section assumes that you have the Red Hat NTP package installed on the CMS server. By default the NTP package is installed on CMS2GODell servers running Red Hat ES5. Installing the NTP package Tip: If your host server is running Red Hat 4, search on the Internet for instructions on how to install the Yum installation utility. To verify NTP is installed, log in to the host server as the root user and run the command:
yum info ntp
If NTP is not yet installed, you can install the latest version by running the command:
yum install ntp
If NTP is already installed, you can update to the latest version by running the command:
yum update ntp
59
Enabling Calix devices to receive NTP service from the CMS server Enabling Calix devices to receive time updates via the CMS server requires editing the ntp.conf file to add the IP subnets for the managed devices, configuring the ntp daemon to run on startup, and starting the NTP service. You can then verify that NTP service is running. For instructions on how to configure the NTP server options at the network element level, refer to the Calix user guide for the device. The following procedure assumes that you are running Red Hat ES5. To configure the CMS server as the NTP source 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 [root@cmshost1 etc]#
3. Edit the ntp.conf script, if required: Tip: For a list of basic vi commands, see vi Editor Commands. a. At the command prompt, type: vi
ntp.conf
to open the file.
b. Verify that the file contents are similar to the contents in the example below. If you are running a version of Red Hat other than ES5, consult with your IT system administrator or resource for the required file settings. To restrict access to specific SNTP clients, insert one or more lines below the line beginning with # restrict 191.162.0.0 mask 255.255.255.0. For example, to enable hosts on the subnet 10.2.11.x to use CMS as an NTP source, insert the following line:
restrict 10.2.11.0 mask 255.255.255.0 nomodify notrap
c. Press <Esc> to finish editing. d. Type :wq and press <enter> to save the changes and close the script file.
60
Example [root@cmshost1 etc]# vi net.conf

# Permit time synchronization with our time source, but do not # permit the source to query or modify the service on this system. restrict default kod nomodify notrap nopeer noquery
# Permit all access over the loopback interface.
This could
# be tightened as well, but to do so would affect some of # the administrative functions. restrict 127.0.0.1
# Hosts on local network are less restricted. # restrict 191.162.0.0 mask 255.255.255.0 nomodify notrap notrust
# Use public servers from the pool.ntp.org project. # Please consider joining the pool (http://www.pool.ntp.org/join.html). server 0.rhel.pool.ntp.org server 1.rhel.pool.ntp.org server 2.rhel.pool.ntp.org
# Undisciplined Local Clock. This driver is intended for backup # and when no outside source of synchronized time is available. server 127.127.1.0 fudge 127.127.1.0 stratum 10
"ntp.conf" 34L, 1259C
:wq [root@cmshost1 etc]# 1. Configure the daemon to run on startup. At the command prompt, type:
chkconfig ntpd on
2. Start up the NTP service. At the command prompt, type:

service ntpd start Proprietary Information: Not for use or disclosure except by written agreement with Calix. Calix. All Rights Reserved.
61
Example
[root@cmshost1 etc]# chkconfig ntpd on [root@cmshost1 etc]# service ntpd start Starting ntpd: [root@cmshost1 etc]#
3. Verify that NTPD service is running: a. Log in to the SNTP client as the root user. b. From a command line, run the command: ntpdate where cmsserver is the CMS server name. A date time stamp is returned, indicating NTP service is successfully running. Example
cmsserver
# ntpdate cmsserver 27 Jan 20:21:13 ntpdate[7056]: adjust time server 172.23.43.16 offset 0.000254 sec
62
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 warnings 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).
63
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.
64
Notes on Configuring FTP

Prior to setting up the CMS to TFTP connection, ensure that files transferred across the network via FTP have the appropriate permissions.
File Permission Basics

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:
ls -l Command Output
Permissions
Links Owner Account Name Group Account Name Size of File Date/Time of File File Name
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. Displays the number of links to this file. Displays the Owner Account Name for the file. Displays the Group Account Name for the file. Displays the size of the file in bytes. Displays the date and time of last update to the file. 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.
65
Unless setup by yourself or the system administrator, your default umask setting is 000 which means that new files that are created have read and write permissions for everyone (666 or rw-rw-rw). New directories have read, write and execute permissions for everyone (777 or drwxrsxrwx).
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
66
Files created using this umask have default permissions of 644 (666 - 022, or -rw-r--r--). New directories 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.
67
About the 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 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.
68
Chapter 4 Understanding AE ONT Configuration Files

Active Ethernet Provisioning
The Calix AE ONT supports subscriber configuration and management via a Command Line Interface (CLI) or CMS. You access the ONT CLI 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), it is highly recommended 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. Information on building configuration files is discussed in a following chapter.
70
CMS Interface In this release, the following CMS features are included in support of AE provisioning: Inventory (ONT) Tracking Creation, Movement, Deletion, and Resetting of an ONT Video, Data, and Voice Provisioning to an individual ONT Primary and Secondary TFTP Server Configuration ONT Search Capability Alarm and Event Logging CLI cut-through to CMS Google Maps
Note: CMS Alarms are currently integrated provided the CMS is configured as a trap receiver.
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. There are two primary methods for obtaining Configuration files: Configuration file templates 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 Configuration files through the CLI, refer to Calix 700GX AE ONT Configuration Guide. Configuration files are set up by your system administrator on the CMS server. In this case, pre-provisioning, discovery, and service provisioning are accomplished through CMS desktop.
Note: Calix highly recommends user the configuration file approach for any provisioning. 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 these scenarios, a top-level file calls out sub-tending configuration files and executes each file in sequence. As an alternative, a single configuration file can be created containing all required commands in a "monolithic" approach. In this case, the configuration file executes each command in sequence.
71
All configuration files are flexible and scalable for any deployment size and offer 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 describing the error and then reboots. 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.
AE ONT Turn-up Pre-Requisites

In order for an AE ONT to be successfully brought on-line, the following "pre-provisioning" steps must have already been completed: 1. The CMS server must be on-line with all configuration files in their proper locations (on page 72). 2. The provided voice, video, and data configuration file templates have been edited to meet the needs of your particular deployment. Note: Calix recommends creating a new file in notepad and copy/paste the template information into this new file. This minimizes the risk of introducing errors into your "live" configuration files. Once changes are complete, upload the file to the "live" location. 3. The FTP server has been provisioned and manually "synced" with the CMS server. This insures the required drop down boxes within CMS are populated with the edited configuration file template information. This also FTP's the edited files to the TFTP server location. Once the above steps have been completed, the CMS generates a master configuration file for each ONT (for example, "CXNKxxxxxxxx.cfg) and be synchronized automatically.
72
Note: An ONT master configuration file is not generated until at least one piece of provisioning has been applied.
Configuration File Structure

With each distribution of software, a full complement of configuration file templates are provided. These templates can be modified as required based on the service offerings being deployed. Note: CMS expects that certain configuration files follow a specific naming convention (as highlighted in bold below). The remaining configuration files can have any file name you chose, provided they reside in the directories as shown below. The following configuration files are provided:
File Location/Name Description
inc\common.cfg
Specifies Syslog, TFTP, SNMP trap, NTP server, ONT firmware image locations (IP address) Adds an entry for video set top box Organizationally Unique Identifier (OUI). Creates a data profile with varying bandwidth parameters. Specifies VoIP service location and appropriate service options. Creates a video profile with varying VLAN IDs. Creates a SIP or TDM Gateway profile with varying VLAN IDs. Also specifies C7 TDM gateway IP address, TFTP server address (for SIP), and SIP configuration filename (SIP only).
inc\video_oui.cfg inc\data_setup.cfg inc\VoipConfig.txt inc\video\*.cfg inc\voice\*.cfg
73
Configuration File Locations

AE ONTs rely on a series of configuration files (config files) located on a TFTP server. These configuration files provide necessary instructions to the ONT for all service functions and provisioning. AE config files are stored on the CMS at: <cms install directory> \ ae \ inc When installed, the config files folder structure is as follows: Note: Executing the Sync All command within CMS synchronizes the files located in the CMS install directory with the TFTP server's "\" folder. An example configuration file is installed at the root directory: <cms install directory> \ae\CXNK0EXAMPLE.cfg) Note: This configuration file is for your use as a template. Changes to this file are not captured during a Sync All command. The top level AE ONT configuration file is installed at the root directory (for example, <cms install directory> \ae\CXNK0002B633.cfg) Common set-up config files are installed at: <cms install directory> \ae\inc Data service profile config files are installed at: <cms install directory> \ae\inc\data Video service profile config files are installed at: <cms install directory> \ae\inc\video Voice service profile config files are installed at: <cms install directory> \ae\inc\voice Important: When the contents of the "inc" folder on the CMS server are changed/updated, you must re-synchronize the connection between the CMS server and the TFTP server.
74
Synchronizing AE ONT Configuration Files

Synchronizing AE ONT configuration files is required in either of the following circumstances: The common configuration files or service configuration files on the CMS server are modified or added (typically performed by the CMS system administrator). A new TFTP primary or secondary server is configured. See Configuring Primary and Secondary TFTP Servers.
The synchronization process ensures configuration files located on the CMS are identical to configuration files on the TFTP server. When you perform the synchronization, the system does the following: Regenerates the AE ONT configuration files and updates the TFTP servers. Makes new service configuration files available to use in CMS Desktop (using the Services subscriber activation screen). Populates the profile/IG drop down boxes on the AE ONT provisioning page with the appropriate configuration file name.
Important: If you make a provisioning change to a single ONT that is active within CMS, the file for that ONT is immediately changed on the CMS server. This same configuration file is FTP'd to the TFTP server where a reset command is immediately sent to the ONT. To synchronize AE ONT configuration files 1. On the Navigation Tree, click CMS. 2. In the Work Area, click System > AE ONT. 3. At the top of the work area, click Sync All. A prompt displays indicating the status of the synchronization process.
75
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. 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.
76
Configuration File Hierarchy

Each 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 as shown (see below). For example, a 714GX ONT that has the serial number CXNK0002B70E expects (requires) a config file by the name CXNK0002B70E.cfg on the TFTP file server.
In order to simplify the management of a large number of ONTs, a config file may reference another config file (nesting) which instructs the ONT to apply the provisioning that is contained in another config file. This allows the service provider to define a global configuration file that may have a common set of provisioning that applies to a number of ONTs of a specific type or service class.
77
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.
78
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.
79
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.
80
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 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.
81
Creating a Configuration File

Building Cascading Configuration Files
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. An example Cascading Configuration File (on page 179) templates is included in the Appendix section of this guide. 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.
Building Monolithic Configuration Files

In contrast to a cascading configuration file approach, the monolithic method employs a single configuration file for defining all parameters within an ONT. In this case, all management and ONT service parameters are defined in a single file. For an example of this type of file, refer to Monolithic Configuration File (on page 188) in the Appendix of this guide.
82
About VoIP and the VoIP Configuration File

Calix VoIP service is an integrated, multi-service IP network based telephony system designed for use with the AE or GPON system. Calix VoIP supports a full range of advanced voice features and simplifies management of the system. VoIP, 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 complaint 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 VoIP 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 VoIP (Session Initiation Protocol) 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. As is the case with GPON deployments, the detailed VoIP provisioning is done in a separate VoIP configuration file. Required VoIP provisioning parameters includes the name of the VoIP configuration file, the VoIP file server, and a redundant VoIP configuration server if desired. Important: Note that the same VoIP configuration file can be used to provision SIP services on either GPON or AE ONTs simultaneously. Calix GX and GE ONTs come equipped to deliver VoIP services. All ONTs provide built-in Integrated Access Device (IAD) functionality to perform call handling and IP packetization for VoIP functions. At the ONT, VoIP 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 of VoIP service 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)
83
Unsupported Switches Calix provides a standard VoIP 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.
Creating the VoIP Configuration File

VoIP Configuration Files share the following basic attributes: A single Configuration File can be used for multiple ONT ports provided all ports deliver identical service options. For customers that have unique service offerings, a separate Configuration File is required. The Configuration File can be created using a supplied template 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. 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 VoIP port TFTP downloads a Configuration File upon creation, after reset, and when requested by the system.
84
ONT SIP Configuration File Parameters

The table below shows the required configuration file variables and respective descriptions. For a sample of a completed VoIP Configuration file, see The VoIP CF in the back of this guide.
ONT SIP (VoIP) Configuration Parameters
Version of VoIP config file ONT SIP Port Outbound Proxy Option Sip Proxy Server IP Address SipPort Sip Proxy Domain Version of the VoIP config file. Displays the config file version number. Example: Version 1.14 Enter the UDP Port address of the ONT. Example: OntPort: 5060 Sets a flag to capture all SIP messages to the SIP Proxy IP Address server. Example: OutboundProxy: 1 Enter the UDP or IP address for the Border Controller or the SIP Proxy server. Example: SipProxyIP: 172.26.31.16 Enter the UDP/IP Port # of the ONT SIP Port. Example: SipPort: 5060 The SipProxyDomain can be an IP address or a Fully Qualified Domain Name (FQDN). Example: SipProxyDomain: 172.26.31.16 Example: davinci.datcon.co.uk (Metaswitch interop server) DNS IP Address Enter the primary (required) and secondary (optional) DNS IP Address for the ONT Port being provisioned: Example: DNSPrimaryIP: x.x.x.x DNSAlternateIP: x.x.x.x IMPORTANT: These values must be changed to the appropriate network IP address prior to implementing SIP Service. SIP Timers (msecs) Enter SIP Timer time-out values in milliseconds (required parameter per RFC 3261). Example: SipT1Timer: 500 SipT2Timer: 4000 SIP Registration Enter 0 if you want to disable Sip Registration, enter 1 to enable. Calix recommends keeping this enabled unless you have a totally secure network. Example: SipRegistration: 1 SIP Registration Period Enter the maximum registration period for the SIP connection. Example: SipRegPeriod: 3600 Note: Calix recommends you accept the above default values as the SIP Server over-ride (the above value if pre-provisioned on the SIP Server). SIP Registration User Required parameter for several SIP switch vendors including Nortel, Broadsoft, and Metaswitch. Enter 0 if Registration ID comes from the URI field, enter 1 if from the UserID field. (Default = 0) Example: SipRegisterUser: 0 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 (All of North America except Mexico [52]). This setting is rarely used or required. Example: SipE164: 1 QoS Type of Service (RtpTOS) Enter the TOS bits for RTP packet stamping (0-255 bits) Example: RtpTOS: 160 Important: It is recommended that you set your QoS to a relatively high priority in order to avoid potential voice service degradation.
85
RTP Voice base port number (RtpBasePort) Input the starting port number of a specified range of ports that are allowed access to the RTP service. Each ONT VoIP port requires two RTP port numbers. Example: RtpBasePort: 16384 Important: Failure to properly identify this range of ports causes the firewall to reject transmissions. RTPCodec (voice encoding) RTP Packet Rate Enter the voice encoding option. This should always be set to zero (law). (Default = 0) Example: RtpCodec: 0 Input the expected RTP packetization rate sent by the ONT. Choose between 10, 20, or 30 msecs. Example: RtpPacketRate: 10 The configuration file contains options for setting the following ring tone characteristics: Ring Tone Definitions Dial Tone, Busy Tone, Reorder Tone (fast busy), Ringback Tone, Call Waiting Tone, Warning Tone, Alert Tone, CAS Tone, and Stutter Dial Tone. Options are entered in the following order: 1st Frequency(in hertz), 2nd Frequency, Volume Level of 1st Frequency (in dbm), Volume Level of 2nd Frequency, Time tone is on (in milliseconds), time tone is off and continuous tone on (1) or off (0) Examples: VoipDialTone VoipBusyTone VoipReorder Tone VoipRingback Tone VoipCallWait1 Tone VoipWarning Tone VoiPAlertTone VoipCASTTon e VoipStutter Dialtone 2 2 1 2 1 2 2 480 440 440 1400 440 2130 350 620 480 0 2600 0 2750 440 -24 -19 -13 0 -13 -18 -13 -24 -19 0 0 0 -18 -13 250 2000 330 100 2000 80 100 250 4000 0 100 10000 0 100 1 1 0 1 1 1 1 2 2 350 480 440 620 -13 -24 -13 -24 1 500 0 500 1 1
Important: Unless you are thoroughly trained on Tone provisioning, it is recommended you accept the default values. Note: Ring Tone Definition names do not include any spaces. Spaces may appear here for document formatting purposes only.
86
Ring Cadence Definitions Enter Ringtone Cadences as required. Up to 8 discrete ring tones can be provisioned per configuration file. Options are entered in the following order: Ring frequency (0 = 20 hertz), Shape (0-trapazoidal, 1=sinusoidal), ring period 1 on time, ring period 1 off time, ring period 2 on time, ring period 2 off time, ring period 3 on time, ring period 3 off time (all values in milliseconds) VoipRing CycleR1 VoipRing Cycle2 VoipRing Cycle3 VoipRing Cycle4 VoipRing Cycle5 VoipRing Cycle6 VoipRing Cycle7 VoipRing Cycle8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2000 800 400 300 500 2000 2000 2000 4000 400 200 200 0 4000 4000 4000 2000 800 400 1000 0 2000 2000 2000 4000 4000 200 200 0 4000 4000 4000 2000 0 800 300 0 2000 2000 2000 4000 0 4000 4000 0 4000 4000 4000
Important: Unless you are thoroughly familiar with ring cadence provisioning, it is recommended you accept the default values. Ring Cadence Definitions 1 through 5 are Telcordia defined and should not be changed. Cadences 6 through 8 are user definable. Note: Ring Cadence Definition names do not include any spaces. Spaces may appear here for document formatting purposes only. Distinctive Ringing Alert Enter a value for distinctive ring alerting if required by the switch or application server. This field is used for creating a pattern match between the Alert Header for distinctive ring. The Bellcore standard syntax used by many switches is "Bellcore-dr1" through "Bellcore-dr5". Please note that the Bellcore syntax is case and blank-space sensitive and must match the string format coming from the switch. Example: VoipDRmessage: Bellcore-drX where X is any value between 1 and 5. Note: The Nortel CS2000, CS1500 and DMS-10/PGI allow the use of non-Bellcore syntax in the Alert Header for distinctive ring. The CS2000 sends the pattern match as "dst_ring_x" or may be set to a site specific syntax. The CS1500 can be configured with different brand types that define the Alert Header syntax, including "bellcore-drx", "Bellcorerx", and "bellcore-drx". Please verify the Distinctive Ring Alert Header syntax being used at the customer switch. If distinctive ring is not functional, please examine the "SIP Alert Info" packets coming from the switch to verify distinctive ring Alert Header format. Softswitch Distinctive Ring (Call Waiting) Enter the softswitch signaling pattern for call waiting (Broadsoft BroadWorks switch). This field is used for creating a pattern match for the Distinctive Ring Call Waiting Tone being sent down from the switch. This command is ignored on other switch types. Example: VoipCWmessage: CallWaitingTone Enter the delay in seconds before playing a fast busy tone after far end hang up or far end off hook. Example: VoipReorderDelay: 10 Warning Delay Period Enter the delay in seconds before playing a warning tone "howler" if phone is off hook Example: VoipWarningDelay: 60 Enter the amount of time (in seconds) to play the warning "howler" after the Warning Delay parameter above has elapsed. Example: VoipWarningTimeout: 600
Reorder Delay
87
Dial Plans Enter the types of dialing plans you wish to enable. Dial Plan syntax: ^ = match from start of string | = rule separator for multiple rules per plan [n-m] = match a range of digits {n} = match n digits * = wildcard match - for a variable number of digits T = timeout send of dial string S = star phone key (*) match character in dial plan c = Confirmation tone is played when dialing star code plans ^S72c[0-9][0-9]{6}| r = Recall tone is played during a call forwarding sequence ^S72r[2-9][0-9]{6}| d = Dial tone is played during a call forwarding sequence ^S72d[2-9][0-9]{6}| , (comma) = Outside dial tone is played during a preceding "9" sequence ^9,1[2-9][0-9]{9} *T = Represents the time in seconds before digits are sent. Required for slow dialers. Example: ^01[2-9][0-9]{4}*T|\ ^911 = 911 service ^411 = Directory Assistance Service ^S[0-9]{2} = Star hotkey service (i.e. *69) ^1[0-9]{10} = Traditional Long Distance Dialing ^[2-9][0-9]{9} = Traditional Local Dialing with toll free area code capability ^011[0-9]*T = Traditional Overseas Dialing Example: ^911|^411|^S[0-9]{2}|^1[0-9]{10}|^2[2-9][0-9]{9}|^011[0-9]*T Note: To dial the operator, enter 0 and wait for the Dial timeout feature to send the zero digit to the switch where the switch then forwards the call to the operator. Alternatively, avoid the delay by dialing 0#. Area Code Exceptions For multi-area code communities, enter the list of toll free area codes to provision without dialing a one first. Example: VoipIntroLATA: 952 763 651 612 507 218 Dial Plan Timeout Enter (in seconds), the input delay timeout before sending the string to the switch. Example: VoipDialTimeout: 8
Dial Plan Short Timeout
This is a delay timer (seconds) for a partial match "pause" until all digits have been collected. Slow dialers may need this feature. Example: VoipDialShortTimeout: 8
Embedded 7 Digit Dial Plan
The ONT SIP Client currently has a 7-digit dial rule. This command allows you to over-ride the rule. (Default = rule in effect [0]. Example: Embedded7DigitRule: 0
SIP INFO Message
For Flash Hook messages, you can send a SIP INFO message. Variables: 1 = send INFO, 0 = use Call Hold re-INVITE. Default = 0. Applies to Metaswitch and Broadsoft only. Example: VoipFlashINFO: 1
E911 Called Party Hold
An option exists to specify whether a caller may hang up during an E911 call. Variables: 0 = no special treatment, 1 = Hold 911 call if On Hook, don't send SIP BYE command; provide local power RING back. Example: E911CalledPartyHold: 1
88
Disable Call Waiting Need to execute hunt groups on certain softswitches. Variables: 1 = Disable Call Waiting, 0 - Call Waiting enabled (default). Example: VoipCallWaitDisabled: 0 Disable ONT Caller ID Needed to disable Caller ID display feature at the ONT. Variables: 1 = Caller ID display disabled, 0 = Caller ID enabled (default). Example: VoipCallIDDisabled:0 Three Way Calling Allows for configuring 3-way calling as an optional service. Example: ThreewayCallEnabled: 1 (Default = 0)
DTMF Key Send
Genband M6 requires OOB (SIP INFO) messaging. DTMF Key Send allows you to toggle between inband audio [0] and SIP INFO [1]. Example: VoipDTMFmode: 0
DTMF Key Receive
Can enable or disable the playing of the DTMF SIP INFO message. [0] = playout SIP INFO message. [1] = Disable playout. Genband M6 only. Example: dTMFTonefromiNFOdisabled:1
Stutter Dial Tone
Call On Hold disconnect stutter dial tone can be enabled [1] or disabled [0]. Example: StutterOnhOldDisconnect: 0
Chapter 5 Turning Up an AE ONT via CMS

The Calix CMS supports turn-up and basic management of AE ONTs. Topics Covered This chapter covers the following: CMS Appliance Creating an ONT Configuring the Management VLAN Pre-provisioning of AE ONTs prior to turn-up ONT Discovery
90
CMS Appliance
CMS Appliance is a Unified Access service management platform for fiber access service. The system ships complete with all software necessary for turn-key deployments on a single, fault tolerant, rack-mountable Dell PowerEdge R410 Server. Features include: Redundant power supplies Four Ethernet connections Redundant hard drives
CMS Appliance can be deployed in pairs, providing ultimate system redundancy. The Appliance supports all peripheral AE devices including DHCP servers, TFTP servers, Syslog servers and NTP servers.
91
Configuring Primary and Secondary TFTP Servers

Prior to coming on-line, each ONT must download its configuration file from a remote TFTP server. In an AE deployment, the TFTP server manages the following functions: Stores the appropriate ONT runtime image (downloaded at boot-up) Stores ONT specific configuration files Stores ONT service specific VoIP configuration files (softswitch dependent) Space for ONT Images: 4MB to 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
The minimum configuration specifications for a dedicated TFTP server are:
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). To configure primary and secondary TFTP servers in CMS 1. On the Navigation Tree, select the top-level CMS. 2. In the Work Area, click System > AE ONT. The TFTP Configuration screen is displayed. 3. Enter a name in the Default SNMP Community field. 4. Click the Enable check box under TFTP #1 to configure the primary TFTP server information: a. Enter the appropriate field transfer protocol: FTP, SFTP Note: FTP is not enabled by default on CMS2GO servers. b. Enter the IP address of the server location. c. Optional: Enter a Username and Password for accessing the server. d. Enter a TFTP Folder location where CMS searches for synchronized files. e. Optional: Configure a secondary TFTP server by repeating steps 4a through 4d.
92
5. Click Test. If successful, a "This server is alive" message is displayed. 6. Click Apply. CMS displays the status of each TFTP server as it is updated and provides a Pass/Fail indication as changes are applied. 7. Synchronize the ONT configuration files (using the procedure in the preceding topic). Note: If you receive an invalid directory error when specifying the primary TFTP server location, check to make sure you have the appropriate permissions set on the FTP server before troubleshooting.
Synchronizing AE ONT Configuration Files

Synchronizing AE ONT configuration files is required in either of the following circumstances: The common configuration files or service configuration files on the CMS server are modified or added (typically performed by the CMS system administrator). A new TFTP primary or secondary server is configured. See Configuring Primary and Secondary TFTP Servers (on page 90).
The synchronization process ensures configuration files located on the CMS are identical to configuration files on the TFTP server. When you perform the synchronization, the system does the following: Regenerates the AE ONT configuration files and updates the TFTP servers. Makes new service configuration files available to use in CMS Desktop (using the Services subscriber activation screen).
To synchronize AE ONT configuration files 1. On the Navigation Tree, click CMS. 2. In the Work Area, click System > AE ONT. 3. At the top of the work area, click Sync All. A prompt displays indicating the status of the synchronization process.
93
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. 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 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 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 is 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 re-initiates the process with the primary TFTP server.
94
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 last-known good configuration file (cached locally by the ONT). The ONT makes five attempts to retrieve its specific configuration file at each TFTP server. This results in a twominute 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.
95
ONT Creation
ONTs are created by completing the following tasks: A Management VLAN is configured to support the AE ONTs. The ONT is pre-provisioned by entering the ONT serial number into the New AE ONT dialogue box or via Remote ONT Activation (RONTA). Note: For information on pre-provisioning an ONT via RONTA, refer to the Calix 700GX AE ONT Configuration Guide The ONT is discovered on the AE network. Note: CMS must be accessible from the ONT management network in order to properly manage ONTs. Note: The CMS IP address must be configured as an SNMP Trap Receiver before AE ONTs become visible on the CMS.
Configuring 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: The Management VLAN ID value must be between 1 and 4094. 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. To change the management VLAN 1. Disconnect power to the ONT. 2. Verify the network fiber (pigtail) is disconnected 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). 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).
96
6. 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". 7. Skip to step 9 if MVLAN is correct. 8. 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". 9. 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. 10. Re-connect the network fiber to the ONT and wait for the ONT to come on line.
97
Pre-provisioning an AE ONT
An AE ONT can be added to a network group in CMS (pre-configured) by entering the Registration ID or FSAN Serial Number, selecting the location in the Navigation tree where you want it to appear, and selecting the specific ONT profile. To create an AE ONT The newly created ONT is displayed in the Network Details list and comes up as Disconnected:
1. On the Navigation Tree, select the AE ONT Network Group 2. In the top menu bar, click Create. The New AE ONT dialogue box opens. 3. Enter the Registration ID or the 12-digit FSAN serial number for the AE ONT. 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. 4. From the drop down list, select which Network Group you want to add the AE ONT to. 5. Assign an ONT profile by selecting from the list. 6. Click OK.
98
The AE ONT is displayed in the network structure as being disconnected. Clicking the Provisioning tab shows the newly created ONT has failed to obtain an IP Address, MAC Address, or FSAN Serial Number. This will be rectified once the ONT is physically connected.
ONT Discovery
Using the newly created ONT as an example, the ONT must now be physically attached to the AE network. ONT autodiscovery 1. Physically install the ONT at the intended location. 2. Connect the fiber pigtail (SC-APC) coming from the Ethernet switch to the bulkhead receptacle on the ONT. 3. Since the ONT is already present on the system, wait several minutes for the ONT to be discovered. 4. In the Navigation Tree, scroll down to the autodiscovered Network Group. Note: To customize the default network group used for newly discovered ONTs, at the CMS level in the Navigation Tree click System > AE ONT. In the Default Network Group drop-down list, select the location where you want newly discovered ONTs to be placed. 5. Expand the group then click on the recently installed ONT Serial number in the list. 6. The ONT now shows itself as being connected.
99
7. Move the ONT to the desired network group by using the following procedure: a. On the Navigation Tree, click the root region, the parent region, or the network group of the AE ONT. b. In the Work Area, click Network Details. c. In the AE ONT list, click the device(s) to move. For selecting multiple items, use Ctrl+Click to select one item at a time, or Shift+Click to select a range. d. In the Edit row, click Network Group and then select the new parent network group. e. Click Apply, and then click OK to save the new settings. 8. Once the ONT is located in the proper network group, view the provisioning tab. Notice the ONT has now obtained an IP and MAC address from the DHCP server.
100
CLI Cut-Through
Beginning with CMS version 10.1, multiple CLI sessions can be launched for side by side comparison of ONTs in the network.
To open multiple CLI sessions 1. Navigate to the Network Group where the ONTs reside and click the network group. 2. From the work area, select Network Details > AE ONT 3. Shift-click multiple ONTs from the list and right click this multiple line selection. 4. Hover your mouse over CUT-THROUGH TELNET and click. 5. Separate CMS Cut-Through windows open. Note: CLI cut-through windows may be hidden behind other open windows on your desktop. Check the Windows Quick Launch toolbar (normally on the bottom of your screen) for additional cut-through windows.
Chapter 6 Provisioning Services on an AE ONT via CMS

About the Provisioning Screens
Services Tab AE ONT voice, data, and video services are activated via the Services tab within CMS. The ONT is recognized within CMS via the following four generic attributes: ID - Corresponds to the ID (Registration ID or FSAN Serial Number) specified at the time the AE ONT was created. Profile - Corresponds to the ONT profile specified at the time the AE ONT was created. Subscriber ID - This optional field corresponds to a character string used to set the default subscriber ID for each ONT port. Subscriber Description - This optional field corresponds to a character string used to set the default Subscriber Description for each ONT port. This value is used to set the ONTs Label attribute.
Note: If you choose not to use the Subscriber ID and Subscriber Description functionality, these fields can be hidden by clicking the Less Settings link on the right hand side of the Services tab. All ONT services can be provisioned through CMS by selecting a check box at the port level on the services tab. Selecting any checkbox expands the selection to display fields appropriate for that specific provisioning process. Note: Many of the provisioning fields associated with ONT services require mandatory input during the provisioning process. If a checkbox is selected, and the fields associated with that checkbox are not populated as required, provisioning changes will not be completed as expected. Required fields with invalid or missing data are highlighted in red. Tip: If you are not provisioning all services at once, clear any boxes relating to other services in order to minimize errors returned due to missing data.
102
Provisioning Tab You can view the IP address, MAC address, user description, version, model, FSAN serial number, registration number, and the ONT profile of each AE ONT. Viewing AE ONT provisioning information requires Min (Minimum) CMS Configuration Management privileges. To view AE ONT provisioning information 1. On the Navigation Tree, expand the network group and click the AE ONT. 2. In the Work Area, click Provisioning to view the details. Note: If the AE ONT Connection State displays as Disconnected, the details on screen represents the last saved information.
Provisioning an ONT Ethernet Port for Data

To provision an AE ONT Ethernet port for Data services, a data services profile and VLAN must be established: To provision an AE ONT Ethernet port for data service 1. Select the AE ONT to configure using one of the following methods: On the Navigation Tree, expand a network group to view the network elements, and then click the AE ONT. On the Navigation Tree, click a network group, and then click Network Details > AE ONTs. From the list, double-click an AE ONT. Use the CMS Search feature to find and navigate to an AE ONT. See Performing a Search (on page 107).
2. From the Services pane, check the Data box for the first Ethernet Port. 3. From the drop down list, select a pre-defined Data Service profile (for example, HSD_Tier_A) 4. Enter the Data VLAN ID number for upload. 5. Click Apply. A dialogue box is displayed detailing the progress of the provisioning changes.
103
Provisioning an ONT Ethernet Port for Video

To provision an AE ONT Ethernet port for Video services, a video profile and VLAN must be established: To provision an AE ONT Ethernet port for video service 1. Select the AE ONT to configure using one of the following methods: On the Navigation Tree, expand a network group to view the network elements, and then click the AE ONT. On the Navigation Tree, click a network group, and then click Network Details > AE ONTs. From the list, double-click an AE ONT. Use the CMS Search feature to find and navigate to an AE ONT. See Performing a Search.
2. From the Services pane, check the Video box for the first Ethernet Port. 3. From the drop down list, select a pre-defined Video Service profile (for example, Premium_Tier_A) 4. Enter the Video VLAN ID number for upload. 5. At the top of the Service Work Area, click Apply. A dialogue box is displayed detailing the progress of the provisioning changes.
Provisioning DS0 Voice Ports

Two types of voice ports are supported on AE ONTs: Calix TDM Gateway (CTG) Voice port Session Initiation Protocol (SIP) Voice port
By selecting the appropriate profile, CMS automatically displays the appropriate fields required to provision the service.
About Voice Port Configuration Files

In order for the system to recognize the appropriate configuration file for the voice service being implemented, the following naming conventions must be strictly adhered to: SIP profiles must always include the substring "SIP" within the profile name (for example, SIP_Template_CF.cfg. CTG profiles are recognized by an Interface Group IAD and this IAD must be included as part of the profile name (for example, GR303_N1-2-IG3_Example.cfg).
104
Provisioning a CTG Voice Port

Note: This task assumes that you have already established the TDM switch interfacethat DS1 links are installed and wired, and the GR-303 or GR-8 interface group is provisioned. If you have not yet established the TDM switch interface, do so before continuing. See the C7 Voice Services Guide for instructions. To establish TDM voice service for subtended VoIP lines, create DS0 cross-connects between the GR-303 or GR-8 interface group and the SIP VCG. The DS0 cross-connects are provisioned as Call Reference Values (CRVs) for GR-303 or as channels for GR-8. The CRV/channel IDs you assign at the GR-303/GR-8 interface group must match the assignments at the switch and at the subtended service unit. (The cross-connect endpoints at the SIP VCG use index numbers that have no significance outside of the SIP VCG.) To provision an AE ONT voice port for CTG service 1. Select the AE ONT to configure using one of the following methods: On the Navigation Tree, expand a network group to view the network elements, and then click the AE ONT. On the Navigation Tree, click a network group, and then click Network Details > AE ONTs. From the list, double-click an AE ONT. Use the CMS Search feature to find and navigate to an AE ONT. See Performing a Search.
2. From the Services pane, select the check box for the first DS0 Port. 3. From the drop down list, select a CTG profile (for example, GR303_N1-2-IG3) 4. Enter the CRV number for the CTG voice service. Note: Prior to provisioning CTG voice services on an AE ONT, an Interface Group and CRV must exist in the system. 5. Click Apply. A dialogue box is displayed detailing the progress of the provisioning changes. Note: To complete the end-to-end service provisioning, you must configure the subtended Calix service unit for operation in 'TDM gateway' mode. For example, on an AE ONT, set the VoIP mode to C7 TDM Gateway and configure the VoIP ports accordingly (including the CRV/channel ID (e.g., N1-1-IG1-224) as the 'VoIP Tel Number'). Note: If the VoIP mode is C7 TDM Gateway, enter the CRV or channel ID for the subscriber line, as provisioned on the C7 GR-303 or GR-8 interface group (for example, N11-IG1-224; format is case sensitive).
105
Provisioning a SIP Port

To provision an AE ONT voice port for SIP service 1. Select the AE ONT to configure using one of the following methods: On the Navigation Tree, expand a network group to view the network elements, and then click the AE ONT. On the Navigation Tree, click a network group, and then click Network Details > AE ONTs. From the list, double-click an AE ONT. Use the CMS Search feature to find and navigate to an AE ONT. See Performing a Search.
2. From the Services pane, select the check box for the first DS0 Port. 3. From the drop down list, select a SIP voice profile (for example, SIP_Rev_DialPlan) 4. Enter a user name for the SIP user account. 5. Enter a password for the SIP user account. 6. Enter the SIP URI (for example, 555-555-1212). 7. Enter the Caller ID string to be displayed for this service.
106
Chapter 7 Managing AE ONTs through CMS

The Calix CMS supports basic management of AE ONTs. Topics Covered This chapter covers the following tasks: Searching for AE ONTs in CMS Moving AE ONTs in the Navigation Tree Viewing AE ONTs in Google Maps Removing AE ONT Services Resetting AE ONTs
108
Performing AE ONT Searches

Within CMS, you can run a global search to create a report of all AE ONT Nodes. The data returned in the report is based on the latest synchronized data. Global searches are permission-based; screens and report filters show only those resources that you have permission to view. Members of any default user group have permission to view all resources. Running a global search requires Minimum (Min) CMS Administration privileges. Users in custom user groups with one or more permissions set to None can use the Basic Search feature. For complete information on global searches, refer to the Calix CMS Guide. To perform an AE ONT search in CMS 1. From the Tools menu, click Search > AE ONT. Note: Selections with right-pointing triangles have submenus. An inventory screen is displayed where you set the filter criteria, additional criteria, sort criteria, and report parameters. Optionally, set one or more of the report parameters described in Steps 2 through 6. 2. Define the Region Name where the AE ONTs reside. Under Filter Criteria > Region, click the arrow to the right of the Region topology list to view all available Regions.
109
Note the following: To include multiple Regions in a filter criterion list, use Ctrl+click to select one item at a time, or Shift+click to select a range of items. (To de-select an item, Ctrl+click it again.) The Region list includes both regions and network groups.
3. To define additional filters, click the arrow to the right of Additional Criteria to view the available element filters:
In most cases you specify a match option (Equals, Contains, Not Equals, Starts With, or Ends With), then type a text string in the box to the right. Optionally, select the Case Sensitive check box to only return results matching the case you used). For example, in a node inventory query, to return all nodes named AEONT, set the AID criterion list to Equals and type AEONT (with the Case Sensitive check box selected) in the box. SID indicates the System ID or node name. Type all or part of a node name. For card and port inventory queries, you can filter based on service states and card types. Service states have a Not check box option for searching all inventory that is not in the selected state(s). For example, you can set up a card query to only return ADSL-24 cards that are not out-of-service.
Note: Selecting more than one service state includes the cards or ports that match all of the selected states. Selecting more than one card type includes any of the selected types.
110
4. Specify how to sort the search report. Click the arrow to the right of Sort Criteria, then do the following: a. In the Column Name list, click the filter to use as the primary sort. b. In the Sort Order list, click Ascending or Descending to specify the sort order. c. Click More to list a secondary sort criterion, and then repeat Steps 4a and 4b.
111
5. Change the default report output options. Click the arrow to the right of Report Parameters. You have these options:
Save the file in CSV format by clicking CSV.
Tip: You can also generate a CSV report after generating the HTML search report (Step 6), however, if you anticipate the search report to be large, using the option here eliminates the processing required to generate the HTML report. Change the number of lines per HTML page (or the number of lines to include in the CSV file) from the default of 50. Type a different number in the Lines Per Page box, or click the Show All Rows check box.
Note: A maximum of one million lines can be returned. If you specify a number over 999, do not use a comma as a thousands separator.
112
6. At the bottom of the screen, do one of the following: Use advanced search options to customize the columns displayed in the report and the sort order, as well as set further filter criteria, by clicking Advanced. At the bottom of the Web page or screen, click Submit. The search report displays on screen, or if you selected CSV format in Step 5, the Downloading dialog box opens with options to open the search report directly in your default spreadsheet application, or save the file open to a location on your PC or workstation. Clear the Search screen of all search criteria you have set by clicking Reset. Scroll through multiple search results pages. Use the Next, Last, First, and Prev above or below the list. Return to the Search screen and modify the criteria. Above the report buttons, click Back. Above the list results, toggle the parameters on screen to display those from a different CMS work area (not available on all searches). The link for the currentlyselected set of parameters displays largest. In the report table, for one of the lines in the search report: Open a Table View by clicking the Row # hyperlink. Jump to the Work Area by clicking an ID hyperlink.
7. In the report screen, you have these options:
Note: After clicking an ID hyperlink, you cannot return to the search report without regenerating the report. Save the results displayed on the current screen only in CSV format. Above the report results, click CSV Export. The Downloading dialog box opens with options to open the search results directly in your default spreadsheet application, or save the file to you local hard drive. In CMS, you can run a global search to create a report of all AE ONT Nodes. The data returned in the report is based on the latest synchronized data.
Global searches are permission-based; screens and report filters show only those resources that you have permission to view. Members of any default user group have permission to view all resources. Running a global search requires Minimum (Min) CMS Administration privileges. Users in custom user groups with one or more permissions set to None can use the Basic Search feature. For complete information on global searches, refer to the Calix CMS Guide.
113
Moving an AE ONT in the Navigation Tree

Upon discovery, a Calix AE ONT is initially added to the Autodiscovered system network group on the CMS Navigation Tree. You can move the ONT to a different network group to place it where needed. Modifying a parent network group requires Full CMS administration privileges. Note: You can modify the destination folder of autodiscovered AE ONTs by navigating to CMS > System > System Settings > AE ONT > Default Network Group To move an AE ONT on the Navigation Tree 1. On the Navigation Tree, click any of the following options for the AE ONT: a. the root region b. the parent region c. network group of the AE ONT 2. In the Work Area, click Network Details. 3. In the AE ONT list, click the device(s) to move. For selecting multiple items, use Ctrl+Click to select one item at a time, or Shift+Click to select a range. 4. In the Edit row, click Network Group and then select the new parent network group. 5. Click Apply, and then click OK to save the new settings.
114
Working in Map View

In CMS you can customize your network and node topologies with a background map using Google Maps. Using Google Maps Google Maps uses a hosted service on a Calix server domain. In order to access Google Maps in Map View, your CMS Desktop client machine must be connected to the Internet. Note: To access Google Maps, your client machine cannot use a proxy server for the Internet connection. Check your Web browser settings or consult with your system administrator to be sure that the PC or workstation does not use a proxy server. When you first view the Map View Work Area in CMS, each network element displays as a red pin or icon on a background map of the United States. You have several options: Enter either an address or latitude and longitude coordinates to associate with each network element. Use the navigation buttons at the upper-left corner of the screen to pan up or down and zoom in or out, and then drag the map in any direction using your cursor. Use the options in the upper-right corner of the screen to change the display to a map, satellite, or hybrid view.
To view network elements in Map View 1. On the Navigation Tree, click one of the following: A network group A network element (network, service unit or platform, or an ONT)
2. In the Work Area, click Map View. Tip: Minimize the Alarm Table to view more of the map.
115
3. Use one or more of these methods to zoom to a specific map location and place the network elements: Pan and zoom: Zoom to a map level or in the text box above the navigations buttons, type a location, and click Goto. Alternatively, right-click anywhere on the map to zoom in or out or center the map at a specific location. Goto list (to the right of the Goto button): Select a network element to jump its map location. Click and drag: Use your cursor to drag each pin or icon to a location on the map. As you select and move a pin, it changes to an icon representing the network element type (for ONTs, if a GoogleMap location has not been specified, the network element changes to a blue pin.) Enter a physical location or latitude and longitude coordinates in one of two ways: In the upper-right corner of the map, type in the Goto box. Click an icon to view a popup menu, click Move To, and type in the box.
Tip: A physical location can be a full street address (with city and state) or partial address (such as a city and state). Latitude and longitude coordinates are entered in the following format: LAT,LON. For example, 38.27,-122.66. Location information is saved with the network element object in CMS. 4. (Optional) From Map View, you can jump to any network element in the Navigation Tree. To do so, click an icon to open a popup menu, and then click Open. 5. In the Navigation Tree or Work Area, click Apply, and in the Confirmation dialog box, click OK to save the changes.
116
Removing AE ONT Services

Removing AE ONT service using the Services screen in CMS Desktop requires Full CMS Administration privileges. To remove services from an AE ONT 1. Select the AE ONT to configure using one of the following methods: On the Navigation Tree, expand a network group to view the network elements, and then click the AE ONT. On the Navigation Tree, click a network group, and then click Network Details > AE ONTs. From the list, double-click an AE ONT. Use the CMS Search feature to find and navigate to an AE ONT. See Performing a Search.
In the Work Area, the Services work area for the selected AE ONT displays by default. Video, data, or voice service that has been activated appears expanded on screen with a check box to the left of the service. 2. Clear the check box to the left of the service(s) that you are removing. 3. At the top of the Services work area, click Apply. A confirmation dialog box opens for verifying that you are ready to reset to AE ONT and save the changes. Click Yes to confirm.
117
Resetting an AE ONT
Resetting AE ONTs requires Full CMS Administration privileges. Additionally, the AE ONT must be in a Connected status in CMS. To reset a Calix Active Ethernet (AE) ONT 1. From the Navigation Tree, select one or more AE ONTs using one of the following methods: Expand the network group and select an AE ONT. Select the root region, another region, or a network group. In the Work Area, click Network Details > AE ONTs and select an AE ONT from the list.
To reset multiple AE ONTs, use Ctrl+click to select one ONT at a time, or Shift+click to select a range of ONTs. 2. In the Work Area, click Action > Reset. A Task Progress window opens showing the progress of the action.
118
Chapter 8 Turning Up an AE ONT via CLI

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: 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
120
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 uses to communicate with DHCP, TFTP, NTP, and Syslog servers (default VLAN ID = 85) IP address on Management VLAN for NTP and Syslog server VLAN IDs for other services such as high speed data, IPTV, and VoIP 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.
Prior to turning up the ONT, keep the following information in mind:
About the ONT Runtime 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.
121
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.
122
Configuring 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: The Management VLAN ID value must be between 1 and 4094. 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. To change the management VLAN 1. Disconnect power to the ONT. 2. Verify the network fiber (pigtail) is disconnected 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). 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). 6. 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". 7. Skip to step 9 if MVLAN is correct. 8. 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". 9. 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. 10. Re-connect the network fiber to the ONT and wait for the ONT to come on line.
123
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.
124
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.
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.
125
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.
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.
126
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), 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.
About Syslog Events

The complete list of Syslog events reported by an AE ONT is listed in the table below.
Syslog Events Type
Info
Event
Use Default config filename: FILENAME Failed to retrieve current time from an NTP server Retrieving file FILENAME from server IP_ADDRESS Cannot retrieve config file FILENAME Configuration file FILENAME is over the size limit of 16384 characters Command at line NUMBER in configuration file FILENAME is longer than the 1024 characters limit Configuration file FILENAME is not found at the TFTP server Cannot retrieve firmware image FILENAME from server IP_ADDRESS Firmware upgrade complete. Booting to new version FILENAME is not a configuration file Configuration script error at file FILENAME line NUMBER Configuration file include level exceeded limit ONT reboots shortly due to configuration failure ONT has been configured successfully Cannot create SNMP session on trap sink IP_ADDRESS
Description
DHCP server did not supply configuration filename. As a result the ONT used a default name which is serial number based for its configuration file request. ONT failed to retrieve the current time from an NTP server due to incorrect server address or server timeout ONT was attempting to retrieve the named ONT configuration file at the specified TFTP server ONT failed to retrieve the ONT configuration file from the TFTP server ONT configuration file was over the size limit Command in the ONT configuration file is too long
Warning Info Error Error Error
Error Error Info Error Error Error Info Info Error
ONT configuration file is not available on the TFTP server ONT failed to retrieve the ONT firmware image from the TFTP ONT completed the upgrade of firmware image. ONT would soon reboot to the new firmware. ONT configuration file did not have the correct format. The file signature was not found at the first line. A command in the ONT configuration file failed due to parameter error or processing error. ONT configuration file is recursively including other configuration files at more than 3 levels deep. Error occurred during the processing of the ONT configuration file. ONT would reboot in a few seconds. ONT completed the processing of the configuration file and was configured successfully. ONT Failed to configure SNMP trap sink address.
127
About Alarms
The table below details all alarms reported via the SNMP trap receivers. Note: These alarms are also captured by the Syslog server.
AE Alarms Alarm Name
UDP_ALARM_ON_BATTERY UDP_ALARM_NO_BATTERY UDP_ALARM_BAD_BATTERY UDP_ALARM_TX_LASER UDP_ALARM_VIDEO_SIG_BAD UDP_ALARM_RF_RETURN_LASER_EOL UDP_ALARM_LOW_BATTERY UDP_STATUS_ENET_DOWN UDP_ALARM_UPS_MISSING UDP_ALARM_MGMT_DHCP_RENEWAL UDP_ALARM_VOIP_CONFIG_TFTP_FAILURE UDP_ALARM_VOIP_REG_AUTH_FAILURE UDP_STATUS_ENET_0_OOS UDP_STATUS_ENET_1_OOS UDP_ALARM_VOIP_REGISTRATION
Description
The AC power is disconnected. The ONT is currently on UPS battery power. There is no battery installed in the UPS. The battery is not functioning properly in the UPS. The transmit laser is near End-of-Life. The received RF Video signal level is too low. The RF Return Laser is near End-of-Life (Model 725GX). The UPS battery power level is too low. The ONTs Ethernet port is disconnected. The UPS is missing. The ONT failed to renew the DHCP lease on the Management VLAN for the management interface. The VoIP host failed to retrieve a VoIP configuration file from any TFTP server(s). The VoIP host failed to authenticate with the VoIP server. Ethernet port 1 is configured but the link is down. Ethernet port 2 is configured but the link is down. The VoIP server timed out.
Note: If SNMP trap receivers are not provisioned, alarms may be viewed by opening the current Syslog file.
128
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. For information on displayed alarms in the CMS, refer to Viewing ONT Alarms in CMS (on page 166).
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 139) 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
129
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 must hair-pin between two separate subscriber ports which are members of the same carrier VLAN. This service model is used to configure multiple subscribers into an N:1 service, meaning more than one subscriber is a member of the VLAN, possibly outside the ONT. This type of configuration simplifies subscriber provisioning but requires "MAC forced forwarding" at some level above the ONT, preventing subscribers from directly communicating via Layer-2 in the VLAN. 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.
130
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.
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.
131
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. 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
132
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.
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 ------------CXNK000004E5 CXNK11900002 Assigned IP -------------177.0.0.58 177.0.0.59 FW Ver -------6.0.Z.101 ONT Label ---------16306 36th Ave N <NOT CURRENTLY ACTIVE>
The following ONTs are selected: CXNK000004E5 Dispatching command to ONT config alarms All currently ACTIVE alarms: [ 58] UPS Missing CXNK000004E5 Done CXNK000004E5 at 177.0.0.58 ...
In this example, all ONTs (-a) on the system were scanned and filtered for ONTs with outstanding (active) alarms (-m).
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).
133
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 Layer-2 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. 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.
134
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 bridge add -snoop=ena vid=4002 bridge portadd vid=4002 dev=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 lev2 add -treatinpri=0 -treatinvid=4002 dev=eth-1
Chapter 9 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)
136
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:
137
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.
138
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.
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 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
139
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 limits 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 be greater than or equal to CIR. Note: The minimum metered rate is 0 Kbps (disabled), the maximum metered rate is 200000000 (200 Mbps). 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. One or more VIDs are attached to a given shaper direction. One or more PortId flows are attached to a given shaper. By the WAN side outer VLAN ID value By PON portId (applies to GPON mode only) 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.
140
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.
There are two L2 mapping/filtering tables defined that are operated on the subscriber side of the WAN bridge for each Ethernet port. Level 1 L2 Filtering/Mapping 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=eth0
Result Adds single tag (lev1l2tag), with filter on source address SMAC OUI (-filtmac=sa), adds VID=100, with explicit PBIT value (4)
141
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=eth0
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 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
142
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 Action
lev2l2tag add -treatinpri 5 -treatinvid 200 eth-0
Result Adds single tag, Adds tag, sets explicit PBITs, uses default TPID
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 8 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. The interface supports no-tag, 1 tag, and 2 tag operations however only no-tag, and 1 tag operations are currently supported for the level 1 table. 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.
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. This second table is used exactly the same way as the Level 1 table.
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 L2 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.
144
Chapter 10 Command Line Interface (CLI)

Overview
Provisioning and operational 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. 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.
146
Telnet Interface
The CLI interface is accessed through any Telnet program using special port 23 through the WAN fiber interface. Login is required for Telnet CLI access. Login: admin password: fiber1ttx Note: Both login and passwords 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 all base-level shell commands is displayed:
CXNK03010101>? add ... bridge ... delete ... disable Disable maintenance mode enable Enable maintenance mode explicit Turn on/off CLI explicit 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 ...
147
The "" notation indicates that there are additional parameters following a command (which may or may not be optional). 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 ? conntable Add iparptable Add ipconfigtable Add routetable Add voip ... conn group connTable row ipArp group ipArpTable row ipConfig group ipConfigTable row route group routeTable row
To understand additional parameters associated with the command the help may be additionally invoked such as:
CXNK03010101>add ipconf ?
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.

148
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.
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. (This is for debug ONLY and negatively impacts ONT performance at rates > 60 Mbps. Default = disable type: enable, disable -mf=<enum> Enable/Disable multicast filtering in the UPSTREAM direction, type: enable, disable -fw=<enum> subscriber2subscriber forwarding - enable/disable, default =disable type: enable, disable -snoop=<enum> Turn on IGMP snooping, default = disable type: enable, disable -sv=<enum> Station validation - enable/disable DHCP station validation, default = disable type: enable, disable -macff Enable/Disable MAC forced forwarding support, default = disable type: enable, disable default = disable
Parameters
vid= WAN side VLAN Id for this VLAN (0 - 4094), 0 == untagged type: Unsigned
149
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) type: Interface Name -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.
150
Chapter 11 Remote ONT Activation

RONTA Overview
The Calix Remote ONT Activation (RONTA) 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 RONTA 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 RONTA feature is activated when the ONT is powered with the drop fiber disconnected. The ONT leaves the RONTA mode as soon as an optical signal is detected. The following features are available:
AE ONT RONTA Commands Function Command Keystrokes
Master Reset for an AE ONT (on page 152) Assigning a Registration ID (GPON Mode) Assigning a Registration ID (AE Mode) Assigning an AE Management VLAN to an ONT (on page 154) Placing an AE ONT in Unmanaged mode (on page 155)
***# ***0 ***0 ***1 ***2
Note: Attempts to configure a non-AE capable ONT for Management VLAN, Unmanaged Mode, or AE RONTA (Subscriber ID) are ignored by the ONT.
152
Configuration Rules Follow the rules listed below when configuring Ethernet ports in pass-through mode: The 1st Ethernet port on any ONT can be disabled, assigned to a single VLAN, or configured for pass-through mode. If the 1st Ethernet port is set to pass-through, the 2nd Ethernet port is disabled (in other words, the RONTA prompting stops after the 1st Ethernet port is set to pass-through)
If the 1st Ethernet port is not set to pass-through, the 2nd Ethernet port can be set to disabled, or assigned to a single VLAN, provided the VLAN IDs are not identical at each ONT).
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 1. Disconnect power to the ONT. 2. Verify the network fiber (pigtail) is disconnected 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). 4. Verify the network fiber is disconnected from the ONT. 5. Re-apply power to the ONT. 6. Listen for a click sound coming from the buttset (about 10 seconds after power has been re-applied). 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.
153
Assigning a Registration ID to an ONT (AE Mode)

Buttset provisioning via the remote ONT registration 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 preprovision services to the ONT, the remote ONT registration 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 per PON. 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 RONTA Note: Ensure you listen to the entire voice prompt prior to pressing any keys on the buttset. 1. Disconnect power to the ONT. 2. Verify the network fiber (pigtail) is disconnected 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. Listen to the butt-set, wait for a click sound (about 10 seconds after power has been reapplied). 5. Press "*", "*", "*,"0" (star, star, star, zero) keys on the butt-set key pad. The buttset sounds DTMF tones as the keys are pressed. 6. A voice prompt is heard: "Please enter [PON or AE] Registration ID followed by pound". 7. Enter a Registration ID of your choosing (up to 10 alpha numeric characters in length) followed by the # (pound) key. Note: When using the RONTA technique for turn-up, make sure all Registration ID numbers are unique. 8. The voice prompts: "You entered 'xxxx'. If correct, enter 1, otherwise enter 0".
154
9. If you pressed 1, the voice prompt responds: "Registration ID saved". 10. If you pressed 0, the system returns to step 6 above. Once complete, the following operational behavior is expected: 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. 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"
With the Registration ID now embedded, pre-provisioning is allowed without knowing the ONT serial number.
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 1. Disconnect power to the ONT. 2. Verify the network fiber (pigtail) is disconnected 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). 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). 6. 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". 7. Skip to step 9 if MVLAN is correct. 8. 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".
155
9. 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. 10. Continue entering new RONTA commands as required. 11. Re-connect the network fiber to the ONT and wait for the ONT to come on line.
Assigning an ONT to Unmanaged Mode

Using a buttset device, the 700GX ONT can be configured without requiring a dedicated management server to provide data service. In this mode, one or both subscriber Ethernet ports are configured to pass data on a particular VLAN on the WAN side. If the ONT has two subscriber Ethernet ports, each port is configured for a different VLAN. Note: The same VLAN may not be assigned to both subscriber ports. The first subscriber Ethernet port can also be configured as a simple pass-through pipe. In this case, the ONT passes all tagged and untagged traffic between the WAN interface and the subscriber GE port. The only exception is for Management VLAN traffic that is terminated within the ONT. In this case, the second (expansion) Ethernet port is disabled. See the section WAN to LAN Pass-through for an example. Configuration Rules Follow the rules listed below when configuring Ethernet ports in pass-through mode: The 1st Ethernet port on any ONT can be disabled, assigned to a single VLAN, or configured for pass-through mode. If the 1st Ethernet port is set to pass-through, the 2nd Ethernet port is disabled (in other words, the RONTA prompting stops after the 1st Ethernet port is set to pass-through) If the 1st Ethernet port is not set to pass-through, the 2nd Ethernet port can be set to disabled, or assigned to a single VLAN, provided the VLAN IDs are not identical at each ONT)
To provision AE ONT unmanaged mode via buttset Note: Ensure you listen to the entire voice prompt prior to pressing any keys on the buttset. 1. Disconnect power to the ONT. 2. Verify the network fiber (pigtail) is disconnected 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).
156
4. Re-apply power to the ONT. 5. Listen for a click sound coming from the buttset (about 10 seconds after power has been re-applied). 6. Press "*", "*", "*" and "2" keys (star, star, star, 2) on the buttset key pad. The buttset sounds DTMF tones as the keys are pressed. 7. A voice prompt is heard: "The ONT is in Managed Mode". Note: AE ONTs from the factory default to Managed mode. 8. The voice prompt confirms the current state of each Ethernet port: "Unmanaged mode VLAN for Ethernet port 1 is disabled. To confirm, press 1. Otherwise press zero". Note: Pressing 1 keeps the Ethernet port in Managed mode ("Unmanaged mode for Ethernet port 1 saved"). Pressing 0 provides options for setting the Unmanaged mode VLAN ID (see step 9). Note: Non-AE capable ONTs always remain in Managed mode. Attempts to configure a non-AE ONT for Management VLAN, Unmanaged Mode, or AE RONTA are ignored. 9. After pressing zero, the following prompt is heard: "Please enter Unmanaged mode VLAN for Ethernet port 1 followed by the # (pound) sign". 10. Enter the desired VLAN ID using the buttset keypad, followed by the "#" key. The voice prompt replies: "You entered 'xxxx'. If correct, enter 1, otherwise enter 0". 11. If you pressed 1, the voice prompt responds: "Unmanaged mode VLAN for Ethernet port 1 saved". If you pressed 0, you are returned to step 9. Note: If you enter 4095 as the Unmanaged mode VLAN ID, the voice prompt responds: "You entered 4095 to use pass-through. If correct, enter 1, otherwise enter 0". 12. Repeat steps 8 through 11 for configuring the 2nd Ethernet port (if present). Note: Enter VLAN ID value zero (0) if you want to disable Unmanaged mode for the Ethernet port. Note: You cannot enter a duplicate value for Ethernet ports 1 and 2: "You entered an out of range value". In addition, if you attempt to provision the 2nd Ethernet port to 4095 (pass-through), the same voice prompt is returned. Note: The Unmanaged Mode VLAN cannot be the same as the Management VLAN ("You entered an out of range value".) 13. Continue entering new RONTA commands as required. 14. Connect the network fiber to the ONT. The ONT begins the boot up process. Note: If the VLAN IDs for all subscriber Ethernet ports are configured to be zero, the ONT uses the default boot-up process (Managed mode) requiring a Management VLAN and configuration files.
157
Assigning a Registration ID to an AE ONT

Buttset provisioning via the remote ONT registration 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 preprovision services to the ONT, the remote ONT registration 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 per PON. 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 RONTA Note: Ensure you listen to the entire voice prompt prior to pressing any keys on the buttset. 1. Disconnect power to the ONT. 2. Verify the network fiber (pigtail) is disconnected 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. Listen to the butt-set, wait for a click sound (about 10 seconds after power has been reapplied). 5. Press "*", "*", "*,"0" (star, star, star, zero) keys on the butt-set key pad. The buttset sounds DTMF tones as the keys are pressed. 6. A voice prompt is heard: "Please enter [PON or AE] Registration ID followed by pound". 7. Enter a Registration ID of your choosing (up to 10 alpha numeric characters in length) followed by the # (pound) key. Note: When using the RONTA technique for turn-up, make sure all Registration ID numbers are unique. 8. The voice prompts: "You entered 'xxxx'. If correct, enter 1, otherwise enter 0".
158
9. If you pressed 1, the voice prompt responds: "Registration ID saved". 10. If you pressed 0, the system returns to step 6 above. Once complete, the following operational behavior is expected: 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. 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"
With the Registration ID now embedded, pre-provisioning is allowed without knowing the ONT serial number.
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 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 is 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.
159
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 makes 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
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.
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]). When registering with the CMS, AE ONTs include additional information such as model number and firmware revision. 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.
160
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 requests 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 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 simply ignores 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 executes the firmware matching/upgrade as instructed by the CLI command.
Chapter 12 System Maintenance and Troubleshooting

Configuration File Back-up
When considering the back-up needs for your deployment, two types of configuration files need to be addressed: Configuration File Templates AE ONT Configuration Files generated by the system
Configuration File Templates These configuration files include files that were provided as part of the AE ONT Software as well as any additional configuration files you created in support of service delivery. These files are installed in specific locations on the CMS server and are replicated on the TFTP server (assuming they are located in the right spot). Because these files are automatically replicated, no additional back-up strategies need be implemented. If desired, the folder location where these files are stored on the TFTP server could be added to your normal nightly back-up routine. To restore these configuration files to their proper location, move the back-up set from its current location to the "live" folder on the TFTP server.
162
AE ONT Configuration Files These system created configuration files (for example, "CXNK45567788.cfg") are treated as objects in the database and can be recovered through the CMSWEB utility. 1. Launch the CMSWEB Interface. 2. Navigate to Administration > Import > CMS Objects 3. Enter the filename for the back-up file to restore. 4. Click Submit.
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 163) TFTP server responds with file not found (on page 163) Download transfer is interrupted (on page 163) 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). 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.
163
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.
164
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, the 700GX, at a minimum, resets and returns to the phase 1 boot state (on page 123) 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 reset. 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. 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 700GX 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".
165
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. 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.
166
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. 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
167
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.
168
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 700GX and 700GE 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. For additional information, refer to Channel and Drop Testing (on page 303) in the Command Reference section of this guide.
169
Pinging AE ONTs
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: . . . Number of ping requests to send type: Integer Bytes of data to send type: Integer Timeout in milliseconds to wait for each reply type: Integer Source iP Address type: IP Address
-n=<n>
-l=<n>
=w=<n>
-src=<ipaddr>
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 Reply from <ipaddr>: bytes=32 time<1ms TTL=63 Reply from <ipaddr>: bytes=32 time<1ms TTL=63 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
For AE ONTs with more than one host, you must specify the Gateway address associated with the ONT in order to verify a connection.
170
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 IpNextHop --------------- --------------- --------------10.100.100.0 255.255.255.0 10.100.100.200 66.231.10.0 255.255.255.192 66.231.10.55 127.0.0.0 255.0.0.0 127.0.0.1
I/F -----iph-0 iph-1 loop-0
Type -----local local local
Proto ---------local 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 Reply from 64.33.247.229: bytes=32 time<10ms Reply from 64.33.247.229: bytes=32 time<10ms 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.
171
Diagnostic Commands
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 are often requested by Calix Service Engineers during the troubleshooting process. The config diag command outputs the following in sequence: ver (on page 336) - displays information on the AE ONT being queried. config history (on page 219) - displays all previously performed "config" commands for the AE ONT. show iftab (on page 220) - displays interface, administrative state, and operational state information for the AE ONT. show ifstats (on page 221) - displays data flow, lost packets, and the like for serviceability and debugging by the operator. mpp rates (on page 331) - 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 223) - displays basic Layer-2 information about the AE ONT Ethernet port. bridge show bridge (on page 240) - displays detailed information about all bridges (or a single bridge [-bid=x]) configured at the ONT. bridge show drops (on page 240) - displays all dropped packet counters associated with the Layer2 bridging functions configured on the ONT. bridge glob (on page 236) - displays forwarding statistics not attributed to any particular bridge. meter show info (on page 231) - This command summarizes information on each traffic shaper. It is used as a debugging or sanity check mechanism. iphost show (on page 245) - This command is used to display current information about IP Hosts. mpp ess (on page 331) - displays the ingress and egress Ethernet port statistics by MAC Address show voip mib (on page 315) - displays pertinent information for the VoIP service by port. voipreg (on page 323) - displays the VoIP addressing parameters for each VoIP port. voiprtp (on page 323) - displays the RTP Packet and error information. voipcc (on page 325) - displays the current call state by port.
172
lev1l2tag show eth-0 (on page 261) - displays upstream and downstream tagging history for each Ethernet port. lev2l2tag show eth-0 (on page 269) - 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.
CMS 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 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
Voice Services
173
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 - CLI

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.
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=eth0 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
bridge show bridges The "bridge show bridges" displays: All of the configured bridges on an AE ONT Unicast and multicast statistics for the bridge Additional settings for the bridge.
174
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 igmpSnoopInd: FALS filtUpMcastInd: FALS EthMcastUnkCnt: 0 filtUpMcastCnt: 0 dhcpUpstreamSnoopHits: 0 dhcpDnstreamSnoopHits: 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 Bridge: Type: VLAN Members: 2 VID: 0x0fa0 (4000) PBIT: (0) learningInd: FALS sub2subFwInd: TRUE igmpSnoopInd: FALS filtUpMcastInd: FALS EthMcastUnkCnt: 0 filtUpMcastCnt: 0 dhcpUpstreamSnoopHits: 0 dhcpDnstreamSnoopHits: 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
175
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
mpp packet Next, you can begin dumping packets while going through the queue to see whether a packet tagged with the expected tag is present. Consulting the table above, I am focusing on the 1st ethernet port (ETH0Rx) and looking for a packet with a value of 512 9first packet).In the case below, the first queue entry for what is being received on eth-0 of the ONT is displayed using the mpp packet command:
176 CXNK000370EE> mpp packet 512 MPP Packet number 512 at Ptr 0x597 at Address 0x01acb800 80440079 10000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 ffffffff 00119291 00119291 8a1c0013 80efc911 8100038c 08004500 00679198 40007d06 4cf00ab0 018c0ac0 080d0d19 008beecd e19b4f6e 9efc5018 fc90185b 00000000 003bff53 4d422e00 00000018 07c80000 021c6bf2 6ad96b03 000006a0 fffe0220 01af0cff 00dede0f c0000000 00b810b8 10ffffff ffb81000 00000000 00000000 00ad044e 434e3d50 43435044 4330312c 434e3d53 65727665 72732c43 4e3d5043 432d5075 65626c6f 2c434e3d 53697465 732c434e 3d436f6e 66696775 72617469 6f6e2c44 433d6363 6f66632c 44433d65 64753084 00000057 30840000 0051040f 73657276 65725265 66657265 6e636531 84000000 3a043843 4e3d5043 43504443
This same command can be used on any of the locations identified in the output of "mpp q." As shown above, the ONT received a tagged packet with a value of 908. Practically speaking, there may be hundreds of packets (typical in a TLS environment) with hundreds of VLANs. Implementing a more automated method is needed. By using the "lev2 show <dev>" command, you can determine how many hits each tag entry is taking on a specified interface:
CXNK000370EE> lev2 show eth-0 Level 2 Upstream Tagging Entry Table: unit = upstream_filter_drops = 0 outputTpid = 8100 inputTpid = 8100 I ac fop fov fotp fip fiv fitp feth tr top - -- --- ---- ---- --- ---- ---- ---- -- --0 9 15 4096 0 8 4096 5 0 0 8 1 0 15 4096 0 15 4096 0 0 0 15 Level 2 Downstream Tagging Entry Table: unit dnstream_filter_drops = 0 outputTpid = 8100 inputTpid = 8100 I ac fop fov fotp fip fiv fitp feth tr top - -- --- ---- ---- --- ---- ---- ---- -- --0 7 8 4000 6 8 4096 6 0 1 15 1 6 15 0 6 0 4000 6 0 1 15 0
tov totp tip tiv titp hits ---- ---- --- ---- ---- ---4000 6 8 4096 6 158d 0 6 0 4000 6 7c = 0
tov totp tip tiv titp hits ---- ---- --- ---- ---- ---0 6 15 4096 6 11f7 0 6 15 4096 6 0
177
Troubleshooting AE ONT Ethernet Issues - CMS

Use the Action menu to launch specific dialogs to assist in troubleshooting and diagnostics.
Actions Menu Options Menu Item

RESET SYNCALARM
Underlying CLI Command

not applicable not applicable
Description
Resets all statistics for the selected ONT. When initiated, the system clears all alarms pertaining to the ONT and then displays a list of current standing alarms via SNMP GET. Opens a CLI (telnet) window for the selected ONT. Full definitions here (on page 257). Displays a summary of all bridges configured on an ONT. Full definitions here (on page 239). Displays the status of all Ethernet ports associated with the ONT. Full definitions here (on page 223). Displays statistics for Ethernet interfaces associated with the ONT. Full definitions here (on page 221). Displays statistics for ONT interfaces. Full definitions here (on page 220). Displays the physical location of the current VLAN associated with the ONT. Full definitions here (on page 245). Displays statistics for MAC forced forwarding addressing. Full definitions here (on page 251). Displays a summary of all traffic shapers. Full definitions here (on page 231). Deletes any association of this ONT with the uplinked E5-400 or E7.
CUT-THROUGH TELNET LAYER 2 INTERFACE TABLE SHOW BRIDGE SUMMARY SHOW ETHERTABLE SHOW INTERFACE STATISTICS SHOW INTERFACE TABLE SHOW IP HOST
not applicable l2l (el - 2 - el) bridge show summary show ethertable show ifstats show iftable iphost show
SHOW MAC FORCED FORWARDING SHOW METERS UNLINK FROM E5-400/E7
macff show meter show info not applicable
178
To access ONT diagnostics in CMS 1. In the Navigate Tree, select the ONT to display statistics 2. From the Action Menu (Work Area), select the appropriate category that you want to view. 3. A CLI Cut-Through window opens and displays the appropriate data.
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. Note: Make sure you adhere to the CF location (on page 72) and structure (on page 72) instructions for CMS based systems. The configuration files included here are included with the AE ONT software distribution. Topics Covered This chapter includes CF Templates for the following: Top-level AE ONT CF using embedded sub-configuration files (710X ONT). Provisions triple play services. Common CF for identifying system management tasks including: Syslog Server iP address SNMP Trap address NTP Server IP address ONT firmware update location High Speed Internet (HSI) Global parameters IPTV Service Global parameters Voice Service VLAN IP Host parameters
HSI detailed parameters CFs Transparent LAN Service (TLS) CF STB map OUI CF Generic Video CF SIP Voice Port CF STB map OUI CF VoIP CF A Monolithic CF file (no embedded CF files)
179
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 - 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 # # === 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 (eth-0) # include hsi_setup.cfg 4001 eth-0 0 # include hsi_setup.cfg 4001 eth-0 1 # include hsi_setup.cfg 4001 eth-0 2 # # # # # #
Second Ethernet port (eth-1) include hsi_setup.cfg include hsi_setup.cfg include hsi_setup.cfg 4002 eth-1 0 4002 eth-1 1 4002 eth-1 2
180 # === Transparent LAN Services setup === # # # 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 # # Add subscriber Ethernet port to the TLS VLAN # # Script parameters: # $0 = TLS 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) # # include tls_setup.cfg 900 eth-0 0 # include tls_setup.cfg 900 eth-1 0 # # === TLS with Q in Q === # # This script sets up the VLAN bridge for TLS and the appropriate traffic # filtering # # Script parameters: # $0 = TLS VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # # Attach subscriber Ethernet port to VLAN bridge # bridge portadd vid=$0 dev=$1 # 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)
181 lev2l2tag add \ -filtinpri=8 \ -filtintpidde=5 \ -treatoutpri=8 \ -treatoutvid=$0 \ -treatinpri=8 \ -treatinvid=4096 \ dev=$1 # # Attach service profile to TLS VLAN # meter attach downstream -vid=$0 shaper=$2 meter attach upstream -vid=$0 shaper=$2 # === Video service setup === # # Configure the subscriber Ethernet ports participating in # video service. The ports 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: # $0 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # include video_setup.cfg eth-0 # include video_setup.cfg eth-1 # # === Voice service setup === # # Add voice service to port 0 # # 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 # include voice_add.cfg 0 Name_Line1 7635551011 password 7635551011 # # Add voice service to port 1 # # Script parameters: # $0 = POTS port number (0, 1, .. etc) # $1 = VOIP port label, alphanumerical label # $2 = VOIP registration username # $3 = VOIP registration password
182 # $4 = URI # include voice_add.cfg 1 Name_Line2 7635551013 password 7635551013 # # === Ethernet port enabling === # # All Ethernet ports are administratively disabled by default. # Each Ethernet port needs to be specifically enabled before any # data traffic passes through. # Enable eth-0 set iftable adminstatus index=eth-0 adminstatus=up # Enable eth-1 # set iftable adminstatus index=eth-1 adminstatus=up
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
"serialnumber.cfg" or "registrationid.cfg" Main
Hierarchy
Included Configuration Files

common.cfg hsi_setup.cfg video_setup.cfg voice_add.cfg
Defined Parameters
ONT Control VLAN (Default 85) TLS VLAN 900 SIP/VoIP VLAN 3001 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) 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
common.cfg
Included in Main Configuration File
None
hsi_setup.cfg
Included in Main Configuration File
None
183 Sample Cascading Configuration File Definitions

video_setup.cfg Included in Main Configuration File video_oui.cfg video_oui.cfg voice_setup.cfg VoIPConfig.txt Included in video_setup.cfg Included in Main Configuration File Called out in voice_setup.cfg file None None None Sets up IPTV service on ONT Ethernet port Adds ONT Ethernet port to IPTV VLAN Bridge Sets up OUI filtering
Adds desired filter for STB - routes to appropriate IPTV VLAN Adds VoIP service to a port Defines all VoIP service parameters
Common CF The cascading configuration file above includes the following common attributes which apply to virtually all ONTs on this network (common.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 #
184 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 # config upgrade \ -prisvr 172.26.31.3 \ -secsvr 172.26.31.4 \ filename=calix_ae.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 meter set upstream shaper=0 cir=40000000 pir=40000000 meter set downstream shaper=0 cir=40000000 pir=40000000 # Silver level # 20 Mbps upstream, 20 Mbps downstream on all traffic on an Ethernet port meter set upstream shaper=1 cir=20000000 pir=20000000 meter set downstream shaper=1 cir=20000000 pir=20000000 # Bronze level # 10 Mbps upstream, 10 Mbps downstream on all traffic on an Ethernet port meter set upstream shaper=2 cir=10000000 pir=10000000 meter set downstream shaper=2 cir=10000000 pir=10000000 # # Low speed shaper for upstream broadcast as security for the HSI VLAN # meter set upstream shaper=10 cir=10000 pir=10000 ######################################################################
185 # IPTV service ###################################################################### # # Create VLAN bridge for IPTV service on VLAN 4090 # bridge add -snoop=ena vid=4090 # # (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
186
HSI CF The cascading configuration file above includes the following high speed internet configuration file (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: # $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) # # # 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" # # (optional) enable option82 on IPTV bridge # 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
187 # is mapped to HSI, VLAN $1 on $0 # lev2 add -treatinpri=0 -treatinvid=$0 dev=$1 # # Attach low speed shaper for upstream multicast as security # meter attach mcastup vid=$0 shaper=10 # # Attach silver level service profile to HSI VLAN # meter attach downstream -vid=$0 shaper=$2 meter attach upstream -vid=$0 shaper=$2
Video Services CF The cascading configuration file above includes the following video services parameters (video_setup.cfg).
[CALIX_AE_ONT:R1] # # Setup IPTV service on subscriber Ethernet port # # Script parameters: # $0 = Ethernet port eth-0, eth-1 . . eth-x depending on ONT type # # 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
188
Video Set-top Box OUI Filter
The following configuration file sets up the proper filtering for video set-top boxes and is called out in the video_setup.cfg file.
[CALIX_AE_ONT:R1] # # Add Level 1 layer 2 filter for OUI (STBs) map to IPTV VLAN # # Script parameters: # $0 = IPTV VLAN # $1 = Ethernet port eth-0, eth-1 . . eth-X depending on ONT type # # 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
189
Monolithic CF for a Single ONT The monolithic method employs a single configuration file for defining all parameters within an ONT. Note: The monolithic method is recommended for deployments where ONT services are nearly identical from one ONT to another. [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 - 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.cfg # # Assign a custom label to this ONT # 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) #
190
# First Ethernet port (eth-0) # include hsi_setup.cfg 4001 eth-0 0 # include hsi_setup.cfg 4001 eth-0 1 # include hsi_setup.cfg 4001 eth-0 2 # # # # # Second Ethernet port (eth-1) include hsi_setup.cfg include hsi_setup.cfg 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 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 # $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) # # include tls_setup.cfg 900 eth-0 0 # include tls_setup.cfg 900 eth-1 0 # # === TLS with Q in Q === # # This script sets up the VLAN bridge for TLS and the appropriate traffic # filtering # # Script parameters: # $0 = TLS VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # # Attach subscriber Ethernet port to VLAN bridge # bridge portadd vid=$0 dev=$1
191 # 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 \ -treatoutvid=$0 \ -treatinpri=8 \ -treatinvid=4096 \ dev=$1 # # Attach service profile to TLS VLAN # meter attach downstream -vid=$0 shaper=$2 meter attach upstream -vid=$0 shaper=$2 # === Video service setup === # # Configure the subscriber Ethernet ports participating in # video service. The ports 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: # $0 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # include video_setup.cfg eth-0 # include video_setup.cfg eth-1 # # === Voice service setup === # # Add voice service to port 0 # # 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
192 # include voice_add.cfg 0 Name_Line1 7635551011 password 7635551011 # # Add voice service to port 1 # # 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 # include voice_add.cfg 1 Name_Line2 7635551013 password 7635551013 # # === Ethernet port enabling === # # All Ethernet ports are administratively disabled by default. # Each Ethernet port needs to be specifically enabled before any # data traffic passes through. # Enable eth-0 set iftable adminstatus index=eth-0 adminstatus=up # Enable eth-1 # set iftable adminstatus index=eth-1 adminstatus=up
193
Sample SIP Configuration File

The Calix SIP configuration file template is shown below. You can modify the configuration settings as needed to suit your application requirements. Note: Use a text editor only (such as Notepad) to edit a configuration file. Do not use a word processing program such as MS Word, which adds font formatting that corrupts the configuration file. The following file provides the detail and structure of the actual VoIP configuration file (VoipConfig.txt). Note: For additional information, refer to the ONT SIP Configuration File Settings topic below.
;Agile Document Part P/N: 600675-0002 Rev 13 ; SPECIFICATION, GPON ONT VOIP CONFIGURATION FILE ; ;Revision Date Description :-------- --------------------------------------; 1.10 2/15/2007 added Nortel and Sonus support ; 1.11 4/05/2007 added Agile Part Number ; 1.12 4/05/2007 added edit warning ; 1.13 5/01/2009 added Nortel DMS-10/PGI options ; 1.14 4/23/2010 added Dial Plan enhancements ; 1.15 8/18/2010 added VoIP Stutter Count option ; ;IMPORTANT: ;DO NOT USE MICROSOFT WORD TO EDIT THIS FILE ;Only use a text editor (like Notepad) that does not add ;additional formatting. ;At a minimum you must edit: ;1. Either the SipProxyIP or the SipProxyDomain fields with your site's ; values (dependent on whether you are using DNS or IP schema). ;2. DNSPrimaryIP, DNSAlternateIP with your site's values. ;3. VoipIntraLATA with your site's IntraLATA area codes. ; ; CALIX_VOIP_Config.txt ; ------------------;============================================================= ;Configuration file to initialize the Calix VOIP application ;============================================================= ;Syntax definition: ;Parameter: Value ;1) Please note - the parameter's names as well as values are ; case sensitive.
194 ;2) ; ;3) ;4) Semi-colon at start of line (column 1) is a comment/remark line only Parameter must start at column 1 (no leading spaces allowed) Whitespace allowed between Parameter: Value
;Version of VOIP config file Version: 1.14 ;ONT UDP SIP Port Address (default = 5060) OntPort: 5060 ;Outbound Proxy option (default = 1) ;1=enabled, 0=disabled OutboundProxy: 1 ;Border Controller or SIP Proxy Server ;UDP,IP address, or domain name server address SipProxyIP: x.x.x.x SipPort: 5060 SipProxyDomain: your.SipProxy.com ;Primary (required) and secondary (optional) DNS IP address ; for the ONT Port being provisioned DNSPrimaryIP: x.x.x.x DNSAlternateIP: x.x.x.x ;SIP Timers (in msec) SipT1Timer: 500 SipT2Timer: 4000 ;SIP Registration (default = 1) ;1=registration enabled, 0=disabled SipRegistration: 1 ;SIP Registration Period (in seconds). Maximum registration ; period for the SIP connection SipRegPeriod: 3600 ;SIP Register User (default = 0) ;Required for Nortel DMS-10/PGI, CS1500, and CS2000 (1) ;Required for Broadsoft BroadWorks (1) ;Required for Metaswitch (1) ;1=use UserID field, 0=use URI field SipRegisterUser: 0 ;SipE164 Adds country code to SIP messages (default = 0) ;1=use E.164 global format for SIP msgs, ;0=use local format
195 SipE164: 0 ;ToS bit for RTP packet stamping (0-255 bits) ;Recommend setting QoS to high priority (default = 160) RtpTOS: 160 ;RTP base port. Starting port number for range of ports ; for allowed RTP access (ONT RTPBasePort = 16384) RtpBasePort: 16384 ;Rtp Codec (default = 0) ;0=G.711 u-law, 1=G.711 a-law RtpCodec: 0 ;RTP Packet Rate (default = 10) ;Select 10, 20, or 30 msec packetization rate RtpPacketRate: 10 ;Ring Tone Definitions ;Table Format below consists of: ; number of frequency components (single or dual tone) ; 1st frequency (Hz) ; 2nd frequency (Hz) ; volume level tone 1(dbm) ; volume level tone 2(dbm) ; time tone is on (msec) ; time tone is off (msec) ; continuous tone flag definition: ; 1 = on ; 0 = off (one-shot) Used for Call Waiting Only ; 2-10 = (stutter count) ;Below are recommended default values ;Note: Enter with space between values VoipDialTone: VoipBusyTone: VoipReorderTone: VoipRingbackTone: VoipCallWait1Tone: VoipWarningTone: VoipAlertTone: VoipCASTone: VoipStutterDialTone: 2 350 440 -13 2 480 620 -24 2 480 620 -24 2 440 480 -19 1 440 0 -13 2 1400 2600 0 1 440 0 -13 2 2130 2750 -18 2 350 440 -13 -13 1 0 1 -24 500 500 1 -24 250 250 1 -19 2000 4000 1 0 330 0 0 0 100 100 1 0 2000 10000 1 -18 80 0 1 -13 100 100 10
;Ring Cadence Definitions ;Up to 8 discrete ring tones can be provisioned ;Format consists of frequency and time components: ; Ringing Frequency: 0 = 20 Hz
196 ; Shape: 1=sinusoidal 0=trapazoidal ; ringing period 1 ontime (msec) ; ringing period 1 offtime (msec) ; ringing period 2 ontime (msec) ; ringing period 2 offtime (msec) ; ringing period 3 ontime (msec) ; ringing period 3 offtime (msec) ; VoipRingCycleR1: 0 0 2000 4000 2000 4000 VoipRingCycleR2: 0 0 800 400 800 4000 VoipRingCycleR3: 0 0 400 200 400 200 VoipRingCycleR4: 0 0 300 200 1000 200 VoipRingCycleR5: 0 0 500 0 0 0 VoipRingCycleR6: 0 0 2000 4000 2000 4000 VoipRingCycleR7: 0 0 2000 4000 2000 4000 VoipRingCycleR8: 0 0 2000 4000 2000 4000
2000 0 800 300 0 2000 2000 2000
4000 0 4000 4000 0 4000 4000 4000
;Distinctive Ringing Alert ;Required for Broadsoft BroadWorks only (default Bellcore-dr1) ;Sends ring alert in SIP INFO VoipDRmessage: Bellcore-dr ;Voip Call Waiting signaling pattern ;Required for Broadsoft Broadworks only VoipCWmessage: CallWaitingTone ;Reorder Delay (default = 10) ;Delay (seconds) before playing fast busy tone VoipReorderDelay: 10 ;Warning Delay (default = 60) ;Delay (seconds) before playing warning (howler) tone VoipWarningDelay: 60 ;Warning Timeout (default = 600) ;Period (seconds) to play warning (howler) tone VoipWarningTimeout: 600 ;Dial Plan ;The dial plan can be customized for each switch type ;See SIP VoIP Configuration Parameters for details ;Note: Use the "\" character to extend values over multiple lines ; Syntax: ; ^ Match from start of dial string ; | Rule separator for multiple rules per plan ; [n-m] Match a range of digits ; {n} Match n digits ; * Matching a variable number of digits
197 ; T Variable digit timeout ; S Star phone key (*) match character ; c Confirmation tone is played when dialing star code ; plans: ^S72c[0-9][0-9]{6}| ; r Recall tone is played during a call forwarding ; sequence: ^S72r[2-9][0-9]{6}| ; d Dial tone is played during a call forwarding ; sequence: ^S72d[2-9][0-9]{6}| ; , Comma) - outside dial tone is played during a ; preceding "9" sequence: ^9,1[2-9][0-9]{9}| ; ^911 Emergency 911 Service ; ^411 Directory Assistance Service ; ^S[0-9]{2} Star hotkey service (for example, *69) ; ^1[0-9]{10} Traditional long distance dialing ;^2[2-9][0-9]{9} Traditional local dialing with toll free area code ; capability ; ^011[0-9]*T Traditional overseas dialing ;Example dial plan: ^911|^411|^S[0-9]{2}|^1[0-9]{10}\ ;^2[2-9][0-9]{9}|^011[0-9]*T ;Below are recommended dial plan default values VoipDialPlan: ^911^411|\ ^S67[2-9][2-9][0-9]{9}|\ ^S72[2-9][0-9]{9}|\ ^S74[2-9][2-9][0-9]{9}|\ ^S75[2-9]{2}[2-9][0-9]{9}|\ ^S90[2-9][0-9]{9}|\ ^S92[2-9][0-9]{9}|\ ^S3[0-9]{2}|\ ^S15|^S23|^S27|\ ^S91|^S93|^S7[3-9]|\ ^S[5-6][0-9]|\ ^S8[0-9]|\ ^1[0-9]{10}|\ ^[2-9][0-9]{9}|\ ^011[0-9]*T ;Area code exceptions, intra-LATA dialing ;List codes that do not need a preceding "1" ;Note: Enter values with a space between codes VoipIntraLATA: 952 763 651 612 507 218 ;Dial Plan Digit timeout (default = 16) ;Delay timeout (seconds) before sending string to switch. In ; effect when there are no partial matches in the dial ; string digits dialed so far VoipDialTimeout: 16
198
;Dial Plan Interdigit Short Timeout (default = 8) ;Sets the delay timer (seconds) for partial match ; of incomplete dial strings (slow dialers). In effect when there ; are partial matches in the dial string digits dialed so far. VoipDialShortTimeout: 8 ;Embedded 7 digit dial plan rule. (default = 1) ;Used to over-ride the standard ONT 7 digit dial plan. ;1=enabled, 0=disabled Embedded7DigitRule: 1 ;SIP INFO Message (default = 0) ;Required for Metaswitch and Broadsoft BroadWorks (1) ;Option to send a required SIP INFO message on a flash-hook ;1=Send INFO, 0=use Call Hold Re-Invite VoipFlashINFO: 0 ;E911CalledPartyHold option (default = 1) ;No SIP BYE message sent, provides local power RING back ;0=No special treatment, 1=Hold 911 call if Onhook E911CalledPartyHold: 1 ;Call Waiting Disable (default = 0) ;Required for support of Hunt Groups (1) ;1=disable Call Waiting, 0=Call Waiting enabled VoipCallWaitDisabled: 0 ;Caller ID Disable (default = 0) ;Disables Caller ID feature on a per ONT basis ;1=Caller ID display disabled, 0=Caller ID enabled VoipCallIDDisabled: 0 ;ONT Controlled Three Way Calling (default = 0) ;Required for switches that do not support audio mixing ;For Nortel DSM10/PGI, CS1500, and CS2000 (1 or 0) ;1=Enabled, 0=Disabled ThreeWayCallEnabled: 0 ;DTMF Key Send Method (default = 0) ;Required for GENBAND M6 Application Server only (1) ;0=inband audio, 1=SIP INFO msg VoipDTMFmode: 0 ;DTMF Key Receive Method (default = 0) ;Required for GENBAND M6 Application Server only ;0=play DTMF from SIP INFO msg, 1=disable DTMFtonefromINFOdisabled: 1
199
;Call on Hold disconnect stutter dial tone (default = 0) ;1=play Stutter Dial Tone, 0= do not play Stutter Dial tone StutterOnHoldDisconnect: 0
ONT SIP Configuration File Settings The table below shows the required configuration file variables and respective descriptions.
ONT SIP (VoIP) Configuration Settings
Version of VoIP config file ONT SIP Port Outbound Proxy Option Sip Proxy Server IP Address SipPort Sip Proxy Domain Version of the VoIP config file. Displays the config file version number. Example: Version 1.15 Enter the UDP Port address of the ONT. Example: OntPort: 5060 Sets a flag to capture all SIP messages to the SIP Proxy IP Address server. Example: OutboundProxy: 1 Enter the UDP or IP address for the Border Controller or the SIP Proxy server. Example: SipProxyIP: 172.26.31.16 Enter the UDP/IP Port # of the ONT SIP Port. Example: SipPort: 5060 The SipProxyDomain can be an IP address or a Fully Qualified Domain Name (FQDN). Example: SipProxyDomain: 172.26.31.16 Example: davinci.datcon.co.uk (Metaswitch interop server) DNS IP Address Enter the primary (required) and secondary (optional) DNS IP Address for the ONT Port being provisioned: Example: DNSPrimaryIP: x.x.x.x DNSAlternateIP: x.x.x.x IMPORTANT: These values must be changed to the appropriate network IP address prior to implementing SIP Service. SIP Timers (msecs) Enter SIP Timer time-out values in milliseconds (required parameter per RFC 3261). Example: SipT1Timer: 500 SipT2Timer: 4000 SIP Registration Enter 0 if you want to disable Sip Registration, enter 1 to enable. Calix recommends keeping this enabled unless you have a totally secure network. Example: SipRegistration: 1 SIP Registration Period Enter the maximum registration period for the SIP connection. Example: SipRegPeriod: 3600 Note: Calix recommends you accept the above default values as the SIP Server over-ride (the above value if pre-provisioned on the SIP Server). SIP Registration User Required parameter for several SIP switch vendors including Nortel, Broadsoft, and Metaswitch. Enter 0 if Registration ID comes from the URI field, enter 1 if from the UserID field. (Default = 0) Example: SipRegisterUser: 0 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 (All of North America except Mexico [52]). This setting is rarely used or required. Example: SipE164: 1 QoS Type of Service (RtpTOS) Enter the TOS bits for RTP packet stamping (0-255 bits) Example: RtpTOS: 160
200
Important: It is recommended that you set your QoS to a relatively high priority in order to avoid potential voice service degradation. RTP Voice base port number (RtpBasePort) Input the starting port number of a specified range of ports that are allowed access to the RTP service. Each ONT VoIP port requires two RTP port numbers. Example: RtpBasePort: 16384 Important: Failure to properly identify this range of ports causes the firewall to reject transmissions. RTPCodec (voice encoding) RTP Packet Rate Enter the voice encoding option. This should always be set to zero (law). (Default = 0) Example: RtpCodec: 0 Input the expected RTP packetization rate sent by the ONT. Choose between 10, 20, or 30 msecs. Example: RtpPacketRate: 10 The configuration file contains options for setting the following ring tone characteristics: Ring Tone Definitions Dial Tone, Busy Tone, Reorder Tone (fast busy), Ringback Tone, Call Waiting Tone, Warning Tone, Alert Tone, CAS Tone, and Stutter Dial Tone. Options are entered in the following order: Number of Frequency components in this definition, 1st Frequency(in hertz), 2nd Frequency, Volume Level of 1st Frequency (in dbm), Volume Level of 2nd Frequency, Time tone is on (in milliseconds), time tone is off and continuous tone on (1) or off (0)*. Examples: VoipDialTone VoipBusyTone VoipReorder Tone VoipRingback Tone VoipCallWait1 Tone VoipWarning Tone VoiPAlertTone VoipCASTTone VoipStutter* Dialtone 2 2 1 2 1 2 2 480 440 440 1400 440 2130 350 620 480 0 2600 0 2750 440 -24 -19 -13 0 -13 -18 -13 -24 -19 0 0 0 -18 -13 250 2000 330 100 2000 80 100 250 4000 0 100 10000 0 100 1 1 0 1 1 1 10 2 2 350 480 440 620 -13 -24 -13 -24 1 500 0 500 1 1
* - For the VoipStutterDialTone command, the continuous tone flag definition includes the following options: 1 = continuous tone (no stutter) 0 = one-shot tone stutter tone (used for call waiting only) 2-10 = stutter count - the number of stutter tones to play before returning to normal dialtone (default = 10) Important: Unless you are thoroughly trained on Tone provisioning, it is recommended you accept the default values. Note: Ring Tone Definition names do not include any spaces. Spaces may appear here for document formatting purposes only.
201
Ring Cadence Definitions Enter Ringtone Cadences as required. Up to 8 discrete ring tones can be provisioned per configuration file. Options are entered in the following order: Ring frequency (0 = 20 hertz), Shape (0-trapazoidal, 1=sinusoidal), ring period 1 on time, ring period 1 off time, ring period 2 on time, ring period 2 off time, ring period 3 on time, ring period 3 off time (all values in milliseconds) VoipRing CycleR1 VoipRing Cycle2 VoipRing Cycle3 VoipRing Cycle4 VoipRing Cycle5 VoipRing Cycle6 VoipRing Cycle7 VoipRing Cycle8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2000 800 400 300 500 2000 2000 2000 4000 400 200 200 0 4000 4000 4000 2000 800 400 1000 0 2000 2000 2000 4000 4000 200 200 0 4000 4000 4000 2000 0 800 300 0 2000 2000 2000 4000 0 4000 4000 0 4000 4000 4000
Important: Unless you are thoroughly familiar with ring cadence provisioning, it is recommended you accept the default values. Ring Cadence Definitions 1 through 5 are Telcordia defined and should not be changed. Cadences 6 through 8 are user definable. Note: Ring Cadence Definition names do not include any spaces. Spaces may appear here for document formatting purposes only. Distinctive Ringing Alert Enter a value for distinctive ring alerting (For Broadsoft and MetaSwitch). This field is used for creating a pattern match between the Alert Header for distinctive ring. Choose between Bellcore-dr1 through Bellcore-dr5 Example: VoipDRmessage: Bellcore-dr Note: The Nortel CS2000 does not support Bellcore syntax and sends the pattern match as "dst_ring_x". Softswitch Distinctive Ring (Call Waiting) Enter the softswitch signaling pattern for call waiting (Broadsoft BoradWorks switch). This field is used for creating a pattern match for the Distinctive Ring Call Waiting Tone being sent down from the switch. This command is ignored on other switch types. Example: VoipCWmessage: CallWaitingTone Enter the delay in seconds before playing a fast busy tone after far end hang up or far end off hook. Example: VoipReorderDelay: 10 Warning Delay Period Enter the delay in seconds before playing a warning tone "howler" if phone is off hook Example: VoipWarningDelay: 60 Enter the amount of time (in seconds) to play the warning "howler" after the Warning Delay parameter above has elapsed. Example: VoipWarningTimeout: 600
Reorder Delay
202
Dial Plans
Enter the types of dialing plans you wish to enable. Dial Plan syntax: ^ = match from start of string | = rule separator for multiple rules per plan [n-m] = match a range of digits {n} = match n digits * = wildcard match - for a variable number of digits T = timeout send of dial string S = star phone key (*) match character in dial plan c = Confirmation tone is played when dialing star code plans ^S72c[0-9][0-9]{6}| r = Recall tone is played during a call forwarding sequence ^S72r[2-9][0-9]{6}| d = Dial tone is played during a call forwarding sequence ^S72d[2-9][0-9]{6}| , (comma) = Outside dial tone is played during a preceding "9" sequence ^9,1[2-9][0-9]{9} *T = Represents the time in seconds before digits are sent. Required for slow dialers. Example: ^01[2-9][0-9]{4}*T|\ ^911 = 911 service ^411 = Directory Assistance Service ^S[0-9]{2} = Star hotkey service (i.e. *69) ^1[0-9]{10} = Traditional Long Distance Dialing ^[2-9][0-9]{9} = Traditional Local Dialing with toll free area code capability ^011[0-9]*T = Traditional Overseas Dialing Example: ^911|^411|^S[0-9]{2}|^1[0-9]{10}|^2[2-9][0-9]{9}|^011[0-9]*T Note: To dial the operator, enter 0 and wait for the Dial timeout feature to send the zero digit to the switch where the switch then forwards the call to the operator. Alternatively, avoid the delay by dialing 0#.
Area Code Exceptions
For multi-area code communities, enter the list of toll free area codes to provision without dialing a one first. Example: VoipIntroLATA: 952 763 651 612 507 218
Dial Plan Timeout
Enter (in seconds), the input delay timeout before sending the string to the switch. Example: VoipDialTimeout: 8
Dial Plan Short Timeout
This is a delay timer (seconds) for a partial match "pause" until all digits have been collected. Slow dialers may need this feature. Example: VoipDialShortTimeout: 8
Embedded 7 Digit Dial Plan
The ONT SIP Client currently has a 7-digit dial rule. This command allows you to over-ride the rule. (Default = rule in effect [0]. Example: Embedded7DigitRule: 0
SIP INFO Message
For Flash Hook messages, you can send a SIP INFO message. Variables: 1 = send INFO, 0 = use Call Hold re-INVITE. Default = 0. Applies to Metaswitch and Broadsoft only. Example: VoipFlashINFO: 1
E911 Called Party Hold
An option exists to specify whether a caller may hang up during an E911 call. Variables: 0 = no special treatment, 1 = Hold 911 call if On Hook, don't send SIP BYE command; provide local power RING back. Example: E911CalledPartyHold: 1
203
Disable Call Waiting Need to execute hunt groups on certain softswitches. Variables: 1 = Disable Call Waiting, 0 - Call Waiting enabled (default). Example: VoipCallWaitDisabled: 0 Disable ONT Caller ID Needed to disable Caller ID display feature at the ONT. Variables: 1 = Caller ID display disabled, 0 = Caller ID enabled (default). Example: VoipCallIDDisabled:0 Three Way Calling Allows for configuring 3-way calling as an optional service. Example: ThreewayCallEnabled: 1 (Default = 0)
DTMF Key Send
Genband M6 requires OOB (SIP INFO) messaging. DTMF Key Send allows you to toggle between inband audio [0] and SIP INFO [1]. Example: VoipDTMFmode: 0
DTMF Key Receive
Can enable or disable the playing of the DTMF SIP INFO message. [0] = playout SIP INFO message. [1] = Disable playout. Genband M6 only. Example: dTMFTonefromiNFOdisabled:1
Stutter Dial Tone
Call On Hold disconnect stutter dial tone can be enabled [1] or disabled [0]. Example: StutterOnHoldDisconnect: 0
GR-303 Voice Port CF

[CALIX_AE_ONT:R1] # # Example GR303 Voice profile # # Add GR303 voice service to a port # # Script parameters: # $0 = POTS port number (0, 1, .. etc) # $1 = LINEAID # ctg setup \ -pbit=5 \ -linemode=GroundStart \ board=i-pots \ port=$0 \ ctgsvr=172.26.203.17 \ lineaid=$1 \ vid=3001
204
SIP Voice Port CF

[CALIX_AE_ONT:R1] # # Example SIP Voice profile # # Add SIP voice service to a port # # Script parameters: # $0 = POTS port number (0, 1, .. etc) # $1 = DISPLAY # $2 = User # $3 = Password # $4 = URI # voip setup \ -pbit=5 \ vid=3001 \ board=i-pots \ port=$0 \ display=$1 \ file=inc/VoipConfig.txt \ prisvr=172.26.203.16 \ secsvr=172.26.203.16 \ user=$2 \ password=$3 \ uri=$4
STB Mapping OUI CF

[CALIX_AE_ONT:R1] # # Add Level 1 layer 2 filter for OUI (STBs) map to IPTV VLAN # # Script parameters: # $0 = IPTV VLAN # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # # 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
205
Sample Configuration Files - CMS

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. Note: Make sure you adhere to the CF location (on page 72) and structure (on page 72) instructions for CMS based systems. The CF file examples listed below are included in CMS. Topics Covered This chapter includes CF Templates for the following: Top-level AE ONT CF using embedded sub-configuration files Common CF for identifying system wide parameters Data service CF Gold, Silver, Bronze Bandwidth CF A default Video CF A GR-303 TDM Gateway Voice Port CF SIP Voice Port CF STB map OUI CF VoIP CF
AE ONT CF
[CALIX_AE_ONT:R1] # # This configuration file example sets up triple play services on an # Calix GX ONT. # include inc/common.cfg config label set label="16305 36th Ave N Plymouth" include inc/data/Gold.cfg 4002 eth-0 include inc/data/Silver.cfg 4002 eth-1 include inc/video/Default.cfg 4090 eth-0 include inc/video/Default.cfg 4091 eth-1 set iftable adminstatus index=eth-0 adminstatus=up set iftable adminstatus index=eth-1 adminstatus=up include inc/voice/GR303_N1-2-IG3_Example.cfg 0 N1-2-IG3-4 include inc/voice/SIP_Example.cfg 1 "caller id" "user" "password" "7075551212"
206
Common CF
[CALIX_AE_ONT:R1] ###################################################################### # Common 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 # config upgrade \ -prisvr 172.26.31.3 \ -secsvr 172.26.31.4 \ filename=calix_ae.rto
207
Data Service CF
[CALIX_AE_ONT:R1] # # Common setup script for data service # # This CF sets up the VLAN bridge for data service and the appropriate traffic # filtering. # # Script parameters: # $0 = HSI VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # $2 = Downstream committed bandwidth in bits per second # $3 = Downstream peak bandwidth in bits per second # $4 = Upstream committed bandwidth in bits per second # $5 = Upstream peak bandwidth in bits per second # # # Create VLAN Per service data service on VLAN $0 - port $1, filter all upstream multicast # and enable MAC forced forwarding # bridge setup -mf=enable -macff=enable -dcir=$2 -dpir=$3 -ucir=$4 upir=$5 vid=$0 dev=$1 # # Add a Level 2 filter such that all other untagged traffic from subscriber # is mapped to data service, VLAN $0 on port $1 # lev2 add -treatinpri=0 -treatinvid=$0 dev=$1
208
Bandwidth Profile CF
Customers often offer varying levels of bandwidth for data services. Follows are three data service bandwidth profiles: Bronze CF
[CALIX_AE_ONT:R1] # # Example "Bronze" level data service profile # 10Mbits/sec upstream and downstream direction # # Script parameters: # # $0 = Data VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # # Setup the VLAN bridge for data service and the appropriate traffic # filtering. # # data_setup.cfg script parameters: # # $0 = Data VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # $2 = Downstream committed bandwidth in bits per second # $3 = Downstream peak bandwidth in bits per second # $4 = Upstream committed bandwidth in bits per second # $5 = Upstream peak bandwidth in bits per second include inc/data_setup.cfg $0 $1 10000000 10000000 10000000 10000000
Silver CF
[CALIX_AE_ONT:R1] # # Example "Silver" level data service profile # 20Mbits/sec upstream and downstream direction # # Script parameters: # # $0 = Data VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # # Setup the VLAN bridge for data service and the appropriate traffic # filtering. # # data_setup.cfg script parameters:
209 # # # # # # #
$0 $1 $2 $3 $4 $5
= = = = = =
Data VLAN assigned for this subscriber Ethernet port eth-0, eth-1 .. eth-X depending on ONT type Downstream committed bandwidth in bits per second Downstream peak bandwidth in bits per second Upstream committed bandwidth in bits per second Upstream peak bandwidth in bits per second
include inc/data_setup.cfg $0 $1 20000000 20000000 20000000 20000000
Gold CF
[CALIX_AE_ONT:R1] # # Example "Gold" level data service profile # 40Mbits/sec upstream and downstream direction # # Script parameters: # # $0 = Data VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # # Setup the VLAN bridge for data service and the appropriate traffic # filtering. # # data_setup.cfg script parameters: # # $0 = Data VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # $2 = Downstream committed bandwidth in bits per second # $3 = Downstream peak bandwidth in bits per second # $4 = Upstream committed bandwidth in bits per second # $5 = Upstream peak bandwidth in bits per second include inc/data_setup.cfg $0 $1 40000000 40000000 40000000 40000000
210
Video CF
[CALIX_AE_ONT:R1] # # Example "Default" Video profile # # Configure the subscriber Ethernet ports participating in # video service. # # Script parameters: # $0 = Video VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # # # Setup VLAN bridge for video service on VLAN $0 port $1, enable # IGMP snooping and MAC forced forwarding # bridge setup -snoop=enable -macff=enable vid=$0 dev=$1 # # Set up appropriate OUI filtering for set top boxes # include inc/video_oui.cfg $0 $1
Appendix A Appendix
Glossary
Glossary of Terms
Term Active Ethernet (AE) ARD ARP BRAS E5 C7 CPE DHCP Downstream EPG ERD FE FTTP
Definition
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. Architecture Requirements Document Defines a piece of the architecture for the product. The ARD also provides a response to the PSA. Address Resolution Protocol The protocol TCP/IP uses to map an IP address to a MAC address. Broadband Remote Access Server A IP network element that aggregates user sessions from the access network, provides policy management, and provides QoS. Calixs remote IP DSLAM platform. Calixs multi-service, multi-protocol DSLAM/BDLC platform. 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. Dynamic Host Configuration Protocol Manages the assignment of IP addresses within a network. The direction of traffic flow from the central office and the customer premise. 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. 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. Fast Ethernet 100 Mbps Ethernet (SMII or 100base-T) Fiber to the Premise A fiber transmission scheme to deliver broadband access between the central office and customer premise.
212 Glossary of Terms
GBIC GE IGMP IPOTS IPTV LLDP LACP MAC MEF MPEG-X MC PHY PPPoX PSTN POTS PSA QoS RED RTSP SerDes SFP SIP SLIC SMII SGMII SONET STB Tail-Drop TDMoIP
Gigabit Interface Converter A high speed transceiver that interfaces electrical/digital signals with optical/fiber signals. Gigabit Ethernet Internet Group Management Protocol A protocol that allows for multicasting. Integrated POTS A method within the E5 for integrating voice and data service onto a single digital network. Internet Protocol Television Video delivery for televisions using the Internet Protocol Link Layer Discovery Protocol IEEE 802.1ab draft standard defines a protocol used to do device discovery using Ethernet. 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). Media Access Control MAC address is the physical address of a network element. Metro Ethernet Forum. Motion Picture Experts Group Video compression/encoding formats. Multicast A packet that has a Multicast Ethernet address Physical Interface In a DSLAM, the xDSL interface. 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. Public Switched Telephone Network A voice-band telephone network. Plain Old Telephone System A voice-band telephone network (PSTN). Product Specifications Agreement Defined the market requirements for the product. Quality of Service Random Early Discard A method of discarding packets during network congestion. Real Time Streaming Protocol A protocol used as the data packetization method for VOIP packets. Serializer/Deserializer Converts between parallel and serial data. Extra bits are added/removed from the serial stream to embed/synthesize a clock. Simple Form Factor Pluggable A pluggable module that interfaces digital circuitry to optical fiber. Session Initiation Protocol A protocol used to establish, modify, or terminate multimedia applications, such as voice-over-IP and video conferencing. Subscriber Line Interface Circuit Provides the analog POTS interface on the local telephone loop. Serial Media Independent Interface An interface definition to transport 10/100 Ethernet. Serial Gigabit Media Independent Interface An interface definition to transport Gigabit Ethernet. Synchronous Optical Network An ANSI standard, fiber optic transmission system. Set Top Box The device which terminates video service at a customer premise. A method of discarding packets during network congestion. Time Division Multiplexed over Internet Protocol A method for trunking raw voice data over an IP connection.
213 Glossary of Terms
TLAN Upstream Utopia VLAN VoD VoIP xDSL
Transparent Local Access Network Provides a single LAN (or VLAN) between multiple end-points on different xDSL connections. The direction of traffic flow from the customer premise to the central office. Universal Test and Operations Interface for ATM. A synchronous physical interface bus used to transport fixed-length packets. Virtual Local Access Network A logical grouping of LAN devices. Video on Demand Unicast video for television. Voice over Internet Protocol A real-time protocol that allows voice delivery over IP networks (e.g. SIP). 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.
214
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. Note: Beginning with CMS version 11.1, multiple CLI sessions can be launched for side by side comparison of ONTs in the network. In addition, Action menus have been added that launch specific dialogs to assist in troubleshooting and diagnostics.
To open multiple CLI sessions 1. Navigate to the Network Group where the ONTs reside and click the network group. 2. From the work area, select Network Details > AE ONT 3. Shift-click multiple ONTs from the list and right click this multiple line selection. 4. Hover your mouse over CUT-THROUGH TELNET and click. 5. A separate CMS Cut-Through windows open. Note: Windows may be hidden behind other open windows on your desktop. Check your Windows Quick Launch window for additional CLI windows.
215
Viewing Commands Config Commands

A single command is provided which is used to configure basic ONT operation. This command is called config. 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)
216
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.
config ntp update Usage
config ntp update [-prisvr=<ipaddr>] [-secsvr=<ipaddr>] [-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 -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)
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)
217
Config upgrade 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 -nofail Downgrade allowed Continue configuration process despite upgrade failure
Parameters
filename=<str> firmware image filename type: Character String (80)
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
218
Config vlan 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 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). 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 type: Character String (32) Trap sink #1 IP address type: IP Address Trap sink #2 IP address type: IP Address Trap sink #3 IP address type: IP Address -s4=<ipaddr> Trap sink #4 IP address type: IP Address -freq=<n> Initial registration frequency in seconds (0 to disable) type: Integer (0,3600)
-s1=<ipaddr>
-s2=<ipaddr>
-s3=<ipaddr>
219
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 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 config syslog setup config trap sink -prisvr=172.26.31.3 -secsvr=172.26.31.4
-s1=172.26.31.65 -s2=10.83.1.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 shaper=0 cir=40000000 pir=40000000 meter set downstream shaper=0 cir=40000000 pir=40000000 meter set upstream shaper=1 cir=20000000 pir=20000000 meter set downstream shaper=1 cir=20000000 pir=20000000 meter set upstream shaper=2 cir=10000000 pir=10000000 meter set downstream shaper=2 cir=10000000 pir=10000000 meter set upstream shaper=10 cir=10000 pir=10000 bridge add -snoop=ena vid=4090 bridge addiph -pbit=5 vid=3001 bridge portadd vid=3001 dev=iph-1 iphost create dev=iph-1 config label set label="16305 36th Ave N Plymouth" bridge add -lb=enable -mf=enable vid=2501 bridge portadd vid=2501 dev=eth-0 lev2 add -treatinpri=0 -treatinvid=2501 dev=eth-0 meter attach mcastup vid=2501 shaper=10 meter attach downstream -vid=2501 shaper=0 meter attach upstream -vid=2501 shaper=0 bridge portadd vid=4090 dev=eth-0 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 -
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 m2u age 1 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 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 set iftable adminstatus index=eth-0 adminstatus=up show iftab show ifstats mpp rates show ethert bridge show bridge bridge show drops
220 config history

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 mpp queues bridge glob meter show info meter show count iphost show mpp ess mpp show show voip mib voipreg voiprtp voipcc lev1l2tag show eth-0 lev2l2tag show eth-0 config diag show iftab show ifstats mpp rates show ethert
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. Show iftable The following CLI capture shows the display on a 714GX ONT:
CXNK03010101> show iftable
I/F ---eth-0 eth-1 loop-0 iph-0 iph-1 iph-2 iph-3 iph-4 wan-0 Type ----ether ether loop ether ether ether ether ether ether MTU ----1500 1500 1500 1500 1500 1500 1500 1500 1500 Speed -------0 0 0 0 0 0 0 0 0 PhysAddress --------------00-01-02-03-99-00 00-01-02-03-99-01 00-00-00-00-00-00 00-01-03-01-01-00 00-01-03-01-01-10 00-01-03-01-01-11 00-01-03-01-01-12 00-01-03-01-01-13 00-01-02-03-99-01 Admn -------up up up up up up up up up Oper -----up up up up up up up up up LastChg --------100 100 100 100 100 100 100 100 100
221 Show iftable Field Definitions Value

I/F Type MTU PhysAddress Speed Admn Oper LastChg
Description
The Interface Name The Interface Type The maximum transmission unit of the IP payload The IEEE MAC address of the interface Unsupported. See "show ethert" to get the current operable link speed. The desired administrative state, "up" or "down" 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. The time in seconds since "epoch" when the last change in operational state occurred.
Show ifstats 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 ---eth-0 eth-1 loop-0 iph-0 iph-1 iph-2 iph-3 iph-4 wan-0 InOctets --------10864 2280 32 0 0 0 0 0 0 InUcastPkt -----------78 13 1 0 0 0 0 0 0 InNUcastPk ------------6 20 0 0 0 0 0 0 0 outOctets ---------6768 1334 32 0 0 0 0 0 0 OutUcastPk -----------75 15 1 0 0 0 0 0 0 OutNUcastP -----------15 3 0 0 0 0 0 0 0
I/F ---eth-0 eth-1 loop-0 iph-0 iph-1 iph-2 iph-3 iph-4 wan-0
InDiscards ----------0 0 0 0 0 0 0 0 0
InErrors --------0 0 0 0 0 0 0 0 0
InUnknwnPr ------------0 0 0 0 0 0 0 0 0
outDiscard --------------0 0 0 0 0 0 0 0 0
OutErrors ---------0 0 0 0 0 0 0 0 0
OutQLen -------0 0 0 0 0 0 0 0 0
222 Show ifstats Field Definitions Value

I/F ifInUcastPkts ifInNUcastPkts ifInDiscards The Interface Name The number of subnetwork-unicast packets delivered to a higher-layer protocol. The number of non-unicast (i.e., subnetwork-broadcast or subnetwork-multicast) packets delivered to a higher-layer protocol. 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. The number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. The number of packets received via the interface which were discarded because of an unknown or unsupported protocol The total number of octets transmitted out of the interface, including framing characters 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. 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. 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. The number of outbound packets that could not be transmitted because of errors. The length of the output packet queue in packets.
Description
ifInErrors ifInUnknownProtos ifOutOctets ifOutUcastPkts ifOutNUcastPkts
ifOutDiscards
ifOutErrors ifOutQLen
Set iftab 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 iftab 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
223
Ethert Commands
Various Ethernet commands are available to monitor the physical Ethernet ports. 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 ---eth-0 eth-1 iph-0 iph-1 iph-2 iph-3 iph-4 wan-4 AdminMode --------------auto auto auto auto auto auto auto auto OperMode -----------100-full 100-full 100-full 100-full 100-full 100-full 100-full 100-full PhysAddress ------------------00-01-02-03-99-00 00-01-02-03-99-01 00-01-03-01-01-00 00-01-03-01-01-10 00-01-03-01-01-11 00-01-03-01-01-12 00-01-03-01-01-13 00-01-02-03-99-01
Show ethert Command Field Definitions Value

I/F AdminMode OperMode PhysAddress The Interface Name 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". The current operating Ethernet mode of the interface, unknown, 10-half, 10-full, 100-half, 100-full, 1000-half, 1000-full. The IEEE MAC address of the interface
Description
224
Set ethert Admin 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
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 138). 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:
225
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.
meter set downstream Usage
meter set downstream <shaper> <cir> <pir> Set downstream shaper rate
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
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 <shaper> <cir> <pir> Set upstream shaper rate
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
226
Meter attach downstream 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.
meter attach downstream Usage
meter attach downstream [-dev=<fname>] [-vid=] [-portid=] shaper= Attach downstream shaper to flow
Options
Parameters
227
Meter de-attach 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
Parameters
228
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
Parameters
shaper= Upstream shaper number (0-31) type: Unsigned
229
Meter de-attach 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
Parameters
shaper= Upstream shaper number (0-31) type: Unsigned
230
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= Upstream shaper number (0-31) type: Unsigned vid= WAN VLAN ID value flow (0 - 4094) type: Unsigned
Meter de-attach 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= WAN VLAN ID value flow (0 - 4094) type: Unsigned
231
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 ---4 3 2 1 0 CIR ---10000 100000000 100000000 30000000 200000 PIR ---10000 100000000 100000000 30000000 200000 RunAvg --------0 0 0 0 0 Drops ------0 0 0 0 0 pmap ------0000 0000 0000 0000 0000 attachments -------------mv4001 v4001 v4002 eth-0 UNASSIGNED v100
******Downstream Shaper Info****** Idx ---3 2 1 0 CIR ---100000000 100000000 30000000 200000 PIR ---100000000 100000000 30000000 200000 RunAvg --------0 0 0 0 Drops ------0 0 0 0 pmap ------0000 0000 0000 0000 attachments -------------v4001 v4002 eth-0 UNASSIGNED v100
meter show info Field Definitions Value

IDx CIR PIR RunAvg Drops Pmap Attachments The shaper index value The committed information rate of the shaper The peak information rate of the shaper The current running average rate of information passing through this shaper. The number of packets dropped on this shaper due to queue full conditions. A bit map of occupied priority queues in hexadecimal. The least significant bit is priority 0. 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
Description
232
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 139). VLAN per Port and VLAN per Service Bridge Create The VLAN per port model is used when each subscriber port on the ONT is associated with a separate single WAN VLAN. Typically the ONT does not perform a "learning bridge" function when operating on this type of bridge. It simply maps and forward data between the WAN port and a single subscriber port. This bridge may be configured to "learn" MAC addresses on each side for the purpose of debugging via the l2l command. The VLAN per service model is used when more than one Ethernet port is associated with a single WAN side VLAN. The scope of the VLAN may be either within the ONT or spread across multiple subscribers and ONTs. This service model may be used to configure multiple subscribers into an N:1 service model, in other words, more than one subscriber is a member of the VLAN, possibly outside the ONT. This type of configuration simplifies subscriber provisioning but requires "MAC force forwarding" at some level above the ONT. This prevents subscribers from directly communicating via Layer-2 in the VLAN. For either scenario, the commands to create a VLAN bridge and associate the bridge to a subscriber port is defined below:
233
VLAN 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. (This is for debug ONLY and negatively impacts ONT performance at rates > 60 Mbps. Default = disable type: enable, disable -mf=<enum> Enable/Disable multicast filtering in the UPSTREAM direction, type: enable, disable -fw=<enum> subscriber2subscriber forwarding - enable/disable, default =disable type: enable, disable -snoop=<enum> Turn on IGMP snooping, default = disable type: enable, disable -sv=<enum> Station validation - enable/disable DHCP station validation, default = disable type: enable, disable -macff Enable/Disable MAC forced forwarding support, default = disable type: enable, disable default = disable
Parameters
vid= WAN side VLAN Id for this VLAN (0 - 4094), 0 == untagged type: Unsigned Note: References to the -snoop command refer to IGMP snooping.
234
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= lWAN side VLAN Id for this VLAN (0 - 4094), 0 == untagged type: Unsigned dev=<ifname> eth device name type: Interface Name
IGMP Snoop VLAN Per Service Bridge 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 224).
235
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 Ethernet device name to apply (eth-0 - eth-n) type: Interface Name
Enable Multicast to Unicast Mode The multicast to Unicast mode sets the Ethernet ports to unicast from multicast mode.
multi mode unicast Usage
multi mode unicast <dev> Set ethernet port multicast mode to multicast to unicast
Parameters
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 ----eth-0 eth-1 mode ------unicast multicast
236
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

ffwd_downstream_no_bridge ffwd_upstream_no_bridge ffwd_downstream_no_ports ffwd_send_error_ae
Description
Downstream packets dropped without bridge definitions. Upstream packets dropped without bridge definitions. Downstream packets dropped with no port definitions assigned. Forwarded packets dropped due to send errors.
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.
237
Bridge setup
The bridge setup command is used to facilitate the provisioning of objects within CMS.
bridge setup Usage
bridge setup -mf=enable -macff=enable -dcir=40000000 -dpir=40000000 -ucir=40000000 -upir=40000000 vid= dev=eth-0 Add bridge for data services on a port
Options
-vprofile=<str> Name of video profile when snooping is enabled. Default = None. type: Character string (14) -mf=<enum> Enable or disable upstream multicast filtering. Default = disable type: enable, disable -macff=<enum> Enable/Disable MAC forced forwarding support, default = disable type: enable, disable -dcir=<enum> Committed downstream unicast traffic rate type: Character string (14) -dpir=<enum> Peak downstream unicast traffic rate type: Character string (14) -ucir=<enum> Committed upstream unicast traffic rate type: Character string (14) -upir=<enum> Peak upstream unicast traffic rate type: Character string (14)
Parameters
vid= WAN side VLAN ID for this VLAN (0-4094) type: Unsigned dev= Ethernet device name type: Interface name
238
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 238)" 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 238)" command. Creates a pair of downstream and upstream traffic shapers and attaches them to the VLAN bridge. Reference "meter set downstream" (on page 224), "meter set upstream (on page 225)", and "meter attach (on page 226)" commands. Attaches the multicast upstream shaper to the VLAN bridge if the "-mshaper" option is provided. Reference "meter attach mcastup (on page 230)" command.
IP Host Bridge Create (bridge add)
This command creates an IP host VLAN Bridge

bridge add Usage
bridge addiph [-pbit=] vid= Add an IP host VLAN Bridge
Options
Parameters
vid= WAN side VLAN ID for this VLAN (0-4094), 0 = untagged type: Unsigned
239
Add IP Host to VLAN Bridge (bridgeport add)
This command can be called repeatedly for each member IP host in a VLAN.
bridge portadd Usage
bridge portadd vid= dev=<ifname> Associate a port with an already created VLAN Bridge
Parameters
vid= WAN side VLAN ID for this VLAN (0-4094), 0 = untagged type: Unsigned dev=<ifname> eth device name type: Interface Name
Bridge Show Summary
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 ---31 30 Type ----VLANIPH VLANPS Member -------2 2 VID ---85 300 upUcast -------0 16 dnUcast -------0 17 upNUcast ---------5 1 dnNUcast ---------0 0
Bridge Show Summary Command Value

BID Type Member VID upUcast dnUcast upNUcast dnNUcast
Description
The ONT's internal Bridge ID. This is used to display detailed bridge information with the "bri show bri -bid=x" command (optional). The type of bridge as it was created The number or port members on this bridge The VLAN ID assigned to the bridge The number of unicast packets sent out the WAN side of the bridge The number unicast packets sent out the subscriber side of the bridge The number of non-unicast packets sent out the WAN side of the bridge The number of non-unicast packets sent out the subscriber side of the bridge
240
Bridge Show Drops
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 --0 16 SID ----eth wan bKuNK -----TRUE FALSE ingressDrop -------------0 0 egressDrop ------------0 0 ponIndDrop -------------0 0 dstSrcDrop ------------0 0 mtuDrop ---------0 0
bridge show drops Field Definitions Value

McastDrops DnNoEthMDrops Idx SID BkUnk ingressDrop egressDrop ponIndDrop dstSrcDrop mtuDrdop
Description
The number of broadcast/multicast/unknown packets dropped for various reasons. The number of broadcast/multicast/unknown packets received on a PON Connection that were dropped because no Ethernet port existed as a forwarding member. The port number (relative 0) if the port member is a WAN, Ethernet port or IP Host port. The segment identifier. The Boolean value indicating whether broadcast/unknown packets can be sent to the port. The total number of packets dropped on the ingress side of the interface. The total number of packets dropped on the egress side of the interface. The number of uni-cast packets dropped which were forward to an ATM port where ponPortBridgingInd has been set to FALSE. 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. The number of packets dropped at the destination egress side because the packet to be forwarded exceeded the max MTU provisioned for the port.
241
Bridge Show Bridge
This CLI is used to dump detailed information about all bridges (or a single bridge [-bid=x]) configured at the ONT. An example output is shown below:
CXNK03010101> bri sh bri Bridge: 026f96e8-1f Type: VLANIPH Members: 2 VID: 0x0055 (0085) PBIT: 5 learningInd: TRUE igmpSnoopInd: FALS filtUpMcastInd: FALS sub2subFwInd: FALS EthMcastUnkCnt: 0 filtUpMcastCnt: 0 dhcpUpstreamSnoopHits: 0 dhcpDnstreamSnoopHits: 0 option82ProcessErrors: 0
Idx ---0 0 SID ---iph wan Ecp ---NUL NUL FCS ----NUL NUL BkUn -----TRU E TRU E UP ---5 5 DP ---5 5 ucast_in --------0 0 ucast_out ----------0 0 mcast_in ----------7 0 mcast_out -----------0 7
Bridge: Type: Members: VID: PBIT: learningInd: sub2subFwInd: stationValidation: option82Enabled: MACFF: igmpSnoopInd: filtUpMcastInd: EthMcastUnkCnt: dhcpUpstreamSnoopHits: dhcpDnstreamSnoopHits: EthMcastUnk: filteredMulticastUp: stationvalidcount:
026faed0-1e VLAN 2 0X012C (0300) (0) TRUE FALS FALS FALS TRUE FALS FALS 0 0 0 0 0 0
242
Idx ---0 0 SID ---eth wan Ecp ----NUL NUL FCS ----NUL NUL BkUn -----TRUE TRUE UP ---0 0 DP ---0 0 ucast_in --------16 17 ucast_out ----------17 16 mcast_in ----------1 0 mcast_out -----------0 1
bridge show bridge Field Definitions Value

Bridge Type Members VID PBIT learningInd sub2subFwInd stationValidation option82Enabled MACFF igmpSnoopInd filtUpMcastInd EthMcast UnkCnt dhcpUpstreamSnoopHits dhcpDnstreamSnoopHits EthMcastUnk filteredMulticastUp stationvalidcount Option82ProcessErrors Idx SID Encap FCSId BkUnk UP DP
Description
This is a unique bridge handle (X) used by the internal mechanisms. The Bridge type defined for the AE ONT. The current number of port members. Members are either PON SIDs, Ethernet ports, or IP Hosts. The VLAN ID used by this bridge. The PBIT value for an IPHost Bridge (if applicable). Boolean value indicating whether MAC learning is turned on for this bridge. Allows subscriber to forward packets directly to another subscriber. Enable/Disable station validation. If stationValidation is true, then MACFF is enabled at bridge creation. Indicates whether Option-82 is inserted onto upstream DHCP requests Enable/Disable MAC Forced Forwarding Boolean value indicating whether IGMP snooping is enabled. Boolean value indicating whether the topion to filter upstream multicast is enabled. The number of multicast/broadcast/unknown destination packets which have been sent to the Ethernet port members of the bridge. The number DHCP upstream packets detected during snooping. The number of DHCP downstream packets detected during snooping. Ethernet Multicast Unknown Counts The number of multicast packets that have been filtered out when "filtUpMcastInd" is TRUE. Number of packets from a valid station count. The number of processing errors associated with Option-82 insertion. 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. 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. Unused by the AE ONT Unused by the AE ONT The Boolean value indicating whether broadcast/unknown packets can be sent to the port. The Ndab packet upstream send priority. A value of 7 is the highest priority. A value of 0 is the lowest priority. The Ndab packet downstream send priority. A value of 7 is the highest priority. A
243 bridge show bridge Field Definitions

value of 0 is the lowest priority. ucast_in ucast_out mcast_in mcast_out The number of uni-cast packets received on the interface port. The number of uni-cast packets sent to the interface port. The number of multicast/broadcast/unknown packets received on the interface port. The number of multicast/broadcast/unknown packets sent to the interface port. This is maintained on PON segments only since EthMcastUnk is used to track Ethernet multicast output.
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 224) 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:
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).
244
IP Host Create
The IP Host used for Layer-3 services destined for the ONT is defined by the IP Host Create 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 type: enable/disable
-ping=<enum> -tracert=<enum> -rsh=<enum> -gwf=<enum>
ICMP ping enable/disable, default = enable type: enable/disable ICMP tracert enable/disable, default = enable type: enable/disable Telnet/rsh enable/disable, default = enable. type: enable/disable Gateway forwarding, enable/disable, Default (iph-1 through iph-n = enable), (iph-0 = disable) type: enable/disable
-staticip=<ipaddr> -mask=<ipaddr> -gateway=<ipaddr>
Static IP Host Address, must specify <-dhcp disable>, <-mask>, and <-gateway> type: IP Address IP Host Mask, must specify <-dhcp disable>, <-staticip>, and <-gateway> type: IP Address 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) type: Interface Name
245
IP Host Delete
To delete an IP Host entry:

iphost delete Usage
iphost delete dev=<ifname> Delete IP Host
Parameters
dev=<ifname> IP Host device name flow (iph-1 - iph-n) type: Interface Name
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 use DHCP for VoIP iphost interfaces.
Usage: iphost show
U --0 Vid ---85 P --0 MacAddr ---------00-01-03-01-01-10 CurrIpAddr ------------10.1.2.3 CurrMask ----------255.255.0.0 CurrGateway ---------------10.1.2.1
Server:172.26.31.3 Lease:120secs Remaining:94secs
iphost show Command Value

U Vid P MacAddr CurrIpAddr CurrMask CurrGateway The IP Host unit number. The VLAN ID where this IP Host is located. The PBIT value applied to packets sent from this host. The IEEE MAC Address of this IP Host. The static or dynamically obtained IP address of this IP Host. The subnet mask used by this host. The default gateway used to route packets not on this IP Host subnet.
Description
246
IP Host Options
This command displays which options are currently enabled for all IP Hosts. Usage: iphost options
Unit ----iph-0 Option -------DHCP PINGS TRACEROUTE RSH
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.
Overview
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 240): 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 232): bridge add [-lb=<enum>] [-mf=<enum>] [-fw=<enum>] [snoop=<enum>] [-sv=<enum>] [-macff=<enum>] vid=. Use this command to create a new VLAN bridge.
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.
247
MACFF is constrained by the following:

MAC Forced Forwarding Limits
Maximum # of bridges/vlans with MACFF enabled (per ONT) Maximum # of access routers per VLAN Maximum # of MACFF stations per ONT * This number to be increased with next AE release. 64 1* 256
MACFF
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.
248
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 as an Access Router (AR). If an AR is found, MACFF applies a proxy ARP to replay 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.
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. The minimum usable mask for static MACFF entries is /24.
249
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)
10 CSFP 20 CSFP 20 SFP 40 SFP 60 SFP 700GE AE ONT (60 km) 700GX AE ONT (50 km)
Transmit Min (dBm)

-9.0 -9.0 -7.0 -5.0 -2.0 -5.0 .50
Transmit Max (dBm)

-3.0 -3.0 -1.0 0.0 4.0 0.0 5.0
Receive Min (dBm)

-19.5 -22.5 -22.0 -22.0 -26.0 -22.0 -27.0
Receive Max (dBm)

-3.0 0.0 0.0 0.0 0.0 -3.0 -8.0
Note: The maximum reach can be increased slightly by deploying premium grade attenuation fiber.
700GE ONTs
When 700GE 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.
700GE ONT AE Attenuation Requirements Calix E-Series SFPs SFP Rated Reach
10 km CSFP 20 km CSFP 20 km SFP
Optical Fiber Link Length (km)
Attenuation Value to Prevent SFP Saturation
SFP Part Number

100-01791 100-01792 100-01669 0 to 10 km 0 to 20 km 0 to 10 km 10 to 20 km 0 dB 0 dB 5 dB 0 dB 5 dB 0 dB 0 dB 10 dB 5 dB 0 dB Not Recommended
40 km SFP
100-01671
0 to 20 km 20 to 30 km 30 to 40* km
60* km SFP
100-01673
0 to 10 km 10 to 30 km 30 up to 50 km 50 to 60** km
250
* - The optical fiber plant performance characteristics determine whether the combination of the 40 km SFP and 700 GE ONT works effectively up to 40 km. ** - The 60 km SFP and 700GE ONT combination only works reliably up to 50 km (actual reach depends on outside plant fiber and connector loss). This is due to the 700GE ONTs reduced output power which is optimized to allow the 10 and 20 km CSFPs to operate without attenuation.
700GX ONTs
When 700GX 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.
700GX ONT AE Attenuation Requirements Calix E-Series SFPs SFP Rated Reach
10 km CSFP 20 km CSFP
Optical Fiber Link Length (km)
Attenuation Value to Prevent SFP Saturation
SFP Part Number

100-01791 100-01792 0 to 10 km 0 to 10 km 10 to 20 km 10 dB 10 dB 5 dB 10 dB 5 dB 10 dB 5 dB 0 dB 15 dB 10 dB 10 dB 5 dB 5 dB 0 dB
20 km SFP
100-01669
0 to 10 km 10 to 20 km
40 km SFP
100-01671
0 to 20 km 20 to 30 km 30 to 40 km
60 km SFP
100-01673
0 to 10* km 10 to 20 km 20 to 30 km 30 to 40 km 40 to 50 km 50 to 60 km
* - Calix recommends using the 60 km rated SFP only for 700GX ONT links longer than 10 km. This eliminates the need for a 15 db attenuator and simplifies attenuator inventory.
251
MACFF Commands
Use the following commands to manage and provision Mac Forced Forwarding on an AE ONT Network:
MACFF Show
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 ** Access Routers Entries: ** MAC Address vid IP Address ref state ----------------- ---- --------------- --- ---------00-16-c8-bc-a4-cb 4002 172.26.61.2 3 resolved ** Subscriber Station Validation Entries: ** 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 ** Learning Bridge L2Table Entries: ** 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
252 ** Static MACFF configuration Entries: ** 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 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 CXNK000004E6>
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
253
MACFF Set Index
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 populate values as required.
254
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 bridge portadd vid=4002 dev=eth-0 #Now map all untagged as data traffic on data vlan for eth-0 lev2 add -treatinpri=0 -treatinvid=4002 dev=eth-0 #Time to turn on the ports set iftab admin eth-0 up set iftab admin eth-1 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
255
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 bridge add -lb=ena -mf=ena -sv=ena -macff=ena vid=4002 bridge portadd vid=4002 dev=eth-0 #Set-up MACFF on VLAN 4090 and add the VLAN to the 2nd Ethernet port bridge add -lb=ena -mf=ena -sv=ena -macff=ena vid=4090 bridge portadd vid=4090 dev=eth-0 bridge portadd vid=4090 dev=eth-1 #Now map all untagged as data traffic on data vlan for eth-0 lev2 add -treatinpri=0 -treatinvid=4002 dev=eth-0 #Time to turn on the ports set iftab admin eth-0 up set iftab admin eth-1 up #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
256
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
257
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 ** Access Routers Entries: ** 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 ** Subscriber Station Validation Entries: ** 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 ** Learning Bridge L2Table Entries: ** MAC Address vid IP Address L2Table ----------------- ---- --------------- ----------------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
258
Learning Bridge (l2l) The learning bridge table keeps track of the MAC addresses associated with a given bridge. Each learning bridge consists of 256 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 ---3 8 Port ----eth-0 wan-0 MAC Address ----------------00-01-02-03-05-03 00-01-02-03-04-08 Minutes ------5 5 source_hit ---------4 4 dest_hits --------4 3 hw_act_hit --------0 0
l2l Field Definitions Value

hash Port MAC Address Minutes source_hit dest_hit
Description
This index is used internally by the hash lookup mechanism. The WAN or the Ethernet/IP Host port device defining the interface the MAC address is known to be on. The IEEE MAC address of the device. The number of minutes remaining on the entry. The number of times a packet was received and the SRC MAC address in the packet matched the entry. 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.
259
DHCP Relay - Option-82 Commands

The AE ONT supports the ability to add DHCP remote agent-id Option-82 strings to upstream subscriber DHCP packets on a per WAN VLAN basis. On downstream DHCP packets, the string is 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. 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
The defined values and their associated strings must include (at a minimum): Ethernet, eth IP Host, iph
Rendered As
String (predefined values of no more than 3 char)
VLAN SN ONTPORT DESC CLAB
The VLAN number on the receive port associated with the Request message. The FSAN Serial number of the device The ONT interface number relative to zero where the packet was received. This operator specified description string associated with a physical port. The operator specified configuration label for the AE ONT
All valid VLAN numbers (0-4094) String (16 characters maximum) Integer String (31 characters maximum) String (31 characters maximum)
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:
# # 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-0 bridge portadd vid=4090 dev=eth=1 # # set up the option82 format string for the IPTV bridge #
260
opt82 set string vid=4090 format="%clab - %sn - %vlan - %iftype%ontport - %desc" # # set up a config label for this ONT # config label set label="Doe" # # enable option82 on IPTV bridge # The following option82 would be produced... # Doe - CXNK03010101 - 4090 - eth-0 - John Doe, Anytown USA opt82 enable remote vid=4090 -frame=1stag -desc="John Doe, Anytown USA"
The complete description of Option-82 configuration commands follows: Define Option-82 Format String The following configuration command is defined as follows:
opt82 set Usage
opt82 set string vid= format=<str> Define string/tokens for option-82 insertion
Parameters
vid= Index to the MACFF static configuration station validation table entry type: Unsigned format=<str> The DHCP Option-82 format string, current supported tokens which the ONT auto inserts are: %sn, %vlan, %ifname, %ontport, %desc, %clab type: Character string (80)
261
Enable Option-82 on a Bridge 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 type: Character string (31)
Parameters
vid= WAN side VLAN ID identifying bridge to enable DHCP Option-82 remote ID insertion on type: Unsigned
262
Layer-2 and Layer-3 Mapping and Filtering CLIs Level 1- L2 Mapping/Filtering Table Add Entry CLI 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 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 and automatic "inverse" operation for the downstream processing if the action requires it. The interface supports no tag, 1 tag, and 2 tag operations. Note: Currently only no tag and 1 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> -filtmacmask=<mac> Which MAC address to filter on, default = disable type: disable, da, sa Mask of MAC address bytes used to compare with filtermacmatch, the bits that are significant type: MAC address -filtmacmatch=<mac> -treattagremdrop= MAC address to match on type: MAC address method to remove tags or drop frames or do nothing, skip = 0, remove1tags = 1, remove2tags = 2, 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 type: Unsigned -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 -treatinpri= Method to handle inner priority, 0-7 = explicit setting, 8 = copy PBITs from inner tag, 9 = copy PBITS from inner tag, 15 = don't add inner tag, default = 15
263 lev1l2 mapping add entry

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=<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) type: Interface Name
Supported Configurations
When implementing Level1, Layer 2 tagging configurations, only certain configurations are supported. Refer to the information below for
264
Level 2 - L2 Mapping/Filtering Table Add Entry CLI
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. 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 a subscriber. 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:
lev2l2 mapping add entry 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
265 lev2l2 mapping add entry

-filtetype= Method to filter on ethertype, 0 = Do not filter on ethertype, ethertype to match on, default = 0 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) 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 VID, default = 0 type: Unsigned -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 tag, 9 = copy PBITS from inner tag, 15 = don't add 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 >0=
Parameters
dev=<ifname> Ethernet device name to add the table entry (eth-0--eth-n) type: Interface Name
266
Level 1 and Level 2 Table Set CLI
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) type: Interface Name
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) type: Interface Name
267
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 filtmacmatch=00:01:04: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 --0 ac ---0 fm ---2 filtermacmask -------------------ff-ff-ff-00-00-00 filtermacmatch -------------------00-01-04-00-00-00 trd ----0 top ----15 tov ---0 totp -----6 tip ----4 tiv ----100 titp -----6
Level 1 Downstream Tagging Entry Table: unit = 0 outputTpid = 8100 inputTpid = 8100
i --0 ac ---1 fm ---1 filtermacmask -------------------ff-ff-ff-00-00-00 filtermacmatch -------------------00-01-04-00-00-00 trd ----1 top ----0 tov ---0 totp -----0 tip ----0 tiv ---0 titp -----0
268
L2 Mapping/Filtering Table Show Value

outputTpid inputTpid i ac
Description
Default Tpid/ethertype for frame output operations Default Tpid/ethertype for input frame filtering operations on Tpid. The table index entry number An internally defined code for the operation filterSAAdd1VidExpPbitDefaultOutputTpid=0, Lev1RemoveVidOnVidMatchTreatmentInner=1, filterSADrop=2, filterDADrop=3
fm
filterMac Value FILTER_MAC_DA 1 FILTER_MAC_SA 2 INVERSE_SA_ADD1 3 // Filter on MAC DA // Filter on MAC SA // Inverse of 2
filtermacMask filtermacmatch
The significant bits of the MAC to match on 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 7 - TPID - OutputTPID, DE bit = 1
tip
The treatment inner 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
269 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 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 7 - TPID - OutputTPID, DE bit = 1
Level 2 - L2 Mapping/Filtering Table Show
10.5.3.4
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. 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=eth0 # 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 eth-0 # 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 eth-0 # 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
270
# 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 # 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 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
i -0 1 2 3 4 5 6
ac --1 2 3 4 5 0 9
fop ---15 15 15 15 15 15 15
fov ----4096 4096 4096 4096 4096 4096 4096
fot p ---0 0 0 0 0 0 0
fip ---5 8 8 8 15 15 8
fiv ----100 300 600 700 4096 4096 4096
fitp ---0 0 0 0 0 0 5
feth -----0 0 0 0 8863 0 0
tr --0 0 0 0 0 0 0
top ----15 15 8 4 15 15 8
tov ----0 0 500 800 0 0 900
totp -----6 6 6 6 6 6 6
tip ----4 8 8 8 5 5 8
tiv ----210 400 4096 4096 200 200 4096
titp ----6 6 6 6 6 6 6
Level 2 Downstream Tagging Entry Table: unit = 0 dnstream_filter_drops = 0 outputTpid = 8100 inputTpid = 8100
I ac --0 1 2 3 4 5 6 1 2 7 7 6 6 7 fop ---15 15 8 4 15 15 8 fov ---0 0 500 800 0 0 900 fot p ---5 5 5 5 5 5 6 fip ---4 8 8 8 5 5 8 fiv ----210 400 4096 4906 200 200 4096 fitp ---5 5 5 5 5 5 6 feth ----0 0 0 0 8863 0 0 tr -0 0 1 1 1 1 1 top ---15 15 15 15 15 15 15 tov ---0 0 0 0 0 0 0 totp -----6 6 6 6 6 6 6 tip ----5 8 15 15 15 15 15 tiv ----100 300 600 700 4096 4096 4096 titp ----6 6 6 6 6 6 6
271 Valid Level 2 - L2 Mapping/Filtering Table Entry Adds

upstream filter drops downstream filter drops outputTpid inputTpid i ac Number of upstream frames dropped due to "drop" treatment Number of downstream frames dropped due to "drop" treatment Default Tpid/ethertype for frame output operations Default Tpid/ethertype for input frame filtering operations on Tpid. The table index entry 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 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
272
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 7 - The value less than or equal to this is used as outer priority 8 - copy outer priority from the 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 - 0x81000 6 - Output TPID, DE bit=0 7 - TPID - OutputTPID, DE bit=1 tip The treatment inner 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 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 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 7 - TPID - OutputTPID, DE bit=1
273
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>
-adminstate=<enum>
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). type: disabled, enabled Administrative State: enabled, disabled (default enabled). type: disabled, enabled
Parameters: port=
T1 Port (1..8). type: Unsigned
274
pwe3 service create

This service command creates the PWE3 service. This command includes the following attributes: The default packet size chosen should be 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. 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 Note: The packet size must match at both ends of the pseudowire (source and destination). The UDP port parameter is utilized to associate a particular packet stream with a T1 port and is considered the local pseudowire label (PW label). If the other end of the pseudowire uses a different PW label, the remote UDP port can be optionally specified. Note: The UDP port 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.
Usage: pwe3 service create [-remoteudpport=][-localudpport=] [-satpacketsize=] [-jitterbuffer=]port= destip=<ipaddr> rtpheader=<enum> rtpmode=<enum> timingmode=<enum> Provision the PWE3 Service on the T1 Port (AE mode only). Options: -satpacketsize= SAToP Packet Size: 80..1450 bytes (default 204 bytes). type: Unsigned -jitterbuffer= Jitter Buffer Size: 1..512000 usec (default 1500 usec). type: Unsigned -remoteudpport= The UDP port value that designates the remote PW LABEL. (1024..65534) Defaults to the udpport value.
275 -localudpport= The uDP port value that designates the local PW LABEL. (1024..65535). type: Unsigned T1 Port (1..8). type: Unsigned The destination IP address for this PWE3 service. type: IP Address RTP Header Control: enable, disable. type: disable, enable RTP Timestamp Generation Mode: differential, absolute. type: absolute, differential PWE3 Timing Mode: adaptive, differential, loop. type: adaptive, differential, loop
Parameters: port= destip=<ipaddr>
rtpheader=<enum> rtpmode=<enum>
timingmode=<enum>
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
276
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 : 2 Bundle ID : 200 (Index : 3 Bundle ID : 300 (Index : 4 Bundle ID : 400 (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
277
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 200 300 400 1000 1000 1000 2832 2832 2832 932 911 808 1365 1155 1134 1450 1471 1326 704 683 642 1450 1471 1326
OK OK OK OK
278
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 200 300 400 2 3 4 SAToP SAToP SAToP
TX Packets -----------31195970 31195967 31195957 31195952
RX Packets -----------31195970 31195966 31195958 31195953
Alm/Cnt -------
Recovery --------------TRACKING 2 TRACKING 2 TRACKING 2 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 Alternate 2: pwe3 pm bundle clr Alternate 3: pwe3 pm bundle bundle 100 -clr SAToP
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
279
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. 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 transitions 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 causes it to take longer. 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 300 400 2 3 4 SAToP SAToP 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
280
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
281
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 are incrementing at the same rate. The PWE3 chip contains an extensive packet classifier that determines how received packets are to be 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 is 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 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 Alternate: pwe3 pm ethernet -clr
(934262126 bytes) (934282186 bytes) (0 unclassified/stray)
All Ethernet statistics can be cleared using the alternate command
282
Pseudowire Commands
Several commands are available for managing PWE3 services. TDM Mode 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.
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.
283 Usage: pwe3 bridge create [-mask=<ipaddr>] [-gateway=<ipaddr>] vid= pbit= staticip=<ipaddr> Provision the Bridge and static IP address for PWE3 (AE mode only). Options: -mask=<ipaddr>
-gateway=<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
Parameters: vid=
pbit=
staticip=<ipaddr>
The VLAN ID used for PWE3 traffic (1..4094). PWE3 traffic must be tagged and should use a unique VLAN. type: Unsigned The priority of the PWE3 traffic (0..7). PWE3 should use a high pbit value. type: Unsigned 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).
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.
284
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>
-linecoding=<enum> -linebuildout=<enum>
-loopbackmode=<enum>
-inbandloopback=<enum>
-adminstate=<enum>
Frame Format: unframed, esf, sf (default unframed). type: unframed, esf, sf Line Encoding: b8zs, ami (default b8zs). type: b8zs, ami Line Build Out: 0_133, 133_266, 266_399, 399_532, 532_655 (default 0_133). type: 0_133, 133_266, 266_399, 399_532, 532_655 Loopback Control: none, facility, equipment, payload (default none). type: none, facility, equipment, payload Inband Loopback Enable: disabled, enabled (default disabled). type: disabled, enabled Administrative State: enabled, disabled (default enabled).
Parameters: port=
T1 Port (1..8) type: Unsigned
285
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 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 utilizes 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. 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. 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 5604 PW-TDM-MIB
286
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.
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.
287
PWE3 Provisioning Example

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 can 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 continues to ARP until either the other end responds or the service is deleted. For the example directly below, the UDP demultiplexing mode is configured per item 1 above:
pwe3 tdmmode -mode t1 pwe3 bridge create 101 5 11.1.1.199 pwe3 t1port 1 pwe3 service create -localudpport 2001 1 11.1.1.200 disable absolute adaptive pwe3 t1port linebuildout 133_266 2 pwe3 service create -localudpport 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
pwe3 tdmmode - mode t1 pwe3 bridge create 101 5 11.1.1.199
Function
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. 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. The first T1 port is enabled. The port defaults to unframed, B8ZS, 0133 feet, no loopback, with inband loopback detection disabled. 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. 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 133-266 feet 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).
pwe3 t1port 1 pwe3 service create -localudpport 2001 1 11.1.1.200 disable absolute adaptive
pwe3 t1port linebuildout 133_266 2
pwe3 service create -localudpport 2002 2 11.1.1.200 disable absolute adaptive
288
In the following example, the TDM mode is set to E1 and the UDP demultiplexing mode is configured per item 3 above:
pwe3 pwe3 pwe3 pwe3 tdmmode -mode e1 bridge create 101 5 11.1.1.99 e1port 1 service create -remoteudpport 4000 -localudpport 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
pwe3 tdmmode - mode e1
Function
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. 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. The first E1 port is enabled. The port defaults to unframed, HDB3, no loopback, with inband loopback detection disabled. Service is created with a packet size of 216 bytes. Packets are received on UDP port 3000 and transmitted to UDP port 4000.
pwe3 bridge create 101 5 11.1.1.199
pwe3 e1port 1 pwe3 service create -remoteudpport 4000 localudpport 3000 -satpacketsize 216 1 12.1.1.10 disable absolute adaptive
289
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 pwe3 tdmmode -mode t1 ### Define the PWE3 IP address, VLAN, and p-bit value. This creates 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
290
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 pwe3 tdmmode -mode t1 ### Define the PWE3 IP address, VLAN, and p-bit value. This creates 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
291
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) 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
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= -m2u=<enum> Router query interval (in seconds) type: Unsigned (30 - 3600) Enable Multicast to Unicast conversion? Yes = 1, No = 0 type: enum
Parameters
name=<str> Provide a video profile name type: charstring (14)
292
Additional Supported Commands Action

videoprofile delete name=<str>
Result Delete an existing video profile

Action videoprofile show
Result Displays all video profiles created Multicast VLAN Registration (MVR) Provisioning 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
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
293
Additional MVR Commands Action

mvrprofile delete vlan=
Result Deletes an mvrprofile) 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
294
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
295
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 create vlan=800 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
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 # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # 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
296 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 # # Set up appropriate OUI filtering for set top boxes # 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. 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.
297
MVR Video Profile for Tagged CPE

[root@k2intsolsrv1 video]# cat MvrVideoVid700_5Channels.cfg [CALIX_AE_ONT:R1] # # Example MVR Video profile for tagged CPE # # MVR Video Script parameters: # $0 = Subscriber Unicast Video VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # 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 # # 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
298
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. 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. 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.
299
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 # # MVR Video Script parameters: # $0 = Subscriber Unicast Video VLAN assigned for this subscriber # $1 = Ethernet port eth-0, eth-1 .. eth-X depending on ONT type # 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 mvrprofile add vlan=$0 mvrvlan=600 # Create multicast allow range (Do not need if full range is allowed) mcrange create vlan=$0 # SD Content mcrange set vlan=$0 index=1 ipstart=224.0.1.0 ipend=227.255.255.255 # HD Content mcrange set vlan=$0 index=2 ipstart=230.0.0.1 ipend=235.255.255.255 # Add multicast allow range to specify multiple MVR VLANs # SD Content mvrprofile set vlan=$0 mvrvlan=500 index=1 ipstart=224.0.1.0 ipend=227.255.255.255 # HD Content mvrprofile set vlan=$0 mvrvlan=600 index=2 ipstart=230.0.0.1 ipend=235.255.255.255 # 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 VLANs bridge setup -snoop=enable vid=500 dev=$1 bridge setup -snoop=enable vid=600 dev=$1 # # Set up appropriate OUI filtering for set top boxes # include inc/video_oui.cfg $0 $1
300
Notes on Above Configuration 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. 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 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. 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. Ranges cannot overlap within a given MVR profile, in other words, a given range 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.
301
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 in the Command Reference section of this guide.
302
Troubleshooting Commands
To facilitate ONT troubleshooting, the CLI provides many commands to assist in determining ONT problems. The basic syntax for using the command line based instructions is available here (on page 146). The following commands are used most often when troubleshooting ONT configuration issues;
Basic Troubleshooting Commands
bridge show summary (on page 239) bridge show bridges (on page 240) bridge show drops (on page 240) ip host show (on page 245) config dia (on page 335)g ver (on page 336) config hist (on page 219) os log dump (on page 337) pmcat (on page 340) os dump force (on page 339) os dump clear (on page 339) os sys (on page 339)
This command is used to dump a summary of all bridges configured on an ONT.
This command is used to dump detailed information about all bridges (or a single bridge [-bid=x]) configured at the ONT.
This command displays all dropped packet counters associated with the Layer2 bridging function.
This command is used to display current information about IP Hosts. It displays all allocated iphost interfaces and any associated VIDs. 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 its contents for reference. The ver command is used to show current software and hardware version information. This command displays all previously performed config commands for the AE ONT. 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. 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. 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. When executed, the os sys command displays various system statistics
303
Basic VoIP Commands (CTG and SIP)
voipreg (on page 322) voipcc (on page 325) iphost show (on page 245) voiprtp (on page 323) voipconfig (on page 320) show voip mib (on page 315)
The voipreq command returns registration and IP address information for each port of the ONT. The voipcc command displays the current call state by port. This command is used to display current information about IP Hosts. It displays all allocated iphost interfaces and any associated VIDs. The voiprtp command returns registration and IP address information for each port of the ONT. The voipconfig command includes all SIP provisioning parameters for the voice service. 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.
Basic Data and Video Commands
show ethertable (on page 223) show iftable (on page 220) mpp rate (on page 331) show ifstats (on page 221) meter show info (on page 231) macff show (on page 251) lev1 show (on page 267) lev2 show (on page 269) mpp ess (on page 331) mpp pdump (on page 334)
The sh ethertable command is used to show basic Layer-2 information about an Ethernet port. The show iftable command displays various attributes associated with an ONT Ethernet interface group. The mpp rates command displays data and packet rates on each interface as observed over the last 5 seconds of operation. 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. This command summarizes information on each traffic shaper. It is used as a debugging or sanity check mechanism. The macff show command displays MACFF static entry settings by IP address This command is used to examine the Level 1 - L2 Mapping/Filtering Table for the purpose of debugging or interrogation. This command is used to examine the Level 2 - L2 Mapping/Filtering Table for the purpose of debugging or interrogation. The mpp ess command displays the ingress and egress Ethernet port statistics by MAC address. The mpp pdump command is used to dump transmitted/received/errored frames to the console.
304
Channel and Drop Testing (vtst test)

The vtst test command initializes a channel and drop test on a phone line:
Usage: vtst test [main=<default>] [BP] [all/cd/ch/drop/vbat/drop+/test<code>] [extra]
Testing Example Follows is a sample output for a "typical" channel and drop test run from the CLI. Definitions for the output are also included.
CXNK0002B70E> vtst test 0 cd start test 00003FFC on BP 0 in slot 0 057, (CXNK0002B703) [INFO], Sat Jan 01 20:30:04 2000, VoiceDrv, Voice port test: BP1, slot 0 [00003FFC] Start 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:Fail:None DIAG:VOICEPATH:PASS:LoopCur:slot0:BP1:Not run, no hardware DIAG:VOICEPATH:PASS:VACFEME:slot0:BP1:Pass:0.0VACr DIAG:VOICEPATH:PASS:VDCFEME:slot0:BP1:Pass:0.8VDCl DIAG:VOICEPATH:PASS:VDD:slot0:BP1:Pass:3.38VDCv DIAG:VOICEPATH:PASS:VBATR:slot0:BP1:Pass:101.0VDCr DIAG:VOICEPATH:PASS:VBATL:slot0:BP1:Pass:24.9VDCl DIAG:VOICEPATH:PASS:VBATH:slot0:BP1:Pass:51.2VDCh 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.0REN Want tests 00003FFC, ran 0001F7FE Test duration: 8.330sec 058, (CXNK0002B70E) [INFO], Sat Jan 01 20:30:12 2000, VoiceDrv, Voice port test: BP 1, slot 0 [00003FFC] Fail {3} <8.330sec>
305 DIAG;VOICEPATH:FAIL:Final:slot0:BP1:Fail
# --1: VRinging 2: RingTrip 3: DialTone 4: LoopCur 5: VACFEMF 6: VACFEMF 7: VTipRing 8: TGres 9: RGres 10: TRres 11: RENload 12: Offhook 13: Final step -----[3] [5] [4] [13] [6] [7] [2] [8] [9] [10] [12] [11] [0] res ---1 1 !3 1 0 0 0 0 0 0 0 2 !3 lvl ---0 0 0 0 0 0 0 0 0 0 0 0 0 Dial Tone 43.0VDC 150kohm 150kohm 150kohm 51.2VDCh Open Open Open 0.0REN 5.5REN 75.0VDC None 0.0 VACr 0.8 VACl 20.0VAC 60.0VDC min -----actual -------max -----
Channel and Drop Testing Options Value

all cd ch drop vbat drop+ test ren1
Description
Specifies to run all channel and drop tests. Example: vtst test 0 all Run channel and drop test. Example: vtst test 0 cd Run channel test only. Example: vtst test 1 ch Run drop test only. Example: vtst test 0 drop Runs battery voltage tests including ringing voltage, low voltage supply, and high voltage supply. Example: vtst test 0 vbat Run drop test with VBAT, TGres, RGres, TRres, RENload, and Offhook. Example: vtst test 0 drop+ Specify a specific test to run. See below for a list of available test codes. Example: vtst test 0 test 00002 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 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 Run minimum REN test. These are tests run by manufacturing only and provide no meaningful user data when run. Example: vtst test 1 minren Runs all tests and shows additional results for voltage tests. Example: vtst test 0 extra
ren5
minren
extra
306 Test Output Descriptions

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

# step res Test sequence number with name of test Internal value of test (from specific test option). 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 actual max Minimum value to compare for passing test. Actual value captured during the test. Maximum value to compare for passing test.
307
Specific Test Options The "test" command 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
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Test Code
[00001] [00002] [00004] [00008] [00010] [00020] [00040] [00080] [00100] [00200] [00400] [00800] [01000] [02000] [04000] [08000] [10000] Final
Test Name
Note: Used to Reset sequence only (not a valid test). VDD VTipRing VRinging DialTone RingTrip VACFEMF VDCFEMF TGres RGres TRres OffHook RENload LoopCur VBATR VBATH VBATL
308
VoIP Commands
CLI commands are available to facilitate the provisioning of SIP voice service and TDM Gateway voice services while setting up the necessary objects for the CMS interface. 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: 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 "-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.
309
voip setup Usage

voip setup [-pbit=] [-dhcp=<enum>] [-ping=<enum>] [-tracert=<enum>] [-rsh=<enum>] [-staticip=<ipaddr>] [mask=<ipaddr>] [-gwf=<enum>] [-gateway=<ipaddr>] vid= linemode=<enum> 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)
Options
-pbit= PBIT value to be applied to frames (0..7, default = 0), ignored if VLAN bridge is already created type: Unsigned -dhcp=<enum> -ping=<enum> -tracert=<enum> -rsh=<enum> -staticip=<ipaddr> DHCP enable/disable, default=enable type: enable/disable ICMP ping enable/disable, default = enable type: enable/disable ICMP tracert enable/disable, default = enable type: enable/disable Telnet/rsh enable/disable, default = disable type: enable/disable Static IP Host Address, must specify <-dhcp disable>, <-mask>, and <gateway> type: IP Address -mask=<ipaddr> IP Host Mask, must specify <-dhcp disable>, <-staticip>, and <-gateway>
type: IP Address -gwf=<enum> Gateway forwarding, enable/disable, Default (iph-1 through iph-n = enable), (iph-0 = disable) type: enable/disable -gateway=<ipaddr> IP Host Gateway Address, must be same subnet as <-staticip>, must specify <-dhcp disable>and <-mask> type: IP ADDress -linemode=<enum> POTS port line mode: Loop start or Ground Start type: LoopStart, GroundStart, default=LoopStart* Note: Both values case sensitive
310
Parameters
vid= WAN side VLAN ID for this VLAN (0-4094), 0 = untagged 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 type: Character String (32) file=<str> Name of file to retrieve to configure VoIP Server type: Character String (80) 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 type: Character String (20) uri=<str> VoIP URI type: Character String (32) * - If loopstart is the desired mode, this command can be omitted.
311
Add VoIP Service
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 linemode=<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* Note: Both values case sensitive
Parameters
board=<enum> board=<enum> type: i-pots, n-exp1, n-exp2 port=<n> POTS Port number type: Integer (0-7) iphost=<n> IP Host index type: Integer (0-7) display=<str> Display Name type: Character String (32) file=<str> Name of file to retrieve to configure VoIP Server type: Character String (80) 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 type: Character String (20) VoIP URI type: Character String (32) * - If Loopstart is the desired linemode, this command can be omitted.
uri=<str>
312
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: 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 "-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.
313
ctg setup Usage

ctg setup [-pbit=] [-dhcp=<enum>] [-ping=<enum>] [-tracert=<enum>] [-rsh=<enum>] [-staticip=<ipaddr>] [mask=<ipaddr>] [-gwf=<enum>] [-gateway=<ipaddr>] [-pktrate=<enum>] vid= linemode=<enum> 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)
Options
-pbit= PBIT value to be applied to frames (0..7, default = 0), ignored if VLAN bridge is already created type: Unsigned -dhcp=<enum> -ping=<enum> -tracert=<enum> -rsh=<enum> -staticip=<ipaddr> DHCP enable/disable, default=enable type: enable/disable ICMP ping enable/disable, default = enable type: enable/disable ICMP tracert enable/disable, default = enable type: enable/disable Telnet/rsh enable/disable, default = disable type: enable/disable Static IP Host Address, must specify <-dhcp disable>, <-mask>, and <gateway> type: IP Address -mask=<ipaddr> IP Host Mask, must specify <-dhcp disable>, <-staticip>, and <-gateway> type: IP Address -gwf=<enum> Gateway forwarding, enable/disable, Default (iph-1 through iph-n = enable), (iph-0 = disable) type: enable/disable -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 case sensitive
314
Parameters
vid= WAN side VLAN ID for this VLAN (0-4094), 0 = untagged type: Unsigned board=<enum> Board (SLC) ID type: i-pots, n-exp1, n-exp2 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 type: Character string (32) * - If loopstart is the desired linemode, this command can be omitted.
315
Add TDM Voice Service
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 [-pktrate=<enum>] linemode=<enum> board=<enum> port=<n> iphost=<n> ctgsvr=<ipaddr> 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* Note: Both values case sensitive
Parameters
board=<enum> board=<enum> type: i-pots, n-exp1, n-exp2 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 type: Character String (32) * - If Loopstart is the desired linemode, this command can be omitted.
316
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 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
317 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: 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
318
Show voip mib Field Definitions

show voip mib Field Definitions Field Name
Voip data for board cfg file pri cfg file sec cfg srvr pri cfg srvr sec Reg name URI display name DHCP Profile static addr MAC address in-use addr DNS primary and secondary hook state dhcp attpts
Description
Displays the binding post and port for the VoIP service Example: board: 0, port: 1 Primary configuration file name Example: VoipConfig.txt Secondary configuration file name Example: VoipConfig_bu.txt Location of the primary and secondary tftp server. Example: cfg srvr pri:172.26.203.16 cfg srvr sec: 172.26.203.16 VoIP service name and optional password for changing. Example: 7655551012, password:password Uniform Resource Identifier. Example: 7655551012 Name that appears on a caller ID string. Example: Name_Line1 Name of DHCP Profile being used for this line. Example: dhcp_sip2 Static, mask, and gateway IP address. Example: 0.0.0.0, mask: 0.0.0.0, gateway:0.0.0.0 MAC address for the DHCP Profile Example: 00-06-31-14-38-a0 ??? Example: 172.26.203.136, mask: 255.255.255.0, gateway: 172.26.203.16 Domain Name primary and secondary IP addresses. Example: DNS primary: 0.0.0.0, DNS secondary: 0.0.0.0 Current hook state and call status. Example: hook state: on hook, call status: idle Total cumulative usage of the SIP line. This counter increments every 100 seconds a call is active. Example: dhcp attps: 59383 Total cumulative Acknowledgement Packets. Example: dhcp acks: 4865 Total cumulative Negative Acknowledgement Packets. Example: dhcp nacks: 0 Total registration attempts on the line. Example: reg attpts: 25889 Total registration challenges on the line. Example: reg challenges: 0 Total registration rejections on the line. Example: reg rejects: 0 Total SIP REGISTER message requested granted (OK). Example: reg grants: 1788
dhcp acks dhcp nacks reg attpts reg challenges reg rejects reg grants
319 show voip mib Field Definitions

incall attpts incall complts incall busy incall peerdisc incall ontdisc outcall attpts outcall complts outcall busy outcall peerdisc outcall ontdisc 911 attpts 911 complts 911 busy 911 peerdisc 911 onhooks vmwi notify(msgs) mnwi notify (nomsgs) rtp pts sent rtp pkts recv null IPs sent Total incoming calls received. Example: incall attpts: 25122 Total incoming calls completed successfully. Example: incall complts: 24915 Total incoming calls received when line was busy. Example: incall busy: 45 Incoming calls disconnected by far end peer (calling party). Example: incall peerdisc: 9 Incoming calls disconnected by local ONT hangup (on hook). Example: incall ontdisc: 14 Total outgoing calls attempted. Example: outcall attpts: 94 Total outgoing calls completed successfully. Example: outcall complts: 125 Total outgoing calls that received a busy reply. Example: outcall busy: 3 Total outgoing calls that were disconnected by far end peer (calling party). Example: outcall peerdisc: 7 Total outgoing calls disconnected by local ONT hangup (on hook). Example: outcall ontdisc: 4 Emergency 911 Call Attempts on the line. Example: 911 attpts: 4 Emergency 911 Call Attempts completed successfully. Example: 911 complts: 4 Emergency 911 Call Attempts that received a busy reply. Example: 911 busy: 0 Emergency 911 calls disconnected by far end E911 operator. Example: 911 peerdisc: 0 Emergency 911 Call attempts with local On hook condition. Example: 911 onhooks: 5 SIP NOTIFY messages received with Messages-Waiting set to Yes. Example: vmwi notify(msgs): 2 SIP NOTIFY message received with Messages-Waiting set to No. Example: vmwi notify(nomsgs): 0 Total RTP Packets sent Example: rtp pts sent: 25411 Total RTP Packets received Example: rtp pts recv: 25411 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
320
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
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][09]{9}|^011[0-9]*T
Line
321
voipconfig Field Definitions

voipconfig Field Definitions Field Name
SIP ONT URI SIP ONT IP SIP Contact IP SIP Proxy Server SIP Domain name DNS Primary DNS Alternate TFTP Primary TFTP Secondary TFTP Filename SIP Proxy Port SIP Registration SIP Register SIP Registration Period SIP T1 Timer SIP T2 Timer Reorder Tone Delay Warning Tone Delay Warning Tone Timeout RTP Base Port RTP TOS/DSCP RTP Codec RTP Packet Rate
Description
SIP Uniform Resource Identifier (typically telephone number) IP Address of the ONT Secondary IP Address of the ONT (if used) UDP or IP address of the Border Controller or the SIP Proxy Server. IP address or a Fully Qualified Domain Name (FQDN). Primary DNS IP Address for the ONT port being provisioned. Secondary DNS IP Address for the ONT port being provisioned. IP Address of Primary TFTP Server IP Address of Secondary TFTP Server Filename of SIP Configuration file UDP Port number for SIP Proxy server Enter 0 to disable SIP Registration. Enter 0 to disable SIP Register. Enter the maximum registration period for the SIP connection. SIP Timer Time-out Values in milliseconds. SIP Timer Time-out Values in milliseconds. Enter the delay in seconds before playing a fast busy tone after far end hangup or far end off hook. Enter the delay in seconds before playing a warning tone (howler) for off hook. Enter the amount of time to play the "howler". 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. Enter the TOS bits for RTP packet stamping (0-255) Enter the voice encoding option. Always set to zero. Input the expected RTP packetization rate sent by the ONT. choose between 10, 20, or 30 msecs.
322
Options
SIP E.164 FlashINFO E911CalledPartyHold Call Waiting Caller ID DTMF playout Pulse Dial GroundStart CSIP ThreewayCall ContactHeaderPort Dial digit Timeout Dial Plan IntraLATA Area codes Dial Plan Format to add the country code to all SIP messages. enter 0 to use local format, enter 1 to use E.164 global format. For Flash Hook messages, send a SIP INFO message. Options to allow E911 hang-up. Enter the softswitch signaling pattern for call waiting. Needed to disable Caller ID at the ONT. Enable or disable the playing of the DTMF SIP INFO message. Enable or disable pulse dialing. Enable GroundStart POTS. Enable or Disable TDM Gateway Allows for configuring 3-way calling. Enable or Disable ContactHeaderPort Enter a value (seconds) for a partial match "pause" until all digits have been collected (slow dialers). Enter area code toll free exceptions. Enter the type of dial plan to enable. For additional information, reference the VOIP Configuration File (on page 199) example.
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 ONT URI : SIP ONT IP : SIP Contact IP : SIP Shadow IP : SIP Proxy Server: SIP Domain Name : DNS Primary : DNS Alternate : SIP Registration: in 10 seconds Line 2: SIP ONT URI SIP ONT IP SIP Contact IP 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
: 7635551014 : 172.26.203.136 : 172.26.203.136
323 SIP Shadow IP : SIP Proxy Server: SIP Domain Name : DNS Primary : DNS Alternate : SIP Registration: in 10 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 voipreg Field Definitions Field Name
SIP ONT URI SIP ONT IP SIP PRoxy Server SIP Domain Name DNS Primary DNS Alternate SIP Registration incall attpts incall complts incall busy incall peerdisc incall ontdisc outcall attpts outcall complts outcall busy outcall peerdisc outcall ontdisc
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
Description
The assigned registration ID number for the port. The IP Address for the port. The IP Address for the SIP proxy server. The IP Address for the Sip switch. The primary DNS IP address. The secondary DNS IP address (optional). Displays the Registration state of the port and the length of time until the next lease renewal. Total incoming calls received. Total incoming calls completed successfully. Total incoming calls received when the line was busy. Incoming calls disconnected by far end peer (calling party). Incoming calls disconnected by local ONT hangup (on hook). Total outgoing calls attempted. total outgoing calls completed successfully. Total outgoing calls that received a busy reply. Total outgoing calls that were disconnected by far end peer (calling party). Total outgoing calls disconnected by local ONT hangup (on hook).
324
Voiprtp The voiprtp 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 ONT URI : SIP ONT IP : SIP Contact IP : SIP Shadow IP : SIP Proxy Server: SIP Domain Name : DNS Primary : DNS Alternate : SIP Registration: in 10 seconds Line 2: SIP ONT URI : SIP ONT IP : SIP Contact IP : SIP Shadow IP : SIP Proxy Server: SIP Domain Name : DNS Primary : DNS Alternate : SIP Registration: in 10 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 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
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
325
voipreg Field Definitions Field Name

SIP ONT URI SIP ONT IP SIP PRoxy Server SIP Domain Name DNS Primary DNS Alternate SIP Registration incall attpts incall complts incall busy incall peerdisc incall ontdisc outcall attpts outcall complts outcall busy outcall peerdisc outcall ontdisc
Description
The assigned registration ID number for the port. The IP Address for the port. The IP Address for the SIP proxy server. The IP Address for the Sip switch. The primary DNS IP address. The secondary DNS IP address (optional). Displays the Registration state of the port and the length of time until the next lease renewal. Total incoming calls received. Total incoming calls completed successfully. Total incoming calls received when the line was busy. Incoming calls disconnected by far end peer (calling party). Incoming calls disconnected by local ONT hangup (on hook). Total outgoing calls attempted. total outgoing calls completed successfully. Total outgoing calls that received a busy reply. Total outgoing calls that were disconnected by far end peer (calling party). Total outgoing calls disconnected by local ONT hangup (on hook).
326
Voipcc The voipcc command displays the current call state by port.
CXNK0002B2E3> voipcc Line 1: CCState (1) remoteIP remoteIP2 waitingIP : : : : IDLE : : : Msg Waiting: NO 0 0 0 localport: 16384
crv=0 crvWaiting=0 crvHold=0 Threeway=0 Line2: CCState(1) remoteIP remoteIP2 waitingIP : : : : IDLE : : : MsgWaiting: NO 0 0 0 localport: 16386
crv=0 crvWaiting=0 crvHold=0 Threeway=0
voipcc Field Definitions Field Name

CCState Msg Waiting remote IP remote IP2 waiting IP crv crvWaiting crvHold Threeway
Description
Current Call State of the port (IDLE, ???, xxx) Message waiting indicator (yes or no). IP address of the inbound calling party. IP address of any secondary inbound calling party. IP address of any inbound call in the call waiting queue. The Call Reference Value (CRV) of the current call. The CRV of any inbound call in the waiting queue. The CRV of a current called placed on hold. Status of current three way call. possible states????
327
Delete voip/ctg Service The voip del command is used to delete the voice service on a binding post (SIP or TDM).
delete voip or ctg Usage
voip del board=<enum> port=<n> Delete VoIP or TDM port
Parameters
board=<enum> port=<n> Board (SLC) ID type: i-pots, n-exp1, n-exp2 POTS port number type: integer (0,7)
328
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 firmware 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 of 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.
329
DHCP Option-43 Command Elements The following elements must be included in the DHCP global command structure:
option option option 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.validateMIC code 3 = boolean; CALIX-ONT-SERVER.firmware1 code 101 = text; CALIX-ONT-SERVER.firmware2 code 102 = text; CALIX-ONT-SERVER.firmware3 code 103 = text; CALIX-ONT-SERVER.firmware4 code 104 = text; CALIX-ONT-SERVER.firmware5 code 105 = text; CALIX-ONT-SERVER.force-firmware code 200 = boolean;
The following elements must be included in the DHCP subnet declaration structure:
# This line is required vendor-option-space CALIX-ONT-SERVER; # Primary TFTP Server Address option CALIX-ONT-SERVER.cms-address 172.26.31.149; # Secondary TFTP Server Address option CALIX-ONT-SERVER.second-tftp-address 172.26.35.3; # list of firmware image names option CALIX-ONT-SERVER.firmware1 "calix_ae_700ge_r2.0.0.20.rto"; option CALIX-ONT-SERVER.firmware2 "calix_ae_700sfu_r2.0.0.20.rto"; option CALIX-ONT-SERVER.firmware3 "calix_ae_700mdu_r2.0.0.20.rto"; Global Option-43 Field Definitions Option Name
option CALIX-ONT-SERVER.cmsaddress option CALIX-ONTSERVER.second-tftpaddress
Definition
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. 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-ONT-SERVER.validateMIC
Placeholder for future "Message Integrity Code" feature. Not currently supported in CMS 11.1 This flag is used to force load C7 or manufacturing ONT images onto the ONT.
option CALIX-ONT-SERVER.forcefirmware
330
Notes on Option-43 Processing Effective with AE ver 2.0, the Option-43 structure allows for both Primary and Secondary TFTP servers to be specified.
Note: In AE ver 1.1 and below, the following sequence is used in determining the correct server name location: 1. Looks for the server name in the sname field. 2. Looks for the server name in the Option-66 string. 3. Looks for the siaddr field. 4. Looks for the ONTs DHCP server address. 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"; max-lease-time 2592000; # 30 days default-lease-time 2592000; # 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.firmware1 code 101 = text; option CALIX-ONT-SERVER.firmware2 code 102 = text; option CALIX-ONT-SERVER.firmware3 code 103 = 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.firmware1 "calix_ae_700ge_r2.0.0.5.rto"; option CALIX-ONT-SERVER.firmware2 "calix_ae_700sfu_r2.0.0.6.rto"; option CALIX-ONT-SERVER.firmware3 "calix_ae_700mdu_r2.0.0.6.rto"; max-lease-time 3600; default-lease-time 3600; range 192.168.254.10 192.168.254.252; }
331
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
IFDesc upUcastPps dnUcastPps upMcastPps dnMcastPps upMbps dnMbps The interface type description Upstream Unicast packets per second Downstream Unicast packets per second Upstream multicast packets per second Downstream multicast packets per second Overall upstream Mbps Overall downstream Mbps
Description
332
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
NUM_GOOD_FRAMES NUM_BC_FRAMES NUM_MC_FRAMES NUM_UNDERRUN NUM_CONTROL_FRAMES BYTES_GOOD_FRAMES BYTES_BC_FRAMES BYTES_MC_FRAMES BYTES_VLAN_FRAMES NUM_VLAN_FRAMES NUM_TX_DEFERRALS NUM_EXCESSIVE_DEFERRALS NUM_LATE_COLLISIONS NUM_EXCESSIVE_COLLISIONS NUM_PAUSE_FRAMES NUM_TX_ATTEMPTS NUM_TOTAL_FRAMES
Description
Number of frames received error free. Number of broadcast packet frames processed. Number of multicast packet frames processed. Number of data underruns during transmit. Number of frames processed which include a control frame identifier. Number of bytes processed in error free frames. Number of bytes processed for broadcast frames. Number of bytes processed for multicast frames. Number of bytes for frames which include a VLAN identifier (tag). Number of frames processed which include a VLAN identifier (tag). Number of transmitted frames that were deferred. Number of frames that were deferred past the maxDeferTime constant. Number of frames that had collisions during transmit. Number of frames that had at least 16 attempts to transmit. Number of pause frames detected. Number of attempts to transmit the previous frame. Total number of frames processed.
333 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
NUM_GOOD_FRAMES NUM_BAD_FRAMES NUM_FCS NUM_BC_FRAMES NUM_MC_FRAMES BYTES_GOOD_FRAMES BYTES_BC_FRAMES BYTES_MC_FRAMES BYTES_VLAN_FRAMES NUM_CTRL_FRAMES NUM_OUT_OF_BOUNDS
Description
Number of frames received error free. Number of frames received with errors. Number of inserted Frame Check Sequence bits. Number of broadcast packet frames processed. Number of multicast packet frames processed. Number of bytes processed in error free frames. Number of bytes processed for broadcast frames. Number of bytes processed for multicast frames. Number of bytes for frames which include a VLAN identifier (tag). Number of frames processed which include a control frame identifier. Number of frames processed which exceeded the maximum legal length. Note: Only applies if jumbo frames are disabled. Number of frames processed which include a VLAN identifier (tag). Number of frames received with an incorrect FCS value. Number of Ethernet flow control type packets as identified by the Length/Type (LT) field. Number of frames processed that contains an unsupported OPCODE. Note: only applies to non-Pause type frames Number of frames processed where the Length exceeds max_mtu or is less than 64 bytes. Total number of frames processed. Number of total resource errors detected.
NUM_VLAN_FRAMES NUM_ALIGNMENT_ERROR NUM_FLOW_CTRL NUM_BAD_OPCODE
NUM_LT_OUT_OF_RANGE NUM_TOTAL_FRAMES NUM_RESOURCES_ERRORS
334
mpp pdump The mpp pdump command is used to dump transmitted/received/errored frames to the console. On the GE ONT, only control frames such as ARP, IGMP, etc are printed to the console and therefore can be analyzed quickly. However, on the GX ONTs there is no filter and as such, all frames received/transmitted on the specified interface are printed to the console. Thus, extra care must be taken when using this command on the GX ONT if you dont wish to inadvertently reset the ONT. CXNK0006CDA0> mpp pdump ?
errors receive transmit Errored packet dump enable control Receive packet dump enable control Transmit packet dump enable control
CXNK0004FC4F> mpp pdump receive device=eth-0 ena=ena CXNK0004FC4F> NPACKET Head = 1cba000 NPACKET Data = 1cba040 NPACKET Tail = 1cba080 NPACKET End = 1cba7e4 NPACKET Length = 64 01 00 5e 11 ba 4d 00 08 d4 8a 0a 3b 08 00 46 00 00 20 00 01 00 00 01 02 ae 9e 0a d1 c8 08 e9 11 ba 4d 94 04 00 00 16 00 46 a0 e9 11 ba 4d 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 08 11
335
Miscellaneous Serviceability 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. Show ipconfig
The show ipconfig command displays critical IP information pertaining to an ONT. CXNK03010101> show ipc
I/F ----loop-0 iph-0 iph-1 iph-2 iph-3 Address ----------127.0.0.1 192.168.102.2 192.168.102.3 192.168.102.4 192.168.102.5 NetMask ----------255.0.0.0 255.255.255.0 255.255.255.0 255.255.255.0 255.255.255.0 MHomeIndex ----------------0 0 0 0 0 xIndex --------0 0 0 0 0
The show route command displays IP routing of each ONT interface.

CXNK03010101>show route
IpDest ----127.0.0.0 192.168.102.0 192.168.102.0 192.168.102.0 192.168.102.0
IpMask ----------255.0.0.0 255.255.255.0 255.255.255.0 255.255.255.0 255.255.255.0
IpNextHop ----------127.0.0.1 192.168.102.2 192.168.102.3 192.168.102.4 192.168.102.5
I/F -----loop-0 iph-0 iph-0 iph-0 iph-0
Type -------local local local local local
Proto -------local local local local local
336
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 its contents for reference. The following commands are executed as part of the config diag command: ver config history show iftab show ifstats mpp rates show ethert bridge show bridge bridge show drops mpp queues bridge glob meter show info meter show count iphost show mpp ess mpp show show voip mib voipreg voiprtp voipcc levxl2tag show eth-x (where levx is lev1 or lev2 and eth-x corresponds to all Ethernet ports on the ONT)
337
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)
338
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 eth-0 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"
processing file business_gold_eth-0_700.cfg line 4: "meter set downstream 0 400000000 400000000"
339 processing file business_gold_eth-0_700.cfg line 5: "meter attach downstream -dev eth-0 0"
processing file business_gold_eth-0_700.cfg line 6: "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 172.26.31.3 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
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.
340
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 Error Code Panic Time Up Time Current Time : : : : 4096 bytes Unknown POWER UP *** No Panic Yet ***
: 0x0 : : 0 years, 0 days, 15:29:14.40 (tot tics: 5575440) : Thu Nov 4 20:30:58 2010
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>
341
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 * ********************************************************************* *********** ************************** *******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.
342

AE ONT Config Guide R20

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

AE ONT Config Guide R20

Uploaded by

Copyright:

Available Formats

Active Ethernet ONT Configuration Guide, R2.

Chapter 2: AE Configuration ................................................ 35

Chapter 3: Configuring an AE System ................................ 49

Chapter 4: Understanding AE ONT Configuration Files .... 69

Chapter 5: Turning Up an AE ONT via CMS ........................ 89

Chapter 6: Provisioning Services on an AE ONT via CMS101

Chapter 7: Managing AE ONTs through CMS ................... 107

Chapter 8: Turning Up an AE ONT via CLI ........................ 119

Chapter 9: AE Deployment Options ................................... 135

Chapter 10: Command Line Interface (CLI) ....................... 145

Chapter 11: Remote ONT Activation .................................. 151

Chapter 12: System Maintenance and Troubleshooting . 161

Appendix A ........................................................................... 211

About this Guide

Chapter 1 Active Ethernet Overview

Ethernet Data Services

New features in AE Release 2.0 include (described in detail below):

0-2 MB 2-100 MB 100 MB - 1 GB

0-8 MB 8-255 MB 256-511 MB 512 MB - 1 GB

T1 Services via PWE3

The listed SFU ONTs offer the following AE features:

ONT Optics Characteristics

Network Component Overview

Unmanaged Pass-through ONT

Unmanaged Single VLAN Mapping

Managed ONT Basic Service - VLAN per Port

An example of this model is illustrated below.

ONT Basic Multi-service - VLAN per Service

Chapter 3 Configuring an AE System

Notes on Configuring the DHCP Server

DHCP Message Field Definitions Field

3. In the Devices tab, Create a new Ethernet device:

:wq [root@cmshost1 etc]#

to open the script file.

:wq [root@cmshost1 etc]#

Notes on Configuring the NTP Server

to open the file.

Example [root@cmshost1 etc]# vi net.conf

# Permit all access over the loopback interface.

"ntp.conf" 34L, 1259C

2. Start up the NTP service. At the command prompt, type:

Notes on Configuring the Syslog Server

Notes on Configuring the SIP Server

Notes on Configuring FTP

File Permission Basics

About the umask Command

Chapter 4 Understanding AE ONT Configuration Files

About Configuration Files

AE ONT Turn-up Pre-Requisites

Configuration File Structure

inc\video_oui.cfg inc\data_setup.cfg inc\VoipConfig.txt inc\video\*.cfg inc\voice\*.cfg

Configuration File Locations

Synchronizing AE ONT Configuration Files

Configuration File Characteristics

Configuration File Hierarchy

Sample Configuration File

internet_gold.cfg This configuration file establishes upstream and downstream bandwidth.

Configuration File Processing

Creating a Configuration File

Building Monolithic Configuration Files

About VoIP and the VoIP Configuration File

Creating the VoIP Configuration File

ONT SIP Configuration File Parameters

inc\video_oui.cfg inc\data_setup.cfg inc\VoipConfig.txt inc\video\.cfg inc\voice\.cfg

# 0 0 1 ***2