vRGW Command Reference

This command creates a text description stored in the configuration file for a configuration context. This associates a text string with a configuration context to help identify the context in the configuration file.

The no form of this command removes any description string from the context.

This command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics. Many entities must be explicitly enabled using the no shutdown command.

The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they can be deleted.

Unlike other commands and parameters where the default state is not indicated in the configuration file, shutdown and no shutdown are always indicated in system-generated configuration files.

The no form of the command puts an entity into the administratively enabled state.

This command creates the profile for Bridged Residential Gateway (BRG) devices. The BRG profile specifies default parameters that are used for host management under a single BRG.

The no form of the command removes the profile name from the configuration.

This command configures the BRG connectivity verification. The system uses ICMP Echo request messages for connectivity verification.

When the last host associated with a BRG is removed, a ping mechanism is used to verify if the BRG is still active. This command specifies the parameters used in this mechanism.

The no form of this command disables the BRG ping mechanism and removes the BRG without verification. Any configured hold time still applies.

This command enables the context to configure per-subscriber IPv4 address pool parameters to be used for address allocation. Pools for different subscribers can overlap. Specific pool parameters can be overridden by RADIUS.

This command configures the lease time, in seconds, to be used when allocating addresses from the pool. This time value should always be longer than the renew/rebind time.

The no form of the command reverts to the default.

This command enables the context to configure options that are reflected in DHCP.

This command configures DHCP options.

This command configures the subnet that will be used for the L2aware-subscriber. This subnet is only locally significant and can overlap with other subscribers. The subnet is derived by ignoring the host bits of the IP address. The IP address specifies the default gateway that will be signaled in DHCP along with the netmask derived from the prefix length.

The start and end addresses specify the range of addresses that are suitable for allocation within the given subnet. If the subnet address (host bits 0), broadcast address (host bits 1) or default-gw address fall in this range, they will not be considered for allocation.

Changing the subnet will only affect new subscribers. New and existing hosts for existing subscribers will keep allocating from the original subnet.

This command holds the BRG object for the specified time. This applies when the connectivity verification fails or when the last host is removed and no connectivity-verification is enabled. Hold time does not apply to an explicit removal via the radius or clear commands.

The no form of the command disables the hold time.

This hold time applies to BRG instances that are created without any hosts; for example, triggered due to proxy authentication. During this initial hold-time the BRG is not deleted and no connectivity-verification is started. When this timer expires, connectivity verification is started. If connectivity verification is disabled and no hosts are associated with the BRG upon expiry, the regular hold time is started and the BRG instance will be removed.

This command allows an operator to have fast BRG removal (no connectivity-verification and no hold-time) but still use BRG proxy authentication. Without an initial hold time the BRG would be removed immediately after creation.

This command does not apply to BRG instances that are created through host setup.

This command enables the context to configure parameters related to RADIUS authentication performed for the BRG.

This command configures the value of the user password as signaled in RADIUS. The no form of this command indicates that no password field should be sent in RADIUS.

This command is used if the BRG needs to be authenticated to the controller/PCMP by the vRGW. This is required if the BRG does not perform RADIUS authentication via the proxy server. The vRGW will originate a valid Access Request using the BRG ID as the username.

The no form of this command removes the radius-server-policy from the configuration. Setup of an unauthenticated BRG will now fail.

This command enables BRG processing on the specified RADIUS proxy server. Whenever an Access-Accept message is received with the attribute Alc-BRG-Id present, this will trigger the creation of a BRG. The BRG will use the brg-profile specified in the Access-Accept message or fall back to this BRG profile. When the specified radius-proxy-server has a cache enabled, no cache entries will be created for a transaction identified as BRG. A RADIUS proxy server can only be listed in one BRG profile.

This command can be executed multiple times.

The no form of this command removes BRG processing for the specified radius-proxy server.

This command configures the SLA profile string that will be used as a default for SLA profile lookup. This string can be overridden during BRG or host authentication.

The no form of the command removes the string from the configuration.

This command is used as a default for subscriber profile lookup. This string can be overridden during BRG or host authentication. The no form of the command removes the string from the configuration.

This command specifies a subscriber RADIUS-based accounting policy.

This command enables the context to specify the RADIUS parameters that the system should include in RADIUS authentication-request messages.

This command specifies authentication policy configured under the aaa context for authenticating users on the WLAN-GW ISA.

This command includes the Alc-Num-Attached-UEs attribute. For session/host accounting, this is the tunnel of the associated UE. For queue-instance accounting, this attribute will not be included.

The no form of the command removes the attribute from inclusion.

This command indicates the number of IPoE sessions that are currently active on the BRG to which this accounting message relates. The no form of the command removes the attribute from inclusion.

This command enables the context to configure subscriber management entities. A subscriber is uniquely identified by a subscriber identification string. Each subscriber can have several DHCP sessions active at any time. Each session is referred to as a subscriber host and is identified by its IP address and MAC address.

All subscriber hosts belonging to the same subscriber are subject to the same hierarchical QoS (HQoS) processing. The HQoS processing is defined in the sub-profile (the subscriber profile). A sub-profile refers to an existing scheduler policy (configured in the configure>qos>scheduler-policy context) and offers the possibility to overrule the rate of individual schedulers within this policy.

Because all subscriber hosts use the same scheduler policy instance, they must all reside on the same complex.

This command enables the context to configure BRG parameters. In the config>service>ies>sub-if>grp-if and config>service>vprn>sub-if>grp-if contexts, these commands are only available in the vlan-tag-ranges level.

This command indicates that only BRGs that are pre-authenticated using the RADIUS proxy are allowed in this context.

The no form of the command removes the restriction.

This command indicates that the default BRG profile must be used for new BRGs. This profile can be overridden by RADIUS.

This command enables the sending of ARP or ND packets on the WLAN-GW GRE tunnel for certain events. The target IP address in the ARP/ND packet is the endpoint IP address of the AP. The ARP/ND response from the AP should contain the AP MAC, which subsequently can be reported in a called-station-id message. When enabled, a message will be sent for following events:

This configuration is ignored for L2-AP and L2TPv3 access.

This command enables or disables data-triggered subscriber creation for WIFI subscribers. Data- triggered UE creation is currently only supported for UDP and TCP packets.

This command allows the operator to create special subscriber-based interfaces. It is used to contain multiple group interfaces. Multiple subnets associated with the subscriber interface can be applied to any of the contained group interfaces in any combination. The subscriber interface allows subnet sharing between group interfaces.

The no form of the command removes the subscriber interface.

This command creates a group interface. This interface is designed for triple-play services where multiple SAPs are part of the same subnet. A group interface may contain one or more SAPs.

The no form of the command removes the group interface from the subscriber interface.

This command enables the context to configure WLAN GW parameters.

This command creates or enters the context of specified VLAN range for configuration applicable to that range of VLANs.

This command enables the context to configure VLAN-to-retail-map parameters to map dot1q tags to the retail service ID. The WIFI AP inserts a dot1Q tag in the Layer 2 frame within the GRE tunnel to indicate the retail service provider for the subscriber.

This command enables the context to display operational information for connected BRGs and related hosts.

This command displays operational information for connected BRGs and related hosts.

This command displays all operational data related to the BRG.

This command lists all the DHCP bindings of the local pool associated with the specified BRG. If the MAC attribute is specified, only the binding for that MAC address is displayed.

This command lists pool information about a specific host in the BRG.

This command lists all the hosts connected to the BRG.

This command lists operational gateway information for all BRGs active on the system. This list can optionally be reduced by specifying a BRG profile.

This command displays BRG profile information.

This command clears BRG data.

This command clears BRG gateway data.