Subscriber Management Command Reference
Command Hierarchies
 | Note:
Enhanced Subscriber Management is supported on the redundant chassis model only. |
ANCP Commands
GSMP Configuration Commands
| Note:
The commands listed in this section apply only to the 7750 SR. |
Authentication Policy Commands
RADIUS Accounting Policy Commands
RADIUS Route Download Commands
Diameter Policy Commands
AAA Diameter Peer Policy Commands
Subscriber Management Diameter Application Policy Commands
Category Map and Credit Control Policy Commands
Filter Commands
BGP Peering Policy Commands
| Note:
The commands listed in this section apply only to the 7750 SR. |
Explicit Subscriber Mapping Commands
IGMP Policy Command
| Note:
The commands listed in this section apply only to the 7750 SR. |
Host Lockout Commands
| Note:
The commands listed in this section apply only to the 7750 SR. |
Host Tracking Policy Commands
PIM Policy Commands
SLA Profile Commands
Subscriber Identification Policy Commands
Auto-Generated Subscriber Identification Key Commands
| Note:
These commands are supported on the 7450 ESS in mixed mode. |
Auto-Generated Subscriber Identification Key Service Commands
| Note:
Refer to the Layer 2 Services and EVPN Guide: VLL, VPLS, PBB, and EVPN and Layer 3 Services Guide: Internet Enhanced Services and Virtual Private Routed Network Services for further services commands. |
Subscriber MCAC Policy Commands
Subscriber Profile Commands
For information about configuring accounting policies, refer to the SR OS System Management Guide.
IPoE Session Policy Commands
Multi-Chassis Redundancy Commands
SHCV Policy Commands
Subscriber Management Service Commands
VPLS Subscriber Management Configuration Commands
Capture SAP Configuration Commands
Managed SAP Policy Commands
VPRN Subscriber Interface Configuration Commands
| Note:
The commands listed in this section apply only to the 7750 SR. |
VPRN Subscriber Interface Group Interface Commands
| Note:
The commands listed in this section apply only to the 7750 SR. |
IES Subscriber Management Configuration Commands
| Note:
The commands listed in this section apply only to the 7750 SR. |
IES Interface Commands
IES Subscriber Interface Commands
| Note:
The commands listed in this section apply only to the 7750 SR. |
IES Subscriber Interface Group Interface Commands
| Note:
The commands listed in this section apply only to the 7750 SR. |
Service Subscriber Interface, Group Interface IPoE Command
VPRN Group Interface Commands
RIP Commands
VPort Commands
Refer to the SR OS Interfaces Guide for further information on card, Media Dependent Adapter (MDA), MCM (MDA Carrier Module), CMA (Compact Media Adapter) and port provisioning.
Redundant Interface Commands
| Note:
The commands listed in this section apply only to the 7750 SR. |
Wireless Portal Protocol (WPP) Commands
Multiple PPoE Session QoS Commands
Multicast Listener Discovery (MLD) Commands
For more information about MLD commands, refer to the Unicast Routing Protocols Guide.
Show Commands
Monitor Commands
Clear Commands
Debug Commands
Tools Commands
Triple Play Subscriber Management Configuration Commands
Triple Play Subscriber Management Configuration Commands
Generic Commands
description
Syntax
Context
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command 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.
Default
No description is associated with the configuration context.
Parameters
shutdown
Syntax
Context
Description
The shutdown 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 shutdown command administratively disables an entity. 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.
Shutting down a subscriber interface on a 7750 SR will operationally shut down all child group interfaces and SAPs. Shutting down a group interface on a 7750 SR will operationally shut down all SAPs that are part of that group-interface.
The no form of the command puts an entity into the administratively enabled state.
Default
no shutdown
subscriber-mgmt
Syntax
Context
Description
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.
ANCP and GSMP Commands
ancp
Syntax
Context
Description
This command enables the context to configure Access Node Control Protocol (ANCP) parameters.
ancp-policy
Syntax
Context
Description
This command creates an Access Node Control Protocol (ANCP) policy. The policy is associated with either the ANCP string (static case) or subscriber-profile (dynamic case) and defines the behavior of the hosts belonging to these profiles.
ANCP polices control rates and subscribers based on port-up/port-down messages from the access node. When configured, the 7450 ESS or 7750 SR should stop SHCV to a host that is part of a port defined to be down (by port-down message). When the node receives a port-up message for a port that was in port-down, state the node will initiate the SHCV process immediately to verify connectivity.
When ANCP is used with Enhanced Subscriber Management, the ANCP string last associated with the subscriber will be used. All hosts of a subscriber will be updated with the new ANCP string.
Default
No policies are defined.
Parameters
ancp-policy
Syntax
Context
Description
This command specifies an existing Access Node Control Protocol (ANCP) policy to associate with the subscriber profile. The policy is associated with either the ANCP string (static case) or subscriber-profile (dynamic case) and defines the behavior of the hosts belonging to these profiles.
Default
No policies are defined.
Parameters
ingress
Syntax
Context
Description
This command configures ingress ANCP policy parameters.
rate-adjustment
Syntax
Context
Description
This command configures a rate adjustment for the scheduler. The rate-adjustment command should be used when the rate returned by the DSLAM is calculated with different encapsulation than the 7450 ESS or 7750 SR. The node will adjust the rate by the percent specified as:
DSLAM_RATE*adjust-rate/100 — rate-reduction.
The no form of the command returns the default value.
Default
none
Parameters
rate-reduction
Syntax
Context
Description
This command defines a constant rate reduction to the rate specified by the DSLAM. The rate-reduction command should be used if the node should adjust the rate to a value that is offset (for example by a fixed multicast dedicated bandwidth) compared to the total available on the DSLAM.
When set, the rate will be:
DSLAM_RATE*adjust-rate/100 — rate-reduction
Default
none
rate-monitor
Syntax
Context
Description
This command configures the rate monitor level.
Default
none
Parameters
rate-modify
Syntax
Context
Description
This command configures ingress rate modify scheduler parameters.
Default
none
Parameters
egress
Syntax
Context
Description
This command configures egress ANCP policy parameters.
rate-modify
Syntax
Context
Description
This command configures egress rate modify scheduler parameters.
Default
none
Parameters
port-down
Syntax
Context
Description
This command specifies the number of GSMP portdown messages received in this ANCP session.
disable-shcv
Syntax
Context
Description
When this command is configured, the node will suspend SHCV for the hosts defined with this ANCP policy until the access node sends a port-up message. When the hold-time parameter is used, the node will suspend SHCV for the period of time defined. If the hold-time parameter is not defined the node will suspend SHCV until a port-up message is received.
If the optional alarm flag is used the node should send a SHCV alarm before suspending.
Default
no disable-shcv
ancp-static-map
Syntax
Context
Description
This command enables the context to configure a static ANCP name map.
Default
ancp-static-map
entry
Syntax
Context
Description
This command configures an ANCP name. When ANCP is configured to provide rate adaptation without the use of enhanced subscriber management, this command will define how to map an ANCP key (usually the circuit-id of the DSLAM port) to either a SAP and a scheduler name (when a Multi-Service Site (MSS) is not used) or a customer, site and scheduler name when MSS is used.
Different ANCP names may be used with the same SAPs or customer ID/MSS combinations to allow schedulers within the policy to be mapped to the ANCP names. An ANCP string and SAP combination may reference only one ancp-policy. An ANCP string and customer and site-name combination may reference a single ancp-policy.
Default
none
Parameters
VPRN GSMP Configuration Commands
| Note:
The commands in this section apply only to the 7750 SR. |
gsmp
Syntax
Context
Description
This command enables the context to configure GSMP connections maintained in this service.
Default
not enabled
group
Syntax
Context
Description
This command specifies a GSMP name. A GSMP group name is unique only within the scope of the service in which it is defined.
ancp
Syntax
Context
Description
This command configures ANCP parameters for this GSMP group.
dynamic-topology-discover
Syntax
Context
Description
This command enables the ANCP dynamic topology discovery capability.
The no form of this command disables the feature.
oam
Syntax
Context
Description
This command specifies whether or not the GSMP ANCP OAM capability should be negotiated at startup of the GSMP connection.
The no form of this command disables the feature.
hold-multiplier
Syntax
Context
Description
This command configures the hold-multiplier for the GSMP connections in this group.
Parameters
idle-filter
Syntax
Context
Description
This command when applied will filter out new incoming ANCP messages while subscriber “DSL-line-state” is IDLE. The command takes effect at the time that it is applied. Existing subscriber already in IDLE state are not purged from the database.
Default
no idle-filter
keepalive
Syntax
Context
Description
This command configures keepalive values for the GSMP connections in this group.
Parameters
neighbor
Syntax
Context
Description
This command configures a GSMP ANCP neighbor.
Parameters
local-address
Syntax
Context
Description
This command configures the source ip-address used in the connection towards the neighbor. The local address is optional. If specified the node will accept connections only for that address in the service running ANCP. The address may be created after the reference but connections will not be accepted until it is created. If the local address is not used, the system accepts connections on any interface within the routing context.
Parameters
priority-marking
Syntax
Context
Description
This command configures the type of priority marking to be used.
Parameters
persistency-database
Syntax
Context
Description
This command enables the system to store DSL line information in memory. If the GSMP connection terminates, the DSL line information will remain in memory and accessible for RADIUS authentication and accounting.
Default
no persistency-database
BGP Peering Policy Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
bgp-peering-policy
Syntax
Context
Description
This command configures the name of the BGP peering policy.
Parameters
advertise-inactive
Syntax
Context
Description
This command enables or disables the advertising of inactive BGP routers to other BGP peers.
By default, BGP only advertises BGP routes to other BGP peers if a given BGP route is chosen by the route table manager as the most preferred route within the system and is active in the forwarding plane. This command allows system administrators to advertise a BGP route even though it is not the most preferred route within the system for a given destination.
Default
no advertise-inactive
aggregator-id-zero
Syntax
Context
Description
This command is used to set the router ID in the BGP aggregator path attribute to zero when BGP aggregates routes. This prevents different routers within an AS from creating aggregate routes that contain different AS paths.
When BGP is aggregating routes, it adds the aggregator path attribute to the BGP update messages. By default, BGP adds the AS number and router ID to the aggregator path attribute.
When this command is enabled, BGP adds the router ID to the aggregator path attribute. The no form of the command used at the global level reverts to default where BGP adds the AS number and router ID to the aggregator path attribute.
Default
no aggregator-id-zero — BGP adds the AS number and router ID to the aggregator path attribute.
as-override
Syntax
Context
Description
This command replaces all instances of the peer's AS number with the local AS number in a BGP route's AS_PATH.
This command breaks BGP's loop detection mechanism. It should be used carefully.
Default
as-override is not enabled by default.
auth-keychain
Syntax
Context
Description
This command configures the BGP authentication key for all peers.
The keychain allows the rollover of authentication keys during the lifetime of a session.
Default
no auth-keychain
Parameters
authentication-key
Syntax
Context
Description
This command configures the BGP authentication key.
Authentication is performed between neighboring routers before setting up the BGP session by verifying the password. Authentication is performed using the MD-5 message-based digest. The authentication key can be any combination of letters or numbers from 1 to 16.
The no form of the command removes the authentication password from the configuration and effectively disables authentication.
Default
Authentication is disabled and the authentication password is empty.
Parameters
This is useful when a user must configure the parameter, but, for security purposes, the actual unencrypted key value is not provided.
cluster
Syntax
Context
Description
This command configures the cluster ID for a route reflector server.
Route reflectors are used to reduce the number of IBGP sessions required within an AS. Normally, all BGP speakers within an AS must have a BGP peering with every other BGP speaker in an AS. A route reflector and its clients form a cluster. Peers that are not part of the cluster are considered to be non-clients.
When a route reflector receives a route, first it must select the best path from all the paths received. If the route was received from a non-client peer, then the route reflector sends the route to all clients in the cluster. If the route came from a client peer, the route reflector sends the route to all non-client peers and to all client peers except the originator.
For redundancy, a cluster can have multiple route reflectors.
Confederations can also be used to remove the full IBGP mesh requirement within an AS.
The no form of the command deletes the cluster ID and effectively disables the Route Reflection for the given group.
Default
no cluster — No cluster ID is defined.
Parameters
connect-retry
Syntax
Context
Description
This command configures the BGP connect retry timer value in seconds.
When this timer expires, BGP tries to reconnect to the configured peer.
The no form of the command used at the global level reverts to the default value.
Default
120 seconds
Parameters
damping
Syntax
Context
Description
This command enables BGP route damping for learned routes which are defined within the route policy. Use damping to reduce the number of update messages sent between BGP peers and reduce the load on peers without affecting the route convergence time for stable routes. Damping parameters are set via route policy definition.
The no form of the command used at the global level disables route damping.
When damping is enabled and the route policy does not specify a damping profile, the default damping profile is used. This profile is always present and consists of the following parameters:
Half-life: | 15 minutes |
Max-suppress: | 60 minutes |
Suppress-threshold: | 3000 |
Reuse-threshold | 750 |
Default
no damping — Learned route damping is disabled.
disable-4byte-asn
Syntax
Context
Description
This command disables the use of 4-byte ASNs. It can be configured at all 3 level of the hierarchy so it can be specified down to the per peer basis.
If this command is enabled 4-byte ASN support should not be negotiated with the associated remote peer(s).
The no form of the command resets the behavior to the default which is to enable the use of 4-byte ASN.
disable-client-reflect
Syntax
Context
Description
This command disables the reflection of routes by the route reflector to the group or neighbor. This only disables the reflection of routes from other client peers. Routes learned from non-client peers are still reflected to all clients.
The no form re-enables client reflection of routes.
Default
no disable-client-reflect — Client routes are reflected to all client peers.
disable-communities
Syntax
Context
Description
This command configures BGP to disable sending communities.
Parameters
disable-fast-external-failover
Syntax
Context
Description
This command configures BGP fast external failover.
export
Syntax
Context
Description
This command specifies the export policies to be used to control routes advertised to BGP neighbors.
When multiple policy names are specified, the policies are evaluated in the order they are specified. A maximum of five (5) policy names can be configured. The first policy that matches is applied.
| Note:
If a non-existent route policy is applied to a VPRN instance, the CLI generates a warning message. This message is only generated at an interactive CLI session and the route policy association is made. No warning message is generated when a non-existent route policy is applied to a VPRN instance in a configuration file or when SNMP is used. |
The no form of this command removes all route policy names from the export list.
Default
no export — BGP advertises routes from other BGP routes but does not advertise any routes from other protocols unless directed by an export policy.
Parameters
hold-time
Syntax
Context
Description
This command configures the BGP hold time, expressed in seconds.
The BGP hold time specifies the maximum time BGP waits between successive messages (either keepalive or update) from its peer, before closing the connection.
Even though the router OS implementation allows setting the keepalive time separately, the configured keepalive timer is overridden by the hold-time value under the following circumstances:
If the specified hold-time is less than the configured keepalive time, then the operational keepalive time is set to a third of the hold-time; the configured keepalive time is not changed.
If the hold-time is set to zero, then the operational value of the keepalive time is set to zero; the configured keepalive time is not changed. This means that the connection with the peer is up permanently and no keepalive packets are sent to the peer.
The no form of the command used at the global level reverts to the default value.
Default
90 seconds
Parameters
import
Syntax
Context
Description
This command specifies the import policies to be used to control routes advertised to BGP neighbors. Route policies are configured in the config>router>policy-options context. When multiple policy names are specified, the policies are evaluated in the order they are specified. A maximum of five (5)policy names can be specified. The first policy that matches is applied.
The no form of this command removes all route policy names from the import list.
Default
no import — BGP accepts all routes from configured BGP neighbors. Import policies can be used to limit or modify the routes accepted and their corresponding parameters and metrics.
Parameters
keepalive
Syntax
Context
Description
This command configures the BGP keepalive timer. A keepalive message is sent every time this timer expires.
The keepalive value is generally one-third of the hold-time interval. Even though the OS implementation allows the keepalive value and the hold-time interval to be independently set, under the following circumstances, the configured keepalive value is overridden by the hold-time value:
If the specified keepalive value is greater than the configured hold-time, then the specified value is ignored, and the keepalive is set to one third of the current hold-time value.
If the specified hold-time interval is less than the configured keepalive value, then the keepalive value is reset to one third of the specified hold-time interval.
If the hold-time interval is set to zero, then the configured value of the keepalive value is ignored. This means that the connection with the peer is up permanently and no keepalive packets are sent to the peer.
The no form of the command used at the global level reverts to the default value.
Default
30 seconds
Parameters
local-address
Syntax
Context
Description
Configures the local IP address used by the group or neighbor when communicating with BGP peers.
Outgoing connections use the local-address as the source of the TCP connection when initiating connections with a peer.
When a local address is not specified, the 7750 SR OS uses the system IP address when communicating with IBGP peers and uses the interface address for directly connected EBGP peers. This command is used at the neighbor level to revert to the value defined under the group level.
The no form of the command removes the configured local-address for BGP.
The no form of the command used at the group level reverts to the value defined at the global level.
The no form of the command used at the neighbor level reverts to the value defined at the group level.
Default
no local-address
For IPv4, the local address is expressed in dotted decimal notation. Allowed values are a valid routable IP address on the router, either an interface or system IP address.
For IPv6, the local address is expressed in semi-colon hexadecimal notation. Allowed values is an interface or a system IP address.
local-as
Syntax
Context
Description
This command configures a BGP virtual autonomous system (AS) number.
In addition to the AS number configured for BGP in the config>router>autonomous-system context, a virtual (local) AS number is configured.The virtual AS number is added to the as-path message before the router’s AS number makes the virtual AS the second AS in the as-path.
This configuration parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in peer-group) or neighbor level (only applies to specified peer). Thus, by specifying this at each neighbor level, it is possible to have a separate as-number per EBGP session.
When a command is entered multiple times for the same AS, the last command entered is used in the configuration. The private attribute can be added or removed dynamically by reissuing the command.
Changing the local AS at the global level in an active BGP instance causes the BGP instance to restart with the new local AS number. Changing the local AS at the global level in an active BGP instance causes BGP to re-establish the peer relationships with all peers in the group with the new local AS number. Changing the local AS at the neighbor level in an active BGP instance causes BGP to re-establish the peer relationship with the new local AS number.
This is an optional command and can be used in the following circumstance:
Provider router P is moved from AS1 to AS2. The customer router that is connected to P, however, is configured to belong to AS1. To avoid reconfiguring the customer router, the local-as value on router P can be set to AS1. Thus, router P adds AS1 to the as-path message for routes it advertises to the customer router.
The no form of the command used at the global level will remove any virtual AS number configured. The no form of the command used at the group level reverts to the value defined at the global level.
The no form of the command used at the neighbor level reverts to the value defined at the group level.
Default
no local-as
Parameters
local-preference
Syntax
Context
Description
This command enables setting the BGP local-preference attribute in incoming routes if not specified and configures the default value for the attribute. This value is used if the BGP route arrives from a BGP peer without the local-preference integer set.
The specified value can be overridden by any value set via a route policy.
The no form of the command at the global level specifies that incoming routes with local-preference set are not overridden and routes arriving without local-preference set are interpreted as if the route had local-preference value of 100.
Default
no local-preference
Does not override the local-preference value set in arriving routes and analyze routes without local preference with value of 100.
Parameters
loop-detect
Syntax
Context
Description
This command configures how the BGP peer session handles loop detection in the AS path.
| Note:
Dynamic configuration changes of loop-detect are not recognized. |
The no form of the command used at the global level reverts to default, which is loop-detect ignore-loop.
Default
loop-detect ignore-loop
Parameters
med-out
Syntax
Context
Description
This command enables advertising the Multi-Exit Discriminator (MED) and assigns the value used for the path attribute for the MED advertised to BGP peers if the MED is not already set.
The specified value can be overridden by any value set via a route policy.
The no form of the command used at the global level reverts to default where the MED is not advertised.
no med-out
Parameters
min-as-origination
Syntax
Context
Description
This command configures the minimum interval, in seconds, at which a path attribute, originated by the local router, can be advertised to a peer.
The no form of the command used at the global level reverts to default.
Default
15 seconds
Parameters
min-route-advertisement
Syntax
Context
Description
This command configures the minimum interval, in seconds, at which a prefix can be advertised to a peer.
The no form of the command reverts to default values.
Default
30 seconds
Parameters
multihop
Syntax
Context
Description
This command configures the time to live (TTL) value entered in the IP header of packets sent to an EBGP peer multiple hops away.
This parameter is meaningful only when configuring EBGP peers. It is ignored if set for an IBGP peer.
The no form of the command is used to convey to the BGP instance that the EBGP peers are directly connected.
The no form of the command reverts to default values.
Default
1 — EBGP peers are directly connected.
64 — IBGP
Parameters
next-hop-self
Syntax
Context
Description
This command configures the neighbor to always set the NEXTHOP path attribute to its own physical interface when advertising to a peer.
The no form of the command disables the command.
Default
no next-hop-self
passive
Syntax
Context
Description
This command enables the passive mode for the BGP neighbors.
The no form of the command disables the passive mode.
Default
no passive
peer-as
Syntax
Context
Description
This command configures the autonomous system number for the remote peer. The peer AS number must be configured for each configured peer.
The no form of the command removes the as-number from the configuration.
Default
No AS numbers are defined.
Parameters
preference
Syntax
Context
Description
This command configures the route preference for routes learned from the configured peer(s).
The lower the preference the higher the chance of the route being the active route. The OS assigns BGP routes highest default preference compared to routes that are direct, static or learned via MPLS or OSPF.
The no form of the command used at the global level reverts to default value.
Default
170
Parameters
prefix-limit
Syntax
Context
Description
This command configures the maximum number of routes BGP can learn from a peer.
When the number of routes reaches 90% of this limit, an SNMP trap is sent. When the limit is exceeded, the BGP peering is dropped and disabled.
The no form of the command removes the prefix-limit.
Default
no prefix-limit
Parameters
remove-private
Syntax
Context
Description
This command allows private AS numbers to be removed from the AS path before advertising them to BGP peers.
The OS software recognizes the set of AS numbers that are defined by IANA as private. These are AS numbers in the range 64512 through 65535, inclusive.
The no form of the command used at the global level reverts to default value.
Default
no remove-private
Private AS numbers will be included in the AS path attribute.
type
Syntax
Context
Description
This command designates the BGP peer as type internal or external.
The type of internal indicates the peer is an IBGP peer while the type of external indicates that the peer is an EBGP peer.
By default, the OS derives the type of neighbor based on the local AS specified. If the local AS specified is the same as the AS of the router, the peer is considered internal. If the local AS is different, then the peer is considered external.
The no form of the command used at the group level reverts to the default value.
Default
no type
Type of neighbor is derived on the local AS specified.
Parameters
ttl-security
Syntax
Context
Description
Configure TTL security parameters for incoming packets.
Parameters
RADIUS Policy Commands
isa-radius-policy
Syntax
Context
Description
This command enables the context to configure an ISA RADIUS policy.
Default
none
Parameters
radius-coa-port
Syntax
Context
Description
This command configures the system-wide UDP port number that RADIUS is listening on for CoA and Disconnect messages
The no form of the command resets the default UDP port to 3799.
Default
3799
Parameters
authentication-policy
Syntax
Context
Description
This command creates the context to configure RADIUS server parameters for session authentication. The policies can be applied to an IES or VPRN interface, or a VPLS SAP.
The no form of the command removes the RADIUS server configuration for session authentication.
RADIUS servers can be configured for three different applications:
- For authentication of dynamic Triple Play subscriber sessions, under config>subscr-mgmt>authentication-plcy
- For 802.1x port authentication, under config>system>security>dot1x>radius-plcy
- For CLI login users, under config>system>radius
Default
none
Parameters
pim-policy
Syntax
Context
Description
This command adds an existing PIM policy to this subscriber profile.
The no form of the command removes the specified PIM policy from this subscriber profile.
Default
No PIM policy is added to a subscriber profile by default.
Parameters
radius-accounting-policy
Syntax
Context
Description
This command specifies a subscriber RADIUS based accounting policy.
Parameters
accept-authorization-change
Syntax
Context
Description
This command specifies whether or not the system should handle the CoA messages initiated by the RADIUS server, and provide for mid-session interval changes of policies applicable to subscriber hosts.
Default
no accept-authorization-change
accept-script-policy
Syntax
Context
Description
This command configures a RADIUS script policy used to change the RADIUS attributes of the incoming Access-Accept messages.
Parameters
access-loop-options
Syntax
Context
Description
This command enables inclusion of access loop information: Broadband Forum (BBF) access loop characteristics, DSL line state and DSL type. The BBF access loop characteristics are returned as BBF specific RADIUS attributes where DSL line state and DSL type are returned as Alcatel-Lucent specific RADIUS VSA’s.
Information obtained via the ANCP protocol has precedence over information received in PPPoE Vendor Specific BBF tags or DHCP Vendor Specific BBF Options.
If ANCP is utilized and interim accounting update is enabled, any “Port Up” event from GSMP will initiate in an interim update. “Port Up” messages can include information such as an update on the current subscriber actual-upstream-speed. The next interim accounting message will be from “port up” triggering point.
Default
no access-loop-options
host-accounting
Syntax
Context
Description
This command enables per host accounting mode. In host accounting mode, the acct-session-id is generated per host. This acct-session-id is uniformly included in all accounting messages (START/INTERIM-UPDTATE/STOP) and it can be included in RADIUS Access-Request message.
Accounting counters are based on the queue counters and as such are aggregated for all host sharing the queues within an sla-profile instance (non HSMDA) or a subscriber (HSMDA). CoA and LI is supported based on the acct-session-id of the host.
Default
no host-accounting
Parameters
include-radius-attribute
Syntax
Context
Description
This command enables the context to specify the RADIUS parameters that the system should include into RADIUS authentication-request messages.
acct-authentic
Syntax
Context
Description
This command enables the generation of the acct-authentic RADIUS attribute and only applies to the 7750 SR.
acct-delay-time
Syntax
Context
Description
This command enables the generation of the acct-delay-time RADIUS attribute and only applies to the 7750 SR.
alc-error-code
Syntax
Context
Description
This command enables RADIUS accounting messages to include an error number and error code when the subscriber host session terminates. To obtain a complete list of error numbers and their corresponding codes, use the tools>dump>aaa>radius-acct-terminate-cause command.
all-authorized-session-addresses
Syntax
Context
Description
Applicable for session-accounting mode only.
With this flag enabled, all IP address attributes explicitly enabled to be included are the following:
- delegated-ipv6-prefix
- framed-ip-address
- framed-ip-netmask
- framed-ipv6-prefix
- ipv6-address
These are included if the corresponding addresses or prefixes are authorized (via access-accept or ludb) and independent if they are used or not.
Default
no all-authorized-session-addresses
called-station-id
Syntax
Context
Description
This command includes called station id attributes and only applies to the 7750 SR.
The no form of the command excludes called station id attributes.
calling-station-id
Syntax
Context
Description
This command enables the inclusion of the calling-station-id attribute in RADIUS authentication requests and RADIUS accounting messages. The value inserted is set at the SAP level. If no calling-station-id value is set at the SAP level, the calling-station-id attribute will not be sent.
Default
no calling-station-id
Parameters
access-loop-options
Syntax
Context
Description
This command enables inclusion of access loop information: Broadband Forum (BBF) access loop characteristics, DSL line state and DSL type. The BBF access loop characteristics are returned as BBF specific RADIUS attributes where DSL line state and DSL type are returned as Alcatel-Lucent specific RADIUS VSA’s.
Information obtained via the ANCP protocol has precedence over information received in PPPoE Vendor Specific BBF tags or DHCP Vendor Specific BBF Options.
acct-session-id
Syntax
Context
Description
The acct-session-id attribute for each subscriber host will be generated at the very beginning of the session initiation. This command will enable or disable sending this attribute to the RADIUS server in the Access-Request messages regardless of whether the accounting is enabled or not. The acct-session-id attribute can be used to address the subscriber hosts from the RADIUS server in the CoA Request.
The acct-session-id attribute will be unique per subscriber host network wide. It is a 22bytes long field comprised of the system MAC address along with the creation time and a sequence number in a hex format.
Default
Disabled
circuit-id
Syntax
Context
Description
This command enables the generation of the agent-circuit-id for RADIUS.
delegated-ipv6-prefix
Syntax
Context
Description
This command enables the generation of the delegated-ipv6-prefix RADIUS attribute and only applies to the 7750 SR.
detailed-acct-attributes
Syntax
Context
Description
This command enables detailed reporting of per queue and per policer octet and packet counters using RADIUS VSAs. Enabled by default. It can be enabled simultaneously with aggregate counters (std-acct-attributes).
The no form of the command excludes the detailed counter VSAs from the RADIUS accounting messages.
Default
detailed-acct-attributes
dhcp-options
Syntax
Context
Description
This command enables insertion of RADIUS VSA containing all dhcp-options from dhcp-discover (or dhcp-request) message. The VSA contains all dhcp-options in a form of the string. If required (the total length of all dhcp-options exceeds 255B), multiple VSAs are included.
Default
no dhcp-options
dhcp6-options
Syntax
Context
Description
This command will copy DHCPv6 options from received DHCPv6 messages on ingress access and pass them to the RADIUS server in Accept-Request. The messages will be carried in the ALU VSA Alc-ToServer-Dhcp6-Options.
Default
no dhcp6-options
dhcp-vendor-class-id
Syntax
Context
Description
This command includes the “[26-6527-36] Alc-DHCP-Vendor-Class-Id” attribute in RADIUS accounting messages. The content of the DHCP Vendor-Class-Identifier option (60) is mapped in this attribute.
Default
no dhcp-vendor-class-id
framed-interface-id
Syntax
Context
Description
This command enables the generation of the framed-interface-id RADIUS attribute and only applies to the 7750 SR.
framed-ip-addr
Syntax
Context
Description
This command enables the inclusion of the framed-ip-addr attribute.
framed-ip-netmask
Syntax
Context
Description
This command enables the inclusion of the framed-ip-netmask attribute.
framed-ipv6-prefix
Syntax
Context
Description
This command enables the generation of the framed-ipv6-prefix RADIUS attribute and only applies to the 7750 SR.
framed-ipv6-route
Syntax
Context
Description
When enabled, all valid [99] Framed-IPv6-Route attributes as received in the RADIUS authentication phase and associated with an instantiated IPv6 wan host will be included in the RADIUS accounting request messages. The state of the Framed-IPv6-Route (installed, shadowed, hostInactive, etc.) is not taken into account for reporting in the accounting request messages. This command only applies to the 7750 SR.
Default
no framed-ipv6-route
framed-route
Syntax
Context
Description
When enabled, all valid [22] Framed-Route attributes as received in the RADIUS authentication phase and associated with an instantiated IPv4 host will be included in the RADIUS accounting request messages. The state of the Framed-Route (installed, shadowed, hostInactive, etc.) is not taken into account for reporting in the accounting request messages. This command only applies to the 7750 SR.
Default
no framed-route
ipv6-address
Syntax
Context
Description
This command enables the generation of the ipv6-address RADIUS attribute and only applies to the 7750 SR.
mac-address
Syntax
Context
Description
This command enables the generation of the client MAC address RADIUS attribute.
nas-identifier
Syntax
Context
Description
This command enables the generation of the nas-identifier RADIUS attribute.
nas-port
Syntax
Context
Description
This command enables the generation of the nas-port RADIUS attribute. You enter decimal representation of a 32-bit string that indicates your port information. This 32-bit string can be compiled based on different information from the port (data types). By using syntax number-of-bits data-type you indicate how many bits from the 32 bits are used for the specific data type. These data types can be combined up to 32 bits in total. In between the different data types 0's and/or 1's as bits can be added.
The no form of this command disables your nas-port configuration.
Parameters
binary-spec | <bit-specification> <binary-spec> | |
bit-specification | 0 | 1 | <bit-origin> | |
bit-origin | *<number-of-bits><origin> | |
number-of-bits | 1 — 32 | |
origin | o | i | s | m | p | |
outer VLAN ID | ||
i | inner VLAN ID | |
s | slot number | |
m | MDA number | |
p | port number or lag-id | |
Output
nas-port-id
Syntax
Context
Description
This command enables the generation of the nas-port-id RADIUS attribute. Optionally, the value of this attribute (the SAP-id) can be prefixed by a fixed string and suffixed by the circuit-id or the remote-id of the client connection. If a suffix is configured, but no corresponding data is available, the suffix used will be 0/0/0/0/0/0.
Parameters
nas-port-type
Syntax
Context
Description
This command enables the generation of the nas-port-type RADIUS attribute. If set to nas-port-type, the following will be sent: values: 32 (null-encap), 33 (dot1q), 34 (qinq), 15 (DHCP hosts). The nas-port-type can also be set as a specified value, with an integer from 0 to 255.
The no form of the command reverts to the default.
Default
no nas-port-type
Parameters
nat-port-range
Syntax
Context
Description
This command enables the generation of the of nat-port-range attribute and only applies to the 7750 SR.
Default
no nat-port-range
pppoe-service-name
Syntax
Context
Description
This command enables the generation of the pppoe-service-name RADIUS attribute.
remote-id
Syntax
Context
Description
This command enables the generation of the agent-remote-id for RADIUS.
sap-session-index
Syntax
Context
Description
This command enables the generation of the per-SAP unique session index.
The no form of the command excludes sap-session-index attributes.
tunnel-server-attrs
Syntax
Context
Description
This command includes tunnel-server attribute.
wifi-num-attached-ues
Syntax
Context
Description
When enabled, this command indicates the number of UEs connected to the tunnel to which the radius message applies to. 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.
wifi-ssid-vlan
Syntax
Context
Description
This command enables including the per-SSID VLAN ID in a Alc-Wlan-SSID-VLAN.
sla-profile
Syntax
Context
Description
This command specifies that SLA profile attributes should be included into RADIUS accounting messages.
std-acct-attributes
Syntax
Context
Description
This command enables reporting of aggregated forwarded IPv4 and IPv6 octet, packet and gigaword counters using standard Radius attributes. Disabled by default. It can be enabled simultaneously with detailed per queue/policer counters (detailed-acct-attributes).
Default
no std-acct-attributes
sub-profile
Syntax
Context
Description
This command specifies that subscriber profile attributes should be included into RADIUS accounting messages.
subscriber-id
Syntax
Context
Description
This command specifies that subscriber ID attributes should be included into RADIUS accounting messages.
tunnel-server
Syntax
Context
Description
This command enables the generation of the tunnel-server RADIUS attribute and only applies to the 7750 SR.
user-name
Syntax
Context
Description
This command enables the inclusion of the user-name attribute.
The no form of the command disables the inclusion of the user-name attribute.
Default
no user-name
v6-aggregate-stats
Syntax
Context
Description
This command enables reporting of IPv6 aggregated forwarded octet and packet counters using RADIUS VSAs. Disabled by default. It requires stat-mode v4-v6 for policers and queues for which the IPv6 aggregate forwarded packets should be counted.
Default
no v6-aggregate-stats
wifi-rssi
Syntax
Context
Description
This command enables the inclusion of the 802.11 Received Signal Strength Indication attribute.
password
Syntax
Context
Description
This command sets a password that is sent with user-name in every RADIUS authentication request sent to the RADIUS server upon receipt of DHCP discover or request messages. If no password is configured, no password AVP will be sent.
The no form of the command reverts to the default value.
Default
none
Parameters
password
Syntax
Context
Description
This command sets a password that is sent with user-name in every RADIUS authentication request sent to the RADIUS server upon receipt of DHCP discover or request messages. If no password is provided, an empty password will be sent.
The no form of the command reverts to the default value.
Default
no password
Parameters
ppp-user-name
Syntax
Context
Description
This command configures the password that is sent with the User-Name in Diameter NASREQ AA-Requests for IPoE hosts.
When no password is configured, an empty password will be sent.
Default
no ppp-user-name
Parameters
pppoe-access-method
Syntax
Context
Description
This command indicates the authentication method used towards the RADIUS server in case the policy is used for PPPoE.
Parameters
queue-instance-accounting
Syntax
Context
Description
This command enables per queue-instance-accounting. A stream of accounting messages (START/INTERIM-UPDATE/STOP) is generated per queuing instance. A queuing instance is equivalent to an sla-profile instance on non HSMDA based hardware and to subscriber on HSMDA based hardware. Accounting session id is generated per queuing instance and this accounting session id CANNOT be included in RADIUS Access-Request message. Queue instance counters represent volume based aggregation for all hosts sharing the queuing instance.
CoA and LI is supported based on the acct-session-id of the queuing instance.
Default
interim-update
Parameters
radius-authentication-server
Syntax
Context
Description
This command creates the context for defining RADIUS authentication server attributes under a given session authentication policy.
access-algorithm
Syntax
Context
Description
This command configures the algorithm used to access the list of configured RADIUS servers.
Parameters
fallback-action
Syntax
Context
Description
This command configures the action when no RADIUS server is available; servers are either out of service or are in a probing state.
The no form of the command removes the action from the configuration.
Default
no fallback-action
Parameters
hold-down-time
Syntax
Context
Description
This command determines the interval during which no new communication attempts will be made to a RADIUS server that is marked down to prevent immediately overloading the server when it is starting up. The only exception is when all servers in the authentication policy are marked down; in that case they will all be used again to prevent failures on new client connections.
Default
30
Parameters
router
Syntax
Context
Description
This command specifies the virtual router instance applicable for the set of configured RADIUS servers. This value cannot be changed once a RADIUS server is configured for this policy. When the value is zero, both base and management router instances are matched.
Parameters
router-name: | Base, management |
service-id: | 1 — 2147483647 |
service-name: | Specifies the service name up to 64 characters in length |
retry
Syntax
Context
Description
This command configures the number of times the router attempts to contact the RADIUS server for authentication, if not successful the first time.
The no form of the command reverts to the default value.
Default
3
Parameters
radius-server-policy
Syntax
Context
Description
This command references an existing radius-server-policy (available under the config>aaa context) for use in subscriber management authentication and accounting.
When configured in an authentication-policy, following CLI commands are ignored in the policy to avoid conflicts:
- all commands in the radius-authentication-server context
- accept-authorization-change
- coa-script-policy
- accept-script-policy
- request-script-policy
When configured in a radius-accounting-policy, following CLI commands are ignored in the policy to avoid conflicts:
- all commands in the radius-accounting-server context
- acct-request-script-policy
The no form of the command removes the radius-server-policy reference from the configuration
Default
no radius-server-policy
Parameters
server
Syntax
Context
Description
This command adds a RADIUS server and configures the RADIUS server IP address, index, and key values.
Up to sixteen RADIUS servers can be configured at any one time in a RADIUS authentication policy. Only five can be used for authentication, all other servers should be configured as coa-only servers. In a RADIUS accounting policy, up to five RADIUS servers can be configured. RADIUS servers are accessed in order from lowest to highest index for authentication or accounting requests until a response from a server is received. A higher indexed server is only queried if no response is received from a lower indexed server (which implies that the server is not available). If a response from a server is received, no other RADIUS servers are queried.
The no form of the command removes the server from the configuration.
Default
No RADIUS servers are configured.
Parameters
For authentication purposes, the maximum number of servers is 5. All other servers may only be used as coa-only servers.
hold-down-time
Syntax
Context
Description
This command determines the interval during which no new communication attempts will be made to a RADIUS server that is marked down to prevent immediately overloading the server when it is starting up. The only exception is when all servers in the authentication policy are marked down; in that case, they will all be used again to prevent failures on new client connections.
Default
30s
Parameters
down-timeout
Syntax
Context
Description
This command determines the interval to wait for a RADIUS reply message from the RADIUS server before a RADIUS server is declared “out-of-service”. By default, the value of the “down-timeout” is the number of retries multiplied by the timeout interval. Each host will use the configured timeout and retry value under the AAA RADIUS server policy.
timeout refers to the waiting period before the next retry attempt
retry refers the number of times the host will attempt to contact the RADIUS server.
If a RADIUS server is declared “out-of-service”, the host pending retry attempts will move on to the next RADIUS server.
Default
By default the down-timeout interval is timeout multiply by retry attempts.
Parameters
source-address
Syntax
Context
Description
This command configures the source address of the RADIUS packet.
The system IP address must be configured in order for the RADIUS client to work. See Configuring a System Interface in the Router Configuration Guide.
| Note:
The system IP address must only be configured if the source-address is not specified. When the no source-address command is executed, the source address is determined at the moment the request is sent. This address is also used in the nas-ip-address attribute: over there it is set to the system IP address if no source-address was given. |
The no form of the command reverts to the default value.
Default
System IP address
Parameters
timeout
Syntax
Context
Description
This command configures the number of seconds the router waits for a response from a RADIUS server.
The no form of the command reverts to the default value.
Default
3 seconds
Parameters
session-accounting
Syntax
Context
Description
This command enables per session accounting mode. In per session accounting mode, the acct-session-id is generated per session. This acct-session-id is uniformly included in all accounting messages (START/INTERIM-UPDTATE/STOP) and it can be included in RADIUS Access-Request message.
This accounting mode of operation can be used only in PPPoE environment with dual-stack host in which case both hosts (IPv4 and IPv6) are considered part of the same session. In addition to regular interim-updates, triggered interim-updates are sent by a host joining or leaving the session.
When an IPv4/v6 address is allocated, or released from a dual-stack host, a triggered interim-update message is immediately sent. This triggered interim-update message reflects the change in the IP address. The triggered interim-update has no effect on the interval at which the regular interim updates are scheduled.
Accounting counters are based on the queue counters and as such are aggregated for all host sharing the queues within an sla-profile instance (non HSMDA) or a subscriber (HSMDA).
CoA and LI is supported based on the acct-session-id of the session.
Default
no session-accounting
Parameters
session-id-format
Syntax
Context
Description
This command specifies the format for the acct-session-id attribute used in RADIUS accounting requests.
Parameters
update-interval
Syntax
Context
Description
This command specifies the interval at which accounting data of subscriber hosts will be updated in a RADIUS Accounting Interim-Update message. Requires interim-update to be enabled when specifying the accounting mode in the radius accounting policy.
A RADIUS specified interim interval (attribute [85] Acct-Interim-Interval) overrides the CLI configured value.
Parameters
update-interval-jitter
Syntax
Context
Description
This command specifies the absolute maximum random delay introduced on the update interval between two accounting interim update messages. The effective maximum random delay value is the minimum of the configured absolute jitter value and 10% of the configured update-interval.
A value of zero will send the accounting interim update message without introducing an additional random delay.
The no form of the command sets the default to 10% of the configured update-interval.
Default
no update-interval-jitter
This corresponds with 10% of the configured update-interval
Parameters
re-authentication
Syntax
Context
Description
This command enables authentication process at every DHCP address lease renewal s only if RADIUS did not reply any special attributes (for example, authentication only, no authorization).
The no form of the command reverts to the default value.
Default
disabled
request-script-policy
Syntax
Context
Description
This command specifies the RADIUS script policy used to change the RADIUS attributes of the outgoing Access-Request messages.
Default
none
Parameters
send-acct-stop-on-fail
Syntax
Context
Description
This command activates the reporting of RADIUS authentication failures of a PPPoE session to a RADIUS accounting server with an Accounting Stop message.
Three failure categories can be enabled separately:
- on-request-failure: All failure conditions between the sending of an Access-Request and the reception of an Access-Accept or Access-Reject.
- on-reject: When an Access-Reject is received
- on-accept-failure: All failure conditions that appear after receiving an Access-Accept and before successful instantiation of the host or session.
The RADIUS accounting policy to be used for sending the Accounting Stop messages must be obtained prior to RADIUS authentication via local user database pre-authentication.
Default
no send-acct-stop-on-fail
user-name-format
Syntax
Context
Description
This command defines the format of the “user-name” field in the session authentication request sent to the RADIUS server.
The no form of the command switches to the default format, mac.
Default
By default, the MAC source address of the DHCP DISCOVER message is used in the user-name field.
Parameters
ascii-converted-tuple — Identical to tuple, but the circuit-id part of the user name will be sent to the RADIUS server as a string of hex digits, for use if there is binary data in the circuit-id.
circuit-id — If the system serves as a DHCP relay server which inserts option 82 info, the user name will be formatted as defined under DHCP information option. If the system is not a DHCP relay server, the circuit-id will be taken from option 82 in the received DHCP message. If no circuit-id can be found, the DHCP-msg is rejected.
dhcp-client-vendor-opts — Creates a concatenation of the DHCP client-identifier option (option 60), a “@” delimiter and the DHCP vendor-class identifier options. The two option strings are parsed for any characters which are non-printing are considered invalid and must be converted to underscore “_” characters. In addition, any space character (hex 20) and @ character (hex 40) are also converted to underscore. The character set considered valid is ASCII hex 21 through hex 3F, and hex 41 through hex 7E. Any character outside this set will be converted into an underscore (hex 5F) character.
mac — The MAC source address of the DHCP DISCOVER message is used in the user-name field. The format of the MAC address string used as the user name in the RADIUS authentication requests uses lowercase hex digits, and “:” as the inter-digit separator, for example, 00:11:22:aa:bb:cc is valid but 00-11-22-AA-BB-CC will return an error. The RADIUS server must be configured accordingly, otherwise the authentication request will fail.
mac-giaddr — Specifies that MAC giaddr indicates the format used to identify the user towards the RADIUS server.
tuple — The concatenation of MAC source address and circuit-ID are used in the user-name field.
Examples: | ab: | 00:0c:f1:99:85:b8 Alcatel-Lucent 7xxx style |
XY- | 00-0C-F1-99-85-B8 IEEE canonical style | |
mmmm. | 0002.03aa.abff Cisco style |
Example:
user-name-format
Syntax
Context
Description
This command defines the format of the User-Name AVP value in Diameter NASREQ AA-Requests for IPoE hosts.
Parameters
user-name-operation
Syntax
Context
Description
This command enables domain name manipulation of the user name, such as append, strip, replace or add as default.
For IPoE, this command only applies when user-name-format is configured to dhcp-client-vendor-opts.
Default
no user-name-operation
Parameters
RADIUS Accounting Policy Custom Record Commands
custom-record
Syntax
Context
Description
This command enables the context to configure the layout and setting for a custom accounting record associated with this accounting policy.
The no form of the command reverts the configured values to the defaults.
delay-start-time
Syntax
Context
Description
It is recommended to only use this command when session-accounting is used. By default, a dual stack subscriber generates a RADIUS accounting interim message for each new host update (IPv4, IPv6 WAN, and IPv6 PD). This command delays the trigger of a RADIUS accounting start message and allows all hosts to connect first. When the delay timer expires, a single RADIUS accounting start message containing all the host currently connected to the BNG is sent to the server. Subsequent host connections will trigger interim-updates if host-update is enabled on session-accounting. For all other accounting modes, this command will delay the trigger of an accounting start when a host connects.
Default
no delay-start-time
override-counter
Syntax
Context
Description
This command enables the context to configure Application Assurance override counter parameters.
The no form of the command removes the ID from the configuration.
Parameters
e-counters
Syntax
Context
Description
This command configures egress counter parameters for this custom record.
The no form of the command
Parameters
i-counters
Syntax
Context
Description
This command configures ingress counter parameters for this custom record.
The no form of the command
Parameters
queue
Syntax
Context
Description
This command specifies the queue-id for which counters will be collected in this custom record. The counters that will be collected are defined in egress and ingress counters.
The no form of the command reverts to the default value
Parameters
in-profile-octets-discarded-count
Syntax
Context
Description
This command includes the in-profile octets discarded count.
For queues with stat-mode v4-v6, this command includes the IPv4 octets discarded count instead.
The no form of the command excludes the in-profile octets discarded count.
in-profile-octets-forwarded-count
Syntax
Context
Description
This command includes the in-profile octets forwarded count. For queues with stat-mode v4-v6, this command includes the IPv4 octets forwarded count instead.
The no form of the command excludes the in-profile octets forwarded count.
in-profile-packets-discarded-count
Syntax
Context
Description
This command includes the in-profile packets discarded count.
For queues with stat-mode v4-v6, this command includes the IPv4 packets discarded count instead.
The no form of the command excludes the in-profile packets discarded count.
in-profile-packets-forwarded-count
Syntax
Context
Description
This command includes the in-profile packets forwarded count.
For queues with stat-mode v4-v6, this command includes the IPv4 packets forwarded count instead.
The no form of the command excludes the in-profile packets forwarded count.
out-profile-octets-discarded-count
Syntax
Context
Description
This command includes the out of profile packets discarded count.
For queues with stat-mode v4-v6, this command includes the IPv6 octets discarded count instead.
The no form of the command excludes the out of profile packets discarded count.
out-profile-octets-forwarded-count
Syntax
Context
Description
This command includes the out of profile octets forwarded count.
For queues with stat-mode v4-v6, this command includes the IPv6 octets forwarded count instead.
The no form of the command excludes the out of profile octets forwarded count.
out-profile-packets-discarded-count
Syntax
Context
Description
This command includes the out of profile packets discarded count.
For queues with stat-mode v4-v6, this command includes the IPv6 packets discarded count instead.
The no form of the command excludes the out of profile packets discarded count.
out-profile-packets-forwarded-count
Syntax
Context
Description
This command includes the out of profile packets forwarded count.
For queues with stat-mode v4-v6, this command includes the IPv6 packets forwarded count instead.
The no form of the command excludes the out of profile packets forwarded count.
all-octets-offered-count
Syntax
Context
Description
This command includes all octets offered in the count.
The no form of the command excludes the octets offered in the count.
Default
no all-octets-offered-count
all-packets-offered-count
Syntax
Context
Description
This command includes all packets offered in the count.
The no form of the command excludes the packets offered in the count.
Default
no all-packets-offered-count
high-octets-discarded-count
Syntax
Context
Description
This command includes the high octets discarded count.
For queues with stat-mode v4-v6, this command includes the IPv4 octets discarded count instead.
The no form of the command excludes the high octets discarded count.
Default
no high-octets-discarded-count
high-octets-offered-count
Syntax
Context
Description
This command includes the high octets offered count.
The no form of the command excludes the high octets offered count.
high-packets-discarded-count
Syntax
Context
Description
This command includes the high packets discarded count.
For queues with stat-mode v4-v6, this command includes the IPv4 packets discarded count instead.
The no form of the command excludes the high packets discarded count.
Default
no high-packets-discarded-count
high-packets-offered-count
Syntax
Context
Description
This command includes the high packets offered count.
The no form of the command excludes the high packets offered count.
Default
no high-packets-offered -count
in-profile-octets-forwarded-count
Syntax
Context
Description
This command includes the in profile octets forwarded count.
For queues with stat-mode v4-v6, this command includes the IPv4 octets forwarded count instead.
The no form of the command excludes the in profile octets forwarded count.
Default
no in-profile-octets-forwarded-count
in-profile-packets-forwarded-count
Syntax
Context
Description
This command includes the in profile packets forwarded count.
For queues with stat-mode v4-v6, this command includes IPv4 packets forwarded count instead.
The no form of the command excludes the in profile packets forwarded count.
Default
no in-profile-packets-forwarded-count
low-octets-discarded-count
Syntax
Context
Description
This command includes the low octets discarded count.
For queues with stat-mode v4-v6, this command includes the IPv6 octets discarded count instead.
The no form of the command excludes the low octets discarded count.
Default
no low-octets-discarded-count
low-packets-discarded-count
Syntax
Context
Description
This command includes the low packets discarded count.
For queues with stat-mode v4-v6, this command includes the IPv6 packets discarded count instead.
The no form of the command excludes the low packets discarded count.
Default
no low-packets-discarded-count
low-octets-offered-count
Syntax
Context
Description
This command includes the low octets discarded count.
The no form of the command excludes the low octets discarded count.
low-packets-offered-count
Syntax
Context
Description
This command includes the low packets discarded count.
The no form of the command excludes the low packets discarded count.
out-profile-octets-forwarded-count
Syntax
Context
Description
This command includes the out of profile octets forwarded count.
For queues with stat-mode v4-v6, this command includes the IPv6 octets forwarded count instead.
The no form of the command excludes the out of profile octets forwarded count.
Default
no out-profile-octets-forwarded-count
out-profile-packets-forwarded-count
Syntax
Context
Description
This command includes the out of profile packets forwarded count.
For queues with stat-mode v4-v6, this command includes the IPv6 packets forwarded count instead.
The no form of the command excludes the out of profile packets forwarded count.
Default
no out-profile-packets-forwarded-count
uncoloured-octets-offered-count
Syntax
Context
Description
This command includes the uncoloured octets offered in the count.
The no form of the command excludes the uncoloured octets offered in the count.
uncoloured-packets-offered-count
Syntax
Context
Description
This command includes the uncoloured packets offered count.
The no form of the command excludes the uncoloured packets offered count.
ref-aa-specific-counter
Syntax
Context
Description
This command
The no form of the command
ref-override-counter
Syntax
Context
Description
This command configures a reference override counter.
The no form of the command reverts to the default value.
Default
no ref-override-counter
ref-queue
Syntax
Context
Description
This command configures a reference queue.
The no form of the command reverts to the default value.
Default
no ref-queue
significant-change
Syntax
Context
Description
This command configures the significant change required to generate the record.
Parameters
RADIUS Route Download Commands
route-downloader
Syntax
Context
Description
This command creates or enters the configuration of a route-downloader instance. The route-downloader is a process that uses radius access-request messages to a particular server. The server returns either an access-accept or access-deny message. Access-accept messages also contain the prefixes (in the form of static blackhole routes in various formats)
The no form of the command removes the name from the configuration. The object must be shutdown prior to deletion. No prefix is needed to delete an existing route-download object.
Default
None. Only a single route-downloader object can be created.
Parameters
base-user-name
Syntax
Context
Description
This command sets the prefix for the user name that shall be used as access requests. The actual name used will be a concatenation of this string, the “-” (dash) character and a monotonically increasing integer.
The no form of the command removes the user-name from the configuration.
Default
The system’s configured name (system-name).
Parameters
default-metric
Syntax
Context
Description
This command sets the default metric that routes imported by the RTM will acquire.
The no form of the command removes the metric
Default
2
Parameters
default-tag
Syntax
Context
Description
This command sets the default tag that routes processed by the AAA route downloader will take.
| Note:
Any route received with a specific tag retains the specific tag. The tag value is passed to the Route Table Manager and is available as match condition on the export statement of other routing protocols. |
The no form of the command reverts to the default.
Default
0
Parameters
download-interval
Syntax
Context
Description
This command sets the time interval, in minutes, that the system waits for between two consecutive runs of the route-download process. The time is counted from the start-time of the run, thus, if an route-download process is still ongoing by the time the timer expires, the process will restart from count=1.
The no form of the command reverts to the default value.
Default
720
Parameters
max-routes
Syntax
Context
Description
This command determines the upper limits for total number of routes to be received and accepted by the system. The total number is inclusive of both IPv4 and IPv6 addresses and no differentiation is needed across protocols. It includes the sum of both. Once this limit is reached, the download process stops sending new access-requests until the next download-interval expires.
The no form of the command reverts to the default value.
Default
200000
Parameters
password
Syntax
Context
Description
This command specifies the password that is used in the RADIUS access requests.It shall be specified as a string of up to 32 characters in length.
The no form of the command resets the password to its default of ALU and will be stored using hash/hash2 encryption.
Default
ALU
Parameters
radius-server-policy
Syntax
Context
Description
This command references an existing radius-server-policy (available under the config>aaa context). The server (or servers) referenced by the policy will be used as the targets for the access-request message.
The no form of the command removes the policy name from the route-downloader configuration.
Default
none
Parameters
retry-interval
Syntax
Context
Description
This command sets the duration, in minutes, of the retry interval. The retry interval is the interval meant for the system to retry sending an Access Request message after the previous one was un-answered (not with an access reject but rather just a RADIUS failure or ICMP port unreachable). This timer is actually an exponential backoff timer that starts at min and is capped at max minutes.
The no form of the command reverts to the default values.
Default
retry-interval min 10 max 20
Parameters
Category Map Commands
category-map
Syntax
Context
Description
This command specifies the category map name.
Default
none
Parameters
credit-control-policy
Syntax
Context
Description
This command creates, configures or deletes a credit control policy.
Parameters
credit-control-server
Syntax
Context
Description
This command configures the credit control server to use. In case of RADIUS, the servers defined in the authentication policy are used. For Diameter, the peers defined in the specified Diameter policy are used.
Default
no credit-control-server
Parameters
default-category-map
Syntax
Context
Description
This command configures the default category map.
Parameters
error-handling-action
Syntax
Context
Description
This command configures the error handling action for the policy.
out-of-credit-action
Syntax
Context
Description
This command configures the action to be performed when out of credit is reached.
Parameters
activity-threshold
Syntax
Context
Description
This command configures the threshold that is applied to determine whether or not there is activity. This is only valid for credit-type = time (not volume).
Default
0
Parameters
category
Syntax
Context
Description
This command specifies the category name.
Default
none
Parameters
category-map
Syntax
Context
Description
This command references the category-map to be used for the idle-timeout monitoring of subscriber hosts associated with this sla-profile. The category-map must already exist in the config>subscr-mgmt context.
Parameters
category
Syntax
Context
Description
This command defines the category in the category-map to be used for the idle-timeout monitoring of subscriber hosts.
Parameters
idle-timeout
Syntax
Context
Description
This command defines the idle-timeout value.
Default
no idle-timeout – corresponds with an infinite idle-timeout
Parameters
idle-timeout-action
Syntax
Context
Description
This command defines the action to be executed when the idle-timeout is reached. The action is performed for all hosts associated with the sla-profile instance.
Default
terminate
Parameters
| Note:
Host connectivity verification must be enabled on the group-interface where the host is connected. |
If the check is successful, the hosts are not disconnected and the idle-timeout timer is reset.
If the check fails, the hosts are deleted, similar as for “idle-timeout-action=terminate”.
credit-type-override
Syntax
Context
Description
This command overrides the credit-type configured in the config>subscr-mgmt>cat-map context for the given category.
Default
no credit-type-override
Parameters
default-credit
Syntax
Context
Description
This command configures the default time or volume credit for this category. The default credit is used during initial setup when no quota is received from RADIUS.
Refer to Minimum Credit Control Quota Values for more information.
Default
no default-credit
Parameters
exhausted-credit-service-level
Syntax
Context
Description
This command enables the context to configure the exhausted credit service level
Default
exhausted-credit-service-level
egress-ip-filter-entries
Syntax
Context
Description
This command configures the egress IP filter entries.
egress-ipv6-filter-entries
Syntax
Context
Description
This command configures the egress IPv6 filter entries.
ingress-ip-filter-entries
Syntax
Context
Description
This command configures the ingress IP filter entries.
ingress-ipv6-filter-entries
Syntax
Context
Description
This command configures the ingress IPv6 filter entries.
pir
Syntax
Context
Description
This command configures the PIR.
entry
Syntax
Context
Description
This command configures the IP filter entry.
Parameters
action
Syntax
Context
Description
This command configures the action for the filter entry.
Parameters
| Note:
Http-redirect is not supported on 7450 ESS-1 models. |
The following displays information that can optionally be added as variables in the portal URL (http-redirect url):
- $IP – Customer’s IP address
- $MAC – Customer’s MAC address
- $URL – Original requested URL
- $SAP – Customer’s SAP
- $SUB – Customer’s subscriber identification string
- $CID – string that represents the circuit-id or interface-id of the subscriber host (hexadecimal format)
- $RID – string that represents the remote-id of the subscriber host (hexadecimal format)
match
Syntax
Context
Description
This command configures the match criteria for this IP filter entry.
Parameters
dscp
Syntax
Context
Description
This command configures DSCP match conditions.
Parameters
dst-ip
Syntax
Context
Description
This command configures the destination IP match condition.
Parameters
ip-address | a.b.c.d |
mask | 0..32 |
ipv6-address | x:x:x:x:x:x:x:x (where x is [0..FFFFH]) |
:x:x:x:x:x:d.d.d.d (where d is [0..255]D) |
dst-port
Syntax
Context
Description
This command configures the destination port match condition.
Parameters
fragment
Syntax
Context
Description
This command configures the fragmentation match condition.
Parameters
icmp-code
Syntax
Context
Description
This command configures the ICMP code match condition.
Parameters
icmp-type
Syntax
Context
Description
This command configures the ICMP type match condition.
Parameters
ip-option
Syntax
Context
Description
This command configures the IP option match condition.
Parameters
multiple-option
Syntax
Context
Description
This command configures the multiple-option match condition.
Parameters
option-present
Syntax
Context
Description
This command configures the option-present match condition.
Parameters
src-ip
Syntax
Context
Description
This command configures the source IP match condition.
Parameters
ipv6-address | x:x:x:x:x:x:x:x (where x is [0..FFFFH]) |
x:x:x:x:x:x:d.d.d.d (where d is [0..255]D) |
src-port
Syntax
Context
Description
This command configures the source port match condition.
Parameters
tcp-ack
Syntax
Context
Description
This command configures the TCP ACK match condition. The no tcp-ack command disables the checking on the presence or absence of the tcp-ack flag.
Parameters
tcp-syn
Syntax
Context
Description
This command configures the TCP SYN match condition. The no tcp-syn command disables the checking on the presence or absence of the tcp-syn flag.
Parameters
pir
Syntax
Context
Description
This command configures the PIR which will be enforced for all queues pertaining to this category.
Default
no pir
Parameters
out-of-credit-action-override
Syntax
Context
Description
This command specifies the action to be taken if the credit is exhausted.
Default
no out-of-credit-action-override
Parameters
policer
Syntax
Context
Description
This command configures a policer in this category.
Parameters
queue
Syntax
Context
Description
This command configures a queue in this category.
Default
none
Parameters
rating-group
Syntax
Context
Description
This command configures the rating group applicable for this category.
Default
no rating group
Parameters
credit-exhaust-threshold
Syntax
Context
Description
This command specifies the credit exhaust threshold taken into account to take action.
The no form of the command reverts the configured value to the default.
Default
100
Parameters
credit-type
Syntax
Context
Description
This command specifies whether volume or time based accounting is performed.
Default
volume
Parameters
Diameter Commands
diameter-peer-policy
Syntax
Context
Description
This command creates a base diameter policy with up to 5 peers. There is a (TCP) connection created to each peer while only two peers can be active (used by applications) simultaneously. Various diameter applications can reference this policy.
Default
none
Parameters
diameter-application-policy
Syntax
Context
Description
This command creates diameter application policy.
Default
none
Parameters
diameter-peer-policy
Syntax
Context
Description
This command is used by an application (DCCA, Gx, policy-management application, etc.) to reference a base diameter peer policy that the application will use.
Default
none
Parameters
applications
Syntax
Context
Description
This command specifies which applications are advertised in the Capability Exchange Request (CER) messages sent on the peers.
Applications that can be configured on a Diameter peer policy:
- client and proxy role:
- gx
- nasreq
- gx nasreq
- client role only:
- gy
| Note:
Gx and nasreq applications can be enabled simultaneously on a single diameter peer. |
Default
none
Parameters
application
Syntax
Context
Description
This command specifies the Diameter application for which this policy contains the configuration details, such as AVPs to include and their format.
Applications are mutually exclusive.
Default
none
Parameters
connection-timer
Syntax
Context
Description
This command defines the frequency of attempts to open a TCP connection to each peer that is configured in the diameter-peer-policy. Once a TCP connection fails to be established (transaction-timer expires at sending TCP SYN) or an existing TCP connection fails, the next attempt to open the connection will be tried upon the expiry of the connection-timer. There is no limit on the number of attempts.
Default
30 seconds at diameter-base level
The default value at peer is taken from diameter-base.
Parameters
ipv6-source-address
Syntax
Context
Description
This command configures the IPv6 source address for all diameter messages sent to IPv6-reachable peers.
When no IPv6 source address is specified, then the source address is determined by:
- router = “management”; use the active management port IP address as configured in the Boot Options File (BOF): bof address ipv6-prefix/ipv6-prefix-length
- router = “Base” or VPRN service ID; use the system interface IP address: configure router interface “system” ipv6 address ipv6-address/prefix-length
Default
no ipv6-source-address
Parameters
ipv6-address: | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D |
origin-host
Syntax
Context
Description
This command configures the origin-realm AVP that will be sent in CER messages and all application based messages. Together with the Origin-Host AVP, these two AVPs form a Diameter Identity.
Parameters
origin-realm
Syntax
Context
Description
This command configures the origin-realm AVP that will be sent in CER messages and all application based messages. Together with the Origin-Host AVP, these two AVPs form a Diameter Identity.
Parameters
peer
Syntax
Context
Description
This command enables the context to configure diameter peer parameters. Up to five diameter peers can be defined inside of a diameter peer policy.
Default
none
Parameters
address
Syntax
Context
Description
This command configures the IPv4 or IPv6 address of the diameter peer.
Parameters
ipv4-address: | a.b.c.d |
ipv6-address: | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D |
destination-host
Syntax
Context
Description
This command configures the destination-host AVP that will be sent in CCR-i/u and RAA messages. If the destination-host is not explicitly set via configuration, it will be learned from CCA or RAR messages. In other words, the origin-host received in the CCA or RAR message will be used to populate or replace the destination-host for the DCAA or GX session in the router.
Parameters
preference
Syntax
Context
Description
This command configured preference per peer. Only the two peers with the highest preference in the peer table are considered for use (primary and secondary). Other peers can be the Open state and they just run keepalives (watchdog-request/answer messages). Once the primary peer fails, the secondary peer will be used as long as the last transaction on it has succeeded (stickiness). Another peer in the Open state will become secondary.Load balancing between peers is not supported.
The no form of the command reverts to the default value.
Default
none
Parameters
transaction-timer
Syntax
Context
Description
This command defines the time-out value for the Base Diameter messages (DWR, CER, DPR). Once the transaction-timer expires, an appropriate action will be taken for each message type.
This timer is used in the following cases:
- Opening the TCP connection (and completing the 3-way handshake) - if the TCP ACK is not received within the time specified by the transaction-timer, the TCP connection is closed and the connection-timer is started waiting for the new connection to be initiated.
- Capability Exchange – if the response to the CER message (CEA) is not received within the time specified by the transaction-timer, the peer connection is closed and the connection-timer is started waiting for the new connection to be initiated.
- Peer disconnect Request- if the response to the DPR message is not received (DPA) within the time specified by the transaction-timer, the peer connection is closed.
- DWR Timeout - if the response to the DWR message is not received (DWA) within the time specified by the transaction-timer, the peer connection is NOT closed. Instead the peer will transition into a peer suspended mode and at the same time the watchdog timer is restarted.
Default
none
Parameters
transport
Syntax
Context
Description
This command defines source tcp port of the connection channel. Only TCP transport is currently supported
Default
3868
Parameters
destination-realm
Syntax
Context
Description
This command configures the destination-realm AVP that will be sent in CCR-i/u and RAA messages. The Destination-Realm cannot be learned dynamically from the CCA or RAR messages and therefore it should be explicitly configured in the router. Once configured, it cannot be changed while peers are open.
Parameters
watchdog-timer
Syntax
Context
Description
This command configures the interval between consecutive watchdog messages. On the first timeout of the DWR, the node will resend the DWR message. The peer is still operation during this time.
On the second timeout, the peer will transition into a suspended mode and the peer-failover procedure will be initiated (if the peer-failover is enabled via configuration). In this state the peer is not used for new transactions. At the same time, the cooldown procedure is started which means that it would take 3 successful DWR/DWA message exchanges to re-instate the peer in a fully operation state.
On the third timeout, the peer is removed and its connection is closed.
This behavior is described in RFC 3539, §3.4.1)
Default
30
Parameters
proxy
Syntax
Context
Description
This command enables the context to configure the diameter peer policy proxy.
mcs-peer
Syntax
Context
Description
This command configures multi-chassis synchronization (MCS) peer (redundant node). The sync-tag identifies Diameter proxies that will participate in synchronization.
The no form of the command reverts to the default.
Default
no mcs-peer
Parameters
router
Syntax
Context
Description
This command configures the IPv4 or IPv6 address and routing context on which the diameter proxy is listening for the client connections.
Default
no router
Parameters
ipv4-address: | a.b.c.d |
ipv6-address: | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D |
python-policy
Syntax
Context
Description
This command specified the python-policy for Diameter messages received or transmitted on the Diameter peers defined in the diameter-peer-policy.
Default
none
Parameters
router
Syntax
Context
Description
This command references the routing instance from which diameter peering is instantiated.
Parameters
router-name — Specifies a router name up to 32 characters to be used in the match criteria.
source-address
Syntax
Context
Description
This command configures the IPv4 source-address that the node will use for peering connections.
Parameters
vendor-support
Syntax
Context
Description
In a diameter peer policy, this command specifies the vendor support announced in the capability exchange. In a Gy diameter application policy, this command specifies the vendor specific attributes for the user sessions.
The no form of the command reverts to the default value.
Default
three-gpp
Parameters
include-avp
Syntax
Context
Description
This command enables the context to configure AVPs and their format to be included in Diameter Gx, Gy or NASREQ application messages.
an-gw-address
Syntax
Context
Description
This command configures the IPv4 address of the node.
called-station-id
Syntax
Context
Description
This command configures the MAC address of AP in WiFi.
Default
no called-station-id
calling-station-id
Syntax
Context
Description
This command includes the calling-station-id AVP in the specified format.
Default
no calling-station-id
Parameters
circuit-id
Syntax
Context
Description
This command includes the Agent-Circuit-Id AVP.
ip-can-type
Syntax
Context
Description
This command includes the ip-can-type.
logical-access-id
Syntax
Context
Description
This command includes the logical-access-id.
nas-port
Syntax
Context
Description
This command specifies the format of the 32 bit string used as value for the Nas-Port AVP.
Default
no nas-port
Parameters
binary-spec | <bit-specification> <binary-spec> | |
bit-specification | 0 | 1 | <bit-origin> | |
bit-origin | *<number-of-bits><origin> | |
number-of-bits | 1 — 32 | |
origin | s | m | p | o | i | v | c | |
s | - slot number | |
m | - MDA number | |
p | - port number or lag-id | |
o | - outer VLAN ID | |
i | - inner VLAN ID | |
v | - ATM VPI | |
c | - ATM VCI | |
nas-port-id
Syntax
Context
Description
This command includes the Nas-Port-Id AVP.
Default
no nas-port-id
Parameters
nas-port-type
Syntax
Context
Description
This command includes the Nas-Port-Type AVP.
Default
no nas-port-type
Parameters
remote-id
Syntax
Context
Description
This command enables the generation of the agent-remote-id for RADIUS.
physical-access-id
Syntax
Context
Description
This command includes the physical access ID.
rat-type
Syntax
Context
Description
This command includes the RAT type.
supported-features
Syntax
Context
Description
This command includes the supported-features.
user-equipment-info
Syntax
Context
Description
This command includes the user-equipment-info.
mac-format
Syntax
Context
Description
This command configures the format of the MAC address when reported in Gx or NASREQ application message AVPs such as Calling-Station-Id or User-Name.
Default
mac-format “aa:”
Parameters
report-ip-address-event
Syntax
Context
Description
This command enables triggered CCR-u messages based on IP address allocation/de-allocation for the subscriber-host.
In case that the requests for both IP address families (IPv4 and IPv6) arrive at approximately the same time, a single CCR-i will be sent containing the IP addresses from both address families - IPv4 and IPv6 (NA, PD or SLAAC). Otherwise, in case that the requests for IP addresses are not nearly simultaneous, the CCR-i will contain only the IP address that was allocated first (the one that triggered the session creation). The request for the second IP address family will, depending on configuration, trigger an additional CCR-u that will carry the IP address allocation update to the PCRF along with the UE_IP_ADDRESS_ALLOCATE (18) event. Apart from that, the CCR-u content should mirror the content of the CCR-i with exception of already allocated IP address(es).
In case that this command is disabled, IP address triggered CCR-u messages will not be sent.
Default
report-ip-addr-event (enabled)
3gpp-ggsn-address
Syntax
Context
Description
This command includes the [10415-7] 3GPP-GGSN-Address AVP in the diameter gy messages. It's value is set to the source IPv4 address that is used for outgoing diameter messages.
Default
3gpp-ggsn-address
3gpp-ggsn-ipv6-address
Syntax
Context
Description
This command includes the [10415-16] 3GPP-GGSN-IPv6-Address AVP in the diameter gy messages. It's value is set to the source IPv6 address that is used for outgoing diameter messages.
Default
no 3gpp-ggsn-ipv6-address
3gpp-imsi
Syntax
Context
Description
This command specifies the origin of the information to send in the DCCA IMSI AVP.
The no form of the command reverts to the default value.
Default
subscriber-id
Parameters
called-station-id
Syntax
Context
Description
This command configures the value of the called station ID AVP.
Default
no called-station-id
Parameters
radius-user-name
Syntax
Context
Description
This command includes the RADIUS user name AVP in the Diameter gy messages.
Default
no radius-user-name
service-context-id
Syntax
Context
Description
This command configure the value of the service context ID AVP.
Default
no service-context-id
Parameters
preference
Syntax
Context
Description
This command configures the preference given to this policy peer with respect to the other peers associated with this policy.
If multiple peers are available for this policy, only the available peer with the highest preference will be used.
If multiple peers with the same preference are available, one of them will be used.
The no form of the command reverts to the default value.
Default
50
Parameters
transaction-timer
Syntax
Context
Description
This command defines the time-out value for the Base Diameter messages (DWR, CER, DPR). Once the transaction-timer expires, an appropriate action will be taken for each message type.
This timer is used in the following cases:
- Opening the TCP connection (and completing the 3-way handshake) - if the TCP ACK is not received within the time specified by the transaction-timer, the TCP connection is closed and the connection-timer is started waiting for the new connection to be initiated.
- Capability Exchange – if the response to the CER message (CEA) is not received within the time specified by the transaction-timer, the peer connection is closed and the connection-timer is started waiting for the new connection to be initiated.
- Peer disconnect Request- if the response to the DPR message is not received (DPA) within the time specified by the transaction-timer, the peer connection is closed.
- DWR Timeout - if the response to the DWR message is not received (DWA) within the time specified by the transaction-timer, the peer connection is NOT closed. Instead the peer will transition into a peer suspended mode and at the same time the watchdog timer is restarted.
Default
none
Parameters
router
Syntax
Context
Description
This command specifies the virtual router in which the diameter connection(s) will be established by this diameter policy.
Parameters
router-instance: | router-name | service-id | |
router-name: | Base, management | |
service-id: | 1 — 2147483647 | |
source-address
Syntax
Context
Description
This command configures the source address.
Default
no source-address; system-ip address is used instead
Parameters
gx
Syntax
Context
Description
This command enables the context to configure Gx parameters.
gy
Syntax
Context
Description
This command enables the context to configure Diameter Credit Control Application or Gy-specific options.
nasreq
Syntax
Context
Description
This command enables the context to configure NASREQ application-specific attributes.
avp-subscription-id
Syntax
Context
Description
This command is used to provide identification information to the PCRF for the end user. Subscription-id is a grouped AVP. In case that parameter designated to be the subscription-id is not available, the subscription-avp will not be sent.
The no form of the command reverts to the default value.
Default
none
avp-subscription-id subscriber-id type private
Parameters
ccrt-replay-interval
Syntax
Context
Description
This command enables sending CCR-t messages for a given Gx session until a valid response (CCA-t) is received or until a 24h period expires, whichever comes first. The purpose of replaying CCR-t message is to ensure that the Gx session is cleared on the PCRF side in case that the peering session to the PCRF was not available at the time when the initial and the first retransmitted CCR-t was sent.
In case that a valid CCA-t response is not received, the system will continue to replay CCR-t messages at configurable interval for the duration of 24 hours.
The subscriber-host behind the Gx session that is in CCR-t replay mode is terminated at the time when the initial CCR-t is sent. This means that all resources associated with the subscriber (queues, DHCP lease states, PPPoE states, etc) are freed. What is left behind in the node is an orphaned Gx session in a replay mode trying to clear itself on the PCRF side.
Default
none
Parameters
out-of-credit-reporting
Syntax
Context
Description
This command changes the reporting reason in an intermediate interrogation when the final granted units have been consumed and a corresponding out-of-credit-action different from "disconnect-host" is started.
The no form of the command reverts to the default value
Default
out-of-credit-reporting final
Parameters
on-failure
Syntax
Context
Description
Behavior of the application’s session in case of a peer failure can be controlled by the Diameter server through two AVPs carried in CCA messages that are defined in RFC4006:
- CC-Session-Failover AVP
- FAILOVER_NOT_SUPPORTED
- FAILOVER_SUPPORTED
- Credit-Control-Failure-Handling AVP
- TERMINATE
- CONTINUE
- RETRY_AND_TERMINATE
In case that those AVPs are not provided by the Diameter server, the local configuration provided by this command will take effect. This command defines the following:
- Peer-failover behavior to a secondary peer in case that the primary peer is unresponsive. The primary peer is considered unresponsive in case that the application message sent to it, times out. The failover mechanism defined by this command is only applicable to CCR messages (and not to RAA messages since there is no response expected).The time out of the message is determined by the tx-timer command.The peer-failover action based on the message timeout is defined per session. In other words, a message timeout for one session cannot cause the failover for some other session.The maximum number of transmissions per session is hardcoded to 2 and the same message is never re-transmitted to the same TCP socket (a TCP socket is defined as a current peering connection defined by the TCP source/destination IP addresses/ports; closing and then reopening a connection to the same peer will result in creation of a new TCP socket). Once the original message for the session times out on the primary peer, the message will be re-transmitted to the secondary peer, provided that the secondary peer is available and the failover is enabled with the corresponding handling mechanism. In case that the secondary peer is unavailable, the original message will not be re-transmitted to the same primary peer again.Once the reply from a peer is received, the session will be tied to that peer until the next timeout. In other words, the session always sticks to the peer from which it received the last response.
- Handling behavior in case that the response from the peer is not received or the peers are not available at all (all peering connections are closed). This behavior is applicable to CCR-i messages in Gx and CCR-i/u messages in Gy. In case of Gx, if the response to a session initiation message (CCR-i) is not received, the fate of the session will depend on the configuration (the session can be terminated or continue to exist with default parameters).
Default
on-failure failover enabled handling terminate
Parameters
tx-timer
Syntax
Context
Description
This command defines the time-out period for the application’s CCR-i/u messages that are waiting for a reply from a peer (message is in a pending state). Peer-failover behavior determines the action that will be taken once the message times out. Peer-failover behavior can be dictated by the PCRF or can be locally configured in the router.
Per RFC 4006, sec 13, Diameter Credit-Control Application, Credit-Control Application Related Parameters, When real-time credit-control is required, the credit-control client contacts the credit-control server before and while the service is provided to an end user. Due to the real-time nature of the application, the communication delays SHOULD be minimized; e.g., to avoid an overly long service setup time experienced by the end user. The Tx timer is introduced to control the waiting time in the client in the Pending state. When the Tx timer elapses, the credit-control client takes an action to the end user according to the value of the Credit-Control-Failure-Handling AVP or Direct-Debiting-Failure-Handling AVP. The recommended value is 10 seconds.
Default
10
Parameters
diameter-application-policy
Syntax
Context
Description
This command associates the specified diameter-application-policy with the processing of the host attachment requests.
Default
none
Parameters
Filter Commands
filter
Syntax
Context
Description
This command manages the configuration of filters.
copy
Syntax
Context
Description
This command copies filters and its entries.
Parameters
dhcp6-filter
Syntax
Context
Description
This command configures the DHCPv6 filter to either bypass ESM host creation or drop DHCPv6 relay-reply messages.
Default
no dhcpv6-filter
Parameters
default-action
Syntax
Context
Description
This command specifies the default action when no entries match.
Parameters
entry
Syntax
Context
Description
This command configures a DHCPv6 filter entry.
Parameters
action
Syntax
Context
Description
This command configures an action for the DHCP6 filter entry.
Parameters
option
Syntax
Context
Description
This command configures the DHCPv6 option to match.
Parameters
ip-filter
Syntax
Context
Description
This command configures an IP filter.
Parameters
ipv6-filter
Syntax
Context
Description
This command configures an IPv6 filter.
Parameters
default-action
Syntax
Context
Description
This command configures default-action for the IP or IPv6 filter.
Parameters
entry
Syntax
Context
Description
This command configures an IP or IPv6 filter entry.
Parameters
action
Syntax
Context
Description
This command configures actions for the IP or IPv6 filter entry.
Parameters
tcp-mss-adjust
Syntax
Context
Description
This command configures the Maximum Segment Size (MSS) adjustment for TCP packets.
The no form of the command disables adjusting TCP MSS values.
log
Syntax
Context
Description
This command configures the log for the IP or IPv6 filter entry.
Parameters
match
Syntax
Context
Description
This command configures the match criteria for the IP or IPv6 filter entry.
Parameters
dscp
Syntax
Context
Description
This command configures DSCP match condition.
dst-ip
Syntax
Context
Description
This command configures the destination IP or IPv6 address match condition.
dst-port
Syntax
Context
Description
This command configures the destination port match condition.
icmp-code
Syntax
Context
Description
This command configures the ICMP code match condition.
icmp-type
Syntax
Context
Description
This command configures the ICMP type match condition.
src-ip
Syntax
Context
Description
This command configures the source IP or IPv6 address match condition.
src-port
Syntax
Context
Description
This command configures the source port match condition.
tcp-ack
Syntax
Context
Description
This command configures the TCP ACK match condition.
tcp-syn
Syntax
Context
Description
This command configures the TCP SYN match condition.
group-inserted-entries
Syntax
Context
Description
This command groups auto-inserted entries.
Parameters
renum
Syntax
Context
Description
This command renumbers an IP or IPv6 filter entry.
Parameters
scope
Syntax
Context
Description
This command configures the scope for the IP or IPv6 filter.
Parameters
shared-radius-filter-wmark
Syntax
Context
Description
This command defines the thresholds that will be used to raise a respective alarm when the number of shared filter copies increases.
Default
no shared-radius-filter-wmark
Parameters
sub-insert-radius
Syntax
Context
Description
This command defines the range of filter entries which will be reserved for entries created based on information (match criteria and action) from RADIUS auth-response messages.
The no version of the command disables the insertion, which means that information from auth-response messages cannot be stored in the filter, and the corresponding host will not be created in the system.
Default
per default insertion is disabled
Parameters
sub-insert-credit-control
Syntax
Context
Description
This command defines the range of filter entries that will be reserved for entries created based on information (match criteria and action) configured under the category-map configuration tree to enforce reduced-service level in case of credit exhaustion.
The no version of the command disables the insertion, which means that entries will not be installed even though the credit for the given category and subscriber-host has been exhausted.
Default
per default insertion is disabled
Parameters
sub-insert-shared-radius
Syntax
Context
Description
This command defines the range of filter entries that will be reserved for shared filter entries received in RADIUS messages.
The no version of the command disables the insertion resulting in a host setup failure when shared filter attributes are received in a RADIUS authentication response.
Default
no sub-insert-shared-radius
Parameters
sub-insert-wmark
Syntax
Context
Description
This command defines the thresholds that will be used to raise a respective alarm to provide monitoring of the resources for subscriber-specific filter insertion.
The no version of the command sets the default values for the respective thresholds.
Default
low - 90%
high - 95%
Parameters
IGMP Policy Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
igmp-policy
Syntax
Context
Description
This command configures an IGMP policy.
Parameters
egress-rate-modify
Syntax
Context
Description
This command is used to apply HQoS Adjustment to a subscriber. HQoS Adjustment is needed when multicast traffic flow for the subscriber is dissociated from subscriber host queues. Multicast redirection is typical such case although it can be applied in direct IPoE subscriber per-sap replication mode.
The channel bandwidth definition policy is defined in the mcac policy under the configure>router>mcac>policy hierarchy. The policy is applied under the redirected interface or under the group-interface.
In order for HQoS Adjustment to take effect, sub-mcac-policy must be in a no shutdown mode and applied under the sub-profile even if mcac is not deployed.
Default
HQoS Adjustment is disabled.
Parameters
import
Syntax
Context
Description
This command specifies the import policy to filter IGMP packets.
Parameters
max-num-groups
Syntax
Context
Description
This command configures the max number of multicast groups.
Parameters
max-num-sources
Syntax
Context
Description
This command configures the maximum number of multicast sources.
The no form of the command disables the command.
Default
no max-num-sources
Parameters
max-num-grp-sources
Syntax
Context
Description
This command configures the maximum number of group sources for which IGMP can have local receiver information based on received IGMP reports on this interface. When this configuration is changed dynamically to a value lower than currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources will not be allowed. When this object has a value of 0, there is no limit to the number of group sources.
The no form of the command removes the value from the configuration.
Default
no max-num-grp-sources
Parameters
mcast-reporting
Syntax
Context
Description
This command configures mcast reporting.
mcast-reporting-dest
Syntax
Context
Description
This command references Multicast Reporting Destination to which IGMP related events are exported.
The Multicast Reporting Destination is referenced with the subscriber itself or within the Host-Tracking-Policy.
Default
no mcast-reporting-dest is referenced.
Parameters
opt-reporting-fields
Syntax
Context
Description
This command will specify optional data relevant to the IGMP event that can be exported. This optional data includes:
- Host MAC address
- PPPoE session-ID
- Service ID
- SAP
Default
Optional data is disabled.
Parameters
Output
sub-mcac-policy
Syntax
Context
Description
This command will create a policy template with mcac bandwidth limits that will be applied to the subscriber.
Per interface mcac bandwidth limits will be set directly under the interface (regular interface or group-interface) and no such policy templates are needed.
The need for a separate policy template for subscribers is due to the fact that sub-groups of subscribers under the group-interface can share certain settings that can be configured via templates.
To summarize, the mcac bandwidth constraints for subscribers are defined in the sub-mcac-policy while the mcac bandwidth constraints for the interface are configured directly under the igmp>interface>mcac or igmp>grp-if>mcac context without the need for policy templates.
| Note:
The sub-mcac-policy only deals with the mcac bandwidth limits and not the channel bandwidth definitions. Channels bandwidth is defined in a different policy (under the configure>router>mcac hierarchy) and that policy is applied on the interface level as follows: |
In case of HQoS Adjustment, it is mandatory that the sub-mcac-policy be created and applied to the subscriber. The sub-mac-policy does not have to contain any bandwidth constrains, but it has to be in a no shutdown state in order for HQoS Adjustment to work.
Default
No sub-mcac-policy is created.
Parameters
sub-mcac-policy
Syntax
Context
Description
This command references the policy template in which the mcac bandwidth limits are defined. Mcac for the subscriber is effectively enabled with this command when the sub-profile is applied to the subscriber. The bandwidth of the channels is defined in a different policy (under the configure>router>mcac hierarchy) and this policy is applied on the interface level as follows:
for regular interfacs under the configure>service/router>igmp>interface>mcac hierarchy
In case of HQoS Adjustment, it is mandatory that the sub-mcac-policy be created and applied to the subscriber. The sub-mac-policy does not have to contain any bandwidth constrains, but it has to be in a no shutdown state in order for HQoS Adjustment to work.
Default
No policy is referenced.
Parameters
version
Syntax
Context
Description
This command configures the version of IGMP.
Parameters
fast-leave
Syntax
Context
Description
This command enables/disables IGMP fast-leave processing.
Default
fast-leave
static
Syntax
Context
Description
This command adds or removes IGMP static group membership.
per-host-replication
Syntax
Context
Description
This command enables per-host-replication in IPoE model. For PPPoX, per-host-replication is the only mode of operation. In the per-host-replication mode, multicast traffic is replicated per each host within the subscriber irrespective of the fact that some hosts may be subscribed to the same multicast stream. As a result, in case that multiple hosts within the subscriber are registered for the same multicast group, the multicast streams of that group will be generated. The destination MAC address of multicast streams will be changed to unicast so that each host receives its own copy of the stream. Multicast traffic in the per-host-replication mode can be classified via the existing QoS CLI structure. As such the multicast traffic will flow through the subscriber queues. HQoS Adjustment is not needed in this case.
The alternative behavior for multicast replication in IPoE environment is per-SAP- replication. In this model, only a single copy of the multicast stream is sent per SAP, irrespective of the number of hosts that are subscribed to the same multicast group. This behavior applies to 1:1 connectivity model as well as on 1:N connectivity model (SAP centric behavior as opposed to subscriber centric behavior).
In the per-SAP-replication model the destination MAC address is multicast (as opposed to unicast in the per-host-replication model). Multicast traffic is flowing via the SAP queue which is outside of the subscriber context. The consequence is that multicast traffic is not accounted in the subscriber HQoS. In addition, HQoS Adaptation is not supported in the per SAP replication model.
Default
By default there is no per host replication and replication is done per SAP. This mode utilizes the SAP queues. With per-host-replication it will allow the use of the subscriber queues. Per-host-replication uses unicast MAC and multicast IP to deliver multicast content to end hosts. This is useful for multi host per SAP cases. To interoperate with end devices that do not support unicast MAC, there is an option to use per-host-replication with a multicast MAC. The traffic will be the same as replication per SAP but the difference of using the subscriber queues.
Parameters
redirection-policy
Syntax
Context
Description
This command will apply multicast redirection action to the subscriber. The redirection action along with the redirected interface (and possibly service id) is defined in the referenced policy-name. IGMP messages will be redirected to an alternate interface if that alternate interface has IGMP enabled. The alternate interface does not have to have any multicast groups registered via IGMP. Currently all IGMP messages are redirected and there is no ability to selectively redirect IGMP messages based on match conditions (multicast-group address, source IP address, etc.). Multicast redirection is supported between VPRN services and also between interfaces within the Global Routing Context. Multicast Redirection is not supported between the VRPN services and the Global Routing Table (GRT).
IGMP state is maintained per subscriber host and per redirected interface. Traffic is however forwarded only on the redirected interface.
Default
none
Parameters
group
Syntax
Context
Description
This command adds or removes a static multicast group.
Parameters
Host Lockout Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
host-key
Syntax
Context
Description
This command specifies the parameters used in host identification for lockout on a given SAP or capture SAP:
no host-key – include (MAC address, Circuit-Id, Remote-Id)
host-key mac – include MAC address only
“host-key mac” should be used in DHCPv4 scenarios where Circuit-Id and Remote-Id are changed with “dhcp option action replace” configuration: a host lockout context is created with the replaced Circuit-Id/Remote-Id; with the default host-key (including Circuit-Id and Remote-Id), lockout does not kick in on the original trigger packet when it is retransmitted by the client.
Changing the host-key to mac should be used with care: all hosts with the same MAC address on a given SAP or capture SAP are identified as a single host with respect to host-lockout.
The host-key command cannot be changed when the host-lockout-policy is referenced (i.e. configured under a SAP context).
Default
no host-key
Parameters
host-lockout-policy
Syntax
Context
Description
This command creates a host lockout policy. The policy contains set of host lockout configuration parameters. It is applied to SAP or MSAPs (by a MSAP-policy). Any change does not impact existing locked-out hosts, but only new incoming hosts that enter lockout.
The no form of the command removes the policy name from the configuration. The policy must not be associated with any entity.
Default
none
Parameters
ies
Syntax
Context
Description
This command enables the context to configure or edit an IES service instance. The ies command is used to create or maintain an Internet Enhanced Service (IES). If the service-id does not exist, a context for the service is created. If the service-id exists, the context for editing the service is entered.
For further information about the vpls command usage, syntax and description, refer to the Layer 3Services Guide.
vpls
Syntax
Context
Description
This command enables the context to configure or edit a Virtual Private LAN Services (VPLS) instance. The vpls command is used to create or maintain a VPLS service. If the service-id does not exist, a context for the service is created. If the service-id exists, the context for editing the service is entered.
For further information about the vpls command usage, syntax and description, refer to the Layer 2 Services Guide.
vprn
Syntax
Context
Description
This command creates or edits a Virtual Private Routed Network (VPRN) service instance. If the service-id does not exist, a context for the service is created. If the service-id exists, the context for editing the service is entered.
For further information about the vprn command usage, syntax and description, refer to the Layer 3Services Guide.
interface
Syntax
Context
Description
This command creates a logical IP routing interface for an Layer 3 service. Once created, attributes like an IP address and service access point (SAP) can be associated with the IP interface.
For further information about the interface command usage, syntax and description, refer to the Layer 3 Services Guide.
Default
none
Parameters
sap
Syntax
Context
Description
This command creates a Service Access Point (SAP) within a service. A SAP is a combination of port and encapsulation parameters which identifies the service access point on the interface and within the router. Each SAP must be unique.
For further information about the sap command usage, syntax and description, refer to the Layer 2 Services Guide and the Layer 3 Services Guide.
cflowd
Syntax
Context
Description
This command enables cflowd to collect traffic flow samples through a router for analysis. cflowd is used for network planning and traffic engineering, capacity planning, security, application and user profiling, performance monitoring, usage-based billing, and SLA measurement. When Triple Play Service Delivery Architecture 7750 SR Triple Play Service Delivery Architecture Page 109 cflowd is enabled at the interface level, all packets forwarded by the interface are subjected to analysis according to the cflowd configuration.
Default
no cflowd
Parameters
host-lockout-policy
Syntax
Context
Description
This command selects an existing host lockout policy. The host-lockout-policy policy-name is created in the config>subscriber-mgmt context.
The no form of the command removes the policy name from the SAP configuration.
Default
none
Parameters
lockout-time
Syntax
Context
Description
This command configures the time for which a client stays in the lockout state during which authentication and ESM host creation is suppressed. The range for the min and max lockout times is 1 second to 86400 seconds. The min time defaults to 10 seconds, and max time defaults to 3600 seconds.
The no form of the command reverts to the default value.
Parameters
lockout-reset-time
Syntax
Context
Description
This command configures the time that needs to elapse from the point a client enters lockout to when the client’s lockout time can be reset to the configured minimum value. The range is 1 sec
The no form of the command reverts to the default value.
Parameters
max-lockout-hosts
Syntax
Context
Description
When a client enters lockout, authentication and ESM host creation is suppressed. A lightweight context maintains the lockout state and the timeouts for the client in lockout. This command allows the number of lockout contexts to be configured per SAP. If the number of existing contexts reaches the configured count, incoming hosts that fail authentication or creation are not subject to lockout, and are retired as normal.
The no form of the command reverts to the default value.
Parameters
host-tracking-policy
Syntax
Context
Description
This command configures a host tracking policy. IGMP host tracking is an option in the subscriber profile that allows the factoring in of a subscriber’s (multicast) video traffic by reducing the unicast operational egress aggregate rate or the rate of the scheduler specified in the ANCP policy to account for a subscriber’s multicast traffic. If no ANCP policy is defined, the egress aggregate rate configured in the subscriber profile is reduced. If an ANCP policy is defined, the “rate-modify” parameter in the policy specifies whether the egress aggregate rate or the rate of the egress policer specified in the policy is to be reduced to account for the subscriber’s multicast traffic.
Default
disabled
egress-rate-modify
Syntax
Context
Description
This command specifies the egress-rate modification that is to be applied.
Parameters
PIM Policy Commands
pim-policy
Syntax
Context
Description
This command creates a PIM policy or enables the context to configure a PIM policy.
The no form of this command deletes the specified PIM policy.
Default
none
Parameters
Managed SAP Policy Commands
msap-policy
Syntax
Context
Description
This command configures a managed SAP policy. Managed SAPs allow the use of policies and a SAP template for the creation of a SAP.
Default
none
Parameters
cpu-protection
Syntax
Context
Description
This command enables the context to configure CPU protection policies.
cpu-protection
Syntax
Context
Description
This command assigns an existing CPU protection policy to the SAP or interface.
CPU protection policies are configured in the config>sys>security>cpu-protection context.
The no form of the command removes the policy ID from the SAP or interface configuration.
Default
none
Parameters
cpu-protection
Syntax
Context
Description
This command assigns an existing CPU protection policy to the SAP or interface.
CPU protection policies are configured in the config>sys>security>cpu-protection context.
The no form of the command removes the policy ID from the SAP or interface configuration.
Default
none
Parameters
default-host
Syntax
Context
Description
This command configures the default-host to be used. More than one default-host can be configured per SAP.
The no form of the command removes the values from the configuration.
Parameters
dist-cpu-protection
Syntax
Context
Description
This command assigns a Distributed CPU Protection (DCP) policy to the MSAP policy. The DCP policy will automatically get assigned to any MSAPs created with this policy. A non-existant DCP policy can be assigned to an msap-policy since an msap-policy is effectively a template that gets applied at some point in the future during msap creation. The existence of the DCP policy will be validated at the time that the msap is created, and the msap creation will be blocked (and an appropriate log event created) if the DCP policy does not exist.
| Note:
For other types of objects (for example, normal non-msap SAPs and network interfaces) the DCP policy must exist before it can be assigned to the SAP. |
Default
no dist-cpu-protection
ies-vprn-only-sap-parameters
Syntax
Context
Description
This command configures Managed SAP IES and VPRN properties. VPRN is supported on the 7750 SR only.
igmp-host-tracking
Syntax
Context
Description
This command enables the context to configure IGMP host tracking parameters.
disable-router-alert-check
Syntax
Context
Description
This command enables the IGMP router alert check option.
The no form of the command disables the router alert check.
This command only applies to the 7750 SR.
expiry-time
Syntax
Context
Description
This command configures the time that the system continues to track inactive hosts.
The no form of the command removes the values from the configuration.
Default
no expiry-time
Parameters
import
Syntax
Context
Description
This command specifies the import routing policy to be used for IGMP packets to be used on this SAP or SDP. Only a single policy can be imported on a single SAP at any time.
The no form of the command removes the policy association from the SAP or SDP.
Default
no import (No import policy is specified)
Parameters
max-num-group
Syntax
Context
Description
This command configures the maximum number of multicast groups allowed to be tracked.
The no form of the command removes the values from the configuration.
Default
no max-num-groups
Parameters
max-num-sources
Syntax
Context
Description
This command configures the maximum number of multicast sources allowedto be tracked per group.
The no form of the command removes the value from the configuration.
Parameters
max-num-grp-sources
Syntax
Context
Description
This command configures the maximum number of group sources for which IGMP can have local receiver information based on received IGMP reports on this interface. When this configuration is changed dynamically to a value lower than currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources will not be allowed. When this object has a value of 0, there is no limit to the number of group sources.
The no form of the command removes the value from the configuration.
Default
no max-num-grp-sources
Parameters
lag-link-map-profile
Syntax
Context
Description
This command assigns a pre-configured lag link map profile to a SAP/network interface configured on a LAG or a PW port that exists on a LAG. Once assigned/de-assigned, the SAP/network interface egress traffic will be re-hashed over LAG as required by the new configuration.
The no form of this command reverts the SAP/network interface to use per-flow, service or link hash as configured for the service/LAG.
Default
no lag-link-map-profile
Parameters
sticky
Syntax
Context
Description
This command prevents MSAPs associated with the specified MSAP policy from being deleted unless a manual clear command is issued. If this command is not enabled, an MSAP is deleted when a host creation fails or when a subscriber is no longer associated with the MSAP, for example, when a subscriber ends the session. This feature is useful for an operator who wants to keep historical statistics records on MSAPs. It can also speed up host creation on an MSAP since the MSAP is already created.
Default
no sticky
sub-sla-mgmt
Syntax
Context
Description
This command enables the context to configure subscriber management parameters for an MSAP.
Default
no sub-sla-mgmt
def-app-profile
Syntax
Context
Description
This command specifies the application profile to be used by a subscriber host.
The no form of the command removes the application profile name from the configuration.
Default
no def-app-profile
Parameters
def-inter-dest-id
Syntax
Context
Description
This command specifies a default destination string for all subscribers associated with the SAP. The command also accepts the use-top-q flag that automatically derives the string based on the top most delineating Dot1Q tag from the SAP’s encapsulation.
The no form of the command removes the default subscriber identification string from the configuration.
no def-sub-id
Default
no def-inter-dest-id
Parameters
def-sub-id
Syntax
Context
Description
This command specifies the explicit default sub-id for dynamic subscriber hosts (including ARP hosts) in case that the sub-id string is NOT supplied through RADIUS or LUDB.
The sub-id is assigned to a new subscriber host in the following order of priority:
- RADIUS
- LUDB
- Explicit default – with the def-sub-id command we explicitly set the sub-id name of the host to be one of the following:
- The sap-id to which the new host is associated with
- Explicit string
- Auto-generated string consisting of the concatenated subscriber identification fields defined under the subscr-mgmt>auto-sub-id-key node. The fields are taken in the order in which they are configured and are separated by a ‘|‘character. The subscriber host identification fields are separately defined for IPoE and PPPoE host types.
- Implicit default – in case that the sub-id string is not returned via RADIUS or LUDB and there is no def-sub-id configured, the sub-id name will be generated as a random 10 character encoded string based on the auto-sub-id-keys. This 10 characters encoded string will be unique per chassis as well as in dual-homed environment. It is generated based on auto-sub-id-keys. If auto-sub-id-keys are not explicitly configured, the default ones are:
- <mac, sap-id, session-id> for PPP type hosts
- <mac, sap-id> for IPoE type hosts.
This command does not apply to static subscribers.
Parameters
<mac, sap-id, session-id>for PPPoE type hosts
<mac, sap-id>for IPoE type hosts
def-sla-profile
Syntax
Context
Description
This command specifies a default SLA profile for an MSAP.
An SLA profile is a named group of QoS parameters used to define per service QoS for all subscriber hosts common to the same subscriber within a provider service offering. A single SLA profile may define the QoS parameters for multiple subscriber hosts.
The no form of the command removes the default SLA profile from the MSAP configuration.
Default
no def-sla-profile
Parameters
def-sub-profile
Syntax
Context
Description
This command specifies a default subscriber profile for an MSAP.
A subscriber profile defines the aggregate QoS for all hosts within a subscriber context. This is done through the definition of the egress and ingress scheduler policies that govern the aggregate SLA for subscriber using the subscriber profile.
The no form of the command removes the default SLA profile from the SAP configuration.
Parameters
multi-sub-sap
Syntax
Context
Description
This command defines the maximum number of subscribers (dynamic + static) that can be simultaneously active on an MSAP.
If the limit is reached, a new host will be denied access and the corresponding DHCP ACK will be dropped.
The no form of the command reverts back to the default setting.
Default
1
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
single-sub-parameters
Syntax
Context
Description
This command enables the context to configure single subscriber MSAP parameters.
non-sub-traffic
Syntax
Context
Description
This command configures traffic profiles for non-IP traffic such as PPPoE.It is used in conjunction with the profiled-traffic-only on single subscriber SAPs and creates a subscriber host which is used to forward non-IP traffic through the single subscriber SAP without the need for SAP queues.
The no form of the command removes any configured profile.
Default
no non-sub-traffic
Parameters
profiled-traffic-only
Syntax
Context
Description
This command specifies whether only profiled traffic is applicable for an MSAP. When enabled, all queues will be deleted.
The no form of the command reverts to the default setting.
Default
no profiled-traffic-only
sub-ident-policy
Syntax
Context
Description
This command specifies an existing subscriber identification policy. Each subscriber identification policy can have a default subscriber profile defined. The subscriber identification policy default subscriber profile overrides the system default and the subscriber SAP default subscriber profiles. Defining a subscriber identification policy default subscriber profile is optional.
Defining a subscriber profile as a subscriber identification policy default subscriber profile will cause all active subscribers currently associated with a subscriber SAP using the policy and associated with a subscriber policy through the system default or subscriber SAP default subscriber profiles to be reassigned to the subscriber policy defined as default on the subscriber identification policy.
Attempting to delete a subscriber profile that is currently defined as a default for a subscriber identification policy will fail.
When attempting to remove a subscriber identification policy default subscriber profile definition, the system will evaluate each active subscriber on all subscriber SAPs the subscriber identification policy is currently associated with that are using the default definition to determine whether the active subscriber can be either reassigned to a subscriber SAP default or the system default subscriber profile. If all active subscribers cannot be reassigned, the removal attempt will fail.
Parameters
vpls-only-sap-parameters
Syntax
Context
Description
This command enables the context to configure MSAP VPLS properties.
arp-host
Syntax
Context
Description
This command enables the context to configure ARP host parameters.
host-limit
Syntax
Context
Description
This command configures the maximum number of ARP hosts.
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
min-auth-interval
Syntax
Context
Description
This command configures the minimum authentication interval.
Parameters
sap-host-limit
Syntax
Context
Description
This command configures the maximum number of ARP hosts per SAP.
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
arp-reply-agent
Syntax
Context
Description
This command enables a special ARP response mechanism in the system for ARP requests destined to static or dynamic hosts associated with the SAP. The system responds to each ARP request using the hosts MAC address as the both the source MAC address in the Ethernet header and the target hardware address in the ARP header.
ARP replies and requests received on an MSAP with arp-reply-agent enabled will be evaluated by the system against the anti-spoof filter entries associated with the ingress SAP (if the SAP has anti-spoof filtering enabled). ARPs from unknown hosts on the SAP will be discarded when anti-spoof filtering is enabled.
The ARP reply agent only responds if the ARP request enters an interface (SAP, spoke-SDP or mesh-SDP) associated with the VPLS instance of the MSAP.
A received ARP request that is not in the ARP reply agent table is flooded to all forwarding interfaces of the VPLS capable of broadcast except the ingress interface while honoring split-horizon constraints.
Static hosts can be defined using the host command. Dynamic hosts are enabled on the system by enabling the lease-populate command in the dhcp context. In the event that both a static host and a dynamic host share the same IP and MAC address, the VPLS ARP reply agent will retain the host information until both the static and dynamic information are removed. In the event that both a static and dynamic host share the same IP address, but different MAC addresses, the VPLS ARP reply agent is populated with the static host information.
The arp-reply-agent command will fail if an existing static host does not have both MAC and IP addresses specified. Once the ARP reply agent is enabled, creating a static host on the MSAP without both an IP address and MAC address will fail.
The ARP-reply-agent may only be enabled on SAPs supporting Ethernet encapsulation.
The no form of the command disables ARP-reply-agent functions for static and dynamic hosts on the MSAP.
Default
not enabled
Parameters
Hosts are identified by their subscriber information. For DHCP subscriber hosts, the subscriber hosts, the subscriber information is configured using the optional subscriber parameter string.
When arp-reply-agent is enabled with sub-ident:
- If the subscriber information for the destination host exactly matches the subscriber information for the originating host and the destination host is known on the same MSAP as the source, the ARP request is silently discarded.
- If the subscriber information for the destination host or originating host is unknown or undefined, the source and destination hosts are not considered to be the same subscriber. The ARP request is forwarded outside the MSAP’s Split Horizon Group.
- When sub-ident is not configured, the arp-reply-agent does not attempt to identify the subscriber information for the destination or originating host and will not discard an ARP request based on subscriber information.
dhcp
Syntax
Context
Description
This command enables the context to configure DHCP parameters.
option
Syntax
Context
Description
This command enables DHCP Option 82 (Relay Agent Information Option) parameters processing and enters the context for configuring Option 82 sub-options.
The no form of this command returns the system to the default.
Default
no option
action
Syntax
Context
Description
This command configures the Relay Agent Information Option (Option 82) processing.
The no form of this command returns the system to the default value.
Default
The default is to keep the existing information intact.
Parameters
circuit-id
Syntax
Context
Description
When enabled, the router sends an ASCII-encoded tuple in the circuit-id sub-option of the DHCP packet. This ASCII-tuple consists of the access-node-identifier, service-id, and SAP-ID, separated by “|”.
If disabled, the circuit-id sub-option of the DHCP packet will be left empty.
The no form of this command returns the system to the default.
Default
circuit-id
Parameters
vendor-specific-option
Syntax
Context
Description
This command configures the Alcatel-Lucent vendor specific sub-option of the DHCP relay packet.
client-mac-address
Syntax
Context
Description
This command enables the sending of the MAC address in the Alcatel-Lucent vendor specific sub-option of the DHCP relay packet.
The no form of the command disables the sending of the MAC address in the Alcatel-Lucent vendor specific sub-option of the DHCP relay packet.
sap-id
Syntax
Context
Description
This command enables the sending of the SAP ID in the Alcatel-Lucent vendor specific sub-option of the DHCP relay packet.
The no form of the command disables the sending of the SAP ID in the Alcatel-Lucent vendor specific sub-option of the DHCP relay packet.
service-id
Syntax
Context
Description
This command enables the sending of the service ID in the Alcatel-Lucent vendor specific sub-option of the DHCP relay packet.
The no form of the command disables the sending of the service ID in the Alcatel-Lucent vendor specific sub-option of the DHCP relay packet.
string
Syntax
Context
Description
This command specifies the string in the Alcatel-Lucent vendor specific sub-option of the DHCP relay packet.
The no form of the command returns the default value.
Parameters
system-id
Syntax
Context
Description
This command specifies whether the system-id is encoded in the Alcatel-Lucent vendor specific sub-option of Option 82.
emulated-server
Syntax
Context
Description
This command configures the IP address which will be used as the DHCP server address in the context of the MSAP. Typically, the configured address should be in the context of the subnet represented by the service.
The no form of this command reverts to the default setting. The local proxy server will not become operational without the emulated-server address being specified.
Parameters
lease-time
Syntax
Context
Description
This command defines the length of lease-time that will be provided to DHCP clients. By default the local-proxy-server will always make use of the lease-time information provide by either a RADIUS or DHCP server.
The no form of this command disables the use of the lease-time command. The local-proxy-server will use the lease-time offered by either a RADIUS or DHCP server.
Default
7 days 0 hours 0 seconds
Parameters
egress
Syntax
Context
Description
This command configures egress policies for MSAPs.
multicast-group
Syntax
Context
Description
This command specifies an existing egress multicast group (EMG). An EMG is created as an object used to group VPLS SAPs that are allowed to participate in efficient multicast replication (EMR). EMR is a method to increase the performance of egress multipoint forwarding by sacrificing some destination-based features. Eliminating the requirement to perform unique features for each destination allows the egress forwarding plane to chain together multiple destinations into a batch replication process. In order to perform this batch replication function, similar characteristics are required on each SAP within the EMG.
Only SAPs defined on Ethernet access ports are allowed into an egress-multicast-group.
In order to understand the purpose of an egress-multicast-group, an understanding of the system’s use of flooding lists is required. A flooding list is maintained at the egress forwarding plane to define a set of destinations to which a packet must be replicated. Multipoint services make use of flooding lists to enable forwarding a single packet to many destinations. Examples of multipoint services that use flooding lists are VPLS, IGMP snooping and IP multicast routing. Currently, the egress forwarding plane will only use efficient multicast replication for VPLS and IGMP snooping flooding lists.
In VPLS services, a unique flooding list is created for each VPLS context. The flooding list is used when a packet has a broadcast, multicast or unknown destination MAC address. From a system perspective, proper VPLS handling requires that a broadcast, multicast or unknown destined packet be sent to all destinations that are in the forwarding state. The ingress forwarding plane ensures the packet gets to all egress forwarding planes that include a destination in the VPLS context. It is the egress forwarding plane’s job to replicate the packet to the subset of the destinations that are reached through its interfaces and each of these destinations are included in the VPLS context’s flooding list.
For IGMP snooping, a unique flooding list is created for each IP multicast (s,g) record. This (s,g) record is associated with an ingress VPLS context and may be associated with VPLS destinations in the source VPLS instance or other VPLS instances (in the case of MVR). Again, the ingress forwarding plane ensures that an ingress IP multicast packet matching the (s,g) record gets to all egress forwarding planes that have a VPLS destination associated with the (s,g) record. The egress forwarding plane uses the flooding list owned by the (s,g) record to replicate the packet to all VPLS destinations in the flooding list. The IGMP Snooping function identifies which VPLS destinations should be associated with the (s,g) record.
With normal multicast replication, the egress forwarding plane examines which features are enabled for each destination. This includes ACL filtering, mirroring, encapsulation and queuing. The resources used to perform this per destination multicast processing are very expensive to the egress forwarding plane when high replication bandwidth is required. If destinations with similar egress functions can be grouped together, the egress forwarding plane can process them in a more efficient manner and maximize replication bandwidth.
The egress-multicast-group object is designed to allow the identification of SAPs with similar egress characteristics. When a SAP is successfully provisioned into an egress-multicast-group, the system is ensured that it may be batched together with other SAPs in the same group at the egress forwarding plane for efficient multicast replication. A SAP that does not meet the common requirements is not allowed into the egress-multicast-group.
At the forwarding plane level, a VPLS flooding list is categorized into chainable and non-chainable destinations. Currently, the only chainable destinations are SAPs within an egress-multicast-group. The chainable destinations are further separated by egress-multicast-group association. Chains are then created following the rules below:
- A replication batch chain may only contain SAPs from the same egress-multicast-group
- A replication batch chain length may not exceed the dest-chain-limit of the egress-multicast-group to which the SAPs are members
Further subcategories are created for an IGMP (s,g) flooding list. A Layer 2 (s,g) record is created in a specific VPLS instance (the instance the (s,g) flow ingresses). SAPs within that VPLS context that join the (s,g) record are considered native SAPs within the flooding list. SAPs that join the (s,g) flooding list through the multicast VPLS registration process (MVR) from another VPLS context using the from-vpls command are considered alien SAPs. The distinction between native and alien in the list is maintained to allow the forwarding plane to enforce or suspend split-horizon-group (SHG) squelching. When the source of the (s,g) matching packet is in the same SHG as a native SAP, the packet must not be replicated to that SAP. For a SAP in another VPLS context, the source SHG of the packet has no meaning and the forwarding plane must disregard SHG matching between the native source of the packet and the alien destination. Because the SHG squelch decision is done for the whole chain based on the first SAP in the chain, all SAPs in the chain must be all native or all alien SAPs. Chains for IGMP (s,g) flooding lists are created using the following rules:
- A replication batch chain may only contain SAPs from the same egress-multicast-group.
- A replication batch chain may only contain all alien or all native SAPs.
- A replication batch chain length may not exceed the dest-chain-limit of the egress-multicast-group to which the SAPs are members
When a packet associated with a flooding list is received by the egress forwarding plane, it processes the packet by evaluating each destination on the list sequentially in a replication context. If the current entry being processed in the list is a non-chained destination, the forwarding plane processes the packet for that destination and then moves on to process other packets currently in the forwarding plane before returning to process the next destination in the list. If the current entry being processed is a chained destination, the forwarding plane remains in the replication context until it has forwarded to each entry in that chain. Once the replication context finishes with the last entry in the chain, it moves on to process other packets waiting for egress processing before returning to the replication context. Processing continues in this manner until the packet has been forwarded to all destinations in the list.
Batch chain processing of a chain of SAPs improves replication efficiency by bypassing the functions that perform egress mirroring decisions on SAPs within the chain and making a single ACL filtering decision for the whole chain. Each destination in the chain may have a unique egress QoS policy and per destination queuing is still performed for each destination in the chain. Also, while each SAP in the chain must be on access ports with the same encap-type, if the encap-type is dot1q, each SAP may have a unique dot1q tag.
One caveat to each SAP having a unique egress QoS policy in the chain is that only the Dot1P marking decisions for the first SAP in the list is enforced. If the first SAP’s QoS policy forwarding class action states that the packet should not be remarked, none of the replicated packets in the chain will have the dot1P bits remarked. If the first SAP’s QoS policy forwarding class action states that the packet should be remarked with a specific dot1P value, all the replicated packets for the remaining SAPs in the chain will have the same dot1P marking.
While the system supports 32 egress multicast groups, a single group would usually suffice. An instance where multiple groups would be needed is when all the SAPs requiring efficient multicast replication cannot share the same common requirements. In this case, an egress multicast group would be created for each set of common requirements. An egress multicast group may contain SAPs from many different VPLS instances. It should be understood that an egress multicast group is not equivalent to an egress forwarding plane flooding list. An egress multicast group only identifies which SAPs may participate in efficient multicast replication. As stated above, entries in a flooding list are populated due to VPLS destination creation or IGMP snooping events.
The no form of the command removes a specific egress multicast group. Deleting an egress multicast group will only succeed when the group has no SAP members. To remove SAP members, use the no multicast-group group-name command under each SAP’s egress context.
| Note:
Efficient multicast replication will only be performed on IOMs that support chassis mode b If an IOM does not support mode b operation, egress-multicast-group membership is ignored on that IOM’s egress forwarding planes. The chassis need not be placed into mode b for efficient multicast replication to be performed on the capable IOMs. |
Parameters
igmp-snooping
Syntax
Context
Description
This command enables the Internet Group Management Protocol (IGMP) snooping context.
Default
none
fast-leave
Syntax
Context
Description
This command enables fast leave.
When IGMP fast leave processing is enabled, the 7450 ESS or 7750 SR will immediately remove a SAP or SDP from the IP multicast group when it detects an IGMP 'leave' on that SAP or SDP. Fast leave processing allows the switch to remove a SAP or SDP that sends a 'leave' from the forwarding table without first sending out group-specific queries to the SAP or SDP, and thus speeds up the process of changing channels ('zapping').
Fast leave should only be enabled when there is a single receiver present on the SAP or SDP.
When fast leave is enabled, the configured last-member-query-interval value is ignored.
Default
no fast-leave
import
Syntax
Context
Description
This command specifies the import routing policy to be used for IGMP packets to be used on this SAP or SDP. Only a single policy can be imported on a single SAP at any time.
The no form of the command removes the policy association from the SAP or SDP.
Default
no import (No import policy is specified)
Parameters
last-member-query-interval
Syntax
Context
Description
This command configures the maximum response time used in group-specific queries sent in response to 'leave' messages, and is also the amount of time between 2 consecutive group-specific queries. This value may be tuned to modify the leave latency of the network. A reduced value results in reduced time to detect the loss of the last member of a group.
The configured last-member-query-interval is ignored when fast-leave is enabled on the SAP or SDP.
Default
10
Parameters
max-num-groups
Syntax
Context
Description
This command defines the maximum number of multicast groups that can be joined on an MSAP or SDP. If the router receives an IGMP join message that would exceed the configured number of groups, the request is ignored.
Default
no max-num-groups
Parameters
mcac
Syntax
Context
Description
This command enables the context to configure multicast CAC parameters.
Default
none
if-policy
Syntax
Context
Description
This command assigns an existing MCAC interface policy to this MSAP policy.
The no form of the command removes the MCAC interface policy association.
Default
no if-policy
Parameters
mc-constraints
Syntax
Context
Description
This command enables the context to configure the level and its associated bandwidth for a bundle or a logical interface.
Default
none
level
Syntax
Context
Description
This command configures levels and their associated bandwidth for multicast CAC policy on an interface.
Parameters
number-down
Syntax
Context
Description
This command configures the number of ports down along with level for multicast CAC policy on an MSAP
Parameters
policy
Syntax
Context
Description
This command configures the multicast CAC policy name.
Parameters
unconstrained-bw
Syntax
Context
Description
This command configures the bandwidth for the interface's multicast CAC policy traffic. When disabled (no unconstrained-bw) there will be no checking of bandwidth constraints on the interface level. When enabled and a policy is defined, enforcement is performed. The allocated bandwidth for optional channels should not exceed the unconstrained-bw minus the mandatory-bw and the mandatory channels have to stay below the specified value for the mandatory-bw. After this interface check, the bundle checks are performed.
Parameters
If the bandwidth value is 0, no mandatory channels are allowed. If the value of bandwidth is '-1', then all mandatory and optional channels are allowed.
If the value of mandatory-bw is equal to the value of bandwidth, then all the unconstrained bandwidth on a given interface is allocated to mandatory channels configured through multicast CAC policy on that interface and no optional groups (channels) are allowed.
The value of mandatory-bw should always be less than or equal to that of bandwidth, An attempt to set the value of mandatory-bw greater than that of bandwidth, will result in inconsistent value error.
use-lag-port-weight
Syntax
Context
Description
This command enables port weight to be used when determining available bandwidth per level when LAG ports go down/come up. The command is required for proper operation on mixed port-speed LAGs and can be used for non-mixed port-speed LAGs as well.
Default
no use-lag-port-weight
port number is used when determining available BW per level when LAG ports go down/come up
sub-mcac-policy
Syntax
Context
Description
This command will create a policy template with mcac bandwidth limits that will be applied to the subscriber.
Per interface mcac bandwidth limits will be set directly under the interface (regular interface or group-interface) and no such policy templates are needed.
The need for a separate policy template for subscribers is due to the fact that groups of subscribers under the same group-interface can share certain settings that can be configured via this template.
To summarize, the mcac bandwidth constraints for subscribers are defined in the sub-mcac-policy while the mcac bandwidth constraints for the interface are configured directly under the igmp>interface>mcac or igmp>grp-if>mcac context without the need for policy templates.
| Note:
The sub-mcac-policy only deals with the mcac bandwidth limits and not the channel bandwidth definitions. Channels bandwidth is defined in a different policy (under the configure>router>mcac hierarchy) and that policy is applied on the interface level as follows:
|
In case of HQoS Adjustment, it is mandatory that the sub-mcac-policy be created and applied to the subscriber. The sub-mac-policy does not have to contain any bandwidth constrains, but it has to be in a no shutdown state in order for HQoS Adjustment to work.
Parameters
mvr
Syntax
Context
Description
This command enables the context to configure Multicast VPLS Registration (MVR) parameters.
from-vpls
Syntax
Context
Description
This command configures the VPLS from which multicast traffic is copied upon receipt of an IGMP join request.
IGMP snooping must be enabled on the MVR VPLS.
Default
no from-vpls
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum(applies only to the 7750 SR) |
query-interval
Syntax
Context
Description
This command configures the IGMP query interval. If the send-queries command is enabled, this parameter specifies the interval between two consecutive general queries sent by the system on an MSAP or SDP.
The configured query-interval must be greater than the configured query-response-interval.
If send-queries is not enabled on an MSAP or SDP, the configured query-interval value is ignored.
Default
125
Parameters
query-response-interval
Syntax
Context
Description
This command configures the IGMP query response interval. If the send-queries command is enabled, this parameter specifies the maximum response time advertised in IGMPv2/v3 queries.
The configured query-response-interval must be smaller than the configured query-interval.
If send-queries is not enabled on an MSAP or SDP, the configured query-response-interval value is ignored.
Default
10
Parameters
robust-count
Syntax
Context
Description
This command configures the IGMP robustness variable. If the send-queries command is enabled, this parameter allows tuning for the expected packet loss on a SAP or SDP. The robust-count variable allows tuning for the expected packet loss on a subnet and is comparable to a retry count. If an MSAP or SDP is expected to be “lossy”, this parameter may be increased. IGMP snooping on an MSAP or SDP is robust to (robust-count-1) packet losses.
If send-queries is not enabled, this parameter will be ignored.
Default
2
Parameters
send-queries
Syntax
Context
Description
This command specifies whether to send IGMP general query messages on the managed SAP. When send-queries is configured, all type of queries generate ourselves are of the configured version. If a report of a version higher than the configured version is received, the report will get dropped and a new wrong version counter will get incremented.
If send-queries is not configured, the version command has no effect. The version used on that SAP/SDP will be the version of the querier. This implies that, for example, when there is a v2 querier, a v3 group or group-source specific query is never sent when a host wants to leave a certain group.
Default
no send-queries
version
Syntax
Context
Description
This command specifies the version of IGMP which is running on an MSAP. This object can be used to configure a router capable of running either value. For IGMP to function correctly, all routers on a LAN must be configured to run the same version of IGMP on that LAN.
When the send-query command is configured, all type of queries generate ourselves are of the configured version. If a report of a version higher than the configured version is received, the report gets dropped and a new “wrong version” counter is incremented.
If the send-query command is not configured, the version command has no effect. The version used on that SAP or SDP will be the version of the querier. This implies that, for example, when there is a v2 querier, a v3 group or group-source specific query when a host wants to leave a certain group will never be sent.
Parameters
mac-da-hashing
Syntax
Context
Description
This command specifies whether subscriber traffic egressing a LAG SAP has its egress LAG link selected by a function of the MAC destination address instead of the subscriber ID.
This command is only meaningful if subscriber management is enabled and can be configured for a VPLS service.
split-horizon-group
Syntax
Context
Description
This command specifies the name of the split horizon group to which the MSAP belongs.
default-msap-policy
Syntax
Context
Description
This command specifies the default managed SAP policy to use to create MSAPs when the response from the RADIUS server does not specify a managed SAP policy.
The policy-name parameter is only valid for a SAP with the keywords capture-sap specified in the SAP’s configuration. The capture-sap keyword in the SAP configuration captures the SAP where triggering packets will be sent to the CPM. Non-triggering packets captured by the capture SAP will be dropped.
The managed SAP policy must already be defined in the config>subscr-mgmt>msap-policy context
The no form of the command removes the policy-name from the configuration.
Default
no default-msap-policy
Parameters
trigger-packet
Syntax
Context
Description
This command enables triggering packet to initiate RADIUS authentication that provides a service context. The authentication, together with the service context for this request, creates a managed SAP. The VLAN is the same as the triggering packet. This SAP behaves as a regular SAP but the configuration is not user-editable and not maintained in the configuration file. The managed SAP remains active as long as the session is active.
Default
none
Parameters
allow-dot1q-msaps
Syntax
Context
Description
This command enables support for single tagged traffic triggering managed SAP creation on a qinq encapsulated capture SAP.
With this command enabled, a single tagged trigger packet received on a qinq encapsulated capture SAP (x/y/z:*.* or x/y/z:tag.*) can trigger the creation of an x/y/z:tag.0 managed SAP (MSAP).
With this command disabled (default), a single tagged trigger packet received on a qinq encapsulated capture SAP (x/y/z:*.* or x/y/z:tag.*) is dropped as “Invalid QTag”.
This command cannot be enabled on:
- a dot1q encapsulated capture-sap
- an inverse capture sap (x/y/z:*.tag)
Default
no allow-dot1q-msaps
Multi-Chassis Redundancy Commands
redundancy
Syntax
Context
Description
This command allows the user to perform redundancy operations.
Parameters
now | keyword - switch to standby CPM) |
| Note:
Switching to the standby displays the following message. WARNING: Configuration and/or Boot options may have changed since the last save. Are you sure you want to switchover (y/n)? |
synchronize
Syntax
Context
Description
This command performs a synchronization of the standby CPM images and/or config files to the active CPM. Either the boot-env or config parameter must be specified.
In the config>redundancy context, this command performs an automatically triggered standby CPM synchronization.
When the standby CPM takes over operation following a failure or reset of the active CPM, it is important to ensure that the active and standby CPM have identical operational parameters. This includes the saved configuration, CPM and IOM images.
The active CPM ensures that the active configuration is maintained on the standby CPM. However, to ensure smooth operation under all circumstances, runtime images and system initialization configurations must also be automatically synchronized between the active and standby CPM.
If synchronization fails, alarms and log messages that indicate the type of error that caused the failure of the synchronization operation are generated. When the error condition ceases to exist, the alarm is cleared.
Only files stored on the router are synchronized. If a configuration file or image is stored in a location other than on a local compact flash, the file is not synchronized (for example, storing a configuration file on an FTP server).
Default
enabled
Parameters
multi-chassis
Syntax
Context
Description
This command enables the context to configure multi-chassis parameters.
peer
Syntax
Context
Description
This command creates a new multi-chassis redundancy peer or enables the context to configure an existing peer.
The peer address can be either an IPv4 address or an IPv6 address. If an IPv6 address is used, the following MCS clients are not supported:
- mc-endpoint
- l2tp
- python
Default
none
Parameters
authentication-key
Syntax
Context
Description
This command configures the authentication key used between this node and the multi-chassis peer. The authentication key can be any combination of letters or numbers.
Parameters
mc-ipsec
Syntax
Context
Description
This command enters the configuration context of multi-chassis IPSec.
discovery-interval
Syntax
Context
Description
This command specifies the time interval of tunnel-group stays in “Discovery” state. Interval-1 is used as discovery-interval when a new tunnel-group is added to multi-chassis redundancy (mp-ipsec); interval-2 is used as discovery-interval at system boot-up. It is optional and when it is not specified, interval-1 will be used.
Default
300
Parameters
keep-alive-interval
Syntax
Context
Description
This command specifies the time interval of the mastership election protocol sending the keep-alive packet.
Default
10
Parameters
hold-on-neighbor-failure
Syntax
Context
Description
This command specifies the number of keep-alive failures before the peer is considered down.
Default
3
Parameters
bfd-enable
Syntax
Context
Description
This command enables tracking a central BFD session. If the BFD session goes down, then the system considers the peer down and changes the mc-ipsec status of the configured tunnel-group accordingly.
The BFD session uses the specified loopback interface (in the specified service) address as the source address and uses the specified dst-ip as the destination address. Other BFD parameters are configured with the “bfd” command on the specified interface.
Parameters
tunnel-group
Syntax
Context
Description
This command enables multi-chassis redundancy for the specified tunnel-group or enters an already configured tunnel-group context. The configured tunnel-group could failover independently.
Parameters
peer-group
Syntax
Context
Description
This command specifies the corresponding tunnel-group ID on the peer node. The peer tunnel-group ID does not necessarily equal the local tunnel-group ID.
Parameters
priority
Syntax
Context
Description
This command specifies the local priority of the tunnel-group. This is used to elect the master (higher number is the master). If priorities are the same, then the peer with the more active ISA becomes the master. If the priority and the number of active ISAs are the same, then the peer with the higher IP address is the master.
Parameters
preempt
Syntax
Context
Description
This command enables the preempt behavior of local node.
mc-lag
Syntax
Context
Description
This command enables the context to configure multi-chassis LAG operations and related parameters.
The no form of this command administratively disables multi-chassis LAG. MC-LAG can only be issued only when mc-lag is shutdown.
hold-on-neighbor-failure
Syntax
Context
Description
This command specifies the interval that the standby node will wait for packets from the active node before assuming a redundant-neighbor node failure. This delay in switch-over operation is required to accommodate different factors influencing node failure detection rate, such as IGP convergence, or HA switch-over times and to prevent the standby node to take action prematurely.
The no form of this command sets this parameter to default value.
Default
3
Parameters
keep-alive-interval
Syntax
Context
Description
This command sets the interval at which keep-alive messages are exchanged between two systems participating in MC-LAG. These keep-alive messages are used to determine remote-node failure and the interval is set in deci-seconds.
The no form of this command sets the interval to default value
Default
1s (10 hundreds of milliseconds means interval value of 10)
Parameters
lag
Syntax
Context
Description
This command defines a LAG which is forming a redundant-pair for MC-LAG with a LAG configured on the given peer. The same LAG group can be defined only in the scope of 1 peer.
The same lacp-key, system-id, and system-priority must be configured on both nodes of the redundant pair in order to MC-LAG to become operational. In order MC-LAG to become operational, all parameters (lacp-key, system-id, system-priority) must be configured the same on both nodes of the same redundant pair.
The partner system (the system connected to all links forming MC-LAG) will consider all ports using the same lacp-key, system-id, system-priority as the part of the same LAG. In order to achieve this in MC operation, both redundant-pair nodes have to be configured with the same values. In case of the mismatch, MC-LAG is kept in oper-down status.
Default
none
Parameters
source-address
Syntax
Context
Description
This command specifies the source address used to communicate with the multi-chassis peer.
Parameters
sync
Syntax
Context
Description
This command enables the context to configure synchronization parameters.
igmp
Syntax
Context
Description
This command specifies whether IGMP protocol information should be synchronized with the multi-chassis peer.
Default
no igmp
igmp-snooping
Syntax
Context
Description
This command specifies whether IGMP snooping information should be synchronized with the multi-chassis peer.
Default
no igmp-snooping
local-dhcp-server
Syntax
Context
Description
This command synchronizes DHCP server information.
mc-ring
Syntax
Context
Description
This command synchronizes mc-ring information.
mld-snooping
Syntax
Context
Description
This command is not supported. It is not blocked for backwards-compatibility reasons but has no effect on the system if configured.
pim-snooping
Syntax
Context
Description
This command specifies whether PIM snooping for IPv4 information should be synchronized with the multi-chassis peer. Entering only pim-snooping (without any parameter) results in the synchronization being applicable only to SAPs.
Default
no pim-snooping
Parameters
port
Syntax
Context
Description
This command specifies the port to be synchronized with the multi-chassis peer and a synchronization tag to be used while synchronizing this port with the multi-chassis peer.
Parameters
range
Syntax
Context
Description
This command configures a range of encapsulation values.
Parameters
Dot1Q | start-vlan-end-vlan |
QinQ | Q1.start-vlan-Q1.end-vlan |
srrp
Syntax
Context
Description
This command specifies whether subscriber routed redundancy protocol (SRRP) information should be synchronized with the multi-chassis peer.
Default
no srrp
sub-host-trk
Syntax
Context
Description
This command synchronizes subscriber host tracking information.
sub-mgmt
Syntax
Context
Description
This command will enable synchronization of subscriber states between chassis. Synchronization will be enabled per protocol type (IPoE or PPPoE).
The keywords (ipoe, pppoe) must match on both nodes. If not, subscriber synchronization will fail.
For example if one node is configured with:
configure>multi-chassis>peer>sync>sub-mgmt ipoe
but the other node is configured with:
configure>multi-chassis>peer>sync>sub-mgmt ipoe pppoe
synchronization will fail even for ipoe application.
Default
no sub-mgmt
Parameters
tunnel-group
Syntax
Context
Description
This command enables multi-chassis synchronization of IPSec states of a specified tunnel-group with its peer. Sync-tag is used to match corresponding tunnel-groups on both peers. IPSec states will be synchronized between tunnel-groups with the same sync-tag.
Parameters
ipsec
Syntax
Context
Description
This command enables multi-chassis synchronization of IPSec states on system level.
mc-ring
Syntax
Context
Description
This command enables the context to configure the multi-chassis ring parameters.
Default
mc-ring
ring
Syntax
Context
Description
This command configures a multi-chassis ring.
The no form of the command removes the sync-tag from the configuration.
Default
none
l3-ring
Syntax
Context
Description
This command configures a Layer 3 multi-chassis ring.
in-band-control-path
Syntax
Context
Description
This command enables the context to configure control path parameters.
Default
none
debounce
Syntax
Context
Description
This command enables the inband control path debouncing. The no form of the command disables inband control path debouncing.
dst-ip
Syntax
Context
Description
This command specifies the destination IP address used in the inband control connection.
If the destination IP address is not configured, the ring cannot become operational.
Default
none
Parameters
interface
Syntax
Context
Description
This command specifies the name of the IP interface used for the inband control connection.
If an interface name is not configured, the ring cannot become operational.
Parameters
max-debounce-time
Syntax
Context
Description
This command configures the inband control path maximum debounce time.
Parameters
service-id
Syntax
Context
Description
This command configures the service ID of the SAP used for the Ring-Node Connectivity Verification of this ring node.
Parameters
path-b
Syntax
Context
Description
This command specifies the set of upper-VLAN IDs associated with the SAPs that belong to path B with respect to load-sharing. All other SAPs belong to path A.
Default
If not specified, the default is an empty set.
range
Syntax
Context
Description
This command specifies the set of VLAN IDs associated with the SAPs that are controlled by the remote peer. It is a bitmap that associates bit i with VLAN ID i, with i in [0..4094]. Setting the value to the empty string is equivalent to setting it to 512 zeroes.
ring-node
Syntax
Context
Description
This command specifies the unique name of a multi-chassis ring access node.
path-excl
Syntax
Context
Description
This command specifies the set of upper-VLAN IDs associated with the SAPs that are to be excluded from control by the multi-chassis ring.
Default
If not specified, the default is an empty set.
connectivity-verify
Syntax
Context
Description
This command configures the node connectivity check.
interval
Syntax
Context
Description
This command specifies the polling interval of the ring-node connectivity verification of this ring node.
Parameters
service-id
Syntax
Context
Description
This command specifies the service ID of the SAP used for ring-node connectivity verification of this ring node.
Parameters
src-ip
Syntax
Context
Description
This command specifies the source IP address used in ring-node connectivity verification of this ring node.
Parameters
src-mac
Syntax
Context
Description
This command specifies the source MAC address used for the Ring-Node Connectivity Verification of this ring node.
If all zeros are specified, then the MAC address of the system management processor (CPM) is used.
Parameters
vlan
Syntax
Context
Description
This command specifies the VLAN tag of the SAP used for ring-node connectivity verification of this ring node. It is only meaningful if the value of is not zero.
srrp-instance
Syntax
Context
Description
This command configures an SRRP instance for Layer 3 ring.
Parameters
SLA Profile Commands
sla-profile
Syntax
Context
Description
This command configures an SLA profile mapping. Hosts associated with a subscriber are subdivided into Service Level Agreement (SLA) profiles. For each subscriber host an SLA profile can be specified. For a subscriber host, the SLA profile determines:
- The QoS-policies to use
- The classification
- The queues
- The queue mapping
- The IP filters to use
The SLA profile also has the attribute host-limit which limits the total number of hosts (belonging to the same subscriber) on a certain SAP that can be using this SLA profile.
Default
none
Parameters
egress
Syntax
Context
Description
This command configures egress parameters for the SLA profile.
ingress
Syntax
Context
Description
This command configures ingress parameters for the SLA profile.
host-limits
Syntax
Context
Description
This command configures the maximum number of hosts per host type for this SLA profile.
ipv4-arp
Syntax
Context
Description
This command configures the maximum number of IPv4 ARP hosts.
The no form of the command removes the number of IPv4 ARP hosts from the SLA profile.
Default
no ipv4-arp
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv4-dhcp
Syntax
Context
Description
This command limits the number of IPv4 DHCP hosts.
The no form of the command removes the number of IPv4 DHCP hosts from the SLA profile.
Default
no ipv4-dhcp
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv4-overall
Syntax
Context
Description
This command limits the total number of IPv4 hosts.
The no form of the command removes the number of IPv4 hosts from the SLA profile.
Default
no ipv4-overall
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv4-ppp
Syntax
Context
Description
This command limits the total number of IPv4 PPP hosts.
The no form of the command removes the number of IPv4 PPP hosts from the SLA profile.
Default
no ipv4-ppp
Parameters
ipv6-overall
Syntax
Context
Description
This command limits the total number of IPv6 hosts.
The no form of the command removes the number of IPv6 hosts from the SLA profile.
Default
no ipv6-overall
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv6-pd-ipoe-dhcp
Syntax
Context
Description
This command configures the total number of IPv6 DHCP PD hosts.
The no form of the command removes the number of IPv6 DHCP hosts from the SLA profile.
Default
no ipv6-dhcp
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv6-pd-overall
Syntax
Context
Description
This command limits the total number of IPv6-PD hosts.
The no form of the command removes the number of IPv6-PD hosts from the SLA profile.
Default
no ipv6-pd-overall
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv6-pd-ppp-dhcp
Syntax
Context
Description
This command configures the maximum number of IPv6-WAN PPP DHCP hosts.
The no form of the command removes the number of IPv6-WAN PPP DHCP hosts from the SLA profile.
Default
no ipv6-pd-ppp-dhcp
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv6-wan-ipoe-dhcp
Syntax
Context
Description
This command configures the maximum number of IPv6-WAN PPP DHCP hosts.
The no form of the command removes the number of IPv6-WAN PPP DHCP hosts from the SLA profile.
Default
no ipv6-wan-ipoe-dhcp
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv6-wan-ipoe-slaac
Syntax
Context
Description
This command configures the maximum number of IPv6-WAN IPoE SLAAC hosts.
The no form of the command removes the number of IPv6-WAN IPoE SLAAC hosts from the SLA profile.
Default
no ipv6-wan-ipoe-slaac
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv6-wan-overall
Syntax
Context
Description
This command configures the total number of IPv6 WAN hosts.
The no form of the command removes the number of IPV6 WAN hosts from the SLA profile.
Default
no ipv6-wan-overall
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv6-wan-ppp-dhcp
Syntax
Context
Description
This command configures the total number of IPv6 PPP DHCP WAN hosts.
The no form of the command removes the number of IPv6 PPP DHCP WAN hosts from the SLA profile.
Default
no ipv6-wan-ppp-dhcp
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
ipv6-wan-ppp-slaac
Syntax
Context
Description
This command configures the total number of SLAAC hosts.
The no form of the command removes the number of SLAAC hosts from the SLA profile.
Default
no ipv6-wan-ppp-slaac
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
lac-overall
Syntax
Context
Description
This command configures the total number of L2TP LAC hosts
The no form of the command removes the number of L2TP LAC from the SLA profile.
Default
no lac-overall
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
overall
Syntax
Context
Description
This command configures the total number of hosts.
The no form of the command reverts to the default.
Default
no overall
Parameters
remove-oldest
Syntax
Context
Description
This command removes the oldest subscriber host when the host limit is reached.
The no form of the command maintains the oldest subscriber host when the host limit is reached.
Default
no remove-oldest
ip-filter
Syntax
Context
Description
This command configures an egress or ingress IP filter.
Parameters
SLA Profile QoS Commands
qos
Syntax
Context
Description
This command specifies the egress QoS policy applicable to this SLA profile. The policy must already be defined in the configure>qos>sap-egress context.
Default
1
Parameters
qos
Syntax
Context
Description
This command specifies the ingress QoS policy applicable to this SLA profile. The policy must already be defined in the configure>qos>sap-ingress context.
Default
qos 1
Parameters
queue
Syntax
Context
Description
This command configures the context to configure egress or ingress queue parameters. Parameters defined in the config>qos>sap-egress policy-id or the config>qos>sap-ingress policy-id context are overridden by parameters specified in the subscriber management SLA profile context.
The classification and the queue mapping are shared by all the hosts on the same complex that use the same QoS policy (specified in the sla-profile SAP egress and SAP ingress policy IDs).
The queues are shared by all the hosts (of the same subscriber) on the same SAP that are using the same SLA profile. Queues are instantiated when, on a given SAP, a host of a subscriber is the first to use a certain SLA profile. This instantiation is referred to as an SLA profile instance.
The no form of the command removes the queue-id from the SLA profile.
Default
none
Parameters
avg-frame-overhead
Syntax
Context
Description
This command configures the average frame overhead to define the average percentage that the offered load to a queue will expand during the frame encapsulation process before sending traffic on-the-wire. While the avg-frame-overhead value may be defined on any queue, it is only used by the system for queues that egress a SONET or SDH port or channel. Queues operating on egress Ethernet ports automatically calculate the frame encapsulation overhead based on a 20 byte per packet rule (8 bytes for preamble and 12 bytes for Inter-Frame Gap).
When calculating the frame encapsulation overhead for port scheduling purposes, the system determines the following values:
- Offered-load — The offered-load of a queue is calculated by starting with the queue depth in octets, adding the received octets at the queue and subtracting queue discard octets. The result is the number of octets the queue has available to transmit. This is the packet based offered-load.
- Frame encapsulation overhead — Using the avg-frame-overhead parameter, the frame encapsulation overhead is simply the queues current offered-load (how much has been received by the queue) multiplied by the avg-frame-overhead. If a queue had an offered load of 10000 octets and the avg-frame-overhead equals 10%, the frame encapsulation overhead would be 10000 x 0.1 or 1000 octets.
For egress Ethernet queues, the frame encapsulation overhead is calculated by multiplying the number of offered-packets for the queue by 20 bytes. If a queue was offered 50 packets then the frame encapsulation overhead would be 50 x 20 or 1000 octets.
- Frame based offered-load — The frame based offered-load is calculated by adding the offered-load to the frame encapsulation overhead. If the offered-load is 10000 octets and the encapsulation overhead was 1000 octets, the frame based offered-load would equal 11000 octets.
- Packet to frame factor — The packet to frame factor is calculated by dividing the frame encapsulation overhead by the queues offered-load (packet based). If the frame encapsulation overhead is 1000 octets and the offered-load is 10000 octets then the packet to frame factor would be 1000 / 10000 or 0.1. When in use, the avg-frame-overhead will be the same as the packet to frame factor making this calculation unnecessary.
- Frame based CIR — The frame based CIR is calculated by multiplying the packet to frame factor with the queues configured CIR and then adding that result to that CIR. If the queue CIR is set at 500 octets and the packet to frame factor equals 0.1, the frame based CIR would be 500 x 1.1 or 550 octets.
- Frame based within-cir offered-load — The frame based within-cir offered-load is the portion of the frame based offered-load considered to be within the frame-based CIR. The frame based within-cir offered-load is the lesser of the frame based offered-load and the frame based CIR. If the frame based offered-load equaled 11000 octets and the frame based CIR equaled 550 octets, the frame based within-cir offered-load would be limited to 550 octets. If the frame based offered-load equaled 450 octets and the frame based CIR equaled 550 octets, the frame based within-cir offered-load would equal 450 octets (or the entire frame based offered-load).
As a special case, when a queue or associated intermediate scheduler is configured with a CIR-weight equal to 0, the system automatically sets the queue’s frame based within-cir offered-load to 0, preventing it from receiving bandwidth during the port scheduler’s within-cir pass.
- Frame based PIR — The frame based PIR is calculated by multiplying the packet to frame factor with the queue’s configured PIR and then adding the result to that PIR. If the queue PIR is set to 7500 octets and the packet to frame factor equals 0.1, the frame based PIR would be 7500 x 1.1 or 8250 octets.
- Frame based within-pir offered-load — The frame based within-pir offered-load is the portion of the frame based offered-load considered to be within the frame based PIR. The frame based within-pir offered-load is the lesser of the frame based offered-load and the frame based PIR. If the frame based offered-load equaled 11000 octets and the frame based PIR equaled 8250 octets, the frame based within-pir offered-load would be limited to 8250 octets. If the frame based offered-load equaled 7000 octets and the frame based PIR equaled 8250 octets, the frame based within-pir offered load would equal 7000 octets.
Port scheduler operation using frame transformed rates — The port scheduler uses the frame based rates to determine the maximum rates that each queue may receive during the within-cir and above-cir bandwidth allocation passes. During the within-cir pass, a queue may receive up to its frame based within-cir offered-load. The maximum it may receive during the above-cir pass is the difference between the frame based within-pir offered load and the amount of actual bandwidth allocated during the within-cir pass.
SAP and subscriber SLA-profile average frame overhead override — The average frame overhead parameter on a sap-egress may be overridden at an individual egress queue basis. On each SAP and within the sla-profile policy used by subscribers an avg-frame-overhead command may be defined under the queue-override context for each queue. When overridden, the queue instance will use its local value for the average frame overhead instead of the sap-egress defined overhead.
The no form of this command restores the average frame overhead parameter for the queue to the default value of 0 percent. When set to 0, the system uses the packet based queue statistics for calculating port scheduler priority bandwidth allocation. If the no avg-frame-overhead command is executed in a queue-override queue id context, the avg-frame-overhead setting for the queue within the sap-egress QoS policy takes effect.
Default
0
Parameters
burst-limit
Syntax
Context
Description
The queue burst-limit command is used to define an explicit shaping burst size for a queue. The configured size defines the shaping leaky bucket threshold level that indicates the maximum burst over the queue’s shaping rate.
The burst-limit command is supported under the sap-ingress and sap-egress QoS policy queues. The command is also supported under the ingress and egress queue-group-templates queues.
The no form of this command is used to restore the default burst limit to the specified queue. This is equivalent to specifying burst-limit default within the QoS policies or queue group templates. When specified within a queue-override queue context, any current burst limit override for the queue will be removed and the queue’s burst limit will be controlled by its defining policy or template.
Parameters
cbs
Syntax
Context
Description
This command can be used to override specific attributes of the specified queue's CBS parameters. It is permissible, and possibly desirable, to oversubscribe the total CBS reserved buffers for a given access port egress buffer pool. Oversubscription may be desirable due to the potential large number of service queues and the economy of statistical multiplexing the individual queues’ CBS settings into the defined reserved total.
When oversubscribing the reserved total, it is possible for a queue depth to be lower than its CBS setting and still not receive a buffer from the buffer pool for an ingress frame. As more queues are using their CBS buffers and the total in use exceeds the defined reserved total, essentially the buffers are being removed from the shared portion of the pool without the shared in use average and total counts being decremented. This can affect the operation of the high and low priority RED slopes on the pool, causing them to miscalculate when to start randomly drop packets.
The no form of this command returns the CBS size to the size as configured in the QoS policy.
Default
no cbs
Parameters
high-prio-only
Syntax
Context
Description
This command configures the value of the percentage of buffer space for the queue, used exclusively by high priority packets. The specified value overrides the default value for the context.
The priority of a packet can only be set in the SAP ingress QoS policy and is only applicable on the ingress queues for a SAP. The high-prio-only parameter is used to override the default value derived from the network-queue command.
The defined high-prio-only value cannot be greater than the MBS size of the queue. Attempting to change the MBS to a value smaller than the high priority reserve will generate an error and fail execution. Attempting to set the high-prio-only value larger than the current MBS size will also result in an error and fail execution.
The no form of this command returns high-prio-only to the size as configured in the QoS policy.
Default
no high-prio-only
Parameters
mbs
Syntax
Context
Description
This command configures the maximum size for the queue.
The sum of the MBS for all queues on an egress access port can oversubscribe the total amount of buffering available. When congestion occurs and buffers become scarce, access to buffers is controlled by the RED slope a packet is associated with. A queue that has not exceeded its MBS size is not guaranteed that a buffer will be available when needed or that the packet’s RED slope will not force the discard of the packet. Setting proper CBS parameters and controlling CBS oversubscription is one major safeguard to queue starvation (when a queue does not receive its fair share of buffers). Another is properly setting the RED slope parameters for the needs of services on this port or channel.
The no form of this command returns the MBS size to the size as configured in the QoS policy.
Default
no mbs
Parameters
mbs
Syntax
Context
Description
The Maximum Burst Size (MBS) command configures the explicit definition of the maximum amount of buffers allowed for a specific queue.
The MBS value is used by a queue to determine whether it has exhausted all of its buffers while enqueuing packets. Once the queue has exceeded the amount of buffers allowed by MBS, all packets are discarded until packets have been drained from the queue.
The sap-ingress context for mbs provides a mechanism for overriding the default maximum size for the queue.
The sum of the MBS for all queues on an ingress access port can oversubscribe the total amount of buffering available. When congestion occurs and buffers become scarce, access to buffers is controlled by the RED slope a packet is associated with. A queue that has not exceeded its MBS size is not guaranteed that a buffer will be available when needed or that the packet’s RED slope will not force the discard of the packet. Setting proper CBS parameters and controlling CBS oversubscription is one major safeguard to queue starvation (when a queue does not receive its fair share of buffers). Another is properly setting the RED slope parameters for the needs of services on this port or channel.
The defined high-prio-only value cannot be greater than the MBS size of the queue. Attempting to change the MBS to a value smaller than the high priority reserve will generate an error and fail execution. Attempting to set the high-prio-only value larger than the current MBS size will also result in an error and fail execution.
The no form of this command returns the MBS size to the size as configured in the QoS policy.
Default
no mbs
Parameters
rate
Syntax
Context
Description
This command defines the administrative Peak Information Rate (PIR) and the administrative Committed Information Rate (CIR) parameters for the queue. The PIR defines the maximum rate that the queue can transmit packets out an egress interface (for SAP egress queues). Defining a PIR does not necessarily guarantee that the queue can transmit at the intended rate. The actual rate sustained by the queue can be limited by oversubscription factors or available egress bandwidth.
The CIR defines the rate at which the system prioritizes the queue over other queues competing for the same bandwidth. In-profile then out-of-profile packets are preferentially queued by the system at egress and at subsequent next hop nodes where the packet can traverse. To be properly handled throughout the network, the packets must be marked accordingly for profiling at each hop.
The CIR can be used by the queue’s parent command’s cir-level and cir-weight parameters to define the amount of bandwidth considered to be committed for the child queue during bandwidth allocation by the parent scheduler.
The rate command can be executed at anytime, altering the PIR and CIR rates for all queues created through the association of the SAP egress QoS policy with the queue-id.
The no form of the command returns all queues created with the queue-id by association with the QoS policy to the default PIR and CIR parameters (max, 0).
Default
no rate
Parameters
The actual PIR rate is dependent on the queues adaptation-rule parameters and the actual hardware where the queue is provisioned.
qos-marking-from-sap
Syntax
Context
Description
This command sets the QoS policy from which the egress QoS marking rules are applied.
| Note:
If applied to a managed SAP, the default SAP-egress qos-policy (sap-egress 1) cannot be changed. |
The no form of the command reverts to the egress QoS marking defined in SAP-egress policy defined at sla-profile level.
Default
qos-marking-from-sap
report-rate
Syntax
Context
Description
This command configures the source for Tx and Rx connect speeds in AVP 38 (Rx Connect Speed) and AVP 24 (Tx Connect Speed) of an L2TP session established on a LAC.
Default
no report-rate – Rates takes from the physical port speed.
Parameters
- The agg-rate RADIUS override (RADIUS VSA “Alc-Subscriber-QoS-Override” in a RADIUS Access-Accept message) if present.
- The configured agg-rate-limit in the config>subscr-mgmt>sub-prof>egr context.
- Fall back to the default (no report-rate).
scheduler-policy
Syntax
Context
Description
This command specifies a scheduler policy to associate to the sla profile. Scheduler policies are configured in the configure>qos>scheduler>policy context. Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations. The policy defines the hierarchy and operating parameters for virtual schedulers.
The no form of the command removes the scheduler-policy-name from the configuration.
Default
no scheduler-policy
Parameters
scheduler
Syntax
Context
Description
This command provides a way to override parameters of the existing scheduler associated with the
egress scheduler policy. A scheduler defines bandwidth controls that limit each child (other schedulers and queues) associated with the scheduler. Scheduler objects are created within the
hierarchical tiers of the policy. It is assumed that each scheduler created will have queues or other
schedulers defined as child associations. The scheduler can be a child (take bandwidth from a
scheduler in a higher tier).
Parameters
use-ingress-l2tp-dscp
Syntax
Context
Description
This command enables the use of the DSCP marking taken from the L2TP header received on an L2TP Access Concentrator (LAC) for egress classification for the subscriber host using the associated sla-profile.
This command is ignored if the ingress packet is not identified as an L2TP packet.
Default
no use-ingress-l2tp-dscp
one-time-http-redirection
Syntax
Context
Description
This command specify the one-time http redirection filter id. This filter will apply to the host when host is created, and will be replaced by the sla-profile ingress filter (configured in the config>subscr-mgmt>sla-prof>ingress context) after first HTTP request from host has been redirected.
| Note:
The system does not check if the configured filter include http-redirection entry. If the filter does not include the http-redirection then it will not be replaced in future. |
If 7750 SR receives filter insertion via CoA or access-accept when one-time redirection filter is still active then the received filter entries will only be applied to the sla-profile ingress filter. And after 1st http redirection, the original sla-profile ingress filter + received filter will replace the redirection filter.
Default
no
Parameters
rate
Syntax
Context
Description
This command defines the administrative Peak Information Rate (PIR) and the administrative Committed Information Rate (CIR) parameters for the queue. The PIR defines the maximum rate that the queue can transmit packets through the switch fabric (for SAP ingress queues). Defining a PIR does not necessarily guarantee that the queue can transmit at the intended rate. The actual rate sustained by the queue can be limited by oversubscription factors or available egress bandwidth.
The CIR defines the rate at which the system prioritizes the queue over other queues competing for the same bandwidth. For SAP ingress, the CIR also defines the rate that packets are considered in-profile by the system. In-profile then out-of-profile packets are preferentially queued by the system at egress and at subsequent next hop nodes where the packet can traverse. To be properly handled throughout the network, the packets must be marked accordingly for profiling at each hop.
The CIR can be used by the queue’s parent command’s cir-level and cir-weight parameters to define the amount of bandwidth considered to be committed for the child queue during bandwidth allocation by the parent scheduler.
The rate command can be executed at anytime, altering the PIR and CIR rates for all queues created through the association of the SAP ingress or SAP egress QoS policy with the queue-id.
The no form of the command returns all queues created with the queue-id by association with the QoS policy to the default PIR and CIR parameters (max, 0).
Default
no rate
Parameters
Fractional values are not allowed and must be given as a positive integer.
The actual PIR rate is dependent on the queues adaptation-rule parameters and the actual hardware where the queue is provisioned.
Fractional values are not allowed and must be given as a positive integer.
policer
Syntax
Context
Description
This command is used in the sap-ingress and sap-egress QoS policies to create, modify or delete a policer. Policers are created and used in a similar manner to queues. The policer ID space is separate from the queue ID space, allowing both a queue and a policer to share the same ID. The sap-ingress policy may have up to 32 policers (numbered 1 through 32) may be defined while the sap-egress QoS policy supports a maximum of 8 (numbered 1 through 8). While a policer may be defined within a QoS policy, it is not actually created on SAPs or subscribers associated with the policy until a forwarding class is mapped to the policer’s ID.
All policers must be created within the QoS policies. A default policer is not created when a sap-ingress or sap-egress QoS policy is created.
Once a policer is created, the policer's metering rate and profiling rates may be defined as well as the policer's maximum and committed burst sizes (MBS and CBS respectively). Unlike queues which have dedicated counters, policers allow various stat-mode settings that define the counters that will be associated with the policer. Another supported feature—packet-byte-offset—provides a policer with the ability to modify the size of each packet based on a defined number of bytes.
Once a policer is created, it cannot be deleted from the QoS policy unless any forwarding classes that are mapped to the policer are first moved to other policers or queues.
The system will allow a policer to be created on a SAP QoS policy regardless of the ability to support policers on objects where the policy is currently applied. The system only scans the current objects for policer support and sufficient resources to create the policer when a forwarding class is first mapped to the policer ID. If the policer cannot be created due to one or more instances of the policy not supporting policing or having insufficient resources to create the policer, the forwarding class mapping will fail.
The no form of this command is used to delete a policer from a sap-ingress or sap-egress QoS policy. The specified policer cannot currently have any forwarding class mappings for the removal of the policer to succeed. It is not necessary to actually delete the policer ID for the policer instances to be removed from SAPs or subscribers associated with the QoS policy once all forwarding classes have been moved away from the policer. It is automatically deleted from each policing instance although it still appears in the QoS policy.
Parameters
cbs
Syntax
Context
Description
This command is used to configure the policer’s CIR leaky bucket’s exceed threshold. The CIR bucket’s exceed threshold represents the committed burst tolerance allowed by the policer. If the policer’s forwarding rate is equal to or less than the policer's defined CIR, the CIR bucket depth hovers around the 0 depth with spikes up to the maximum packet size in the offered load. If the forwarding rate increases beyond the profiling rate, the amount of data allowed to be in-profile above the rate is capped by the threshold.
The policer’s cbs size defined in the QoS policy may be overridden on an sla-profile or SAP where the policy is applied.
The no form of this command returns the policer to its default CBS size.
Default
none
Parameters
cbs
Syntax
Context
Description
This command is used to configure the policer’s CIR leaky bucket’s exceed threshold. The CIR bucket’s exceed threshold represents the committed burst tolerance allowed by the policer. If the policer’s forwarding rate is equal to or less than the policer's defined CIR, the CIR bucket depth hovers around the 0 depth with spikes up to the maximum packet size in the offered load. If the forwarding rate increases beyond the profiling rate, the amount of data allowed to be in-profile above the rate is capped by the threshold.
The policer’s cbs size defined in the QoS policy may be overridden on an sla-profile or SAP where the policy is applied.
The no form of this command returns the policer to its default CBS size.
Default
none
Parameters
mbs
Syntax
Context
Description
This command configures the MBS for the QoS policer.
Default
None
Parameters
mbs
Syntax
Context
Description
This command is used to configure the policer’s PIR leaky bucket’s high priority violate threshold. The high-prio-only command is applied to the MBS value to derive the bucket’s low priority violate threshold. For ingress, trusted in-profile packets and un-trusted high priority packets use the policer’s high priority violate threshold while trusted out-of-profile and un-trusted low priority packets use the policer's low priority violate threshold. At egress, in-profile packets use the policer’s high priority violate threshold and out-of-profile packets use the policer's low priority violate threshold.
The PIR bucket’s violate threshold represent the maximum burst tolerance allowed by the policer. If the policer's offered rate is equal to or less than the policer's defined rate, the PIR bucket depth hovers around the 0 depth with spikes up to the maximum packet size in the offered load. If the offered rate increases beyond the metering rate, the amount of data allowed above the rate is capped by the threshold. The low priority violate threshold provides a smaller burst size for the lower priority traffic associated with the policer. Since all lower priority traffic is discarded at the lower burst tolerance size, the remaining burst tolerance defined by high-prio-only is available for the higher priority traffic.
The policer’s mbs size defined in the QoS policy may be overridden on an sla-profile or SAP where the policy is applied.
The no form of this command returns the policer to its default MBS size.
Default
None
Parameters
packet-byte-offset
Syntax
Context
Description
This command is used to modify the size of each packet handled by the policer by adding or subtracting a number of bytes. The actual packet size is not modified; only the size used to determine the bucket depth impact is changed. The packet-byte-offset command is meant to be an arbitrary mechanism the can be used to either add downstream frame encapsulation or remove portions of packet headers. Both the policing metering and profiling throughput is affected by the offset as well as the stats associated with the policer.
When child policers are adding to or subtracting from the size of each packet, the parent policer’s min-thresh-separation value should also need to be modified by the same amount.
The policer’s packet-byte-offset defined in the QoS policy may be overridden on an sla-profile or SAP where the policy is applied.
The no version of this command is used to remove per packet size modifications from the policer.
Parameters
| Note:
The minimum resulting packet size used by the system is 1 byte. |
rate
Syntax
Context
Description
This command is used to configure the policer’s metering and optional profiling rates. The metering rate is used by the system to configure the policer’s PIR leaky bucket’s decrement rate while the profiling rate configures the policer’s CIR leaky bucket’s decrement rate. The decrement function empties the bucket while packets applied to the bucket attempt to fill it based on the each packets size. If the bucket fills faster than how much is decremented per packet, the bucket’s depth eventually reaches it's exceed (CIR) or violate (PIR) threshold. The cbs, mbs, and high-prio-only commands are used to configure the policer’s PIR and CIR thresholds.
If a packet arrives at the policer while the bucket’s depth is less than the threshold associated with the packet, the packet is considered to be conforming to the bucket’s rate. If the bucket depth is equal to or greater than the threshold, the packet is considered to be in the exception state. For the CIR bucket, the exception state is exceeding the CIR rate while the PIR bucket's exception state is violating the PIR bucket rate. If the packet is violating the PIR, the packet is marked red and will be discarded. If the packet is not red, it may be green or yellow based on the conforming or exceeding state from the CIR bucket.
When a packet is red neither the PIR or CIR bucket depths are incremented by the packets size. When the packet is yellow the PIR bucket is incremented by the packet size, but the CIR bucket is not. When the packet is green, both the PIR and CIR buckets are incremented by the packet size. This ensures that conforming packets impact the bucket depth while exceeding or violating packets do not.
The policer’s adaptation-rule command settings are used by the system to convert the specified rates into hardware timers and decrement values for the policer’s buckets.
By default, the policer’s metering rate is max and the profiling rate is 0 Kbps (all packets out-of-profile).
The rate settings defined for the policer in the QoS policy may be overridden on an sla-profile or SAP where the policy is applied.
The no form of this command is used to restore the default metering and profiling rate to a policer.
Parameters
stat-mode
Syntax
Context
Description
This command is used to configure the forwarding plane octet and packet counters of a policer or queue to count packets of a specific type or state. For example separate counters for IPv4/IPv6 or separate counters for offered high and low priority policed traffic.
For policers, this command overrides the policer stat-mode configuration as defined in the sap-ingress or sap-egress qos policy. For details on sap-ingress and sap-egress policer stat-mode, refer to the Quality of Service Guide. For use in Enhanced Subscriber Management (ESM) context only, an additional stat-mode enables separate counters for IPv4 and IPv6 packets.
When a policer’s stat-mode is changed while the sla profile is in use, any previous counter values are lost and any new counters are set to zero.
For queues, this command sets the stat-mode. Queue stat-mode is only available for use in Enhanced Subscriber Management (ESM) context to enable separate IPv4/IPv6 counters.
A queue’s stat-mode cannot be changed while the SLA profile is in use.
Default
no stat-mode
For policers, the default is no stat-mode override. The sap-ingress or sap-egress stat-mode is used instead.
For queues, the default is to count in-/out-of-profile octets and packets.
Parameters
For ingress and egress qos queue stat-mode overrides
For ingress and egress qos policer stat-mode overrides, refer to the Quality of Service Guide for details on the sap-ingress and sap-egress policer stat-mode parameters.
For use in Enhanced Subscriber Management (ESM) context only:
Subscriber Identification Policy Commands
sub-ident-policy
Syntax
Context
Description
This command configures a subscriber identification policy. Each subscriber identification policy can have a default subscriber profile defined. The subscriber identification policy default subscriber profile overrides the system default and the subscriber SAP default subscriber profiles. Defining a subscriber identification policy default subscriber profile is optional.
The subscriber identification policy default subscriber profile cannot be defined with the subscriber profile name default.
Defining a subscriber profile as a subscriber identification policy default subscriber profile will cause all active subscribers currently associated with a subscriber SAP using the policy and associated with a subscriber policy through the system default or subscriber SAP default subscriber profiles to be reassigned to the subscriber policy defined as default on the subscriber identification policy.
Attempting to delete a subscriber profile that is currently defined as a default for a subscriber identification policy will fail.
When attempting to remove a subscriber identification policy default subscriber profile definition, the system will evaluate each active subscriber on all subscriber SAPs the subscriber identification policy is currently associated with that are using the default definition to determine whether the active subscriber can be either reassigned to a subscriber SAP default or the system default subscriber profile. If all active subscribers cannot be reassigned, the removal attempt will fail.
Parameters
app-profile-map
Syntax
Context
Description
This command enables the context to configure an application profile mapping.
entry
Syntax
Context
Description
This command configures an application profile string.
The no form of the command removes the values from the configuration.
Parameters
use-direct-map-as-default
Syntax
Context
Description
This command enables direct mapping of application profile as default. With this flag, a script returned string will be used as the named profile. If the named profiled cannot be found, the default profile will be used.
The no form of the command disables the direct mapping.
Default
no use-direct-map-as-default
primary
Syntax
Context
Description
This command configures a primary identification script.
script-url
Syntax
Context
Description
This command specifies the URL of the identification scripts.
Parameters
secondary
Syntax
Context
Description
This command configures a secondary identification script.
sla-profile-map
Syntax
Context
Description
This command configures an SLA profile mapping.
sub-profile-map
Syntax
Context
Description
This command configures a subscriber profile mapping.
entry
Syntax
Context
Description
This command configures an SLA profile string. Each subscriber identification string can be provisioned into a subscriber mapping table providing an explicit mapping of the string to a specific subscriber profile. This allows certain subscribers to be directly mapped to the appropriate subscriber profile in the event that the default mappings are not desired for the subscriber.
An explicit mapping of a subscriber identification string to a subscriber profile cannot be defined with the subscriber profile name default. It is possible for the subscriber identification string to be entered in the mapping table without a defined subscriber profile which can result in the explicitly defined subscriber to be associated with the subscriber profile named default.
Explicitly mapping a subscriber identification string to a subscriber profile will cause an existing active subscriber associated with the string to be reassigned to the newly mapped subscriber profile. An explicit mapping overrides all default subscriber profile definitions.
Attempting to delete a subscriber profile that is currently defined as in an explicit subscriber identification string mapping will fail.
The system will fail the removal attempt of an explicit subscriber identification string mapping to a subscriber profile definition when an active subscriber is using the mapping and cannot be reassigned to a defined default non-provisioned subscriber profile.
Parameters
entry
Syntax
Context
Description
This command configures a subscriber profile string.
Parameters
tertiary
Syntax
Context
Description
This command configures a tertiary identification script.
Auto-Generated Subscriber Identification Key Commands
auto-sub-id-key
Syntax
Context
Description
ipoe-sub-id-key
Syntax
Context
Description
This command enables certain fields to become the base for auto-generation of the default sub-id name. The sub-id name will be auto generated if there is not a more specific method available. Such more specific methods would be a default sub-id name as a sap-id, a preconfigured static string or explicit mappings based on RADIUS/LUDB returned strings.
In case that a more specific sub-id name generation method is not available AND the auto-id keyword is defined under the def-sub-id hierarchy, the sub-id name will be generated by concatenating fields defined in this command separated by a “|” character.
The maximum sub-id name length is 32 characters while the concatenation of subscriber identification fields can easily exceed 32 characters. Subscriber host instantiation will fail in case that the sub-id name is based on subscriber identification fields whose concatenated length exceeds 32 characters. Failing the host creation rather than truncating sub-id name on a 32 character boundary will prevent collision of sub-ids (subscriber name duplication).
In case that a more specific sub-id name generation method is not available AND the auto-id keyword is NOT defined under the def-sub-id hierarchy, the sub-id name will be a random 10 character encoded string based on the fields defined under this command.
There is only one set of identification fields allowed per host type (IPoE or PPP) per chassis.
Parameters
| Note:
If circuit-id contains any non printable ASCI characters, the entire circuit-id string will be formatted in hex in the sub-id name output. Otherwise all characters in circuit-id will be converted to ASCII. ASCII printable characters contain bytes in range 0x20..0x7E. |
| Note:
If remote-id contains any non printable ASCI characters, the entire remote-id string will be formatted in hex in the sub-id name output. Otherwise all characters in remote-id will be converted to ASCII. ASCII printable characters contain bytes in range 0x20..0x7E. |
ppp-sub-id-key
Syntax
Context
Description
This command enable certain fields to become the base for auto-generation of default sub-id name. The sub-id name will be auto-generated if there is not a more specific method available. Examples of these specific methods would be a default sub-id name as a sap-id, a preconfigured static string or explicit mappings based on RADIUS/LUDB returned strings.
In case that a more specific sub-id name generation method is not available and the auto-id keyword is defined under the def-sub-id hierarchy, the sub-id name will be generated by concatenating fields defined in this command separated by a “|” character.
The maximum sub-id name length is 32 characters while the concatenation of subscriber identification fields can easily exceed 32 characters. The subscriber host instantiation will fail if the sub-id name is based on subscriber identification fields whose concatenated length exceeds 32 characters. Failing the host creation rather than truncating sub-id name on a 32 character boundary will prevent collision of sub-ids (subscriber name duplication).
In case that a more specific sub-id name generation method is not available and the auto-id keyword is not defined under the def-sub-id hierarchy, the sub-id name will be a random 10 character encoded string based on the fields defined under this command.
There is only one set of identification fields allowed per host type (IPoE or PPP) per chassis.
Parameters
| Note:
If circuit-id contains any non printable ASCI characters, the entire circuit-id string will be formatted in hex in the sub-id name output. Otherwise all characters in circuit-id will be converted to ASCII. ASCII printable characters contain bytes in range 0x20..0x7E. |
| Note:
If remote-id contains any non printable ASCI characters, the entire remote-id string will be formatted in hex in the sub-id name output. Otherwise all characters in remote-id will be converted to ASCII. ASCII printable characters contain bytes in range 0x20..0x7E. |
Subscriber Profile Commands
sub-profile
Syntax
Context
Description
This command enables the context to configure a subscriber profile. A subscriber profile is a template used to define the aggregate QoS for all hosts within a subscriber context. This is done through the definition of the egress and ingress scheduler policies that govern the aggregate SLA for subscribers using the subscriber profile. Subscriber profiles also allow for specific SLA profile definitions when the default definitions from the subscriber identification policy must be overridden.
Subscribers are either explicitly mapped to a subscriber profile template or are dynamically associated by one of various non-provisioned subscriber profile definitions.
A subscriber host can be associated with a subscriber profile in the following ways, listed from lowest to highest precedence:
- The subscriber profile named default.
- The subscriber profile defined as the subscriber SAP default.
- The subscriber profile found by the subscriber identification policy sub-profile-map.
- The subscriber profile found by the subscriber identification policy explicit map.
In the event that no defaults are defined and the subscriber identification string is not explicitly provisioned to map to a subscriber profile, either the static subscriber host creation will fail or the dynamic subscriber host DHCP ACK will be discarded.
Default Subscriber profile:
When a subscriber profile is created with the subscriber-profile-name default, it will be used when no other subscriber profile is associated with the subscriber host by the system. Creating a subscriber profile with the subscriber-profile-name default is optional. If a default subscriber profile is not created, all subscriber hosts subscriber identification strings must match either a non-provisioned default or be provisioned as an explicit match to a subscriber profile.
The default profile has no effect on existing active subscriber on the system as they exist due to higher precedence mappings.
Attempting to delete any subscriber profile (including the profile named default) while in use by existing active subscribers will fail.
Parameters
accounting-policy
Syntax
Context
Description
This command specifies the policy to use to collect accounting statistics on this subscriber profile.
A maximum of one accounting policy can be associated with a profile at one time. Accounting policies are configured in the config>log context.
The no form of this command removes the accounting policy association.
Default
no accounting policy
Parameters
collect-stats
Syntax
Context
Description
When enabled, the agent collects non-RADIUS accounting statistics.
When the no collect-stats command is issued the statistics are still accumulated by the IOM cards. However, the CPU will not obtain the results and write them to the billing file. If a subsequent collect-stats command is issued then the counters written to the billing file include all the traffic while the no collect-stats command was in effect.
Default
collect-stats
agg-rate-limit
Syntax
Context
Description
This command define a subscriber aggregate limit when the subscriber profile is directly associated with an egress port based scheduler instead of a scheduler policy. The optional queue-frame-based-accounting keyword allows the subscriber queues to operate in the frame based accounting mode.
Once egress frame based accounting is enabled on the subscriber profile, all queues associated with the subscriber (created through the sla-profile associated with each subscriber host) will have their rate and CIR values interpreted as frame based values. When shaping, the queues will include the 12 byte Inter-Frame Gap (IFG) and 8 byte preamble for each packet scheduled out the queue. The profiling CIR threshold will also include the 20 byte frame encapsulation overhead. Statistics associated with the queue do not include the frame encapsulation overhead.
The queue-frame-based-accounting keyword does not change the behavior of the egress-agg-rate-limit rate value. Since egress-agg-rate-limit is always associated with egress port based scheduling and egress port based scheduling is dependent on frame based operation, the egress-agg-rate-limit rate is always interpreted as a frame based value.
Enabling queue-frame-based-accounting will not cause statistics for queues associated with the subscriber to be cleared.
The no form of the command removes both an egress aggregate rate limit and egress frame based accounting for all subscribers associated with the sub-profile. If a subscriber’s accounting mode is changed, the subscriber’s queue statistics are cleared.
Parameters
avg-frame-size
Syntax
Context
Description
This command specifies the average frame size used in the calculation of the fixed and variable encapsulation offset when the command encap-offset is enabled in the egress context of a subscriber profile.
If the user does not explicitly configure a value for the avg-frame-size parameter, then it will also be assumed the offset is zero.
The no form of the command removes the avg-frame-size parameter from the subscriber profile.
Default
0
Parameters
encap-offset
Syntax
Context
Description
This command enables the adjustment of the queue and subscriber aggregate rate based on the last mile Ethernet or ATM encapsulation.
In R9.0, the data path computes the adjusted frame size real-time for each serviced packet from a queue by adding the actual packet size to the fixed offset provided by CPM for this queue and variable AAL5 padding.
When this command is enabled, the fixed packet offset is derived from the encapsulation type value signaled in the Access-loop-encapsulation sub-TLV in the Vendor-Specific PPPoE Tags or DHCP Relay Options as per RFC 4679. If the user specifies an encapsulation type with the command, this value is used as the default value for all hosts of this subscriber until a host session signaled a valid value. The signaled value is applied to this host only and the remaining hosts of this subscriber continue to use the user entered default type value if configured, or no offset is applied. However, hosts of the same subscriber using the same SLA profile and which are on the same SAP will share the same instance of FC queues. In this case, the last valid encapsulation value signaled by a host of that same instance of the SAP egress QoS policy will override any previous signaled or configured value.
If the user manually applied a constant byte offset to each packet serviced by the queue by configuring the packet-byte-offset, it will have no effect on the net offset computed for the packet. This net offset is stored in the subscriber host table.
The procedures for handling signaling changes or configuration changes affecting the subscriber profile are as follows:
The avg-frame-size parameter in the subscriber profile is ignored.
If the user specifies an encapsulation type with the command, this value is used as the default value for all hosts of this subscriber until a host session signaled a valid value. The signaled value is applied to this host and other hosts of the same subscriber sharing the same SLA profile and which are on the same SAP. The remaining hosts of this subscriber continue to use the user entered default type value if configured, or no offset is applied.
If the user enables/disables the encap-offset option, or changes the parameter value of the encap-offset option, CPM immediately triggers a re-evaluation of subscribers hosts using the corresponding subscriber profile and an update the IOM with the new fixed offset value.
If a subscriber has a static host or an ARP host, the subscriber host continues to use the user-configured default encapsulation type value or the last valid encapsulation value signaled in the PPPoE tags or DHCP relay options by other hosts of the same subscriber which use the same SLA profile instance. If none was signaled or configured, then no rate adjustment is applied.
When the encap-offset option is configured in the subscriber profile, the subscriber host queue rates, that is, CLI and operational PIR and CIR as well as queue bucket updates, the queue statistics, that is, forwarded, dropped, and HQoS offered counters use the last-mile frame-over-the-wire format. The scheduler policy CLI and operational rates also use LM-FoW format. The port scheduler max-rate and the priority level rates and weights, if a Weighted Scheduler Group is used, are always entered in CLI and interpreted as local port frame-over-the-wire rates. The same is true for an agg-rate-limit applied to a vport. Finally the subscriber agg-rate-limit is entered in CLI as last-mile frame-over-the-wire rate. The system maintains a running average frame expansion ratio for each queue to convert queue rates between these two formats.
Parameters
scheduler
Syntax
Context
Description
This command provides a way to override parameters of the existing scheduler associated with the egress or ingress scheduler policy. A scheduler defines bandwidth controls that limit each child (other schedulers and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created will have queues or other schedulers defined as child associations. The scheduler can be a child (take bandwidth from a scheduler in a higher tier).
Parameters
scheduler-policy
Syntax
Context
Description
This command specifies a scheduler policy to associate to the subscriber profile. Scheduler policies are configured in the configure>qos>scheduler>policy context. Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations. The policy defines the hierarchy and operating parameters for virtual schedulers.
Parameters
lag-per-link-hash
Syntax
Context
Description
This command configures weight and class to be used on LAG egress when the LAG uses weighted per-link-hash by subscribers with the profile assigned. Subscribers using profile with lag-per-link-hash default configuration, inherit weight and class from the SAP configuration (1 and 1 respectively if none configured under SAP).
The no form of this command restores default configuration.
Default
no lag-per-link-hash
policer-control-policy
Syntax
Context
Description
This command is used to create, delete, or modify policer control policies. The policer-control-policy controls the aggregate bandwidth available to a set of child policers. Once created, the policy can be applied to ingress or egress SAPs. The policy can also be applied to the ingress or egress context of a sub-profile.
Default
no policer-control-policy
Parameters
max-rate
Syntax
Context
Description
The max-rate command defines the parent policer’s PIR leaky bucket’s decrement rate. A parent policer is created for each time the policer-control-policy is applied to either a SAP or subscriber instance. Packets that are not discarded by the child policers associated with the SAP or subscriber instance are evaluated against the parent policer’s PIR leaky bucket.
For each packet, the bucket is first decremented by the correct amount based on the decrement rate to derive the current bucket depth. The current depth is then compared to one of two discard thresholds associated with the packet. The first discard threshold (discard-unfair) is applied if the FIR (Fair Information Rate) leaky bucket in the packet’s child policer is in the confirming state. The second discard threshold (discard-all) is applied if the child policer's FIR leaky bucket is in the exceed state. Only one of the two thresholds is applied per packet. If the current depth of the parent policer PIR bucket is less than the threshold value, the parent PIR bucket is in the conform state for that particular packet. If the depth is equal to or greater than the applied threshold, the bucket is in the violate state for the packet.
If the result is “conform,” the bucket depth is increased by the size of the packet (plus or minus the per-packet-offset setting in the child policer) and the packet is not discarded by the parent policer. If the result is “violate,” the bucket depth is not increased and the packet is discarded by the parent policer. When the parent policer discards a packet, any bucket depth increases (PIR, CIR and FIR) in the parent policer caused by the packet are canceled. This prevents packets that are discarded by the parent policer from consuming the child policers PIR, CIR and FIR bandwidth.
The policer-control-policy root max-rate setting may be overridden on each SAP or sub-profile where the policy is applied.
Default
max
Parameters
priority-mbs-thresholds
Syntax
Context
Description
The priority-mbs-thresholds command contains the root arbiter parent policer’s min-thresh-separation command and each priority level’s mbs-contribution command that is used to internally derive each priority level’s shared-portion and fair-portion values. The system uses each priority level’s shared-portion and fair-portion value to calculate each priority level’s discard-unfair and discard-all MBS thresholds that enforce priority sensitive rate-based discards within the root arbiter’s parent policer.
The priority-mbs-thresholds CLI node always exists and does not need to be created.
Default
None.
min-thresh-separation
Syntax
Context
Description
The min-thresh-separation command defines the minimum required separation between each in-use discard threshold maintained for each parent policer context associated with the policer-control-policy. The min-thresh-separation value may be overridden on each SAP or sub-profile to which the policy is applied.
The system uses the default or specified min-thresh-separation value in order to determine the minimum separation required between each of the of the parent policer discard thresholds. The system enforces the minimum separation based on the following behavior in two ways. The first is determining the size of the shared-portion for each priority level (when the mbs-contribution command’s optional fixed keyword is not specified):
- When a parent policer instance’s priority level has less than two child policers associated, the shared-portion for the level will be zero.
- When a parent policer instance’s priority level has two or more child policers associated, the shared-portion for the level will be equal to the current value of min-thresh-separation.
The second function the system uses the min-thresh-separation value for is determining the value per priority level for the fair-portion:
- When a parent policer instance’s priority level has no child policers associated, the fair-portion for the level will be zero.
- When a parent policer instance’s priority level has one child policer associated, the fair-portion will be equal to the maximum of the min-thresh-separation value and the priority level’s mbs-contribution value.
- When a parent policer instance's priority level has two or more child policers associated, the fair-portion will be equal to the maximum of the following:
- min-thresh-separation value
- The priority level’s mbs-contribution value less min-thresh-separation value
When the mbs-contribution command’s optional fixed keyword is defined for a priority level within the policy, the system will treat the defined mbs-contribution value as an explicit definition of the priority level’s MBS. While the system will continue to track child policer associations with the parent policer priority levels, the association counters will have no effect. Instead the following rules will be used to determine a fixed priority level’s shared-portion and fair-portion:
- If a fixed priority level’s mbs-contribution value is set to zero, both the shared-portion and fair-portion will be set to zero
- If the mbs-contribution value is not set to zero:
- The shared-portion will be set to the current min-thresh-separation value
- The fair-portion will be set to the maximum of the following:
min-thresh-separation value
mbs-contribution value less min-thresh-separation value
Each time the min-thresh-separation value is modified, the thresholds for all instances of the parent policer created through association with this policer-control-policy are reevaluated.
Determining the Correct Value for the Minimum Threshold Separation Value
The minimum value for min-thresh-separation should be set equal to the maximum size packet that will be handled by the parent policer. This ensures that when a lower priority packet is incrementing the bucket, the size of the increment will not cause the bucket's depth to equal or exceed a higher priority threshold. It also ensures that an unfair packet within a priority level cannot cause the PIR bucket to increment to the discard-all threshold within the priority.
When evaluating maximum packet size, each child policer’s per-packet-offset setting should be taken into consideration. If the maximum size packet is 1518 bytes and a per-packet-offset parameter is configured to add 20 bytes per packet, min-thresh-separation should be set to 1538 due to the fact that the parent policer will increment its PIR bucket using the extra 20 bytes.
In most circumstances, a value larger than the maximum packet size is not necessary. Management of priority level aggregate burst tolerance is intended to be implemented using the priority level mbs-contribution command. Setting a value larger than the maximum packet size will not adversely affect the policer performance, but it may increase the aggregate burst tolerance for each priority level.
| Note:
A priority level’s shared-portion of the parent policer’s PIR bucket depth is only necessary to provide some separation between a lower priority’s discard-all threshold and this priority’s discard-unfair threshold. It is expected that the burst tolerance for the unfair packets is relatively minimal since the child policers feeding the parent policer priority level all have some amount of fair burst before entering into an FIR exceed or unfair state. The fair burst amount for a priority level is defined using the mbs-contribution command. |
The no form of this command returns the policy’s min-thresh-separation value to the default value.
Default
no min-thresh-separation
Parameters
The kilobytes keyword is optional and is mutually exclusive with the bytes keyword. When specified, size is interpreted as specifying the size of min-thresh-separation in kilobytes.
priority
Syntax
Context
Description
The priority level command contains the mbs-contribution configuration command for a given strict priority level. Eight levels are supported numbered 1 through 8 with 8 being the highest strict priority.
Each of the eight priority CLI nodes always exists and do not need to be created. While parameters exist for each priority level, the parameters are only applied when the priority level within a parent policer instance is currently supporting child policers.
Default
None.
mbs-contribution
Syntax
Context
Description
The mbs-contribution command is used to configure the policy-based burst tolerance for a parent policer instance created when the policy is applied to a SAP or subscriber context. The system uses the parent policer’s min-thresh-separation value, the priority level’s mbs-contribution value and the number of child policers currently attached to the priority level to derive the priority level’s shared-portion and fair-portion of burst tolerance within the local priority level. The shared-portion and fair-portions for each priority level are then used by the system to calculate each priority level’s discard-unfair threshold and discard-all threshold.
The value for a priority level’s mbs-contribution within the policer-control-policy may be overridden on the SAP or subscriber sub-profile where the policy is applied in order to allow fine tuning of the discard-unfair and discard-all thresholds relevant to the needs of the local child policers on the object.
Accumulative Nature of Burst Tolerance for a Parent Policer Priority Level
When defining mbs-contribution, the specified size may only be a portion of the burst tolerance associated with the priority level. The packets associated with the priority level share the burst tolerance of lower within the parent policer. As the parent policer PIR bucket depth increases during congestion, the lower priority packets eventually experience discard based on each priority’s discard-unfair and discard-all thresholds. Assuming congestion continues once all the lower priority packets have been prevented from consuming bucket depth, the burst tolerance for the priority level will be consumed by its own packets and any packets associated with higher priorities.
The Effect of Fair and Unfair Child Policer Traffic at a Parent Policer Priority Level
The system continually monitors the offered rate of each child policer on each parent policer priority level and detects when the policer is in a congested state (the aggregate offered load is greater than the decrement rate defined on the parent policer). As previously stated, the result of congestion is that the parent policer's bucket depth will increase until it eventually hovers around either a discard-unfair or discard-all threshold belonging to one of the priority levels. This threshold is the point where enough packets are being discarded that the increment rate and decrement rate begin to even out. If only a single child policer is associated to the priority level, the discard-unfair threshold is not used since fairness is only applicable when multiple child policers are competing at the same priority level.
When multiple child policers are sharing the congested priority level, the system uses the offered rates and the parenting parameters of each child to determine the fair rate per child when the parent policer is unable to meet the bandwidth needs of each child. The fair rate represents the amount of bandwidth that each child at the priority level should receive relative to the other children at the same level according to the policer control policy instance managing the child policers. This fair rate is applied as the decrement rate for each child's FIR bucket. Changing a child’s FIR rate does not modify the amount of packets forwarded by the parent policer for the child’s priority level. It simply modifies the forwarded ratio between the children on that priority level. Since each child FIR bucket has some level of burst tolerance before marking its packets as unfair, the current parent policer bucket depth may at times rise above the discard-unfair threshold. The mbs-contribution value provides a means to define how much separation is provided between the priority level’s discard-unfair and discard-all threshold to allow the parent policer to absorb some amount of FIR burst before reaching the priority’s discard-all threshold.
This level of fair aggregate burst tolerance is based on the decrement rate of the parent policer’s PIR bucket while the individual fair bursts making up the aggregate are based on each child’s FIR decrement rate. The aggregate fair rate of the priority level is managed by the system with consideration of the current rate of traffic in higher priority levels. In essence, the system ensures that for each iteration of the child FIR rate calculation, the sum of the child FIR decrement rates plus the sum of the higher priority traffic increment rates equals the parent policers decrement rate. This means that dynamic amounts of higher priority traffic can be ignored when sizing a lower priority’s fair aggregate burst tolerance. Consider the following:
- The parent policer decrement rate is set to 20 Mbps (max-rate 20,000).
- A priority level’s fair burst size is set to 30 Kbytes (mbs-contribution 30 kilobytes).
- Higher priority traffic is currently taking 12 Mbps.
- The priority level has three child policers attached.
- Each child’s PIR MBS is set to 10 Kbytes, which makes each child’s FIR MBS 10 Kbytes.
- The children want 10 Mbps, but only 8 Mbps is available,
- Based on weights, the children's FIR rates are set as follows:
FIR Rate
FIR MBS
Child 1
4 Mbps
10 Kbytes
Child 2
3 Mbps
10 Kbytes
Child 3
1 Mbps
10 Kbytes
The 12 Mbps of the higher priority traffic and the 8 Mbps of fair traffic equal the 20 Mbps decrement rate of the parent policer.
It is clear that the higher priority traffic is consuming 12 Mbps of the parent policer’s decrement rate, leaving 8 Mbps of decrement rate for the lower priority’s fair traffic.
- The burst tolerance of child 1 is based on 10 Kbytes above 4 Mbps,
- The burst tolerance of child 2 is based on 10 Kbytes above 3 Mbps,
- The burst tolerance of child 3 is based on 10 Kbytes above 1 Mbps.
If all three children burst simultaneously (unlikely), they will consume 30 Kbytes above 8 Mbps. This is the same as the remaining decrement rate after the higher priority traffic.
Parent Policer Total Burst Tolerance and Downstream Buffering
The highest in-use priority level’s discard-all threshold is the total burst tolerance of the parent policer. In some cases the parent policer represents downstream bandwidth capacity and the max-rate of the parent policer is set to prevent overrunning the downstream bandwidth. The burst tolerance of the parent policer defines how much more traffic may be sent beyond the downstream scheduling capacity. In the worst case scenario, when the downstream buffering is insufficient to handle the total possible burst from the parent policer, downstream discards based on lack of buffering may occur. However, in all likelihood, this is not the case.
In most cases, lower priority traffic in the policer will be responsible for the greater part of congestion above the parent policer rate. Since this traffic is discarded with a lower threshold, this lowers the effective burst tolerance even while the highest priority traffic is present.
Configuring a Priority Level's MBS Contribution Value
In the most conservative case, a priority level’s mbs-contribution value may be set to be greater than the sum of child policer’s mbs and one max-size-frame per child policer. This ensures that even in the absolute worst case where all the lower priority levels are simultaneously bursting to the maximum capacity of each child, enough burst tolerance for the priority’s children will exist if they also burst to their maximum capacity.
Since simply adding up all the child policer’s PIR MBS values may result in large overall burst tolerances that are not ever likely to be needed, you should consider some level of burst oversubscription when configuring the mbs-contribution value for each priority level. The amount of oversubscription should be determined based on the needs of each priority level.
Using the Fixed Keyword to Create Deterministic Parent Policer Discard Thresholds
In the default behavior, the system ignores the mbs-contribution values for a priority level on a subscriber or SAP parent policer when a child policer is not currently associated with the level. This prevents additional burst tolerance from being added to higher priority traffic within the parent policer.
This does cause fluctuations in the defined threshold values when child policers are added or removed from a parent policer instance. If this behavior is undesirable, the fixed keyword may be used which causes the mbs-contribution value to always be included in the calculation of parent policer’s discard thresholds. The defined mbs-contribution value may be overridden on a subscriber sla-profile or on a SAP instance, but the fixed nature of the contribution cannot be overridden.
If the defined mbs-contribution value for the priority level is zero, the priority level will have no effect on the parent policer’s defined discard thresholds. A packet associated with the priority level will use the next lower priority level’s discard-unfair and discard-all thresholds.
Default
no mbs-contribution
The no mbs-contribution command returns the policy’s priority level’s MBS contribution to the default value. When changed, the thresholds for the priority level and all higher priority levels for all instances of the parent policer will be recalculated.
Parameters
The kilobytes keyword is optional and is mutually exclusive with the bytes keyword. When specified, size is interpreted as specifying the size of min-thresh-separation in kilobytes.
radius-accounting
Syntax
Context
Description
This command configures the radius accounting policy that will be used by the subscriber.
policy
Syntax
Context
Description
This command specifies the radius accounting policy for the subscriber that is using this subscriber profile; a second radius accounting policy can also be specified. If two radius accounting policies are configured, each policy will function according to its specific configuration, such as its accounting mode, included-attributes, update-interval, and so on.
Default
no policy
Parameters
session-optimized-stop
Syntax
Context
Description
This command optimizes a RADIUS Accounting Stop message for a PPPoE session termination (specifically for session accounting mode when the host update is enabled). By default when a PPPoE session terminates, the system removes a dual stack host in sequence, one host at a time. Therefore, the system will generate a RADIUS accounting interim for each host termination until only the final host is left. The final host will generate a final accounting stop message. Enabling this command will trigger a single Stop RADIUS accounting message and include information of all hosts without the host updates.
Default
no session-optimized-stop
sla-profile-map
Syntax
Context
Description
This command enables the context to configure SLA profile mapping.
entry
Syntax
Context
Description
This command configures SLA profile string mappings.
Parameters
use-direct-map-as-default
Syntax
Context
Description
This command enables direct mapping of the SLA profile as default.
The no form of the command disables direct mapping,
sub-mcac-policy
Syntax
Context
Description
This command references the policy template in which the mcac bandwidth limits are defined. Mcac for the subscriber is effectively enabled with this command when the sub-profile is applied to the subscriber. The bandwidth of the channels is defined in a different policy (under the config>router>mcac context) and this policy is applied on the interface level as follows:
- For group-interfaces under the config>service>vprn>igmp>grp-if>mcac context
- For regular interfaces under the config>service/router>igmp>interface>mcac context
In case of HQoS Adjustment, it is mandatory that the sub-mcac-policy be created and applied to the subscriber. The sub-mac-policy does not have to contain any bandwidth constrains, but it has to be in a no shutdown state in order for HQoS Adjustment to work.
Default
none
Parameters
volume-stats-type
Syntax
Context
Description
This command enables the reporting of layer 3 (IP) based subscriber host volume accounting data.
By default, subscriber host volume accounting data includes Layer 2 header octets and can be configured to include a fixed packet byte offset or last-mile encapsulation overhead.
Default
volume-stats-type default
Parameters
igmp-policy
Syntax
Context
Description
This command will enable IGMP processing per subscriber host. Without this command IGMP states will not be maintained per subscriber hosts. The referenced policy is defined under the configure>subscr-mgmt context and can be only applied via the sub-profile.
The referenced policy contains entries such as:
- description statement
- import statement — IGMP filters
- egress-rate-modify statement—HQoS Adjustment
- mcast-redirection statement—redirection to alternate interface
- static statement—definition of static IGMP groups
- version statement —IGMP version
- fast-leave statement
- max-num-groups statement—t max number of multicast groups allowed
This command only applies to the 7750 SR.
Parameters
hsmda
Syntax
Context
Description
This command enables the context to configure egress and ingress HSMDA queue parameters.
egress-qos
Syntax
Context
Description
This command enables the context to configure SAP egress QOS policy for the HSMDA egress queue.
ingress-qos
Syntax
Context
Description
This command enables the context to configure SAP egress QOS policy for the HSMDA ingress queue
agg-rate
Syntax
Context
Description
This command configures an aggregate rate for the vport.The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command. Applying a scheduler-policy to a VPORT is only applicable to Ethernet interfaces.
Parameters
limit-unused-bandwidth
Syntax
Context
Description
Optional command used to enable (or disable) aggregate rate overrun protection on the agg-rate context.
agg-rate-limit
Syntax
Context
Description
This command defines a maximum total rate for all subscriber egress queues for each subscriber associated with the sub-profile. The egress-agg-rate-limit command is mutually exclusive with the egress-scheduler-policy. When an egress-scheduler-policy is defined on the sub-profile, the egress-agg-rate-limit command will fail. If the egress-agg-rate-limit command is specified, at attempt to bind an egress-scheduler-policy to the sub-profile will fail.
A port scheduler policy must be applied on the egress port or channel the subscriber instance is bound to in order for the defined egress-agg-rate-limit to take effect. The egress port scheduler enforces the aggregate queue rate as it distributes its bandwidth at the various port priority levels. The port scheduler stops offering bandwidth to member queues once it has detected that the aggregate rate limit has been reached.
If a port scheduler is not defined on the egress port, the queues are allowed to operate based on their own bandwidth parameters.
The no form of the command removes the aggregate rate limit from the sub-profile.
Default
no agg-rate-limit
Parameters
qos
Syntax
Context
Description
This command assigns a SAP egress QOS policy to the HSMDA egress queue.
Parameters
qos
Syntax
Context
Description
This command assigns a SAP ingress QOS policy to the HSMDA ingress queue.
Parameters
packet-byte-offset
Syntax
Context
Description
This command adds or subtracts the specified number of bytes to the accounting function for each packet handled by the HSMDA queue. Normally, the accounting and leaky bucket functions are based on the Ethernet DLC header, payload and the 4 byte CRC (everything except the preamble and inter-frame gap). As an example, the packet-byte-offset command can be used to add the frame encapsulation overhead (20 bytes) to the queues accounting functions.
The accounting functions affected include:
- Offered High Priority / In-Profile Octet Counter
- Offered Low Priority / Out-of-Profile Octet Counter
- Discarded High Priority / In-Profile Octet Counter
- Discarded Low Priority / Out-of-Profile Octet Counter
- Forwarded In-Profile Octet Counter
- Forwarded Out-of-Profile Octet Counter
- Peak Information Rate (PIR) Leaky Bucket Updates
- Committed Information Rate (CIR) Leaky Bucket Updates
- Queue Group Aggregate Rate Limit Leaky Bucket Updates
The secondary shaper leaky bucket, scheduler priority level leaky bucket and the port maximum rate updates are not affected by the configured packet-byte-offset. Each of these accounting functions are frame based and always include the preamble, DLC header, payload and the CRC regardless of the configured byte offset.
The packet-byte-offset command accepts either add or subtract as valid keywords which define whether bytes are being added or removed from each packet traversing the queue. An example use case for subtracting bytes from each packet is an IP based accounting function. Given a Dot1Q encapsulation, the command packet-byte-offset subtract 14 would remove the DLC header and the Dot1Q header from the size of each packet for accounting functions only. The 14 bytes are not actually removed from the packet, only the accounting size of the packet is affected.
As inferred above, the variable accounting size offered by the packet-byte-offset command is targeted at the queue and queue group level. The packet-byte-offset, when set, applies to all queues in the queue group. The accounting size of the packet is ignored by the secondary shapers, the scheduling priority level shapers and the scheduler maximum rate. The actual on-the-wire frame size is used for these functions to allow an accurate representation of the behavior of the subscriber’s packets on an Ethernet aggregation network.
The packet-byte-offset value may be overridden at the queue-group level.
Parameters
| Note:
The minimum resulting packet size used by the system is 1 byte. |
queue
Syntax
Context
Description
This command specifies the HSMDA queue mapping for all packets in point-to-point services and unicast destined packets in multipoint services. Point-to-point services include epipe and other VLL type services. Multipoint services include IES, VPLS and VPRN services. The queue command does not apply to multicast, broadcast or unknown unicast packets within multipoint services (the multicast, broadcast and unknown commands must be used to define the queue mapping for non-unicast packets within a forwarding class). For Epipe services, the queue queue-id mapping applies to all packets, regardless of the packets destination MAC address.
Each forwarding class has a default queue ID based on the intrinsic hierarchy between the forwarding classes. Executing the queue command within the HSMDA context of a forwarding class with a different queue ID than the default overrides the default mapping. Multiple forwarding classes may be mapped to the same HSMDA queue ID.
The no form of the command returns the HSMDA queue mapping for queue to the default mapping for the forwarding class.
Parameters
rate
Syntax
Context
Description
This command can be used to override specific attributes of the specified queue’s Peak Information Rate (PIR) and the Committed Information Rate (CIR) parameters. The PIR defines the maximum rate that the queue can transmit packets out an egress interface (for SAP egress queues). Defining a PIR does not necessarily guarantee that the queue can transmit at the intended rate. The actual rate sustained by the queue can be limited by oversubscription factors or available egress bandwidth.
The CIR defines the rate at which the system prioritizes the queue over other queues competing for the same bandwidth. In-profile, then out-of-profile packets are preferentially queued by the system at egress and at subsequent next hop nodes where the packet can traverse. To be properly handled throughout the network, the packets must be marked accordingly for profiling at each hop.
The CIR can be used by the queue’s parent commands cir-level and cir-weight parameters to define the amount of bandwidth considered to be committed for the child queue during bandwidth allocation by the parent scheduler.
The rate command can be executed at any time, altering the PIR and CIR rates for all queues created through the association of the SAP egress QoS policy with the queue-id.
The no form of the command returns all queues created with the queue-id by association with the QoS policy to the default PIR and CIR parameters (max, 0).
Default
rate max cir 0
The max default specifies the amount of bandwidth in kilobits per second (thousand bits per second). The max value is mutually exclusive to the pir-rate value.
Parameters
Fractional values are not allowed and must be given as a positive integer.
The actual PIR rate is dependent on the queue’s adaptation-rule parameters and the actual hardware where the queue is provisioned.
slope-policy
Syntax
Context
Description
This command specifies an existing slope policy name. The policy contains the Maximum Buffer Size (MBS) that will be applied to the queue and the high and low priority RED slope definitions. The function of the MBS and RED slopes is to provide congestion control for an HSMDA queue. The MBS parameter defines the maximum depth a queue may reach when accepting packets. The low and high priority RED slopes provides for random early detection of congestion and slope based discards based on queue depth.
An hsmda-slope-policy can be applied to queues defined in the sap-ingress and sap-egress QoS policy hsmda-queues context. Once an HSMDA slope policy is applied to a SAP QoS policy queue, it cannot be deleted. Any edits to the policy are updated to all HSMDA queues indirectly associated with the policy.
Default HSMDA Slope Policy
An hsmda-slope-policy named default always exists on the system and does not need to be created. The default policy is automatically applied to all HSMDA queues unless another HSMDA slope policy is specified for the queue. The default policy cannot be modified or deleted. Attempting to execute no hsmda-slope-policy default will result in an error.
The no form of the command removes the slope policy from the subscriber profile HSMDA configuration.
stat-mode
Syntax
Context
Description
This command configures the forwarding plane octet and packet counters of a policer or queue to count packets of a specific type or state. For example separate counters for IPv4/IPv6.
For HSMDA ingress policers, this command overrides the policer stat-mode configuration as defined in the sap-ingress qos policy. For details on sap-ingress and sap-egress policer stat-mode, refer to the Quality of Service Guide. For use in Enhanced Subscriber Management (ESM) context only, an additional stat-mode enables separate counters for IPv4 and IPv6 packets. stat-mode v4-v6 is the only mode that can be configured as an HSMDA ingress policer override.
An HSMDA policer’s stat-mode cannot be changed while the sub profile is in use.
For queues, this command sets the stat-mode. Queue stat-mode is only available for use in ESM context to enable separate IPv4/IPv6 counters.
An HSMDA queue’s stat-mode cannot be changed while the sub profile is in use.
Default
no stat-mode
For policers, the default is no stat-mode override. The sap-ingress stat-mode is used instead.
For queues, the default is to count in-/out-of-profile octets and packets.
Parameters
wrr-weight
Syntax
Context
Description
This command assigns the weight value to the HSMDA queue.
The no form of the command returns the weight value for the queue to the default value.
Parameters
wrr-policy
Syntax
Context
Description
This command associates an existing HSMDA weighted-round-robin (WRR) scheduling loop policy to the HSMDA queue.
Parameters
Explicit Subscriber Mapping Commands
explicit-sub-map
Syntax
Context
Description
This command configures an explicit subscriber mapping
entry
Syntax
Context
Description
This command configures a subscriber identification string.
Parameters
Subscriber Management Service Commands
SAP Subscriber Management Commands
sub-sla-mgmt
Syntax
Context
Description
This command enables the context to configure subscriber management parameters for this SAP.
Default
no sub-sla-mgmt
def-sla-profile
Syntax
Context
Description
This command specifies a default SLA profile for this SAP.
An SLA profile is a named group of QoS parameters used to define per service QoS for all subscriber hosts common to the same subscriber within a provider service offering. A single SLA profile may define the QoS parameters for multiple subscriber hosts.
The no form of the command removes the default SLA profile from the SAP configuration.
Default
no def-sla-profile
Parameters
def-sub-profile
Syntax
Context
Description
This command specifies a default subscriber profile for this SAP.
A subscriber profile defines the aggregate QoS for all hosts within a subscriber context. This is done through the definition of the egress and ingress scheduler policies that govern the aggregate SLA for subscriber using the subscriber profile.
The no form of the command removes the default SLA profile from the SAP configuration.
Parameters
sub-ident-policy
Syntax
Context
Description
This command associates a subscriber identification policy to this SAP.
Subscribers are managed by the system through the use of subscriber identification strings. A subscriber identification string uniquely identifies a subscriber. For static hosts, the subscriber identification string is explicitly defined with each static subscriber host.
For dynamic hosts, the subscriber identification string must be derived from the DHCP ACK message sent to the subscriber host. The default value for the string is the content of Option 82 CIRCUIT-ID and REMOTE-ID fields interpreted as an octet sting. As an option, the DHCP ACK message may be processed by a subscriber identification policy which has the capability to parse the message into an alternative ASCII or octet string value.
When multiple hosts on the same port are associated with the same subscriber identification string they are considered to be host members of the same subscriber.
The no form of the command removes the default subscriber identification policy from the SAP configuration.
Default
no sub-ident-policy
Parameters
multi-sub-sap
Syntax
Context
Description
This command defines the maximum number of subscribers (dynamic + static) that can be simultaneously active on this SAP.
If the limit is reached, a new host will be denied access and the corresponding DHCP ACK will be dropped.
The no form of the command reverts back to the default setting.
Default
1
no multi-sub-sap
Parameters
single-sub-parameters
Syntax
Context
Description
This command configure single subscriber SAP parameters.
non-sub-traffic
Syntax
Context
Description
This command configures traffic profiles for non-IP traffic such as PPPoE.It is used in conjunction with the profiled-traffic-only on single subscriber SAPs and creates a subscriber host which is used to forward non-IP traffic through the single subscriber SAP without the need for SAP queues.
The no form of the command removes any configured profile.
Default
no non-sub-traffic
Parameters
profiled-traffic-only
Syntax
Context
Description
This command specifies whether only profiled traffic is applicable for this SAP. The profiled traffic refers to single subscriber traffic on a dedicated SAP (in the VLAN-per-subscriber model). When enabled, subscriber queues are instantiated through the QOS policy defined in the sla-profile and the associated SAP queues are deleted. This can increase subscriber scaling by reducing the number of queues instantiated per subscriber (in the VLAN-per-subscriber model). In order for this to be achieved, any configured multi-sub-sap limit must be removed (leaving the default of 1).
The no form of the command reverts to the default setting.
Default
no profiled-traffic-only
srrp
Syntax
Context
Description
This command creates an SRRP instance on a group IP interface. An SRRP instance manages all subscriber subnets within the group interfaces subscriber IP interface or other subscriber IP interfaces that are associated through a wholesale/retail relationship. Only one unique SRRP instance can be configured per group interface.
The no form of the command removes an SRRP instance from a group IP interface. Once removed, the group interface ignores ARP requests for the SRRP gateway IP addresses that may exist on subscriber subnets associated with the group IP interface. Then the group interface stops routing using the redundant IP interface associated with the group IP interface and will stop routing with the SRRP gateway MAC address. Ingress packets destined to the SRRP gateway MAC will also be silently discarded. This is the same behavior as a group IP interface that is disabled (shutdown).
This command applies only to the 7750 SR.
Default
no srrp
Parameters
gw-mac
Syntax
Context
Description
This command overrides the default SRRP gateway MAC address used by the SRRP instance. Unless specified, the system uses the same base MAC address for all SRRP instances with the last octet overridden by the lower 8 bits of the SRRP instance ID. The same SRRP gateway MAC address should be in-use by both the local and remote routers participating in the same SRRP context.
One reason to change the default SRRP gateway MAC address is if two SRRP instances sharing the same broadcast domain are using the same SRRP gateway MAC. The system will use the SRRP instance ID to separate the SRRP messages (by ignoring the messages that does not match the local instance ID), but a unique SRRP gateway MAC is essential to separate the routed packets for each gateway IP address.
The no form of the command removes the explicit SRRP gateway MAC address from the SRRP instance. The SRRP gateway MAC address can only be changed or removed when the SRRP instance is shutdown.
This command only applies to the 7750 SR.
Parameters
keep-alive-interval
Syntax
Context
Description
This command defines the interval between SRRP advertisement messages sent when operating in the master state. The interval is also the basis for setting the master-down timer used to determine when the master is no longer sending. The system uses three times the keep-alive interval to set the timer. Every time an SRRP advertisement is seen that is better then the local priority, the timer is reset. If the timer expires, the SRRP instance assumes that a master does not exist and initiates the attempt to become master.
When in backup state, the SRRP instance takes the keep-alive interval of the master as represented in the masters SRRP advertisement message. Once in master state, the SRRP instance uses its own configured keep-alive interval.
The keep-alive-interval may be changed at anytime, but will have no effect until the SRRP instance is in the master state.
The no form of the command restores the default interval.
This command only applies to the 7750 SR.
Parameters
message-path
Syntax
Context
Description
This command defines a specific SAP for SRRP in-band messaging. A message-path SAP must be defined prior to activating the SRRP instance. The defined SAP must exist on the SRRP instances group IP interface for the command to succeed and cannot currently be associated with any dynamic or static subscriber hosts. Once a group IP interface SAP has been defined as the transmission path for SRRP Advertisement messages, it cannot be administratively shutdown, will not support static or dynamic subscriber hosts and cannot be removed from the group IP interface.
The SRRP instance message-path command may be executed at anytime on the SRRP instance. Changing the message SAP will fail if a dynamic or static subscriber host is associated with the new SAP. Once successfully changed, the SRRP instance will immediately disable anti-spoof on the SAP and start sending SRRP Advertisement messages if the SRRP instance is activated.
Changing the current SRRP message SAP on an active pair of routers should be done in the following manner:
- Shutdown the backup SRRP instance.
- Change the message SAP on the shutdown node.
- Change the message SAP on the active master node.
- Re-activate the shutdown SRRP instance.
Shutting down the backup SRRP instance prevents the SRRP instances from becoming master due to temporarily using differing message path SAPs.
If an MCS peering is operational between the redundant nodes and the SRRP instance has been associated with the peering, the designated message path SAP will be sent from each member.
The no form of the command can only be executed when the SRRP instance is shutdown. Executing no message-path allows the existing SAP to be used for subscriber management functions. A new message-path SAP must be defined prior to activating the SRRP instance.
This command only applies to the 7750 SR.
Parameters
policy
Syntax
Context
Description
This command associates one or more VRRP policies with the SRRP instance. A VRRP policy is a collection of connectivity and verification tests used to manipulate the in-use priorities of VRRP and SRRP instances. A VRRP policy can test the link state of ports, ping IP hosts, discover the existence of routes in the routing table or the ability to reach L2 hosts. When one or more of these tests fail, the VRRP policy has the option of decrementing or setting an explicit value for the in-use priority of an SRRP instance.
More than one VRRP policy may be associated with an SRRP instance. When more than one VRRP policy is associated with an SRRP instance the delta decrement of the in-use priority is cumulative unless one or more test fail that have explicit priority values. When one or more explicit tests fail, the lowest priority value event takes effect for the SRRP instance. When the highest delta-in-use-limit is used to manage the lowest delta derived in-use priority for the SRRP instance.
VRRP policy associations may be added and removed at anytime. A maximum of two VRRP policies can be associated with a single SRRP instance.
The no form of the command removes the association with vrrp-policy-id from the SRRP instance.
This command only applies to the 7750 SR.
Parameters
priority
Syntax
Context
Description
This command overrides the default base priority for the SRRP instance. The SRRP instance priority is advertised by the SRRP instance to its neighbor router and is compared to the priority received from the neighbor router. The router with the best (highest) priority enters the master state while the other router enters the backup state. If the priority of each router is the same, the router with the lowest source IP address in the SRRP advertisement message assumes the master state.
The base priority of an SRRP instance can be managed by VRRP policies. A VRRP policy defines a set of connectivity or verification tests which, when they fail, may lower an SRRP instances base priority (creating an in-use priority for the instance). Every time an SRRP instances in-use priority changes when in master state, it sends an SRRP advertisement message with the new priority. If the dynamic priority drops to zero or receives an SRRP Advertisement message with a better priority, the SRRP instance transitions to the becoming backup state.
When the priority command is not specified, or the no priority command is executed, the system uses a default base priority of 100. The priority command may be executed at anytime.
The no form of the command restores the default base priority to the SRRP instance. If a VRRP policy is associated with the SRRP instance, it will use the default base priority as the basis for any modifications to the SRRP instances in-use priority.
This command only applies to the 7750 SR.
Parameters
srrp-enabled-routing
Syntax
Context
Description
This command configures SRRP-enabled routing and only applies to the 7750 SR.
Parameters
tos-marking-state
Syntax
Context
Description
This command is used to alter the default trusted state to a non-trusted state. When unset or reverted to the trusted default, the ToS field will not be remarked by egress network IP interfaces unless the egress network IP interface has the remark-trusted state set, in which case the egress network interface treats all VPRN and network IP interface as untrusted.
When the ingress interface is set to untrusted, all egress network IP interfaces will remark IP packets received on the network interface according to the egress marking definitions on each network interface. The egress network remarking rules also apply to the ToS field of IP packets routed using IGP shortcuts (tunneled to a remote next-hop). However, the tunnel QoS markings are always derived from the egress network QoS definitions. Egress marking and remarking is based on the internal forwarding class and profile state of the packet once it reaches the egress interface. The forwarding class is derived from ingress classification functions. The profile of a packet is either derived from ingress classification or ingress policing.
The default marking state for network IP interfaces is trusted. This is equivalent to declaring no tos-marking-state on the network IP interface. When undefined or set to tos-marking-state trusted, the trusted state of the interface will not be displayed when using show config or show info unless the detail parameter is given. The save config command will not store the default tos-marking-state trusted state for network IP interfaces unless the detail parameter is also specified.
The no tos-marking-state command is used to restore the trusted state to a network IP interface. This is equivalent to executing the tos-marking-state trusted command.
This command only applies to the 7750 SR.
Default
trusted
Parameters
mac-da-hashing
Syntax
Context
Description
This command specifies whether subscriber traffic egressing a LAG SAP has its egress LAG link selected by a function of the MAC destination address instead of the subscriber ID.
The no form of the command reverts to the default setting.
Default
no mac-da-hashing
diameter-auth-policy
Syntax
Context
Description
This command is used to configure the Diameter NASREQ application policy to use for authentication.
Parameters
host
Syntax
Context
Description
This command creates a static subscriber host for the SAP. Static subscriber hosts may be used by the system for various purposes. Applications within the system that make use of static host entries include anti-spoof, ARP reply agent and source MAC population into the VPLS forwarding database.
Multiple static hosts may be defined on the SAP. Each host is identified by either a source IP address, a source MAC address or both a source IP and source MAC address. Every static host definition must have at least one address defined, IP or MAC.
Static hosts can exist on the SAP even with anti-spoof and ARP reply agent features disabled. When enabled, each feature has different requirements for static hosts.
Use the no form of the command to remove a static entry from the system. The specified ip-address and mac-address must match the host’s exact IP and MAC addresses as defined when it was created. When a static host is removed from the SAP, the corresponding anti-spoof filter entry and/or FDB entry is also removed.
Default
none
Parameters
Every static host definition must have at least one address defined, IP or MAC.
For VPLS SAPs with arp-reply-agent enabled with the optional sub-ident parameter, the static subscriber hosts sub-ident-string is used to determine whether an ARP request received on the SAP is sourced from a host belonging to the same subscriber as the destination host. When both the destination and source hosts from the ARP request are known on the SAP and the subscriber identifications do not match, the ARP request may be forwarded to the rest of the VPLS destinations.
If the static subscriber hosts sub-ident string is not defined, the host is not considered to belong to the same subscriber as another host on the SAP.
If source or destination host is unknown, the hosts are not considered to belong to the same subscriber. (ARP messages from unknown hosts are subject to anti-spoof filtering rules applied at the SAP.)
If sub-ident is not enabled on the SAP arp-reply-agent, subscriber identification matching is not performed on ARP requests received on the SAP.
ARP requests are never forwarded back to the same SAP or within the receiving SAP’s Split Horizon Group.
| Note:
If Enhanced Subscriber Management is enabled on a SAP using the sub-sla-mgmt command, the sub-ident, sub-profile, and sla-profile must be configured for all static hosts defined on this SAP. |
Wireless Portal Protocol (WPP) Commands
wpp
Syntax
Context
Description
This command enables the context to configure Wireless Portal Protocol (WPP) parameters.
enable-triggered-hosts
Syntax
Context
Description
This command enables system to auto creates ESM hosts upon successful WPP authentication. Default host need to be configured under SAP on the subscriber SAP in order to redirection un-authentication client traffic to web portal.
Default
none
initial-app-profile
Syntax
Context
Description
This command specifies the initial app-profile for the hosts created on the group-interface. This initial app-profile will be replaced after hosts pass web portal authentication.
Default
none
Parameters
initial-sla-profile
Syntax
Context
Description
This command specifies the initial sla-profile for the hosts created on the group-interface. This initial sla-profile will be replaced after hosts pass web portal authentication.
Default
none
Parameters
initial-sub-profile
Syntax
Context
Description
This command specifies the initial sub-profile for the hosts created on the group-interface. This initial sub-profile will be replaced after hosts pass web portal authentication.
Default
none
Parameters
portals
Syntax
Context
Description
This command enables the context to configure WPP portal server parameters.
portal
Syntax
Context
Description
This command specifies the web portal server that system talks to for the hosts on the group-interface.
Default
none
Parameters
router-name: | Base, management |
service-id: | 1 — 2147483647 |
service-name: | Specifies the service name up to 64 characters in length |
lease-time
Syntax
Context
Description
This command specifies the lease time of the trigger created by the ESM host by WPP authentication.
Parameters
restore-disconnected
Syntax
Context
Description
This command specifies the behavior that system will restore the initial-sla-profile/initial-sub-profile/initial-aa-prfofile when hosts disconnects instead of removing them.
Default
none
Parameters
user-db
Syntax
Context
Description
This command configures the user database.
| Note:
If configured, the values configured under grp-if will only be used if there is no corresponding value returned from LUDB lookup. |
This command specifies the LUDB system use to lookup while creating initial host before WPP authentication. LUDB could return WPP attributes such as portal name, initial-sla-profile, initial-sub-profile, etc. LUDB is configured in config>subscr-mgmt>local-user-db context.
Default
none
Parameters
Subscriber Management Service Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
subscriber-interface
Syntax
Context
Description
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.
Use the no form of the command to remove the subscriber interface.
Default
no subscriber interfaces configured
Parameters
address
Syntax
Context
Description
This command creates or removes an IP address, IP subnet or broadcast address format for the interface. Multiple IP addresses can be associated with a subscriber-interface
The IP address for the interface can be entered in either CIDR (Classless Inter-Domain Routing) or traditional dotted decimal notation. The show commands display CIDR notation and is stored in configuration files.
In the IES subscriber interface context, this command is used to assign one or more host IP addresses and subnets. This differs from a normal IES interfaces where secondary command creates and additional subnet after the primary address is assigned. A user can then add or remove addresses without having to keep a primary address.
Use the no form of this command to remove the IP address assignment from the IP interface.
Default
no IP address or subnet associations configured
Parameters
| Note:
A mask of 255.255.255.255 is reserved for system IP addresses. |
The gw-address parameter may be specified at anytime. If the subscriber subnet was created previously, executing the address command with a gw-address parameter will simply add the SRRP gateway IP address to the existing subnet.
If the address command is executed without the gw-address parameter when the subscriber subnet is associated with an active SRRP instance, the address will fail. If the SRRP instance is inactive or removed, executing the address command without the gw-address parameter will remove the SRRP gateway IP address from the specified subscriber subnet.
If the address command is executed with a new gw-address, all SRRP instances currently associated with the specified subscriber subnet will be updated with the new SRRP gateway IP address.
ipv6
Syntax
Context
Description
This command enables the context to enable IPv6 IPoE bridged mode.
allow-unmatching-subnets
Syntax
Context
Description
This command allows address assignment for IPoEv4 and PPPoEv4 subscriber hosts in cases where the subscriber assigned IPv4 address falls outside of the subscriber-interface subnet configured under the same CLI hierarchy. Such subscriber host will be installed in the FIB as /32 hosts because the aggregated subscriber-interface route is not available for them (not configured under the subscriber-interface). Without the allow-unmatching-subnets command, such host are instantiated in the system but forwarding for them is disabled.
This command can be only configured in case where the subscriber-interface has an IP address (and therefore subnet) configured. In case where the subscriber interface does not have explicitly configured and IP address, execution of this command will fail.
IPv6 hosts are not affected by this command.
Default
no allow-unmatching-subnets
allow-unmatching-subnets
Syntax
Context
Description
This command will allow address assignment for IPoEv6 and PPPoEv6 hosts in cases where the subscriber host assigned IPv6 address or prefix falls outside of the subscriber-prefix range explicitly configured for the subscriber-interface (configure>service>vprn/ies>sub-if>ipv6) or the subscriber-prefix is not configured at all.
SLAAC hosts will be installed in the FIB as /64 entries, the length of the installed DHCP-PD prefix will be dictated by the prefix-length and the DHCP-NA host will be installed as /128 entries.
IPv4 subscriber hosts are unaffected by this command.
Default
no allow-unmatching-subnets
allow-unmatching-prefixes
Syntax
Context
Description
This command will allow address assignment for IPoEv6 and PPPoEv6 hosts in cases where the subscriber host assigned IPv6 address or prefix falls outside of the subscriber-prefix range explicitly configured for the subscriber-interface (configure>service>vprn/ies>sub-if>ipv6) or the subscriber-prefix is not configured at all.
SLAAC hosts will be installed in the FIB as /64 entries, the length of the installed DHCP-PD prefix will be dictated by the prefix-length and the DHCP-NA host will be installed as /128 entries.
IPv4 subscriber hosts are unaffected by this command.
Default
no allow-unmatching-subnets
authentication-policy
Syntax
Context
Description
This command assigns an authentication policy to the interface.
The no form of this command removes the policy name from the group interface configuration.
Default
no authentication-policy
Parameters
arp-populate
Syntax
Context
Description
This command enables populating static and dynamic hosts into the system ARP cache. When enabled, the host’s IP address and MAC address are placed in the system ARP cache as a managed entry. Static hosts must be defined on the interface using the host command. Dynamic hosts are enabled on the system through enabling lease-populate in the IP interface DHCP context. In the event that both a static host and a dynamic host share the same IP and MAC address, the system’s ARP cache retains the host information until both the static and dynamic information are removed. Both static and dynamic hosts override static ARP entries. Static ARP entries are marked as inactive when they conflict with static or dynamic hosts and will be repopulated once all static and dynamic host information for the IP address are removed. Since static ARP entries are not possible when static subscriber hosts are defined or when DHCP lease state table population is enabled, conflict between static ARP entries and the arp-populate function is not an issue.
The arp-populate command will fail if an existing static subscriber host on the SAP does not have both MAC and IP addresses specified.
Once arp-populate is enabled, creating a static subscriber host on the SAP without both an IP address and MAC address will fail.
arp-populate can only be enabled on VPRN interfaces supporting Ethernet encapsulation.
Use the no form of the command to disable ARP cache population functions for static and dynamic hosts on the interface. All static and dynamic host information in the systems ARP cache will be removed. Any existing static ARP entries previously inactive due to static or dynamic hosts will be populated in the system ARP cache.
When arp-populate is enabled, the system will not send out ARP Requests for hosts that are not in the ARP cache. Only statically configured and DHCP learned hosts are reachable through an IP interface with arp-populate enabled.
Default
not enabled
arp-timeout
Syntax
Context
Description
This command configures the minimum time in seconds an ARP entry learned on the IP interface will be stored in the ARP table. ARP entries are automatically refreshed when an ARP request or gratuitous ARP is seen from an IP host, otherwise, the ARP entry is aged from the ARP table. If arp-timeout is set to a value of zero seconds, ARP aging is disabled.
Default
14400 seconds
Parameters
lease-populate
Syntax
Context
Description
This command enables dynamic host lease state management for SAPs.
For VPLS, DHCP snooping must be explicitly enabled (using the snoop command) at all points where DHCP messages requiring snooping enter the VPLS instance (both from the DHCP server and from the subscribers). Lease state information is extracted from snooped DHCP ACK messages to populate lease state table entries for the MSAP.
The optional number-of-entries parameter is used to define the number lease state table entries allowed for an MSAP or IP interface. If number-of-entries is omitted, only a single entry is allowed. Once the maximum number of entries has been reached, subsequent lease state entries are not allowed and subsequent DHCP ACK messages are discarded.
The retained lease state information representing dynamic hosts may be used to:
- Populate an MSAP based anti-spoof filter table to provide dynamic anti-spoof filtering. If the system is unable to populate the dynamic host information in the anti-spoof filter table on the SAP, the DHCP ACK message must be discarded without adding new lease state entry or updating an existing lease state entry.
- Generate dynamic ARP replies if arp-reply-agent is enabled.
The no form of the command disables dynamic host lease state management for the MSAP.
Default
no lease-populate
delayed-enable
Syntax
Context
Description
This command delays making interface operational by the specified number of seconds.
In environments with many subscribers, it can take time to synchronize the subscriber state between peers when the subscriber-interface is enabled (perhaps, after a reboot). To ensure that the state has time to be synchronized, the delayed-enable timer can be specified. The optional parameter init-only can be added to use this timer only after a reboot.
Default
no delayed-enable
Parameters
export-host-routes
Syntax
Context
Description
This command controls the export of subscriber management host routes from a retail service to the corresponding forwarding wholesale VPRN service.
By default, subscriber management host routes are not exported.
The presence of retail subscriber management host routes in the wholesale VPRN service is required for downstream traffic forwarding in multi-chassis redundancy scenario’s with a redundant interface and when the retail subscriber subnets are not leaked in the wholesale VPRN service (allow-unmatching-subnets or unnumbered retail subscriber interface).
This command will fail if the subscriber interface is not associated with a forwarding wholesale service subscriber interface or if the subscriber interface is not configured to support address allocation outside the provisioned subnets (allow-unmatching-subnets or unnumbered subscriber interface)
Default
no export-host-routes
group-interface
Syntax
Context
Description
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.
Use the no form of the command to remove the group interface from the subscriber interface.
Default
no group interfaces configured
Parameters
data-trigger
Syntax
Context
Description
This command enabled the context to configure data-triggered subscriber management entities.
ingress
Syntax
Context
Description
This command configures ingress network filter policies for the interface.
policy-accounting
Syntax
Context
Description
This command enables/disables the specified policy accounting template.
ip-mtu
Syntax
Context
Description
This command specifies the maximum size of ip packets on this group-interface. Packets larger than this will get fragmented.
The ip-mtu applies to all IPoE host types (dhcp, arp, static). For PPP/L2TP sessions, the ip-mtu is not taken into account for the mtu negotiation; the ppp-mtu in the ppp-policy should be used instead.
Default
none
Parameters
enable-ingress-stats
Syntax
Context
Description
This command enables the collection of ingress interface IP stats. This command is only appliable to IP statistics, and not to uRPF statistics.
If enabled, then the following statistics are collected:
- IPv4 offered packets
- IPv4 offered octets
- IPv6 offered packets
- IPv6 offered octets
| Note:
Octet statistics for IPv4 and IPv6 bytes at IP interfaces include the layer 2 frame overhead. |
Default
no enable-ingress-stats
host-connectivity-verify
Syntax
Context
Description
This command enables subscriber host connectivity verification on a given SAP within a service. This tool will periodically scan all known hosts (from dhcp-state) and perform UC ARP requests. The subscriber host connectivity verification will maintain state (connected vs. not-connected) for all hosts.
Default
no host-connectivity-verify
Parameters
ipoe-linking
Syntax
Context
Description
This command enables the context to configure IPoE host linking.
gratuitous-rtr-adv
Syntax
Context
Description
If enabled, this command controls generation of unsolicited Router-advertisement on creation of v4 host.
The no form of the command disables gratuitous-rtr-adv.
Default
gratuitous-rtr-adv
ipoe-session
Syntax
Context
Description
This command enables the context to configure IPoE session parameters.
shared-circuit-id
Syntax
Context
Description
If configured, circuit-id in DHCPv4 option-82 is used to authenticate DHCPv6. If DHCPv6 is received before DHCPv4, it is dropped. Also, a SLAAC host is created based on DHCPv4 authentication if RADIUS returns IPv6 framed-prefix. IPv6oE host is deleted if the linked IPv4oE host is deleted due to DHCP release or lease time-out. The linkage between IPv4 and IPv6 is based on SAP and MAC address. The sharing of circuit-id from DHCPv4 for authentication of DHCPv6 (or SLAAC) allows 7750 SR to work around lack of support for LDRA on Access-nodes.
The no form of the command disables the feature.
Default
no shared-circuit-id
ipv6
Syntax
Context
Description
This command enables the context to configure IPv6 for an IES interface.
urpf-check
Syntax
Context
Description
This command enables unicast RPF (uRPF) Check on this interface.
The no form of the command disables unicast RPF (uRPF) Check on this interface.
Default
disabled
mode
Syntax
Context
Description
This command specifies the mode of unicast RPF check.
The no form of the command reverts to the default (strict) mode.
Default
strict
Parameters
match-circuit-id
Syntax
Context
Description
This command enables Option 82 circuit ID on relayed DHCP packet matching. For routed CO, the group interface DHCP relay process is stateful. When packets are relayed to the server the virtual router ID, transaction ID, SAP ID, and client hardware MAC address of the relayed packet are tracked.
When a response is received from the server the virtual router ID, transaction ID, and client hardware MAC address must be matched to determine the SAP on which to send the packet out. In some cases, the virtual router ID, transaction ID, and client hardware MAC address are not guaranteed to be unique.
When the match-circuit-id command is enabled this as part of the key is used to guarantee correctness in our lookup. This is really only needed when dealing with an IP aware DSLAM that proxies the client hardware MAC address.
Default
no match-circuit-id
mac
Syntax
Context
Description
This command assigns a specific MAC address to a subscriber group interface.
The no form of the command returns the MAC address of the group interface to the default value.
Default
The physical MAC address associated with the Ethernet interface that the SAP is configured on (the default MAC address assigned to the interface, assigned by the system).
Parameters
oper-up-while-empty
Syntax
Context
Description
This command allows the subscriber interface to treat this group interface to be operationally enabled without any active SAPs.
This command is typically used with MSAPs where advertising the subnet prior to having a MSAP dynamically created is needed.
policy-control
Syntax
Context
Description
This command configures a policy-control policy for the interface.
Parameters
mode
Syntax
Context
Description
This command configures the ATM MDA into a mode with the increased VC scale (16k VCs, as opposed to 8K VCs). ESM is supported only in 16K VCs mode. In 16K VCs mode, there is only one queue allocated to each VC in the ATM MDA. In 8K VCs mode, there are two queues allocated per VC.
The 16K VC mode is supported only on the 4 port oc-3/12c/STM-1/4c and the 16 port ATM oc-3/STM-1 ATM MDA.
Changing the ATM MDA mode requires a reset of the MDA. A warning is issued asking for the confirmation before the command is executed.
Default
max8k-vc.
Parameters
agg-rate
Syntax
Context
Description
This command is used to control an HQoS aggregate rate limit. It is used in conjunction with the following parameter commands: rate, limit-unused-bandwidth, and queue-frame-based-accounting.
When specified under a VPORT, the agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
rate
Syntax
Context
Description
This command defines the enforced aggregate rate for all queues associated with the agg-rate context. A rate must be specified for the agg-rate context to be considered to be active on the context’s object (SAP, subscriber, VPORT etc.).
Parameters
limit-unused-bandwidth
Syntax
Context
Description
This command is used to enable (or disable) aggregate rate overrun protection on the agg-rate context.
queue-frame-based-accounting
Syntax
Context
Description
This command is used to enabled (or disable) frame based accounting on all queues associated with the agg-rate context. Only supported on Ethernet ports. Not supported on HSMDA Ethernet ports.
vpi
Syntax
Context
Description
This command enables the ATM VP shaper under the ATM port. The type of ATM shaper are CBR or rt/nrt-VBR as defined by the traffic descriptor. It cannot be a UBR service-type.
All VCs within the shaper will degrade into a UBR type service class. For example, when a CBR type VC is associated with the shaper, it will degrade into a UBR type VC. Scheduling traffic amongst VCs within the shaper is based on WRR using the weight parameter.
If the VP shaper is deleted, the VCs that were under it is restored to their original service category.
The VP shaper is statically configured and instantiated upon configuration.
A VP shaper can be seamlessly added to or removed from the active VCs in the system.
Default
none
Parameters
traffic-desc
Syntax
Context
Description
This command references traffic-descriptor id for VPs and VCs.
The VP shaper cannot be of service-type UBR.
Default
Default traffic descriptor (id=1) of UBR type.
Parameters
weight
Syntax
Context
Description
VCs within the VP tunnel are serviced by a single scheduler assigned to each VP tunnel. VCs within the shaped VP tunnel will be degraded from the originally assigned service category to a common UBR service category (default traffic descriptor). Scheduling between VCs will be based on WRR with a weight parameter that can be explicitly configured in the ATM traffic descriptor profile. If weight is not specifically configured, the defaults are taken.
The explicitly configured weight parameter is honored only on the ATM MDA in the max16k-vc mode. On all other ATM capable MDAs (ASAP or ATM MDA in max8k-vc mode), the weight parameter is ignored.
Default
VC degraded from CBR = weight 10
VC degraded from rt-VBR = weight 7
VC degraded from nrt-VBR = weight 5
VC degraded from UBR+ = weight 2
VC degraded from UBR = weight 1
Parameters
encapsulation
Syntax
Context
Description
This command is a SAP level command and it will either statically set or enable dynamic detection of the encapsulation.
Default
snap-bridged
Parameters
| Note:
On ATM frames with Ethernet FCS or without FCS are accepted but only frames with no Ethernet FCS are sent. |
def-inter-dest-id
Syntax
Context
Description
This command is used to associate the vport with the subscriber. The association method will depend on the configured option.
Default
Disabled
Parameters
Alternatively, the destination string can be defined in LUDB.
Control Plane will be aware of the VPI during the session initiation phase. This VPI will be used to make the association between the host and the vport with the same name (VPI number).
| Note:
In this case the vport name under the configure>port>sonet-sdh>path>access>egress context must be the VPI number. |
pppoe-user-db
Syntax
Context
Description
This command will enable LUDB authentication on capture SAPs for PPPoE(oA) clients. In case that this command is configured along with the authentication-policy command (RADIUS authentication), then the authentication-policy command will take precedence.
Optionally, with a separate command (ppp-user-db) PPPoA clients can be authenticated under a separate LUDB.
Default
Disabled
Parameters
ppp-user-db
Syntax
Context
Description
This command will enable LUDB authentication on capture SAPs for PPPoA clients. In case that this command is configured along with the authentication-policy command (RADIUS authentication), then the authentication-policy command will take precedence.
Optionally, with a separate command (pppoe-user-db) PPPoE(oA) clients can be authenticated under a separate LUDB.
Default
Disabled
Parameters
ppp-policy
Syntax
Context
Description
This command will reference a ppp-policy that will define session parameters (ppp-mtu, authentication options, etc.) during the session initiation phase. Normally, ppp-policy is referenced under the group-interface hierarchy. But with capture SAP is it not known at the session initiation phase to which group-interface the session belongs. This is why, with the capture SAP, the ppp-policy must be referenced directly under the capture SAP. The ppp-policy referenced under the group-interface must be the same as the ppp-policy referenced under the capture SAP. Otherwise the session will not come up.
Default
Disabled
Parameters
pppoe-policy
Syntax
Context
Description
This command will reference a pppoe-policy that will define session parameters (ppp-mtu, authentication options, etc.) during the session initiation phase. Normally, pppoe-policy is referenced under the group-interface hierarchy. But with capture SAP is it not known at the session initiation phase to which group-interface the session belongs. This is why, with the capture SAP, the ppp-policy must be referenced directly under the capture SAP. The pppoe-policy referenced under the group-interface must be the same as the pppoe-policy referenced under the capture SAP. Otherwise the session will not come up.
Default
Disabled
Parameters
rtr-solicit-user-db
Syntax
Context
Description
This command enabled access to LUDB for SLAAC hosts under the capture SAP. The name of this ludb must match the name of ludb configured under the configure>service>vprn/ies>subscrintf>group-intf>ipv6>router-solicit> hierarchy.
Default
no rtr-solicit-user-db
Parameters
vc-range
Syntax
Context
Description
This command is supported only in max16k-vc ATM MDA mode. An ATM MDA supports a number (see scaling guides for more info) of passive (or listening) VCs, of which a subset can be simultaneously active.
Default
Disabled
Parameters
local-address-assignment
Syntax
Context
Description
This command enables the context t configure the local address assignment.
ipv6
Syntax
Context
Description
This command configures the IPv6 local address assignment.
client-application
Syntax
Context
Description
This command enables local router DHCP server pool management for PPPoXv4 clients. A pool of IP addresses can be shared between IPoE clients that rely on DHCP protocol (lease renewal process) and PPPoX clients wehre address allocation is not dependent on DHCP messaging but instead an IP address allocation within the pool is tied to the PPPoX session.
client-application
Syntax
Context
Description
This defines the client application that will use the local address server to perform address assignment. This feature is relies on RADIUS or local-user-database to return a pool name. The pool name is matched again the pools defined in the local-dhcp6-server. The name of the local-dhcp6-server must also be provisioned.
Parameters
default-pool
Syntax
Context
Description
This command references a default DHCP address pool for local PPPoX pool management in case that the pool-name is not retuned via RADIUS or LUDB.
Parameters
server
Syntax
Context
Description
This command designates a local router DHCPv4 server for local pools management where IPv4 addresses for PPPoXv4 clients will be allocated without the need for the internal router DHCP relay-agent. Those addresses will be tied to PPPoX sessions and they will be de-allocated when the PPPoX session is terminated.
Parameters
server
Syntax
Context
Description
This command designates a local router DHCPv6 server for local pools management where IPv6 prefixes or address for PPPoXv6 clients or IPoEv6 clients will be allocated without the need for the internal router DHCP relay-agent. Those addresses will be tied to PPPoX or IPoE sessions and they will be de-allocated when the PPPoX or IPoE session is terminated.
Default
none
Parameters
Layer 3 Subscriber Interfaces SAP Commands
accounting-policy
Syntax
Context
Description
This command specifies the policy to use to collect accounting statistics on a subscriber profile.
A maximum of one accounting policy can be associated with a profile at one time.
The no form of this command removes the accounting policy association.
This command only applies to the 7750 SR.
Default
no accounting policy
Parameters
anti-spoof
Syntax
Context
Description
This command configures the anti-spoof type of the MSAP.
The type of anti-spoof filtering defines what information in the incoming packet is used to generate the criteria to lookup an entry in the anti-spoof filter table. The type parameter (ip, ip-mac) defines the anti-spoof filter type enforced by the SAP when anti-spoof filtering is enabled.
The no form of the command reverts back to the default.
| Note:
For IES and VPRN subscriber group interfaces, setting no anti-spoof will set the default anti-spoofing type which is ip-mac. |
Default
no anti-spoof
Parameters
| Note:
This parameter is not applicable in the config>subscr-mgmt>msap-policy context. |
app-profile
Syntax
Context
Description
This command configures the application profile name and only applies to the 7750 SR.
Parameters
collect-stats
Syntax
Context
Description
When enabled, the agent collects non-RADIUS accounting statistics on a subscriber profile.
When the no collect-stats command is issued the statistics are still accumulated by the IOM cards. However, the CPU will not obtain the results and write them to the billing file. If a subsequent collect-stats command is issued then the counters written to the billing file include all the traffic while the collect-stats
Default
collect-stats
default-host
Syntax
Context
Description
This command configures the default-host. More than one default host can be configured per SAP.
Default
no lease-populate
Parameters
ipv4-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D | |
prefix-length - [0..128] | |
ipv6-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D | |
prefix-length - [0..128] | |
cpu-protection
Syntax
Context
Description
This command assigns an existing CPU protection policy to the associated group interface. The CPU protection policies are configured in the config>sys>security>cpu-protection>policy cpu-protection-policy-id context.
If no CPU-Protection policy is assigned to a group interface SAP, then the default policy is used to limit the overall-rate. The default policy is policy number 254 for access interfaces and 255 for network interfaces.
The no form of the command removes the association of the CPU protection policy from the associated interface and reverts to the default policy values.
Default
cpu-protection 254 (for access interfaces)
cpu-protection 255 (for network interfaces)
The configuration of no cpu-protection returns the interface/SAP to the default policies as shown above.
Parameters
egress
Syntax
Context
Description
This command enables the context to configure egress SAP Quality of Service (QoS) policies and filter policies.
If no sap-egress QoS policy is defined, the system default sap-egress QoS policy is used for egress processing. If no egress filter is defined, no filtering is performed.
This command only applies to the 7750 SR.
filter
Syntax
Context
Description
This command associates an IP filter policy with an ingress or egress Service Access Point (SAP). Filter policies control the forwarding and dropping of packets based on the matching criteria.
MAC filters are only allowed on Epipe and Virtual Private LAN Service (VPLS) SAPs.
The filter command is used to associate a filter policy with a specified ip-filter-id with an ingress or egress SAP. The filter policy must already be defined before the filter command is executed. If the filter policy does not exist, the operation will fail and an error message returned.
In general, filters applied to SAPs (ingress or egress) apply to all packets on the SAP. One exception is non-IP packets are not applied to the match criteria, so the default action in the filter policy applies to these packets.
The no form of this command removes any configured filter ID association with the SAP. The filter ID itself is not removed from the system unless the scope of the created filter is set to local. To avoid deletion of the filter ID and only break the association with the service object, use the scope command within the filter definition to change the scope to local or global. The default scope of a filter is local.
This command only applies to the 7750 SR.
Special Cases
Parameters
qos
Syntax
Context
Description
Associates a Quality of Service (QoS) policy with an egress Service Access Point (SAP) or IP interface.
QoS egress policies are important for the enforcement of SLA agreements. The policy ID must be defined prior to associating the policy with a SAP or IP interface. If the policy-id does not exist, an error will be returned.
The qos command is used to associate egress QoS policies. The qos command only allows egress policies on SAP or IP interface egress. Attempts to associate a QoS policy of the wrong type returns an error.
Only one ingress QoS policy can be associated with a SAP or IP interface at one time. Attempts to associate a second QoS policy of a given type will return an error.
By default, no specific QoS policy is associated with the SAP or IP interface for egress, so the default QoS policy is used.
The normal behavior is for queues to be created per destination.
The no form of this command removes the QoS policy association from the SAP or IP interface, and the QoS policy reverts to the default.
This command only applies to the 7750 SR.
Parameters
qos
Syntax
Context
Description
Associates a Quality of Service (QoS) policy with an ingress Service Access Point (SAP) or IP interface.
QoS ingress policies are important for the enforcement of SLA agreements. The policy ID must be defined prior to associating the policy with a SAP or IP interface. If the policy-id does not exist, an error will be returned.
This qos command is used to associate ingress QoS policies. The qos command only allows ingress policies to be associated on SAP or IP interface ingress.
Only one ingress and one egress QoS policy can be associated with a SAP or IP interface at one time. Attempts to associate a second QoS policy of a given type will return an error.
By default, no specific QoS policy is associated with the SAP or IP interface for ingress so the default QoS policy is used.
The normal behavior is for queues to be created per destination. Shared and multipoint shared change this behavior creating either unicast or unicast and mcast shared queues.
The no form of this command removes the QoS policy association from the SAP or IP interface, and the QoS policy reverts to the default.
This command only applies to the 7750 SR.
Parameters
scheduler-policy
Syntax
Context
Description
This command applies an existing scheduler policy to an ingress or egress scheduler used by SAP queues associated with this multi-service customer site. The schedulers defined in the scheduler policy can only be created once the customer site has been appropriately assigned to a chassis port, channel or slot. Scheduler policies are defined in the config>qos>scheduler-policy scheduler-policy-name context.
The no form of this command removes the configured ingress or egress scheduler policy from the multi-service customer site. When the policy is removed, the schedulers created due to the policy are removed also making them unavailable for the ingress SAP queues associated with the customer site. Queues that lose their parent scheduler association are deemed to be orphaned and are no longer subject to a virtual scheduler. The SAPs that have ingress queues reliant on the removed schedulers enter into an operational state depicting the orphaned status of one or more queues. When the no scheduler-policy command is executed, the customer site ingress or egress node will not contain an applied scheduler policy.
This command only applies to the 7750 SR.
Parameters
host
Syntax
Context
Description
This command creates a static subscriber host for the SAP. Static subscriber hosts may be used by the system for various purposes. Applications within the system that make use of static host entries include anti-spoof filters and ARP cache population.
Multiple static hosts may be defined on the SAP. Each host is identified by either a source IP address, a source MAC address or both a source IP and source MAC address. Every static host definition must have at least one address defined, IP or MAC.
Static hosts can exist on the SAP even with anti-spoof and ARP populate features disabled. When enabled, each feature has different requirements for static hosts.
Default
none
Parameters
Attempting to define a static subscriber host that conflicts with an existing DHCP lease state table entry will fail.
Use the no form of the command to remove a static entry from the system. The specified ip-address and mac-address must match the host’s exact IP and MAC addresses as defined when it was created. When a static host is removed from the SAP, the corresponding anti-spoof entry and/or ARP cache entry is also removed.
This command only applies to the 7750 SR.
For VPRN SAPs with arp-reply-agent enabled with the optional sub-ident parameter, the static subscriber hosts sub-ident-string is used to determine whether an ARP request received on the SAP is sourced from a host belonging to the same subscriber as the destination host. When both the destination and source hosts from the ARP request are known on the SAP and the subscriber identifications do not match, the ARP request may be forwarded to the rest of the VPRN destinations.
If the static subscriber hosts sub-ident string is not defined, the host is not considered to belong to the same subscriber as another host on the SAP.
If source or destination host is unknown, the hosts are not considered to belong to the same subscriber. (ARP messages from unknown hosts are subject to anti-spoof filtering rules applied at the SAP.)
If sub-ident is not enabled on the SAP arp-reply-agent, subscriber identification matching is not performed on ARP requests received on the SAP.
ARP requests are never forwarded back to the same SAP or within the receiving SAP’s Split Horizon Group.
ingress
Syntax
Context
Description
This command enables the context to configure ingress SAP Quality of Service (QoS) policies and filter policies.
If no SAP ingress QoS policy is defined, the system default sap-ingress QoS policy is used for ingress processing. If no ingress filter is defined, no filtering is performed.
This command only applies to the 7750 SR.
multi-service-site
Syntax
Context
Description
This command creates a new customer site or edits an existing customer site with the customer-site-name parameter. A customer site is an anchor point to create an ingress and egress virtual scheduler hierarchy. When a site is created, it must be assigned to a chassis slot or port. When scheduler policies are defined for ingress and egress, the scheduler names contained in each policy are created according to the parameters defined in the policy. Multi-service customer sites exist for the sole purpose of creating a virtual scheduler hierarchy and making it available to queues on multiple Service Access Points (SAPs).
The scheduler policy association with the customer site normally prevents the scheduler policy from being deleted until after the scheduler policy is removed from the customer site. The multi-service-site object will generate a log message indicating that the association was deleted due to scheduler policy removal.
When the multi-service customer site is created, an ingress and egress scheduler policy association does not exist. This does not prevent the site from being assigned to a chassis slot or prevent service SAP assignment. After the site has been created, the ingress and egress scheduler policy associations can be assigned or removed at anytime.
This command only applies to the 7750 SR.
Default
None — Each customer site must be explicitly created.
Parameters
If the customer-site-name does not exist, it is assumed that an attempt is being made to create a site of that name in the customer ID context. The success of the command execution depends on the following:
The maximum number of customer sites defined for the chassis slot has not been met.
The customer-site-name is valid.
The create keyword is included in the command line syntax (if the system requires it).
When the maximum number of customer sites has been exceeded a configuration error occurs, the command will not execute and the CLI context will not change.
If the customer-site-name is invalid, a syntax error occurs, the command will not execute and the CLI context will not change.
ATM Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
atm
Syntax
Context
Description
This command enables access to the context to configure ATM-related attributes. This command can only be used when a given context (for example, a channel or SAP) supports ATM functionality such as:
- Configuring ATM port or ATM port-related functionality on MDAs supporting ATM functionality
- Configuring ATM-related configuration for ATM-based SAPs that exist on MDAs supporting ATM functionality.
If ATM functionality is not supported for a given context, the command returns an error.
egress
Syntax
Context
Description
This command enables the context to configure egress ATM attributes for the SAP.
encapsulation
Syntax
Context
Description
This command configures RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, encapsulation for an ATM PVCC delimited SAP.
This command specifies the data encapsulation for an ATM PVCC delimited SAP. The definition references RFC 2684 and to the ATM Forum LAN Emulation specification.
Ingress traffic that does not match the configured encapsulation will be dropped.
Default
The encapsulation is driven by the services for which the SAP is configured. For IES service SAPs, the default is aal5snap-routed.
Parameters
ingress
Syntax
Context
Description
This command configures ingress ATM attributes for the SAP.
traffic-desc
Syntax
Context
Description
This command assigns an ATM traffic descriptor profile to a given context (for example, a SAP). When configured under the ingress context, the specified traffic descriptor profile defines the traffic contract in the forward direction. When configured under the egress context, the specified traffic descriptor profile defines the traffic contract in the backward direction.
The no form of the command reverts the traffic descriptor to the default traffic descriptor profile.
Default
The default traffic descriptor (trafficDescProfileId. = 1) is associated with newly created PVCC-delimited SAPs.
Parameters
oam
Syntax
Context
Description
This command enables the context to configure OAM functionality for a PVCC delimiting a SAP.
The ATM-capable MDAs support F5 end-to-end OAM functionality (AIS, RDI, Loopback):
- ITU-T Recommendation I.610 - B-ISDN Operation and Maintenance Principles and Functions version 11/95
- GR-1248-CORE - Generic Requirements for Operations of ATM Network Elements (NEs). Issue 3 June 1996
- GR-1113-CORE - Bellcore, Asynchronous Transfer Mode (ATM) and ATM Adaptation Layer (AAL) Protocols Generic Requirements, Issue 1, July 1994
alarm-cells
Syntax
Context
Description
This command configures AIS/RDI fault management on a PVCC. Fault management allows PVCC termination to monitor and report the status of their connection by propagating fault information through the network and by driving PVCCs operational status.
When alarm-cells functionality is enabled, PVCCs operational status is affected when a PVCC goes into AIS or RDI state because of an AIS/RDI processing (i.e. assuming nothing else affects PVCCs operational status, PVCC goes DOWN, when it enters a fault state and comes back UP, when it exits that fault state) and RDI cell are generated when PVCC is operationally DOWN. No OAM-specific SNMP trap is raised whenever an endpoint enters/exits an AIS or RDI states, however, if as result of an OAM state change, the PVCC changes operational status, then a trap is expected from an entity the PVCC is associated with (for example a SAP).
The no command disables alarm-cells functionality for a PVCC. When alarm-cells functionality is disabled, PVCCs operational status is no longer affected by PVCCs OAM state changes due to AIS/RDI processing (when alarm-cells is disabled, a PVCC will change operational status to UP, if it was DOWN because of the alarm-cell processing) and RDI cells are not generated as result of PVCC going into AIS or RDI state, however, PVCCs OAM status will record OAM faults as described above.
Default
Enabled for PVCCs delimiting IES SAPs
periodic-loopback
Syntax
Context
Description
This command enables periodic OAM loopbacks on this SAP. This command is only configurable on IES and VPRN SAPs. When enabled, an ATM OAM loopback cell is transmitted every period as configured in the config>system>atm>oam>loopback-period period context.
If a response is not received and consecutive retry-down retries also result in failure, the endpoint will transition to an alarm indication signal/loss of clock state. Then, an ATM OAM loopback cell will be transmitted every period as configured in the loopback-period period. If a response is received for the periodic loopback and consecutive retry-up retries also each receive a response, the endpoint will transition back to the up state.
The no form of the command sets the value back to the default.
Default
no periodic-loopback
Redundant Interface Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
redundant-interface
Syntax
Context
Description
This command configures a redundant interface.
Parameters
address
Syntax
Context
Description
This command assigns an IP address mask or netmask and a remote IP address to the interface.
Parameters
Assigns an IP address netmask to the interface.
spoke-sdp
Syntax
Context
Description
This command binds a service to an existing Service Distribution Point (SDP).
A spoke SDP is treated like the equivalent of a traditional bridge “port” where flooded traffic received on the spoke SDP is replicated on all other “ports” (other spoke and mesh SDPs or SAPs) and not transmitted on the port it was received.
The SDP has an operational state which determines the operational state of the SDP within the service. For example, if the SDP is administratively or operationally down, the SDP for the service will be down.
The SDP must already be defined in the config>service>sdp context in order to associate an SDP with a VPRN service. If the sdp sdp-id is not already configured, an error message is generated. If the sdp-id does exist, a binding between that sdp-id and the service is created.
SDPs must be explicitly associated and bound to a service. If an SDP is not bound to a service, no far-end 7750 SRdevices can participate in the service.
The no form of this command removes the SDP binding from the service. The SDP configuration is not affected; only the binding of the SDP to a service. Once removed, no packets are forwarded to the far-end router.
Default
No sdp-id is bound to a service.
Special Cases
Parameters
egress
Syntax
Context
Description
This command configures egress SDP parameters.
ingress
Syntax
Context
Description
This command configures ingress SDP parameters.
vc-label
Syntax
Context
Description
This command configures the egress VC label.
Parameters
vc-label
Syntax
Context
Description
This command configures the ingress VC label.
Parameters
filter
Syntax
Context
Description
This command associates an IP filter policy with an ingress or egress Service Access Point (SAP) or IP interface. An IP filter policy can be associated with spoke SDPs.
Filter policies control the forwarding and dropping of packets based on IP or MAC matching criteria.
The filter command is used to associate a filter policy with a specified ip-filter-id with an ingress or egress SAP. The ip-filter-id must already be defined before the filter command is executed. If the filter policy does not exist, the operation will fail and an error message returned.
In general, filters applied to SAPs (ingress or egress) apply to all packets on the SAP. One exception is non-IP packets are not applied to IP match criteria, so the default action in the filter policy applies to these packets.
The no form of this command removes any configured filter ID association with the SAP or IP interface. The filter ID itself is not removed from the system unless the scope of the created filter is set to local. To avoid deletion of the filter ID and only break the association with the service object, use scope command within the filter definition to change the scope to local or global. The default scope of a filter is local.
Parameters
SDP Binding Commands
binding
Syntax
Context
Description
The command enables the context to configure SDP bindings.
port
Syntax
Context
Description
This command specifies the port or lag identifier, to which the PW ports associated with the underlying SDP are bound. If the underlying SDP is re-routed to a port or lag other than the specified one, the PW ports on the SDP are operationally brought down.
The no form of the command removes the value from the configuration.
Default
none
Parameters
pw-port
Syntax
Context
Description
This command creates a pseudowire port.
The no form of the command removes the pseudowire port ID from the configuration.
Default
none
Parameters
description
Syntax
Context
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command associates a text string with a configuration context to help identify the content in the configuration file.
The no form of the command removes the string from the configuration.
Default
no description
Parameters
egress
Syntax
Context
Description
This command enables the context to configure PW-port egress side parameters.
encap-type
Syntax
Context
Description
This command sets the encapsulation type for the PW-port as dot1q or qinq.
Default
dot1q
Parameters
shaper
Syntax
Context
Description
This command configures an egress shaping option for use by a PW port..
Default
no shaper.
int-dest-id
Syntax
Context
Description
This command specifies the intermediate destination string configured for dynamic vport selection.
The no form of the command removes the configured intermediate destination string.
This command is only valid for PW ports used for enhanced subscriber management (ESM on PW).
Default
no .int-dest-id
Parameters
vport
Syntax
Context
Description
This command configures the name of the vport to be used for the PW port.
The no form of the command removes the configured vport name.
This command is valid for PW ports used for enhanced subscriber management (ESM on pseudowire) and pseudowire SAPs on Ethernet ports. It is not valid for pseudowire ports on the HSMDA.
Default
no vport
Parameters
vc-type
Syntax
Context
Description
This command sets the forwarding mode for PW-port. The vc-type is signaled to the peer, and must be configured consistently on both ends of the PW. vc-type VLAN is only configurable with dot1q encapsulation on the PW-port. The tag with vc-type vlan only has significance for transport, and is not used for service delineation or ESM. The top (provider tag) is stripped while forwarding out of the PW, and a configured vlan-tag (for vc-type vlan) is inserted when forwarding into the PW. With vc-type ether, the tags if present (max 2), are transparently preserved when forwarding in our out of the PW.
The no form of the command reverts to the default value.
Default
ether
Parameters
vlan-vc-tag
Syntax
Context
Description
This command sets tag relevant for vc-type vlan mode. This tag is inserted in traffic forwarded into the PW.
The no form of the command reverts to the default value.
Default
0
Parameters
RIP Commands
rip-policy
Syntax
Context
Description
This command creates a RIP policy. This policy is applied to a subscriber IPv4 host to enable the BNG to learn RIP routes from the host. RIP routes are never sent to the hosts.
Default
none
Parameters
neighbor
Syntax
Context
Description
This command creates a context for configuring a RIP neighbor interface. By default, group interfaces are not activated with RIP, unless explicitly configured. The BNG will only learn RIP routes from IPv4 host on the group interface. Hence, RIP neighbor group interface will default send to “none”. The send operation is unchangeable for group-interface.
The no form of the command deletes the RIP interface configuration for this group interface. The shutdown command in the config>router>rip>group group-name>neighbor context can be used to disable an interface without removing the configuration for the interface.
Default
no neighbor — No RIP interfaces are defined.
Parameters
authentication-key
Syntax
Context
Description
This command configures the BGP authentication key.
Authentication is performed between neighboring routers before setting up the BGP session by verifying the password. Authentication is performed using the MD-5 message-based digest. The authentication key can be any combination of letters or numbers from 1 to 16.
The no form of the command removes the authentication password from the configuration and effectively disables authentication.
Default
Authentication is disabled and the authentication password is empty.
Parameters
This is useful when a user must configure the parameter, but, for security purposes, the actual unencrypted key value is not provided.
authentication-type
Syntax
Context
Description
This command sets the type of authentication to be used between RIP neighbors. The type and password must match exactly for the RIP message to be considered authentic and processed.
The no form of the command removes the authentication type from the configuration and effectively disables authentication.
Default
no authentication-type — No authentication enabled.
Parameters
retail-svc-id
Syntax
Context
Description
This command specifies the service id of the retailer IES/VPRN service to which the static IPv6 host belongs. A corresponding retailer subscriber interface must exist in the specified service.
Default
no retail-svc-id
Parameters
rip
Syntax
Context
Description
This command enables the RIP protocol on the given VPRN IP interface.
The no form of the command disables the RIP protocol from the given VPRN IP interface.
Default
no rip
group
Syntax
Context
Description
This command creates a context for configuring a RIP group of neighbors. RIP groups are a way of logically associating RIP neighbor interfaces to facilitate a common configuration for RIP interfaces.
The no form of the command deletes the RIP neighbor interface group. Deleting the group will also remove the RIP configuration of all the neighbor interfaces currently assigned to this group.
Default
no group — No group of RIP neighbor interfaces defined
Parameters
Vport Commands
ethernet
Syntax
Context
Description
This command enables access to the context to configure Ethernet port attributes.
This context can only be used when configuring Fast Ethernet, gigabit or 10Gig Fast Ethernet or Ethernet LAN ports on an appropriate MDA.
egress-scheduler-override
Syntax
Context
Description
This command applies egress scheduler overrides. When a port scheduler is associated with an egress port, it is possible to override the following parameters:
- The max-rate allowed for the scheduler.
- The maximum rate for each priority level 8 through 1.
- The CIR associated with each priority level 8 through 1.
See the SR OS Quality of Service Guide for command syntax and usage for the port-scheduler-policy command.
The no form of this command removes all override parameters from the egress port or channel scheduler context. Once removed, the port scheduler reverts all rate parameters back to the parameters defined on the port-scheduler-policy associated with the port.
level
Syntax
Context
Description
This command overrides the maximum and CIR rate parameters for a specific priority level on the port or channel’s port scheduler instance. When the level command is executed for a priority level, the corresponding priority level command in the port-scheduler-policy associated with the port is ignored. The override level command supports the keyword max for the rate and cir parameter. When executing the level override command, at least the rate or cir keywords and associated parameters must be specified for the command to succeed.
The no form of this command removes the local port priority level rate overrides. Once removed, the port priority level will use the port scheduler policies level command for that priority level.
Parameters
access
Syntax
Context
Description
This command configures Ethernet access port parameters.
egress
Syntax
Context
Description
This command configures Ethernet access egress port parameters.
vport
Syntax
Context
Description
This command configures a scheduling node, referred to as virtual port, within the context of an egress Ethernet port. The vport scheduler operates either like a port scheduler with the difference that multiple vport objects can be configured on the egress context of an Ethernet port, or it can be an aggregate rate when an egress port-scheduler policy is applied to the port.
The vport is always configured at the port level even when a port is a member of a LAG.
When a port scheduler policy is applied to a vport the following command is used:
configure>port>ethernet>acess>egress>vport>port-scheduler-policy port-scheduler-policy-name
The CLI will not allow the user to apply a port scheduler policy to a vport if one has been applied to the port. Conversely, the CLI will not allow the user to apply a port scheduler policy to the egress of an Ethernet port if one has been applied to any vport defined on the access egress context of this port. The agg-rate-limit, along with an egress port-scheduler, can be used to ensure that a given vport does not oversubscribe the port’s rate.
SAP and subscriber host queues can be port-parented to a vport scheduler in a similar way they port-parent to a port scheduler or can be port-parented directly to the egress port-scheduler if the agg-rate-limit is used.
When the vport uses an aggregate rate, the following command is used:
configure>port>ethernet>acess>egress>vport>agg-rate-limit
Parameters
agg-rate-limit
Syntax
Context
Description
This command configures an aggregate rate for the vport. This command is mutually exclusive with the port-scheduler-policy command.
Parameters
egress-rate-modify
Syntax
Context
Description
This command is used to apply HQoS Adjustment to a vport. HQoS Adjustment refers to the dynamic adjustment of the rate limit at an QoS enforcement point within router when the multicast traffic stream is disjointed from the unicast traffic stream. This QoS enforcement point within router represents the physical point further down in the access part of the network where the two streams join each other and potentially can cause congestion.
An example would be a PON port which is shared amongst subscriber’s multicast traffic (single copy of each channel) and subscriber’s unicast traffic. The bandwidth control point for this PON port resides in the upstream router BNG node in the form of a vport. In case that the multicast delivery method in the router BNG utilizes redirection, the multicast traffic in the router BNG will flow outside of the subscriber or the vport context and thus will bypass any bandwidth enforcement in the router. To correct this, a vport bandwidth adjustment is necessary in the router that will account for the multicast bandwidth consumption that is bypassing vport in the router but is present in the PON port whose bandwidth is controlled by vport.
An estimate of the multicast bandwidth consumption on the PON port can be made at the vport level based on the IGMP messages sourced from the subscribers behind the PON port. This process is called HQoS Adjustment.
A multicast channel bandwidth is subtracted from or added to the vport rate limit according to the received IGMP Join/Leave messages and the channel bandwidth definition policy associated with the vport (indirectly through a group-interface). Since the multicast traffic on the PON port is shared amongst subscribers behind this PON port, only the first IGMP Join or the last IGMP Leave per multicast channel is tracked for the purpose of the vport bandwidth modification.
The vport rate that will be affected by this functionality depends on the configuration:
- In case the agg-rate-limit within the vport is configured, its value will be modified based on the IGMP activity associated with the subscriber under this vport.
- In case the port-scheduler-policy within the vport is referenced, the max-rate defined in the corresponding port-scheduler-policy will be modified based on the IGMP activity associated with the subscriber under this vport.
The channel bandwidth definition policy is defined in the mcac policy in the configure>router>mcac>policy context. The policy is applied under the group-interface or in case of redirection under the redirected-interface.
The rates in effect can be displayed with the following two commands:
show port 1/1/5 vport name
qos scheduler-hierarchy port port-id vport vport-name
The configuration of a scheduler policy under a Vport, which is only applicable to Ethernet interfaces, is mutually exclusive with the configuration of the egress-rate-modify parameter.
The configuration of a scheduler policy under a Vport, which is only applicable to Ethernet interfaces, is mutually exclusive with the configuration of the egress-rate-modify parameter.
Default
HQoS Adjustment for vport is disabled.
host-match
Syntax
Context
Description
This command configures host matching for the Ethernet port egress queue-group.
The no form of the command removes
Parameters
port-scheduler-policy
Syntax
Context
Description
This command specifies the destination and organization strings to be used for matching subscriber hosts with this vport.
The parent vport of a subscriber host queue, which has the port-parent option enabled, is determined by matching the destination string dest string associated with the subscriber and the organization string org string associated with the subscriber host with the strings defined under a vport on the port associated with the subscriber.
If a given subscriber host queue does not have the port-parent option enabled, it will be foster-parented to the vport used by this subscriber and which is based on matching the dest string and org string. If the subscriber could not be matched with a vport on the egress port, the host queue will not be bandwidth controlled and will compete for bandwidth directly based on its own PIR and CIR parameters.
By default, a subscriber host queue with the port-parent option enabled is scheduled within the context of the port’s port scheduler policy.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command. Applying a scheduler-policy to a VPORT is only applicable to Ethernet interfaces.
The no form of the command removes the port-scheduler-policy-name from the configuration.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
Parameters
scheduler-policy
Syntax
Context
Description
This command specifies a scheduler policy to associate to the Vport. Scheduler policies are configured in the configure>qos>scheduler>policy context. Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations. The policy defines the hierarchy and operating parameters for virtual schedulers.
The no form of this command removes the configured egress scheduler policy from the VPORT.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
The configuration of a scheduler policy under a Vport is mutually exclusive with the configuration of the egress-rate-modify parameter.
Parameters
parent-location
Syntax
Context
Description
This command determines the expected location of the parent schedulers for queues configured with a parent command within the SAP egress policy. All parent schedulers must be configured within a scheduler policy applied at the location corresponding to the parent-location parameter.
If a parent scheduler name does not exist at the specified location, the queue will not be parented and will be orphaned.
Default
parent-location default
Parameters
parent-location
Syntax
Context
Description
This command determines the expected location of the parent schedulers for the tier 1 schedulers configured with a parent command within the scheduler policy. The parent schedulers must be configured within a scheduler policy applied at the location corresponding to the parent location parameter.
If a parent scheduler name does not exist at the specified location, the schedulers will not be parented and will be orphaned.
The configuration of parent-location and frame-based-accounting in a scheduler policy is mutually exclusive in to ensure consistency between the different scheduling levels.
Default
parent-location none
Parameters
If this parameter is configured within a scheduler policy that is applied to any object except for the egress of an SLA profile, the configured parent schedulers will not be found and so the tier 1 schedulers will not be parented and will be orphaned.
If this parameter is configured within a scheduler policy that is applied to to any object except for the egress of an SLA profile or SUB profile, or to the egress of a PW SAP, the configured parent schedulers will not be found and so the tier 1 schedulers will not be parented and will be orphaned.
MLD Policy Commands
mld-policy
Syntax
Context
Description
This command enables the context to create an MLD policy.
egress-rate-modify
Syntax
Context
Description
This command configures the egress rate modification.
The no form of the command removes the values from the configuration.
Parameters
fast-leave
Syntax
Context
Description
This command enables fast leave. When fast leave processing is enabled, the router will immediately remove a SAP or SDP from the IP multicast group when it detects an MLD 'leave' on that SAP or SDP. Fast leave processing allows the switch to remove a SAP or SDP that sends a 'leave' from the forwarding table without first sending out group-specific queries to the SAP or SDP, and thus speeds up the process of changing channels ('zapping').
Fast leave should only be enabled when there is a single receiver present on the SAP or SDP.
When fast leave is enabled, the configured last-member-query-interval value is ignored.
Default
no fast-leave
import
Syntax
Context
Description
This command specifies the import routing policy to be used. Only a single policy can be imported at a time.
The no form of the command removes the policy association.
Default
no import — No import policy is specified.
Parameters
max-num-groups
Syntax
Context
Description
This command defines the maximum number of multicast groups that can be joined. If the router receives a join message that would exceed the configured number of groups, the request is ignored.
Default
no max-num-groups
Parameters
max-num-grp-sources
Syntax
Context
Description
This command configures the maximum number of group sources for which MLD can have local receiver information based on received MLD reports on this interface. When this configuration is changed dynamically to a value lower than currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources will not be allowed. When this object has a value of 0, there is no limit to the number of group sources.
The no form of the command removes the value from the configuration.
Default
no max-num-grp-sources
Parameters
max-num-sources
Syntax
Context
Description
This command configures the maximum number of multicast sources allowed per group.
The no form of the command removes the value from the configuration.
Parameters
per-host-replication
Syntax
Context
Description
This command enables per-host-replication. In the per-host-replication mode, multicast traffic is replicated per each host within the subscriber irrespective of the fact that some hosts may be subscribed to the same multicast stream. As a result, in case that multiple hosts within the subscriber are registered for the same multicast group, the multicast streams of that group will be generated. The destination MAC address of multicast streams will be changed to unicast so that each host receives its own copy of the stream. Multicast traffic in the per-host-replication mode can be classified via the existing QoS CLI structure. As such the multicast traffic will flow through the subscriber queues. HQoS Adjustment is not needed in this case.
The alternative behavior for multicast replication in IPoE environment is per-SAP- replication. In this model, only a single copy of the multicast stream is sent per SAP, irrespective of the number of hosts that are subscribed to the same multicast group. This behavior applies to 1:1 connectivity model as well as on 1:N connectivity model (SAP centric behavior as opposed to subscriber centric behavior).
In the per-SAP-replication model the destination MAC address is multicast (as opposed to unicast in the per-host-replication model). Multicast traffic is flowing via the SAP queue which is outside of the subscriber context. The consequence is that multicast traffic is not accounted in the subscriber HQoS. In addition, HQoS Adaptation is not supported in the per SAP replication model.
Default
disabled
redirection-policy
Syntax
Context
Description
This command will apply multicast redirection action to the subscriber. The redirection action along with the redirected interface (and possibly service id) is defined in the referenced policy-name. MLD messages will be redirected to an alternate interface if that alternate interface has MLD enabled. The alternate interface does not have to have any multicast groups registered via MLD. Currently all MLD messages are redirected and there is no ability to selectively redirect MLD messages based on match conditions (multicast-group address, source IP address, etc.). Multicast redirection is supported between VPRN services and also between interfaces within the Global Routing Context. Multicast Redirection is not supported between the VRPN services and the Global Routing Table (GRT).
MLD state is maintained per subscriber host and per redirected interface. Traffic is however forwarded only on the redirected interface.
Default
none
Parameters
static
Syntax
Context
Description
This command adds an MLD static group membership.
group
Syntax
Context
Description
This command configures a static multicast group.
Parameters
source
Syntax
Context
Description
This command adds or removes a static multicast source.
Parameters
starg
Syntax
Context
Description
This command adds a static (*,G) entry. This command can only be enabled if no existing source addresses for this group are specified.
Use the no form of the command to remove the starg entry from the configuration.
Default
none
version
Syntax
Context
Description
This command configures the MLD version.
Parameters
IPoE Session Commands
ipoe-session-policy
Syntax
Context
Description
This command configures an IPoE session policy. The policies are referenced from subscriber interfaces, group interfaces and capture SAPs. Multiple IPoE session policies can be configured.
Default
none
Parameters
description
Syntax
Context
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command 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.
Default
no description
Parameters
session-key
Syntax
Context
Description
This command configures the key to logically group subscriber hosts that belong to the same dual stack end device in an IPoE session.
The SAP and MAC address are always part of the IPoE session key. Optionally the Circuit-Id/Interface-Id or Remote-Id can be added to the session key.
Default
session-key sap mac
Parameters
sap and mac are mandatory parameters while cid and rid are optional and mutually exclusive. Valid IPoE session key parameters are: sap mac, sap mac cid and sap mac rid.
session-timeout
Syntax
Context
Description
This command defines the time in seconds between 1 second and 360 days before the IPoE session will be disconnected. The default value is unlimited session timeout.
Default
no session-timeout
Parameters
sap
Syntax
Context
Description
This command declares a given SAP as a primary (or secondary) VPLS port.
ipoe-session
Syntax
Context
Description
This command configures IPoE session parameters.
Default
none
force-auth
Syntax
Context
Description
By default, if the circuit-id/interface-id or remote-id in the IPoE session re-authentication trigger packet (such as a DHCP renewal) is not empty and different from the circuit-id/interface-id or remote-id stored in the IPoE session data, a forced re-authentication is performed, ignoring the configured min-auth-interval. This default behavior can be changed with this command.
The no form of the command resets the default behavior.
Default
force-auth cid-change rid-change force-auth disabled on WLAN-GW group interfaces
Parameters
ipoe-session-policy
Syntax
Context
Description
This command specifies the IPoE session policy applicable for this group interface or capture SAP.
On wlan-gw group interfaces, it is not possible to change this value.
Default
no ipoe-session-policy ipoe-session-policy “default” on WLAN-GW group interfaces
Parameters
min-auth-interval
Syntax
Context
Description
Re-authentication for IPoE sessions enable dynamic policy changes.
This command configures the maximum frequency of re-authentications by specifying a minimum interval between two non-forced authentications for the same IPoE session.
A forced authentication is by default triggered by a Circuit-Id/Interface-Id or Remote-Id change (see the force-auth command).
Re-authentications are, by default, disabled and can be enabled by configuring a min-auth-interval.
Setting the min-auth-interval to zero seconds will always re-authenticate on each trigger packet.
Default
min-auth-interval infinite
Parameters
radius-session-timeout
Syntax
Context
Description
This command specifies how to interpret the session-timeout coming from a RADIUS VSA in an Access-Accept or CoA message.
The value of this command can only be changed on WLAN-GW group interfaces.
The no form of this command resets the default value.
Default
absolute backwards-compatible on WLAN-GW group interfaces
Parameters
sap-session-limit
Syntax
Context
Description
This command specifies the number of IPoE sessions per SAP allowed for this group-interface
Default
sap-session-limit 1
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
session-limit
Syntax
Context
Description
This command specifies the number of IPoE sessions allowed for this group interface or retail subscriber interface.
Default
session-limit 1
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
user-db
Syntax
Context
Description
This command configures the local user database to use for IPoE session authentication.
When configured on a capture SAP, the group interface must have the same local user database configured.
On a WLAN-GW group interface, the no form of this command indicates that the user database will be picked from the following sources in the order shown:
- dhcp
- ipv6> dhcp6
- ipv6> router-solicit
If no user database can be found in any of these locations, processing continues as if no user database was configured. This behavior is for backwards compatibility reasons only; when using a LUDB, it should be explicitly added to the IPoE session configuration.
Default
no user-db
Parameters
shutdown
Syntax
Context
Description
The shutdown command enables or disables IPoE session management on a group interface or capture SAP.
A shutdown of the IPoE session CLI hierarchy on a group-interface will clear all active IPoE sessions on that interface, resulting in a deletion of all corresponding subscriber hosts.
On WLAN-GW group interfaces it is not possible to disable an IPoE session.
Default
shutdown no shutdown on WLAN-GW group interfaces
SHCV Policy Commands
shcv-policy
Syntax
Context
Description
This command configures a Subscriber Host Connectivity Verification (SHCV) policy. An SHCV policy can be applied to both the subscriber management group interface and VPLS instances. All SHCV-related features inside a group interface and a VPLS service will follow the configuration specified in the SHCV policy. The SHCV policy and the SHCV configuration on a group interface are mutually exclusive. Only one can be applied to the group interface.
The no form of the command removes the policy name from the configuration.
Default
none
Parameters
layer-3
Syntax
Context
Description
This command enables the context to configure SHCV behavior parameters for IES and VPRN services.
Default
none
source-ip-origin
Syntax
Context
Description
This command selects the source IP address to be used for SHCV messages.
The no form of the command reverts to the default.
Parameters
periodic
Syntax
Context
Description
This command configures the periodic SHCV properties for the subscriber management group-interface. This tool will periodically scan all known DHCP hosts only and perform unicast ARP/NS requests. The subscriber host connectivity verification will maintain state (connected vs. not-connected) for all hosts.
Default
none
action
Syntax
Context
Description
This command configures the action to take when the periodic connectivity verification failed.
The no form of the command reverts to the default.
Default
alarm
Parameters
interval
Syntax
Context
Description
This command specifies the time interval which all known sources should be verified. The actual rate is dependent on the number of known hosts and intervals.
The no form of the command reverts to the default.
Default
30 minutes
Parameters
retry-count
Syntax
Context
Description
This command configures the number of retransmissions.
The no form of the command reverts to the default.
Default
2
Parameters
timeout
Syntax
Context
Description
This command configures the timeout before a retransmission in triggered connectivity verification.
The no form of the command reverts to the default.
Default
10
Parameters
trigger
Syntax
Context
Description
This command enables to context to configure SHCV triggers.
Default
none
Parameters
retry-count
Syntax
Context
Description
This command configures the number of retransmissions in periodic connectivity verification.
The no form of the command reverts to the default.
Default
1
Parameters
timeout
Syntax
Context
Description
This command configures the timeout before a retransmission.
The no form of the command reverts to the default.
Default
1
Parameters
vpls
Syntax
Context
Description
This command enables the context to configure SHCV behavior in VPLS services.
source-ip
Syntax
Context
Description
This command configures the IPv4 address to be used as source address for connectivity verification in a VPLS service.
The no form of the command reverts to the default.
Default
no source-ip
Parameters
source-mac
Syntax
Context
Description
Specifies the MAC address to be used as source address for connectivity verification in a VPLS service.
The no form of the command reverts to the default.
Default
no source-mac
Parameters
Show Commands
| Note:
The command outputs in the following section are examples only; actual displays may differ depending on supported functionality and user configuration. |
diameter-peer-policy
Syntax
Context
Description
This command displays diameter peer policy information and diameter peer information and statistics. For the diameter proxy, the incoming peer can be specified with an IP address and port number.
Parameters
Output
Table 85 provides a description of the counters in the output of the show aaa diameter-peer-policy command. and Table 86 provides the failure reasons for the aggregate Failed counter (Request Rx and Answer Rx). Sample output follows the tables.
Table 85: show aaa diameter-peer-policy Field Descriptions
Counter | Counts | |
Aggregates Total | Request Tx | Aggregated countersum of all successfully transmitted diameter request messages (all applications, all message types) |
Answer Rx | Aggregated countersum of all successfully received diameter answer messages (all applications, all message types) | |
Request Rx | Aggregated countersum of all successfully received diameter request messages (all applications, all message types) | |
Answers Tx | Aggregated countersum of all successfully transmitted diameter answer messages (all applications, all message types) | |
Aggregates Failed | Request Tx | Aggregated countersum of all request messages that could not be sent for internal reasons, such as TCP socket error (for example, congestion), failure reported to application (for example, no retries left)Dropped by PythonTimeouts (requests for which no answer was received within the configured timeout interval) |
Answer Rx | Aggregated countersum of all Answer messages that failed to be successfully decoded, such as such as invalid header length or a violation against the Command Code Format (CCF) specification. See Table 86 Aggregate Failed Request Rx and Answer Rx counters for more information. | |
Request Rx | Aggregated countersum of all Request messages that failed to be successfully decoded, such as invalid header length or a violation against the Command Code Format (CCF) specificationSee Table 86 Aggregate Failed Request Rx and Answer Rx counters for more information. | |
Answers Tx | Aggregated counterSum of all answer messages that could not be sent for internal reasons such as TCP socket error (for example, congestion)Dropped by Python | |
Application ID id message type | Request Tx | successfully transmitted diameter request messages for the corresponding application and message type |
Answer Rx | successfully received diameter answer messages for the corresponding application and message type | |
Request Rx | successfully received diameter request messages for the corresponding application and message type | |
Answers Tx | successfully transmitted diameter answer messages for the corresponding application and message type | |
Table 86: Aggregate Failed Request Rx and Answer Rx counters
Role | Failed reasons |
Proxy | proxy (message length too short / too long / version unsupported) |
Consistency check failed: header size, message length, illegal flag combination, AVP header too small, AVP present but not allowed (base RFC messages), etc. | |
not a base message | |
not a request | |
Tx overload (message received to be send to client) | |
dropped by python | |
failed to create answer | |
no transaction (answer to server, but request is not found - 5 min.) | |
Diameter base / Diameter application | message dropped due to result code |
message too big / too small | |
dropped by python | |
consistency check failed | |
end-2-end mismatch hop-to-hop command code (answer/request mismatch) | |
cool down sequence drop | |
cc error request | |
application id in header error | |
T bit in header |
isa-radius-policy
Syntax
Context
Description
This command displays ISA RADIUS policy information.
Parameters
Output
Table 87: Subscriber ISA RADIUS Policy Field Descriptions
Label | Description |
Purposes Up | Indicates the RADIUS services that are up and running, and fully operational for this server. |
Source IP address | Indicates the IP address of the RADIUS server. |
Acct Tx Requests | Indicates the number of RADIUS transaction requests transmitted. |
Acct TX Retries | Indicates the number of RADIUS transaction request retries. |
Acct TX Timeouts | Indicates the number of RADIUS transaction requests that have timed out. |
Acct RX Replies | Indicates the number of RADIUS transaction responses received. |
Auth Tx Requests | Indicates the number of authentication requests transmitted. |
Auth Tx Retries | Indicates the number of authentication request retries. |
Auth Tx Timeouts | Indicates the number of RADIUS authentication requests that have timed out for the policy. |
CoA RX Requests | Indicates the number of Change-of-Authorization message responses received. |
radius-configuration
Syntax
Context
Description
This command displays RADIUS configuration information.
Output
radius-server-policy
Syntax
Context
Description
This command displays RADIUS server policy configuration information.
Parameters
Output
Table 88: Subscriber RADIUS Server Policy Field Descriptions
Label | Description |
Tx transaction requests | Indicates the number of RADIUS transaction requests transmitted. |
Rx transaction responses | Indicates the number of RADIUS transaction responses received. |
Transaction requests timed out | Indicates the number of RADIUS transaction requests that have timed out. |
Transaction requests send failed | Indicates the number of RADIUS transaction requests that could not be transmitted. |
Packet retries | Indicates the number of times a RADIUS request packet was retransmitted to a server. |
Transaction requests send rejected | Indicates the number of RADIUS transaction requests that were not transmitted due to unacceptable configuration. |
Authentication requests failed | Indicates the number of authentication failures for this policy. |
Accounting requests failed | Indicates the number of accounting failures for this policy. |
Ratio of access-reject over auth responses | Indicates the ratio of access-rejects in the auth responses for this policy. |
Transaction success ratio | Indicates the transaction success ratio for this policy. |
Transaction failure ratio | Indicates the transaction failure ratio for this policy. |
Statistics last reset at | Indicated the date and time at which the statistics for this policy were last reset. |
ancp-policy
Syntax
Context
Description
This command displays subscriber Access Node Control Protocol (ANCP) policy information.
Parameters
Output
ancp-string
Syntax
Context
Description
This command displays subscriber Access Node Control Protocol (ANCP) string information.
Parameters
<sap-id> | null | <port-id|bundle-id|bpgrp-id|lag-id|aps-id> | |
dot1q | <port-id|bundle-id|bpgrp-id|lag-id|aps-id|pw-id>:qtag1 | ||
qinq | <port-id|bundle-id|bpgrp-id|lag-id| pw-id>:qtag1.qtag2 | ||
atm | <port-id|aps-id>[:vpi/vci|vpi|vpi1.vpi2|cp.conn-prof-id] | ||
cp | keyword | ||
conn-prof-id | [1..8000] | ||
frame | <port-id|aps-id>:dlci | ||
cisco-hdlc | slot/mda/port.channel | ||
cem | slot/mda/port.channel | ||
ima-grp | <bundle-id>[:vpi/vci|vpi|vpi1.vpi2|cp.conn-prof-id] | ||
cp | keyword | ||
conn-prof-id | [1..8000] | ||
port-id | slot/mda/port[.channel] | ||
bundle-id | bundle-<type>-slot/mda.<bundle-num> | ||
bundle | keyword | ||
type | ima|fr|ppp | ||
bundle-num | [1..336] | ||
bpgrp-id | bpgrp-<type>-<bpgrp-num> | ||
bpgrp | keyword | ||
type | ima|ppp | ||
bpgrp-num | [1..2000] | ||
aps-id | aps-<group-id>[.channel] | ||
aps | keyword | ||
group-id | [1..64] | ||
ccag-id | ccag-<id>.<path-id>[cc-type]:<cc-id> | ||
ccag | keyword | ||
id | [1..8] | ||
path-id | [a|b] | ||
cc-type | [.sap-net|.net-sap] | ||
cc-id | [0..4094] | ||
eth-tunnel | eth-tunnel-<id>[:<eth-tun-sap-id>] | ||
id | [1..1024] | ||
eth-tun-sap-id | [0..4094] | ||
lag-id | lag-<id> | ||
lag | keyword | ||
id | [1..800] | ||
pw-id | pw-<id> | ||
pw | keyword | ||
id | [1..10239] | ||
qtag1 | [0..4094] | ||
qtag2 | [*|0..4094] | ||
vpi | [0..4095] (NNI) | ||
[0..255] (UNI) | |||
vci | [1|2|5..65535] | ||
dlci | [16..1022] | ||
tunnel-id | tunnel-<id>.<private|public>:<tag> | ||
tunnel | keyword | ||
id | [1..16] | ||
tag | [0..4094] | ||
Output
authentication
Syntax
Context
Description
This command displays subscriber management RADIUS authentication policy information and statistics.
Parameters
Output
Table 89: Subscriber Authentication Field Descriptions
Label | Description |
Requests Received | Indicates the number of notify Change-of-Authorization requests received. |
Requests Accepted | Indicates the number of notify Change-of-Authorization requests accepted. |
Requests Rejected | Indicates the number of notify Change-of-Authorization requests rejected. |
Requests Dropped | Indicates the number of notify Change-of-Authorization requests dropped. |
No Auth Policy found | Indicates the number of notify Change-of-Authorization requests found. |
Invalid message | Indicates the number of notify Change-of-Authorization requests rejected because of decode errors. |
Out of resources | Indicates the number of notify Change-of-Authorization requests rejected due to lack of resources. |
Authentication Failure | Indicates the number of notify Change-of-Authorization requests which do not have NAS-Port-ID or Framed-IP-Address set or have mismatched subscriber-id. |
diameter-application-policy
Syntax
Context
Description
This command displays Diameter application policy information.
Parameters
Output
diameter-session
Syntax
Context
Description
This command displays diameter session information.
ccrt-replay
Syntax
Context
Description
This command displays information about diameter Gx sessions that are in Credit-Control-Request Session-Terminate-Request (CCR-T) replay mode.
Parameters
Output
explicit-subscriber-map
Syntax
Context
Description
This command displays explicit subscriber mappings.
Output
host-lockout-policy
Syntax
Context
Description
This command displays host lockout policy information.
Parameters
Output
The following is a sample output for the host-lockout-policy command.
igmp-policy
Syntax
Context
Description
This command displays IGMP policy information and only applies to the 7750 SR.
Parameters
Output
ipoe-session-policy
Syntax
Context
Description
This command displays IPoE session policy information.
Parameters
Output
local-user-db
Syntax
Context
Description
This command displays local user database information.
Output
msap-policy
Syntax
Context
Description
This command displays Managed SAP policy information.
Output
pcc-rule
Syntax
Context
Description
This command displays a list of pcc-rules and associated monitoring keys in the system.
Parameters
Output
radius-accounting-policy
Syntax
Context
Description
This command displays RADIUS accounting policy information.
Parameters
Output
Table 90: Subscriber RADIUS Accounting Policy Field Descriptions
Label | Description |
Tx Requests/TX Reqs | Displays the number of accounting requests transmitted for this policy. |
Rx Responses/Rx Resps | Displays the number of accounting responses received for this policy. |
Request Timeouts/Req Timeouts | Displays the number of accounting requests which have timed out for this policy. |
Send Retries | Displays the number of retries to a different server for a single accounting request for this policy. |
Send Failed Req Send Failed | Displays how many accounting requests failed because the packet could not be sent out for this policy. |
Radius Servers | Displays a table in which the statistics associated with this RADIUS accounting policy are broken down by individual RADIUS server. The table columns are: Index—displays the index number assigned to the RADIUS server. The index determines the sequence in which the servers are queried for authentication requests. Servers are queried in order from lowest to highest index. IP Address—the address of the RADIUS server. TX Reqs—see TX Requests in this table. Rx Resps—see RX Responses in this table. Req Timeouts—see Request Timeouts in this table. Req Send Failed—see Send Failed in this table. |
sla-profile
Syntax
Context
Description
This command displays SLA profile information.
Parameters
Output
sla-profile
Syntax
Context
Description
This command displays the subscriber’s SLA profile scheduler stats.
Parameters
Output
port
Syntax
Context
Description
This command displays the subscriber’s SLA profile scheduler stats.
Parameters
Output
vport
Syntax
Context
Description
This command displays the vport scheduler stats.
Parameters
Output
statistics
Syntax
Context
Description
This command displays enhanced subscriber management statistics per port/pw-port/MDA/IOM/system.
For each statistic, there is current value and peak value, peak value is the highest value since last reset via system boot or command clear subscriber-mgmt peakvalue-stats.
| Note:
The peak values can be reset via the clear subscriber-mgmt peakvalue-stats command. |
Parameters
The following tables describe the counters available in the show subscriber management statistics command output.
The following terminology is used to indicate applicability of the stats:
- ESM — Enhanced Subscriber Management. Subscriber traffic forwarded via subscriber queues. Enabled with SAP sub-sla-mgmt in no shutdown state.
- BSM — Basic Subscriber Management. Subscriber traffic forwarded via SAP queues. SAP sub-sla-mgmt must be in shutdown state. For DHCP, dhcp lease-populate or dhcp6-relay lease-populate must be enabled to count the leases. For IPv4, if anti-spoof is enabled on the SAP, a subscriber host is instantiated.
- Routed CO — IES or VPRN service with subscriber-interface and group-interface constructs.
- Bridged CO — VPLS service with DHCPv4 lease management enabled (lease-populate)
- regular interface — IES or VPRN interface (none subscriber-interface or group-interface)
- Host (also subscriber host) — A resource in the system that is used for traffic forwarding and security related actions. The creation of a subscriber host entry is linked to anti-spoof being enabled on a SAP. For ESM, anti-spoof is mandatory and hence every connected {IP/MAC} consumes by default a subscriber host entry. A DHCP6 IA-PD can also be modeled as a managed route. In this case, no subscriber host is instantiated. For BSM, anti-spoof is optional on regular interfaces. An IPv4 static-host and DHCPv4 lease do not result in a subscriber host instantiation when anti-spoof is disabled on the SAP.
Table 91: Host And Protocol Statistics
Section
Counter
Counts
Applies to
IPv4
1. PPP Hosts - IPCP
IPv4 local terminated PPP hosts (PTA, LNS)
ESM, Routed CO
2. IPOE Hosts - DHCP
DHCPv4 hosts (lease states)
ESM, Routed CO, Bridged CO
3. IPOE Hosts - ARP
ARP hosts
ESM, Routed CO, Bridged CO
4. IPOE Hosts – Static
IPv4 static hosts
ESM, Routed CO, Bridged CO
5. IPOE Hosts BSM - DHCP
DHCPv4 hosts (lease states: anti-spoof and lease-populate enabled)
BSM, Routed CO, Bridged CO, regular interface
6. IPOE Hosts BSM – Static
IPv4 static hosts (with anti-spoof enabled)
BSM, Routed CO, Bridged CO, regular interface
7. IPOE BSM - DHCP
DHCPv4 lease states (with lease-populate enabled, no anti-spoof)
BSM, Routed CO, Bridged CO, regular interface
8. IPOE BSM – Static
IPv4 static hosts (no anti-spoof)
BSM, Routed CO, Bridged CO, regular interface
IPv6
PPP Hosts – SLAAC
Local terminated IPv6 wan-host – SLAAC (PTA, LNS)
ESM, Routed CO
PPP Hosts - DHCP6 (PD)
Local terminated IPv6 pd-host (PTA, LNS) – DHCP6 IA-PD leases over PPP (excluding PD as managed route)
ESM, Routed CO
PPP Hosts - DHCP6 (NA)
Local terminated IPv6 wan-host (PTA, LNS) – DHCP6 IA-NA leases over PPP
ESM, Routed CO
PPP Mngd Rt - DHCP6 (PD)
IPv6 (PTA, LNS) – DHCP6 IA-PD leases over PPP (PD as managed route only)
ESM, Routed CO
IPOE Hosts – SLAAC
IPv6 wan-host – SLAAC
ESM, Routed CO
IPOE Hosts - DHCP6 (PD)
IPv6 pd-host – DHCP6 IA-PD leases (excluding PD as managed route)
ESM, Routed CO
IPOE Hosts - DHCP6 (NA)
IPv6 wan-host – DHCP6 IA-NA leases
ESM, Routed CO
IPOE Mngd Rt - DHCP6 (PD)
IPv6 – DHCP6 IA-PD leases (PD as managed route only)
ESM, Routed CO
IPOE Hosts – Static (PD)
IPv6 static hosts with prefix-length shorter than /128
ESM, Routed CO
IPOE Hosts – Static (WAN)
IPv6 static hosts with prefix-length equal to /128
ESM, Routed CO
IPOE BSM - DHCP6 (PD)
IPv6 – DHCP6 IA-PD leases (lease-populate)
BSM, regular interface
IPOE BSM - DHCP6 (NA)
IPv6 – DHCP6 IA-NA leases (lease-populate)
BSM, regular interface
Total
PPP Hosts
Local terminated PPP hosts (PTA, LNS)
Sum of counters 1, 9, 10 and 11
ESM
IPOE Hosts
Total IPv4 and IPv6 IPOE hosts.
Sum of counters 2, 3, 4, 5, 6, 13, 14, 15, 17 and 18
ESM
IPv4 Hosts
Total IPv4 hosts. PPP (PTA, LNS) and IPOE.
Sum of counters 1, 2, 3, 4, 5 and 6
ESM
IPv6 Hosts
Total IPv6 hosts. PPP (PTA, LNS) and IPOE.
Sum of counters 9, 10, 11, 13, 14, 15, 17 and 18
ESM
IPv6 PD Mngd Routes
Total DHCP6 IA-PD leases modeled as a managed route. PPP (PTA, LNS) and IPOE.
Sum of counters 12 and 16
ESM
L2TP LAC Hosts
L2TP LAC hosts – single host per single or dual stack PPP session.
Counter also increases for outgoing LTS sessions.
ESM, Routed CO
Internal Hosts
Subscriber hosts for internal use. For example: LNS redirect hosts (for LTS, an LNS redirect host is also instantiated).
ESM
Total (Cont)
Non-Sub-Traffic L2-Hosts
Host on a single subscriber SAP in a VPLS service that enables non-IP traffic to be forwarded using the specified SLA profile instance queues.
Host on a single subscriber SAP attached to an IES/VPRN group-interface that enables traffic normally forwarded via the SAP queues to flow via the specified SLA profile instance queues.
configure service vpls <service-id> sap <sap-id> sub-sla-mgmt single-sub-parameters non-sub-traffic sub-profile <sub-profile-name> sla-profile <sla-profile-name> [subscriber <sub-ident-string>] [app-profile <app-profile-name>]
ESM, Routed CO, Bridged CO
DHCP leases
Total number of DHCPv4 lease states.
Sum of counters 2, 5 and 7
ESM, BSM
DHCPv6 leases
Total number of DHCPv6 lease states.
Sum of counters 10, 11, 12, 14, 15, 16, 19 and 20
ESM, BSM
Subscriber Hosts
Counter displayed in the output of “show subscriber-mgmt statistics iom | mda | port | pw-port”
This counter matches the number of hosts accounted for in the per line card limit
Sum of counters 1, 2, 3, 4, 5, 6, 9, 10, 11, 13, 14, 15, 17, 18 and 26
ESM
Total (Cont)
System Hosts Scale
Counter displayed in the output of “show subscriber-mgmt statistics system”
This counter matches the number of hosts accounted for in the system wide limit
Sum of counters 1, 2, 3, 4, 5, 6, 9, 10, 11, 13, 14, 15, 17, 18, 26 and 27
ESM
Table 92: PPP Session Statistics
Section
Counter
Counts
Applies to
Local
PPP Sessions - PPPoE
Local terminated PPPoE sessions (PTA)
ESM, Routed CO
PPP Sessions - PPPoEoA
Local terminated PPPoEoA sessions (PTA)
ESM, Routed CO
.PPP Sessions - PPPoA
Local terminated PPPoA sessions (PTA)
ESM, Routed CO
PPP Sessions - L2TP (LNS)
Local terminated PPP sessions (L2TP LNS)
ESM, Routed CO
LAC
PPP Sessions - PPPoE
Tunneled PPPoE session (L2TP LAC)
ESM, Routed CO
PPP Sessions - PPPoEoA
Tunneled PPPoEoA session (L2TP LAC)
ESM, Routed CO
PPP Sessions - PPPoA
Tunneled PPPoA session (L2TP LAC)
ESM, Routed CO
PPP Sessions - L2TP (LTS)
Tunneled PPP session (L2TP LTS)
ESM, Routed CO
Total
PPP Sessions - established
PPP sessions that are established (at least one active host attached) – PTA/LAC/LTS/LNS
ESM, Routed CO
PPP Sessions - in setup
PPP sessions in setup (session created, host setup in progress) – PTA/LAC/LTS/LNS
ESM, Routed CO
Total (Cont)
PPP Sessions - local
Local terminated PPPoX sessions (PTA, L2TP LNS)
Sum of counters 33, 34, 35 and 36
ESM, Routed CO
PPP Sessions - LAC
Tunneled PPPoX session (L2TP LAC, L2TP LTS)
Sum of counters 37, 38, 39 and 40
ESM, Routed CO
L2TP
L2TP Tunnels - originator
Number of L2TP Tunnels originated on this node. (LAC/ LTS)
ESM, Routed CO
.L2TP Tunnels - receiver
Number of L2TP Tunnels terminated on this node. (LNS/LTS)
ESM, Routed CO
Total L2TP Tunnels
Number of L2TP Tunnels originated or terminated on this node
Sum of counters 45 and 46
ESM, Routed CO
Table 93: IPoE Session Statistics
Section | Counter | Counts | Applies to |
Total | IPOE Sessions - established | IPoE sessions that are established (at least one active host attached). | ESM, Routed CO |
IPOE Sessions- in setup | IPoE sessions in setup (session created, host setup in progress). | ESM, Routed CO |
Table 94: Subscriber Statistics
Section | Counter | Counts | Applies to |
Total | Subscribers | Total number of active subscribers. | ESM, Routed CO, Bridged CO |
Table 95: SubMgmt Statistics Summary
Section | Counter | Counts | |
Hosts | IPv4 | Total IPv4 hosts (counter 23 in tables above) | |
IPv6 | Total IPv6 hosts (counter 24 in tables above) | ||
Sessions | PPP | Total PPP sessions - established (counter 41 in tables above) | |
IPOE | Total IPOE sessions – established (counter 48 in tables above) | ||
Subscribers | Total number of active subscribers (counter 50 in tables above) | ||
Output
sub-ident-policy
Syntax
Context
Description
This command displays subscriber identification policy information.
Parameters
Output
sub-profile
Syntax
Context
Description
This command displays subscriber profile information.
Parameters
Output
pw-port
Syntax
Context
Description
Displays pseudo-wire port information.
If no optional parameters are specified, the command displays a summary of all defined PW ports. The optional parameters restrict output to only ports matching the specified properties.
Parameters
Output
Show PW-Port
The following table describes show pw-port output fields:
Table 96: Subscriber Show PW-Port Field Descriptions
Label | Description |
PW Port | The PW Port identifier. |
Encap | The encapsulation type of the PW Port. |
SDP | The SDP identifier. |
IfIndex | The interface index used for the PW Port. |
VC-Id | The Virtual Circuit identifier. |
Description | The description string for the PW Port. |
port-scheduler-policy
Syntax
Context
Description
This command displays scheduler policy information.
Output
sap-egress
Syntax
Context
Description
This command displays SAP egress policy information.
Parameters
Output
sap-ingress
Syntax
Context
Description
This command displays SAP ingress policy information.
Parameters
Output
scheduler-hierarchy
Syntax
Context
Description
This command enables the context to display information about policies that use this scheduler.
customer
Syntax
Context
Description
This command displays the scheduler hierarchy per customer multi-service-site.
Parameters
sap
Syntax
Context
Description
This command displays the scheduler stats per SAP.
Parameters
subscriber
Syntax
Context
Description
This command displays the scheduler hierarchy rooted at the SLA profile scheduler.
Parameters
| Note:
If the SLA profile scheduler is orphaned (that is when the scheduler has a parent which does not exist) then the hierarchy is only shown when the show command includes the sla-profile and sap parameters. |
Output
scheduler-name
Syntax
Context
Description
This command displays information about the specified scheduler name.
Parameters
scheduler-policy
Syntax
Context
Description
This command displays information about the specified scheduler policy.
Parameters
Output
scheduler-stats
Syntax
Context
Description
This command enables the context to display scheduler statistics information.
Output
shared-queue
Syntax
Context
Description
This command displays shared policy information.
Output
ancp-policy
Syntax
Context
Description
This command displays subscriber ANCP policy information.
Output
ancp-string
Syntax
Context
Description
This command displays subscriber ANCP string information.
Parameters
Output
Other applicable show command output:
radius-proxy-server
Syntax
Context
Description
This command displays RADIUS proxy server information.
Parameters
Output
Table 97: Subscriber RADIUS Proxy Server Field Descriptions
Label | Description |
Invalid response Authenticator Rx packet | Displays the number of packets received by this RADIUS proxy server. |
Rx Access-Request | Displays the number of Access-Request packets received by this RADIUS proxy server. |
Rx Accounting-Request | Displays the number of Accounting-Request packets received by this RADIUS proxy server. |
Rx dropped | Displays the number of packets received by this RADIUS proxy server but dropped. |
Retransmit | Displays the number of packets received by this RADIUS proxy server that were rejected because they are retransmitted. |
Wrong purpose | Displays the number of packets received by this RADIUS proxy server that were rejected because the value of tmnxRadProxSrvPurpose is set to a value not matching the type of packet. |
No UE MAC to cache | Displays the number of packets received by this RADIUS proxy server that were rejected because the UE MAC address was not present in the packet. |
Client context limit reached | Displays the number of packets received by this RADIUS proxy server that were rejected because the limit of client contexts was reached. For each RADIUS transaction a client context is created, and will be deleted once the transaction is finished. |
No ISA RADIUS policy configured | Displays the number of packets received by this RADIUS proxy server that were rejected because it has no ISA RADIUS server policy configured for that type of packet. |
Server admin down | Displays the number of packets received by this RADIUS proxy server that were rejected because it is administratively shut down. |
No RADIUS policy configured | Displays the number of packets received by this RADIUS proxy server that were rejected because it has no RADIUS server policy configured for that type of packet. |
No load-balance-key configured | Displays the number of packets received by this RADIUS proxy server that were rejected because the selected RADIUS server policy's algorithm is set to hashBased and no load balance key is configured. |
Invalid length | Displays the number of packets received by this RADIUS proxy server that were rejected because their length was invalid. |
Invalid Code field | Displays the number of packets received by this RADIUS proxy server that were rejected because they had an invalid Code field. |
Invalid attribute encoding | Displays the number of packets received by this RADIUS proxy server that were rejected because one of the attributes was incorrectly encoded. |
Invalid User-Name | Displays the number of packets received by this RADIUS proxy server that were rejected because they contained an invalid User-Name attribute. |
Invalid password | Displays the number of packets received by this RADIUS proxy server that were rejected because the User-Password attribute could not be decoded. |
Invalid accounting Authenticator | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained an invalid Authenticator field. |
Invalid Message-Authenticator | Displays the number of packets received by this RADIUS proxy server that were rejected because they contained an invalid Message-Authenticator attribute. |
Management core overload | Displays the number of packets that were rejected by this RADIUS server because the ISA management core is not able to process any new RADIUS requests because of overload. |
No memory | Displays the number of packets that were rejected by this RADIUS server because there was not enough memory to store them. |
Accounting-Request with invalid Acct-Status-Type | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained an invalid Acct-Status-Type attribute. |
Accounting-Request with no Acct-Status-Type | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained no Acct-Status-Type attribute. |
Registered user overload | Displays the number of packets that were rejected by this RADIUS server because the registered user indicated to be in overload. |
Dropped by Python | Displays the number of packets received by this RADIUS proxy server but dropped by Python. |
Tx Access-Accept | Displays the number of Access-Accept packets transmitted by this RADIUS proxy server. |
Tx Access-Reject | Displays the number of Access-Reject packets transmitted by this RADIUS proxy server. |
Tx Access-Challenge | Displays the number of Access-Challenge packets transmitted by this RADIUS proxy server. |
Tx Accounting-Response | Displays the number of Accounting-Response packets transmitted by this RADIUS proxy server. |
Tx dropped | Displays the number of packets dropped by this RADIUS proxy server before transmission. |
No key to cache | Displays the number of packets that could not be cached by this RADIUS proxy server because the key information was not present in the packet. |
Cache key too long | Displays the number of packets that could not be cached by this RADIUS proxy server because the key information present in the packet was too long. |
Cache attributes too long | Displays the number of packets that could not be cached by this RADIUS proxy server because the total length of the attributes is too long. |
Reached maximum number of cache entries | Displays the number of packets that could not be cached by this RADIUS proxy server because the limit has been reached. |
No memory | Displays the number of packets that could not be transmitted by this RADIUS proxy server because there was not enough memory. |
Server timeout | Displays the number of packets that were dropped because the RADIUS servers have timed out. |
Server authentication failure | Displays the number of packets that were dropped because the RADIUS server replied with a packet which failed authentication (invalid response Authenticator or Message Authenticator attribute). |
Server invalid Code | Displays the number of packets that were dropped because the RADIUS server replied with a packet with an invalid Code field. |
Invalid attribute encoding | Displays the number of packets that were dropped because the RADIUS server replied with a packet with an invalid attribute. |
Registered user overload | Displays the number of packets that were dropped because the registered user indicated to be in overload. |
No RADIUS server configured | Displays the number of packets that were dropped by this RADIUS server because the RADIUS server policy has no servers configured. |
RADIUS server send failure | Displays the number of packets that were dropped by this RADIUS server because the packet could not get transmitted to one of the servers in the RADIUS server policy. |
Dropped by Python | Displays the number of packets that were dropped by this RADIUS server because the packet was dropped by the Python script. |
Invalid response Authenticator | Displays the number of packets that were dropped because the RADIUS server replied with a packet which failed authentication |
wpp
Syntax
Context
Description
This command displays WPP port-related information in the specified routing instance.
Parameters
Output
ipoe session
Syntax
Context
Description
This command displays the identified IPoE session details active on the specified service instance.
Parameters
Output
managed-hosts
Syntax
Context
Description
This command displays information about hosts that are not yet linked to an in-band control plane protocol, such as DHCP or DHCPv6. Examples include hosts installed by data-triggers and hosts installed by RADIUS.
Parameters
Output
The following output is an example of managed host information.
Clear Commands
ancp-sub-string
Syntax
Context
Description
This command clears subscriber ANCP data.
Parameters
arp
Syntax
Context
Description
This command clears all or specific ARP entries.
The scope of ARP cache entries cleared depends on the command line option(s) specified.
Parameters
authentication
Syntax
Context
Description
This command clears subscriber authentication data.
Parameters
diameter-session
Syntax
Context
Description
This command clears diameter session data.
ccrt-replay
Syntax
Context
Description
This command clears diameter Gx sessions that are in CCR Terminate replay mode.
Parameters
idle-only-msap
Syntax
Context
Description
This command removes all idle MSAPs associated with the MSAP policy.This command only removes idle MSAPs without active subscribers. This command is considered safer than the clear>subscr-mgmt>msap-policy msap-policy-name idle-only command because in that command, the parameter idle-only is optional. Not specifying idle-only will delete MSAPs with active subscribers.
Parameters
msap-policy
Syntax
Context
Description
This command deletes Managed SAPs (MSAPs) created by the MSAP policy.
This command can remove an MSAP with active subscribers still associated with the MSAP. Use the idle-only parameter to remove only MSAPs in an idle state.
Parameters
peakvalue-stats
Syntax
Context
Description
This command resets the most recent peak counter.
| Note:
Clearing one counter will not impact other counters. For example, clearing one IOM’s most recent peak value will not impact chassis peak value. |
Parameters
radius-accounting
Syntax
Context
Description
This command clears RADIUS accounting data for the specified policy.
Parameters
scheduler-stats
Syntax
Context
Description
This command clears scheduler statistics.
subscriber
Syntax
Context
Description
This command clears scheduler stats per subscriber.
Parameters
sla-profile
Syntax
Context
Description
This command clears the subscriber’s SLA profile scheduler stats.
Parameters
srrp
Syntax
Context
Description
This command enables the context to clear and reset SRRP virtual router instances.
interface
Syntax
Context
Description
This command clears and resets SRRP interface instances.
Parameters
statistics
Syntax
Context
Description
This command clears statistics for SRRP instances.
Parameters
route-downloader
Syntax
Context
Description
This command clears all the radius-downloaded routes from the internal downloader cache (or protocol RIB/db) (and thus eventually from the RTM itself). The parameters vprn and/or family allow to restrict the deletion of those routes learned in a particular address family (IPv4 or IPv6) and/or a particular VPRN.
By default, all VPRNs and both IPv4 and IPv6 families are affected.
| Note:
A clear of the internal protocol DB means the corresponding prefix that were deleted should be removed from the RTM (and from any other exports) as well. |
Parameters
vport
Syntax
Context
Description
This command clears the vport scheduler stats.
Parameters
ipoe session
Syntax
Context
Description
This commands clears all identified IPoE sessions for the specified service instance. All associated subscriber hosts will be deleted from the system.
Parameters
Tools Commands
tools
Syntax
Context
Description
The context to enable useful tools for debugging purposes.
Default
none
Parameters
avp-match-learned-session-id
Syntax
Context
Description
This command displays the diameter session IDs that are learned by the AVP value matching in a diameter debug.
Per avp-match id in a diameter peer policy, a single diameter session ID can be learned. "N/A" means no session ID is learned.
Output
The following is a sample output for the avp-match-learned-session-id command.
perform
Syntax
Context
Description
This command enables the context to enable tools to perform specific tasks.
Default
none
credit-reset
Syntax
Context
Description
This command resets the credit for an SLA-profile instance.
Parameters
persistence
Syntax
Context
Description
This command enables the context to configure downgrade parameters.
downgrade
Syntax
Context
Description
This command downgrades persistence files to a previous version.
Parameters
eval-msap
Syntax
Context
Description
This command re-applies the managed SAP policy to the managed SAP identified by the specified sap-id or to all managed SAPs associated with the specified msap-policy name.
Parameters
eval-lease-state
Syntax
Context
Description
This command evaluates lease state.
Parameters
subscriber-mgmt
Syntax
Context
Description
This command enables tools to control subscriber management.
edit-lease-state
Syntax
Context
Description
This command provides the parameters to edit lease state information.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
credit-reset
Syntax
Context
Description
This command resets the credit for an SLA-profile instance.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
edit-ppp-session
Syntax
Context
Description
This command updates the data of the PPP session identified with the given MAC address and SAP identifier. Optionally the remote-id and circuit-id can be specified to identify the IPoE session to update.
| Note:
The changes take immediate effect. |
edit-slaac-host
Syntax
Context
Description
This command updates the data of the SLAAC host information
edit-ipoe-session
Syntax
Context
Description
This command updates the data of the IPoE session identified with the given MAC address and SAP identifier. Optionally the remote-id and circuit-id can be specified to identify the IPoE session to update.
| Note:
The changes take immediate effect. |
eval-ipoe-session
Syntax
Context
Description
This command re-evaluates the mapping between authentication strings such as the SLA profile string and the actual profiles for the identified IPoE sessions.
eval-ppp-session
Syntax
Context
Description
This command evaluates PPP sessions.
eval-slaac-host
Syntax
Context
Description
This command evaluates the SLAAC host.
remap-lease-state
Syntax
Context
Description
This command allows the remapping of all existing hosts if network card on CMTS/WAC side is changed is required. This command only applies to the 7750 SR.
When this command is executed, the following restrictions apply:
- When sap is taken, all leases associated with the SAP are re-written.
- For a SAP with a configured MAC in "lease-populate" command, this MAC will be taken.
- For a SAP without a configured MAC the MAC from tools command will be taken.
- For a SAP without a configured MAC and no MAC in tools command no action will be perform.
- When using the old-mac option, providing a new MAC ieee-address is mandatory.
This command is applicable only when dealing with DHCP lease states which were instantiated using l2header mode of DHCP operation.
Parameters
When configured, the SAP parameter will remap all MAC addresses of DHCP lease states on the specified SAP. When no optional MAC parameter is specified, the sap sap-id command remaps all MAC addresses of lease states towards the MAC address specified in the l2-header configuration.
re-ident-sub
Syntax
Context
Description
This command renames a subscriber identification string.
Parameters
redundancy
Syntax
Context
Description
This command enables the context to dump redundancy parameters.
multi-chassis
Syntax
Context
Description
This command enables the context to dump multi-chassis parameters.
mc-endpoint
Syntax
Context
Description
This command dumps multi-chassis endpoint information.
Parameters
force-switchover
Syntax
Context
Description
This command manually switches over mc-ipsec mastership of the specified tunnel-group.
Parameters
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring information.
Parameters
srrp-sync-database
Syntax
Context
Description
This command dumps SRRP database information and only applies to the 7450 ESS and 7750 SR.
Parameters
sync-database
Syntax
Context
Description
This command dumps MCS database information.
Parameters
dhcp-server: | local dhcp server (7450 ESS and 7750 SR only) |
igmp: | Internet group management protocol |
igmp-snooping: | igmp-snooping |
mc-ring: | multi-chassis ring |
mld-snooping: | multicast listener discovery-snooping |
srrp: | simple router redundancy protocol (7450 ESS and 7750 SR only) |
sub-host-trk: | subscriber host tracking (7450 ESS and 7750 SR only) |
sub-mgmt: | subscriber management (7450 ESS and 7750 SR only) |
mc-ipsec
Syntax
Context
Description
This command enters the mc-ipsec context.
mc-endpoint
Syntax
Context
Description
This command dumps multi-chassis endpoint information.
Parameters
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring information.
Parameters
srrp-sync-database
Syntax
Context
Description
This command dumps SRRP database information and only applies to the 7450 ESS and 7750 SR.
Parameters
sync-database
Syntax
Context
Description
This command dumps MCS database information.
Parameters
dhcp-server: | local dhcp server (7450 ESS and 7750 SR only) |
igmp: | Internet group management protocol |
igmp-snooping: | igmp-snooping |
mc-ring: | multi-chassis ring |
mld-snooping: | multicast listener discovery-snooping |
srrp: | simple router redundancy protocol (7450 ESS and 7750 SR only) |
sub-host-trk: | subscriber host tracking (7450 ESS and 7750 SR only) |
sub-mgmt: | subscriber management (7450 ESS and 7750 SR only) |
forcerenew
Syntax
Context
Description
This command forces the renewal of lease state and only applies to the 7450 ESS and 7750 SR
Parameters
local-user-db
Syntax
Context
Description
This command provides tools to control the local user database.
ipoe
Syntax
Context
Description
This command provides the tools to control IPoE entries in the local user database.
host-lookup
Syntax
Context
Description
This command performs a lookup in the local user database.
ppp
Syntax
Context
Description
This command provides the tools to control PPPoE entries in the local user database.
authentication
Syntax
Context
Description
This command authenticates the PPPoE user name.
host-lookup
Syntax
Context
Description
This command performs a lookup in the local user database.
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring data.
sync-database
Syntax
Context
Description
This command dumps multi-chassis sync database information.
Parameters
sync-database-reconcile
Syntax
Context
Description
This command provides the paramwters to reconcile MCS database entries.
srrp-sync-data
Syntax
Context
Description
This command dumps multi-chassis SRRP sync database information.
Parameters
route-downloader
Syntax
Context
Description
This command causes the download process to start immediately. If an ongoing download is already in progress then no further action is needed, except if the force keyword is added. In case the force keyword is added, then the current download is aborted and a new one is immediately restarted. If aborting the current download, the internal route table should not be emptied or cleared.
Parameters
router
Syntax
Context
Description
This command enables the context for tools dump commands in the specified routing instance.
Parameters
ipoe-session
Syntax
Context
Description
This command enables the context for IPoE session-related tools dump commands in the specified routing instance.
migration
Syntax
Context
Description
This command displays details on the IPoE session migration progress. It shows per group interface the number of hosts per type (DHCPv4, DHCPv6 and SLAAC) that are associated with an IPoE session or that are not associated with an IPoE session.
Output
The following is a sample output for the migration command.
Debug Commands
diameter
Syntax
Context
Description
This command enables debugging for diameter.
dest-realm
Syntax
Context
Description
This command restricts the output to a specific destination-realm.
Parameters
detail-level
Syntax
Context
Description
This command configures the detail level of debug output.
Parameters
diameter-peer
Syntax
Context
Description
This command restricts output to a specific peer.
Parameters
diameter-peer-policy
Syntax
Context
Description
This command restricts the debug output to messages on peers of a specific diameter peer policy. Up to eight diameter peer policies can be specified.
The no form of the command removes the specified diameter peer policy and all debug statement under this policy from the debug configuration.
Parameters
avp-match
Syntax
Context
Description
This command restricts the debug output to messages within the diameter peer policy that belong to a diameter session identified based on the AVP value matching in a diameter application message.At least the message type and one AVP match criteria must be specified in an avp-match id command.
If a diameter application message matches all criteria within one AVP match ID, then the session ID is learned and all subsequent messages of that diameter session are shown until a relearning occurs. (OR function between avp-match id commands.)
When the session ID is learned in an Answer message, an attempt is made to include the corresponding Request message in the debug output: The Request message should still be available in the system and must pass all debug filters (such as message-type).
By default an avp-match id is disabled and must be configured with the debug>diameter>diameter-peer-policy>avp-match no shutdown to activate.
Parameters
avp
Syntax
Context
Description
This command specifies an AVP match criteria for AVP value matching. At least one and up to five AVP match criteria can be specified in an avp-match id command. When multiple AVP match criteria are specified, they must all match to be successful and result in a diameter session ID learning. (AND function between avp avp-id commands.)
The AVP in an AVP match criteria is identified by its AVP ID. The AVP ID is specified as [vendor-id-]avp-code[.avp-id] with nesting up to five levels deep.
The format type of the AVP should match the standard documents in which the AVP is specified. Any AVP can be specified as an octet string in hex format.
Parameters
message-type
Syntax
Context
Description
This command specifies the message type match criteria for AVP value matching. Only specified diameter application messages are used for AVP value matching. This is a mandatory criteria in an avp-match id command.This command does not restrict the debug output to the specified messages.
Parameters
shutdown
Syntax
Context
Description
Enables or disables the avp-match id criteria for filtering debug output based on AVP value matching.A shutdown of the avp-match id will clear the learned diameter session ID.
diameter-peer
Syntax
Context
Description
This command restricts the debug output to messages on a specific peer within the diameter peer policy. Overrides the debug>diameter>diameter-peer debug command for the specified diameter peer policy. A single peer can be specified per diameter peer policy.
When no peer is specified at the diameter peer policy level, the debug output is restricted to the peer configured at the debug>diameter level.
The no form of the command removes the peer from the debug>diameter>diameter-peer-policy debug output.
Parameters
message-type
Syntax
Context
Description
This command restricts the debug output to the specified message types.
When specified within a diameter peer policy, it overrides the message type configuration at the debug>diameter level for messages received and sent on that diameter peer policy.
The no form of the command removes the message type from the debug configuration.
Parameters
origin-realm
Syntax
Context
Description
This command restricts output to a specific origin-realm.
arp-host
Syntax
Context
Description
This command enables and configures ARP host debugging.
The no form of the command disables ARP host debugging.
one-time-http-redirection
Syntax
Context
Description
This command produces one-time http redirection debug output.
ppp
Syntax
Context
Description
This command enables the PPP debug context.
event
event
Syntax
Context
Description
This command enables the PPP event debug context.
dhcp-client
Syntax
Context
Description
This command enable PPP event debug for DHCP client.
Parameters
l2tp
Syntax
Context
Description
This command enables PPP L2TP event debug.
Parameters
local-address-assignment
Syntax
Context
Description
This command enables debugging for local-address-assignment events.
The no form of the command disables debugging.
Parameters
ppp
Syntax
Context
Description
This command enables PPP event debug.
The no form of the command disables debugging.
Parameters
mac
Syntax
Context
Description
This command displays PPP packets for a particular MAC address.
The no form of the command disables debugging.
msap
Syntax
Context
Description
This command enables debugging for specific PPP MSAPs.
The no form of the command disables debugging.
packet
Syntax
Context
Description
This command enables the PPP packet debug context.
The no form of the command disables debugging.
detail-level
Syntax
Context
Description
This command specify the detail level of PPP packet debug output.
The no form of the command disables debugging.
dhcp-client
Syntax
Context
Description
This command enables packet debug output for DHCP client of the PPP session
The no form of the command disables debugging.
discovery
Syntax
Context
Description
This command enables PPP discovery packet debug output.
The no form of the command disables debugging.
Parameters
mode
Syntax
Context
Description
This command specifies PPP packet debug mode.
The no form of the command disables debugging.
Parameters
ppp
Syntax
Context
Description
This command enables PPP discovery packet debug output for the specified PPP protocol.
The no form of the command disables debugging.
Parameters
remote-id
Syntax
Context
Description
This command enables debugging for specific PPP remote-ids.
The no form of the command disables debugging.
sap
Syntax
Context
Description
This command enables PPP debug output for the specified SAP, this command allow multiple instances.
The no form of the command disables debugging.
Parameters
username
Syntax
Context
Description
This command enable PPP debug for the specified username. since not all PPP packets contain username, so a mac debug filter will be created automatically when system sees a PPP packet contain the specified username.
Multiple username filters can be specified in the same debug command.
The no form of the command disables debugging.
Parameters
circuit-id
Syntax
Context
Description
This command enable PPP debug for the specified circuit-id.
Multiple circuit-id filters can be specified in the same debug command.
The no form of the command disables debugging.
Parameters
remote-id
Syntax
Context
Description
This command enable PPP debug for the specified remote-id.
Multiple remote-id filters could be specified in the same debug command.
Parameters
msap
Syntax
Context
Description
This command enable PPP debug for the specified managed SAP.
Multiple msap filters could be specified in the same debug command.
Parameters
authentication
Syntax
Context
Description
This command debugs subscriber authentication.
Parameters
sub-ident-policy
Syntax
Context
Description
This command debugs subscriber identification policies.
Parameters
script-compile-error
Syntax
Context
Description
This command send the traceback of the compile error to the logger. The traceback contains detailed information about where and why the compilation fails. The compilation takes place when the CLI user changes the admin state of the Python URL from shutdown to no-shutdown.
script-export-variables
Syntax
Context
Description
This command sends the result (the three output variables) of the Python script to the logger when the script ran successfully.
script-output
Syntax
Context
Description
This command sends the output (such as from 'print' statements) of the Python script to the logger.
script-output-on-error
Syntax
Context
Description
This command sends the output (such as from 'print' statements) of the Python script to the logger, but only when the script fails.
script-runtime-error
Syntax
Context
Description
This command sends the traceback of the Python script failure to the logger.
script-all-info
Syntax
Context
Description
This command enables the script-compile-error, script-export-variables, script-output, script-output-on-error, and script-runtime-error functionalities.
srrp
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
events
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
packets
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
radius
Syntax
Context
Description
This command enables the debug router RADIUS context.
detail-level
Syntax
Context
Description
This command specifies the output detail level of command debug router radius.
Default
medium
Parameters
packet-type
Syntax
Context
Description
This command specifies the RADIUS packet type filter of command debug router radius
Default
authentication accounting coa
Parameters
radius-attr
Syntax
Context
Description
This command specifies the RADIUS attribute filter of command debug router radius.
Default
none
Parameters
address | <ipv4-address>|<ipv6-address>| <ipv6-prefix/prefix-length> | |
ipv4-address | a.b.c.d | |
ipv6-address | x:x:x:x:x:x:x:x (eight 16-bit pieces) | |
ipv6-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) | |
x:x:x:x:x:x:d.d.d.d | ||
x - [0..FFFF]H | ||
d - [0..255]D | ||
ipv6-prefix-length [0..128] | ||
hex | [0x0..0xFFFFFFFF...(max 506 hex nibbles)] | |
integer | [0..4294967295] | |
string | ascii-string (max 253 chars) | |
wpp
Syntax
Context
Description
This command enables the context to configure WPP debugging parameters.
packet
Syntax
Context
Description
This command enables WPP packet debugging.
detail-level
Syntax
Context
Description
This command specifies the detail level of WPP packet debugging.
Parameters
portal
Syntax
Context
Description
This command enables WPP debugging for the specified WPP portal.
Parameters
Monitor Commands
subscriber
Syntax
Context
Description
This command monitors statistics for a subscriber.
Parameters
Output
host
Syntax
Context
Description
This command displays static host information configured on this service.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
Default
collect-stats
default-host
Syntax
Context
Description
This command configures the default-host. More than one default host can be configured per SAP.
Default
no lease-populate
Parameters
ipv4-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D | |
prefix-length - [0..128] | |
ipv6-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D | |
prefix-length - [0..128] | |
cpu-protection
Syntax
Context
Description
This command assigns an existing CPU protection policy to the associated group interface. The CPU protection policies are configured in the config>sys>security>cpu-protection>policy cpu-protection-policy-id context.
If no CPU-Protection policy is assigned to a group interface SAP, then the default policy is used to limit the overall-rate. The default policy is policy number 254 for access interfaces and 255 for network interfaces.
The no form of the command removes the association of the CPU protection policy from the associated interface and reverts to the default policy values.
Default
cpu-protection 254 (for access interfaces)
cpu-protection 255 (for network interfaces)
The configuration of no cpu-protection returns the interface/SAP to the default policies as shown above.
Parameters
egress
Syntax
Context
Description
This command enables the context to configure egress SAP Quality of Service (QoS) policies and filter policies.
If no sap-egress QoS policy is defined, the system default sap-egress QoS policy is used for egress processing. If no egress filter is defined, no filtering is performed.
This command only applies to the 7750 SR.
filter
Syntax
Context
Description
This command associates an IP filter policy with an ingress or egress Service Access Point (SAP). Filter policies control the forwarding and dropping of packets based on the matching criteria.
MAC filters are only allowed on Epipe and Virtual Private LAN Service (VPLS) SAPs.
The filter command is used to associate a filter policy with a specified ip-filter-id with an ingress or egress SAP. The filter policy must already be defined before the filter command is executed. If the filter policy does not exist, the operation will fail and an error message returned.
In general, filters applied to SAPs (ingress or egress) apply to all packets on the SAP. One exception is non-IP packets are not applied to the match criteria, so the default action in the filter policy applies to these packets.
The no form of this command removes any configured filter ID association with the SAP. The filter ID itself is not removed from the system unless the scope of the created filter is set to local. To avoid deletion of the filter ID and only break the association with the service object, use the scope command within the filter definition to change the scope to local or global. The default scope of a filter is local.
This command only applies to the 7750 SR.
Special Cases
Parameters
qos
Syntax
Context
Description
Associates a Quality of Service (QoS) policy with an egress Service Access Point (SAP) or IP interface.
QoS egress policies are important for the enforcement of SLA agreements. The policy ID must be defined prior to associating the policy with a SAP or IP interface. If the policy-id does not exist, an error will be returned.
The qos command is used to associate egress QoS policies. The qos command only allows egress policies on SAP or IP interface egress. Attempts to associate a QoS policy of the wrong type returns an error.
Only one ingress QoS policy can be associated with a SAP or IP interface at one time. Attempts to associate a second QoS policy of a given type will return an error.
By default, no specific QoS policy is associated with the SAP or IP interface for egress, so the default QoS policy is used.
The normal behavior is for queues to be created per destination.
The no form of this command removes the QoS policy association from the SAP or IP interface, and the QoS policy reverts to the default.
This command only applies to the 7750 SR.
Parameters
qos
Syntax
Context
Description
Associates a Quality of Service (QoS) policy with an ingress Service Access Point (SAP) or IP interface.
QoS ingress policies are important for the enforcement of SLA agreements. The policy ID must be defined prior to associating the policy with a SAP or IP interface. If the policy-id does not exist, an error will be returned.
This qos command is used to associate ingress QoS policies. The qos command only allows ingress policies to be associated on SAP or IP interface ingress.
Only one ingress and one egress QoS policy can be associated with a SAP or IP interface at one time. Attempts to associate a second QoS policy of a given type will return an error.
By default, no specific QoS policy is associated with the SAP or IP interface for ingress so the default QoS policy is used.
The normal behavior is for queues to be created per destination. Shared and multipoint shared change this behavior creating either unicast or unicast and mcast shared queues.
The no form of this command removes the QoS policy association from the SAP or IP interface, and the QoS policy reverts to the default.
This command only applies to the 7750 SR.
Parameters
scheduler-policy
Syntax
Context
Description
This command applies an existing scheduler policy to an ingress or egress scheduler used by SAP queues associated with this multi-service customer site. The schedulers defined in the scheduler policy can only be created once the customer site has been appropriately assigned to a chassis port, channel or slot. Scheduler policies are defined in the config>qos>scheduler-policy scheduler-policy-name context.
The no form of this command removes the configured ingress or egress scheduler policy from the multi-service customer site. When the policy is removed, the schedulers created due to the policy are removed also making them unavailable for the ingress SAP queues associated with the customer site. Queues that lose their parent scheduler association are deemed to be orphaned and are no longer subject to a virtual scheduler. The SAPs that have ingress queues reliant on the removed schedulers enter into an operational state depicting the orphaned status of one or more queues. When the no scheduler-policy command is executed, the customer site ingress or egress node will not contain an applied scheduler policy.
This command only applies to the 7750 SR.
Parameters
host
Syntax
Context
Description
This command creates a static subscriber host for the SAP. Static subscriber hosts may be used by the system for various purposes. Applications within the system that make use of static host entries include anti-spoof filters and ARP cache population.
Multiple static hosts may be defined on the SAP. Each host is identified by either a source IP address, a source MAC address or both a source IP and source MAC address. Every static host definition must have at least one address defined, IP or MAC.
Static hosts can exist on the SAP even with anti-spoof and ARP populate features disabled. When enabled, each feature has different requirements for static hosts.
Default
none
Parameters
Attempting to define a static subscriber host that conflicts with an existing DHCP lease state table entry will fail.
Use the no form of the command to remove a static entry from the system. The specified ip-address and mac-address must match the host’s exact IP and MAC addresses as defined when it was created. When a static host is removed from the SAP, the corresponding anti-spoof entry and/or ARP cache entry is also removed.
This command only applies to the 7750 SR.
For VPRN SAPs with arp-reply-agent enabled with the optional sub-ident parameter, the static subscriber hosts sub-ident-string is used to determine whether an ARP request received on the SAP is sourced from a host belonging to the same subscriber as the destination host. When both the destination and source hosts from the ARP request are known on the SAP and the subscriber identifications do not match, the ARP request may be forwarded to the rest of the VPRN destinations.
If the static subscriber hosts sub-ident string is not defined, the host is not considered to belong to the same subscriber as another host on the SAP.
If source or destination host is unknown, the hosts are not considered to belong to the same subscriber. (ARP messages from unknown hosts are subject to anti-spoof filtering rules applied at the SAP.)
If sub-ident is not enabled on the SAP arp-reply-agent, subscriber identification matching is not performed on ARP requests received on the SAP.
ARP requests are never forwarded back to the same SAP or within the receiving SAP’s Split Horizon Group.
ingress
Syntax
Context
Description
This command enables the context to configure ingress SAP Quality of Service (QoS) policies and filter policies.
If no SAP ingress QoS policy is defined, the system default sap-ingress QoS policy is used for ingress processing. If no ingress filter is defined, no filtering is performed.
This command only applies to the 7750 SR.
multi-service-site
Syntax
Context
Description
This command creates a new customer site or edits an existing customer site with the customer-site-name parameter. A customer site is an anchor point to create an ingress and egress virtual scheduler hierarchy. When a site is created, it must be assigned to a chassis slot or port. When scheduler policies are defined for ingress and egress, the scheduler names contained in each policy are created according to the parameters defined in the policy. Multi-service customer sites exist for the sole purpose of creating a virtual scheduler hierarchy and making it available to queues on multiple Service Access Points (SAPs).
The scheduler policy association with the customer site normally prevents the scheduler policy from being deleted until after the scheduler policy is removed from the customer site. The multi-service-site object will generate a log message indicating that the association was deleted due to scheduler policy removal.
When the multi-service customer site is created, an ingress and egress scheduler policy association does not exist. This does not prevent the site from being assigned to a chassis slot or prevent service SAP assignment. After the site has been created, the ingress and egress scheduler policy associations can be assigned or removed at anytime.
This command only applies to the 7750 SR.
Default
None — Each customer site must be explicitly created.
Parameters
If the customer-site-name does not exist, it is assumed that an attempt is being made to create a site of that name in the customer ID context. The success of the command execution depends on the following:
The maximum number of customer sites defined for the chassis slot has not been met.
The customer-site-name is valid.
The create keyword is included in the command line syntax (if the system requires it).
When the maximum number of customer sites has been exceeded a configuration error occurs, the command will not execute and the CLI context will not change.
If the customer-site-name is invalid, a syntax error occurs, the command will not execute and the CLI context will not change.
ATM Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
atm
Syntax
Context
Description
This command enables access to the context to configure ATM-related attributes. This command can only be used when a given context (for example, a channel or SAP) supports ATM functionality such as:
- Configuring ATM port or ATM port-related functionality on MDAs supporting ATM functionality
- Configuring ATM-related configuration for ATM-based SAPs that exist on MDAs supporting ATM functionality.
If ATM functionality is not supported for a given context, the command returns an error.
egress
Syntax
Context
Description
This command enables the context to configure egress ATM attributes for the SAP.
encapsulation
Syntax
Context
Description
This command configures RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, encapsulation for an ATM PVCC delimited SAP.
This command specifies the data encapsulation for an ATM PVCC delimited SAP. The definition references RFC 2684 and to the ATM Forum LAN Emulation specification.
Ingress traffic that does not match the configured encapsulation will be dropped.
Default
The encapsulation is driven by the services for which the SAP is configured. For IES service SAPs, the default is aal5snap-routed.
Parameters
ingress
Syntax
Context
Description
This command configures ingress ATM attributes for the SAP.
traffic-desc
Syntax
Context
Description
This command assigns an ATM traffic descriptor profile to a given context (for example, a SAP). When configured under the ingress context, the specified traffic descriptor profile defines the traffic contract in the forward direction. When configured under the egress context, the specified traffic descriptor profile defines the traffic contract in the backward direction.
The no form of the command reverts the traffic descriptor to the default traffic descriptor profile.
Default
The default traffic descriptor (trafficDescProfileId. = 1) is associated with newly created PVCC-delimited SAPs.
Parameters
oam
Syntax
Context
Description
This command enables the context to configure OAM functionality for a PVCC delimiting a SAP.
The ATM-capable MDAs support F5 end-to-end OAM functionality (AIS, RDI, Loopback):
- ITU-T Recommendation I.610 - B-ISDN Operation and Maintenance Principles and Functions version 11/95
- GR-1248-CORE - Generic Requirements for Operations of ATM Network Elements (NEs). Issue 3 June 1996
- GR-1113-CORE - Bellcore, Asynchronous Transfer Mode (ATM) and ATM Adaptation Layer (AAL) Protocols Generic Requirements, Issue 1, July 1994
alarm-cells
Syntax
Context
Description
This command configures AIS/RDI fault management on a PVCC. Fault management allows PVCC termination to monitor and report the status of their connection by propagating fault information through the network and by driving PVCCs operational status.
When alarm-cells functionality is enabled, PVCCs operational status is affected when a PVCC goes into AIS or RDI state because of an AIS/RDI processing (i.e. assuming nothing else affects PVCCs operational status, PVCC goes DOWN, when it enters a fault state and comes back UP, when it exits that fault state) and RDI cell are generated when PVCC is operationally DOWN. No OAM-specific SNMP trap is raised whenever an endpoint enters/exits an AIS or RDI states, however, if as result of an OAM state change, the PVCC changes operational status, then a trap is expected from an entity the PVCC is associated with (for example a SAP).
The no command disables alarm-cells functionality for a PVCC. When alarm-cells functionality is disabled, PVCCs operational status is no longer affected by PVCCs OAM state changes due to AIS/RDI processing (when alarm-cells is disabled, a PVCC will change operational status to UP, if it was DOWN because of the alarm-cell processing) and RDI cells are not generated as result of PVCC going into AIS or RDI state, however, PVCCs OAM status will record OAM faults as described above.
Default
Enabled for PVCCs delimiting IES SAPs
periodic-loopback
Syntax
Context
Description
This command enables periodic OAM loopbacks on this SAP. This command is only configurable on IES and VPRN SAPs. When enabled, an ATM OAM loopback cell is transmitted every period as configured in the config>system>atm>oam>loopback-period period context.
If a response is not received and consecutive retry-down retries also result in failure, the endpoint will transition to an alarm indication signal/loss of clock state. Then, an ATM OAM loopback cell will be transmitted every period as configured in the loopback-period period. If a response is received for the periodic loopback and consecutive retry-up retries also each receive a response, the endpoint will transition back to the up state.
The no form of the command sets the value back to the default.
Default
no periodic-loopback
Redundant Interface Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
redundant-interface
Syntax
Context
Description
This command configures a redundant interface.
Parameters
address
Syntax
Context
Description
This command assigns an IP address mask or netmask and a remote IP address to the interface.
Parameters
Assigns an IP address netmask to the interface.
spoke-sdp
Syntax
Context
Description
This command binds a service to an existing Service Distribution Point (SDP).
A spoke SDP is treated like the equivalent of a traditional bridge “port” where flooded traffic received on the spoke SDP is replicated on all other “ports” (other spoke and mesh SDPs or SAPs) and not transmitted on the port it was received.
The SDP has an operational state which determines the operational state of the SDP within the service. For example, if the SDP is administratively or operationally down, the SDP for the service will be down.
The SDP must already be defined in the config>service>sdp context in order to associate an SDP with a VPRN service. If the sdp sdp-id is not already configured, an error message is generated. If the sdp-id does exist, a binding between that sdp-id and the service is created.
SDPs must be explicitly associated and bound to a service. If an SDP is not bound to a service, no far-end 7750 SRdevices can participate in the service.
The no form of this command removes the SDP binding from the service. The SDP configuration is not affected; only the binding of the SDP to a service. Once removed, no packets are forwarded to the far-end router.
Default
No sdp-id is bound to a service.
Special Cases
Parameters
egress
Syntax
Context
Description
This command configures egress SDP parameters.
ingress
Syntax
Context
Description
This command configures ingress SDP parameters.
vc-label
Syntax
Context
Description
This command configures the egress VC label.
Parameters
vc-label
Syntax
Context
Description
This command configures the ingress VC label.
Parameters
filter
Syntax
Context
Description
This command associates an IP filter policy with an ingress or egress Service Access Point (SAP) or IP interface. An IP filter policy can be associated with spoke SDPs.
Filter policies control the forwarding and dropping of packets based on IP or MAC matching criteria.
The filter command is used to associate a filter policy with a specified ip-filter-id with an ingress or egress SAP. The ip-filter-id must already be defined before the filter command is executed. If the filter policy does not exist, the operation will fail and an error message returned.
In general, filters applied to SAPs (ingress or egress) apply to all packets on the SAP. One exception is non-IP packets are not applied to IP match criteria, so the default action in the filter policy applies to these packets.
The no form of this command removes any configured filter ID association with the SAP or IP interface. The filter ID itself is not removed from the system unless the scope of the created filter is set to local. To avoid deletion of the filter ID and only break the association with the service object, use scope command within the filter definition to change the scope to local or global. The default scope of a filter is local.
Parameters
SDP Binding Commands
binding
Syntax
Context
Description
The command enables the context to configure SDP bindings.
port
Syntax
Context
Description
This command specifies the port or lag identifier, to which the PW ports associated with the underlying SDP are bound. If the underlying SDP is re-routed to a port or lag other than the specified one, the PW ports on the SDP are operationally brought down.
The no form of the command removes the value from the configuration.
Default
none
Parameters
pw-port
Syntax
Context
Description
This command creates a pseudowire port.
The no form of the command removes the pseudowire port ID from the configuration.
Default
none
Parameters
description
Syntax
Context
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command associates a text string with a configuration context to help identify the content in the configuration file.
The no form of the command removes the string from the configuration.
Default
no description
Parameters
egress
Syntax
Context
Description
This command enables the context to configure PW-port egress side parameters.
encap-type
Syntax
Context
Description
This command sets the encapsulation type for the PW-port as dot1q or qinq.
Default
dot1q
Parameters
shaper
Syntax
Context
Description
This command configures an egress shaping option for use by a PW port..
Default
no shaper.
int-dest-id
Syntax
Context
Description
This command specifies the intermediate destination string configured for dynamic vport selection.
The no form of the command removes the configured intermediate destination string.
This command is only valid for PW ports used for enhanced subscriber management (ESM on PW).
Default
no .int-dest-id
Parameters
vport
Syntax
Context
Description
This command configures the name of the vport to be used for the PW port.
The no form of the command removes the configured vport name.
This command is valid for PW ports used for enhanced subscriber management (ESM on pseudowire) and pseudowire SAPs on Ethernet ports. It is not valid for pseudowire ports on the HSMDA.
Default
no vport
Parameters
vc-type
Syntax
Context
Description
This command sets the forwarding mode for PW-port. The vc-type is signaled to the peer, and must be configured consistently on both ends of the PW. vc-type VLAN is only configurable with dot1q encapsulation on the PW-port. The tag with vc-type vlan only has significance for transport, and is not used for service delineation or ESM. The top (provider tag) is stripped while forwarding out of the PW, and a configured vlan-tag (for vc-type vlan) is inserted when forwarding into the PW. With vc-type ether, the tags if present (max 2), are transparently preserved when forwarding in our out of the PW.
The no form of the command reverts to the default value.
Default
ether
Parameters
vlan-vc-tag
Syntax
Context
Description
This command sets tag relevant for vc-type vlan mode. This tag is inserted in traffic forwarded into the PW.
The no form of the command reverts to the default value.
Default
0
Parameters
RIP Commands
rip-policy
Syntax
Context
Description
This command creates a RIP policy. This policy is applied to a subscriber IPv4 host to enable the BNG to learn RIP routes from the host. RIP routes are never sent to the hosts.
Default
none
Parameters
neighbor
Syntax
Context
Description
This command creates a context for configuring a RIP neighbor interface. By default, group interfaces are not activated with RIP, unless explicitly configured. The BNG will only learn RIP routes from IPv4 host on the group interface. Hence, RIP neighbor group interface will default send to “none”. The send operation is unchangeable for group-interface.
The no form of the command deletes the RIP interface configuration for this group interface. The shutdown command in the config>router>rip>group group-name>neighbor context can be used to disable an interface without removing the configuration for the interface.
Default
no neighbor — No RIP interfaces are defined.
Parameters
authentication-key
Syntax
Context
Description
This command configures the BGP authentication key.
Authentication is performed between neighboring routers before setting up the BGP session by verifying the password. Authentication is performed using the MD-5 message-based digest. The authentication key can be any combination of letters or numbers from 1 to 16.
The no form of the command removes the authentication password from the configuration and effectively disables authentication.
Default
Authentication is disabled and the authentication password is empty.
Parameters
This is useful when a user must configure the parameter, but, for security purposes, the actual unencrypted key value is not provided.
authentication-type
Syntax
Context
Description
This command sets the type of authentication to be used between RIP neighbors. The type and password must match exactly for the RIP message to be considered authentic and processed.
The no form of the command removes the authentication type from the configuration and effectively disables authentication.
Default
no authentication-type — No authentication enabled.
Parameters
retail-svc-id
Syntax
Context
Description
This command specifies the service id of the retailer IES/VPRN service to which the static IPv6 host belongs. A corresponding retailer subscriber interface must exist in the specified service.
Default
no retail-svc-id
Parameters
rip
Syntax
Context
Description
This command enables the RIP protocol on the given VPRN IP interface.
The no form of the command disables the RIP protocol from the given VPRN IP interface.
Default
no rip
group
Syntax
Context
Description
This command creates a context for configuring a RIP group of neighbors. RIP groups are a way of logically associating RIP neighbor interfaces to facilitate a common configuration for RIP interfaces.
The no form of the command deletes the RIP neighbor interface group. Deleting the group will also remove the RIP configuration of all the neighbor interfaces currently assigned to this group.
Default
no group — No group of RIP neighbor interfaces defined
Parameters
Vport Commands
ethernet
Syntax
Context
Description
This command enables access to the context to configure Ethernet port attributes.
This context can only be used when configuring Fast Ethernet, gigabit or 10Gig Fast Ethernet or Ethernet LAN ports on an appropriate MDA.
egress-scheduler-override
Syntax
Context
Description
This command applies egress scheduler overrides. When a port scheduler is associated with an egress port, it is possible to override the following parameters:
- The max-rate allowed for the scheduler.
- The maximum rate for each priority level 8 through 1.
- The CIR associated with each priority level 8 through 1.
See the SR OS Quality of Service Guide for command syntax and usage for the port-scheduler-policy command.
The no form of this command removes all override parameters from the egress port or channel scheduler context. Once removed, the port scheduler reverts all rate parameters back to the parameters defined on the port-scheduler-policy associated with the port.
level
Syntax
Context
Description
This command overrides the maximum and CIR rate parameters for a specific priority level on the port or channel’s port scheduler instance. When the level command is executed for a priority level, the corresponding priority level command in the port-scheduler-policy associated with the port is ignored. The override level command supports the keyword max for the rate and cir parameter. When executing the level override command, at least the rate or cir keywords and associated parameters must be specified for the command to succeed.
The no form of this command removes the local port priority level rate overrides. Once removed, the port priority level will use the port scheduler policies level command for that priority level.
Parameters
access
Syntax
Context
Description
This command configures Ethernet access port parameters.
egress
Syntax
Context
Description
This command configures Ethernet access egress port parameters.
vport
Syntax
Context
Description
This command configures a scheduling node, referred to as virtual port, within the context of an egress Ethernet port. The vport scheduler operates either like a port scheduler with the difference that multiple vport objects can be configured on the egress context of an Ethernet port, or it can be an aggregate rate when an egress port-scheduler policy is applied to the port.
The vport is always configured at the port level even when a port is a member of a LAG.
When a port scheduler policy is applied to a vport the following command is used:
configure>port>ethernet>acess>egress>vport>port-scheduler-policy port-scheduler-policy-name
The CLI will not allow the user to apply a port scheduler policy to a vport if one has been applied to the port. Conversely, the CLI will not allow the user to apply a port scheduler policy to the egress of an Ethernet port if one has been applied to any vport defined on the access egress context of this port. The agg-rate-limit, along with an egress port-scheduler, can be used to ensure that a given vport does not oversubscribe the port’s rate.
SAP and subscriber host queues can be port-parented to a vport scheduler in a similar way they port-parent to a port scheduler or can be port-parented directly to the egress port-scheduler if the agg-rate-limit is used.
When the vport uses an aggregate rate, the following command is used:
configure>port>ethernet>acess>egress>vport>agg-rate-limit
Parameters
agg-rate-limit
Syntax
Context
Description
This command configures an aggregate rate for the vport. This command is mutually exclusive with the port-scheduler-policy command.
Parameters
egress-rate-modify
Syntax
Context
Description
This command is used to apply HQoS Adjustment to a vport. HQoS Adjustment refers to the dynamic adjustment of the rate limit at an QoS enforcement point within router when the multicast traffic stream is disjointed from the unicast traffic stream. This QoS enforcement point within router represents the physical point further down in the access part of the network where the two streams join each other and potentially can cause congestion.
An example would be a PON port which is shared amongst subscriber’s multicast traffic (single copy of each channel) and subscriber’s unicast traffic. The bandwidth control point for this PON port resides in the upstream router BNG node in the form of a vport. In case that the multicast delivery method in the router BNG utilizes redirection, the multicast traffic in the router BNG will flow outside of the subscriber or the vport context and thus will bypass any bandwidth enforcement in the router. To correct this, a vport bandwidth adjustment is necessary in the router that will account for the multicast bandwidth consumption that is bypassing vport in the router but is present in the PON port whose bandwidth is controlled by vport.
An estimate of the multicast bandwidth consumption on the PON port can be made at the vport level based on the IGMP messages sourced from the subscribers behind the PON port. This process is called HQoS Adjustment.
A multicast channel bandwidth is subtracted from or added to the vport rate limit according to the received IGMP Join/Leave messages and the channel bandwidth definition policy associated with the vport (indirectly through a group-interface). Since the multicast traffic on the PON port is shared amongst subscribers behind this PON port, only the first IGMP Join or the last IGMP Leave per multicast channel is tracked for the purpose of the vport bandwidth modification.
The vport rate that will be affected by this functionality depends on the configuration:
- In case the agg-rate-limit within the vport is configured, its value will be modified based on the IGMP activity associated with the subscriber under this vport.
- In case the port-scheduler-policy within the vport is referenced, the max-rate defined in the corresponding port-scheduler-policy will be modified based on the IGMP activity associated with the subscriber under this vport.
The channel bandwidth definition policy is defined in the mcac policy in the configure>router>mcac>policy context. The policy is applied under the group-interface or in case of redirection under the redirected-interface.
The rates in effect can be displayed with the following two commands:
show port 1/1/5 vport name
qos scheduler-hierarchy port port-id vport vport-name
The configuration of a scheduler policy under a Vport, which is only applicable to Ethernet interfaces, is mutually exclusive with the configuration of the egress-rate-modify parameter.
The configuration of a scheduler policy under a Vport, which is only applicable to Ethernet interfaces, is mutually exclusive with the configuration of the egress-rate-modify parameter.
Default
HQoS Adjustment for vport is disabled.
host-match
Syntax
Context
Description
This command configures host matching for the Ethernet port egress queue-group.
The no form of the command removes
Parameters
port-scheduler-policy
Syntax
Context
Description
This command specifies the destination and organization strings to be used for matching subscriber hosts with this vport.
The parent vport of a subscriber host queue, which has the port-parent option enabled, is determined by matching the destination string dest string associated with the subscriber and the organization string org string associated with the subscriber host with the strings defined under a vport on the port associated with the subscriber.
If a given subscriber host queue does not have the port-parent option enabled, it will be foster-parented to the vport used by this subscriber and which is based on matching the dest string and org string. If the subscriber could not be matched with a vport on the egress port, the host queue will not be bandwidth controlled and will compete for bandwidth directly based on its own PIR and CIR parameters.
By default, a subscriber host queue with the port-parent option enabled is scheduled within the context of the port’s port scheduler policy.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command. Applying a scheduler-policy to a VPORT is only applicable to Ethernet interfaces.
The no form of the command removes the port-scheduler-policy-name from the configuration.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
Parameters
scheduler-policy
Syntax
Context
Description
This command specifies a scheduler policy to associate to the Vport. Scheduler policies are configured in the configure>qos>scheduler>policy context. Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations. The policy defines the hierarchy and operating parameters for virtual schedulers.
The no form of this command removes the configured egress scheduler policy from the VPORT.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
The configuration of a scheduler policy under a Vport is mutually exclusive with the configuration of the egress-rate-modify parameter.
Parameters
parent-location
Syntax
Context
Description
This command determines the expected location of the parent schedulers for queues configured with a parent command within the SAP egress policy. All parent schedulers must be configured within a scheduler policy applied at the location corresponding to the parent-location parameter.
If a parent scheduler name does not exist at the specified location, the queue will not be parented and will be orphaned.
Default
parent-location default
Parameters
parent-location
Syntax
Context
Description
This command determines the expected location of the parent schedulers for the tier 1 schedulers configured with a parent command within the scheduler policy. The parent schedulers must be configured within a scheduler policy applied at the location corresponding to the parent location parameter.
If a parent scheduler name does not exist at the specified location, the schedulers will not be parented and will be orphaned.
The configuration of parent-location and frame-based-accounting in a scheduler policy is mutually exclusive in to ensure consistency between the different scheduling levels.
Default
parent-location none
Parameters
If this parameter is configured within a scheduler policy that is applied to any object except for the egress of an SLA profile, the configured parent schedulers will not be found and so the tier 1 schedulers will not be parented and will be orphaned.
If this parameter is configured within a scheduler policy that is applied to to any object except for the egress of an SLA profile or SUB profile, or to the egress of a PW SAP, the configured parent schedulers will not be found and so the tier 1 schedulers will not be parented and will be orphaned.
MLD Policy Commands
mld-policy
Syntax
Context
Description
This command enables the context to create an MLD policy.
egress-rate-modify
Syntax
Context
Description
This command configures the egress rate modification.
The no form of the command removes the values from the configuration.
Parameters
fast-leave
Syntax
Context
Description
This command enables fast leave. When fast leave processing is enabled, the router will immediately remove a SAP or SDP from the IP multicast group when it detects an MLD 'leave' on that SAP or SDP. Fast leave processing allows the switch to remove a SAP or SDP that sends a 'leave' from the forwarding table without first sending out group-specific queries to the SAP or SDP, and thus speeds up the process of changing channels ('zapping').
Fast leave should only be enabled when there is a single receiver present on the SAP or SDP.
When fast leave is enabled, the configured last-member-query-interval value is ignored.
Default
no fast-leave
import
Syntax
Context
Description
This command specifies the import routing policy to be used. Only a single policy can be imported at a time.
The no form of the command removes the policy association.
Default
no import — No import policy is specified.
Parameters
max-num-groups
Syntax
Context
Description
This command defines the maximum number of multicast groups that can be joined. If the router receives a join message that would exceed the configured number of groups, the request is ignored.
Default
no max-num-groups
Parameters
max-num-grp-sources
Syntax
Context
Description
This command configures the maximum number of group sources for which MLD can have local receiver information based on received MLD reports on this interface. When this configuration is changed dynamically to a value lower than currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources will not be allowed. When this object has a value of 0, there is no limit to the number of group sources.
The no form of the command removes the value from the configuration.
Default
no max-num-grp-sources
Parameters
max-num-sources
Syntax
Context
Description
This command configures the maximum number of multicast sources allowed per group.
The no form of the command removes the value from the configuration.
Parameters
per-host-replication
Syntax
Context
Description
This command enables per-host-replication. In the per-host-replication mode, multicast traffic is replicated per each host within the subscriber irrespective of the fact that some hosts may be subscribed to the same multicast stream. As a result, in case that multiple hosts within the subscriber are registered for the same multicast group, the multicast streams of that group will be generated. The destination MAC address of multicast streams will be changed to unicast so that each host receives its own copy of the stream. Multicast traffic in the per-host-replication mode can be classified via the existing QoS CLI structure. As such the multicast traffic will flow through the subscriber queues. HQoS Adjustment is not needed in this case.
The alternative behavior for multicast replication in IPoE environment is per-SAP- replication. In this model, only a single copy of the multicast stream is sent per SAP, irrespective of the number of hosts that are subscribed to the same multicast group. This behavior applies to 1:1 connectivity model as well as on 1:N connectivity model (SAP centric behavior as opposed to subscriber centric behavior).
In the per-SAP-replication model the destination MAC address is multicast (as opposed to unicast in the per-host-replication model). Multicast traffic is flowing via the SAP queue which is outside of the subscriber context. The consequence is that multicast traffic is not accounted in the subscriber HQoS. In addition, HQoS Adaptation is not supported in the per SAP replication model.
Default
disabled
redirection-policy
Syntax
Context
Description
This command will apply multicast redirection action to the subscriber. The redirection action along with the redirected interface (and possibly service id) is defined in the referenced policy-name. MLD messages will be redirected to an alternate interface if that alternate interface has MLD enabled. The alternate interface does not have to have any multicast groups registered via MLD. Currently all MLD messages are redirected and there is no ability to selectively redirect MLD messages based on match conditions (multicast-group address, source IP address, etc.). Multicast redirection is supported between VPRN services and also between interfaces within the Global Routing Context. Multicast Redirection is not supported between the VRPN services and the Global Routing Table (GRT).
MLD state is maintained per subscriber host and per redirected interface. Traffic is however forwarded only on the redirected interface.
Default
none
Parameters
static
Syntax
Context
Description
This command adds an MLD static group membership.
group
Syntax
Context
Description
This command configures a static multicast group.
Parameters
source
Syntax
Context
Description
This command adds or removes a static multicast source.
Parameters
starg
Syntax
Context
Description
This command adds a static (*,G) entry. This command can only be enabled if no existing source addresses for this group are specified.
Use the no form of the command to remove the starg entry from the configuration.
Default
none
version
Syntax
Context
Description
This command configures the MLD version.
Parameters
IPoE Session Commands
ipoe-session-policy
Syntax
Context
Description
This command configures an IPoE session policy. The policies are referenced from subscriber interfaces, group interfaces and capture SAPs. Multiple IPoE session policies can be configured.
Default
none
Parameters
description
Syntax
Context
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command 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.
Default
no description
Parameters
session-key
Syntax
Context
Description
This command configures the key to logically group subscriber hosts that belong to the same dual stack end device in an IPoE session.
The SAP and MAC address are always part of the IPoE session key. Optionally the Circuit-Id/Interface-Id or Remote-Id can be added to the session key.
Default
session-key sap mac
Parameters
sap and mac are mandatory parameters while cid and rid are optional and mutually exclusive. Valid IPoE session key parameters are: sap mac, sap mac cid and sap mac rid.
session-timeout
Syntax
Context
Description
This command defines the time in seconds between 1 second and 360 days before the IPoE session will be disconnected. The default value is unlimited session timeout.
Default
no session-timeout
Parameters
sap
Syntax
Context
Description
This command declares a given SAP as a primary (or secondary) VPLS port.
ipoe-session
Syntax
Context
Description
This command configures IPoE session parameters.
Default
none
force-auth
Syntax
Context
Description
By default, if the circuit-id/interface-id or remote-id in the IPoE session re-authentication trigger packet (such as a DHCP renewal) is not empty and different from the circuit-id/interface-id or remote-id stored in the IPoE session data, a forced re-authentication is performed, ignoring the configured min-auth-interval. This default behavior can be changed with this command.
The no form of the command resets the default behavior.
Default
force-auth cid-change rid-change force-auth disabled on WLAN-GW group interfaces
Parameters
ipoe-session-policy
Syntax
Context
Description
This command specifies the IPoE session policy applicable for this group interface or capture SAP.
On wlan-gw group interfaces, it is not possible to change this value.
Default
no ipoe-session-policy ipoe-session-policy “default” on WLAN-GW group interfaces
Parameters
min-auth-interval
Syntax
Context
Description
Re-authentication for IPoE sessions enable dynamic policy changes.
This command configures the maximum frequency of re-authentications by specifying a minimum interval between two non-forced authentications for the same IPoE session.
A forced authentication is by default triggered by a Circuit-Id/Interface-Id or Remote-Id change (see the force-auth command).
Re-authentications are, by default, disabled and can be enabled by configuring a min-auth-interval.
Setting the min-auth-interval to zero seconds will always re-authenticate on each trigger packet.
Default
min-auth-interval infinite
Parameters
radius-session-timeout
Syntax
Context
Description
This command specifies how to interpret the session-timeout coming from a RADIUS VSA in an Access-Accept or CoA message.
The value of this command can only be changed on WLAN-GW group interfaces.
The no form of this command resets the default value.
Default
absolute backwards-compatible on WLAN-GW group interfaces
Parameters
sap-session-limit
Syntax
Context
Description
This command specifies the number of IPoE sessions per SAP allowed for this group-interface
Default
sap-session-limit 1
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
session-limit
Syntax
Context
Description
This command specifies the number of IPoE sessions allowed for this group interface or retail subscriber interface.
Default
session-limit 1
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
user-db
Syntax
Context
Description
This command configures the local user database to use for IPoE session authentication.
When configured on a capture SAP, the group interface must have the same local user database configured.
On a WLAN-GW group interface, the no form of this command indicates that the user database will be picked from the following sources in the order shown:
- dhcp
- ipv6> dhcp6
- ipv6> router-solicit
If no user database can be found in any of these locations, processing continues as if no user database was configured. This behavior is for backwards compatibility reasons only; when using a LUDB, it should be explicitly added to the IPoE session configuration.
Default
no user-db
Parameters
shutdown
Syntax
Context
Description
The shutdown command enables or disables IPoE session management on a group interface or capture SAP.
A shutdown of the IPoE session CLI hierarchy on a group-interface will clear all active IPoE sessions on that interface, resulting in a deletion of all corresponding subscriber hosts.
On WLAN-GW group interfaces it is not possible to disable an IPoE session.
Default
shutdown no shutdown on WLAN-GW group interfaces
SHCV Policy Commands
shcv-policy
Syntax
Context
Description
This command configures a Subscriber Host Connectivity Verification (SHCV) policy. An SHCV policy can be applied to both the subscriber management group interface and VPLS instances. All SHCV-related features inside a group interface and a VPLS service will follow the configuration specified in the SHCV policy. The SHCV policy and the SHCV configuration on a group interface are mutually exclusive. Only one can be applied to the group interface.
The no form of the command removes the policy name from the configuration.
Default
none
Parameters
layer-3
Syntax
Context
Description
This command enables the context to configure SHCV behavior parameters for IES and VPRN services.
Default
none
source-ip-origin
Syntax
Context
Description
This command selects the source IP address to be used for SHCV messages.
The no form of the command reverts to the default.
Parameters
periodic
Syntax
Context
Description
This command configures the periodic SHCV properties for the subscriber management group-interface. This tool will periodically scan all known DHCP hosts only and perform unicast ARP/NS requests. The subscriber host connectivity verification will maintain state (connected vs. not-connected) for all hosts.
Default
none
action
Syntax
Context
Description
This command configures the action to take when the periodic connectivity verification failed.
The no form of the command reverts to the default.
Default
alarm
Parameters
interval
Syntax
Context
Description
This command specifies the time interval which all known sources should be verified. The actual rate is dependent on the number of known hosts and intervals.
The no form of the command reverts to the default.
Default
30 minutes
Parameters
retry-count
Syntax
Context
Description
This command configures the number of retransmissions.
The no form of the command reverts to the default.
Default
2
Parameters
timeout
Syntax
Context
Description
This command configures the timeout before a retransmission in triggered connectivity verification.
The no form of the command reverts to the default.
Default
10
Parameters
trigger
Syntax
Context
Description
This command enables to context to configure SHCV triggers.
Default
none
Parameters
retry-count
Syntax
Context
Description
This command configures the number of retransmissions in periodic connectivity verification.
The no form of the command reverts to the default.
Default
1
Parameters
timeout
Syntax
Context
Description
This command configures the timeout before a retransmission.
The no form of the command reverts to the default.
Default
1
Parameters
vpls
Syntax
Context
Description
This command enables the context to configure SHCV behavior in VPLS services.
source-ip
Syntax
Context
Description
This command configures the IPv4 address to be used as source address for connectivity verification in a VPLS service.
The no form of the command reverts to the default.
Default
no source-ip
Parameters
source-mac
Syntax
Context
Description
Specifies the MAC address to be used as source address for connectivity verification in a VPLS service.
The no form of the command reverts to the default.
Default
no source-mac
Parameters
Show Commands
| Note:
The command outputs in the following section are examples only; actual displays may differ depending on supported functionality and user configuration. |
diameter-peer-policy
Syntax
Context
Description
This command displays diameter peer policy information and diameter peer information and statistics. For the diameter proxy, the incoming peer can be specified with an IP address and port number.
Parameters
Output
Table 85 provides a description of the counters in the output of the show aaa diameter-peer-policy command. and Table 86 provides the failure reasons for the aggregate Failed counter (Request Rx and Answer Rx). Sample output follows the tables.
Table 85: show aaa diameter-peer-policy Field Descriptions
Counter | Counts | |
Aggregates Total | Request Tx | Aggregated countersum of all successfully transmitted diameter request messages (all applications, all message types) |
Answer Rx | Aggregated countersum of all successfully received diameter answer messages (all applications, all message types) | |
Request Rx | Aggregated countersum of all successfully received diameter request messages (all applications, all message types) | |
Answers Tx | Aggregated countersum of all successfully transmitted diameter answer messages (all applications, all message types) | |
Aggregates Failed | Request Tx | Aggregated countersum of all request messages that could not be sent for internal reasons, such as TCP socket error (for example, congestion), failure reported to application (for example, no retries left)Dropped by PythonTimeouts (requests for which no answer was received within the configured timeout interval) |
Answer Rx | Aggregated countersum of all Answer messages that failed to be successfully decoded, such as such as invalid header length or a violation against the Command Code Format (CCF) specification. See Table 86 Aggregate Failed Request Rx and Answer Rx counters for more information. | |
Request Rx | Aggregated countersum of all Request messages that failed to be successfully decoded, such as invalid header length or a violation against the Command Code Format (CCF) specificationSee Table 86 Aggregate Failed Request Rx and Answer Rx counters for more information. | |
Answers Tx | Aggregated counterSum of all answer messages that could not be sent for internal reasons such as TCP socket error (for example, congestion)Dropped by Python | |
Application ID id message type | Request Tx | successfully transmitted diameter request messages for the corresponding application and message type |
Answer Rx | successfully received diameter answer messages for the corresponding application and message type | |
Request Rx | successfully received diameter request messages for the corresponding application and message type | |
Answers Tx | successfully transmitted diameter answer messages for the corresponding application and message type | |
Table 86: Aggregate Failed Request Rx and Answer Rx counters
Role | Failed reasons |
Proxy | proxy (message length too short / too long / version unsupported) |
Consistency check failed: header size, message length, illegal flag combination, AVP header too small, AVP present but not allowed (base RFC messages), etc. | |
not a base message | |
not a request | |
Tx overload (message received to be send to client) | |
dropped by python | |
failed to create answer | |
no transaction (answer to server, but request is not found - 5 min.) | |
Diameter base / Diameter application | message dropped due to result code |
message too big / too small | |
dropped by python | |
consistency check failed | |
end-2-end mismatch hop-to-hop command code (answer/request mismatch) | |
cool down sequence drop | |
cc error request | |
application id in header error | |
T bit in header |
isa-radius-policy
Syntax
Context
Description
This command displays ISA RADIUS policy information.
Parameters
Output
Table 87: Subscriber ISA RADIUS Policy Field Descriptions
Label | Description |
Purposes Up | Indicates the RADIUS services that are up and running, and fully operational for this server. |
Source IP address | Indicates the IP address of the RADIUS server. |
Acct Tx Requests | Indicates the number of RADIUS transaction requests transmitted. |
Acct TX Retries | Indicates the number of RADIUS transaction request retries. |
Acct TX Timeouts | Indicates the number of RADIUS transaction requests that have timed out. |
Acct RX Replies | Indicates the number of RADIUS transaction responses received. |
Auth Tx Requests | Indicates the number of authentication requests transmitted. |
Auth Tx Retries | Indicates the number of authentication request retries. |
Auth Tx Timeouts | Indicates the number of RADIUS authentication requests that have timed out for the policy. |
CoA RX Requests | Indicates the number of Change-of-Authorization message responses received. |
radius-configuration
Syntax
Context
Description
This command displays RADIUS configuration information.
Output
radius-server-policy
Syntax
Context
Description
This command displays RADIUS server policy configuration information.
Parameters
Output
Table 88: Subscriber RADIUS Server Policy Field Descriptions
Label | Description |
Tx transaction requests | Indicates the number of RADIUS transaction requests transmitted. |
Rx transaction responses | Indicates the number of RADIUS transaction responses received. |
Transaction requests timed out | Indicates the number of RADIUS transaction requests that have timed out. |
Transaction requests send failed | Indicates the number of RADIUS transaction requests that could not be transmitted. |
Packet retries | Indicates the number of times a RADIUS request packet was retransmitted to a server. |
Transaction requests send rejected | Indicates the number of RADIUS transaction requests that were not transmitted due to unacceptable configuration. |
Authentication requests failed | Indicates the number of authentication failures for this policy. |
Accounting requests failed | Indicates the number of accounting failures for this policy. |
Ratio of access-reject over auth responses | Indicates the ratio of access-rejects in the auth responses for this policy. |
Transaction success ratio | Indicates the transaction success ratio for this policy. |
Transaction failure ratio | Indicates the transaction failure ratio for this policy. |
Statistics last reset at | Indicated the date and time at which the statistics for this policy were last reset. |
ancp-policy
Syntax
Context
Description
This command displays subscriber Access Node Control Protocol (ANCP) policy information.
Parameters
Output
ancp-string
Syntax
Context
Description
This command displays subscriber Access Node Control Protocol (ANCP) string information.
Parameters
<sap-id> | null | <port-id|bundle-id|bpgrp-id|lag-id|aps-id> | |
dot1q | <port-id|bundle-id|bpgrp-id|lag-id|aps-id|pw-id>:qtag1 | ||
qinq | <port-id|bundle-id|bpgrp-id|lag-id| pw-id>:qtag1.qtag2 | ||
atm | <port-id|aps-id>[:vpi/vci|vpi|vpi1.vpi2|cp.conn-prof-id] | ||
cp | keyword | ||
conn-prof-id | [1..8000] | ||
frame | <port-id|aps-id>:dlci | ||
cisco-hdlc | slot/mda/port.channel | ||
cem | slot/mda/port.channel | ||
ima-grp | <bundle-id>[:vpi/vci|vpi|vpi1.vpi2|cp.conn-prof-id] | ||
cp | keyword | ||
conn-prof-id | [1..8000] | ||
port-id | slot/mda/port[.channel] | ||
bundle-id | bundle-<type>-slot/mda.<bundle-num> | ||
bundle | keyword | ||
type | ima|fr|ppp | ||
bundle-num | [1..336] | ||
bpgrp-id | bpgrp-<type>-<bpgrp-num> | ||
bpgrp | keyword | ||
type | ima|ppp | ||
bpgrp-num | [1..2000] | ||
aps-id | aps-<group-id>[.channel] | ||
aps | keyword | ||
group-id | [1..64] | ||
ccag-id | ccag-<id>.<path-id>[cc-type]:<cc-id> | ||
ccag | keyword | ||
id | [1..8] | ||
path-id | [a|b] | ||
cc-type | [.sap-net|.net-sap] | ||
cc-id | [0..4094] | ||
eth-tunnel | eth-tunnel-<id>[:<eth-tun-sap-id>] | ||
id | [1..1024] | ||
eth-tun-sap-id | [0..4094] | ||
lag-id | lag-<id> | ||
lag | keyword | ||
id | [1..800] | ||
pw-id | pw-<id> | ||
pw | keyword | ||
id | [1..10239] | ||
qtag1 | [0..4094] | ||
qtag2 | [*|0..4094] | ||
vpi | [0..4095] (NNI) | ||
[0..255] (UNI) | |||
vci | [1|2|5..65535] | ||
dlci | [16..1022] | ||
tunnel-id | tunnel-<id>.<private|public>:<tag> | ||
tunnel | keyword | ||
id | [1..16] | ||
tag | [0..4094] | ||
Output
authentication
Syntax
Context
Description
This command displays subscriber management RADIUS authentication policy information and statistics.
Parameters
Output
Table 89: Subscriber Authentication Field Descriptions
Label | Description |
Requests Received | Indicates the number of notify Change-of-Authorization requests received. |
Requests Accepted | Indicates the number of notify Change-of-Authorization requests accepted. |
Requests Rejected | Indicates the number of notify Change-of-Authorization requests rejected. |
Requests Dropped | Indicates the number of notify Change-of-Authorization requests dropped. |
No Auth Policy found | Indicates the number of notify Change-of-Authorization requests found. |
Invalid message | Indicates the number of notify Change-of-Authorization requests rejected because of decode errors. |
Out of resources | Indicates the number of notify Change-of-Authorization requests rejected due to lack of resources. |
Authentication Failure | Indicates the number of notify Change-of-Authorization requests which do not have NAS-Port-ID or Framed-IP-Address set or have mismatched subscriber-id. |
diameter-application-policy
Syntax
Context
Description
This command displays Diameter application policy information.
Parameters
Output
diameter-session
Syntax
Context
Description
This command displays diameter session information.
ccrt-replay
Syntax
Context
Description
This command displays information about diameter Gx sessions that are in Credit-Control-Request Session-Terminate-Request (CCR-T) replay mode.
Parameters
Output
explicit-subscriber-map
Syntax
Context
Description
This command displays explicit subscriber mappings.
Output
host-lockout-policy
Syntax
Context
Description
This command displays host lockout policy information.
Parameters
Output
The following is a sample output for the host-lockout-policy command.
igmp-policy
Syntax
Context
Description
This command displays IGMP policy information and only applies to the 7750 SR.
Parameters
Output
ipoe-session-policy
Syntax
Context
Description
This command displays IPoE session policy information.
Parameters
Output
local-user-db
Syntax
Context
Description
This command displays local user database information.
Output
msap-policy
Syntax
Context
Description
This command displays Managed SAP policy information.
Output
pcc-rule
Syntax
Context
Description
This command displays a list of pcc-rules and associated monitoring keys in the system.
Parameters
Output
radius-accounting-policy
Syntax
Context
Description
This command displays RADIUS accounting policy information.
Parameters
Output
Table 90: Subscriber RADIUS Accounting Policy Field Descriptions
Label | Description |
Tx Requests/TX Reqs | Displays the number of accounting requests transmitted for this policy. |
Rx Responses/Rx Resps | Displays the number of accounting responses received for this policy. |
Request Timeouts/Req Timeouts | Displays the number of accounting requests which have timed out for this policy. |
Send Retries | Displays the number of retries to a different server for a single accounting request for this policy. |
Send Failed Req Send Failed | Displays how many accounting requests failed because the packet could not be sent out for this policy. |
Radius Servers | Displays a table in which the statistics associated with this RADIUS accounting policy are broken down by individual RADIUS server. The table columns are: Index—displays the index number assigned to the RADIUS server. The index determines the sequence in which the servers are queried for authentication requests. Servers are queried in order from lowest to highest index. IP Address—the address of the RADIUS server. TX Reqs—see TX Requests in this table. Rx Resps—see RX Responses in this table. Req Timeouts—see Request Timeouts in this table. Req Send Failed—see Send Failed in this table. |
sla-profile
Syntax
Context
Description
This command displays SLA profile information.
Parameters
Output
sla-profile
Syntax
Context
Description
This command displays the subscriber’s SLA profile scheduler stats.
Parameters
Output
port
Syntax
Context
Description
This command displays the subscriber’s SLA profile scheduler stats.
Parameters
Output
vport
Syntax
Context
Description
This command displays the vport scheduler stats.
Parameters
Output
statistics
Syntax
Context
Description
This command displays enhanced subscriber management statistics per port/pw-port/MDA/IOM/system.
For each statistic, there is current value and peak value, peak value is the highest value since last reset via system boot or command clear subscriber-mgmt peakvalue-stats.
| Note:
The peak values can be reset via the clear subscriber-mgmt peakvalue-stats command. |
Parameters
The following tables describe the counters available in the show subscriber management statistics command output.
The following terminology is used to indicate applicability of the stats:
- ESM — Enhanced Subscriber Management. Subscriber traffic forwarded via subscriber queues. Enabled with SAP sub-sla-mgmt in no shutdown state.
- BSM — Basic Subscriber Management. Subscriber traffic forwarded via SAP queues. SAP sub-sla-mgmt must be in shutdown state. For DHCP, dhcp lease-populate or dhcp6-relay lease-populate must be enabled to count the leases. For IPv4, if anti-spoof is enabled on the SAP, a subscriber host is instantiated.
- Routed CO — IES or VPRN service with subscriber-interface and group-interface constructs.
- Bridged CO — VPLS service with DHCPv4 lease management enabled (lease-populate)
- regular interface — IES or VPRN interface (none subscriber-interface or group-interface)
- Host (also subscriber host) — A resource in the system that is used for traffic forwarding and security related actions. The creation of a subscriber host entry is linked to anti-spoof being enabled on a SAP. For ESM, anti-spoof is mandatory and hence every connected {IP/MAC} consumes by default a subscriber host entry. A DHCP6 IA-PD can also be modeled as a managed route. In this case, no subscriber host is instantiated. For BSM, anti-spoof is optional on regular interfaces. An IPv4 static-host and DHCPv4 lease do not result in a subscriber host instantiation when anti-spoof is disabled on the SAP.
Table 91: Host And Protocol Statistics
Section
Counter
Counts
Applies to
IPv4
1. PPP Hosts - IPCP
IPv4 local terminated PPP hosts (PTA, LNS)
ESM, Routed CO
2. IPOE Hosts - DHCP
DHCPv4 hosts (lease states)
ESM, Routed CO, Bridged CO
3. IPOE Hosts - ARP
ARP hosts
ESM, Routed CO, Bridged CO
4. IPOE Hosts – Static
IPv4 static hosts
ESM, Routed CO, Bridged CO
5. IPOE Hosts BSM - DHCP
DHCPv4 hosts (lease states: anti-spoof and lease-populate enabled)
BSM, Routed CO, Bridged CO, regular interface
6. IPOE Hosts BSM – Static
IPv4 static hosts (with anti-spoof enabled)
BSM, Routed CO, Bridged CO, regular interface
7. IPOE BSM - DHCP
DHCPv4 lease states (with lease-populate enabled, no anti-spoof)
BSM, Routed CO, Bridged CO, regular interface
8. IPOE BSM – Static
IPv4 static hosts (no anti-spoof)
BSM, Routed CO, Bridged CO, regular interface
IPv6
PPP Hosts – SLAAC
Local terminated IPv6 wan-host – SLAAC (PTA, LNS)
ESM, Routed CO
PPP Hosts - DHCP6 (PD)
Local terminated IPv6 pd-host (PTA, LNS) – DHCP6 IA-PD leases over PPP (excluding PD as managed route)
ESM, Routed CO
PPP Hosts - DHCP6 (NA)
Local terminated IPv6 wan-host (PTA, LNS) – DHCP6 IA-NA leases over PPP
ESM, Routed CO
PPP Mngd Rt - DHCP6 (PD)
IPv6 (PTA, LNS) – DHCP6 IA-PD leases over PPP (PD as managed route only)
ESM, Routed CO
IPOE Hosts – SLAAC
IPv6 wan-host – SLAAC
ESM, Routed CO
IPOE Hosts - DHCP6 (PD)
IPv6 pd-host – DHCP6 IA-PD leases (excluding PD as managed route)
ESM, Routed CO
IPOE Hosts - DHCP6 (NA)
IPv6 wan-host – DHCP6 IA-NA leases
ESM, Routed CO
IPOE Mngd Rt - DHCP6 (PD)
IPv6 – DHCP6 IA-PD leases (PD as managed route only)
ESM, Routed CO
IPOE Hosts – Static (PD)
IPv6 static hosts with prefix-length shorter than /128
ESM, Routed CO
IPOE Hosts – Static (WAN)
IPv6 static hosts with prefix-length equal to /128
ESM, Routed CO
IPOE BSM - DHCP6 (PD)
IPv6 – DHCP6 IA-PD leases (lease-populate)
BSM, regular interface
IPOE BSM - DHCP6 (NA)
IPv6 – DHCP6 IA-NA leases (lease-populate)
BSM, regular interface
Total
PPP Hosts
Local terminated PPP hosts (PTA, LNS)
Sum of counters 1, 9, 10 and 11
ESM
IPOE Hosts
Total IPv4 and IPv6 IPOE hosts.
Sum of counters 2, 3, 4, 5, 6, 13, 14, 15, 17 and 18
ESM
IPv4 Hosts
Total IPv4 hosts. PPP (PTA, LNS) and IPOE.
Sum of counters 1, 2, 3, 4, 5 and 6
ESM
IPv6 Hosts
Total IPv6 hosts. PPP (PTA, LNS) and IPOE.
Sum of counters 9, 10, 11, 13, 14, 15, 17 and 18
ESM
IPv6 PD Mngd Routes
Total DHCP6 IA-PD leases modeled as a managed route. PPP (PTA, LNS) and IPOE.
Sum of counters 12 and 16
ESM
L2TP LAC Hosts
L2TP LAC hosts – single host per single or dual stack PPP session.
Counter also increases for outgoing LTS sessions.
ESM, Routed CO
Internal Hosts
Subscriber hosts for internal use. For example: LNS redirect hosts (for LTS, an LNS redirect host is also instantiated).
ESM
Total (Cont)
Non-Sub-Traffic L2-Hosts
Host on a single subscriber SAP in a VPLS service that enables non-IP traffic to be forwarded using the specified SLA profile instance queues.
Host on a single subscriber SAP attached to an IES/VPRN group-interface that enables traffic normally forwarded via the SAP queues to flow via the specified SLA profile instance queues.
configure service vpls <service-id> sap <sap-id> sub-sla-mgmt single-sub-parameters non-sub-traffic sub-profile <sub-profile-name> sla-profile <sla-profile-name> [subscriber <sub-ident-string>] [app-profile <app-profile-name>]
ESM, Routed CO, Bridged CO
DHCP leases
Total number of DHCPv4 lease states.
Sum of counters 2, 5 and 7
ESM, BSM
DHCPv6 leases
Total number of DHCPv6 lease states.
Sum of counters 10, 11, 12, 14, 15, 16, 19 and 20
ESM, BSM
Subscriber Hosts
Counter displayed in the output of “show subscriber-mgmt statistics iom | mda | port | pw-port”
This counter matches the number of hosts accounted for in the per line card limit
Sum of counters 1, 2, 3, 4, 5, 6, 9, 10, 11, 13, 14, 15, 17, 18 and 26
ESM
Total (Cont)
System Hosts Scale
Counter displayed in the output of “show subscriber-mgmt statistics system”
This counter matches the number of hosts accounted for in the system wide limit
Sum of counters 1, 2, 3, 4, 5, 6, 9, 10, 11, 13, 14, 15, 17, 18, 26 and 27
ESM
Table 92: PPP Session Statistics
Section
Counter
Counts
Applies to
Local
PPP Sessions - PPPoE
Local terminated PPPoE sessions (PTA)
ESM, Routed CO
PPP Sessions - PPPoEoA
Local terminated PPPoEoA sessions (PTA)
ESM, Routed CO
.PPP Sessions - PPPoA
Local terminated PPPoA sessions (PTA)
ESM, Routed CO
PPP Sessions - L2TP (LNS)
Local terminated PPP sessions (L2TP LNS)
ESM, Routed CO
LAC
PPP Sessions - PPPoE
Tunneled PPPoE session (L2TP LAC)
ESM, Routed CO
PPP Sessions - PPPoEoA
Tunneled PPPoEoA session (L2TP LAC)
ESM, Routed CO
PPP Sessions - PPPoA
Tunneled PPPoA session (L2TP LAC)
ESM, Routed CO
PPP Sessions - L2TP (LTS)
Tunneled PPP session (L2TP LTS)
ESM, Routed CO
Total
PPP Sessions - established
PPP sessions that are established (at least one active host attached) – PTA/LAC/LTS/LNS
ESM, Routed CO
PPP Sessions - in setup
PPP sessions in setup (session created, host setup in progress) – PTA/LAC/LTS/LNS
ESM, Routed CO
Total (Cont)
PPP Sessions - local
Local terminated PPPoX sessions (PTA, L2TP LNS)
Sum of counters 33, 34, 35 and 36
ESM, Routed CO
PPP Sessions - LAC
Tunneled PPPoX session (L2TP LAC, L2TP LTS)
Sum of counters 37, 38, 39 and 40
ESM, Routed CO
L2TP
L2TP Tunnels - originator
Number of L2TP Tunnels originated on this node. (LAC/ LTS)
ESM, Routed CO
.L2TP Tunnels - receiver
Number of L2TP Tunnels terminated on this node. (LNS/LTS)
ESM, Routed CO
Total L2TP Tunnels
Number of L2TP Tunnels originated or terminated on this node
Sum of counters 45 and 46
ESM, Routed CO
Table 93: IPoE Session Statistics
Section | Counter | Counts | Applies to |
Total | IPOE Sessions - established | IPoE sessions that are established (at least one active host attached). | ESM, Routed CO |
IPOE Sessions- in setup | IPoE sessions in setup (session created, host setup in progress). | ESM, Routed CO |
Table 94: Subscriber Statistics
Section | Counter | Counts | Applies to |
Total | Subscribers | Total number of active subscribers. | ESM, Routed CO, Bridged CO |
Table 95: SubMgmt Statistics Summary
Section | Counter | Counts | |
Hosts | IPv4 | Total IPv4 hosts (counter 23 in tables above) | |
IPv6 | Total IPv6 hosts (counter 24 in tables above) | ||
Sessions | PPP | Total PPP sessions - established (counter 41 in tables above) | |
IPOE | Total IPOE sessions – established (counter 48 in tables above) | ||
Subscribers | Total number of active subscribers (counter 50 in tables above) | ||
Output
sub-ident-policy
Syntax
Context
Description
This command displays subscriber identification policy information.
Parameters
Output
sub-profile
Syntax
Context
Description
This command displays subscriber profile information.
Parameters
Output
pw-port
Syntax
Context
Description
Displays pseudo-wire port information.
If no optional parameters are specified, the command displays a summary of all defined PW ports. The optional parameters restrict output to only ports matching the specified properties.
Parameters
Output
Show PW-Port
The following table describes show pw-port output fields:
Table 96: Subscriber Show PW-Port Field Descriptions
Label | Description |
PW Port | The PW Port identifier. |
Encap | The encapsulation type of the PW Port. |
SDP | The SDP identifier. |
IfIndex | The interface index used for the PW Port. |
VC-Id | The Virtual Circuit identifier. |
Description | The description string for the PW Port. |
port-scheduler-policy
Syntax
Context
Description
This command displays scheduler policy information.
Output
sap-egress
Syntax
Context
Description
This command displays SAP egress policy information.
Parameters
Output
sap-ingress
Syntax
Context
Description
This command displays SAP ingress policy information.
Parameters
Output
scheduler-hierarchy
Syntax
Context
Description
This command enables the context to display information about policies that use this scheduler.
customer
Syntax
Context
Description
This command displays the scheduler hierarchy per customer multi-service-site.
Parameters
sap
Syntax
Context
Description
This command displays the scheduler stats per SAP.
Parameters
subscriber
Syntax
Context
Description
This command displays the scheduler hierarchy rooted at the SLA profile scheduler.
Parameters
| Note:
If the SLA profile scheduler is orphaned (that is when the scheduler has a parent which does not exist) then the hierarchy is only shown when the show command includes the sla-profile and sap parameters. |
Output
scheduler-name
Syntax
Context
Description
This command displays information about the specified scheduler name.
Parameters
scheduler-policy
Syntax
Context
Description
This command displays information about the specified scheduler policy.
Parameters
Output
scheduler-stats
Syntax
Context
Description
This command enables the context to display scheduler statistics information.
Output
shared-queue
Syntax
Context
Description
This command displays shared policy information.
Output
ancp-policy
Syntax
Context
Description
This command displays subscriber ANCP policy information.
Output
ancp-string
Syntax
Context
Description
This command displays subscriber ANCP string information.
Parameters
Output
Other applicable show command output:
radius-proxy-server
Syntax
Context
Description
This command displays RADIUS proxy server information.
Parameters
Output
Table 97: Subscriber RADIUS Proxy Server Field Descriptions
Label | Description |
Invalid response Authenticator Rx packet | Displays the number of packets received by this RADIUS proxy server. |
Rx Access-Request | Displays the number of Access-Request packets received by this RADIUS proxy server. |
Rx Accounting-Request | Displays the number of Accounting-Request packets received by this RADIUS proxy server. |
Rx dropped | Displays the number of packets received by this RADIUS proxy server but dropped. |
Retransmit | Displays the number of packets received by this RADIUS proxy server that were rejected because they are retransmitted. |
Wrong purpose | Displays the number of packets received by this RADIUS proxy server that were rejected because the value of tmnxRadProxSrvPurpose is set to a value not matching the type of packet. |
No UE MAC to cache | Displays the number of packets received by this RADIUS proxy server that were rejected because the UE MAC address was not present in the packet. |
Client context limit reached | Displays the number of packets received by this RADIUS proxy server that were rejected because the limit of client contexts was reached. For each RADIUS transaction a client context is created, and will be deleted once the transaction is finished. |
No ISA RADIUS policy configured | Displays the number of packets received by this RADIUS proxy server that were rejected because it has no ISA RADIUS server policy configured for that type of packet. |
Server admin down | Displays the number of packets received by this RADIUS proxy server that were rejected because it is administratively shut down. |
No RADIUS policy configured | Displays the number of packets received by this RADIUS proxy server that were rejected because it has no RADIUS server policy configured for that type of packet. |
No load-balance-key configured | Displays the number of packets received by this RADIUS proxy server that were rejected because the selected RADIUS server policy's algorithm is set to hashBased and no load balance key is configured. |
Invalid length | Displays the number of packets received by this RADIUS proxy server that were rejected because their length was invalid. |
Invalid Code field | Displays the number of packets received by this RADIUS proxy server that were rejected because they had an invalid Code field. |
Invalid attribute encoding | Displays the number of packets received by this RADIUS proxy server that were rejected because one of the attributes was incorrectly encoded. |
Invalid User-Name | Displays the number of packets received by this RADIUS proxy server that were rejected because they contained an invalid User-Name attribute. |
Invalid password | Displays the number of packets received by this RADIUS proxy server that were rejected because the User-Password attribute could not be decoded. |
Invalid accounting Authenticator | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained an invalid Authenticator field. |
Invalid Message-Authenticator | Displays the number of packets received by this RADIUS proxy server that were rejected because they contained an invalid Message-Authenticator attribute. |
Management core overload | Displays the number of packets that were rejected by this RADIUS server because the ISA management core is not able to process any new RADIUS requests because of overload. |
No memory | Displays the number of packets that were rejected by this RADIUS server because there was not enough memory to store them. |
Accounting-Request with invalid Acct-Status-Type | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained an invalid Acct-Status-Type attribute. |
Accounting-Request with no Acct-Status-Type | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained no Acct-Status-Type attribute. |
Registered user overload | Displays the number of packets that were rejected by this RADIUS server because the registered user indicated to be in overload. |
Dropped by Python | Displays the number of packets received by this RADIUS proxy server but dropped by Python. |
Tx Access-Accept | Displays the number of Access-Accept packets transmitted by this RADIUS proxy server. |
Tx Access-Reject | Displays the number of Access-Reject packets transmitted by this RADIUS proxy server. |
Tx Access-Challenge | Displays the number of Access-Challenge packets transmitted by this RADIUS proxy server. |
Tx Accounting-Response | Displays the number of Accounting-Response packets transmitted by this RADIUS proxy server. |
Tx dropped | Displays the number of packets dropped by this RADIUS proxy server before transmission. |
No key to cache | Displays the number of packets that could not be cached by this RADIUS proxy server because the key information was not present in the packet. |
Cache key too long | Displays the number of packets that could not be cached by this RADIUS proxy server because the key information present in the packet was too long. |
Cache attributes too long | Displays the number of packets that could not be cached by this RADIUS proxy server because the total length of the attributes is too long. |
Reached maximum number of cache entries | Displays the number of packets that could not be cached by this RADIUS proxy server because the limit has been reached. |
No memory | Displays the number of packets that could not be transmitted by this RADIUS proxy server because there was not enough memory. |
Server timeout | Displays the number of packets that were dropped because the RADIUS servers have timed out. |
Server authentication failure | Displays the number of packets that were dropped because the RADIUS server replied with a packet which failed authentication (invalid response Authenticator or Message Authenticator attribute). |
Server invalid Code | Displays the number of packets that were dropped because the RADIUS server replied with a packet with an invalid Code field. |
Invalid attribute encoding | Displays the number of packets that were dropped because the RADIUS server replied with a packet with an invalid attribute. |
Registered user overload | Displays the number of packets that were dropped because the registered user indicated to be in overload. |
No RADIUS server configured | Displays the number of packets that were dropped by this RADIUS server because the RADIUS server policy has no servers configured. |
RADIUS server send failure | Displays the number of packets that were dropped by this RADIUS server because the packet could not get transmitted to one of the servers in the RADIUS server policy. |
Dropped by Python | Displays the number of packets that were dropped by this RADIUS server because the packet was dropped by the Python script. |
Invalid response Authenticator | Displays the number of packets that were dropped because the RADIUS server replied with a packet which failed authentication |
wpp
Syntax
Context
Description
This command displays WPP port-related information in the specified routing instance.
Parameters
Output
ipoe session
Syntax
Context
Description
This command displays the identified IPoE session details active on the specified service instance.
Parameters
Output
managed-hosts
Syntax
Context
Description
This command displays information about hosts that are not yet linked to an in-band control plane protocol, such as DHCP or DHCPv6. Examples include hosts installed by data-triggers and hosts installed by RADIUS.
Parameters
Output
The following output is an example of managed host information.
Clear Commands
ancp-sub-string
Syntax
Context
Description
This command clears subscriber ANCP data.
Parameters
arp
Syntax
Context
Description
This command clears all or specific ARP entries.
The scope of ARP cache entries cleared depends on the command line option(s) specified.
Parameters
authentication
Syntax
Context
Description
This command clears subscriber authentication data.
Parameters
diameter-session
Syntax
Context
Description
This command clears diameter session data.
ccrt-replay
Syntax
Context
Description
This command clears diameter Gx sessions that are in CCR Terminate replay mode.
Parameters
idle-only-msap
Syntax
Context
Description
This command removes all idle MSAPs associated with the MSAP policy.This command only removes idle MSAPs without active subscribers. This command is considered safer than the clear>subscr-mgmt>msap-policy msap-policy-name idle-only command because in that command, the parameter idle-only is optional. Not specifying idle-only will delete MSAPs with active subscribers.
Parameters
msap-policy
Syntax
Context
Description
This command deletes Managed SAPs (MSAPs) created by the MSAP policy.
This command can remove an MSAP with active subscribers still associated with the MSAP. Use the idle-only parameter to remove only MSAPs in an idle state.
Parameters
peakvalue-stats
Syntax
Context
Description
This command resets the most recent peak counter.
| Note:
Clearing one counter will not impact other counters. For example, clearing one IOM’s most recent peak value will not impact chassis peak value. |
Parameters
radius-accounting
Syntax
Context
Description
This command clears RADIUS accounting data for the specified policy.
Parameters
scheduler-stats
Syntax
Context
Description
This command clears scheduler statistics.
subscriber
Syntax
Context
Description
This command clears scheduler stats per subscriber.
Parameters
sla-profile
Syntax
Context
Description
This command clears the subscriber’s SLA profile scheduler stats.
Parameters
srrp
Syntax
Context
Description
This command enables the context to clear and reset SRRP virtual router instances.
interface
Syntax
Context
Description
This command clears and resets SRRP interface instances.
Parameters
statistics
Syntax
Context
Description
This command clears statistics for SRRP instances.
Parameters
route-downloader
Syntax
Context
Description
This command clears all the radius-downloaded routes from the internal downloader cache (or protocol RIB/db) (and thus eventually from the RTM itself). The parameters vprn and/or family allow to restrict the deletion of those routes learned in a particular address family (IPv4 or IPv6) and/or a particular VPRN.
By default, all VPRNs and both IPv4 and IPv6 families are affected.
| Note:
A clear of the internal protocol DB means the corresponding prefix that were deleted should be removed from the RTM (and from any other exports) as well. |
Parameters
vport
Syntax
Context
Description
This command clears the vport scheduler stats.
Parameters
ipoe session
Syntax
Context
Description
This commands clears all identified IPoE sessions for the specified service instance. All associated subscriber hosts will be deleted from the system.
Parameters
Tools Commands
tools
Syntax
Context
Description
The context to enable useful tools for debugging purposes.
Default
none
Parameters
avp-match-learned-session-id
Syntax
Context
Description
This command displays the diameter session IDs that are learned by the AVP value matching in a diameter debug.
Per avp-match id in a diameter peer policy, a single diameter session ID can be learned. "N/A" means no session ID is learned.
Output
The following is a sample output for the avp-match-learned-session-id command.
perform
Syntax
Context
Description
This command enables the context to enable tools to perform specific tasks.
Default
none
credit-reset
Syntax
Context
Description
This command resets the credit for an SLA-profile instance.
Parameters
persistence
Syntax
Context
Description
This command enables the context to configure downgrade parameters.
downgrade
Syntax
Context
Description
This command downgrades persistence files to a previous version.
Parameters
eval-msap
Syntax
Context
Description
This command re-applies the managed SAP policy to the managed SAP identified by the specified sap-id or to all managed SAPs associated with the specified msap-policy name.
Parameters
eval-lease-state
Syntax
Context
Description
This command evaluates lease state.
Parameters
subscriber-mgmt
Syntax
Context
Description
This command enables tools to control subscriber management.
edit-lease-state
Syntax
Context
Description
This command provides the parameters to edit lease state information.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
credit-reset
Syntax
Context
Description
This command resets the credit for an SLA-profile instance.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
edit-ppp-session
Syntax
Context
Description
This command updates the data of the PPP session identified with the given MAC address and SAP identifier. Optionally the remote-id and circuit-id can be specified to identify the IPoE session to update.
| Note:
The changes take immediate effect. |
edit-slaac-host
Syntax
Context
Description
This command updates the data of the SLAAC host information
edit-ipoe-session
Syntax
Context
Description
This command updates the data of the IPoE session identified with the given MAC address and SAP identifier. Optionally the remote-id and circuit-id can be specified to identify the IPoE session to update.
| Note:
The changes take immediate effect. |
eval-ipoe-session
Syntax
Context
Description
This command re-evaluates the mapping between authentication strings such as the SLA profile string and the actual profiles for the identified IPoE sessions.
eval-ppp-session
Syntax
Context
Description
This command evaluates PPP sessions.
eval-slaac-host
Syntax
Context
Description
This command evaluates the SLAAC host.
remap-lease-state
Syntax
Context
Description
This command allows the remapping of all existing hosts if network card on CMTS/WAC side is changed is required. This command only applies to the 7750 SR.
When this command is executed, the following restrictions apply:
- When sap is taken, all leases associated with the SAP are re-written.
- For a SAP with a configured MAC in "lease-populate" command, this MAC will be taken.
- For a SAP without a configured MAC the MAC from tools command will be taken.
- For a SAP without a configured MAC and no MAC in tools command no action will be perform.
- When using the old-mac option, providing a new MAC ieee-address is mandatory.
This command is applicable only when dealing with DHCP lease states which were instantiated using l2header mode of DHCP operation.
Parameters
When configured, the SAP parameter will remap all MAC addresses of DHCP lease states on the specified SAP. When no optional MAC parameter is specified, the sap sap-id command remaps all MAC addresses of lease states towards the MAC address specified in the l2-header configuration.
re-ident-sub
Syntax
Context
Description
This command renames a subscriber identification string.
Parameters
redundancy
Syntax
Context
Description
This command enables the context to dump redundancy parameters.
multi-chassis
Syntax
Context
Description
This command enables the context to dump multi-chassis parameters.
mc-endpoint
Syntax
Context
Description
This command dumps multi-chassis endpoint information.
Parameters
force-switchover
Syntax
Context
Description
This command manually switches over mc-ipsec mastership of the specified tunnel-group.
Parameters
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring information.
Parameters
srrp-sync-database
Syntax
Context
Description
This command dumps SRRP database information and only applies to the 7450 ESS and 7750 SR.
Parameters
sync-database
Syntax
Context
Description
This command dumps MCS database information.
Parameters
dhcp-server: | local dhcp server (7450 ESS and 7750 SR only) |
igmp: | Internet group management protocol |
igmp-snooping: | igmp-snooping |
mc-ring: | multi-chassis ring |
mld-snooping: | multicast listener discovery-snooping |
srrp: | simple router redundancy protocol (7450 ESS and 7750 SR only) |
sub-host-trk: | subscriber host tracking (7450 ESS and 7750 SR only) |
sub-mgmt: | subscriber management (7450 ESS and 7750 SR only) |
mc-ipsec
Syntax
Context
Description
This command enters the mc-ipsec context.
mc-endpoint
Syntax
Context
Description
This command dumps multi-chassis endpoint information.
Parameters
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring information.
Parameters
srrp-sync-database
Syntax
Context
Description
This command dumps SRRP database information and only applies to the 7450 ESS and 7750 SR.
Parameters
sync-database
Syntax
Context
Description
This command dumps MCS database information.
Parameters
dhcp-server: | local dhcp server (7450 ESS and 7750 SR only) |
igmp: | Internet group management protocol |
igmp-snooping: | igmp-snooping |
mc-ring: | multi-chassis ring |
mld-snooping: | multicast listener discovery-snooping |
srrp: | simple router redundancy protocol (7450 ESS and 7750 SR only) |
sub-host-trk: | subscriber host tracking (7450 ESS and 7750 SR only) |
sub-mgmt: | subscriber management (7450 ESS and 7750 SR only) |
forcerenew
Syntax
Context
Description
This command forces the renewal of lease state and only applies to the 7450 ESS and 7750 SR
Parameters
local-user-db
Syntax
Context
Description
This command provides tools to control the local user database.
ipoe
Syntax
Context
Description
This command provides the tools to control IPoE entries in the local user database.
host-lookup
Syntax
Context
Description
This command performs a lookup in the local user database.
ppp
Syntax
Context
Description
This command provides the tools to control PPPoE entries in the local user database.
authentication
Syntax
Context
Description
This command authenticates the PPPoE user name.
host-lookup
Syntax
Context
Description
This command performs a lookup in the local user database.
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring data.
sync-database
Syntax
Context
Description
This command dumps multi-chassis sync database information.
Parameters
sync-database-reconcile
Syntax
Context
Description
This command provides the paramwters to reconcile MCS database entries.
srrp-sync-data
Syntax
Context
Description
This command dumps multi-chassis SRRP sync database information.
Parameters
route-downloader
Syntax
Context
Description
This command causes the download process to start immediately. If an ongoing download is already in progress then no further action is needed, except if the force keyword is added. In case the force keyword is added, then the current download is aborted and a new one is immediately restarted. If aborting the current download, the internal route table should not be emptied or cleared.
Parameters
router
Syntax
Context
Description
This command enables the context for tools dump commands in the specified routing instance.
Parameters
ipoe-session
Syntax
Context
Description
This command enables the context for IPoE session-related tools dump commands in the specified routing instance.
migration
Syntax
Context
Description
This command displays details on the IPoE session migration progress. It shows per group interface the number of hosts per type (DHCPv4, DHCPv6 and SLAAC) that are associated with an IPoE session or that are not associated with an IPoE session.
Output
The following is a sample output for the migration command.
Debug Commands
diameter
Syntax
Context
Description
This command enables debugging for diameter.
dest-realm
Syntax
Context
Description
This command restricts the output to a specific destination-realm.
Parameters
detail-level
Syntax
Context
Description
This command configures the detail level of debug output.
Parameters
diameter-peer
Syntax
Context
Description
This command restricts output to a specific peer.
Parameters
diameter-peer-policy
Syntax
Context
Description
This command restricts the debug output to messages on peers of a specific diameter peer policy. Up to eight diameter peer policies can be specified.
The no form of the command removes the specified diameter peer policy and all debug statement under this policy from the debug configuration.
Parameters
avp-match
Syntax
Context
Description
This command restricts the debug output to messages within the diameter peer policy that belong to a diameter session identified based on the AVP value matching in a diameter application message.At least the message type and one AVP match criteria must be specified in an avp-match id command.
If a diameter application message matches all criteria within one AVP match ID, then the session ID is learned and all subsequent messages of that diameter session are shown until a relearning occurs. (OR function between avp-match id commands.)
When the session ID is learned in an Answer message, an attempt is made to include the corresponding Request message in the debug output: The Request message should still be available in the system and must pass all debug filters (such as message-type).
By default an avp-match id is disabled and must be configured with the debug>diameter>diameter-peer-policy>avp-match no shutdown to activate.
Parameters
avp
Syntax
Context
Description
This command specifies an AVP match criteria for AVP value matching. At least one and up to five AVP match criteria can be specified in an avp-match id command. When multiple AVP match criteria are specified, they must all match to be successful and result in a diameter session ID learning. (AND function between avp avp-id commands.)
The AVP in an AVP match criteria is identified by its AVP ID. The AVP ID is specified as [vendor-id-]avp-code[.avp-id] with nesting up to five levels deep.
The format type of the AVP should match the standard documents in which the AVP is specified. Any AVP can be specified as an octet string in hex format.
Parameters
message-type
Syntax
Context
Description
This command specifies the message type match criteria for AVP value matching. Only specified diameter application messages are used for AVP value matching. This is a mandatory criteria in an avp-match id command.This command does not restrict the debug output to the specified messages.
Parameters
shutdown
Syntax
Context
Description
Enables or disables the avp-match id criteria for filtering debug output based on AVP value matching.A shutdown of the avp-match id will clear the learned diameter session ID.
diameter-peer
Syntax
Context
Description
This command restricts the debug output to messages on a specific peer within the diameter peer policy. Overrides the debug>diameter>diameter-peer debug command for the specified diameter peer policy. A single peer can be specified per diameter peer policy.
When no peer is specified at the diameter peer policy level, the debug output is restricted to the peer configured at the debug>diameter level.
The no form of the command removes the peer from the debug>diameter>diameter-peer-policy debug output.
Parameters
message-type
Syntax
Context
Description
This command restricts the debug output to the specified message types.
When specified within a diameter peer policy, it overrides the message type configuration at the debug>diameter level for messages received and sent on that diameter peer policy.
The no form of the command removes the message type from the debug configuration.
Parameters
origin-realm
Syntax
Context
Description
This command restricts output to a specific origin-realm.
arp-host
Syntax
Context
Description
This command enables and configures ARP host debugging.
The no form of the command disables ARP host debugging.
one-time-http-redirection
Syntax
Context
Description
This command produces one-time http redirection debug output.
ppp
Syntax
Context
Description
This command enables the PPP debug context.
event
event
Syntax
Context
Description
This command enables the PPP event debug context.
dhcp-client
Syntax
Context
Description
This command enable PPP event debug for DHCP client.
Parameters
l2tp
Syntax
Context
Description
This command enables PPP L2TP event debug.
Parameters
local-address-assignment
Syntax
Context
Description
This command enables debugging for local-address-assignment events.
The no form of the command disables debugging.
Parameters
ppp
Syntax
Context
Description
This command enables PPP event debug.
The no form of the command disables debugging.
Parameters
mac
Syntax
Context
Description
This command displays PPP packets for a particular MAC address.
The no form of the command disables debugging.
msap
Syntax
Context
Description
This command enables debugging for specific PPP MSAPs.
The no form of the command disables debugging.
packet
Syntax
Context
Description
This command enables the PPP packet debug context.
The no form of the command disables debugging.
detail-level
Syntax
Context
Description
This command specify the detail level of PPP packet debug output.
The no form of the command disables debugging.
dhcp-client
Syntax
Context
Description
This command enables packet debug output for DHCP client of the PPP session
The no form of the command disables debugging.
discovery
Syntax
Context
Description
This command enables PPP discovery packet debug output.
The no form of the command disables debugging.
Parameters
mode
Syntax
Context
Description
This command specifies PPP packet debug mode.
The no form of the command disables debugging.
Parameters
ppp
Syntax
Context
Description
This command enables PPP discovery packet debug output for the specified PPP protocol.
The no form of the command disables debugging.
Parameters
remote-id
Syntax
Context
Description
This command enables debugging for specific PPP remote-ids.
The no form of the command disables debugging.
sap
Syntax
Context
Description
This command enables PPP debug output for the specified SAP, this command allow multiple instances.
The no form of the command disables debugging.
Parameters
username
Syntax
Context
Description
This command enable PPP debug for the specified username. since not all PPP packets contain username, so a mac debug filter will be created automatically when system sees a PPP packet contain the specified username.
Multiple username filters can be specified in the same debug command.
The no form of the command disables debugging.
Parameters
circuit-id
Syntax
Context
Description
This command enable PPP debug for the specified circuit-id.
Multiple circuit-id filters can be specified in the same debug command.
The no form of the command disables debugging.
Parameters
remote-id
Syntax
Context
Description
This command enable PPP debug for the specified remote-id.
Multiple remote-id filters could be specified in the same debug command.
Parameters
msap
Syntax
Context
Description
This command enable PPP debug for the specified managed SAP.
Multiple msap filters could be specified in the same debug command.
Parameters
authentication
Syntax
Context
Description
This command debugs subscriber authentication.
Parameters
sub-ident-policy
Syntax
Context
Description
This command debugs subscriber identification policies.
Parameters
script-compile-error
Syntax
Context
Description
This command send the traceback of the compile error to the logger. The traceback contains detailed information about where and why the compilation fails. The compilation takes place when the CLI user changes the admin state of the Python URL from shutdown to no-shutdown.
script-export-variables
Syntax
Context
Description
This command sends the result (the three output variables) of the Python script to the logger when the script ran successfully.
script-output
Syntax
Context
Description
This command sends the output (such as from 'print' statements) of the Python script to the logger.
script-output-on-error
Syntax
Context
Description
This command sends the output (such as from 'print' statements) of the Python script to the logger, but only when the script fails.
script-runtime-error
Syntax
Context
Description
This command sends the traceback of the Python script failure to the logger.
script-all-info
Syntax
Context
Description
This command enables the script-compile-error, script-export-variables, script-output, script-output-on-error, and script-runtime-error functionalities.
srrp
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
events
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
packets
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
radius
Syntax
Context
Description
This command enables the debug router RADIUS context.
detail-level
Syntax
Context
Description
This command specifies the output detail level of command debug router radius.
Default
medium
Parameters
packet-type
Syntax
Context
Description
This command specifies the RADIUS packet type filter of command debug router radius
Default
authentication accounting coa
Parameters
radius-attr
Syntax
Context
Description
This command specifies the RADIUS attribute filter of command debug router radius.
Default
none
Parameters
address | <ipv4-address>|<ipv6-address>| <ipv6-prefix/prefix-length> | |
ipv4-address | a.b.c.d | |
ipv6-address | x:x:x:x:x:x:x:x (eight 16-bit pieces) | |
ipv6-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) | |
x:x:x:x:x:x:d.d.d.d | ||
x - [0..FFFF]H | ||
d - [0..255]D | ||
ipv6-prefix-length [0..128] | ||
hex | [0x0..0xFFFFFFFF...(max 506 hex nibbles)] | |
integer | [0..4294967295] | |
string | ascii-string (max 253 chars) | |
wpp
Syntax
Context
Description
This command enables the context to configure WPP debugging parameters.
packet
Syntax
Context
Description
This command enables WPP packet debugging.
detail-level
Syntax
Context
Description
This command specifies the detail level of WPP packet debugging.
Parameters
portal
Syntax
Context
Description
This command enables WPP debugging for the specified WPP portal.
Parameters
Monitor Commands
subscriber
Syntax
Context
Description
This command monitors statistics for a subscriber.
Parameters
Output
host
Syntax
Context
Description
This command displays static host information configured on this service.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
Default
14400 seconds
Parameters
lease-populate
Syntax
Context
Description
This command enables dynamic host lease state management for SAPs.
For VPLS, DHCP snooping must be explicitly enabled (using the snoop command) at all points where DHCP messages requiring snooping enter the VPLS instance (both from the DHCP server and from the subscribers). Lease state information is extracted from snooped DHCP ACK messages to populate lease state table entries for the MSAP.
The optional number-of-entries parameter is used to define the number lease state table entries allowed for an MSAP or IP interface. If number-of-entries is omitted, only a single entry is allowed. Once the maximum number of entries has been reached, subsequent lease state entries are not allowed and subsequent DHCP ACK messages are discarded.
The retained lease state information representing dynamic hosts may be used to:
- Populate an MSAP based anti-spoof filter table to provide dynamic anti-spoof filtering. If the system is unable to populate the dynamic host information in the anti-spoof filter table on the SAP, the DHCP ACK message must be discarded without adding new lease state entry or updating an existing lease state entry.
- Generate dynamic ARP replies if arp-reply-agent is enabled.
The no form of the command disables dynamic host lease state management for the MSAP.
Default
no lease-populate
delayed-enable
Syntax
Context
Description
This command delays making interface operational by the specified number of seconds.
In environments with many subscribers, it can take time to synchronize the subscriber state between peers when the subscriber-interface is enabled (perhaps, after a reboot). To ensure that the state has time to be synchronized, the delayed-enable timer can be specified. The optional parameter init-only can be added to use this timer only after a reboot.
Default
no delayed-enable
Parameters
export-host-routes
Syntax
Context
Description
This command controls the export of subscriber management host routes from a retail service to the corresponding forwarding wholesale VPRN service.
By default, subscriber management host routes are not exported.
The presence of retail subscriber management host routes in the wholesale VPRN service is required for downstream traffic forwarding in multi-chassis redundancy scenario’s with a redundant interface and when the retail subscriber subnets are not leaked in the wholesale VPRN service (allow-unmatching-subnets or unnumbered retail subscriber interface).
This command will fail if the subscriber interface is not associated with a forwarding wholesale service subscriber interface or if the subscriber interface is not configured to support address allocation outside the provisioned subnets (allow-unmatching-subnets or unnumbered subscriber interface)
Default
no export-host-routes
group-interface
Syntax
Context
Description
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.
Use the no form of the command to remove the group interface from the subscriber interface.
Default
no group interfaces configured
Parameters
data-trigger
Syntax
Context
Description
This command enabled the context to configure data-triggered subscriber management entities.
ingress
Syntax
Context
Description
This command configures ingress network filter policies for the interface.
policy-accounting
Syntax
Context
Description
This command enables/disables the specified policy accounting template.
ip-mtu
Syntax
Context
Description
This command specifies the maximum size of ip packets on this group-interface. Packets larger than this will get fragmented.
The ip-mtu applies to all IPoE host types (dhcp, arp, static). For PPP/L2TP sessions, the ip-mtu is not taken into account for the mtu negotiation; the ppp-mtu in the ppp-policy should be used instead.
Default
none
Parameters
enable-ingress-stats
Syntax
Context
Description
This command enables the collection of ingress interface IP stats. This command is only appliable to IP statistics, and not to uRPF statistics.
If enabled, then the following statistics are collected:
- IPv4 offered packets
- IPv4 offered octets
- IPv6 offered packets
- IPv6 offered octets
| Note:
Octet statistics for IPv4 and IPv6 bytes at IP interfaces include the layer 2 frame overhead. |
Default
no enable-ingress-stats
host-connectivity-verify
Syntax
Context
Description
This command enables subscriber host connectivity verification on a given SAP within a service. This tool will periodically scan all known hosts (from dhcp-state) and perform UC ARP requests. The subscriber host connectivity verification will maintain state (connected vs. not-connected) for all hosts.
Default
no host-connectivity-verify
Parameters
ipoe-linking
Syntax
Context
Description
This command enables the context to configure IPoE host linking.
gratuitous-rtr-adv
Syntax
Context
Description
If enabled, this command controls generation of unsolicited Router-advertisement on creation of v4 host.
The no form of the command disables gratuitous-rtr-adv.
Default
gratuitous-rtr-adv
ipoe-session
Syntax
Context
Description
This command enables the context to configure IPoE session parameters.
shared-circuit-id
Syntax
Context
Description
If configured, circuit-id in DHCPv4 option-82 is used to authenticate DHCPv6. If DHCPv6 is received before DHCPv4, it is dropped. Also, a SLAAC host is created based on DHCPv4 authentication if RADIUS returns IPv6 framed-prefix. IPv6oE host is deleted if the linked IPv4oE host is deleted due to DHCP release or lease time-out. The linkage between IPv4 and IPv6 is based on SAP and MAC address. The sharing of circuit-id from DHCPv4 for authentication of DHCPv6 (or SLAAC) allows 7750 SR to work around lack of support for LDRA on Access-nodes.
The no form of the command disables the feature.
Default
no shared-circuit-id
ipv6
Syntax
Context
Description
This command enables the context to configure IPv6 for an IES interface.
urpf-check
Syntax
Context
Description
This command enables unicast RPF (uRPF) Check on this interface.
The no form of the command disables unicast RPF (uRPF) Check on this interface.
Default
disabled
mode
Syntax
Context
Description
This command specifies the mode of unicast RPF check.
The no form of the command reverts to the default (strict) mode.
Default
strict
Parameters
match-circuit-id
Syntax
Context
Description
This command enables Option 82 circuit ID on relayed DHCP packet matching. For routed CO, the group interface DHCP relay process is stateful. When packets are relayed to the server the virtual router ID, transaction ID, SAP ID, and client hardware MAC address of the relayed packet are tracked.
When a response is received from the server the virtual router ID, transaction ID, and client hardware MAC address must be matched to determine the SAP on which to send the packet out. In some cases, the virtual router ID, transaction ID, and client hardware MAC address are not guaranteed to be unique.
When the match-circuit-id command is enabled this as part of the key is used to guarantee correctness in our lookup. This is really only needed when dealing with an IP aware DSLAM that proxies the client hardware MAC address.
Default
no match-circuit-id
mac
Syntax
Context
Description
This command assigns a specific MAC address to a subscriber group interface.
The no form of the command returns the MAC address of the group interface to the default value.
Default
The physical MAC address associated with the Ethernet interface that the SAP is configured on (the default MAC address assigned to the interface, assigned by the system).
Parameters
oper-up-while-empty
Syntax
Context
Description
This command allows the subscriber interface to treat this group interface to be operationally enabled without any active SAPs.
This command is typically used with MSAPs where advertising the subnet prior to having a MSAP dynamically created is needed.
policy-control
Syntax
Context
Description
This command configures a policy-control policy for the interface.
Parameters
mode
Syntax
Context
Description
This command configures the ATM MDA into a mode with the increased VC scale (16k VCs, as opposed to 8K VCs). ESM is supported only in 16K VCs mode. In 16K VCs mode, there is only one queue allocated to each VC in the ATM MDA. In 8K VCs mode, there are two queues allocated per VC.
The 16K VC mode is supported only on the 4 port oc-3/12c/STM-1/4c and the 16 port ATM oc-3/STM-1 ATM MDA.
Changing the ATM MDA mode requires a reset of the MDA. A warning is issued asking for the confirmation before the command is executed.
Default
max8k-vc.
Parameters
agg-rate
Syntax
Context
Description
This command is used to control an HQoS aggregate rate limit. It is used in conjunction with the following parameter commands: rate, limit-unused-bandwidth, and queue-frame-based-accounting.
When specified under a VPORT, the agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
rate
Syntax
Context
Description
This command defines the enforced aggregate rate for all queues associated with the agg-rate context. A rate must be specified for the agg-rate context to be considered to be active on the context’s object (SAP, subscriber, VPORT etc.).
Parameters
limit-unused-bandwidth
Syntax
Context
Description
This command is used to enable (or disable) aggregate rate overrun protection on the agg-rate context.
queue-frame-based-accounting
Syntax
Context
Description
This command is used to enabled (or disable) frame based accounting on all queues associated with the agg-rate context. Only supported on Ethernet ports. Not supported on HSMDA Ethernet ports.
vpi
Syntax
Context
Description
This command enables the ATM VP shaper under the ATM port. The type of ATM shaper are CBR or rt/nrt-VBR as defined by the traffic descriptor. It cannot be a UBR service-type.
All VCs within the shaper will degrade into a UBR type service class. For example, when a CBR type VC is associated with the shaper, it will degrade into a UBR type VC. Scheduling traffic amongst VCs within the shaper is based on WRR using the weight parameter.
If the VP shaper is deleted, the VCs that were under it is restored to their original service category.
The VP shaper is statically configured and instantiated upon configuration.
A VP shaper can be seamlessly added to or removed from the active VCs in the system.
Default
none
Parameters
traffic-desc
Syntax
Context
Description
This command references traffic-descriptor id for VPs and VCs.
The VP shaper cannot be of service-type UBR.
Default
Default traffic descriptor (id=1) of UBR type.
Parameters
weight
Syntax
Context
Description
VCs within the VP tunnel are serviced by a single scheduler assigned to each VP tunnel. VCs within the shaped VP tunnel will be degraded from the originally assigned service category to a common UBR service category (default traffic descriptor). Scheduling between VCs will be based on WRR with a weight parameter that can be explicitly configured in the ATM traffic descriptor profile. If weight is not specifically configured, the defaults are taken.
The explicitly configured weight parameter is honored only on the ATM MDA in the max16k-vc mode. On all other ATM capable MDAs (ASAP or ATM MDA in max8k-vc mode), the weight parameter is ignored.
Default
VC degraded from CBR = weight 10
VC degraded from rt-VBR = weight 7
VC degraded from nrt-VBR = weight 5
VC degraded from UBR+ = weight 2
VC degraded from UBR = weight 1
Parameters
encapsulation
Syntax
Context
Description
This command is a SAP level command and it will either statically set or enable dynamic detection of the encapsulation.
Default
snap-bridged
Parameters
| Note:
On ATM frames with Ethernet FCS or without FCS are accepted but only frames with no Ethernet FCS are sent. |
def-inter-dest-id
Syntax
Context
Description
This command is used to associate the vport with the subscriber. The association method will depend on the configured option.
Default
Disabled
Parameters
Alternatively, the destination string can be defined in LUDB.
Control Plane will be aware of the VPI during the session initiation phase. This VPI will be used to make the association between the host and the vport with the same name (VPI number).
| Note:
In this case the vport name under the configure>port>sonet-sdh>path>access>egress context must be the VPI number. |
pppoe-user-db
Syntax
Context
Description
This command will enable LUDB authentication on capture SAPs for PPPoE(oA) clients. In case that this command is configured along with the authentication-policy command (RADIUS authentication), then the authentication-policy command will take precedence.
Optionally, with a separate command (ppp-user-db) PPPoA clients can be authenticated under a separate LUDB.
Default
Disabled
Parameters
ppp-user-db
Syntax
Context
Description
This command will enable LUDB authentication on capture SAPs for PPPoA clients. In case that this command is configured along with the authentication-policy command (RADIUS authentication), then the authentication-policy command will take precedence.
Optionally, with a separate command (pppoe-user-db) PPPoE(oA) clients can be authenticated under a separate LUDB.
Default
Disabled
Parameters
ppp-policy
Syntax
Context
Description
This command will reference a ppp-policy that will define session parameters (ppp-mtu, authentication options, etc.) during the session initiation phase. Normally, ppp-policy is referenced under the group-interface hierarchy. But with capture SAP is it not known at the session initiation phase to which group-interface the session belongs. This is why, with the capture SAP, the ppp-policy must be referenced directly under the capture SAP. The ppp-policy referenced under the group-interface must be the same as the ppp-policy referenced under the capture SAP. Otherwise the session will not come up.
Default
Disabled
Parameters
pppoe-policy
Syntax
Context
Description
This command will reference a pppoe-policy that will define session parameters (ppp-mtu, authentication options, etc.) during the session initiation phase. Normally, pppoe-policy is referenced under the group-interface hierarchy. But with capture SAP is it not known at the session initiation phase to which group-interface the session belongs. This is why, with the capture SAP, the ppp-policy must be referenced directly under the capture SAP. The pppoe-policy referenced under the group-interface must be the same as the pppoe-policy referenced under the capture SAP. Otherwise the session will not come up.
Default
Disabled
Parameters
rtr-solicit-user-db
Syntax
Context
Description
This command enabled access to LUDB for SLAAC hosts under the capture SAP. The name of this ludb must match the name of ludb configured under the configure>service>vprn/ies>subscrintf>group-intf>ipv6>router-solicit> hierarchy.
Default
no rtr-solicit-user-db
Parameters
vc-range
Syntax
Context
Description
This command is supported only in max16k-vc ATM MDA mode. An ATM MDA supports a number (see scaling guides for more info) of passive (or listening) VCs, of which a subset can be simultaneously active.
Default
Disabled
Parameters
local-address-assignment
Syntax
Context
Description
This command enables the context t configure the local address assignment.
ipv6
Syntax
Context
Description
This command configures the IPv6 local address assignment.
client-application
Syntax
Context
Description
This command enables local router DHCP server pool management for PPPoXv4 clients. A pool of IP addresses can be shared between IPoE clients that rely on DHCP protocol (lease renewal process) and PPPoX clients wehre address allocation is not dependent on DHCP messaging but instead an IP address allocation within the pool is tied to the PPPoX session.
client-application
Syntax
Context
Description
This defines the client application that will use the local address server to perform address assignment. This feature is relies on RADIUS or local-user-database to return a pool name. The pool name is matched again the pools defined in the local-dhcp6-server. The name of the local-dhcp6-server must also be provisioned.
Parameters
default-pool
Syntax
Context
Description
This command references a default DHCP address pool for local PPPoX pool management in case that the pool-name is not retuned via RADIUS or LUDB.
Parameters
server
Syntax
Context
Description
This command designates a local router DHCPv4 server for local pools management where IPv4 addresses for PPPoXv4 clients will be allocated without the need for the internal router DHCP relay-agent. Those addresses will be tied to PPPoX sessions and they will be de-allocated when the PPPoX session is terminated.
Parameters
server
Syntax
Context
Description
This command designates a local router DHCPv6 server for local pools management where IPv6 prefixes or address for PPPoXv6 clients or IPoEv6 clients will be allocated without the need for the internal router DHCP relay-agent. Those addresses will be tied to PPPoX or IPoE sessions and they will be de-allocated when the PPPoX or IPoE session is terminated.
Default
none
Parameters
Layer 3 Subscriber Interfaces SAP Commands
accounting-policy
Syntax
Context
Description
This command specifies the policy to use to collect accounting statistics on a subscriber profile.
A maximum of one accounting policy can be associated with a profile at one time.
The no form of this command removes the accounting policy association.
This command only applies to the 7750 SR.
Default
no accounting policy
Parameters
anti-spoof
Syntax
Context
Description
This command configures the anti-spoof type of the MSAP.
The type of anti-spoof filtering defines what information in the incoming packet is used to generate the criteria to lookup an entry in the anti-spoof filter table. The type parameter (ip, ip-mac) defines the anti-spoof filter type enforced by the SAP when anti-spoof filtering is enabled.
The no form of the command reverts back to the default.
| Note:
For IES and VPRN subscriber group interfaces, setting no anti-spoof will set the default anti-spoofing type which is ip-mac. |
Default
no anti-spoof
Parameters
| Note:
This parameter is not applicable in the config>subscr-mgmt>msap-policy context. |
app-profile
Syntax
Context
Description
This command configures the application profile name and only applies to the 7750 SR.
Parameters
collect-stats
Syntax
Context
Description
When enabled, the agent collects non-RADIUS accounting statistics on a subscriber profile.
When the no collect-stats command is issued the statistics are still accumulated by the IOM cards. However, the CPU will not obtain the results and write them to the billing file. If a subsequent collect-stats command is issued then the counters written to the billing file include all the traffic while the collect-stats
Default
collect-stats
default-host
Syntax
Context
Description
This command configures the default-host. More than one default host can be configured per SAP.
Default
no lease-populate
Parameters
ipv4-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D | |
prefix-length - [0..128] | |
ipv6-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D | |
prefix-length - [0..128] | |
cpu-protection
Syntax
Context
Description
This command assigns an existing CPU protection policy to the associated group interface. The CPU protection policies are configured in the config>sys>security>cpu-protection>policy cpu-protection-policy-id context.
If no CPU-Protection policy is assigned to a group interface SAP, then the default policy is used to limit the overall-rate. The default policy is policy number 254 for access interfaces and 255 for network interfaces.
The no form of the command removes the association of the CPU protection policy from the associated interface and reverts to the default policy values.
Default
cpu-protection 254 (for access interfaces)
cpu-protection 255 (for network interfaces)
The configuration of no cpu-protection returns the interface/SAP to the default policies as shown above.
Parameters
egress
Syntax
Context
Description
This command enables the context to configure egress SAP Quality of Service (QoS) policies and filter policies.
If no sap-egress QoS policy is defined, the system default sap-egress QoS policy is used for egress processing. If no egress filter is defined, no filtering is performed.
This command only applies to the 7750 SR.
filter
Syntax
Context
Description
This command associates an IP filter policy with an ingress or egress Service Access Point (SAP). Filter policies control the forwarding and dropping of packets based on the matching criteria.
MAC filters are only allowed on Epipe and Virtual Private LAN Service (VPLS) SAPs.
The filter command is used to associate a filter policy with a specified ip-filter-id with an ingress or egress SAP. The filter policy must already be defined before the filter command is executed. If the filter policy does not exist, the operation will fail and an error message returned.
In general, filters applied to SAPs (ingress or egress) apply to all packets on the SAP. One exception is non-IP packets are not applied to the match criteria, so the default action in the filter policy applies to these packets.
The no form of this command removes any configured filter ID association with the SAP. The filter ID itself is not removed from the system unless the scope of the created filter is set to local. To avoid deletion of the filter ID and only break the association with the service object, use the scope command within the filter definition to change the scope to local or global. The default scope of a filter is local.
This command only applies to the 7750 SR.
Special Cases
Parameters
qos
Syntax
Context
Description
Associates a Quality of Service (QoS) policy with an egress Service Access Point (SAP) or IP interface.
QoS egress policies are important for the enforcement of SLA agreements. The policy ID must be defined prior to associating the policy with a SAP or IP interface. If the policy-id does not exist, an error will be returned.
The qos command is used to associate egress QoS policies. The qos command only allows egress policies on SAP or IP interface egress. Attempts to associate a QoS policy of the wrong type returns an error.
Only one ingress QoS policy can be associated with a SAP or IP interface at one time. Attempts to associate a second QoS policy of a given type will return an error.
By default, no specific QoS policy is associated with the SAP or IP interface for egress, so the default QoS policy is used.
The normal behavior is for queues to be created per destination.
The no form of this command removes the QoS policy association from the SAP or IP interface, and the QoS policy reverts to the default.
This command only applies to the 7750 SR.
Parameters
qos
Syntax
Context
Description
Associates a Quality of Service (QoS) policy with an ingress Service Access Point (SAP) or IP interface.
QoS ingress policies are important for the enforcement of SLA agreements. The policy ID must be defined prior to associating the policy with a SAP or IP interface. If the policy-id does not exist, an error will be returned.
This qos command is used to associate ingress QoS policies. The qos command only allows ingress policies to be associated on SAP or IP interface ingress.
Only one ingress and one egress QoS policy can be associated with a SAP or IP interface at one time. Attempts to associate a second QoS policy of a given type will return an error.
By default, no specific QoS policy is associated with the SAP or IP interface for ingress so the default QoS policy is used.
The normal behavior is for queues to be created per destination. Shared and multipoint shared change this behavior creating either unicast or unicast and mcast shared queues.
The no form of this command removes the QoS policy association from the SAP or IP interface, and the QoS policy reverts to the default.
This command only applies to the 7750 SR.
Parameters
scheduler-policy
Syntax
Context
Description
This command applies an existing scheduler policy to an ingress or egress scheduler used by SAP queues associated with this multi-service customer site. The schedulers defined in the scheduler policy can only be created once the customer site has been appropriately assigned to a chassis port, channel or slot. Scheduler policies are defined in the config>qos>scheduler-policy scheduler-policy-name context.
The no form of this command removes the configured ingress or egress scheduler policy from the multi-service customer site. When the policy is removed, the schedulers created due to the policy are removed also making them unavailable for the ingress SAP queues associated with the customer site. Queues that lose their parent scheduler association are deemed to be orphaned and are no longer subject to a virtual scheduler. The SAPs that have ingress queues reliant on the removed schedulers enter into an operational state depicting the orphaned status of one or more queues. When the no scheduler-policy command is executed, the customer site ingress or egress node will not contain an applied scheduler policy.
This command only applies to the 7750 SR.
Parameters
host
Syntax
Context
Description
This command creates a static subscriber host for the SAP. Static subscriber hosts may be used by the system for various purposes. Applications within the system that make use of static host entries include anti-spoof filters and ARP cache population.
Multiple static hosts may be defined on the SAP. Each host is identified by either a source IP address, a source MAC address or both a source IP and source MAC address. Every static host definition must have at least one address defined, IP or MAC.
Static hosts can exist on the SAP even with anti-spoof and ARP populate features disabled. When enabled, each feature has different requirements for static hosts.
Default
none
Parameters
Attempting to define a static subscriber host that conflicts with an existing DHCP lease state table entry will fail.
Use the no form of the command to remove a static entry from the system. The specified ip-address and mac-address must match the host’s exact IP and MAC addresses as defined when it was created. When a static host is removed from the SAP, the corresponding anti-spoof entry and/or ARP cache entry is also removed.
This command only applies to the 7750 SR.
For VPRN SAPs with arp-reply-agent enabled with the optional sub-ident parameter, the static subscriber hosts sub-ident-string is used to determine whether an ARP request received on the SAP is sourced from a host belonging to the same subscriber as the destination host. When both the destination and source hosts from the ARP request are known on the SAP and the subscriber identifications do not match, the ARP request may be forwarded to the rest of the VPRN destinations.
If the static subscriber hosts sub-ident string is not defined, the host is not considered to belong to the same subscriber as another host on the SAP.
If source or destination host is unknown, the hosts are not considered to belong to the same subscriber. (ARP messages from unknown hosts are subject to anti-spoof filtering rules applied at the SAP.)
If sub-ident is not enabled on the SAP arp-reply-agent, subscriber identification matching is not performed on ARP requests received on the SAP.
ARP requests are never forwarded back to the same SAP or within the receiving SAP’s Split Horizon Group.
ingress
Syntax
Context
Description
This command enables the context to configure ingress SAP Quality of Service (QoS) policies and filter policies.
If no SAP ingress QoS policy is defined, the system default sap-ingress QoS policy is used for ingress processing. If no ingress filter is defined, no filtering is performed.
This command only applies to the 7750 SR.
multi-service-site
Syntax
Context
Description
This command creates a new customer site or edits an existing customer site with the customer-site-name parameter. A customer site is an anchor point to create an ingress and egress virtual scheduler hierarchy. When a site is created, it must be assigned to a chassis slot or port. When scheduler policies are defined for ingress and egress, the scheduler names contained in each policy are created according to the parameters defined in the policy. Multi-service customer sites exist for the sole purpose of creating a virtual scheduler hierarchy and making it available to queues on multiple Service Access Points (SAPs).
The scheduler policy association with the customer site normally prevents the scheduler policy from being deleted until after the scheduler policy is removed from the customer site. The multi-service-site object will generate a log message indicating that the association was deleted due to scheduler policy removal.
When the multi-service customer site is created, an ingress and egress scheduler policy association does not exist. This does not prevent the site from being assigned to a chassis slot or prevent service SAP assignment. After the site has been created, the ingress and egress scheduler policy associations can be assigned or removed at anytime.
This command only applies to the 7750 SR.
Default
None — Each customer site must be explicitly created.
Parameters
If the customer-site-name does not exist, it is assumed that an attempt is being made to create a site of that name in the customer ID context. The success of the command execution depends on the following:
The maximum number of customer sites defined for the chassis slot has not been met.
The customer-site-name is valid.
The create keyword is included in the command line syntax (if the system requires it).
When the maximum number of customer sites has been exceeded a configuration error occurs, the command will not execute and the CLI context will not change.
If the customer-site-name is invalid, a syntax error occurs, the command will not execute and the CLI context will not change.
ATM Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
atm
Syntax
Context
Description
This command enables access to the context to configure ATM-related attributes. This command can only be used when a given context (for example, a channel or SAP) supports ATM functionality such as:
- Configuring ATM port or ATM port-related functionality on MDAs supporting ATM functionality
- Configuring ATM-related configuration for ATM-based SAPs that exist on MDAs supporting ATM functionality.
If ATM functionality is not supported for a given context, the command returns an error.
egress
Syntax
Context
Description
This command enables the context to configure egress ATM attributes for the SAP.
encapsulation
Syntax
Context
Description
This command configures RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, encapsulation for an ATM PVCC delimited SAP.
This command specifies the data encapsulation for an ATM PVCC delimited SAP. The definition references RFC 2684 and to the ATM Forum LAN Emulation specification.
Ingress traffic that does not match the configured encapsulation will be dropped.
Default
The encapsulation is driven by the services for which the SAP is configured. For IES service SAPs, the default is aal5snap-routed.
Parameters
ingress
Syntax
Context
Description
This command configures ingress ATM attributes for the SAP.
traffic-desc
Syntax
Context
Description
This command assigns an ATM traffic descriptor profile to a given context (for example, a SAP). When configured under the ingress context, the specified traffic descriptor profile defines the traffic contract in the forward direction. When configured under the egress context, the specified traffic descriptor profile defines the traffic contract in the backward direction.
The no form of the command reverts the traffic descriptor to the default traffic descriptor profile.
Default
The default traffic descriptor (trafficDescProfileId. = 1) is associated with newly created PVCC-delimited SAPs.
Parameters
oam
Syntax
Context
Description
This command enables the context to configure OAM functionality for a PVCC delimiting a SAP.
The ATM-capable MDAs support F5 end-to-end OAM functionality (AIS, RDI, Loopback):
- ITU-T Recommendation I.610 - B-ISDN Operation and Maintenance Principles and Functions version 11/95
- GR-1248-CORE - Generic Requirements for Operations of ATM Network Elements (NEs). Issue 3 June 1996
- GR-1113-CORE - Bellcore, Asynchronous Transfer Mode (ATM) and ATM Adaptation Layer (AAL) Protocols Generic Requirements, Issue 1, July 1994
alarm-cells
Syntax
Context
Description
This command configures AIS/RDI fault management on a PVCC. Fault management allows PVCC termination to monitor and report the status of their connection by propagating fault information through the network and by driving PVCCs operational status.
When alarm-cells functionality is enabled, PVCCs operational status is affected when a PVCC goes into AIS or RDI state because of an AIS/RDI processing (i.e. assuming nothing else affects PVCCs operational status, PVCC goes DOWN, when it enters a fault state and comes back UP, when it exits that fault state) and RDI cell are generated when PVCC is operationally DOWN. No OAM-specific SNMP trap is raised whenever an endpoint enters/exits an AIS or RDI states, however, if as result of an OAM state change, the PVCC changes operational status, then a trap is expected from an entity the PVCC is associated with (for example a SAP).
The no command disables alarm-cells functionality for a PVCC. When alarm-cells functionality is disabled, PVCCs operational status is no longer affected by PVCCs OAM state changes due to AIS/RDI processing (when alarm-cells is disabled, a PVCC will change operational status to UP, if it was DOWN because of the alarm-cell processing) and RDI cells are not generated as result of PVCC going into AIS or RDI state, however, PVCCs OAM status will record OAM faults as described above.
Default
Enabled for PVCCs delimiting IES SAPs
periodic-loopback
Syntax
Context
Description
This command enables periodic OAM loopbacks on this SAP. This command is only configurable on IES and VPRN SAPs. When enabled, an ATM OAM loopback cell is transmitted every period as configured in the config>system>atm>oam>loopback-period period context.
If a response is not received and consecutive retry-down retries also result in failure, the endpoint will transition to an alarm indication signal/loss of clock state. Then, an ATM OAM loopback cell will be transmitted every period as configured in the loopback-period period. If a response is received for the periodic loopback and consecutive retry-up retries also each receive a response, the endpoint will transition back to the up state.
The no form of the command sets the value back to the default.
Default
no periodic-loopback
Redundant Interface Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
redundant-interface
Syntax
Context
Description
This command configures a redundant interface.
Parameters
address
Syntax
Context
Description
This command assigns an IP address mask or netmask and a remote IP address to the interface.
Parameters
Assigns an IP address netmask to the interface.
spoke-sdp
Syntax
Context
Description
This command binds a service to an existing Service Distribution Point (SDP).
A spoke SDP is treated like the equivalent of a traditional bridge “port” where flooded traffic received on the spoke SDP is replicated on all other “ports” (other spoke and mesh SDPs or SAPs) and not transmitted on the port it was received.
The SDP has an operational state which determines the operational state of the SDP within the service. For example, if the SDP is administratively or operationally down, the SDP for the service will be down.
The SDP must already be defined in the config>service>sdp context in order to associate an SDP with a VPRN service. If the sdp sdp-id is not already configured, an error message is generated. If the sdp-id does exist, a binding between that sdp-id and the service is created.
SDPs must be explicitly associated and bound to a service. If an SDP is not bound to a service, no far-end 7750 SRdevices can participate in the service.
The no form of this command removes the SDP binding from the service. The SDP configuration is not affected; only the binding of the SDP to a service. Once removed, no packets are forwarded to the far-end router.
Default
No sdp-id is bound to a service.
Special Cases
Parameters
egress
Syntax
Context
Description
This command configures egress SDP parameters.
ingress
Syntax
Context
Description
This command configures ingress SDP parameters.
vc-label
Syntax
Context
Description
This command configures the egress VC label.
Parameters
vc-label
Syntax
Context
Description
This command configures the ingress VC label.
Parameters
filter
Syntax
Context
Description
This command associates an IP filter policy with an ingress or egress Service Access Point (SAP) or IP interface. An IP filter policy can be associated with spoke SDPs.
Filter policies control the forwarding and dropping of packets based on IP or MAC matching criteria.
The filter command is used to associate a filter policy with a specified ip-filter-id with an ingress or egress SAP. The ip-filter-id must already be defined before the filter command is executed. If the filter policy does not exist, the operation will fail and an error message returned.
In general, filters applied to SAPs (ingress or egress) apply to all packets on the SAP. One exception is non-IP packets are not applied to IP match criteria, so the default action in the filter policy applies to these packets.
The no form of this command removes any configured filter ID association with the SAP or IP interface. The filter ID itself is not removed from the system unless the scope of the created filter is set to local. To avoid deletion of the filter ID and only break the association with the service object, use scope command within the filter definition to change the scope to local or global. The default scope of a filter is local.
Parameters
SDP Binding Commands
binding
Syntax
Context
Description
The command enables the context to configure SDP bindings.
port
Syntax
Context
Description
This command specifies the port or lag identifier, to which the PW ports associated with the underlying SDP are bound. If the underlying SDP is re-routed to a port or lag other than the specified one, the PW ports on the SDP are operationally brought down.
The no form of the command removes the value from the configuration.
Default
none
Parameters
pw-port
Syntax
Context
Description
This command creates a pseudowire port.
The no form of the command removes the pseudowire port ID from the configuration.
Default
none
Parameters
description
Syntax
Context
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command associates a text string with a configuration context to help identify the content in the configuration file.
The no form of the command removes the string from the configuration.
Default
no description
Parameters
egress
Syntax
Context
Description
This command enables the context to configure PW-port egress side parameters.
encap-type
Syntax
Context
Description
This command sets the encapsulation type for the PW-port as dot1q or qinq.
Default
dot1q
Parameters
shaper
Syntax
Context
Description
This command configures an egress shaping option for use by a PW port..
Default
no shaper.
int-dest-id
Syntax
Context
Description
This command specifies the intermediate destination string configured for dynamic vport selection.
The no form of the command removes the configured intermediate destination string.
This command is only valid for PW ports used for enhanced subscriber management (ESM on PW).
Default
no .int-dest-id
Parameters
vport
Syntax
Context
Description
This command configures the name of the vport to be used for the PW port.
The no form of the command removes the configured vport name.
This command is valid for PW ports used for enhanced subscriber management (ESM on pseudowire) and pseudowire SAPs on Ethernet ports. It is not valid for pseudowire ports on the HSMDA.
Default
no vport
Parameters
vc-type
Syntax
Context
Description
This command sets the forwarding mode for PW-port. The vc-type is signaled to the peer, and must be configured consistently on both ends of the PW. vc-type VLAN is only configurable with dot1q encapsulation on the PW-port. The tag with vc-type vlan only has significance for transport, and is not used for service delineation or ESM. The top (provider tag) is stripped while forwarding out of the PW, and a configured vlan-tag (for vc-type vlan) is inserted when forwarding into the PW. With vc-type ether, the tags if present (max 2), are transparently preserved when forwarding in our out of the PW.
The no form of the command reverts to the default value.
Default
ether
Parameters
vlan-vc-tag
Syntax
Context
Description
This command sets tag relevant for vc-type vlan mode. This tag is inserted in traffic forwarded into the PW.
The no form of the command reverts to the default value.
Default
0
Parameters
RIP Commands
rip-policy
Syntax
Context
Description
This command creates a RIP policy. This policy is applied to a subscriber IPv4 host to enable the BNG to learn RIP routes from the host. RIP routes are never sent to the hosts.
Default
none
Parameters
neighbor
Syntax
Context
Description
This command creates a context for configuring a RIP neighbor interface. By default, group interfaces are not activated with RIP, unless explicitly configured. The BNG will only learn RIP routes from IPv4 host on the group interface. Hence, RIP neighbor group interface will default send to “none”. The send operation is unchangeable for group-interface.
The no form of the command deletes the RIP interface configuration for this group interface. The shutdown command in the config>router>rip>group group-name>neighbor context can be used to disable an interface without removing the configuration for the interface.
Default
no neighbor — No RIP interfaces are defined.
Parameters
authentication-key
Syntax
Context
Description
This command configures the BGP authentication key.
Authentication is performed between neighboring routers before setting up the BGP session by verifying the password. Authentication is performed using the MD-5 message-based digest. The authentication key can be any combination of letters or numbers from 1 to 16.
The no form of the command removes the authentication password from the configuration and effectively disables authentication.
Default
Authentication is disabled and the authentication password is empty.
Parameters
This is useful when a user must configure the parameter, but, for security purposes, the actual unencrypted key value is not provided.
authentication-type
Syntax
Context
Description
This command sets the type of authentication to be used between RIP neighbors. The type and password must match exactly for the RIP message to be considered authentic and processed.
The no form of the command removes the authentication type from the configuration and effectively disables authentication.
Default
no authentication-type — No authentication enabled.
Parameters
retail-svc-id
Syntax
Context
Description
This command specifies the service id of the retailer IES/VPRN service to which the static IPv6 host belongs. A corresponding retailer subscriber interface must exist in the specified service.
Default
no retail-svc-id
Parameters
rip
Syntax
Context
Description
This command enables the RIP protocol on the given VPRN IP interface.
The no form of the command disables the RIP protocol from the given VPRN IP interface.
Default
no rip
group
Syntax
Context
Description
This command creates a context for configuring a RIP group of neighbors. RIP groups are a way of logically associating RIP neighbor interfaces to facilitate a common configuration for RIP interfaces.
The no form of the command deletes the RIP neighbor interface group. Deleting the group will also remove the RIP configuration of all the neighbor interfaces currently assigned to this group.
Default
no group — No group of RIP neighbor interfaces defined
Parameters
Vport Commands
ethernet
Syntax
Context
Description
This command enables access to the context to configure Ethernet port attributes.
This context can only be used when configuring Fast Ethernet, gigabit or 10Gig Fast Ethernet or Ethernet LAN ports on an appropriate MDA.
egress-scheduler-override
Syntax
Context
Description
This command applies egress scheduler overrides. When a port scheduler is associated with an egress port, it is possible to override the following parameters:
- The max-rate allowed for the scheduler.
- The maximum rate for each priority level 8 through 1.
- The CIR associated with each priority level 8 through 1.
See the SR OS Quality of Service Guide for command syntax and usage for the port-scheduler-policy command.
The no form of this command removes all override parameters from the egress port or channel scheduler context. Once removed, the port scheduler reverts all rate parameters back to the parameters defined on the port-scheduler-policy associated with the port.
level
Syntax
Context
Description
This command overrides the maximum and CIR rate parameters for a specific priority level on the port or channel’s port scheduler instance. When the level command is executed for a priority level, the corresponding priority level command in the port-scheduler-policy associated with the port is ignored. The override level command supports the keyword max for the rate and cir parameter. When executing the level override command, at least the rate or cir keywords and associated parameters must be specified for the command to succeed.
The no form of this command removes the local port priority level rate overrides. Once removed, the port priority level will use the port scheduler policies level command for that priority level.
Parameters
access
Syntax
Context
Description
This command configures Ethernet access port parameters.
egress
Syntax
Context
Description
This command configures Ethernet access egress port parameters.
vport
Syntax
Context
Description
This command configures a scheduling node, referred to as virtual port, within the context of an egress Ethernet port. The vport scheduler operates either like a port scheduler with the difference that multiple vport objects can be configured on the egress context of an Ethernet port, or it can be an aggregate rate when an egress port-scheduler policy is applied to the port.
The vport is always configured at the port level even when a port is a member of a LAG.
When a port scheduler policy is applied to a vport the following command is used:
configure>port>ethernet>acess>egress>vport>port-scheduler-policy port-scheduler-policy-name
The CLI will not allow the user to apply a port scheduler policy to a vport if one has been applied to the port. Conversely, the CLI will not allow the user to apply a port scheduler policy to the egress of an Ethernet port if one has been applied to any vport defined on the access egress context of this port. The agg-rate-limit, along with an egress port-scheduler, can be used to ensure that a given vport does not oversubscribe the port’s rate.
SAP and subscriber host queues can be port-parented to a vport scheduler in a similar way they port-parent to a port scheduler or can be port-parented directly to the egress port-scheduler if the agg-rate-limit is used.
When the vport uses an aggregate rate, the following command is used:
configure>port>ethernet>acess>egress>vport>agg-rate-limit
Parameters
agg-rate-limit
Syntax
Context
Description
This command configures an aggregate rate for the vport. This command is mutually exclusive with the port-scheduler-policy command.
Parameters
egress-rate-modify
Syntax
Context
Description
This command is used to apply HQoS Adjustment to a vport. HQoS Adjustment refers to the dynamic adjustment of the rate limit at an QoS enforcement point within router when the multicast traffic stream is disjointed from the unicast traffic stream. This QoS enforcement point within router represents the physical point further down in the access part of the network where the two streams join each other and potentially can cause congestion.
An example would be a PON port which is shared amongst subscriber’s multicast traffic (single copy of each channel) and subscriber’s unicast traffic. The bandwidth control point for this PON port resides in the upstream router BNG node in the form of a vport. In case that the multicast delivery method in the router BNG utilizes redirection, the multicast traffic in the router BNG will flow outside of the subscriber or the vport context and thus will bypass any bandwidth enforcement in the router. To correct this, a vport bandwidth adjustment is necessary in the router that will account for the multicast bandwidth consumption that is bypassing vport in the router but is present in the PON port whose bandwidth is controlled by vport.
An estimate of the multicast bandwidth consumption on the PON port can be made at the vport level based on the IGMP messages sourced from the subscribers behind the PON port. This process is called HQoS Adjustment.
A multicast channel bandwidth is subtracted from or added to the vport rate limit according to the received IGMP Join/Leave messages and the channel bandwidth definition policy associated with the vport (indirectly through a group-interface). Since the multicast traffic on the PON port is shared amongst subscribers behind this PON port, only the first IGMP Join or the last IGMP Leave per multicast channel is tracked for the purpose of the vport bandwidth modification.
The vport rate that will be affected by this functionality depends on the configuration:
- In case the agg-rate-limit within the vport is configured, its value will be modified based on the IGMP activity associated with the subscriber under this vport.
- In case the port-scheduler-policy within the vport is referenced, the max-rate defined in the corresponding port-scheduler-policy will be modified based on the IGMP activity associated with the subscriber under this vport.
The channel bandwidth definition policy is defined in the mcac policy in the configure>router>mcac>policy context. The policy is applied under the group-interface or in case of redirection under the redirected-interface.
The rates in effect can be displayed with the following two commands:
show port 1/1/5 vport name
qos scheduler-hierarchy port port-id vport vport-name
The configuration of a scheduler policy under a Vport, which is only applicable to Ethernet interfaces, is mutually exclusive with the configuration of the egress-rate-modify parameter.
The configuration of a scheduler policy under a Vport, which is only applicable to Ethernet interfaces, is mutually exclusive with the configuration of the egress-rate-modify parameter.
Default
HQoS Adjustment for vport is disabled.
host-match
Syntax
Context
Description
This command configures host matching for the Ethernet port egress queue-group.
The no form of the command removes
Parameters
port-scheduler-policy
Syntax
Context
Description
This command specifies the destination and organization strings to be used for matching subscriber hosts with this vport.
The parent vport of a subscriber host queue, which has the port-parent option enabled, is determined by matching the destination string dest string associated with the subscriber and the organization string org string associated with the subscriber host with the strings defined under a vport on the port associated with the subscriber.
If a given subscriber host queue does not have the port-parent option enabled, it will be foster-parented to the vport used by this subscriber and which is based on matching the dest string and org string. If the subscriber could not be matched with a vport on the egress port, the host queue will not be bandwidth controlled and will compete for bandwidth directly based on its own PIR and CIR parameters.
By default, a subscriber host queue with the port-parent option enabled is scheduled within the context of the port’s port scheduler policy.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command. Applying a scheduler-policy to a VPORT is only applicable to Ethernet interfaces.
The no form of the command removes the port-scheduler-policy-name from the configuration.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
Parameters
scheduler-policy
Syntax
Context
Description
This command specifies a scheduler policy to associate to the Vport. Scheduler policies are configured in the configure>qos>scheduler>policy context. Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations. The policy defines the hierarchy and operating parameters for virtual schedulers.
The no form of this command removes the configured egress scheduler policy from the VPORT.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
The configuration of a scheduler policy under a Vport is mutually exclusive with the configuration of the egress-rate-modify parameter.
Parameters
parent-location
Syntax
Context
Description
This command determines the expected location of the parent schedulers for queues configured with a parent command within the SAP egress policy. All parent schedulers must be configured within a scheduler policy applied at the location corresponding to the parent-location parameter.
If a parent scheduler name does not exist at the specified location, the queue will not be parented and will be orphaned.
Default
parent-location default
Parameters
parent-location
Syntax
Context
Description
This command determines the expected location of the parent schedulers for the tier 1 schedulers configured with a parent command within the scheduler policy. The parent schedulers must be configured within a scheduler policy applied at the location corresponding to the parent location parameter.
If a parent scheduler name does not exist at the specified location, the schedulers will not be parented and will be orphaned.
The configuration of parent-location and frame-based-accounting in a scheduler policy is mutually exclusive in to ensure consistency between the different scheduling levels.
Default
parent-location none
Parameters
If this parameter is configured within a scheduler policy that is applied to any object except for the egress of an SLA profile, the configured parent schedulers will not be found and so the tier 1 schedulers will not be parented and will be orphaned.
If this parameter is configured within a scheduler policy that is applied to to any object except for the egress of an SLA profile or SUB profile, or to the egress of a PW SAP, the configured parent schedulers will not be found and so the tier 1 schedulers will not be parented and will be orphaned.
MLD Policy Commands
mld-policy
Syntax
Context
Description
This command enables the context to create an MLD policy.
egress-rate-modify
Syntax
Context
Description
This command configures the egress rate modification.
The no form of the command removes the values from the configuration.
Parameters
fast-leave
Syntax
Context
Description
This command enables fast leave. When fast leave processing is enabled, the router will immediately remove a SAP or SDP from the IP multicast group when it detects an MLD 'leave' on that SAP or SDP. Fast leave processing allows the switch to remove a SAP or SDP that sends a 'leave' from the forwarding table without first sending out group-specific queries to the SAP or SDP, and thus speeds up the process of changing channels ('zapping').
Fast leave should only be enabled when there is a single receiver present on the SAP or SDP.
When fast leave is enabled, the configured last-member-query-interval value is ignored.
Default
no fast-leave
import
Syntax
Context
Description
This command specifies the import routing policy to be used. Only a single policy can be imported at a time.
The no form of the command removes the policy association.
Default
no import — No import policy is specified.
Parameters
max-num-groups
Syntax
Context
Description
This command defines the maximum number of multicast groups that can be joined. If the router receives a join message that would exceed the configured number of groups, the request is ignored.
Default
no max-num-groups
Parameters
max-num-grp-sources
Syntax
Context
Description
This command configures the maximum number of group sources for which MLD can have local receiver information based on received MLD reports on this interface. When this configuration is changed dynamically to a value lower than currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources will not be allowed. When this object has a value of 0, there is no limit to the number of group sources.
The no form of the command removes the value from the configuration.
Default
no max-num-grp-sources
Parameters
max-num-sources
Syntax
Context
Description
This command configures the maximum number of multicast sources allowed per group.
The no form of the command removes the value from the configuration.
Parameters
per-host-replication
Syntax
Context
Description
This command enables per-host-replication. In the per-host-replication mode, multicast traffic is replicated per each host within the subscriber irrespective of the fact that some hosts may be subscribed to the same multicast stream. As a result, in case that multiple hosts within the subscriber are registered for the same multicast group, the multicast streams of that group will be generated. The destination MAC address of multicast streams will be changed to unicast so that each host receives its own copy of the stream. Multicast traffic in the per-host-replication mode can be classified via the existing QoS CLI structure. As such the multicast traffic will flow through the subscriber queues. HQoS Adjustment is not needed in this case.
The alternative behavior for multicast replication in IPoE environment is per-SAP- replication. In this model, only a single copy of the multicast stream is sent per SAP, irrespective of the number of hosts that are subscribed to the same multicast group. This behavior applies to 1:1 connectivity model as well as on 1:N connectivity model (SAP centric behavior as opposed to subscriber centric behavior).
In the per-SAP-replication model the destination MAC address is multicast (as opposed to unicast in the per-host-replication model). Multicast traffic is flowing via the SAP queue which is outside of the subscriber context. The consequence is that multicast traffic is not accounted in the subscriber HQoS. In addition, HQoS Adaptation is not supported in the per SAP replication model.
Default
disabled
redirection-policy
Syntax
Context
Description
This command will apply multicast redirection action to the subscriber. The redirection action along with the redirected interface (and possibly service id) is defined in the referenced policy-name. MLD messages will be redirected to an alternate interface if that alternate interface has MLD enabled. The alternate interface does not have to have any multicast groups registered via MLD. Currently all MLD messages are redirected and there is no ability to selectively redirect MLD messages based on match conditions (multicast-group address, source IP address, etc.). Multicast redirection is supported between VPRN services and also between interfaces within the Global Routing Context. Multicast Redirection is not supported between the VRPN services and the Global Routing Table (GRT).
MLD state is maintained per subscriber host and per redirected interface. Traffic is however forwarded only on the redirected interface.
Default
none
Parameters
static
Syntax
Context
Description
This command adds an MLD static group membership.
group
Syntax
Context
Description
This command configures a static multicast group.
Parameters
source
Syntax
Context
Description
This command adds or removes a static multicast source.
Parameters
starg
Syntax
Context
Description
This command adds a static (*,G) entry. This command can only be enabled if no existing source addresses for this group are specified.
Use the no form of the command to remove the starg entry from the configuration.
Default
none
version
Syntax
Context
Description
This command configures the MLD version.
Parameters
IPoE Session Commands
ipoe-session-policy
Syntax
Context
Description
This command configures an IPoE session policy. The policies are referenced from subscriber interfaces, group interfaces and capture SAPs. Multiple IPoE session policies can be configured.
Default
none
Parameters
description
Syntax
Context
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command 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.
Default
no description
Parameters
session-key
Syntax
Context
Description
This command configures the key to logically group subscriber hosts that belong to the same dual stack end device in an IPoE session.
The SAP and MAC address are always part of the IPoE session key. Optionally the Circuit-Id/Interface-Id or Remote-Id can be added to the session key.
Default
session-key sap mac
Parameters
sap and mac are mandatory parameters while cid and rid are optional and mutually exclusive. Valid IPoE session key parameters are: sap mac, sap mac cid and sap mac rid.
session-timeout
Syntax
Context
Description
This command defines the time in seconds between 1 second and 360 days before the IPoE session will be disconnected. The default value is unlimited session timeout.
Default
no session-timeout
Parameters
sap
Syntax
Context
Description
This command declares a given SAP as a primary (or secondary) VPLS port.
ipoe-session
Syntax
Context
Description
This command configures IPoE session parameters.
Default
none
force-auth
Syntax
Context
Description
By default, if the circuit-id/interface-id or remote-id in the IPoE session re-authentication trigger packet (such as a DHCP renewal) is not empty and different from the circuit-id/interface-id or remote-id stored in the IPoE session data, a forced re-authentication is performed, ignoring the configured min-auth-interval. This default behavior can be changed with this command.
The no form of the command resets the default behavior.
Default
force-auth cid-change rid-change force-auth disabled on WLAN-GW group interfaces
Parameters
ipoe-session-policy
Syntax
Context
Description
This command specifies the IPoE session policy applicable for this group interface or capture SAP.
On wlan-gw group interfaces, it is not possible to change this value.
Default
no ipoe-session-policy ipoe-session-policy “default” on WLAN-GW group interfaces
Parameters
min-auth-interval
Syntax
Context
Description
Re-authentication for IPoE sessions enable dynamic policy changes.
This command configures the maximum frequency of re-authentications by specifying a minimum interval between two non-forced authentications for the same IPoE session.
A forced authentication is by default triggered by a Circuit-Id/Interface-Id or Remote-Id change (see the force-auth command).
Re-authentications are, by default, disabled and can be enabled by configuring a min-auth-interval.
Setting the min-auth-interval to zero seconds will always re-authenticate on each trigger packet.
Default
min-auth-interval infinite
Parameters
radius-session-timeout
Syntax
Context
Description
This command specifies how to interpret the session-timeout coming from a RADIUS VSA in an Access-Accept or CoA message.
The value of this command can only be changed on WLAN-GW group interfaces.
The no form of this command resets the default value.
Default
absolute backwards-compatible on WLAN-GW group interfaces
Parameters
sap-session-limit
Syntax
Context
Description
This command specifies the number of IPoE sessions per SAP allowed for this group-interface
Default
sap-session-limit 1
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
session-limit
Syntax
Context
Description
This command specifies the number of IPoE sessions allowed for this group interface or retail subscriber interface.
Default
session-limit 1
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
user-db
Syntax
Context
Description
This command configures the local user database to use for IPoE session authentication.
When configured on a capture SAP, the group interface must have the same local user database configured.
On a WLAN-GW group interface, the no form of this command indicates that the user database will be picked from the following sources in the order shown:
- dhcp
- ipv6> dhcp6
- ipv6> router-solicit
If no user database can be found in any of these locations, processing continues as if no user database was configured. This behavior is for backwards compatibility reasons only; when using a LUDB, it should be explicitly added to the IPoE session configuration.
Default
no user-db
Parameters
shutdown
Syntax
Context
Description
The shutdown command enables or disables IPoE session management on a group interface or capture SAP.
A shutdown of the IPoE session CLI hierarchy on a group-interface will clear all active IPoE sessions on that interface, resulting in a deletion of all corresponding subscriber hosts.
On WLAN-GW group interfaces it is not possible to disable an IPoE session.
Default
shutdown no shutdown on WLAN-GW group interfaces
SHCV Policy Commands
shcv-policy
Syntax
Context
Description
This command configures a Subscriber Host Connectivity Verification (SHCV) policy. An SHCV policy can be applied to both the subscriber management group interface and VPLS instances. All SHCV-related features inside a group interface and a VPLS service will follow the configuration specified in the SHCV policy. The SHCV policy and the SHCV configuration on a group interface are mutually exclusive. Only one can be applied to the group interface.
The no form of the command removes the policy name from the configuration.
Default
none
Parameters
layer-3
Syntax
Context
Description
This command enables the context to configure SHCV behavior parameters for IES and VPRN services.
Default
none
source-ip-origin
Syntax
Context
Description
This command selects the source IP address to be used for SHCV messages.
The no form of the command reverts to the default.
Parameters
periodic
Syntax
Context
Description
This command configures the periodic SHCV properties for the subscriber management group-interface. This tool will periodically scan all known DHCP hosts only and perform unicast ARP/NS requests. The subscriber host connectivity verification will maintain state (connected vs. not-connected) for all hosts.
Default
none
action
Syntax
Context
Description
This command configures the action to take when the periodic connectivity verification failed.
The no form of the command reverts to the default.
Default
alarm
Parameters
interval
Syntax
Context
Description
This command specifies the time interval which all known sources should be verified. The actual rate is dependent on the number of known hosts and intervals.
The no form of the command reverts to the default.
Default
30 minutes
Parameters
retry-count
Syntax
Context
Description
This command configures the number of retransmissions.
The no form of the command reverts to the default.
Default
2
Parameters
timeout
Syntax
Context
Description
This command configures the timeout before a retransmission in triggered connectivity verification.
The no form of the command reverts to the default.
Default
10
Parameters
trigger
Syntax
Context
Description
This command enables to context to configure SHCV triggers.
Default
none
Parameters
retry-count
Syntax
Context
Description
This command configures the number of retransmissions in periodic connectivity verification.
The no form of the command reverts to the default.
Default
1
Parameters
timeout
Syntax
Context
Description
This command configures the timeout before a retransmission.
The no form of the command reverts to the default.
Default
1
Parameters
vpls
Syntax
Context
Description
This command enables the context to configure SHCV behavior in VPLS services.
source-ip
Syntax
Context
Description
This command configures the IPv4 address to be used as source address for connectivity verification in a VPLS service.
The no form of the command reverts to the default.
Default
no source-ip
Parameters
source-mac
Syntax
Context
Description
Specifies the MAC address to be used as source address for connectivity verification in a VPLS service.
The no form of the command reverts to the default.
Default
no source-mac
Parameters
Show Commands
| Note:
The command outputs in the following section are examples only; actual displays may differ depending on supported functionality and user configuration. |
diameter-peer-policy
Syntax
Context
Description
This command displays diameter peer policy information and diameter peer information and statistics. For the diameter proxy, the incoming peer can be specified with an IP address and port number.
Parameters
Output
Table 85 provides a description of the counters in the output of the show aaa diameter-peer-policy command. and Table 86 provides the failure reasons for the aggregate Failed counter (Request Rx and Answer Rx). Sample output follows the tables.
Table 85: show aaa diameter-peer-policy Field Descriptions
Counter | Counts | |
Aggregates Total | Request Tx | Aggregated countersum of all successfully transmitted diameter request messages (all applications, all message types) |
Answer Rx | Aggregated countersum of all successfully received diameter answer messages (all applications, all message types) | |
Request Rx | Aggregated countersum of all successfully received diameter request messages (all applications, all message types) | |
Answers Tx | Aggregated countersum of all successfully transmitted diameter answer messages (all applications, all message types) | |
Aggregates Failed | Request Tx | Aggregated countersum of all request messages that could not be sent for internal reasons, such as TCP socket error (for example, congestion), failure reported to application (for example, no retries left)Dropped by PythonTimeouts (requests for which no answer was received within the configured timeout interval) |
Answer Rx | Aggregated countersum of all Answer messages that failed to be successfully decoded, such as such as invalid header length or a violation against the Command Code Format (CCF) specification. See Table 86 Aggregate Failed Request Rx and Answer Rx counters for more information. | |
Request Rx | Aggregated countersum of all Request messages that failed to be successfully decoded, such as invalid header length or a violation against the Command Code Format (CCF) specificationSee Table 86 Aggregate Failed Request Rx and Answer Rx counters for more information. | |
Answers Tx | Aggregated counterSum of all answer messages that could not be sent for internal reasons such as TCP socket error (for example, congestion)Dropped by Python | |
Application ID id message type | Request Tx | successfully transmitted diameter request messages for the corresponding application and message type |
Answer Rx | successfully received diameter answer messages for the corresponding application and message type | |
Request Rx | successfully received diameter request messages for the corresponding application and message type | |
Answers Tx | successfully transmitted diameter answer messages for the corresponding application and message type | |
Table 86: Aggregate Failed Request Rx and Answer Rx counters
Role | Failed reasons |
Proxy | proxy (message length too short / too long / version unsupported) |
Consistency check failed: header size, message length, illegal flag combination, AVP header too small, AVP present but not allowed (base RFC messages), etc. | |
not a base message | |
not a request | |
Tx overload (message received to be send to client) | |
dropped by python | |
failed to create answer | |
no transaction (answer to server, but request is not found - 5 min.) | |
Diameter base / Diameter application | message dropped due to result code |
message too big / too small | |
dropped by python | |
consistency check failed | |
end-2-end mismatch hop-to-hop command code (answer/request mismatch) | |
cool down sequence drop | |
cc error request | |
application id in header error | |
T bit in header |
isa-radius-policy
Syntax
Context
Description
This command displays ISA RADIUS policy information.
Parameters
Output
Table 87: Subscriber ISA RADIUS Policy Field Descriptions
Label | Description |
Purposes Up | Indicates the RADIUS services that are up and running, and fully operational for this server. |
Source IP address | Indicates the IP address of the RADIUS server. |
Acct Tx Requests | Indicates the number of RADIUS transaction requests transmitted. |
Acct TX Retries | Indicates the number of RADIUS transaction request retries. |
Acct TX Timeouts | Indicates the number of RADIUS transaction requests that have timed out. |
Acct RX Replies | Indicates the number of RADIUS transaction responses received. |
Auth Tx Requests | Indicates the number of authentication requests transmitted. |
Auth Tx Retries | Indicates the number of authentication request retries. |
Auth Tx Timeouts | Indicates the number of RADIUS authentication requests that have timed out for the policy. |
CoA RX Requests | Indicates the number of Change-of-Authorization message responses received. |
radius-configuration
Syntax
Context
Description
This command displays RADIUS configuration information.
Output
radius-server-policy
Syntax
Context
Description
This command displays RADIUS server policy configuration information.
Parameters
Output
Table 88: Subscriber RADIUS Server Policy Field Descriptions
Label | Description |
Tx transaction requests | Indicates the number of RADIUS transaction requests transmitted. |
Rx transaction responses | Indicates the number of RADIUS transaction responses received. |
Transaction requests timed out | Indicates the number of RADIUS transaction requests that have timed out. |
Transaction requests send failed | Indicates the number of RADIUS transaction requests that could not be transmitted. |
Packet retries | Indicates the number of times a RADIUS request packet was retransmitted to a server. |
Transaction requests send rejected | Indicates the number of RADIUS transaction requests that were not transmitted due to unacceptable configuration. |
Authentication requests failed | Indicates the number of authentication failures for this policy. |
Accounting requests failed | Indicates the number of accounting failures for this policy. |
Ratio of access-reject over auth responses | Indicates the ratio of access-rejects in the auth responses for this policy. |
Transaction success ratio | Indicates the transaction success ratio for this policy. |
Transaction failure ratio | Indicates the transaction failure ratio for this policy. |
Statistics last reset at | Indicated the date and time at which the statistics for this policy were last reset. |
ancp-policy
Syntax
Context
Description
This command displays subscriber Access Node Control Protocol (ANCP) policy information.
Parameters
Output
ancp-string
Syntax
Context
Description
This command displays subscriber Access Node Control Protocol (ANCP) string information.
Parameters
<sap-id> | null | <port-id|bundle-id|bpgrp-id|lag-id|aps-id> | |
dot1q | <port-id|bundle-id|bpgrp-id|lag-id|aps-id|pw-id>:qtag1 | ||
qinq | <port-id|bundle-id|bpgrp-id|lag-id| pw-id>:qtag1.qtag2 | ||
atm | <port-id|aps-id>[:vpi/vci|vpi|vpi1.vpi2|cp.conn-prof-id] | ||
cp | keyword | ||
conn-prof-id | [1..8000] | ||
frame | <port-id|aps-id>:dlci | ||
cisco-hdlc | slot/mda/port.channel | ||
cem | slot/mda/port.channel | ||
ima-grp | <bundle-id>[:vpi/vci|vpi|vpi1.vpi2|cp.conn-prof-id] | ||
cp | keyword | ||
conn-prof-id | [1..8000] | ||
port-id | slot/mda/port[.channel] | ||
bundle-id | bundle-<type>-slot/mda.<bundle-num> | ||
bundle | keyword | ||
type | ima|fr|ppp | ||
bundle-num | [1..336] | ||
bpgrp-id | bpgrp-<type>-<bpgrp-num> | ||
bpgrp | keyword | ||
type | ima|ppp | ||
bpgrp-num | [1..2000] | ||
aps-id | aps-<group-id>[.channel] | ||
aps | keyword | ||
group-id | [1..64] | ||
ccag-id | ccag-<id>.<path-id>[cc-type]:<cc-id> | ||
ccag | keyword | ||
id | [1..8] | ||
path-id | [a|b] | ||
cc-type | [.sap-net|.net-sap] | ||
cc-id | [0..4094] | ||
eth-tunnel | eth-tunnel-<id>[:<eth-tun-sap-id>] | ||
id | [1..1024] | ||
eth-tun-sap-id | [0..4094] | ||
lag-id | lag-<id> | ||
lag | keyword | ||
id | [1..800] | ||
pw-id | pw-<id> | ||
pw | keyword | ||
id | [1..10239] | ||
qtag1 | [0..4094] | ||
qtag2 | [*|0..4094] | ||
vpi | [0..4095] (NNI) | ||
[0..255] (UNI) | |||
vci | [1|2|5..65535] | ||
dlci | [16..1022] | ||
tunnel-id | tunnel-<id>.<private|public>:<tag> | ||
tunnel | keyword | ||
id | [1..16] | ||
tag | [0..4094] | ||
Output
authentication
Syntax
Context
Description
This command displays subscriber management RADIUS authentication policy information and statistics.
Parameters
Output
Table 89: Subscriber Authentication Field Descriptions
Label | Description |
Requests Received | Indicates the number of notify Change-of-Authorization requests received. |
Requests Accepted | Indicates the number of notify Change-of-Authorization requests accepted. |
Requests Rejected | Indicates the number of notify Change-of-Authorization requests rejected. |
Requests Dropped | Indicates the number of notify Change-of-Authorization requests dropped. |
No Auth Policy found | Indicates the number of notify Change-of-Authorization requests found. |
Invalid message | Indicates the number of notify Change-of-Authorization requests rejected because of decode errors. |
Out of resources | Indicates the number of notify Change-of-Authorization requests rejected due to lack of resources. |
Authentication Failure | Indicates the number of notify Change-of-Authorization requests which do not have NAS-Port-ID or Framed-IP-Address set or have mismatched subscriber-id. |
diameter-application-policy
Syntax
Context
Description
This command displays Diameter application policy information.
Parameters
Output
diameter-session
Syntax
Context
Description
This command displays diameter session information.
ccrt-replay
Syntax
Context
Description
This command displays information about diameter Gx sessions that are in Credit-Control-Request Session-Terminate-Request (CCR-T) replay mode.
Parameters
Output
explicit-subscriber-map
Syntax
Context
Description
This command displays explicit subscriber mappings.
Output
host-lockout-policy
Syntax
Context
Description
This command displays host lockout policy information.
Parameters
Output
The following is a sample output for the host-lockout-policy command.
igmp-policy
Syntax
Context
Description
This command displays IGMP policy information and only applies to the 7750 SR.
Parameters
Output
ipoe-session-policy
Syntax
Context
Description
This command displays IPoE session policy information.
Parameters
Output
local-user-db
Syntax
Context
Description
This command displays local user database information.
Output
msap-policy
Syntax
Context
Description
This command displays Managed SAP policy information.
Output
pcc-rule
Syntax
Context
Description
This command displays a list of pcc-rules and associated monitoring keys in the system.
Parameters
Output
radius-accounting-policy
Syntax
Context
Description
This command displays RADIUS accounting policy information.
Parameters
Output
Table 90: Subscriber RADIUS Accounting Policy Field Descriptions
Label | Description |
Tx Requests/TX Reqs | Displays the number of accounting requests transmitted for this policy. |
Rx Responses/Rx Resps | Displays the number of accounting responses received for this policy. |
Request Timeouts/Req Timeouts | Displays the number of accounting requests which have timed out for this policy. |
Send Retries | Displays the number of retries to a different server for a single accounting request for this policy. |
Send Failed Req Send Failed | Displays how many accounting requests failed because the packet could not be sent out for this policy. |
Radius Servers | Displays a table in which the statistics associated with this RADIUS accounting policy are broken down by individual RADIUS server. The table columns are: Index—displays the index number assigned to the RADIUS server. The index determines the sequence in which the servers are queried for authentication requests. Servers are queried in order from lowest to highest index. IP Address—the address of the RADIUS server. TX Reqs—see TX Requests in this table. Rx Resps—see RX Responses in this table. Req Timeouts—see Request Timeouts in this table. Req Send Failed—see Send Failed in this table. |
sla-profile
Syntax
Context
Description
This command displays SLA profile information.
Parameters
Output
sla-profile
Syntax
Context
Description
This command displays the subscriber’s SLA profile scheduler stats.
Parameters
Output
port
Syntax
Context
Description
This command displays the subscriber’s SLA profile scheduler stats.
Parameters
Output
vport
Syntax
Context
Description
This command displays the vport scheduler stats.
Parameters
Output
statistics
Syntax
Context
Description
This command displays enhanced subscriber management statistics per port/pw-port/MDA/IOM/system.
For each statistic, there is current value and peak value, peak value is the highest value since last reset via system boot or command clear subscriber-mgmt peakvalue-stats.
| Note:
The peak values can be reset via the clear subscriber-mgmt peakvalue-stats command. |
Parameters
The following tables describe the counters available in the show subscriber management statistics command output.
The following terminology is used to indicate applicability of the stats:
- ESM — Enhanced Subscriber Management. Subscriber traffic forwarded via subscriber queues. Enabled with SAP sub-sla-mgmt in no shutdown state.
- BSM — Basic Subscriber Management. Subscriber traffic forwarded via SAP queues. SAP sub-sla-mgmt must be in shutdown state. For DHCP, dhcp lease-populate or dhcp6-relay lease-populate must be enabled to count the leases. For IPv4, if anti-spoof is enabled on the SAP, a subscriber host is instantiated.
- Routed CO — IES or VPRN service with subscriber-interface and group-interface constructs.
- Bridged CO — VPLS service with DHCPv4 lease management enabled (lease-populate)
- regular interface — IES or VPRN interface (none subscriber-interface or group-interface)
- Host (also subscriber host) — A resource in the system that is used for traffic forwarding and security related actions. The creation of a subscriber host entry is linked to anti-spoof being enabled on a SAP. For ESM, anti-spoof is mandatory and hence every connected {IP/MAC} consumes by default a subscriber host entry. A DHCP6 IA-PD can also be modeled as a managed route. In this case, no subscriber host is instantiated. For BSM, anti-spoof is optional on regular interfaces. An IPv4 static-host and DHCPv4 lease do not result in a subscriber host instantiation when anti-spoof is disabled on the SAP.
Table 91: Host And Protocol Statistics
Section
Counter
Counts
Applies to
IPv4
1. PPP Hosts - IPCP
IPv4 local terminated PPP hosts (PTA, LNS)
ESM, Routed CO
2. IPOE Hosts - DHCP
DHCPv4 hosts (lease states)
ESM, Routed CO, Bridged CO
3. IPOE Hosts - ARP
ARP hosts
ESM, Routed CO, Bridged CO
4. IPOE Hosts – Static
IPv4 static hosts
ESM, Routed CO, Bridged CO
5. IPOE Hosts BSM - DHCP
DHCPv4 hosts (lease states: anti-spoof and lease-populate enabled)
BSM, Routed CO, Bridged CO, regular interface
6. IPOE Hosts BSM – Static
IPv4 static hosts (with anti-spoof enabled)
BSM, Routed CO, Bridged CO, regular interface
7. IPOE BSM - DHCP
DHCPv4 lease states (with lease-populate enabled, no anti-spoof)
BSM, Routed CO, Bridged CO, regular interface
8. IPOE BSM – Static
IPv4 static hosts (no anti-spoof)
BSM, Routed CO, Bridged CO, regular interface
IPv6
PPP Hosts – SLAAC
Local terminated IPv6 wan-host – SLAAC (PTA, LNS)
ESM, Routed CO
PPP Hosts - DHCP6 (PD)
Local terminated IPv6 pd-host (PTA, LNS) – DHCP6 IA-PD leases over PPP (excluding PD as managed route)
ESM, Routed CO
PPP Hosts - DHCP6 (NA)
Local terminated IPv6 wan-host (PTA, LNS) – DHCP6 IA-NA leases over PPP
ESM, Routed CO
PPP Mngd Rt - DHCP6 (PD)
IPv6 (PTA, LNS) – DHCP6 IA-PD leases over PPP (PD as managed route only)
ESM, Routed CO
IPOE Hosts – SLAAC
IPv6 wan-host – SLAAC
ESM, Routed CO
IPOE Hosts - DHCP6 (PD)
IPv6 pd-host – DHCP6 IA-PD leases (excluding PD as managed route)
ESM, Routed CO
IPOE Hosts - DHCP6 (NA)
IPv6 wan-host – DHCP6 IA-NA leases
ESM, Routed CO
IPOE Mngd Rt - DHCP6 (PD)
IPv6 – DHCP6 IA-PD leases (PD as managed route only)
ESM, Routed CO
IPOE Hosts – Static (PD)
IPv6 static hosts with prefix-length shorter than /128
ESM, Routed CO
IPOE Hosts – Static (WAN)
IPv6 static hosts with prefix-length equal to /128
ESM, Routed CO
IPOE BSM - DHCP6 (PD)
IPv6 – DHCP6 IA-PD leases (lease-populate)
BSM, regular interface
IPOE BSM - DHCP6 (NA)
IPv6 – DHCP6 IA-NA leases (lease-populate)
BSM, regular interface
Total
PPP Hosts
Local terminated PPP hosts (PTA, LNS)
Sum of counters 1, 9, 10 and 11
ESM
IPOE Hosts
Total IPv4 and IPv6 IPOE hosts.
Sum of counters 2, 3, 4, 5, 6, 13, 14, 15, 17 and 18
ESM
IPv4 Hosts
Total IPv4 hosts. PPP (PTA, LNS) and IPOE.
Sum of counters 1, 2, 3, 4, 5 and 6
ESM
IPv6 Hosts
Total IPv6 hosts. PPP (PTA, LNS) and IPOE.
Sum of counters 9, 10, 11, 13, 14, 15, 17 and 18
ESM
IPv6 PD Mngd Routes
Total DHCP6 IA-PD leases modeled as a managed route. PPP (PTA, LNS) and IPOE.
Sum of counters 12 and 16
ESM
L2TP LAC Hosts
L2TP LAC hosts – single host per single or dual stack PPP session.
Counter also increases for outgoing LTS sessions.
ESM, Routed CO
Internal Hosts
Subscriber hosts for internal use. For example: LNS redirect hosts (for LTS, an LNS redirect host is also instantiated).
ESM
Total (Cont)
Non-Sub-Traffic L2-Hosts
Host on a single subscriber SAP in a VPLS service that enables non-IP traffic to be forwarded using the specified SLA profile instance queues.
Host on a single subscriber SAP attached to an IES/VPRN group-interface that enables traffic normally forwarded via the SAP queues to flow via the specified SLA profile instance queues.
configure service vpls <service-id> sap <sap-id> sub-sla-mgmt single-sub-parameters non-sub-traffic sub-profile <sub-profile-name> sla-profile <sla-profile-name> [subscriber <sub-ident-string>] [app-profile <app-profile-name>]
ESM, Routed CO, Bridged CO
DHCP leases
Total number of DHCPv4 lease states.
Sum of counters 2, 5 and 7
ESM, BSM
DHCPv6 leases
Total number of DHCPv6 lease states.
Sum of counters 10, 11, 12, 14, 15, 16, 19 and 20
ESM, BSM
Subscriber Hosts
Counter displayed in the output of “show subscriber-mgmt statistics iom | mda | port | pw-port”
This counter matches the number of hosts accounted for in the per line card limit
Sum of counters 1, 2, 3, 4, 5, 6, 9, 10, 11, 13, 14, 15, 17, 18 and 26
ESM
Total (Cont)
System Hosts Scale
Counter displayed in the output of “show subscriber-mgmt statistics system”
This counter matches the number of hosts accounted for in the system wide limit
Sum of counters 1, 2, 3, 4, 5, 6, 9, 10, 11, 13, 14, 15, 17, 18, 26 and 27
ESM
Table 92: PPP Session Statistics
Section
Counter
Counts
Applies to
Local
PPP Sessions - PPPoE
Local terminated PPPoE sessions (PTA)
ESM, Routed CO
PPP Sessions - PPPoEoA
Local terminated PPPoEoA sessions (PTA)
ESM, Routed CO
.PPP Sessions - PPPoA
Local terminated PPPoA sessions (PTA)
ESM, Routed CO
PPP Sessions - L2TP (LNS)
Local terminated PPP sessions (L2TP LNS)
ESM, Routed CO
LAC
PPP Sessions - PPPoE
Tunneled PPPoE session (L2TP LAC)
ESM, Routed CO
PPP Sessions - PPPoEoA
Tunneled PPPoEoA session (L2TP LAC)
ESM, Routed CO
PPP Sessions - PPPoA
Tunneled PPPoA session (L2TP LAC)
ESM, Routed CO
PPP Sessions - L2TP (LTS)
Tunneled PPP session (L2TP LTS)
ESM, Routed CO
Total
PPP Sessions - established
PPP sessions that are established (at least one active host attached) – PTA/LAC/LTS/LNS
ESM, Routed CO
PPP Sessions - in setup
PPP sessions in setup (session created, host setup in progress) – PTA/LAC/LTS/LNS
ESM, Routed CO
Total (Cont)
PPP Sessions - local
Local terminated PPPoX sessions (PTA, L2TP LNS)
Sum of counters 33, 34, 35 and 36
ESM, Routed CO
PPP Sessions - LAC
Tunneled PPPoX session (L2TP LAC, L2TP LTS)
Sum of counters 37, 38, 39 and 40
ESM, Routed CO
L2TP
L2TP Tunnels - originator
Number of L2TP Tunnels originated on this node. (LAC/ LTS)
ESM, Routed CO
.L2TP Tunnels - receiver
Number of L2TP Tunnels terminated on this node. (LNS/LTS)
ESM, Routed CO
Total L2TP Tunnels
Number of L2TP Tunnels originated or terminated on this node
Sum of counters 45 and 46
ESM, Routed CO
Table 93: IPoE Session Statistics
Section | Counter | Counts | Applies to |
Total | IPOE Sessions - established | IPoE sessions that are established (at least one active host attached). | ESM, Routed CO |
IPOE Sessions- in setup | IPoE sessions in setup (session created, host setup in progress). | ESM, Routed CO |
Table 94: Subscriber Statistics
Section | Counter | Counts | Applies to |
Total | Subscribers | Total number of active subscribers. | ESM, Routed CO, Bridged CO |
Table 95: SubMgmt Statistics Summary
Section | Counter | Counts | |
Hosts | IPv4 | Total IPv4 hosts (counter 23 in tables above) | |
IPv6 | Total IPv6 hosts (counter 24 in tables above) | ||
Sessions | PPP | Total PPP sessions - established (counter 41 in tables above) | |
IPOE | Total IPOE sessions – established (counter 48 in tables above) | ||
Subscribers | Total number of active subscribers (counter 50 in tables above) | ||
Output
sub-ident-policy
Syntax
Context
Description
This command displays subscriber identification policy information.
Parameters
Output
sub-profile
Syntax
Context
Description
This command displays subscriber profile information.
Parameters
Output
pw-port
Syntax
Context
Description
Displays pseudo-wire port information.
If no optional parameters are specified, the command displays a summary of all defined PW ports. The optional parameters restrict output to only ports matching the specified properties.
Parameters
Output
Show PW-Port
The following table describes show pw-port output fields:
Table 96: Subscriber Show PW-Port Field Descriptions
Label | Description |
PW Port | The PW Port identifier. |
Encap | The encapsulation type of the PW Port. |
SDP | The SDP identifier. |
IfIndex | The interface index used for the PW Port. |
VC-Id | The Virtual Circuit identifier. |
Description | The description string for the PW Port. |
port-scheduler-policy
Syntax
Context
Description
This command displays scheduler policy information.
Output
sap-egress
Syntax
Context
Description
This command displays SAP egress policy information.
Parameters
Output
sap-ingress
Syntax
Context
Description
This command displays SAP ingress policy information.
Parameters
Output
scheduler-hierarchy
Syntax
Context
Description
This command enables the context to display information about policies that use this scheduler.
customer
Syntax
Context
Description
This command displays the scheduler hierarchy per customer multi-service-site.
Parameters
sap
Syntax
Context
Description
This command displays the scheduler stats per SAP.
Parameters
subscriber
Syntax
Context
Description
This command displays the scheduler hierarchy rooted at the SLA profile scheduler.
Parameters
| Note:
If the SLA profile scheduler is orphaned (that is when the scheduler has a parent which does not exist) then the hierarchy is only shown when the show command includes the sla-profile and sap parameters. |
Output
scheduler-name
Syntax
Context
Description
This command displays information about the specified scheduler name.
Parameters
scheduler-policy
Syntax
Context
Description
This command displays information about the specified scheduler policy.
Parameters
Output
scheduler-stats
Syntax
Context
Description
This command enables the context to display scheduler statistics information.
Output
shared-queue
Syntax
Context
Description
This command displays shared policy information.
Output
ancp-policy
Syntax
Context
Description
This command displays subscriber ANCP policy information.
Output
ancp-string
Syntax
Context
Description
This command displays subscriber ANCP string information.
Parameters
Output
Other applicable show command output:
radius-proxy-server
Syntax
Context
Description
This command displays RADIUS proxy server information.
Parameters
Output
Table 97: Subscriber RADIUS Proxy Server Field Descriptions
Label | Description |
Invalid response Authenticator Rx packet | Displays the number of packets received by this RADIUS proxy server. |
Rx Access-Request | Displays the number of Access-Request packets received by this RADIUS proxy server. |
Rx Accounting-Request | Displays the number of Accounting-Request packets received by this RADIUS proxy server. |
Rx dropped | Displays the number of packets received by this RADIUS proxy server but dropped. |
Retransmit | Displays the number of packets received by this RADIUS proxy server that were rejected because they are retransmitted. |
Wrong purpose | Displays the number of packets received by this RADIUS proxy server that were rejected because the value of tmnxRadProxSrvPurpose is set to a value not matching the type of packet. |
No UE MAC to cache | Displays the number of packets received by this RADIUS proxy server that were rejected because the UE MAC address was not present in the packet. |
Client context limit reached | Displays the number of packets received by this RADIUS proxy server that were rejected because the limit of client contexts was reached. For each RADIUS transaction a client context is created, and will be deleted once the transaction is finished. |
No ISA RADIUS policy configured | Displays the number of packets received by this RADIUS proxy server that were rejected because it has no ISA RADIUS server policy configured for that type of packet. |
Server admin down | Displays the number of packets received by this RADIUS proxy server that were rejected because it is administratively shut down. |
No RADIUS policy configured | Displays the number of packets received by this RADIUS proxy server that were rejected because it has no RADIUS server policy configured for that type of packet. |
No load-balance-key configured | Displays the number of packets received by this RADIUS proxy server that were rejected because the selected RADIUS server policy's algorithm is set to hashBased and no load balance key is configured. |
Invalid length | Displays the number of packets received by this RADIUS proxy server that were rejected because their length was invalid. |
Invalid Code field | Displays the number of packets received by this RADIUS proxy server that were rejected because they had an invalid Code field. |
Invalid attribute encoding | Displays the number of packets received by this RADIUS proxy server that were rejected because one of the attributes was incorrectly encoded. |
Invalid User-Name | Displays the number of packets received by this RADIUS proxy server that were rejected because they contained an invalid User-Name attribute. |
Invalid password | Displays the number of packets received by this RADIUS proxy server that were rejected because the User-Password attribute could not be decoded. |
Invalid accounting Authenticator | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained an invalid Authenticator field. |
Invalid Message-Authenticator | Displays the number of packets received by this RADIUS proxy server that were rejected because they contained an invalid Message-Authenticator attribute. |
Management core overload | Displays the number of packets that were rejected by this RADIUS server because the ISA management core is not able to process any new RADIUS requests because of overload. |
No memory | Displays the number of packets that were rejected by this RADIUS server because there was not enough memory to store them. |
Accounting-Request with invalid Acct-Status-Type | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained an invalid Acct-Status-Type attribute. |
Accounting-Request with no Acct-Status-Type | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained no Acct-Status-Type attribute. |
Registered user overload | Displays the number of packets that were rejected by this RADIUS server because the registered user indicated to be in overload. |
Dropped by Python | Displays the number of packets received by this RADIUS proxy server but dropped by Python. |
Tx Access-Accept | Displays the number of Access-Accept packets transmitted by this RADIUS proxy server. |
Tx Access-Reject | Displays the number of Access-Reject packets transmitted by this RADIUS proxy server. |
Tx Access-Challenge | Displays the number of Access-Challenge packets transmitted by this RADIUS proxy server. |
Tx Accounting-Response | Displays the number of Accounting-Response packets transmitted by this RADIUS proxy server. |
Tx dropped | Displays the number of packets dropped by this RADIUS proxy server before transmission. |
No key to cache | Displays the number of packets that could not be cached by this RADIUS proxy server because the key information was not present in the packet. |
Cache key too long | Displays the number of packets that could not be cached by this RADIUS proxy server because the key information present in the packet was too long. |
Cache attributes too long | Displays the number of packets that could not be cached by this RADIUS proxy server because the total length of the attributes is too long. |
Reached maximum number of cache entries | Displays the number of packets that could not be cached by this RADIUS proxy server because the limit has been reached. |
No memory | Displays the number of packets that could not be transmitted by this RADIUS proxy server because there was not enough memory. |
Server timeout | Displays the number of packets that were dropped because the RADIUS servers have timed out. |
Server authentication failure | Displays the number of packets that were dropped because the RADIUS server replied with a packet which failed authentication (invalid response Authenticator or Message Authenticator attribute). |
Server invalid Code | Displays the number of packets that were dropped because the RADIUS server replied with a packet with an invalid Code field. |
Invalid attribute encoding | Displays the number of packets that were dropped because the RADIUS server replied with a packet with an invalid attribute. |
Registered user overload | Displays the number of packets that were dropped because the registered user indicated to be in overload. |
No RADIUS server configured | Displays the number of packets that were dropped by this RADIUS server because the RADIUS server policy has no servers configured. |
RADIUS server send failure | Displays the number of packets that were dropped by this RADIUS server because the packet could not get transmitted to one of the servers in the RADIUS server policy. |
Dropped by Python | Displays the number of packets that were dropped by this RADIUS server because the packet was dropped by the Python script. |
Invalid response Authenticator | Displays the number of packets that were dropped because the RADIUS server replied with a packet which failed authentication |
wpp
Syntax
Context
Description
This command displays WPP port-related information in the specified routing instance.
Parameters
Output
ipoe session
Syntax
Context
Description
This command displays the identified IPoE session details active on the specified service instance.
Parameters
Output
managed-hosts
Syntax
Context
Description
This command displays information about hosts that are not yet linked to an in-band control plane protocol, such as DHCP or DHCPv6. Examples include hosts installed by data-triggers and hosts installed by RADIUS.
Parameters
Output
The following output is an example of managed host information.
Clear Commands
ancp-sub-string
Syntax
Context
Description
This command clears subscriber ANCP data.
Parameters
arp
Syntax
Context
Description
This command clears all or specific ARP entries.
The scope of ARP cache entries cleared depends on the command line option(s) specified.
Parameters
authentication
Syntax
Context
Description
This command clears subscriber authentication data.
Parameters
diameter-session
Syntax
Context
Description
This command clears diameter session data.
ccrt-replay
Syntax
Context
Description
This command clears diameter Gx sessions that are in CCR Terminate replay mode.
Parameters
idle-only-msap
Syntax
Context
Description
This command removes all idle MSAPs associated with the MSAP policy.This command only removes idle MSAPs without active subscribers. This command is considered safer than the clear>subscr-mgmt>msap-policy msap-policy-name idle-only command because in that command, the parameter idle-only is optional. Not specifying idle-only will delete MSAPs with active subscribers.
Parameters
msap-policy
Syntax
Context
Description
This command deletes Managed SAPs (MSAPs) created by the MSAP policy.
This command can remove an MSAP with active subscribers still associated with the MSAP. Use the idle-only parameter to remove only MSAPs in an idle state.
Parameters
peakvalue-stats
Syntax
Context
Description
This command resets the most recent peak counter.
| Note:
Clearing one counter will not impact other counters. For example, clearing one IOM’s most recent peak value will not impact chassis peak value. |
Parameters
radius-accounting
Syntax
Context
Description
This command clears RADIUS accounting data for the specified policy.
Parameters
scheduler-stats
Syntax
Context
Description
This command clears scheduler statistics.
subscriber
Syntax
Context
Description
This command clears scheduler stats per subscriber.
Parameters
sla-profile
Syntax
Context
Description
This command clears the subscriber’s SLA profile scheduler stats.
Parameters
srrp
Syntax
Context
Description
This command enables the context to clear and reset SRRP virtual router instances.
interface
Syntax
Context
Description
This command clears and resets SRRP interface instances.
Parameters
statistics
Syntax
Context
Description
This command clears statistics for SRRP instances.
Parameters
route-downloader
Syntax
Context
Description
This command clears all the radius-downloaded routes from the internal downloader cache (or protocol RIB/db) (and thus eventually from the RTM itself). The parameters vprn and/or family allow to restrict the deletion of those routes learned in a particular address family (IPv4 or IPv6) and/or a particular VPRN.
By default, all VPRNs and both IPv4 and IPv6 families are affected.
| Note:
A clear of the internal protocol DB means the corresponding prefix that were deleted should be removed from the RTM (and from any other exports) as well. |
Parameters
vport
Syntax
Context
Description
This command clears the vport scheduler stats.
Parameters
ipoe session
Syntax
Context
Description
This commands clears all identified IPoE sessions for the specified service instance. All associated subscriber hosts will be deleted from the system.
Parameters
Tools Commands
tools
Syntax
Context
Description
The context to enable useful tools for debugging purposes.
Default
none
Parameters
avp-match-learned-session-id
Syntax
Context
Description
This command displays the diameter session IDs that are learned by the AVP value matching in a diameter debug.
Per avp-match id in a diameter peer policy, a single diameter session ID can be learned. "N/A" means no session ID is learned.
Output
The following is a sample output for the avp-match-learned-session-id command.
perform
Syntax
Context
Description
This command enables the context to enable tools to perform specific tasks.
Default
none
credit-reset
Syntax
Context
Description
This command resets the credit for an SLA-profile instance.
Parameters
persistence
Syntax
Context
Description
This command enables the context to configure downgrade parameters.
downgrade
Syntax
Context
Description
This command downgrades persistence files to a previous version.
Parameters
eval-msap
Syntax
Context
Description
This command re-applies the managed SAP policy to the managed SAP identified by the specified sap-id or to all managed SAPs associated with the specified msap-policy name.
Parameters
eval-lease-state
Syntax
Context
Description
This command evaluates lease state.
Parameters
subscriber-mgmt
Syntax
Context
Description
This command enables tools to control subscriber management.
edit-lease-state
Syntax
Context
Description
This command provides the parameters to edit lease state information.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
credit-reset
Syntax
Context
Description
This command resets the credit for an SLA-profile instance.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
edit-ppp-session
Syntax
Context
Description
This command updates the data of the PPP session identified with the given MAC address and SAP identifier. Optionally the remote-id and circuit-id can be specified to identify the IPoE session to update.
| Note:
The changes take immediate effect. |
edit-slaac-host
Syntax
Context
Description
This command updates the data of the SLAAC host information
edit-ipoe-session
Syntax
Context
Description
This command updates the data of the IPoE session identified with the given MAC address and SAP identifier. Optionally the remote-id and circuit-id can be specified to identify the IPoE session to update.
| Note:
The changes take immediate effect. |
eval-ipoe-session
Syntax
Context
Description
This command re-evaluates the mapping between authentication strings such as the SLA profile string and the actual profiles for the identified IPoE sessions.
eval-ppp-session
Syntax
Context
Description
This command evaluates PPP sessions.
eval-slaac-host
Syntax
Context
Description
This command evaluates the SLAAC host.
remap-lease-state
Syntax
Context
Description
This command allows the remapping of all existing hosts if network card on CMTS/WAC side is changed is required. This command only applies to the 7750 SR.
When this command is executed, the following restrictions apply:
- When sap is taken, all leases associated with the SAP are re-written.
- For a SAP with a configured MAC in "lease-populate" command, this MAC will be taken.
- For a SAP without a configured MAC the MAC from tools command will be taken.
- For a SAP without a configured MAC and no MAC in tools command no action will be perform.
- When using the old-mac option, providing a new MAC ieee-address is mandatory.
This command is applicable only when dealing with DHCP lease states which were instantiated using l2header mode of DHCP operation.
Parameters
When configured, the SAP parameter will remap all MAC addresses of DHCP lease states on the specified SAP. When no optional MAC parameter is specified, the sap sap-id command remaps all MAC addresses of lease states towards the MAC address specified in the l2-header configuration.
re-ident-sub
Syntax
Context
Description
This command renames a subscriber identification string.
Parameters
redundancy
Syntax
Context
Description
This command enables the context to dump redundancy parameters.
multi-chassis
Syntax
Context
Description
This command enables the context to dump multi-chassis parameters.
mc-endpoint
Syntax
Context
Description
This command dumps multi-chassis endpoint information.
Parameters
force-switchover
Syntax
Context
Description
This command manually switches over mc-ipsec mastership of the specified tunnel-group.
Parameters
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring information.
Parameters
srrp-sync-database
Syntax
Context
Description
This command dumps SRRP database information and only applies to the 7450 ESS and 7750 SR.
Parameters
sync-database
Syntax
Context
Description
This command dumps MCS database information.
Parameters
dhcp-server: | local dhcp server (7450 ESS and 7750 SR only) |
igmp: | Internet group management protocol |
igmp-snooping: | igmp-snooping |
mc-ring: | multi-chassis ring |
mld-snooping: | multicast listener discovery-snooping |
srrp: | simple router redundancy protocol (7450 ESS and 7750 SR only) |
sub-host-trk: | subscriber host tracking (7450 ESS and 7750 SR only) |
sub-mgmt: | subscriber management (7450 ESS and 7750 SR only) |
mc-ipsec
Syntax
Context
Description
This command enters the mc-ipsec context.
mc-endpoint
Syntax
Context
Description
This command dumps multi-chassis endpoint information.
Parameters
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring information.
Parameters
srrp-sync-database
Syntax
Context
Description
This command dumps SRRP database information and only applies to the 7450 ESS and 7750 SR.
Parameters
sync-database
Syntax
Context
Description
This command dumps MCS database information.
Parameters
dhcp-server: | local dhcp server (7450 ESS and 7750 SR only) |
igmp: | Internet group management protocol |
igmp-snooping: | igmp-snooping |
mc-ring: | multi-chassis ring |
mld-snooping: | multicast listener discovery-snooping |
srrp: | simple router redundancy protocol (7450 ESS and 7750 SR only) |
sub-host-trk: | subscriber host tracking (7450 ESS and 7750 SR only) |
sub-mgmt: | subscriber management (7450 ESS and 7750 SR only) |
forcerenew
Syntax
Context
Description
This command forces the renewal of lease state and only applies to the 7450 ESS and 7750 SR
Parameters
local-user-db
Syntax
Context
Description
This command provides tools to control the local user database.
ipoe
Syntax
Context
Description
This command provides the tools to control IPoE entries in the local user database.
host-lookup
Syntax
Context
Description
This command performs a lookup in the local user database.
ppp
Syntax
Context
Description
This command provides the tools to control PPPoE entries in the local user database.
authentication
Syntax
Context
Description
This command authenticates the PPPoE user name.
host-lookup
Syntax
Context
Description
This command performs a lookup in the local user database.
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring data.
sync-database
Syntax
Context
Description
This command dumps multi-chassis sync database information.
Parameters
sync-database-reconcile
Syntax
Context
Description
This command provides the paramwters to reconcile MCS database entries.
srrp-sync-data
Syntax
Context
Description
This command dumps multi-chassis SRRP sync database information.
Parameters
route-downloader
Syntax
Context
Description
This command causes the download process to start immediately. If an ongoing download is already in progress then no further action is needed, except if the force keyword is added. In case the force keyword is added, then the current download is aborted and a new one is immediately restarted. If aborting the current download, the internal route table should not be emptied or cleared.
Parameters
router
Syntax
Context
Description
This command enables the context for tools dump commands in the specified routing instance.
Parameters
ipoe-session
Syntax
Context
Description
This command enables the context for IPoE session-related tools dump commands in the specified routing instance.
migration
Syntax
Context
Description
This command displays details on the IPoE session migration progress. It shows per group interface the number of hosts per type (DHCPv4, DHCPv6 and SLAAC) that are associated with an IPoE session or that are not associated with an IPoE session.
Output
The following is a sample output for the migration command.
Debug Commands
diameter
Syntax
Context
Description
This command enables debugging for diameter.
dest-realm
Syntax
Context
Description
This command restricts the output to a specific destination-realm.
Parameters
detail-level
Syntax
Context
Description
This command configures the detail level of debug output.
Parameters
diameter-peer
Syntax
Context
Description
This command restricts output to a specific peer.
Parameters
diameter-peer-policy
Syntax
Context
Description
This command restricts the debug output to messages on peers of a specific diameter peer policy. Up to eight diameter peer policies can be specified.
The no form of the command removes the specified diameter peer policy and all debug statement under this policy from the debug configuration.
Parameters
avp-match
Syntax
Context
Description
This command restricts the debug output to messages within the diameter peer policy that belong to a diameter session identified based on the AVP value matching in a diameter application message.At least the message type and one AVP match criteria must be specified in an avp-match id command.
If a diameter application message matches all criteria within one AVP match ID, then the session ID is learned and all subsequent messages of that diameter session are shown until a relearning occurs. (OR function between avp-match id commands.)
When the session ID is learned in an Answer message, an attempt is made to include the corresponding Request message in the debug output: The Request message should still be available in the system and must pass all debug filters (such as message-type).
By default an avp-match id is disabled and must be configured with the debug>diameter>diameter-peer-policy>avp-match no shutdown to activate.
Parameters
avp
Syntax
Context
Description
This command specifies an AVP match criteria for AVP value matching. At least one and up to five AVP match criteria can be specified in an avp-match id command. When multiple AVP match criteria are specified, they must all match to be successful and result in a diameter session ID learning. (AND function between avp avp-id commands.)
The AVP in an AVP match criteria is identified by its AVP ID. The AVP ID is specified as [vendor-id-]avp-code[.avp-id] with nesting up to five levels deep.
The format type of the AVP should match the standard documents in which the AVP is specified. Any AVP can be specified as an octet string in hex format.
Parameters
message-type
Syntax
Context
Description
This command specifies the message type match criteria for AVP value matching. Only specified diameter application messages are used for AVP value matching. This is a mandatory criteria in an avp-match id command.This command does not restrict the debug output to the specified messages.
Parameters
shutdown
Syntax
Context
Description
Enables or disables the avp-match id criteria for filtering debug output based on AVP value matching.A shutdown of the avp-match id will clear the learned diameter session ID.
diameter-peer
Syntax
Context
Description
This command restricts the debug output to messages on a specific peer within the diameter peer policy. Overrides the debug>diameter>diameter-peer debug command for the specified diameter peer policy. A single peer can be specified per diameter peer policy.
When no peer is specified at the diameter peer policy level, the debug output is restricted to the peer configured at the debug>diameter level.
The no form of the command removes the peer from the debug>diameter>diameter-peer-policy debug output.
Parameters
message-type
Syntax
Context
Description
This command restricts the debug output to the specified message types.
When specified within a diameter peer policy, it overrides the message type configuration at the debug>diameter level for messages received and sent on that diameter peer policy.
The no form of the command removes the message type from the debug configuration.
Parameters
origin-realm
Syntax
Context
Description
This command restricts output to a specific origin-realm.
arp-host
Syntax
Context
Description
This command enables and configures ARP host debugging.
The no form of the command disables ARP host debugging.
one-time-http-redirection
Syntax
Context
Description
This command produces one-time http redirection debug output.
ppp
Syntax
Context
Description
This command enables the PPP debug context.
event
event
Syntax
Context
Description
This command enables the PPP event debug context.
dhcp-client
Syntax
Context
Description
This command enable PPP event debug for DHCP client.
Parameters
l2tp
Syntax
Context
Description
This command enables PPP L2TP event debug.
Parameters
local-address-assignment
Syntax
Context
Description
This command enables debugging for local-address-assignment events.
The no form of the command disables debugging.
Parameters
ppp
Syntax
Context
Description
This command enables PPP event debug.
The no form of the command disables debugging.
Parameters
mac
Syntax
Context
Description
This command displays PPP packets for a particular MAC address.
The no form of the command disables debugging.
msap
Syntax
Context
Description
This command enables debugging for specific PPP MSAPs.
The no form of the command disables debugging.
packet
Syntax
Context
Description
This command enables the PPP packet debug context.
The no form of the command disables debugging.
detail-level
Syntax
Context
Description
This command specify the detail level of PPP packet debug output.
The no form of the command disables debugging.
dhcp-client
Syntax
Context
Description
This command enables packet debug output for DHCP client of the PPP session
The no form of the command disables debugging.
discovery
Syntax
Context
Description
This command enables PPP discovery packet debug output.
The no form of the command disables debugging.
Parameters
mode
Syntax
Context
Description
This command specifies PPP packet debug mode.
The no form of the command disables debugging.
Parameters
ppp
Syntax
Context
Description
This command enables PPP discovery packet debug output for the specified PPP protocol.
The no form of the command disables debugging.
Parameters
remote-id
Syntax
Context
Description
This command enables debugging for specific PPP remote-ids.
The no form of the command disables debugging.
sap
Syntax
Context
Description
This command enables PPP debug output for the specified SAP, this command allow multiple instances.
The no form of the command disables debugging.
Parameters
username
Syntax
Context
Description
This command enable PPP debug for the specified username. since not all PPP packets contain username, so a mac debug filter will be created automatically when system sees a PPP packet contain the specified username.
Multiple username filters can be specified in the same debug command.
The no form of the command disables debugging.
Parameters
circuit-id
Syntax
Context
Description
This command enable PPP debug for the specified circuit-id.
Multiple circuit-id filters can be specified in the same debug command.
The no form of the command disables debugging.
Parameters
remote-id
Syntax
Context
Description
This command enable PPP debug for the specified remote-id.
Multiple remote-id filters could be specified in the same debug command.
Parameters
msap
Syntax
Context
Description
This command enable PPP debug for the specified managed SAP.
Multiple msap filters could be specified in the same debug command.
Parameters
authentication
Syntax
Context
Description
This command debugs subscriber authentication.
Parameters
sub-ident-policy
Syntax
Context
Description
This command debugs subscriber identification policies.
Parameters
script-compile-error
Syntax
Context
Description
This command send the traceback of the compile error to the logger. The traceback contains detailed information about where and why the compilation fails. The compilation takes place when the CLI user changes the admin state of the Python URL from shutdown to no-shutdown.
script-export-variables
Syntax
Context
Description
This command sends the result (the three output variables) of the Python script to the logger when the script ran successfully.
script-output
Syntax
Context
Description
This command sends the output (such as from 'print' statements) of the Python script to the logger.
script-output-on-error
Syntax
Context
Description
This command sends the output (such as from 'print' statements) of the Python script to the logger, but only when the script fails.
script-runtime-error
Syntax
Context
Description
This command sends the traceback of the Python script failure to the logger.
script-all-info
Syntax
Context
Description
This command enables the script-compile-error, script-export-variables, script-output, script-output-on-error, and script-runtime-error functionalities.
srrp
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
events
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
packets
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
radius
Syntax
Context
Description
This command enables the debug router RADIUS context.
detail-level
Syntax
Context
Description
This command specifies the output detail level of command debug router radius.
Default
medium
Parameters
packet-type
Syntax
Context
Description
This command specifies the RADIUS packet type filter of command debug router radius
Default
authentication accounting coa
Parameters
radius-attr
Syntax
Context
Description
This command specifies the RADIUS attribute filter of command debug router radius.
Default
none
Parameters
address | <ipv4-address>|<ipv6-address>| <ipv6-prefix/prefix-length> | |
ipv4-address | a.b.c.d | |
ipv6-address | x:x:x:x:x:x:x:x (eight 16-bit pieces) | |
ipv6-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) | |
x:x:x:x:x:x:d.d.d.d | ||
x - [0..FFFF]H | ||
d - [0..255]D | ||
ipv6-prefix-length [0..128] | ||
hex | [0x0..0xFFFFFFFF...(max 506 hex nibbles)] | |
integer | [0..4294967295] | |
string | ascii-string (max 253 chars) | |
wpp
Syntax
Context
Description
This command enables the context to configure WPP debugging parameters.
packet
Syntax
Context
Description
This command enables WPP packet debugging.
detail-level
Syntax
Context
Description
This command specifies the detail level of WPP packet debugging.
Parameters
portal
Syntax
Context
Description
This command enables WPP debugging for the specified WPP portal.
Parameters
Monitor Commands
subscriber
Syntax
Context
Description
This command monitors statistics for a subscriber.
Parameters
Output
host
Syntax
Context
Description
This command displays static host information configured on this service.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
Default
collect-stats
default-host
Syntax
Context
Description
This command configures the default-host. More than one default host can be configured per SAP.
Default
no lease-populate
Parameters
ipv4-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D | |
prefix-length - [0..128] | |
ipv6-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) |
x:x:x:x:x:x:d.d.d.d | |
x - [0..FFFF]H | |
d - [0..255]D | |
prefix-length - [0..128] | |
cpu-protection
Syntax
Context
Description
This command assigns an existing CPU protection policy to the associated group interface. The CPU protection policies are configured in the config>sys>security>cpu-protection>policy cpu-protection-policy-id context.
If no CPU-Protection policy is assigned to a group interface SAP, then the default policy is used to limit the overall-rate. The default policy is policy number 254 for access interfaces and 255 for network interfaces.
The no form of the command removes the association of the CPU protection policy from the associated interface and reverts to the default policy values.
Default
cpu-protection 254 (for access interfaces)
cpu-protection 255 (for network interfaces)
The configuration of no cpu-protection returns the interface/SAP to the default policies as shown above.
Parameters
egress
Syntax
Context
Description
This command enables the context to configure egress SAP Quality of Service (QoS) policies and filter policies.
If no sap-egress QoS policy is defined, the system default sap-egress QoS policy is used for egress processing. If no egress filter is defined, no filtering is performed.
This command only applies to the 7750 SR.
filter
Syntax
Context
Description
This command associates an IP filter policy with an ingress or egress Service Access Point (SAP). Filter policies control the forwarding and dropping of packets based on the matching criteria.
MAC filters are only allowed on Epipe and Virtual Private LAN Service (VPLS) SAPs.
The filter command is used to associate a filter policy with a specified ip-filter-id with an ingress or egress SAP. The filter policy must already be defined before the filter command is executed. If the filter policy does not exist, the operation will fail and an error message returned.
In general, filters applied to SAPs (ingress or egress) apply to all packets on the SAP. One exception is non-IP packets are not applied to the match criteria, so the default action in the filter policy applies to these packets.
The no form of this command removes any configured filter ID association with the SAP. The filter ID itself is not removed from the system unless the scope of the created filter is set to local. To avoid deletion of the filter ID and only break the association with the service object, use the scope command within the filter definition to change the scope to local or global. The default scope of a filter is local.
This command only applies to the 7750 SR.
Special Cases
Parameters
qos
Syntax
Context
Description
Associates a Quality of Service (QoS) policy with an egress Service Access Point (SAP) or IP interface.
QoS egress policies are important for the enforcement of SLA agreements. The policy ID must be defined prior to associating the policy with a SAP or IP interface. If the policy-id does not exist, an error will be returned.
The qos command is used to associate egress QoS policies. The qos command only allows egress policies on SAP or IP interface egress. Attempts to associate a QoS policy of the wrong type returns an error.
Only one ingress QoS policy can be associated with a SAP or IP interface at one time. Attempts to associate a second QoS policy of a given type will return an error.
By default, no specific QoS policy is associated with the SAP or IP interface for egress, so the default QoS policy is used.
The normal behavior is for queues to be created per destination.
The no form of this command removes the QoS policy association from the SAP or IP interface, and the QoS policy reverts to the default.
This command only applies to the 7750 SR.
Parameters
qos
Syntax
Context
Description
Associates a Quality of Service (QoS) policy with an ingress Service Access Point (SAP) or IP interface.
QoS ingress policies are important for the enforcement of SLA agreements. The policy ID must be defined prior to associating the policy with a SAP or IP interface. If the policy-id does not exist, an error will be returned.
This qos command is used to associate ingress QoS policies. The qos command only allows ingress policies to be associated on SAP or IP interface ingress.
Only one ingress and one egress QoS policy can be associated with a SAP or IP interface at one time. Attempts to associate a second QoS policy of a given type will return an error.
By default, no specific QoS policy is associated with the SAP or IP interface for ingress so the default QoS policy is used.
The normal behavior is for queues to be created per destination. Shared and multipoint shared change this behavior creating either unicast or unicast and mcast shared queues.
The no form of this command removes the QoS policy association from the SAP or IP interface, and the QoS policy reverts to the default.
This command only applies to the 7750 SR.
Parameters
scheduler-policy
Syntax
Context
Description
This command applies an existing scheduler policy to an ingress or egress scheduler used by SAP queues associated with this multi-service customer site. The schedulers defined in the scheduler policy can only be created once the customer site has been appropriately assigned to a chassis port, channel or slot. Scheduler policies are defined in the config>qos>scheduler-policy scheduler-policy-name context.
The no form of this command removes the configured ingress or egress scheduler policy from the multi-service customer site. When the policy is removed, the schedulers created due to the policy are removed also making them unavailable for the ingress SAP queues associated with the customer site. Queues that lose their parent scheduler association are deemed to be orphaned and are no longer subject to a virtual scheduler. The SAPs that have ingress queues reliant on the removed schedulers enter into an operational state depicting the orphaned status of one or more queues. When the no scheduler-policy command is executed, the customer site ingress or egress node will not contain an applied scheduler policy.
This command only applies to the 7750 SR.
Parameters
host
Syntax
Context
Description
This command creates a static subscriber host for the SAP. Static subscriber hosts may be used by the system for various purposes. Applications within the system that make use of static host entries include anti-spoof filters and ARP cache population.
Multiple static hosts may be defined on the SAP. Each host is identified by either a source IP address, a source MAC address or both a source IP and source MAC address. Every static host definition must have at least one address defined, IP or MAC.
Static hosts can exist on the SAP even with anti-spoof and ARP populate features disabled. When enabled, each feature has different requirements for static hosts.
Default
none
Parameters
Attempting to define a static subscriber host that conflicts with an existing DHCP lease state table entry will fail.
Use the no form of the command to remove a static entry from the system. The specified ip-address and mac-address must match the host’s exact IP and MAC addresses as defined when it was created. When a static host is removed from the SAP, the corresponding anti-spoof entry and/or ARP cache entry is also removed.
This command only applies to the 7750 SR.
For VPRN SAPs with arp-reply-agent enabled with the optional sub-ident parameter, the static subscriber hosts sub-ident-string is used to determine whether an ARP request received on the SAP is sourced from a host belonging to the same subscriber as the destination host. When both the destination and source hosts from the ARP request are known on the SAP and the subscriber identifications do not match, the ARP request may be forwarded to the rest of the VPRN destinations.
If the static subscriber hosts sub-ident string is not defined, the host is not considered to belong to the same subscriber as another host on the SAP.
If source or destination host is unknown, the hosts are not considered to belong to the same subscriber. (ARP messages from unknown hosts are subject to anti-spoof filtering rules applied at the SAP.)
If sub-ident is not enabled on the SAP arp-reply-agent, subscriber identification matching is not performed on ARP requests received on the SAP.
ARP requests are never forwarded back to the same SAP or within the receiving SAP’s Split Horizon Group.
ingress
Syntax
Context
Description
This command enables the context to configure ingress SAP Quality of Service (QoS) policies and filter policies.
If no SAP ingress QoS policy is defined, the system default sap-ingress QoS policy is used for ingress processing. If no ingress filter is defined, no filtering is performed.
This command only applies to the 7750 SR.
multi-service-site
Syntax
Context
Description
This command creates a new customer site or edits an existing customer site with the customer-site-name parameter. A customer site is an anchor point to create an ingress and egress virtual scheduler hierarchy. When a site is created, it must be assigned to a chassis slot or port. When scheduler policies are defined for ingress and egress, the scheduler names contained in each policy are created according to the parameters defined in the policy. Multi-service customer sites exist for the sole purpose of creating a virtual scheduler hierarchy and making it available to queues on multiple Service Access Points (SAPs).
The scheduler policy association with the customer site normally prevents the scheduler policy from being deleted until after the scheduler policy is removed from the customer site. The multi-service-site object will generate a log message indicating that the association was deleted due to scheduler policy removal.
When the multi-service customer site is created, an ingress and egress scheduler policy association does not exist. This does not prevent the site from being assigned to a chassis slot or prevent service SAP assignment. After the site has been created, the ingress and egress scheduler policy associations can be assigned or removed at anytime.
This command only applies to the 7750 SR.
Default
None — Each customer site must be explicitly created.
Parameters
If the customer-site-name does not exist, it is assumed that an attempt is being made to create a site of that name in the customer ID context. The success of the command execution depends on the following:
The maximum number of customer sites defined for the chassis slot has not been met.
The customer-site-name is valid.
The create keyword is included in the command line syntax (if the system requires it).
When the maximum number of customer sites has been exceeded a configuration error occurs, the command will not execute and the CLI context will not change.
If the customer-site-name is invalid, a syntax error occurs, the command will not execute and the CLI context will not change.
ATM Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
atm
Syntax
Context
Description
This command enables access to the context to configure ATM-related attributes. This command can only be used when a given context (for example, a channel or SAP) supports ATM functionality such as:
- Configuring ATM port or ATM port-related functionality on MDAs supporting ATM functionality
- Configuring ATM-related configuration for ATM-based SAPs that exist on MDAs supporting ATM functionality.
If ATM functionality is not supported for a given context, the command returns an error.
egress
Syntax
Context
Description
This command enables the context to configure egress ATM attributes for the SAP.
encapsulation
Syntax
Context
Description
This command configures RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, encapsulation for an ATM PVCC delimited SAP.
This command specifies the data encapsulation for an ATM PVCC delimited SAP. The definition references RFC 2684 and to the ATM Forum LAN Emulation specification.
Ingress traffic that does not match the configured encapsulation will be dropped.
Default
The encapsulation is driven by the services for which the SAP is configured. For IES service SAPs, the default is aal5snap-routed.
Parameters
ingress
Syntax
Context
Description
This command configures ingress ATM attributes for the SAP.
traffic-desc
Syntax
Context
Description
This command assigns an ATM traffic descriptor profile to a given context (for example, a SAP). When configured under the ingress context, the specified traffic descriptor profile defines the traffic contract in the forward direction. When configured under the egress context, the specified traffic descriptor profile defines the traffic contract in the backward direction.
The no form of the command reverts the traffic descriptor to the default traffic descriptor profile.
Default
The default traffic descriptor (trafficDescProfileId. = 1) is associated with newly created PVCC-delimited SAPs.
Parameters
oam
Syntax
Context
Description
This command enables the context to configure OAM functionality for a PVCC delimiting a SAP.
The ATM-capable MDAs support F5 end-to-end OAM functionality (AIS, RDI, Loopback):
- ITU-T Recommendation I.610 - B-ISDN Operation and Maintenance Principles and Functions version 11/95
- GR-1248-CORE - Generic Requirements for Operations of ATM Network Elements (NEs). Issue 3 June 1996
- GR-1113-CORE - Bellcore, Asynchronous Transfer Mode (ATM) and ATM Adaptation Layer (AAL) Protocols Generic Requirements, Issue 1, July 1994
alarm-cells
Syntax
Context
Description
This command configures AIS/RDI fault management on a PVCC. Fault management allows PVCC termination to monitor and report the status of their connection by propagating fault information through the network and by driving PVCCs operational status.
When alarm-cells functionality is enabled, PVCCs operational status is affected when a PVCC goes into AIS or RDI state because of an AIS/RDI processing (i.e. assuming nothing else affects PVCCs operational status, PVCC goes DOWN, when it enters a fault state and comes back UP, when it exits that fault state) and RDI cell are generated when PVCC is operationally DOWN. No OAM-specific SNMP trap is raised whenever an endpoint enters/exits an AIS or RDI states, however, if as result of an OAM state change, the PVCC changes operational status, then a trap is expected from an entity the PVCC is associated with (for example a SAP).
The no command disables alarm-cells functionality for a PVCC. When alarm-cells functionality is disabled, PVCCs operational status is no longer affected by PVCCs OAM state changes due to AIS/RDI processing (when alarm-cells is disabled, a PVCC will change operational status to UP, if it was DOWN because of the alarm-cell processing) and RDI cells are not generated as result of PVCC going into AIS or RDI state, however, PVCCs OAM status will record OAM faults as described above.
Default
Enabled for PVCCs delimiting IES SAPs
periodic-loopback
Syntax
Context
Description
This command enables periodic OAM loopbacks on this SAP. This command is only configurable on IES and VPRN SAPs. When enabled, an ATM OAM loopback cell is transmitted every period as configured in the config>system>atm>oam>loopback-period period context.
If a response is not received and consecutive retry-down retries also result in failure, the endpoint will transition to an alarm indication signal/loss of clock state. Then, an ATM OAM loopback cell will be transmitted every period as configured in the loopback-period period. If a response is received for the periodic loopback and consecutive retry-up retries also each receive a response, the endpoint will transition back to the up state.
The no form of the command sets the value back to the default.
Default
no periodic-loopback
Redundant Interface Commands
| Note:
The commands described in this section apply only to the 7750 SR. |
redundant-interface
Syntax
Context
Description
This command configures a redundant interface.
Parameters
address
Syntax
Context
Description
This command assigns an IP address mask or netmask and a remote IP address to the interface.
Parameters
Assigns an IP address netmask to the interface.
spoke-sdp
Syntax
Context
Description
This command binds a service to an existing Service Distribution Point (SDP).
A spoke SDP is treated like the equivalent of a traditional bridge “port” where flooded traffic received on the spoke SDP is replicated on all other “ports” (other spoke and mesh SDPs or SAPs) and not transmitted on the port it was received.
The SDP has an operational state which determines the operational state of the SDP within the service. For example, if the SDP is administratively or operationally down, the SDP for the service will be down.
The SDP must already be defined in the config>service>sdp context in order to associate an SDP with a VPRN service. If the sdp sdp-id is not already configured, an error message is generated. If the sdp-id does exist, a binding between that sdp-id and the service is created.
SDPs must be explicitly associated and bound to a service. If an SDP is not bound to a service, no far-end 7750 SRdevices can participate in the service.
The no form of this command removes the SDP binding from the service. The SDP configuration is not affected; only the binding of the SDP to a service. Once removed, no packets are forwarded to the far-end router.
Default
No sdp-id is bound to a service.
Special Cases
Parameters
egress
Syntax
Context
Description
This command configures egress SDP parameters.
ingress
Syntax
Context
Description
This command configures ingress SDP parameters.
vc-label
Syntax
Context
Description
This command configures the egress VC label.
Parameters
vc-label
Syntax
Context
Description
This command configures the ingress VC label.
Parameters
filter
Syntax
Context
Description
This command associates an IP filter policy with an ingress or egress Service Access Point (SAP) or IP interface. An IP filter policy can be associated with spoke SDPs.
Filter policies control the forwarding and dropping of packets based on IP or MAC matching criteria.
The filter command is used to associate a filter policy with a specified ip-filter-id with an ingress or egress SAP. The ip-filter-id must already be defined before the filter command is executed. If the filter policy does not exist, the operation will fail and an error message returned.
In general, filters applied to SAPs (ingress or egress) apply to all packets on the SAP. One exception is non-IP packets are not applied to IP match criteria, so the default action in the filter policy applies to these packets.
The no form of this command removes any configured filter ID association with the SAP or IP interface. The filter ID itself is not removed from the system unless the scope of the created filter is set to local. To avoid deletion of the filter ID and only break the association with the service object, use scope command within the filter definition to change the scope to local or global. The default scope of a filter is local.
Parameters
SDP Binding Commands
binding
Syntax
Context
Description
The command enables the context to configure SDP bindings.
port
Syntax
Context
Description
This command specifies the port or lag identifier, to which the PW ports associated with the underlying SDP are bound. If the underlying SDP is re-routed to a port or lag other than the specified one, the PW ports on the SDP are operationally brought down.
The no form of the command removes the value from the configuration.
Default
none
Parameters
pw-port
Syntax
Context
Description
This command creates a pseudowire port.
The no form of the command removes the pseudowire port ID from the configuration.
Default
none
Parameters
description
Syntax
Context
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command associates a text string with a configuration context to help identify the content in the configuration file.
The no form of the command removes the string from the configuration.
Default
no description
Parameters
egress
Syntax
Context
Description
This command enables the context to configure PW-port egress side parameters.
encap-type
Syntax
Context
Description
This command sets the encapsulation type for the PW-port as dot1q or qinq.
Default
dot1q
Parameters
shaper
Syntax
Context
Description
This command configures an egress shaping option for use by a PW port..
Default
no shaper.
int-dest-id
Syntax
Context
Description
This command specifies the intermediate destination string configured for dynamic vport selection.
The no form of the command removes the configured intermediate destination string.
This command is only valid for PW ports used for enhanced subscriber management (ESM on PW).
Default
no .int-dest-id
Parameters
vport
Syntax
Context
Description
This command configures the name of the vport to be used for the PW port.
The no form of the command removes the configured vport name.
This command is valid for PW ports used for enhanced subscriber management (ESM on pseudowire) and pseudowire SAPs on Ethernet ports. It is not valid for pseudowire ports on the HSMDA.
Default
no vport
Parameters
vc-type
Syntax
Context
Description
This command sets the forwarding mode for PW-port. The vc-type is signaled to the peer, and must be configured consistently on both ends of the PW. vc-type VLAN is only configurable with dot1q encapsulation on the PW-port. The tag with vc-type vlan only has significance for transport, and is not used for service delineation or ESM. The top (provider tag) is stripped while forwarding out of the PW, and a configured vlan-tag (for vc-type vlan) is inserted when forwarding into the PW. With vc-type ether, the tags if present (max 2), are transparently preserved when forwarding in our out of the PW.
The no form of the command reverts to the default value.
Default
ether
Parameters
vlan-vc-tag
Syntax
Context
Description
This command sets tag relevant for vc-type vlan mode. This tag is inserted in traffic forwarded into the PW.
The no form of the command reverts to the default value.
Default
0
Parameters
RIP Commands
rip-policy
Syntax
Context
Description
This command creates a RIP policy. This policy is applied to a subscriber IPv4 host to enable the BNG to learn RIP routes from the host. RIP routes are never sent to the hosts.
Default
none
Parameters
neighbor
Syntax
Context
Description
This command creates a context for configuring a RIP neighbor interface. By default, group interfaces are not activated with RIP, unless explicitly configured. The BNG will only learn RIP routes from IPv4 host on the group interface. Hence, RIP neighbor group interface will default send to “none”. The send operation is unchangeable for group-interface.
The no form of the command deletes the RIP interface configuration for this group interface. The shutdown command in the config>router>rip>group group-name>neighbor context can be used to disable an interface without removing the configuration for the interface.
Default
no neighbor — No RIP interfaces are defined.
Parameters
authentication-key
Syntax
Context
Description
This command configures the BGP authentication key.
Authentication is performed between neighboring routers before setting up the BGP session by verifying the password. Authentication is performed using the MD-5 message-based digest. The authentication key can be any combination of letters or numbers from 1 to 16.
The no form of the command removes the authentication password from the configuration and effectively disables authentication.
Default
Authentication is disabled and the authentication password is empty.
Parameters
This is useful when a user must configure the parameter, but, for security purposes, the actual unencrypted key value is not provided.
authentication-type
Syntax
Context
Description
This command sets the type of authentication to be used between RIP neighbors. The type and password must match exactly for the RIP message to be considered authentic and processed.
The no form of the command removes the authentication type from the configuration and effectively disables authentication.
Default
no authentication-type — No authentication enabled.
Parameters
retail-svc-id
Syntax
Context
Description
This command specifies the service id of the retailer IES/VPRN service to which the static IPv6 host belongs. A corresponding retailer subscriber interface must exist in the specified service.
Default
no retail-svc-id
Parameters
rip
Syntax
Context
Description
This command enables the RIP protocol on the given VPRN IP interface.
The no form of the command disables the RIP protocol from the given VPRN IP interface.
Default
no rip
group
Syntax
Context
Description
This command creates a context for configuring a RIP group of neighbors. RIP groups are a way of logically associating RIP neighbor interfaces to facilitate a common configuration for RIP interfaces.
The no form of the command deletes the RIP neighbor interface group. Deleting the group will also remove the RIP configuration of all the neighbor interfaces currently assigned to this group.
Default
no group — No group of RIP neighbor interfaces defined
Parameters
Vport Commands
ethernet
Syntax
Context
Description
This command enables access to the context to configure Ethernet port attributes.
This context can only be used when configuring Fast Ethernet, gigabit or 10Gig Fast Ethernet or Ethernet LAN ports on an appropriate MDA.
egress-scheduler-override
Syntax
Context
Description
This command applies egress scheduler overrides. When a port scheduler is associated with an egress port, it is possible to override the following parameters:
- The max-rate allowed for the scheduler.
- The maximum rate for each priority level 8 through 1.
- The CIR associated with each priority level 8 through 1.
See the SR OS Quality of Service Guide for command syntax and usage for the port-scheduler-policy command.
The no form of this command removes all override parameters from the egress port or channel scheduler context. Once removed, the port scheduler reverts all rate parameters back to the parameters defined on the port-scheduler-policy associated with the port.
level
Syntax
Context
Description
This command overrides the maximum and CIR rate parameters for a specific priority level on the port or channel’s port scheduler instance. When the level command is executed for a priority level, the corresponding priority level command in the port-scheduler-policy associated with the port is ignored. The override level command supports the keyword max for the rate and cir parameter. When executing the level override command, at least the rate or cir keywords and associated parameters must be specified for the command to succeed.
The no form of this command removes the local port priority level rate overrides. Once removed, the port priority level will use the port scheduler policies level command for that priority level.
Parameters
access
Syntax
Context
Description
This command configures Ethernet access port parameters.
egress
Syntax
Context
Description
This command configures Ethernet access egress port parameters.
vport
Syntax
Context
Description
This command configures a scheduling node, referred to as virtual port, within the context of an egress Ethernet port. The vport scheduler operates either like a port scheduler with the difference that multiple vport objects can be configured on the egress context of an Ethernet port, or it can be an aggregate rate when an egress port-scheduler policy is applied to the port.
The vport is always configured at the port level even when a port is a member of a LAG.
When a port scheduler policy is applied to a vport the following command is used:
configure>port>ethernet>acess>egress>vport>port-scheduler-policy port-scheduler-policy-name
The CLI will not allow the user to apply a port scheduler policy to a vport if one has been applied to the port. Conversely, the CLI will not allow the user to apply a port scheduler policy to the egress of an Ethernet port if one has been applied to any vport defined on the access egress context of this port. The agg-rate-limit, along with an egress port-scheduler, can be used to ensure that a given vport does not oversubscribe the port’s rate.
SAP and subscriber host queues can be port-parented to a vport scheduler in a similar way they port-parent to a port scheduler or can be port-parented directly to the egress port-scheduler if the agg-rate-limit is used.
When the vport uses an aggregate rate, the following command is used:
configure>port>ethernet>acess>egress>vport>agg-rate-limit
Parameters
agg-rate-limit
Syntax
Context
Description
This command configures an aggregate rate for the vport. This command is mutually exclusive with the port-scheduler-policy command.
Parameters
egress-rate-modify
Syntax
Context
Description
This command is used to apply HQoS Adjustment to a vport. HQoS Adjustment refers to the dynamic adjustment of the rate limit at an QoS enforcement point within router when the multicast traffic stream is disjointed from the unicast traffic stream. This QoS enforcement point within router represents the physical point further down in the access part of the network where the two streams join each other and potentially can cause congestion.
An example would be a PON port which is shared amongst subscriber’s multicast traffic (single copy of each channel) and subscriber’s unicast traffic. The bandwidth control point for this PON port resides in the upstream router BNG node in the form of a vport. In case that the multicast delivery method in the router BNG utilizes redirection, the multicast traffic in the router BNG will flow outside of the subscriber or the vport context and thus will bypass any bandwidth enforcement in the router. To correct this, a vport bandwidth adjustment is necessary in the router that will account for the multicast bandwidth consumption that is bypassing vport in the router but is present in the PON port whose bandwidth is controlled by vport.
An estimate of the multicast bandwidth consumption on the PON port can be made at the vport level based on the IGMP messages sourced from the subscribers behind the PON port. This process is called HQoS Adjustment.
A multicast channel bandwidth is subtracted from or added to the vport rate limit according to the received IGMP Join/Leave messages and the channel bandwidth definition policy associated with the vport (indirectly through a group-interface). Since the multicast traffic on the PON port is shared amongst subscribers behind this PON port, only the first IGMP Join or the last IGMP Leave per multicast channel is tracked for the purpose of the vport bandwidth modification.
The vport rate that will be affected by this functionality depends on the configuration:
- In case the agg-rate-limit within the vport is configured, its value will be modified based on the IGMP activity associated with the subscriber under this vport.
- In case the port-scheduler-policy within the vport is referenced, the max-rate defined in the corresponding port-scheduler-policy will be modified based on the IGMP activity associated with the subscriber under this vport.
The channel bandwidth definition policy is defined in the mcac policy in the configure>router>mcac>policy context. The policy is applied under the group-interface or in case of redirection under the redirected-interface.
The rates in effect can be displayed with the following two commands:
show port 1/1/5 vport name
qos scheduler-hierarchy port port-id vport vport-name
The configuration of a scheduler policy under a Vport, which is only applicable to Ethernet interfaces, is mutually exclusive with the configuration of the egress-rate-modify parameter.
The configuration of a scheduler policy under a Vport, which is only applicable to Ethernet interfaces, is mutually exclusive with the configuration of the egress-rate-modify parameter.
Default
HQoS Adjustment for vport is disabled.
host-match
Syntax
Context
Description
This command configures host matching for the Ethernet port egress queue-group.
The no form of the command removes
Parameters
port-scheduler-policy
Syntax
Context
Description
This command specifies the destination and organization strings to be used for matching subscriber hosts with this vport.
The parent vport of a subscriber host queue, which has the port-parent option enabled, is determined by matching the destination string dest string associated with the subscriber and the organization string org string associated with the subscriber host with the strings defined under a vport on the port associated with the subscriber.
If a given subscriber host queue does not have the port-parent option enabled, it will be foster-parented to the vport used by this subscriber and which is based on matching the dest string and org string. If the subscriber could not be matched with a vport on the egress port, the host queue will not be bandwidth controlled and will compete for bandwidth directly based on its own PIR and CIR parameters.
By default, a subscriber host queue with the port-parent option enabled is scheduled within the context of the port’s port scheduler policy.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command. Applying a scheduler-policy to a VPORT is only applicable to Ethernet interfaces.
The no form of the command removes the port-scheduler-policy-name from the configuration.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
Parameters
scheduler-policy
Syntax
Context
Description
This command specifies a scheduler policy to associate to the Vport. Scheduler policies are configured in the configure>qos>scheduler>policy context. Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations. The policy defines the hierarchy and operating parameters for virtual schedulers.
The no form of this command removes the configured egress scheduler policy from the VPORT.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
The configuration of a scheduler policy under a Vport is mutually exclusive with the configuration of the egress-rate-modify parameter.
Parameters
parent-location
Syntax
Context
Description
This command determines the expected location of the parent schedulers for queues configured with a parent command within the SAP egress policy. All parent schedulers must be configured within a scheduler policy applied at the location corresponding to the parent-location parameter.
If a parent scheduler name does not exist at the specified location, the queue will not be parented and will be orphaned.
Default
parent-location default
Parameters
parent-location
Syntax
Context
Description
This command determines the expected location of the parent schedulers for the tier 1 schedulers configured with a parent command within the scheduler policy. The parent schedulers must be configured within a scheduler policy applied at the location corresponding to the parent location parameter.
If a parent scheduler name does not exist at the specified location, the schedulers will not be parented and will be orphaned.
The configuration of parent-location and frame-based-accounting in a scheduler policy is mutually exclusive in to ensure consistency between the different scheduling levels.
Default
parent-location none
Parameters
If this parameter is configured within a scheduler policy that is applied to any object except for the egress of an SLA profile, the configured parent schedulers will not be found and so the tier 1 schedulers will not be parented and will be orphaned.
If this parameter is configured within a scheduler policy that is applied to to any object except for the egress of an SLA profile or SUB profile, or to the egress of a PW SAP, the configured parent schedulers will not be found and so the tier 1 schedulers will not be parented and will be orphaned.
MLD Policy Commands
mld-policy
Syntax
Context
Description
This command enables the context to create an MLD policy.
egress-rate-modify
Syntax
Context
Description
This command configures the egress rate modification.
The no form of the command removes the values from the configuration.
Parameters
fast-leave
Syntax
Context
Description
This command enables fast leave. When fast leave processing is enabled, the router will immediately remove a SAP or SDP from the IP multicast group when it detects an MLD 'leave' on that SAP or SDP. Fast leave processing allows the switch to remove a SAP or SDP that sends a 'leave' from the forwarding table without first sending out group-specific queries to the SAP or SDP, and thus speeds up the process of changing channels ('zapping').
Fast leave should only be enabled when there is a single receiver present on the SAP or SDP.
When fast leave is enabled, the configured last-member-query-interval value is ignored.
Default
no fast-leave
import
Syntax
Context
Description
This command specifies the import routing policy to be used. Only a single policy can be imported at a time.
The no form of the command removes the policy association.
Default
no import — No import policy is specified.
Parameters
max-num-groups
Syntax
Context
Description
This command defines the maximum number of multicast groups that can be joined. If the router receives a join message that would exceed the configured number of groups, the request is ignored.
Default
no max-num-groups
Parameters
max-num-grp-sources
Syntax
Context
Description
This command configures the maximum number of group sources for which MLD can have local receiver information based on received MLD reports on this interface. When this configuration is changed dynamically to a value lower than currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources will not be allowed. When this object has a value of 0, there is no limit to the number of group sources.
The no form of the command removes the value from the configuration.
Default
no max-num-grp-sources
Parameters
max-num-sources
Syntax
Context
Description
This command configures the maximum number of multicast sources allowed per group.
The no form of the command removes the value from the configuration.
Parameters
per-host-replication
Syntax
Context
Description
This command enables per-host-replication. In the per-host-replication mode, multicast traffic is replicated per each host within the subscriber irrespective of the fact that some hosts may be subscribed to the same multicast stream. As a result, in case that multiple hosts within the subscriber are registered for the same multicast group, the multicast streams of that group will be generated. The destination MAC address of multicast streams will be changed to unicast so that each host receives its own copy of the stream. Multicast traffic in the per-host-replication mode can be classified via the existing QoS CLI structure. As such the multicast traffic will flow through the subscriber queues. HQoS Adjustment is not needed in this case.
The alternative behavior for multicast replication in IPoE environment is per-SAP- replication. In this model, only a single copy of the multicast stream is sent per SAP, irrespective of the number of hosts that are subscribed to the same multicast group. This behavior applies to 1:1 connectivity model as well as on 1:N connectivity model (SAP centric behavior as opposed to subscriber centric behavior).
In the per-SAP-replication model the destination MAC address is multicast (as opposed to unicast in the per-host-replication model). Multicast traffic is flowing via the SAP queue which is outside of the subscriber context. The consequence is that multicast traffic is not accounted in the subscriber HQoS. In addition, HQoS Adaptation is not supported in the per SAP replication model.
Default
disabled
redirection-policy
Syntax
Context
Description
This command will apply multicast redirection action to the subscriber. The redirection action along with the redirected interface (and possibly service id) is defined in the referenced policy-name. MLD messages will be redirected to an alternate interface if that alternate interface has MLD enabled. The alternate interface does not have to have any multicast groups registered via MLD. Currently all MLD messages are redirected and there is no ability to selectively redirect MLD messages based on match conditions (multicast-group address, source IP address, etc.). Multicast redirection is supported between VPRN services and also between interfaces within the Global Routing Context. Multicast Redirection is not supported between the VRPN services and the Global Routing Table (GRT).
MLD state is maintained per subscriber host and per redirected interface. Traffic is however forwarded only on the redirected interface.
Default
none
Parameters
static
Syntax
Context
Description
This command adds an MLD static group membership.
group
Syntax
Context
Description
This command configures a static multicast group.
Parameters
source
Syntax
Context
Description
This command adds or removes a static multicast source.
Parameters
starg
Syntax
Context
Description
This command adds a static (*,G) entry. This command can only be enabled if no existing source addresses for this group are specified.
Use the no form of the command to remove the starg entry from the configuration.
Default
none
version
Syntax
Context
Description
This command configures the MLD version.
Parameters
IPoE Session Commands
ipoe-session-policy
Syntax
Context
Description
This command configures an IPoE session policy. The policies are referenced from subscriber interfaces, group interfaces and capture SAPs. Multiple IPoE session policies can be configured.
Default
none
Parameters
description
Syntax
Context
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command 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.
Default
no description
Parameters
session-key
Syntax
Context
Description
This command configures the key to logically group subscriber hosts that belong to the same dual stack end device in an IPoE session.
The SAP and MAC address are always part of the IPoE session key. Optionally the Circuit-Id/Interface-Id or Remote-Id can be added to the session key.
Default
session-key sap mac
Parameters
sap and mac are mandatory parameters while cid and rid are optional and mutually exclusive. Valid IPoE session key parameters are: sap mac, sap mac cid and sap mac rid.
session-timeout
Syntax
Context
Description
This command defines the time in seconds between 1 second and 360 days before the IPoE session will be disconnected. The default value is unlimited session timeout.
Default
no session-timeout
Parameters
sap
Syntax
Context
Description
This command declares a given SAP as a primary (or secondary) VPLS port.
ipoe-session
Syntax
Context
Description
This command configures IPoE session parameters.
Default
none
force-auth
Syntax
Context
Description
By default, if the circuit-id/interface-id or remote-id in the IPoE session re-authentication trigger packet (such as a DHCP renewal) is not empty and different from the circuit-id/interface-id or remote-id stored in the IPoE session data, a forced re-authentication is performed, ignoring the configured min-auth-interval. This default behavior can be changed with this command.
The no form of the command resets the default behavior.
Default
force-auth cid-change rid-change force-auth disabled on WLAN-GW group interfaces
Parameters
ipoe-session-policy
Syntax
Context
Description
This command specifies the IPoE session policy applicable for this group interface or capture SAP.
On wlan-gw group interfaces, it is not possible to change this value.
Default
no ipoe-session-policy ipoe-session-policy “default” on WLAN-GW group interfaces
Parameters
min-auth-interval
Syntax
Context
Description
Re-authentication for IPoE sessions enable dynamic policy changes.
This command configures the maximum frequency of re-authentications by specifying a minimum interval between two non-forced authentications for the same IPoE session.
A forced authentication is by default triggered by a Circuit-Id/Interface-Id or Remote-Id change (see the force-auth command).
Re-authentications are, by default, disabled and can be enabled by configuring a min-auth-interval.
Setting the min-auth-interval to zero seconds will always re-authenticate on each trigger packet.
Default
min-auth-interval infinite
Parameters
radius-session-timeout
Syntax
Context
Description
This command specifies how to interpret the session-timeout coming from a RADIUS VSA in an Access-Accept or CoA message.
The value of this command can only be changed on WLAN-GW group interfaces.
The no form of this command resets the default value.
Default
absolute backwards-compatible on WLAN-GW group interfaces
Parameters
sap-session-limit
Syntax
Context
Description
This command specifies the number of IPoE sessions per SAP allowed for this group-interface
Default
sap-session-limit 1
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
session-limit
Syntax
Context
Description
This command specifies the number of IPoE sessions allowed for this group interface or retail subscriber interface.
Default
session-limit 1
Parameters
| Note:
The operational maximum value may be smaller due to equipped hardware dependencies. |
user-db
Syntax
Context
Description
This command configures the local user database to use for IPoE session authentication.
When configured on a capture SAP, the group interface must have the same local user database configured.
On a WLAN-GW group interface, the no form of this command indicates that the user database will be picked from the following sources in the order shown:
- dhcp
- ipv6> dhcp6
- ipv6> router-solicit
If no user database can be found in any of these locations, processing continues as if no user database was configured. This behavior is for backwards compatibility reasons only; when using a LUDB, it should be explicitly added to the IPoE session configuration.
Default
no user-db
Parameters
shutdown
Syntax
Context
Description
The shutdown command enables or disables IPoE session management on a group interface or capture SAP.
A shutdown of the IPoE session CLI hierarchy on a group-interface will clear all active IPoE sessions on that interface, resulting in a deletion of all corresponding subscriber hosts.
On WLAN-GW group interfaces it is not possible to disable an IPoE session.
Default
shutdown no shutdown on WLAN-GW group interfaces
SHCV Policy Commands
shcv-policy
Syntax
Context
Description
This command configures a Subscriber Host Connectivity Verification (SHCV) policy. An SHCV policy can be applied to both the subscriber management group interface and VPLS instances. All SHCV-related features inside a group interface and a VPLS service will follow the configuration specified in the SHCV policy. The SHCV policy and the SHCV configuration on a group interface are mutually exclusive. Only one can be applied to the group interface.
The no form of the command removes the policy name from the configuration.
Default
none
Parameters
layer-3
Syntax
Context
Description
This command enables the context to configure SHCV behavior parameters for IES and VPRN services.
Default
none
source-ip-origin
Syntax
Context
Description
This command selects the source IP address to be used for SHCV messages.
The no form of the command reverts to the default.
Parameters
periodic
Syntax
Context
Description
This command configures the periodic SHCV properties for the subscriber management group-interface. This tool will periodically scan all known DHCP hosts only and perform unicast ARP/NS requests. The subscriber host connectivity verification will maintain state (connected vs. not-connected) for all hosts.
Default
none
action
Syntax
Context
Description
This command configures the action to take when the periodic connectivity verification failed.
The no form of the command reverts to the default.
Default
alarm
Parameters
interval
Syntax
Context
Description
This command specifies the time interval which all known sources should be verified. The actual rate is dependent on the number of known hosts and intervals.
The no form of the command reverts to the default.
Default
30 minutes
Parameters
retry-count
Syntax
Context
Description
This command configures the number of retransmissions.
The no form of the command reverts to the default.
Default
2
Parameters
timeout
Syntax
Context
Description
This command configures the timeout before a retransmission in triggered connectivity verification.
The no form of the command reverts to the default.
Default
10
Parameters
trigger
Syntax
Context
Description
This command enables to context to configure SHCV triggers.
Default
none
Parameters
retry-count
Syntax
Context
Description
This command configures the number of retransmissions in periodic connectivity verification.
The no form of the command reverts to the default.
Default
1
Parameters
timeout
Syntax
Context
Description
This command configures the timeout before a retransmission.
The no form of the command reverts to the default.
Default
1
Parameters
vpls
Syntax
Context
Description
This command enables the context to configure SHCV behavior in VPLS services.
source-ip
Syntax
Context
Description
This command configures the IPv4 address to be used as source address for connectivity verification in a VPLS service.
The no form of the command reverts to the default.
Default
no source-ip
Parameters
source-mac
Syntax
Context
Description
Specifies the MAC address to be used as source address for connectivity verification in a VPLS service.
The no form of the command reverts to the default.
Default
no source-mac
Parameters
Show Commands
| Note:
The command outputs in the following section are examples only; actual displays may differ depending on supported functionality and user configuration. |
diameter-peer-policy
Syntax
Context
Description
This command displays diameter peer policy information and diameter peer information and statistics. For the diameter proxy, the incoming peer can be specified with an IP address and port number.
Parameters
Output
Table 85 provides a description of the counters in the output of the show aaa diameter-peer-policy command. and Table 86 provides the failure reasons for the aggregate Failed counter (Request Rx and Answer Rx). Sample output follows the tables.
Table 85: show aaa diameter-peer-policy Field Descriptions
Counter | Counts | |
Aggregates Total | Request Tx | Aggregated countersum of all successfully transmitted diameter request messages (all applications, all message types) |
Answer Rx | Aggregated countersum of all successfully received diameter answer messages (all applications, all message types) | |
Request Rx | Aggregated countersum of all successfully received diameter request messages (all applications, all message types) | |
Answers Tx | Aggregated countersum of all successfully transmitted diameter answer messages (all applications, all message types) | |
Aggregates Failed | Request Tx | Aggregated countersum of all request messages that could not be sent for internal reasons, such as TCP socket error (for example, congestion), failure reported to application (for example, no retries left)Dropped by PythonTimeouts (requests for which no answer was received within the configured timeout interval) |
Answer Rx | Aggregated countersum of all Answer messages that failed to be successfully decoded, such as such as invalid header length or a violation against the Command Code Format (CCF) specification. See Table 86 Aggregate Failed Request Rx and Answer Rx counters for more information. | |
Request Rx | Aggregated countersum of all Request messages that failed to be successfully decoded, such as invalid header length or a violation against the Command Code Format (CCF) specificationSee Table 86 Aggregate Failed Request Rx and Answer Rx counters for more information. | |
Answers Tx | Aggregated counterSum of all answer messages that could not be sent for internal reasons such as TCP socket error (for example, congestion)Dropped by Python | |
Application ID id message type | Request Tx | successfully transmitted diameter request messages for the corresponding application and message type |
Answer Rx | successfully received diameter answer messages for the corresponding application and message type | |
Request Rx | successfully received diameter request messages for the corresponding application and message type | |
Answers Tx | successfully transmitted diameter answer messages for the corresponding application and message type | |
Table 86: Aggregate Failed Request Rx and Answer Rx counters
Role | Failed reasons |
Proxy | proxy (message length too short / too long / version unsupported) |
Consistency check failed: header size, message length, illegal flag combination, AVP header too small, AVP present but not allowed (base RFC messages), etc. | |
not a base message | |
not a request | |
Tx overload (message received to be send to client) | |
dropped by python | |
failed to create answer | |
no transaction (answer to server, but request is not found - 5 min.) | |
Diameter base / Diameter application | message dropped due to result code |
message too big / too small | |
dropped by python | |
consistency check failed | |
end-2-end mismatch hop-to-hop command code (answer/request mismatch) | |
cool down sequence drop | |
cc error request | |
application id in header error | |
T bit in header |
isa-radius-policy
Syntax
Context
Description
This command displays ISA RADIUS policy information.
Parameters
Output
Table 87: Subscriber ISA RADIUS Policy Field Descriptions
Label | Description |
Purposes Up | Indicates the RADIUS services that are up and running, and fully operational for this server. |
Source IP address | Indicates the IP address of the RADIUS server. |
Acct Tx Requests | Indicates the number of RADIUS transaction requests transmitted. |
Acct TX Retries | Indicates the number of RADIUS transaction request retries. |
Acct TX Timeouts | Indicates the number of RADIUS transaction requests that have timed out. |
Acct RX Replies | Indicates the number of RADIUS transaction responses received. |
Auth Tx Requests | Indicates the number of authentication requests transmitted. |
Auth Tx Retries | Indicates the number of authentication request retries. |
Auth Tx Timeouts | Indicates the number of RADIUS authentication requests that have timed out for the policy. |
CoA RX Requests | Indicates the number of Change-of-Authorization message responses received. |
radius-configuration
Syntax
Context
Description
This command displays RADIUS configuration information.
Output
radius-server-policy
Syntax
Context
Description
This command displays RADIUS server policy configuration information.
Parameters
Output
Table 88: Subscriber RADIUS Server Policy Field Descriptions
Label | Description |
Tx transaction requests | Indicates the number of RADIUS transaction requests transmitted. |
Rx transaction responses | Indicates the number of RADIUS transaction responses received. |
Transaction requests timed out | Indicates the number of RADIUS transaction requests that have timed out. |
Transaction requests send failed | Indicates the number of RADIUS transaction requests that could not be transmitted. |
Packet retries | Indicates the number of times a RADIUS request packet was retransmitted to a server. |
Transaction requests send rejected | Indicates the number of RADIUS transaction requests that were not transmitted due to unacceptable configuration. |
Authentication requests failed | Indicates the number of authentication failures for this policy. |
Accounting requests failed | Indicates the number of accounting failures for this policy. |
Ratio of access-reject over auth responses | Indicates the ratio of access-rejects in the auth responses for this policy. |
Transaction success ratio | Indicates the transaction success ratio for this policy. |
Transaction failure ratio | Indicates the transaction failure ratio for this policy. |
Statistics last reset at | Indicated the date and time at which the statistics for this policy were last reset. |
ancp-policy
Syntax
Context
Description
This command displays subscriber Access Node Control Protocol (ANCP) policy information.
Parameters
Output
ancp-string
Syntax
Context
Description
This command displays subscriber Access Node Control Protocol (ANCP) string information.
Parameters
<sap-id> | null | <port-id|bundle-id|bpgrp-id|lag-id|aps-id> | |
dot1q | <port-id|bundle-id|bpgrp-id|lag-id|aps-id|pw-id>:qtag1 | ||
qinq | <port-id|bundle-id|bpgrp-id|lag-id| pw-id>:qtag1.qtag2 | ||
atm | <port-id|aps-id>[:vpi/vci|vpi|vpi1.vpi2|cp.conn-prof-id] | ||
cp | keyword | ||
conn-prof-id | [1..8000] | ||
frame | <port-id|aps-id>:dlci | ||
cisco-hdlc | slot/mda/port.channel | ||
cem | slot/mda/port.channel | ||
ima-grp | <bundle-id>[:vpi/vci|vpi|vpi1.vpi2|cp.conn-prof-id] | ||
cp | keyword | ||
conn-prof-id | [1..8000] | ||
port-id | slot/mda/port[.channel] | ||
bundle-id | bundle-<type>-slot/mda.<bundle-num> | ||
bundle | keyword | ||
type | ima|fr|ppp | ||
bundle-num | [1..336] | ||
bpgrp-id | bpgrp-<type>-<bpgrp-num> | ||
bpgrp | keyword | ||
type | ima|ppp | ||
bpgrp-num | [1..2000] | ||
aps-id | aps-<group-id>[.channel] | ||
aps | keyword | ||
group-id | [1..64] | ||
ccag-id | ccag-<id>.<path-id>[cc-type]:<cc-id> | ||
ccag | keyword | ||
id | [1..8] | ||
path-id | [a|b] | ||
cc-type | [.sap-net|.net-sap] | ||
cc-id | [0..4094] | ||
eth-tunnel | eth-tunnel-<id>[:<eth-tun-sap-id>] | ||
id | [1..1024] | ||
eth-tun-sap-id | [0..4094] | ||
lag-id | lag-<id> | ||
lag | keyword | ||
id | [1..800] | ||
pw-id | pw-<id> | ||
pw | keyword | ||
id | [1..10239] | ||
qtag1 | [0..4094] | ||
qtag2 | [*|0..4094] | ||
vpi | [0..4095] (NNI) | ||
[0..255] (UNI) | |||
vci | [1|2|5..65535] | ||
dlci | [16..1022] | ||
tunnel-id | tunnel-<id>.<private|public>:<tag> | ||
tunnel | keyword | ||
id | [1..16] | ||
tag | [0..4094] | ||
Output
authentication
Syntax
Context
Description
This command displays subscriber management RADIUS authentication policy information and statistics.
Parameters
Output
Table 89: Subscriber Authentication Field Descriptions
Label | Description |
Requests Received | Indicates the number of notify Change-of-Authorization requests received. |
Requests Accepted | Indicates the number of notify Change-of-Authorization requests accepted. |
Requests Rejected | Indicates the number of notify Change-of-Authorization requests rejected. |
Requests Dropped | Indicates the number of notify Change-of-Authorization requests dropped. |
No Auth Policy found | Indicates the number of notify Change-of-Authorization requests found. |
Invalid message | Indicates the number of notify Change-of-Authorization requests rejected because of decode errors. |
Out of resources | Indicates the number of notify Change-of-Authorization requests rejected due to lack of resources. |
Authentication Failure | Indicates the number of notify Change-of-Authorization requests which do not have NAS-Port-ID or Framed-IP-Address set or have mismatched subscriber-id. |
diameter-application-policy
Syntax
Context
Description
This command displays Diameter application policy information.
Parameters
Output
diameter-session
Syntax
Context
Description
This command displays diameter session information.
ccrt-replay
Syntax
Context
Description
This command displays information about diameter Gx sessions that are in Credit-Control-Request Session-Terminate-Request (CCR-T) replay mode.
Parameters
Output
explicit-subscriber-map
Syntax
Context
Description
This command displays explicit subscriber mappings.
Output
host-lockout-policy
Syntax
Context
Description
This command displays host lockout policy information.
Parameters
Output
The following is a sample output for the host-lockout-policy command.
igmp-policy
Syntax
Context
Description
This command displays IGMP policy information and only applies to the 7750 SR.
Parameters
Output
ipoe-session-policy
Syntax
Context
Description
This command displays IPoE session policy information.
Parameters
Output
local-user-db
Syntax
Context
Description
This command displays local user database information.
Output
msap-policy
Syntax
Context
Description
This command displays Managed SAP policy information.
Output
pcc-rule
Syntax
Context
Description
This command displays a list of pcc-rules and associated monitoring keys in the system.
Parameters
Output
radius-accounting-policy
Syntax
Context
Description
This command displays RADIUS accounting policy information.
Parameters
Output
Table 90: Subscriber RADIUS Accounting Policy Field Descriptions
Label | Description |
Tx Requests/TX Reqs | Displays the number of accounting requests transmitted for this policy. |
Rx Responses/Rx Resps | Displays the number of accounting responses received for this policy. |
Request Timeouts/Req Timeouts | Displays the number of accounting requests which have timed out for this policy. |
Send Retries | Displays the number of retries to a different server for a single accounting request for this policy. |
Send Failed Req Send Failed | Displays how many accounting requests failed because the packet could not be sent out for this policy. |
Radius Servers | Displays a table in which the statistics associated with this RADIUS accounting policy are broken down by individual RADIUS server. The table columns are: Index—displays the index number assigned to the RADIUS server. The index determines the sequence in which the servers are queried for authentication requests. Servers are queried in order from lowest to highest index. IP Address—the address of the RADIUS server. TX Reqs—see TX Requests in this table. Rx Resps—see RX Responses in this table. Req Timeouts—see Request Timeouts in this table. Req Send Failed—see Send Failed in this table. |
sla-profile
Syntax
Context
Description
This command displays SLA profile information.
Parameters
Output
sla-profile
Syntax
Context
Description
This command displays the subscriber’s SLA profile scheduler stats.
Parameters
Output
port
Syntax
Context
Description
This command displays the subscriber’s SLA profile scheduler stats.
Parameters
Output
vport
Syntax
Context
Description
This command displays the vport scheduler stats.
Parameters
Output
statistics
Syntax
Context
Description
This command displays enhanced subscriber management statistics per port/pw-port/MDA/IOM/system.
For each statistic, there is current value and peak value, peak value is the highest value since last reset via system boot or command clear subscriber-mgmt peakvalue-stats.
| Note:
The peak values can be reset via the clear subscriber-mgmt peakvalue-stats command. |
Parameters
The following tables describe the counters available in the show subscriber management statistics command output.
The following terminology is used to indicate applicability of the stats:
- ESM — Enhanced Subscriber Management. Subscriber traffic forwarded via subscriber queues. Enabled with SAP sub-sla-mgmt in no shutdown state.
- BSM — Basic Subscriber Management. Subscriber traffic forwarded via SAP queues. SAP sub-sla-mgmt must be in shutdown state. For DHCP, dhcp lease-populate or dhcp6-relay lease-populate must be enabled to count the leases. For IPv4, if anti-spoof is enabled on the SAP, a subscriber host is instantiated.
- Routed CO — IES or VPRN service with subscriber-interface and group-interface constructs.
- Bridged CO — VPLS service with DHCPv4 lease management enabled (lease-populate)
- regular interface — IES or VPRN interface (none subscriber-interface or group-interface)
- Host (also subscriber host) — A resource in the system that is used for traffic forwarding and security related actions. The creation of a subscriber host entry is linked to anti-spoof being enabled on a SAP. For ESM, anti-spoof is mandatory and hence every connected {IP/MAC} consumes by default a subscriber host entry. A DHCP6 IA-PD can also be modeled as a managed route. In this case, no subscriber host is instantiated. For BSM, anti-spoof is optional on regular interfaces. An IPv4 static-host and DHCPv4 lease do not result in a subscriber host instantiation when anti-spoof is disabled on the SAP.
Table 91: Host And Protocol Statistics
Section
Counter
Counts
Applies to
IPv4
1. PPP Hosts - IPCP
IPv4 local terminated PPP hosts (PTA, LNS)
ESM, Routed CO
2. IPOE Hosts - DHCP
DHCPv4 hosts (lease states)
ESM, Routed CO, Bridged CO
3. IPOE Hosts - ARP
ARP hosts
ESM, Routed CO, Bridged CO
4. IPOE Hosts – Static
IPv4 static hosts
ESM, Routed CO, Bridged CO
5. IPOE Hosts BSM - DHCP
DHCPv4 hosts (lease states: anti-spoof and lease-populate enabled)
BSM, Routed CO, Bridged CO, regular interface
6. IPOE Hosts BSM – Static
IPv4 static hosts (with anti-spoof enabled)
BSM, Routed CO, Bridged CO, regular interface
7. IPOE BSM - DHCP
DHCPv4 lease states (with lease-populate enabled, no anti-spoof)
BSM, Routed CO, Bridged CO, regular interface
8. IPOE BSM – Static
IPv4 static hosts (no anti-spoof)
BSM, Routed CO, Bridged CO, regular interface
IPv6
PPP Hosts – SLAAC
Local terminated IPv6 wan-host – SLAAC (PTA, LNS)
ESM, Routed CO
PPP Hosts - DHCP6 (PD)
Local terminated IPv6 pd-host (PTA, LNS) – DHCP6 IA-PD leases over PPP (excluding PD as managed route)
ESM, Routed CO
PPP Hosts - DHCP6 (NA)
Local terminated IPv6 wan-host (PTA, LNS) – DHCP6 IA-NA leases over PPP
ESM, Routed CO
PPP Mngd Rt - DHCP6 (PD)
IPv6 (PTA, LNS) – DHCP6 IA-PD leases over PPP (PD as managed route only)
ESM, Routed CO
IPOE Hosts – SLAAC
IPv6 wan-host – SLAAC
ESM, Routed CO
IPOE Hosts - DHCP6 (PD)
IPv6 pd-host – DHCP6 IA-PD leases (excluding PD as managed route)
ESM, Routed CO
IPOE Hosts - DHCP6 (NA)
IPv6 wan-host – DHCP6 IA-NA leases
ESM, Routed CO
IPOE Mngd Rt - DHCP6 (PD)
IPv6 – DHCP6 IA-PD leases (PD as managed route only)
ESM, Routed CO
IPOE Hosts – Static (PD)
IPv6 static hosts with prefix-length shorter than /128
ESM, Routed CO
IPOE Hosts – Static (WAN)
IPv6 static hosts with prefix-length equal to /128
ESM, Routed CO
IPOE BSM - DHCP6 (PD)
IPv6 – DHCP6 IA-PD leases (lease-populate)
BSM, regular interface
IPOE BSM - DHCP6 (NA)
IPv6 – DHCP6 IA-NA leases (lease-populate)
BSM, regular interface
Total
PPP Hosts
Local terminated PPP hosts (PTA, LNS)
Sum of counters 1, 9, 10 and 11
ESM
IPOE Hosts
Total IPv4 and IPv6 IPOE hosts.
Sum of counters 2, 3, 4, 5, 6, 13, 14, 15, 17 and 18
ESM
IPv4 Hosts
Total IPv4 hosts. PPP (PTA, LNS) and IPOE.
Sum of counters 1, 2, 3, 4, 5 and 6
ESM
IPv6 Hosts
Total IPv6 hosts. PPP (PTA, LNS) and IPOE.
Sum of counters 9, 10, 11, 13, 14, 15, 17 and 18
ESM
IPv6 PD Mngd Routes
Total DHCP6 IA-PD leases modeled as a managed route. PPP (PTA, LNS) and IPOE.
Sum of counters 12 and 16
ESM
L2TP LAC Hosts
L2TP LAC hosts – single host per single or dual stack PPP session.
Counter also increases for outgoing LTS sessions.
ESM, Routed CO
Internal Hosts
Subscriber hosts for internal use. For example: LNS redirect hosts (for LTS, an LNS redirect host is also instantiated).
ESM
Total (Cont)
Non-Sub-Traffic L2-Hosts
Host on a single subscriber SAP in a VPLS service that enables non-IP traffic to be forwarded using the specified SLA profile instance queues.
Host on a single subscriber SAP attached to an IES/VPRN group-interface that enables traffic normally forwarded via the SAP queues to flow via the specified SLA profile instance queues.
configure service vpls <service-id> sap <sap-id> sub-sla-mgmt single-sub-parameters non-sub-traffic sub-profile <sub-profile-name> sla-profile <sla-profile-name> [subscriber <sub-ident-string>] [app-profile <app-profile-name>]
ESM, Routed CO, Bridged CO
DHCP leases
Total number of DHCPv4 lease states.
Sum of counters 2, 5 and 7
ESM, BSM
DHCPv6 leases
Total number of DHCPv6 lease states.
Sum of counters 10, 11, 12, 14, 15, 16, 19 and 20
ESM, BSM
Subscriber Hosts
Counter displayed in the output of “show subscriber-mgmt statistics iom | mda | port | pw-port”
This counter matches the number of hosts accounted for in the per line card limit
Sum of counters 1, 2, 3, 4, 5, 6, 9, 10, 11, 13, 14, 15, 17, 18 and 26
ESM
Total (Cont)
System Hosts Scale
Counter displayed in the output of “show subscriber-mgmt statistics system”
This counter matches the number of hosts accounted for in the system wide limit
Sum of counters 1, 2, 3, 4, 5, 6, 9, 10, 11, 13, 14, 15, 17, 18, 26 and 27
ESM
Table 92: PPP Session Statistics
Section
Counter
Counts
Applies to
Local
PPP Sessions - PPPoE
Local terminated PPPoE sessions (PTA)
ESM, Routed CO
PPP Sessions - PPPoEoA
Local terminated PPPoEoA sessions (PTA)
ESM, Routed CO
.PPP Sessions - PPPoA
Local terminated PPPoA sessions (PTA)
ESM, Routed CO
PPP Sessions - L2TP (LNS)
Local terminated PPP sessions (L2TP LNS)
ESM, Routed CO
LAC
PPP Sessions - PPPoE
Tunneled PPPoE session (L2TP LAC)
ESM, Routed CO
PPP Sessions - PPPoEoA
Tunneled PPPoEoA session (L2TP LAC)
ESM, Routed CO
PPP Sessions - PPPoA
Tunneled PPPoA session (L2TP LAC)
ESM, Routed CO
PPP Sessions - L2TP (LTS)
Tunneled PPP session (L2TP LTS)
ESM, Routed CO
Total
PPP Sessions - established
PPP sessions that are established (at least one active host attached) – PTA/LAC/LTS/LNS
ESM, Routed CO
PPP Sessions - in setup
PPP sessions in setup (session created, host setup in progress) – PTA/LAC/LTS/LNS
ESM, Routed CO
Total (Cont)
PPP Sessions - local
Local terminated PPPoX sessions (PTA, L2TP LNS)
Sum of counters 33, 34, 35 and 36
ESM, Routed CO
PPP Sessions - LAC
Tunneled PPPoX session (L2TP LAC, L2TP LTS)
Sum of counters 37, 38, 39 and 40
ESM, Routed CO
L2TP
L2TP Tunnels - originator
Number of L2TP Tunnels originated on this node. (LAC/ LTS)
ESM, Routed CO
.L2TP Tunnels - receiver
Number of L2TP Tunnels terminated on this node. (LNS/LTS)
ESM, Routed CO
Total L2TP Tunnels
Number of L2TP Tunnels originated or terminated on this node
Sum of counters 45 and 46
ESM, Routed CO
Table 93: IPoE Session Statistics
Section | Counter | Counts | Applies to |
Total | IPOE Sessions - established | IPoE sessions that are established (at least one active host attached). | ESM, Routed CO |
IPOE Sessions- in setup | IPoE sessions in setup (session created, host setup in progress). | ESM, Routed CO |
Table 94: Subscriber Statistics
Section | Counter | Counts | Applies to |
Total | Subscribers | Total number of active subscribers. | ESM, Routed CO, Bridged CO |
Table 95: SubMgmt Statistics Summary
Section | Counter | Counts | |
Hosts | IPv4 | Total IPv4 hosts (counter 23 in tables above) | |
IPv6 | Total IPv6 hosts (counter 24 in tables above) | ||
Sessions | PPP | Total PPP sessions - established (counter 41 in tables above) | |
IPOE | Total IPOE sessions – established (counter 48 in tables above) | ||
Subscribers | Total number of active subscribers (counter 50 in tables above) | ||
Output
sub-ident-policy
Syntax
Context
Description
This command displays subscriber identification policy information.
Parameters
Output
sub-profile
Syntax
Context
Description
This command displays subscriber profile information.
Parameters
Output
pw-port
Syntax
Context
Description
Displays pseudo-wire port information.
If no optional parameters are specified, the command displays a summary of all defined PW ports. The optional parameters restrict output to only ports matching the specified properties.
Parameters
Output
Show PW-Port
The following table describes show pw-port output fields:
Table 96: Subscriber Show PW-Port Field Descriptions
Label | Description |
PW Port | The PW Port identifier. |
Encap | The encapsulation type of the PW Port. |
SDP | The SDP identifier. |
IfIndex | The interface index used for the PW Port. |
VC-Id | The Virtual Circuit identifier. |
Description | The description string for the PW Port. |
port-scheduler-policy
Syntax
Context
Description
This command displays scheduler policy information.
Output
sap-egress
Syntax
Context
Description
This command displays SAP egress policy information.
Parameters
Output
sap-ingress
Syntax
Context
Description
This command displays SAP ingress policy information.
Parameters
Output
scheduler-hierarchy
Syntax
Context
Description
This command enables the context to display information about policies that use this scheduler.
customer
Syntax
Context
Description
This command displays the scheduler hierarchy per customer multi-service-site.
Parameters
sap
Syntax
Context
Description
This command displays the scheduler stats per SAP.
Parameters
subscriber
Syntax
Context
Description
This command displays the scheduler hierarchy rooted at the SLA profile scheduler.
Parameters
| Note:
If the SLA profile scheduler is orphaned (that is when the scheduler has a parent which does not exist) then the hierarchy is only shown when the show command includes the sla-profile and sap parameters. |
Output
scheduler-name
Syntax
Context
Description
This command displays information about the specified scheduler name.
Parameters
scheduler-policy
Syntax
Context
Description
This command displays information about the specified scheduler policy.
Parameters
Output
scheduler-stats
Syntax
Context
Description
This command enables the context to display scheduler statistics information.
Output
shared-queue
Syntax
Context
Description
This command displays shared policy information.
Output
ancp-policy
Syntax
Context
Description
This command displays subscriber ANCP policy information.
Output
ancp-string
Syntax
Context
Description
This command displays subscriber ANCP string information.
Parameters
Output
Other applicable show command output:
radius-proxy-server
Syntax
Context
Description
This command displays RADIUS proxy server information.
Parameters
Output
Table 97: Subscriber RADIUS Proxy Server Field Descriptions
Label | Description |
Invalid response Authenticator Rx packet | Displays the number of packets received by this RADIUS proxy server. |
Rx Access-Request | Displays the number of Access-Request packets received by this RADIUS proxy server. |
Rx Accounting-Request | Displays the number of Accounting-Request packets received by this RADIUS proxy server. |
Rx dropped | Displays the number of packets received by this RADIUS proxy server but dropped. |
Retransmit | Displays the number of packets received by this RADIUS proxy server that were rejected because they are retransmitted. |
Wrong purpose | Displays the number of packets received by this RADIUS proxy server that were rejected because the value of tmnxRadProxSrvPurpose is set to a value not matching the type of packet. |
No UE MAC to cache | Displays the number of packets received by this RADIUS proxy server that were rejected because the UE MAC address was not present in the packet. |
Client context limit reached | Displays the number of packets received by this RADIUS proxy server that were rejected because the limit of client contexts was reached. For each RADIUS transaction a client context is created, and will be deleted once the transaction is finished. |
No ISA RADIUS policy configured | Displays the number of packets received by this RADIUS proxy server that were rejected because it has no ISA RADIUS server policy configured for that type of packet. |
Server admin down | Displays the number of packets received by this RADIUS proxy server that were rejected because it is administratively shut down. |
No RADIUS policy configured | Displays the number of packets received by this RADIUS proxy server that were rejected because it has no RADIUS server policy configured for that type of packet. |
No load-balance-key configured | Displays the number of packets received by this RADIUS proxy server that were rejected because the selected RADIUS server policy's algorithm is set to hashBased and no load balance key is configured. |
Invalid length | Displays the number of packets received by this RADIUS proxy server that were rejected because their length was invalid. |
Invalid Code field | Displays the number of packets received by this RADIUS proxy server that were rejected because they had an invalid Code field. |
Invalid attribute encoding | Displays the number of packets received by this RADIUS proxy server that were rejected because one of the attributes was incorrectly encoded. |
Invalid User-Name | Displays the number of packets received by this RADIUS proxy server that were rejected because they contained an invalid User-Name attribute. |
Invalid password | Displays the number of packets received by this RADIUS proxy server that were rejected because the User-Password attribute could not be decoded. |
Invalid accounting Authenticator | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained an invalid Authenticator field. |
Invalid Message-Authenticator | Displays the number of packets received by this RADIUS proxy server that were rejected because they contained an invalid Message-Authenticator attribute. |
Management core overload | Displays the number of packets that were rejected by this RADIUS server because the ISA management core is not able to process any new RADIUS requests because of overload. |
No memory | Displays the number of packets that were rejected by this RADIUS server because there was not enough memory to store them. |
Accounting-Request with invalid Acct-Status-Type | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained an invalid Acct-Status-Type attribute. |
Accounting-Request with no Acct-Status-Type | Displays the number of accounting packets received by this RADIUS proxy server that were rejected because they contained no Acct-Status-Type attribute. |
Registered user overload | Displays the number of packets that were rejected by this RADIUS server because the registered user indicated to be in overload. |
Dropped by Python | Displays the number of packets received by this RADIUS proxy server but dropped by Python. |
Tx Access-Accept | Displays the number of Access-Accept packets transmitted by this RADIUS proxy server. |
Tx Access-Reject | Displays the number of Access-Reject packets transmitted by this RADIUS proxy server. |
Tx Access-Challenge | Displays the number of Access-Challenge packets transmitted by this RADIUS proxy server. |
Tx Accounting-Response | Displays the number of Accounting-Response packets transmitted by this RADIUS proxy server. |
Tx dropped | Displays the number of packets dropped by this RADIUS proxy server before transmission. |
No key to cache | Displays the number of packets that could not be cached by this RADIUS proxy server because the key information was not present in the packet. |
Cache key too long | Displays the number of packets that could not be cached by this RADIUS proxy server because the key information present in the packet was too long. |
Cache attributes too long | Displays the number of packets that could not be cached by this RADIUS proxy server because the total length of the attributes is too long. |
Reached maximum number of cache entries | Displays the number of packets that could not be cached by this RADIUS proxy server because the limit has been reached. |
No memory | Displays the number of packets that could not be transmitted by this RADIUS proxy server because there was not enough memory. |
Server timeout | Displays the number of packets that were dropped because the RADIUS servers have timed out. |
Server authentication failure | Displays the number of packets that were dropped because the RADIUS server replied with a packet which failed authentication (invalid response Authenticator or Message Authenticator attribute). |
Server invalid Code | Displays the number of packets that were dropped because the RADIUS server replied with a packet with an invalid Code field. |
Invalid attribute encoding | Displays the number of packets that were dropped because the RADIUS server replied with a packet with an invalid attribute. |
Registered user overload | Displays the number of packets that were dropped because the registered user indicated to be in overload. |
No RADIUS server configured | Displays the number of packets that were dropped by this RADIUS server because the RADIUS server policy has no servers configured. |
RADIUS server send failure | Displays the number of packets that were dropped by this RADIUS server because the packet could not get transmitted to one of the servers in the RADIUS server policy. |
Dropped by Python | Displays the number of packets that were dropped by this RADIUS server because the packet was dropped by the Python script. |
Invalid response Authenticator | Displays the number of packets that were dropped because the RADIUS server replied with a packet which failed authentication |
wpp
Syntax
Context
Description
This command displays WPP port-related information in the specified routing instance.
Parameters
Output
ipoe session
Syntax
Context
Description
This command displays the identified IPoE session details active on the specified service instance.
Parameters
Output
managed-hosts
Syntax
Context
Description
This command displays information about hosts that are not yet linked to an in-band control plane protocol, such as DHCP or DHCPv6. Examples include hosts installed by data-triggers and hosts installed by RADIUS.
Parameters
Output
The following output is an example of managed host information.
Clear Commands
ancp-sub-string
Syntax
Context
Description
This command clears subscriber ANCP data.
Parameters
arp
Syntax
Context
Description
This command clears all or specific ARP entries.
The scope of ARP cache entries cleared depends on the command line option(s) specified.
Parameters
authentication
Syntax
Context
Description
This command clears subscriber authentication data.
Parameters
diameter-session
Syntax
Context
Description
This command clears diameter session data.
ccrt-replay
Syntax
Context
Description
This command clears diameter Gx sessions that are in CCR Terminate replay mode.
Parameters
idle-only-msap
Syntax
Context
Description
This command removes all idle MSAPs associated with the MSAP policy.This command only removes idle MSAPs without active subscribers. This command is considered safer than the clear>subscr-mgmt>msap-policy msap-policy-name idle-only command because in that command, the parameter idle-only is optional. Not specifying idle-only will delete MSAPs with active subscribers.
Parameters
msap-policy
Syntax
Context
Description
This command deletes Managed SAPs (MSAPs) created by the MSAP policy.
This command can remove an MSAP with active subscribers still associated with the MSAP. Use the idle-only parameter to remove only MSAPs in an idle state.
Parameters
peakvalue-stats
Syntax
Context
Description
This command resets the most recent peak counter.
| Note:
Clearing one counter will not impact other counters. For example, clearing one IOM’s most recent peak value will not impact chassis peak value. |
Parameters
radius-accounting
Syntax
Context
Description
This command clears RADIUS accounting data for the specified policy.
Parameters
scheduler-stats
Syntax
Context
Description
This command clears scheduler statistics.
subscriber
Syntax
Context
Description
This command clears scheduler stats per subscriber.
Parameters
sla-profile
Syntax
Context
Description
This command clears the subscriber’s SLA profile scheduler stats.
Parameters
srrp
Syntax
Context
Description
This command enables the context to clear and reset SRRP virtual router instances.
interface
Syntax
Context
Description
This command clears and resets SRRP interface instances.
Parameters
statistics
Syntax
Context
Description
This command clears statistics for SRRP instances.
Parameters
route-downloader
Syntax
Context
Description
This command clears all the radius-downloaded routes from the internal downloader cache (or protocol RIB/db) (and thus eventually from the RTM itself). The parameters vprn and/or family allow to restrict the deletion of those routes learned in a particular address family (IPv4 or IPv6) and/or a particular VPRN.
By default, all VPRNs and both IPv4 and IPv6 families are affected.
| Note:
A clear of the internal protocol DB means the corresponding prefix that were deleted should be removed from the RTM (and from any other exports) as well. |
Parameters
vport
Syntax
Context
Description
This command clears the vport scheduler stats.
Parameters
ipoe session
Syntax
Context
Description
This commands clears all identified IPoE sessions for the specified service instance. All associated subscriber hosts will be deleted from the system.
Parameters
Tools Commands
tools
Syntax
Context
Description
The context to enable useful tools for debugging purposes.
Default
none
Parameters
avp-match-learned-session-id
Syntax
Context
Description
This command displays the diameter session IDs that are learned by the AVP value matching in a diameter debug.
Per avp-match id in a diameter peer policy, a single diameter session ID can be learned. "N/A" means no session ID is learned.
Output
The following is a sample output for the avp-match-learned-session-id command.
perform
Syntax
Context
Description
This command enables the context to enable tools to perform specific tasks.
Default
none
credit-reset
Syntax
Context
Description
This command resets the credit for an SLA-profile instance.
Parameters
persistence
Syntax
Context
Description
This command enables the context to configure downgrade parameters.
downgrade
Syntax
Context
Description
This command downgrades persistence files to a previous version.
Parameters
eval-msap
Syntax
Context
Description
This command re-applies the managed SAP policy to the managed SAP identified by the specified sap-id or to all managed SAPs associated with the specified msap-policy name.
Parameters
eval-lease-state
Syntax
Context
Description
This command evaluates lease state.
Parameters
subscriber-mgmt
Syntax
Context
Description
This command enables tools to control subscriber management.
edit-lease-state
Syntax
Context
Description
This command provides the parameters to edit lease state information.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
credit-reset
Syntax
Context
Description
This command resets the credit for an SLA-profile instance.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |
edit-ppp-session
Syntax
Context
Description
This command updates the data of the PPP session identified with the given MAC address and SAP identifier. Optionally the remote-id and circuit-id can be specified to identify the IPoE session to update.
| Note:
The changes take immediate effect. |
edit-slaac-host
Syntax
Context
Description
This command updates the data of the SLAAC host information
edit-ipoe-session
Syntax
Context
Description
This command updates the data of the IPoE session identified with the given MAC address and SAP identifier. Optionally the remote-id and circuit-id can be specified to identify the IPoE session to update.
| Note:
The changes take immediate effect. |
eval-ipoe-session
Syntax
Context
Description
This command re-evaluates the mapping between authentication strings such as the SLA profile string and the actual profiles for the identified IPoE sessions.
eval-ppp-session
Syntax
Context
Description
This command evaluates PPP sessions.
eval-slaac-host
Syntax
Context
Description
This command evaluates the SLAAC host.
remap-lease-state
Syntax
Context
Description
This command allows the remapping of all existing hosts if network card on CMTS/WAC side is changed is required. This command only applies to the 7750 SR.
When this command is executed, the following restrictions apply:
- When sap is taken, all leases associated with the SAP are re-written.
- For a SAP with a configured MAC in "lease-populate" command, this MAC will be taken.
- For a SAP without a configured MAC the MAC from tools command will be taken.
- For a SAP without a configured MAC and no MAC in tools command no action will be perform.
- When using the old-mac option, providing a new MAC ieee-address is mandatory.
This command is applicable only when dealing with DHCP lease states which were instantiated using l2header mode of DHCP operation.
Parameters
When configured, the SAP parameter will remap all MAC addresses of DHCP lease states on the specified SAP. When no optional MAC parameter is specified, the sap sap-id command remaps all MAC addresses of lease states towards the MAC address specified in the l2-header configuration.
re-ident-sub
Syntax
Context
Description
This command renames a subscriber identification string.
Parameters
redundancy
Syntax
Context
Description
This command enables the context to dump redundancy parameters.
multi-chassis
Syntax
Context
Description
This command enables the context to dump multi-chassis parameters.
mc-endpoint
Syntax
Context
Description
This command dumps multi-chassis endpoint information.
Parameters
force-switchover
Syntax
Context
Description
This command manually switches over mc-ipsec mastership of the specified tunnel-group.
Parameters
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring information.
Parameters
srrp-sync-database
Syntax
Context
Description
This command dumps SRRP database information and only applies to the 7450 ESS and 7750 SR.
Parameters
sync-database
Syntax
Context
Description
This command dumps MCS database information.
Parameters
dhcp-server: | local dhcp server (7450 ESS and 7750 SR only) |
igmp: | Internet group management protocol |
igmp-snooping: | igmp-snooping |
mc-ring: | multi-chassis ring |
mld-snooping: | multicast listener discovery-snooping |
srrp: | simple router redundancy protocol (7450 ESS and 7750 SR only) |
sub-host-trk: | subscriber host tracking (7450 ESS and 7750 SR only) |
sub-mgmt: | subscriber management (7450 ESS and 7750 SR only) |
mc-ipsec
Syntax
Context
Description
This command enters the mc-ipsec context.
mc-endpoint
Syntax
Context
Description
This command dumps multi-chassis endpoint information.
Parameters
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring information.
Parameters
srrp-sync-database
Syntax
Context
Description
This command dumps SRRP database information and only applies to the 7450 ESS and 7750 SR.
Parameters
sync-database
Syntax
Context
Description
This command dumps MCS database information.
Parameters
dhcp-server: | local dhcp server (7450 ESS and 7750 SR only) |
igmp: | Internet group management protocol |
igmp-snooping: | igmp-snooping |
mc-ring: | multi-chassis ring |
mld-snooping: | multicast listener discovery-snooping |
srrp: | simple router redundancy protocol (7450 ESS and 7750 SR only) |
sub-host-trk: | subscriber host tracking (7450 ESS and 7750 SR only) |
sub-mgmt: | subscriber management (7450 ESS and 7750 SR only) |
forcerenew
Syntax
Context
Description
This command forces the renewal of lease state and only applies to the 7450 ESS and 7750 SR
Parameters
local-user-db
Syntax
Context
Description
This command provides tools to control the local user database.
ipoe
Syntax
Context
Description
This command provides the tools to control IPoE entries in the local user database.
host-lookup
Syntax
Context
Description
This command performs a lookup in the local user database.
ppp
Syntax
Context
Description
This command provides the tools to control PPPoE entries in the local user database.
authentication
Syntax
Context
Description
This command authenticates the PPPoE user name.
host-lookup
Syntax
Context
Description
This command performs a lookup in the local user database.
mc-ring
Syntax
Context
Description
This command dumps multi-chassis ring data.
sync-database
Syntax
Context
Description
This command dumps multi-chassis sync database information.
Parameters
sync-database-reconcile
Syntax
Context
Description
This command provides the paramwters to reconcile MCS database entries.
srrp-sync-data
Syntax
Context
Description
This command dumps multi-chassis SRRP sync database information.
Parameters
route-downloader
Syntax
Context
Description
This command causes the download process to start immediately. If an ongoing download is already in progress then no further action is needed, except if the force keyword is added. In case the force keyword is added, then the current download is aborted and a new one is immediately restarted. If aborting the current download, the internal route table should not be emptied or cleared.
Parameters
router
Syntax
Context
Description
This command enables the context for tools dump commands in the specified routing instance.
Parameters
ipoe-session
Syntax
Context
Description
This command enables the context for IPoE session-related tools dump commands in the specified routing instance.
migration
Syntax
Context
Description
This command displays details on the IPoE session migration progress. It shows per group interface the number of hosts per type (DHCPv4, DHCPv6 and SLAAC) that are associated with an IPoE session or that are not associated with an IPoE session.
Output
The following is a sample output for the migration command.
Debug Commands
diameter
Syntax
Context
Description
This command enables debugging for diameter.
dest-realm
Syntax
Context
Description
This command restricts the output to a specific destination-realm.
Parameters
detail-level
Syntax
Context
Description
This command configures the detail level of debug output.
Parameters
diameter-peer
Syntax
Context
Description
This command restricts output to a specific peer.
Parameters
diameter-peer-policy
Syntax
Context
Description
This command restricts the debug output to messages on peers of a specific diameter peer policy. Up to eight diameter peer policies can be specified.
The no form of the command removes the specified diameter peer policy and all debug statement under this policy from the debug configuration.
Parameters
avp-match
Syntax
Context
Description
This command restricts the debug output to messages within the diameter peer policy that belong to a diameter session identified based on the AVP value matching in a diameter application message.At least the message type and one AVP match criteria must be specified in an avp-match id command.
If a diameter application message matches all criteria within one AVP match ID, then the session ID is learned and all subsequent messages of that diameter session are shown until a relearning occurs. (OR function between avp-match id commands.)
When the session ID is learned in an Answer message, an attempt is made to include the corresponding Request message in the debug output: The Request message should still be available in the system and must pass all debug filters (such as message-type).
By default an avp-match id is disabled and must be configured with the debug>diameter>diameter-peer-policy>avp-match no shutdown to activate.
Parameters
avp
Syntax
Context
Description
This command specifies an AVP match criteria for AVP value matching. At least one and up to five AVP match criteria can be specified in an avp-match id command. When multiple AVP match criteria are specified, they must all match to be successful and result in a diameter session ID learning. (AND function between avp avp-id commands.)
The AVP in an AVP match criteria is identified by its AVP ID. The AVP ID is specified as [vendor-id-]avp-code[.avp-id] with nesting up to five levels deep.
The format type of the AVP should match the standard documents in which the AVP is specified. Any AVP can be specified as an octet string in hex format.
Parameters
message-type
Syntax
Context
Description
This command specifies the message type match criteria for AVP value matching. Only specified diameter application messages are used for AVP value matching. This is a mandatory criteria in an avp-match id command.This command does not restrict the debug output to the specified messages.
Parameters
shutdown
Syntax
Context
Description
Enables or disables the avp-match id criteria for filtering debug output based on AVP value matching.A shutdown of the avp-match id will clear the learned diameter session ID.
diameter-peer
Syntax
Context
Description
This command restricts the debug output to messages on a specific peer within the diameter peer policy. Overrides the debug>diameter>diameter-peer debug command for the specified diameter peer policy. A single peer can be specified per diameter peer policy.
When no peer is specified at the diameter peer policy level, the debug output is restricted to the peer configured at the debug>diameter level.
The no form of the command removes the peer from the debug>diameter>diameter-peer-policy debug output.
Parameters
message-type
Syntax
Context
Description
This command restricts the debug output to the specified message types.
When specified within a diameter peer policy, it overrides the message type configuration at the debug>diameter level for messages received and sent on that diameter peer policy.
The no form of the command removes the message type from the debug configuration.
Parameters
origin-realm
Syntax
Context
Description
This command restricts output to a specific origin-realm.
arp-host
Syntax
Context
Description
This command enables and configures ARP host debugging.
The no form of the command disables ARP host debugging.
one-time-http-redirection
Syntax
Context
Description
This command produces one-time http redirection debug output.
ppp
Syntax
Context
Description
This command enables the PPP debug context.
event
event
Syntax
Context
Description
This command enables the PPP event debug context.
dhcp-client
Syntax
Context
Description
This command enable PPP event debug for DHCP client.
Parameters
l2tp
Syntax
Context
Description
This command enables PPP L2TP event debug.
Parameters
local-address-assignment
Syntax
Context
Description
This command enables debugging for local-address-assignment events.
The no form of the command disables debugging.
Parameters
ppp
Syntax
Context
Description
This command enables PPP event debug.
The no form of the command disables debugging.
Parameters
mac
Syntax
Context
Description
This command displays PPP packets for a particular MAC address.
The no form of the command disables debugging.
msap
Syntax
Context
Description
This command enables debugging for specific PPP MSAPs.
The no form of the command disables debugging.
packet
Syntax
Context
Description
This command enables the PPP packet debug context.
The no form of the command disables debugging.
detail-level
Syntax
Context
Description
This command specify the detail level of PPP packet debug output.
The no form of the command disables debugging.
dhcp-client
Syntax
Context
Description
This command enables packet debug output for DHCP client of the PPP session
The no form of the command disables debugging.
discovery
Syntax
Context
Description
This command enables PPP discovery packet debug output.
The no form of the command disables debugging.
Parameters
mode
Syntax
Context
Description
This command specifies PPP packet debug mode.
The no form of the command disables debugging.
Parameters
ppp
Syntax
Context
Description
This command enables PPP discovery packet debug output for the specified PPP protocol.
The no form of the command disables debugging.
Parameters
remote-id
Syntax
Context
Description
This command enables debugging for specific PPP remote-ids.
The no form of the command disables debugging.
sap
Syntax
Context
Description
This command enables PPP debug output for the specified SAP, this command allow multiple instances.
The no form of the command disables debugging.
Parameters
username
Syntax
Context
Description
This command enable PPP debug for the specified username. since not all PPP packets contain username, so a mac debug filter will be created automatically when system sees a PPP packet contain the specified username.
Multiple username filters can be specified in the same debug command.
The no form of the command disables debugging.
Parameters
circuit-id
Syntax
Context
Description
This command enable PPP debug for the specified circuit-id.
Multiple circuit-id filters can be specified in the same debug command.
The no form of the command disables debugging.
Parameters
remote-id
Syntax
Context
Description
This command enable PPP debug for the specified remote-id.
Multiple remote-id filters could be specified in the same debug command.
Parameters
msap
Syntax
Context
Description
This command enable PPP debug for the specified managed SAP.
Multiple msap filters could be specified in the same debug command.
Parameters
authentication
Syntax
Context
Description
This command debugs subscriber authentication.
Parameters
sub-ident-policy
Syntax
Context
Description
This command debugs subscriber identification policies.
Parameters
script-compile-error
Syntax
Context
Description
This command send the traceback of the compile error to the logger. The traceback contains detailed information about where and why the compilation fails. The compilation takes place when the CLI user changes the admin state of the Python URL from shutdown to no-shutdown.
script-export-variables
Syntax
Context
Description
This command sends the result (the three output variables) of the Python script to the logger when the script ran successfully.
script-output
Syntax
Context
Description
This command sends the output (such as from 'print' statements) of the Python script to the logger.
script-output-on-error
Syntax
Context
Description
This command sends the output (such as from 'print' statements) of the Python script to the logger, but only when the script fails.
script-runtime-error
Syntax
Context
Description
This command sends the traceback of the Python script failure to the logger.
script-all-info
Syntax
Context
Description
This command enables the script-compile-error, script-export-variables, script-output, script-output-on-error, and script-runtime-error functionalities.
srrp
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
events
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
packets
Syntax
Context
Description
This command enables debugging for SRRP packets.
The no form of the command disables debugging.
radius
Syntax
Context
Description
This command enables the debug router RADIUS context.
detail-level
Syntax
Context
Description
This command specifies the output detail level of command debug router radius.
Default
medium
Parameters
packet-type
Syntax
Context
Description
This command specifies the RADIUS packet type filter of command debug router radius
Default
authentication accounting coa
Parameters
radius-attr
Syntax
Context
Description
This command specifies the RADIUS attribute filter of command debug router radius.
Default
none
Parameters
address | <ipv4-address>|<ipv6-address>| <ipv6-prefix/prefix-length> | |
ipv4-address | a.b.c.d | |
ipv6-address | x:x:x:x:x:x:x:x (eight 16-bit pieces) | |
ipv6-prefix | x:x:x:x:x:x:x:x (eight 16-bit pieces) | |
x:x:x:x:x:x:d.d.d.d | ||
x - [0..FFFF]H | ||
d - [0..255]D | ||
ipv6-prefix-length [0..128] | ||
hex | [0x0..0xFFFFFFFF...(max 506 hex nibbles)] | |
integer | [0..4294967295] | |
string | ascii-string (max 253 chars) | |
wpp
Syntax
Context
Description
This command enables the context to configure WPP debugging parameters.
packet
Syntax
Context
Description
This command enables WPP packet debugging.
detail-level
Syntax
Context
Description
This command specifies the detail level of WPP packet debugging.
Parameters
portal
Syntax
Context
Description
This command enables WPP debugging for the specified WPP portal.
Parameters
Monitor Commands
subscriber
Syntax
Context
Description
This command monitors statistics for a subscriber.
Parameters
Output
host
Syntax
Context
Description
This command displays static host information configured on this service.
Parameters
service-id: | 1 — 2147483647 |
svc-name: | 64 characters maximum |