Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Fair Usage on MX Series Routers Configuration Wizard Configuration Overview

 

When you use the fair usage on MX Series routers configuration wizard, the wizard definition file specifies most of the SRC configuration. However, you must provide values for certain parameters in the configuration.

Fair Usage on MX Series Routers Configuration Wizard Definition File

The fair usage on MX Series routers configuration wizard definition file is an .xml file that controls the parameters of the wizard.

The following sample shows the definition file for the fair usage on MX Series routers configuration wizard. The first part of the definition file defines the dialog boxes you use to enter values specific to your environment. The next part of the definition file lists the SRC CLI set commands the wizard invokes.

This file is shown only for reference purposes. Modification of definition files is not supported.

The following sections describe which parameters are predefined by the wizard and which parameters require your input.

Configuration Provided by the Fair Usage on MX Series Routers Configuration Wizard

The fair usage on MX Series routers configuration wizard configures the SRC components and configuration trees described in Table 17. Most of the SRC configuration is defined by the wizard definition file. Some parameters are configured based on your inputs to the configuration wizard interface.

Table 17: SRC Configuration Parameters Supplied by the Fair Usage on MX Series Routers Configuration Wizard

SRC Component or Configuration Tree

Description

Web application server (appsvr)

The wizard configures the Web application server, web virtual host eth0 alias, based on the input you provide for the src-host-name and src-host-ip parameters.

Diameter application

The wizard configures the Diameter application based on the values you enter for the following SRC host parameters in the wizard interface:

  • Origin-host—The wizard configures the Diameter origin-host based on the value you enter for the src-host-name parameter.

  • Origin-realm—The wizard configures the Diameter origin-realm based on the value you enter for the src-host-domain-name parameter.

  • Local-address—The wizard configures the Diameter local-address based on the value you enter for the src-host-ip parameter.

Diameter peer

The wizard configures the Diameter peer parameters for the MX Series router based on the values you enter for the following router host parameters:

  • Diameter peer address—The wizard configures the IP address for the Diameter peer based on the value you enter for the mx-router-ip parameter.

  • Diameter peer origin-host—The wizard configures the origin-host of the Diameter peer based on the value you enter for the mx-router-name.

For the connection to the Diameter peer, the wizard uses TCP, port 3868, and specifies the connection as active.

NIC

The wizard configures the NIC to use the OnePopLogin scenario.

SAE

The wizard uses the SAE group name “fair-usage”, which must exist before invoking the wizard. If the group “fair-usage” does not exist, you must create it by committing set slot 0 sae shared /SAE/fair-usage. Because the wizard uses a single-step configuration commit process, it is not possible to commit the local and shared SAE configurations simultaneously. The wizard configures the following parameters for the SAE:

  • SRC VTA ejb-adaptor plug-ins

  • NIC plug-ins

  • Plug-ins event publisher

  • SAE logger

  • Subscriber classifier. All subscribers are classified to a single SRC VTA user profile.

VTA

Services—The wizard configures an SRC VTA group called “fair-usage” and two services. The high-speed service, called MXQuotaInternet, operates at 10 Mbps and is activated when the subscriber logs in. The MXQuotaInternet service continues to run until the subscriber’s quota is exhausted. When the quota is exhausted, the subscriber is switched to the low-speed service called MXQuotaLowSpeed, which operates at 256 Kbps. The real service behavior depends on the MX Series router firewall filter configuration.

External MySQL database—The wizard requires an external MySQL database, which you must configure. The wizard configures basic parameters for the external database based on the values you specify in the wizard VTA database host and database parameters dialog box. The database connection-url is based on the value you enter for the vta-database-ip parameter. The username and password are based on the values you enter for vta-database-user and vta-database-pass. If you want to use a database other than MySQL, you must customize the configuration using the SRC CLI after you commit the configuration using the wizard.

SRC VTA NIC proxy—The wizard uses the IdToSaeNicProxy NIC proxy, which uses the subscriber ID to locate the SAE when NIC resolution is needed. The wizard also configures the NIC to use the OnePopLogin scenario.

Event Handlers—The wizard configures event handlers so that when there is no quota left for a subscriber, its MXQuotaInternet service is stopped and the MXQuotaLowSpeed service is started. When the subscriber’s quota is refilled, the MXQuotaLowSpeed service is stopped and the MXQuotaInternet service is restarted.

