Previous Topic

Next Topic

Book Contents

Example: HGW Service - External Mode

This topic shows an example process for provisioning Home Gateway Services on an E7 GPON ONT in external mode, where an RG configuration file is downloaded to the ONT to fully manage the RG function. In this mode, the CMS/E7 do not provision the RG WAN interface.

For most Calix Home Gateway deployments that involve data-only services, or access modes that require a single VLAN service, the default RG profile that is created when the HGW becomes operational is sufficient. However, when any customization is required that is not supported by the default profile (associated with RG Management Mode: Native), it is necessary to use an RG Configuration File.

  1. Create an RG configuration file to deploy a common provisioning and service model across all Calix Home Gateways. See Creating an RG Configuration File.
  2. Download an existing configuration file onto the E7.
    • All ONTs in configuration file management mode will automatically receive this file.
    • Or, manually load the file on a particular ONT.

    The file download mechanism is via OMCI file transfer. See Managing RG Configuration Files.

See Overview: HGW Applications - External Mode for the sequence of linked procedures for configuring the E7 and GPON ONTs home gateway services in external mode.

Configuration considerations

  • From a CMS/E7 perspective, none of the “Native RG Management” options are available for ONTs in this mode.
  • The RG portion of the ONT is completely managed by the configuration file, including the WAN interfaces and everything related. In particular, the configuration file configures the RG with one or more VLANs on the GPON WAN.
  • The CMS/E7 is still used for creating ONT Ethernet services, such as creating and applying service-tag actions, bandwidth profiles, and multicast profiles when adding the service to the RG. The service-match list and service-tag must match the RG WAN interface VLAN, as specified in the configuration file.
  • All services on the ONT RG interface must be deleted before you can put the ONT in External mode.
  • The ONT must be reset to factory default values before downloading new configuration files. This can be accomplished by either pressing and holding the reset button for 20 seconds or using the EWI. T-Series ONTs will reset to factory default settings during the "retrieve ONT configuration file" step if a prior non-default configuration file is present in the ONT. Perform the "apply ONT configuration file" step as soon as possible after the retrieve step to minimize service disruptions.
  • An RG configuration file of a particular instance will be downloaded to ONTs with the following conditions:
    • matching vendor, model and product code
    • configured in external mode
    • reference the particular RG configuration file instance
  • An RG configuration file defines 1-4 RG WAN interfaces, each with a unique VLAN.
  • When an RG configuration file is applied to an ONT, the ONT resets.
  • The configuration file management mode is supported on GPON only, not AE.
  • Both N:1 and 1:1 VLANs models are supported. Since the same configuration file will be downloaded to each ONT, the OMCI is responsible for changing the VLAN on each individual ONT.
  • In external configuration file management mode, multiple Ethernet services can be created on the RG interface, each on a different VLAN.
  • At most, one service is allowed to have an multicast-profile.
  • MVR video is supported.

Example deployment of services using the E7 configuration file:

  • RG management mode:


  • RG services:

    GE-1 for High-Speed Internet (HSI) data service (Data1)

    GE-2, GE-3, GE-4 for video service (MVR)


    See Example Voice Services Provisioning from Port View.

  • For RG specific services (not HB or FB), only “Change Tag” and “Add and Change Tag” are supported.

Best Practice: To change parameters of an existing service, first remove the service and then re-add the service with new parameters, especially if using 3rd party provisioning equipment.

Step 1: Configure network uplinks

  • Data VLANs 10, 2, DHCP-snoop = enabled
  • Video (unicast) VLAN 104,
    DHCP-snoop = enabled
    IGMP-mode = flood
  • MVR (multicast) VLAN 101,
    DHCP-snoop = enabled
    IGMP-mode = snoop-suppress or proxy Note: (E7-20 only supports proxy IGMP mode, which requires a Proxy IP Address indicated in the referenced IGMP Profile)
  • VLANs > Create

    See Create the Service VLANs.


  • Make Interfaces VLAN Members

    Add uplink interface (LAG) to the service VLANs.

IGMP Profile



Step 2: Create system profiles

Create Rules to Classify (Data) Traffic:

a) Create a Match List

For P-series ONTs, the default RG configuration file used by the ONT specifies VLAN ID 10 for the HSI services. Therefore, for HSI services, we also match on VLAN ID 10.

E7 > Profiles > Service > Tagging > Match Lists > Profiles > Create



b) Create a Service Tag Action

We match on VLAN ID 10 and perform a change-tag action to VLAN ID 2.


E7 > Profiles > Service > Tagging > Tag Actions > Profiles > Create