db-engine processor—The wizard configures the db-engine processor with some initial balance in the PeriodQuota account. The SRC VTA quota account is debited according to the DebitQuotaUsage script.

Actions—The wizard configures actions to retrieve account balances, debit accounts, calculate usage, and start and stop services.

Policies

The wizard creates a policy folder named “fair-usage-ise” and two policies. The service policy named “MXQuotaPolicy” uses a dynamic profile named “src_driven_quota_profile”. The policy named “MXCaptivePolicy” uses a dynamic profile named “src_driven_captive_profile.”

Services

The wizard configures two services. The high-speed service, called MXQuotaInternet, operates at 10 Mbps and is activated when the subscriber logs in. The MXQuotaInternet service continues to run until the subscriber’s quota is exhausted. When the quota is exhausted, the subscriber is switched to the low-speed service called MXQuotaLowSpeed, which operates at 256 Kbps.

Both of the services use quota as the tracking plug-in.

Subscribers

The wizard configures one subscriber named “quota-subscriber-1” that subscribes to both the MXQuotaInternet and the MXQuotaLowSpeed services.

shared network device (configuration tree)

The shared network device configuration tree sets up the MX Series router so that it can be managed by the SAE. The wizard specifies the router as a junos-ise type device and adds “A MX fair usage device” as the device description.

The management-address assigned by the wizard is based on the value you enter for the mx-router-ip parameter.

The origin-host assigned by the wizard is based on the value you enter for the mx-router-name parameter.

The wizard specifies the router as a peer to the SAE based on the value you enter for the mx-router-name.

The wizard specifies the IP address of the SAE that manages the router based on the value you enter for the src-host-ip parameter.

Required Input Parameters for the Fair Usage on MX Series Routers Configuration Wizard

The fair usage on MX Series routers configuration wizard requires you to input certain parameters that are specific to your environment. When you run the wizard, you are prompted to enter these parameters. Table 18 describes these parameters in detail.

Table 18: Input Parameters Required by the Fair Usage on MX Series Routers Configuration Wizard

Type of Parameters

Parameters

SRC host parameters

  • src-host-name—The wizard uses the value you enter as the origin-host for the SRC Diameter application.

  • src-host-ip—The wizard uses the value you enter as the local-address for the SRC Diameter application.

  • src-host-domain-name—The wizard uses the value you enter as the origin-realm for the SRC Diameter application.

Database host and database parameters used by the SRC VTA

The wizard configures the SRC VTA component to use an external MySQL database, but it does not configure the external database. You must deploy the database on a separate host and create the database by using the “vta-database-mysql.sql” file, which is included with the SRC software. The wizard requires you to enter the following parameters for the external database used by the SRC VTA:

  • vta-database-ip—The wizard uses the value you enter as the database connection-url.

  • vta-database-user—The wizard uses the value you enter as the database username.

  • vta-database-pass—The wizard uses the value you enter as the database password.

Router host parameters

The wizard does not configure the MX Series router. The wizard prompts you to enter values to define the MX Series router as a Diameter peer. The wizard requires you to enter the following parameters for the router host:

  • mx-router-name—The wizard uses the value you enter as the Diameter peer origin-hostname for the router.

  • mx-router-ip—The wizard uses the value you enter as the Diameter peer IP address.

  • mx-router-domain-name—The wizard uses the value you enter as the Diameter peer name.

You must manually configure the rest of the configuration for the MX Series router.

Certain router configuration parameters, such as dynamic profiles, must be consistent between the SRC configuration and the router configuration. The MX Series router configuration described in this section is for reference only.

A sample MX Series router configuration that can work with the SRC configuration created by the fair usage on MX Series routers configuration wizard is provided in a text file in the format of the Junos OS configuration. The sample configuration contains everything under the fair-usage group. The configuration configures IP dynamic interfaces for Dynamic Host Configuration Protocol (DHCP) access. You must edit the interface names that are used for DHCP access in this sample configuration. The sample configuration file is DemosAndSamplesApplications/wizard/fair-usage-mx.txt in SDK+AppSupport+Demos+Samples.tar.gz.