Create Rules to Classify (Video) Traffic:

a) Create a Match List

The match list and tag actions are defined for a downstream RG that is sending single-tagged traffic with a VLAN ID of 104.

E7 > Profiles > Service > Tagging > Match Lists > Profiles > Create


b) Create a Service Tag Action


We match on 104, and perform a change-tag action to 104 as it is sent upstream from the ONT. The service provider could provision 104 in the default configuration file, and as long as the match list included a tagged match rule for 104, they could change the VLAN ID to whatever they desire.

E7 > Profiles > Service > Tagging > Tag Actions > Profiles > Create





Configure the Ethernet Bandwidth Profile.

Create Ethernet bandwidth profiles to specify the upstream and downstream bandwidth rates to apply to the HSI and video services.

For this example:



Committed US














E7 > Profiles > Service > Ethernet Bandwidth > Profiles > Create



Create an MVR Profile and MVR VLAN Addresses.

For this example, the created MVR profile designates the Multicast VLAN (101) as an MVR VLAN and no IP range is specified, allowing all IGMP and Multicast traffic.

E7 > Profiles > Service > Multicast > MVR > Profiles > Create




Configure the Ethernet Multicast Profile.

An Ethernet multicast profile enables provisioning of the IPTV service limits that can be applied to subscriber services.

Select the MVR profile to be used by this profile.

Enter a Query Interval value that matches the query interval of the upstream router that is acting as the IGMP querier.

The Convert to Unicast parameter should ONLY be enabled if switches are deployed on the subscriber side that cannot manage heavy multicast traffic. (Only Calix GX ONTs support this feature.)

E7 > Profiles > Service > Multicast > Profiles > Create



Create an ONT Template.

Using CMS R12.1, you can provision an ONT template that defines all of the key management aspects of the ONT as well as the logical assignments of physical GE ports.

  • Management mode: external
  • WAN protocol: DHCP
  • DSCP/IP Precedence: access
  • Security profile: system-default
  • RG: GE 1
  • FB: GE 2, GE 3, GE 4


  • CMS > Profile > E7/ONT > Templates > ONT > Create
  • See Creating an ONT Template.



Step 3: Configure a PON

Enable the GPON Port.

Split Horizon should ONLY be disabled when setting up TLAN service between multiple GPON ports on the same E7 card.

  • In the Navigation tree, click the triangle-arrow
    (triangle) to the left of the GPON line card, and then click the specific GPON port from the tree.
  • See Configuring an E7 GPON Port.


    Ensure the WAN fiber is attached to the ONT.

    Ensure the ONT is discovered.


Create an ONT.

Typically, the provisioning of an ONT is done in advance of installation and discovery of the physical ONT. ONTs are created as follows:

Manually where the ONT is pre-provisioned by entering the ONT serial number into the Create ONT dialogue box.

Automatically where the ONT is discovered on the network after successfully completing the Remote ONT Activation Process.

Selecting System Assigned ID allows the automatic assignment for the ONT ID.


Apply the ONT Template.

Apply an ONT template that was previously created through CMS R12.1 or later.

  • ONTs > Provisioned ONTs > Provisioning > Action > Apply Template to ONT.
  • In the Apply Template dialog, select the template to apply from the Template list.

    See Applying an ONT Template.


Retrieve and Apply the RG Configuration File.

  • 1) Retrieve the RG configuration file from an external server that is local to the E7.
  • 2) Apply the configuration file to the ONT, causing the ONT to reset and use the new file.

    Note: The configuration-file instance specified when retrieving the RG configuration file must match the instance indicated in the ONT template.

    Instances 17 through 24 are used exclusively for RG configuration files and can be specified either by instance number alone or by "rg-<1 through 8>"

    • rg-1
    • rg-2
    • rg-3
    • rg-4
    • rg-5
    • rg-6
    • rg-7
    • rg-8
    • Instance for RG (17)
    • Instance for RG (18)
    • Instance for RG (19)
    • Instance for RG (20)
    • Instance for RG (21)
    • Instance for RG (22)
    • Instance for RG (23)
    • Instance for RG (24)
  • ONTs > Config File Management > Action
  • Retrieve
  • Apply

    See Retrieving and Applying a Configuration File.


Note: The ONT must be reset to factory default values before downloading new configuration files.


Step 4: Configure subscriber services

Add the Data Service to the RG Interface and Video Service to the FB Interface.

From one ONT Services page, add all Home Gateway Services, entering the subscriber information once and using the Copy to All Ports function to simplify provisioning.