p Commands – Part II
pim-ssm-scaling
pim-ssm-scaling
Syntax
[no] pim-ssm-scaling
Context
[Tree] (config>router>pim pim-ssm-scaling)
Full Context
configure router pim pim-ssm-scaling
Description
This command enables an increase of PIM SSM (S,G) scaling to a maximum of 256kper system. The per-complex (FP) multicast scaling limit is still in place, but multiple complexes can be used to achieve the 256k per-system (S,G) scaling.
The no form of this command disables the increase in PIM SSM scaling.
Default
no pim-ssm-scaling
Platforms
7705 SAR Gen 2
ping
ping
Syntax
ping ip-address | dns-name [bypass-routing | {interface interface-name} | {next-hop ip-address}] [{router router-or-service} | {router-instance router-instance} | {service-name service-name}] [source ip-address] [count requests] [detail | rapid] [do-not-fragment] [fc fc-name] [interval centisecs | secs] [pattern pattern] [size bytes] [timeout timeout] [tos type-of-service] [ttl time-to-live]
ping ipv4-address subscriber-id sub-ident-string [{router router-or-service} | {router-instance router-instance} | {service-name service-name}] [source ip-address] [count requests] [detail | rapid] [do-not-fragment] [fc fc-name] [interval centisecs | secs] [pattern pattern] [size bytes] [timeout timeout] [tos type-of-service] [ttl time-to-live]
ping srv6-policy color color endpoint ipv6-address [segment-list segment-list] [candidate-path protocol-owner static | bgp [preference preference] [distinguisher distinguisher]] [count requests] [detail | rapid] [do-not-fragment] [fc fc-name] [interval centisecs | secs] [pattern pattern] [size bytes] [timeout timeout] [tos type-of-service] [ttl time-to-live]
Context
[Tree] (ping)
Full Context
ping
Description
This command sends a ping to a destination to verify IP reachability.
Use the ping {ip-address | dns-name} [{bypass-routing | {interface interface-name} | {next-hop ip-address}}] command syntax to send a generic ping. This is the basic TCP/IP utility to verify IP reachability.
Use the ping ipv4-address subscriber-id sub-ident-string command syntax to send a ping to verify L2-Aware remote host reachability.
The L2-Aware form of this command can be initiated from the gateway IPv4 address in the inside routing context or from any IPv4 address in the outside routing context. If the gateway IPv4 address is used as the source address, it must be explicitly specified in conjunction with the L2-Aware syntax.
Any source address can be used for the ping to test the relevant NAT policy. If the source address refers to a policy that is not configured on the router, the message "MINOR: OAM #2160 router ID is not an outside router for this subscriber” is displayed. The source address does not need to belong to the system.
If the outside routing context is not specified, by default, the Base router is selected. If the specified or default Base router instance is not the outside routing context for the subscriber, the L2-Aware form of this command fails to execute, and the message "MINOR: OAM #2160 router ID is not an outside router for this subscriber” is displayed.
The NAT application shares query IDs between L2-Aware pings and ICMP or GRE traffic that has undergone NAT and is destined for a DMZ host. If there is query ID space exhaustion, ICMP or GRE flows destined for DMZ hosts are deleted, so their query IDs can be reused for the requested L2-Aware pings.
Use the ping srv6-policy color color endpoint ipv6-address command syntax to launch a ping for an SRv6 policy matching a specific color and endpoint. The ping probe may optionally be targeted at a specific segment list of the SRv6 policy. When the segment list is not specified, the ping probe is sent on the lowest available segment list.
Parameters
- bypass-routing
-
Specifies whether to send the ping request to a host on a directly attached network, bypassing the routing table.
- bytes
-
Specifies the request packet size in bytes, expressed as a decimal integer.
- candidate-path
-
Specifies a candidate path of the SRv6 policy to ping. The candidate path does not need to be the currently active candidate path.
- centiseconds
-
Sets the interval in centiseconds.
- detail
-
Displays detailed information.
- distinguisher
- Specifies the distinguisher of the SRv6 policy candidate path to send the ping probe on. This parameter must be configured if protocol-owner is configured to bgp.
- do-not-fragment
-
Sets the DF (Do Not Fragment) bit in the ICMP ping packet (does not apply to ICMPv6).
- dns-name
-
Specifies the DNS name of the far-end device on which to send the svc-ping request message, expressed as a character string.
- fc-name
-
Specifies the forwarding class of the MPLS echo request packets.
- interface-name
-
Specifies the name of an IP interface. The name must already exist in the configure router interface context.
- ip-address
-
Specifies the far-end IP address, in dotted decimal notation, on which to send the svc-ping request message.
- next-hop ip-address
-
Displays only static routes with the specified next hop IP address.
- pattern
-
Specifies that the date portion in a ping packet that is filled with the pattern value specified. If not specified, position information is filled instead.
- preference
- Specifies the preference of the SRv6 policy candidate path to send the ping probe on.
- protocol-owner
- Specifies the protocol owner of the SRv6 policy candidate path to ping.
- rapid
-
Specifies that packets be generated as fast as possible instead of the default 1 per second. Changes the units for the interval command from seconds to centiseconds.
- requests
-
Specifies the number of times to perform an OAM ping probe operation. Each OAM echo message request must either time out or receive a reply before the next message request is sent.
- router-instance
-
Specifies the preferred method for entering a service name. Stored as the service name. This is the only service-linking function allowed for both mixed-mode and model-driven configuration modes.
- router-or-service
-
Specifies the routing instance or service, by number. The router-instance parameter is preferred for specifying the router or service.
- seconds
-
Overrides the default timeout value and is the amount of time that the router waits for a message reply after sending the message request. Upon the expiration of the message time out, the requesting router assumes that the message response is not received. A request timeout message is displayed by the CLI for each message request sent that expires. Any response received after the request times out is silently discarded.
- secs
-
Sets the interval in seconds.
- service-name
-
Specifies the alias function that allows the service-name to be used, converted, and stored as a service ID.
- sub-ident-string
-
Specifies the L2-Aware NAT subscriber to which ICMP-ping is sent, up to 32 characters. The subscriber-id keyword serves as a differentiator between the subscribers with the same IP address in the same routing context (which is allowed in L2-Aware NAT). The subscriber-id keyword is mandatory for L2-Aware IPv4 ping, but optional in generic ping framework.
- source ip-address
-
Specifies the IP address to be used.
- timeout
-
Specifies the time out, in seconds.
- type-of-service
-
Specifies the service type.
- time-to-live
-
Specifies the TTL value for the MPLS label, expressed as a decimal integer.
- srv6-policy
- Keyword to specify that the ping probe is applied to an SRv6 policy.
- color-id
- Specifies the SRv6 policy color ID.
- endpoint ipv6-address
- Specifies an endpoint as the target of the ping.
- segment-list
- Specifies the segment list to trace.
Platforms
7705 SAR Gen 2
ping-reply
ping-reply
Syntax
[no] ping-reply
Context
[Tree] (config>service>ies>if>ipv6>vrrp ping-reply)
Full Context
configure service ies interface ipv6 vrrp ping-reply
Description
This command enables the non-owner master to reply to ICMP echo requests directed at the virtual router instances IP addresses. The ping request can be received on any routed interface.
Ping must not have been disabled at the management security level (either on the parental Ip interface or based on the ping source host address). when ping-reply is not enabled, icmp Echo Requests to non-owner master virtual IP addresses are silently discarded.
Non-owner backup virtual routers never respond to ICMP echo requests regardless of the setting of ping-reply configuration.
The ping-reply command is only available in non-owner vrrp virtual-router-id nodal context. If the ping-reply command is not executed, ICMP echo requests to the virtual router instance IP addresses will be silently discarded.
The no form of this command restores the default operation of discarding all ICMP echo request messages destined to the non-owner virtual router instance IP addresses.
Default
no ping-reply
Platforms
7705 SAR Gen 2
ping-reply
Syntax
[no] ping-reply
Context
[Tree] (config>service>ies>if>vrrp ping-reply)
Full Context
configure service ies interface vrrp ping-reply
Description
This command enables the non-owner master to reply to ICMP Echo Requests directed at the virtual router instances IP addresses. The ping request can be received on any routed interface.
Ping must not have been disabled at the management security level (either on the parental IP interface or based on the Ping source host address). When ping-reply is not enabled, ICMP Echo Requests to non-owner master virtual IP addresses are silently discarded.
Non-owner backup virtual routers never respond to ICMP Echo Requests regardless of the setting of ping-reply configuration.
The ping-reply command is only available in non-owner vrrp virtual-router-id nodal context. If the ping-reply command is not executed, ICMP Echo Requests to the virtual router instance IP addresses will be silently discarded.
The no form of this command restores the default operation of discarding all ICMP Echo Request messages destined to the non-owner virtual router instance IP addresses.
Default
no ping-reply
Platforms
7705 SAR Gen 2
ping-reply
Syntax
[no] ping-reply
Context
[Tree] (config>service>vprn>if>ipv6>vrrp ping-reply)
[Tree] (config>service>vprn>if>vrrp ping-reply)
Full Context
configure service vprn interface ipv6 vrrp ping-reply
configure service vprn interface vrrp ping-reply
Description
This command enables the non-owner master to reply to ICMP Echo Requests directed at the virtual router instances IP addresses. The ping request can be received on any routed interface.
Ping must not have been disabled at the management security level (either on the parental IP interface or based on the Ping source host address). When ping-reply is not enabled, ICMP Echo Requests to non-owner master virtual IP addresses are silently discarded.
Non-owner backup virtual routers never respond to ICMP Echo Requests regardless of the setting of ping-reply configuration.
The ping-reply command is only available in non-owner vrrp virtual-router-id nodal context. If the ping-reply command is not executed, ICMP Echo Requests to the virtual router instance IP addresses will be silently discarded.
The no form of this command restores the default operation of discarding all ICMP Echo Request messages destined to the non-owner virtual router instance IP addresses.
Default
no ping-reply
Platforms
7705 SAR Gen 2
ping-reply
Syntax
[no] ping-reply
Context
[Tree] (config>router>if>vrrp ping-reply)
[Tree] (config>router>if>ipv6>vrrp ping-reply)
Full Context
configure router interface vrrp ping-reply
configure router interface ipv6 vrrp ping-reply
Description
This command enables the non-owner master to reply to ICMP echo requests directed at the virtual router instances IP addresses.
Non-owner virtual router instances are limited by the VRRP specifications to responding to ARP requests destined to the virtual router IP addresses and routing IP packets not addressed to the virtual router IP addresses. Many network administrators find this limitation frustrating when troubleshooting VRRP connectivity issues.
SR OS allows this access limitation to be selectively lifted for certain applications. Ping, Telnet and SSH can be individually enabled or disabled on a per-virtual-router-instance basis.
The ping-reply command enables the non-owner master to reply to ICMP echo requests directed at the virtual router instances IP addresses. The Ping request can be received on any routed interface. Ping must not have been disabled at the management security level (either on the parental IP interface or based on the Ping source host address).
When ping-reply is not enabled, ICMP echo requests to non-owner master virtual IP addresses are silently discarded.
Non-owner backup virtual routers never respond to ICMP echo requests regardless of the ping-reply setting.
The ping-reply command is only available in non-owner vrrp nodal context.
By default, ICMP echo requests to the virtual router instance IP addresses are silently discarded.
The no form of the command configures discarding all ICMP echo request messages destined to the non-owner virtual router instance IP addresses.
Default
no ping-reply — ICMP echo requests to the virtual router instance IP addresses are discarded.
Platforms
7705 SAR Gen 2
ping-test
ping-test
Syntax
[no] ping-test
Context
[Tree] (config>filter>redirect-policy>dest ping-test)
Full Context
configure filter redirect-policy destination ping-test
Description
This command configures parameters to perform connectivity ping tests to validate the ability for the destination to receive redirected traffic.
Default
no ping-test
Platforms
7705 SAR Gen 2
pki
pki
Syntax
pki
Context
[Tree] (config>system>security pki)
Full Context
configure system security pki
Description
Commands in this context configure PKI related parameters.
Platforms
7705 SAR Gen 2
pkt-too-big
pkt-too-big
Syntax
[no] pkt-too-big
Context
[Tree] (config>service>vprn>if>ipsec>ipsec-tunnel>icmp6-gen pkt-too-big)
[Tree] (config>ipsec>tnl-temp>icmp6-gen pkt-too-big)
[Tree] (config>service>ies>if>ipsec>ipsec-tunnel>icmp6-gen pkt-too-big)
[Tree] (config>service>vprn>if>sap>ipsec-tun>icmp6-gen pkt-too-big)
Full Context
configure service vprn interface ipsec ipsec-tunnel icmp6-generation pkt-too-big
configure ipsec tunnel-template icmp6-generation pkt-too-big
configure service ies interface ipsec ipsec-tunnel icmp6-generation pkt-too-big
configure service vprn interface sap ipsec-tunnel icmp6-generation pkt-too-big
Description
This command enables the system to send ICMPv6 PTB (Packet Too Big) messages on the private side and optionally specifies the rate.
With this command configured, the system sends PTB back if it received an IPv6 packet on the private side that is bigger than 1280 bytes and also exceeds the private MTU of the tunnel.
The ip-mtu command (under ipsec-tunnel or tunnel-template) specifies the private MTU for the ipsec-tunnel or dynamic tunnel.
The no form of this command reverts interval and message-count values to their default values.
Platforms
7705 SAR Gen 2
platform-type
platform-type
Syntax
platform-type type
no platform type
Context
[Tree] (config>system>ned>profile platform-type)
Full Context
configure system network-element-discovery profile platform-type
Description
This command configures the platform name and chassis type to be advertised.
The no form of this command removes any explicitly defined type and the default type of "chassis-name, chassis-type" is used.
Default
no platform-type
Parameters
- type
-
Specifies the platform type to be associates with the profile, up to 255 characters.
Platforms
7705 SAR Gen 2
pmtu-discovery-aging
pmtu-discovery-aging
Syntax
pmtu-discovery-aging seconds
no pmtu-discovery-aging
Context
[Tree] (config>service>vprn>if>sap>ip-tunnel pmtu-discovery-aging)
[Tree] (config>service>ies>if>ipsec>ipsec-tunnel pmtu-discovery-aging)
[Tree] (config>service>vprn>if>sap>ipsec-tunnel pmtu-discovery-aging)
[Tree] (config>router>if>ipsec>ipsec-tunnel pmtu-discovery-aging)
[Tree] (config>ipsec>tnl-temp pmtu-discovery-aging)
[Tree] (config>service>vprn>if>ipsec>ipsec-tunnel pmtu-discovery-aging)
[Tree] (config>service>ies>if>sap>ip-tunnel pmtu-discovery-aging)
Full Context
configure service vprn interface sap ip-tunnel pmtu-discovery-aging
configure service ies interface ipsec ipsec-tunnel pmtu-discovery-aging
configure service vprn interface sap ipsec-tunnel pmtu-discovery-aging
configure router interface ipsec ipsec-tunnel pmtu-discovery-aging
configure ipsec tunnel-template pmtu-discovery-aging
configure service vprn interface ipsec ipsec-tunnel pmtu-discovery-aging
configure service ies interface sap ip-tunnel pmtu-discovery-aging
Description
This command configures the time used to age out the learned temporary MTU which is from the public network. The temporary MTU is used for MTU propagation.
The no form of of this command reverts to the default value.
Default
pmtu-discovery-aging 900
Parameters
- seconds
-
specifies the time, in seconds, used to age out the learned MTU
Platforms
7705 SAR Gen 2
poi-tlv-enable
poi-tlv-enable
Syntax
[no] poi-tlv-enable
Context
[Tree] (config>service>vprn>isis poi-tlv-enable)
Full Context
configure service vprn isis poi-tlv-enable
Description
Enable use of Purge Originator Identification (POI) TLV for this IS-IS instance. The POI is added to purges and contains the system ID of the router that generated the purge, which simplifies troubleshooting and determining what caused the purge.
The no form of this command removes the POI functionality from the configuration.
Default
no poi-tlv-enable
Platforms
7705 SAR Gen 2
poi-tlv-enable
Syntax
[no] poi-tlv-enable
Context
[Tree] (config>router>isis poi-tlv-enable)
Full Context
configure router isis poi-tlv-enable
Description
Enable use of Purge Originator Identification (POI) TLV for this IS-IS instance. The POI is added to purges and contains the system ID of the router that generated the purge, which simplifies troubleshooting and determining what caused the purge.
The no form of this command removes the POI functionality from the configuration.
Default
no poi-tlv-enable
Platforms
7705 SAR Gen 2
policer
policer
Syntax
policer policer-id [create]
no policer policer-id
Context
[Tree] (config>card>fp>ingress>network>qgrp>policer-over policer)
[Tree] (config>card>fp>ingress>access>qgrp>policer-over policer)
Full Context
configure card fp ingress network queue-group policer-override policer
configure card fp ingress access queue-group policer-override policer
Description
This command creates, modifies or deletes 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 fails.
The no form of this command deletes 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
- policer-id
-
Specifies that the policer-id must be specified when executing the policer command. If the specified ID already exists, the system enters that policer's context to allow the policer’s parameters to be modified. If the ID does not exist and is within the allowed range for the QoS policy type, a context for the policer ID will be created (depending on the system's current create keyword requirements which may require the create keyword to actually add the new policer ID to the QoS policy) and the system will enter that new policer’s context for possible parameter modification.
Platforms
7705 SAR Gen 2
policer
Syntax
policer policer-id [create]
no policer policer-id
Context
[Tree] (config>service>epipe>sap>egress>policer-over policer)
Full Context
configure service epipe sap egress policer-override policer
Description
This command, within the SAP ingress or egress contexts, is used to create a CLI node for specific overrides to a specific policer created on the SAP through a sap-ingress or sap-egress QoS policy.
The no form of this command is used to remove any existing overrides for the specified policer-id.
Parameters
- policer-id
-
The policer-id parameter is required when executing the policer command within the policer-overrides context. The specified policer-id must exist within the sap-ingress or sap-egress QoS policy applied to the SAP. If the policer is not currently used by any forwarding class or forwarding type mappings, the policer will not actually exist on the SAP. This does not preclude creating an override context for the policer-id.
- create
-
The create keyword is required when a policer policer-id override node is being created and the system is configured to expect explicit confirmation that a new object is being created. When the system is not configured to expect explicit confirmation, the create keyword is not required.
Platforms
7705 SAR Gen 2
policer
Syntax
policer policer-id [create]
no policer policer-id
Context
[Tree] (config>service>vpls>sap>egress>policer-override policer)
[Tree] (config>service>vpls>sap>ingress>policer-override policer)
Full Context
configure service vpls sap egress policer-override policer
configure service vpls sap ingress policer-override policer
Description
This command, within the SAP ingress or egress contexts, is used to create a CLI node for specific overrides to a specific policer created on the SAP through a sap-ingress or sap-egress QoS policy.
The no form of this command is used to remove any existing overrides for the specified policer-id.
Parameters
- policer-id
-
The policer-id parameter is required when executing the policer command within the policer-overrides context. The specified policer-id must exist within the sap-ingress or sap-egress QoS policy applied to the SAP. If the policer is not currently used by any forwarding class or forwarding type mappings, the policer will not actually exist on the SAP. This does not preclude creating an override context for the policer-id.
- create
-
The create keyword is required when a policer policer-id override node is being created and the system is configured to expect explicit confirmation that a new object is being created. When the system is not configured to expect explicit confirmation, the create keyword is not required.
Platforms
7705 SAR Gen 2
policer
Syntax
policer policer-id [create]
no policer policer-id
Context
[Tree] (config>service>ies>if>sap>ingress>policer-override policer)
[Tree] (config>service>ies>if>sap>egress>policer-override policer)
Full Context
configure service ies interface sap ingress policer-override policer
configure service ies interface sap egress policer-override policer
Description
This command, within the SAP ingress or egress contexts, is used to create a CLI node for specific overrides to a specific policer created on the SAP through a sap-ingress or sap-egress QoS policy.
The no form of this command is used to remove any existing overrides for the specified policer-id.
Parameters
- policer-id
-
This parameter is required when executing the policer command within the policer-override context. The specified policer-id must exist within the sap-ingress or sap-egress QoS policy applied to the SAP. If the policer is not currently used by any forwarding class or forwarding type mappings, the policer will not actually exist on the SAP. This does not preclude creating an override context for the policer-id.
- create
-
The create keyword is required when a policer override node is being created and the system is configured to expect explicit confirmation that a new object is being created. When the system is not configured to expect explicit configuration, the create keyword is not required.
Platforms
7705 SAR Gen 2
policer
Syntax
policer policer-id [create]
no policer policer-id
Context
[Tree] (config>service>vprn>if>sap>ingress>policer-override policer)
[Tree] (config>service>vprn>if>sap>egress>policer-override policer)
Full Context
configure service vprn interface sap ingress policer-override policer
configure service vprn interface sap egress policer-override policer
Description
This command, within the SAP ingress or egress contexts, is used to create a CLI node for specific overrides to a specific policer created on the SAP through a sap-ingress or sap-egress QoS policy.
The no form of this command is used to remove any existing overrides for the specified policer-id.
Parameters
- policer-id
-
This parameter is required when executing the policer command within the policer-override context. The specified policer-id must exist within the sap-ingress or sap-egress QoS policy applied to the SAP. If the policer is not currently used by any forwarding class or forwarding type mappings, the policer will not actually exist on the SAP. This does not preclude creating an override context for the policer-id.
- create
-
The create keyword is required when a policer override node is being created and the system is configured to expect explicit confirmation that a new object is being created. When the system is not configured to expect explicit configuration, the create keyword is not required.
Platforms
7705 SAR Gen 2
policer
Syntax
policer policer-id [fp-redirect-group]
no policer
Context
[Tree] (config>qos>sap-ingress>fc policer)
Full Context
configure qos sap-ingress fc policer
Description
Within a sap-ingress QoS policy forwarding class context, the policer command is used to map packets that match the forwarding class and are considered unicast in nature to the specified policer-id. The specified policer-id must already exist within the sap-ingress QoS policy. While the system is determining the forwarding class of a packet, it is also looking up its forwarding destination. If ingress forwarding logic has resolved a unicast destination (the packet does not need to be sent to multiple destinations), it is considered to be a unicast packet and will be mapped to either an ingress queue (using the queue queue-id or queue queue-id group ingress-queue-group commands) or an ingress policer ( policer policer-id). The queue and policer commands within the forwarding class context are mutually exclusive. By default, the unicast forwarding type is mapped to the SAP ingress default queue (queue 1). If the policer policer-id command is executed, any previous policer mapping or queue mapping for the unicast forwarding type within the forwarding class is overridden if the policer mapping is successful.
A policer defined within the sap-ingress policy is not actually created on an ingress SAP or a subscriber using an sla-profile where the policy is applied until at least one forwarding type (unicast, broadcast, unknown, or multicast) from one of the forwarding classes is mapped to the policer. If insufficient policer resources exist to create the policer for a SAP or subscriber or multiservice site or ingress policing is not supported on the port associated with the SAP or subscriber or multiservice site, the initial forwarding class forwarding type mapping will fail.
When the unicast forwarding type within a forwarding class is mapped to a policer, the unicast packets classified to the subclasses within the forwarding class are also mapped to the policer.
The no form of this command is used to restore the mapping of the unicast forwarding type within the forwarding class to the default queue. If all forwarding class forwarding types had been removed from the default queue, the queue will not exist on the SAPs or subscriber or multiservice sites associated with the QoS policy and the no policer command will cause the system to attempt to create the default queue on each object. If the system cannot create the default queue in each instance, the no policer command will fail and the unicast forwarding type within the forwarding class will continue its mapping to the existing policer-id. If the no policer command results in a policer without any current mappings, the policer will be removed from the SAPs and subscribers associated with the QoS policy. All statistics associated with the policer on each SAP and subscriber will be lost.
Parameters
- policer-id
-
When the forwarding class policer command is executed, a valid policer-id must be specified. The parameter policer-id references a policer-id that has already been created within the sap-ingress QoS policy.
- fp-redirect-group
-
Redirects a forwarding class to a forwarding plane queue-group as specified in a SAP QoS policy.
Platforms
7705 SAR Gen 2
policer
Syntax
policer policer-id [create]
no policer policer-id
Context
[Tree] (config>qos>sap-ingress policer)
Full Context
configure qos sap-ingress policer
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 be defined to have up to 63 policers (numbered 1 through 63) 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 or multiservice sites 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.
When 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 that 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.
When 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 subscriber or multiservice sites associated with the QoS policy when 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
- policer-id
-
The policer-id must be specified when executing the policer command. If the specified ID already exists, the system enters that policer's context to allow the policer’s parameters to be modified. If the ID does not exist and is within the allowed range for the QoS policy type, a context for the policer ID will be created (depending on the system's current create keyword requirements, which may require the create keyword to actually add the new policer ID to the QoS policy) and the system will enter that new policer’s context for possible parameter modification.
Platforms
7705 SAR Gen 2
policer
Syntax
policer policer-id [{[port-redirect-group-queue] [queue queue-id] | group group-name [instance instance-id] [queue queue-id]}]
no policer
Context
[Tree] (config>qos>sap-egress>fc policer)
Full Context
configure qos sap-egress fc policer
Description
Within a sap-egress QoS policy forwarding class context, the policer command is used to map packets that match the forwarding class to the specified policer-id. The specified policer-id must already exist within the sap-egress QoS policy. The forwarding class of the packet is first discovered at ingress, based on the ingress classification rules. When the packet arrives at egress, the sap-egress QoS policy may match a forwarding class reclassification rule that overrides the ingress derived forwarding class. The forwarding class context within the sap-egress QoS policy is then used to map the packet to an egress queue (using the queue queue-id, or port-redirect-group queue queue-id, or group queue-group-name instance instance-id queue queue-id commands) or an egress policer (policer policer-id). The queue and policer commands within the forwarding class context are mutually exclusive. By default, the forwarding class is mapped to the SAP egress default queue (queue 1). If the policer policer- id command is executed, any previous policer mapping or queue mapping for the forwarding class is overridden if the policer mapping is successful.
A policer defined within the sap-egress policy is not actually created on an egress SAP, or a subscriber using an SLA profile where the policy is applied, until at least one forwarding class is mapped to the policer. If insufficient policer resources exist to create the policer for a SAP or subscriber, or egress policing is not supported on the port associated with the SAP or subscriber, the initial forwarding class mapping will fail.
Packets that are mapped to an egress policer that are not discarded by the policer must be placed into a default queue on the packet’s destination port. The system uses egress port queue groups for this purpose. An egress queue group named policer-output-queues is automatically created on each port that supports egress policers. By default, the system uses the forwarding class mappings within this queue group to decide which queue within the group will receive each packet output from the policer. This default policer output queuing behavior may be overridden for non-subscriber packets by redirection to a queue group. The name and instance of the queue group to redirect to is either specified in the QoS policy, or the fact that a forwarding class must be redirected is identified in the QoS policy and the specific queue group instance is only identified at the time the QoS policy is applied:
-
If the policer policer-id command is successfully executed, the default egress queuing is performed for the forwarding class using the policer-output-queues queue group and the queue-id within the group based on the forwarding class map from the group template.
-
If the policer policer-id queue queue-id command is successfully executed, the specified SAP queue-id within the egress QoS policy is used instead of the default policer output queues.
-
If the policer policer-id port-redirect-group-queue keyword is successfully executed, the system will map the forwarding class to the queue within the egress queue group instance specified at the time the QoS policy is applied to the SAP, using the forwarding class map from the queue group template.
-
If the policer policer-id port-redirect-group queue queue-id command is successfully executed, the system will map the forwarding class to the configured queue-id within the egress queue group instance that is specified at the time the QoS policy is applied to the SAP (ignoring using the forwarding class map from the queue group template).
-
If the policer policer-id group queue-group-name instance instance-id command is successfully executed, the system will map the forwarding class to the queue within the specified egress queue group instance using the forwarding class map from the group template.
-
If the policer policer-id group queue-group-name instance instance-id queue queue-id command is successfully executed, the system will map the forwarding class to the specified queue-id within the specified egress queue group instance (ignoring the forwarding class map in the group template).
If the specified group group-name is not defined as an egress queue-group-template, the policer command will fail. Also, if the specified group does not exist on the port for the SAPs or subscribers associated with the sap-egress QoS policy, the policer command will fail. While a group queue-group-name is specified in a sap-egress QoS policy, the groups corresponding egress template cannot be deleted. While a port egress queue group is associated with a policer instance, the port queue group cannot be deleted.
If the specified queue queue-id is not defined in the egress queue-group-template queue-group- name, the policer command will fail. While a queue-id within an egress queue group template is referenced by a sap-egress QoS policy forwarding class policer command, the queue cannot be deleted from the queue group template.
If an egress policed packet is discarded by the egress port queue group queue, the source policer discard stats are incremented. This means that the discard counters for the policer represent both the policer discard events and the destination queue drop tail events associated with the policer.
The no form of this command is used to restore the mapping of the forwarding class to the default queue. If all forwarding classes have been removed from the default queue, the queue will not exist on the SAPs or subscribers associated with the QoS policy and the no policer command will cause the system to attempt to create the default queue on each object. If the system cannot create the default queue in each instance, the no policer command will fail and the forwarding class will continue its mapping to the existing policer-id. If the no policer command results in a policer without any current mappings, the policer will be removed from the SAPs and subscribers associated with the QoS policy. All statistics associated with the policer on each SAP and subscribers will be lost.
Default
no policer
Parameters
- policer-id
-
When the forwarding class policer command is executed, a valid policer-id must be specified. The parameter policer-id references a policer-id that has already been created within the sap-egress QoS policy.
- port-redirect-group-queue
-
Used to override the forwarding class default egress queue destination to an egress port queue group. The specific egress queue group instance to use is specified at the time the QoS policy is applied to the SAP. Therefore, this parameter is only valid if SAP-based redirection is required.
- queue queue-id
-
This parameter overrides the forwarding class default egress queue destination to a specified queue-id. If port-redirect-group is not configured, this will be a local SAP queue of that queue-id. A queue of ID queue-id must exist within the egress QoS policy. If port-redirect-group-queue is configured, the queue queue-id in the egress port queue group instance is used.
- group group-name
-
The group queue-group-name is optional and is used to override the forwarding class's default egress queue destination. If the queue group-queue-id parameter is not specified, the forwarding class map within the specified group's template is used to derive which queue within the group will receive the forwarding class's packets. An egress queue group template must exist for the specified queue-group-name or the policer command will fail. The specified queue-group-name must also exist as an egress queue group on the ports where SAPs and subscribers associated with the sap-egress policy are applied or the policer command will fail.
- queue queue-id
-
The queue group-queue-id is optional when the group queue-group-name parameter is specified and is used to override the forwarding class mapping within the group's egress queue group template. The specified group-queue-id must exist within the group's egress queue group template or the policer command will fail.
- instance instance-id
-
This parameter is used to specify the specific instance of a queue group with template queue-group-name to which this queue should be redirected. This parameter is only valid for queue groups on egress ports where policy-based redirection is required.
Platforms
7705 SAR Gen 2
policer
Syntax
policer policer-id [create]
no policer
Context
[Tree] (config>qos>sap-egress policer)
Full Context
configure qos sap-egress policer
Description
A policer defined within the sap-egress policy is not actually created on an egress SAP, or a subscriber using an SLA profile where the policy is applied, until at least one forwarding class is mapped to the policer. If insufficient policer resources exist to create the policer for a SAP or subscriber, or egress policing is not supported on the port associated with the SAP or subscriber, the initial forwarding class mapping will fail.
Packets that are mapped to an egress policer that are not discarded by the policer must be placed into a default queue on the packet’s destination port. The system uses egress port queue groups for this purpose. An egress queue group named policer-output-queues is automatically created on each port that supports egress policers. By default, the system uses the forwarding class mappings within this queue group to decide which queue within the group will receive each packet output from the policer. This default policer output queuing behavior may be overridden for non-subscriber packets by redirection to a queue group. The name and instance of the queue group to redirect to is either specified in the QoS policy, or the fact that a forwarding class must be redirected is identified in the QoS policy and the specific queue group instance is only identified at the time the QoS policy is applied:
-
If the policer policer-id command is successfully executed, the default egress queuing is performed for the forwarding class using the policer-output-queues queue group and the queue-id within the group based on the forwarding class map from the group template.
-
If the policer policer-id queue queue-id command is successfully executed, the specified SAP queue-id within the egress QoS policy is used instead of the default policer output queues.
-
If the policer policer-id port-redirect-group-queue keyword is successfully executed, the system will map the forwarding class to the queue within the egress queue group instance specified at the time the QoS policy is applied to the SAP, using the forwarding class map from the queue group template.
-
If the policer policer-id port-redirect-group queue queue-id command is successfully executed, the system will map the forwarding class to the configured queue-id within the egress queue group instance that is specified at the time the QoS policy is applied to the SAP (ignoring using the forwarding class map from the queue group template).
-
If the policer policer-id group queue-group-name instance instance-id command is successfully executed, the system will map the forwarding class to the queue within the specified egress queue group instance using the forwarding class map from the group template.
-
If the policer policer-id group queue-group-name instance instance-id queue queue-id command is successfully executed, the system will map the forwarding class to the specified queue-id within the specified egress queue group instance (ignoring the forwarding class map in the group template).
If the specified group group-name is not defined as an egress queue-group-template, the policer command will fail. Also, if the specified group does not exist on the port for the SAPs or subscribers associated with the sap-egress QoS policy, the policer command will fail. While a group queue-group-name is specified in a sap-egress QoS policy, the groups corresponding egress template cannot be deleted. While a port egress queue group is associated with a policer instance, the port queue group cannot be deleted.
If the specified queue queue-id is not defined in the egress queue-group-template queue-group- name, the policer command will fail. While a queue-id within an egress queue group template is referenced by a sap-egress QoS policy forwarding class policer command, the queue cannot be deleted from the queue group template.
If an egress policed packet is discarded by the egress port queue group queue, the source policer discard stats are incremented. This means that the discard counters for the policer represent both the policer discard events and the destination queue drop tail events associated with the policer.
The no form of this command is used to restore the mapping of the forwarding class to the default queue. If all forwarding classes have been removed from the default queue, the queue will not exist on the SAPs or subscribers associated with the QoS policy and the no policer command will cause the system to attempt to create the default queue on each object. If the system cannot create the default queue in each instance, the no policer command will fail and the forwarding class will continue its mapping to the existing policer-id. If the no policer command results in a policer without any current mappings, the policer will be removed from the SAPs and subscribers associated with the QoS policy. All statistics associated with the policer on each SAP and subscribers will be lost.
Default
no policer
Parameters
- policer-id
-
When the forwarding class policer command is executed, a valid policer-id must be specified. The parameter policer-id references a policer-id that has already been created within the sap-egress QoS policy.
Platforms
7705 SAR Gen 2
policer
Syntax
policer policer-id [create]
no policer policer-id
Context
[Tree] (config>qos>qgrps>ing>queue-group policer)
[Tree] (cfg>qos>qgrps>egr>queue-group policer)
Full Context
configure qos queue-group-templates ingress queue-group policer
configure qos queue-group-templates egress queue-group policer
Description
This command is used in ingress and egress queue-group templates 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. While a policer may be defined in a queue-group template, it is not actually created until the queue-group template is instantiated on the ingress context of a forwarding plane or on the egress context of a port.
When 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 that 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.
When a policer is created, it cannot be deleted from the queue-group template unless any forwarding classes that are redirected to the policer are first removed.
The no version of this command deletes the policer.
Parameters
- policer-id
-
The policer-id must be specified when executing the policer command. If the specified ID already exists, the system enters that policer's context to allow the policer’s parameters to be modified. If the ID does not exist and is within the allowed range for the QoS policy type, a context for the policer ID will be created (depending on the system's current create keyword requirements, which may require the create keyword to actually add the new policer ID to the QoS policy) and the system enters that new policer’s context for possible parameter modification.
Platforms
7705 SAR Gen 2
policer
Syntax
[no] policer policer-id
Context
[Tree] (config>log>acct-policy>cr policer)
Full Context
configure log accounting-policy custom-record policer
Description
This command creates a policer context for which counters should be included in the custom-record.
The no form of this command deletes the policer and its counters from the custom-record.
Parameters
- policer-id
-
Specifies the policer for which counters should be included in or deleted from the custom-record.
Platforms
7705 SAR Gen 2
policer-control-override
policer-control-override
Syntax
policer-control-override [create]
no policer-control-override
Context
[Tree] (config>card>fp>ingress>network>queue-group policer-control-override)
[Tree] (config>card>fp>ingress>access>queue-group policer-control-override)
Full Context
configure card fp ingress network queue-group policer-control-override
configure card fp ingress access queue-group policer-control-override
Description
This command configures policer control overrides.
Parameters
- create
-
Keyword required to create a new policer control override instance.
Platforms
7705 SAR Gen 2
policer-control-override
Syntax
policer-control-override [create]
no policer-control-override
Context
[Tree] (config>service>epipe>sap>ingress policer-control-override)
[Tree] (config>service>epipe>sap>egress policer-control-override)
Full Context
configure service epipe sap ingress policer-control-override
configure service epipe sap egress policer-control-override
Description
This command, within the SAP ingress or egress contexts, creates a CLI node for specific overrides to the applied policer-control-policy. A policy must be applied for a policer-control-overrides node to be created. If the policer-control-policy is removed or changed, the policer-control-overrides node is automatically deleted from the SAP.
The no form of this command removes any existing policer-control-policy overrides and the policer-control-overrides node from the SAP.
Default
no policer-control-override
Parameters
- create
-
The create keyword is required when the policer-control-overrides node is being created and the system is configured to expect explicit confirmation that a new object is being created. When the system is not configured to expect explicit confirmation, the create keyword is not required.
Platforms
7705 SAR Gen 2
policer-control-override
Syntax
policer-control-override [create]
no policer-control-override
Context
[Tree] (config>service>vpls>sap>egress policer-control-override)
[Tree] (config>service>vpls>sap>ingress policer-control-override)
Full Context
configure service vpls sap egress policer-control-override
configure service vpls sap ingress policer-control-override
Description
This command, within the SAP ingress or egress contexts, creates a CLI node for specific overrides to the applied policer-control-policy. A policy must be applied for a policer-control-overrides node to be created. If the policer-control-policy is removed or changed, the policer-control-overrides node is automatically deleted from the SAP.
The no form of this command removes any existing policer-control-policy overrides and the policer-control-overrides node from the SAP.
Default
no policer-control-override
Parameters
- create
-
The create keyword is required when the policer-control-overrides node is being created and the system is configured to expect explicit confirmation that a new object is being created. When the system is not configured to expect explicit confirmation, the create keyword is not required.
Platforms
7705 SAR Gen 2
policer-control-override
Syntax
policer-control-override [create]
no policer-control-override
Context
[Tree] (config>service>ies>if>sap>ingress policer-control-override)
[Tree] (config>service>ies>if>sap>egress policer-control-override)
Full Context
configure service ies interface sap ingress policer-control-override
configure service ies interface sap egress policer-control-override
Description
This command, within the SAP ingress or egress contexts, creates a CLI node for specific overrides to the applied policer-control-policy. A policy must be applied for a policer-control-overrides node to be created. If the policer-control-policy is removed or changed, the policer-control-overrides node is automatically deleted from the SAP.
The no form of this command removes any existing policer-control-policy overrides and the policer-control-overrides node from the SAP.
Default
no policer-control-override
Parameters
- create
-
The create keyword is required when the policer-control-overrides node is being created and the system is configured to expect explicit confirmation that a new object is being created. When the system is not configured to expect explicit confirmation, the create keyword is not required.
Platforms
7705 SAR Gen 2
policer-control-override
Syntax
policer-control-override [create]
no policer-control-override
Context
[Tree] (config>service>vprn>if>sap>egress policer-control-override)
[Tree] (config>service>vprn>if>sap>ingress policer-control-override)
Full Context
configure service vprn interface sap egress policer-control-override
configure service vprn interface sap ingress policer-control-override
Description
This command, within the SAP ingress or egress contexts, creates a CLI node for specific overrides to the applied policer-control-policy. A policy must be applied for a policer-control-overrides node to be created. If the policer-control-policy is removed or changed, the policer-control-overrides node is automatically deleted from the SAP.
The no form of this command removes any existing policer-control-policy overrides and the policer-control-overrides node from the SAP.
Default
no policer-control-override
Parameters
- create
-
The create keyword is required when the policer-control-overrides node is being created and the system is configured to expect explicit confirmation that a new object is being created. When the system is not configured to expect explicit confirmation, the create keyword is not required.
Platforms
7705 SAR Gen 2
policer-control-policy
policer-control-policy
Syntax
policer-control-policy policer-control-policy-name
no policer-control-policy
Context
[Tree] (config>card>fp>ingress>access>queue-group policer-control-policy)
[Tree] (config>card>fp>ingress>network>queue-group policer-control-policy)
Full Context
configure card fp ingress access queue-group policer-control-policy
configure card fp ingress network queue-group policer-control-policy
Description
This command configures an policer-control policy that can apply to a queue-group on the forwarding plane.
The no form of this command removes the policer-control policy association from the queue-group.
Default
no policer-control-policy
Parameters
- policer-control-policy-name
-
Specifies the name of the policer-control policy to use for the queue-group. The name can be up to 32 characters long.
Platforms
7705 SAR Gen 2
policer-control-policy
Syntax
policer-control-policy policy-name
no policer-control-policy
Context
[Tree] (config>port>ethernet>network>egress>queue-group policer-control-policy)
Full Context
configure port ethernet network egress queue-group policer-control-policy
Description
This command configures the policer control policy for the QoS egress queue-group.
Parameters
- policy-name
-
Specifies the name of the policer control policy, up to 32 characters.
Platforms
7705 SAR Gen 2
policer-control-policy
Syntax
policer-control-policy policy-name
no policer-control-policy
Context
[Tree] (config>service>epipe>sap>egress policer-control-policy)
[Tree] (config>service>epipe>sap>ingress policer-control-policy)
Full Context
configure service epipe sap egress policer-control-policy
configure service epipe sap ingress policer-control-policy
Description
This command, within the QoS CLI node, is used to create, delete or modify policer control policies. A policer control policy is very similar to the scheduler-policy which is used to manage a set of queues by defining a hierarchy of virtual schedulers and specifying how the virtual schedulers interact to provide an aggregate SLA. In a similar fashion, 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.
Policer Control Policy Instances
On the SAP side, an instance of a policy is created each time a policy is applied.
When applied to a sub-profile, an instance of the policy is created each time a subscriber successfully maps one or more hosts to the profile per ingress SAP.
Each instance of the policer-control-policy manages the policers associated with the object that owns the policy instance (SAP or subscriber). If a policer on the object is parented to an appropriate arbiter name that exists within the policy, the policer will be managed by the instance. If a policer is not parented or is parented to a non-existent arbiter, the policer will be orphaned and will not be subject to bandwidth control by the policy instance.
Maximum Rate and Root Arbiter
The policer-control-policy supports an overall maximum rate (max-rate) that defines the total amount of bandwidth that may be distributed to all associated child policers. By default, that rate is set to max which provides an unlimited amount of bandwidth to the policers. Once the policy is created, an actual rate should be configured in order for the policy instances to be effective. At the SAP level, the maximum rate may be overridden on a per instance basis.
For subscribers, the maximum rate may only be overridden on the subscriber profile which will then be applied to all instances associated with the profile.
The maximum rate is defined within the context of the root arbiter which is always present in a policer-control-policy. The system creates a parent policer which polices the output of all child policers attached to the policy instance to the configured rate. Child policers may be parented directly to the root arbiter (parent root) or parented to one of the tiered arbiters (parent arbiter-name). Since each tiered arbiter must be parented to either another tiered arbiter or the root arbiter (default), every parented child policer is associated with the root arbiter and therefore the root arbiter’s parent policer.
Parent Policer PIR Leaky Bucket Operation
The parent policer is a single leaky bucket that monitors the aggregate throughput rate of the associated child policers. Forwarded packets increment the bucket by the size of each packet. The rate of the parent policer is implemented as a bucket decrement function which attempts to drain the bucket. If the rate of the packets flowing through the bucket is less than the decrement rate, the bucket does not accumulate depth. Each packet that flows through the bucket is accompanied by a derived discard threshold. If the current depth of the bucket is less than the discard threshold, the packet is allowed to pass through, retaining the colors derived from the packet’s child policer. If the current depth is equal to or greater than the threshold value, the packet is colored red and the bucket depth is not incremented by the packet size. Also, any increased bucket depths in the child policer are canceled making any discard event an atomic function between the child and the parent.
Due to the fact that multiple thresholds are supported by the parent policer, the policer control policy is able to protect the throughput of higher priority child policers from the throughput of the lower priority child policers within the aggregate rate.
Tier 1 and Tier 2 Arbiters
As previously stated, each child is attached either to the always available root arbiter or to an explicitly created tier 1 or tier 2 arbiter. Unlike the hardware parent policer based root arbiter, the arbiters at tier 1 and tier 2 are only represented in software and are meant to provide an arbitrary hierarchical bandwidth distribution capability. An arbiter created on tier 2 must parent to either to an arbiter on tier 1 or to the root arbiter. Arbiters created on tier 1 always parent to the root arbiter. In this manner, every arbiter ultimately is parented or grand-parented by the root arbiter.
Each tiered arbiter supports an optional rate parameter that defines a rate limit for all child arbiters or child policers associated with the arbiter. Child arbiters and policers attached to the arbiter have a level attribute that defines the strict level at which the child is given bandwidth by the arbiter. Level 8 is the highest and 1 is the lowest. Also a weight attribute defines each child’s weight at that strict level in order to determine how bandwidth is distributed to multiple children at that level when insufficient bandwidth is available to meet each child’s required bandwidth.
Fair and Unfair Bandwidth Control
Each child policer supports three leaky buckets. The PIR bucket manages the policer’s peak rate and maximum burst size, the CIR leaky bucket manages the policer’s committed rate and committed burst size. The third leaky bucket is used by the policer control policy instance to manage the child policer’s fair rate (FIR). When multiple child policers are attached to the root arbiter at the same priority level, the policy instance uses each child’s FIR bucket rate to control how much of the traffic forwarded by the policer is fair and how much is unfair.
In the simplest case where all the child policers in the same priority level are directly attached to the root arbiter, each child’s FIR rate is set according to the child’s weight divided by the sum of the active children’s weights multiplied by the available bandwidth at the priority level. The result is that the FIR bucket will mark the appropriate amount of traffic for each child as fair-based on the weighted fair output of the policy instance.
The fair/unfair forwarding control in the root parent policer is accomplished by implementing two different discard thresholds for the priority. The first threshold is discard-unfair and the second is discard-all for packet associated with the priority level. As the parent policer PIR bucket fills (due the aggregate forwarded rate being greater than the parent policers PIR decrement rate) and the bucket depth reaches the first threshold, all unfair packets within the priority are discarded. This leaves room in the bucket for the fair packets to be forwarded.
In the more complex case where one or more tiered arbiters are attached at the priority level, the policer control policy instance must consider more than just the child policer weights associated with the attached arbiter. If the arbiter is configured with an aggregate rate limit that its children cannot exceed, the policer control policy instance will switch to calculating the rate each child serviced by the arbiter should receive and enforces that rate using each child policers PIR leaky bucket.
When the child policer PIR leaky bucket is used to limit the bandwidth for the child policer and the child’s PIR bucket discard threshold is reached, packets associated with the child policer are discarded. The child policer’s discarded packets do not consume depth in the child policer’s CIR or FIR buckets. The child policers discarded packets are also prevented from impacting the parent policer and will not consume the aggregate bandwidth managed by the parent policer.
Parent Policer Priority Level Thresholds
As stated in the Tier 1 and Tier 2 Arbiter subsection, each child policer is attached either to the root arbiter or explicitly to one of the tier 1 or tier 2 arbiters. When attached directly to the root arbiter, its priority relative to all other child policers is indicated by the parenting level parameter. When attached through one of the tiered arbiters, the parenting hierarchy of the arbiters must be traced through to the ultimate attachment to the root arbiter. The parenting level parameter of the arbiter parented to the root arbiter defines the child policer’s priority level within the parent policer.
The priority level is important since it defines the parent policer discard thresholds that will be applied at the parent policer. The parent policer has 8 levels of strict priority and each priority level has its own discard-unfair and discard-all thresholds. Each priority’s thresholds are larger than the thresholds of the lower priority levels. This ensures that when the parent policer is discarding, it will be priority sensitive.
To visualize the behavior of the parent policer, picture that when the aggregate forwarding rate of all child policers is currently above the decrement rate of the parent PIR leaky bucket, the bucket depth will increase over time. As the bucket depth increases, it will eventually cross the lowest priority’s discard-unfair threshold. If this amount of discard sufficiently lowers the remaining aggregate child policer rate, the parent PIR bucket will hover around this bucket depth. If however, the remaining aggregate child rate is still greater than the decrement rate, the bucket will continue to rise and eventually reach the lowest priority’s discard-all threshold which will cause all packets associated with the priority level to be discarded (fair and unfair). Again, if the remaining aggregate child rate is less than or equal to the bucket decrement rate, the parent PIR bucket will hover around this higher bucket depth. If the remaining aggregate child rate is still higher than the decrement rate, the bucket will continue to rise through the remaining priority level discards until equilibrium is achieved.
Each child’s rate feeding into the parent policer is governed by the child policer’s PIR bucket decrement rate. The amount of bandwidth the child policer offers to the parent policer will not exceed the child policer’s configured maximum rate.
Root Arbiter’s Parent Policer’s Priority Aggregate Thresholds
Each policer-control-policy root arbiter supports configurable aggregate priority thresholds which are used to control burst tolerance within each priority level. Two values are maintained per priority level; the shared-portion and the fair-portion. The shared-portion represents the amount of parent PIR bucket depth that is allowed to be consumed by both fair and unfair child packets at the priority level. The fair-portion represents the amount of parent PIR bucket depth that only the fair child policer packets may consume within the priority level. It should be noted that the fair and unfair child packets associated with a higher parent policer priority level may also consume the bucket depth set aside for this priority.
While the policy maintains a parent policer default or explicit configurable values for shared-portion and fair-portion within each priority level, it is possible that some priority levels will not be used within the parent policer. Most parent policer use cases require fewer than eight strict priority levels.
To derive the actual priority level discard-unfair and discard-all thresholds while only accounting for the actual in-use priority levels, the system maintains a child policer to parent policer association counter per priority level for each policer control policy instance. As a child policer is parented to either the root or a tiered arbiter, the system determines the parent policer priority level for the child policer and increments the association counter for that priority level on the parent policer instance.
The shared-portion for each priority level is affected by the parent policer global min-thresh-separation parameter that defines the minimum separation between any in-use discard thresholds. When more than one child policer is associated with a parent policer priority level, the shared-portion for that priority level will be the current value of min-thresh-separation. When only a single child policer is associated, the priority level’s shared-portion is zero since all packets from the child will be marked fair and the discard-unfair threshold is meaningless. When the association counter is zero, both the shared-portion and the fair-portion for that priority level are zero since neither discard thresholds will be used. Whenever the association counter is greater than 0, the fair-portion for that priority level will be derived from the current value of the priority’s mbs-contribution parameter and the global min-thresh-separation parameter.
Each priority level’s discard-unfair and discard-all thresholds are calculated based on an accumulation of lower priorities shared-portions and fair-portions and the priority level’s own shared-portion and fair-portion. The base threshold value for each priority level is equal to the sum of all lower priority level’s shared-portions and fair-portions. The discard-unfair threshold is the priority level’s base threshold plus the priority level’s shared-portion. The discard-all threshold for the priority level is the priority level’s base threshold plus both the shared-portion and fair-portion values of the priority. As can be seen, an in-use priority level’s thresholds are always greater than the thresholds of lower priority levels.
Policer Control Policy Application
A policer-control-policy may be applied on any Ethernet ingress or egress SAP that is associated with a port (or ports in the case of LAG).
The no form of this command removes a non-associated policer control policy from the system. The command will not execute when policer-name is currently associated with any SAP context.
Parameters
- policy-name
-
Each policer-control-policy must be created with a unique policy name. The name given as policy-name must adhere to the system policy ASCII naming requirements. If the defined policy-name already exists, the system will enter that policy’s context for editing purposes. If policy-name does not exist, the system will attempt to create a policy with the specified name. Creating a policy may require use of the create parameter when the system is configured for explicit object creation mode.
- create
-
The keyword is required when a new policy is being created and the system is configured for explicit object creation mode.
Platforms
7705 SAR Gen 2
policer-control-policy
Syntax
policer-control-policy policy-name
no policer-control-policy
Context
[Tree] (config>service>template>vpls-sap-template>egress policer-control-policy)
[Tree] (config>service>template>vpls-sap-template>ingress policer-control-policy)
[Tree] (config>service>vpls>sap>ingress policer-control-policy)
[Tree] (config>service>vpls>sap>egress policer-control-policy)
Full Context
configure service template vpls-sap-template egress policer-control-policy
configure service template vpls-sap-template ingress policer-control-policy
configure service vpls sap ingress policer-control-policy
configure service vpls sap egress policer-control-policy
Description
This command, within the qos CLI node, is used to create, delete or modify policer control policies. A policer control policy is very similar to the scheduler-policy which is used to manage a set of queues by defining a hierarchy of virtual schedulers and specifying how the virtual schedulers interact to provide an aggregate SLA. In a similar fashion, 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 may also be applied to the ingress or egress context of a sub-profile.
Policer Control Policy Instances
On the SAP side, an instance of a policy is created each time a policy is applied. When applied to a sub-profile, an instance of the policy is created each time a subscriber successfully maps one or more hosts to the profile per ingress SAP.
Each instance of the policer-control-policy manages the policers associated with the object that owns the policy instance (SAP or subscriber). If a policer on the object is parented to an appropriate arbiter name that exists within the policy, the policer will be managed by the instance. If a policer is not parented or is parented to a non-existent arbiter, the policer will be orphaned and will not be subject to bandwidth control by the policy instance.
Maximum Rate and Root Arbiter
The policer-control-policy supports an overall maximum rate (max-rate) that defines the total amount of bandwidth that may be distributed to all associated child policers. By default, that rate is set to max which provides an unlimited amount of bandwidth to the policers. Once the policy is created, an actual rate should be configured in order for the policy instances to be effective. At the SAP level, the maximum rate may be overridden on a per instance basis. For subscribers, the maximum rate may only be overridden on the subscriber profile which will then be applied to all instances associated with the profile.
The maximum rate is defined within the context of the root arbiter which is always present in a policer-control-policy. The system creates a parent policer which polices the output of all child policers attached to the policy instance to the configured rate. Child policers may be parented directly to the root arbiter (parent root) or parented to one of the tiered arbiters (parent arbiter-name). Since each tiered arbiter must be parented to either another tiered arbiter or the root arbiter (default), every parented child policer is associated with the root arbiter and therefore the root arbiter’s parent policer.
Parent Policer PIR Leaky Bucket Operation
The parent policer is a single leaky bucket that monitors the aggregate throughput rate of the associated child policers. Forwarded packets increment the bucket by the size of each packet. The rate of the parent policer is implemented as a bucket decrement function which attempts to drain the bucket. If the rate of the packets flowing through the bucket is less than the decrement rate, the bucket does not accumulate depth. Each packet that flows through the bucket is accompanied by a derived discard threshold. If the current depth of the bucket is less than the discard threshold, the packet is allowed to pass through, retaining the colors derived from the packet’s child policer. If the current depth is equal to or greater than the threshold value, the packet is colored red and the bucket depth is not incremented by the packet size. Also, any increased bucket depths in the child policer are canceled making any discard event an atomic function between the child and the parent.
Due to the fact that multiple thresholds are supported by the parent policer, the policer control policy is able to protect the throughput of higher priority child policers from the throughput of the lower priority child policers within the aggregate rate.
Tier 1 and Tier 2 Arbiters
As stated above, each child is attached either to the always available root arbiter or to an explicitly created tier 1 or tier 2 arbiter. Unlike the hardware parent policer based root arbiter, the arbiters at tier 1 and tier 2 are only represented in software and are meant to provide an arbitrary hierarchical bandwidth distribution capability. An arbiter created on tier 2 must parent to either to an arbiter on tier 1 or to the root arbiter. Arbiters created on tier 1 always parent to the root arbiter. In this manner, every arbiter ultimately is parented or grand-parented by the root arbiter.
Each tiered arbiter supports an optional rate parameter that defines a rate limit for all child arbiters or child policers associated with the arbiter. Child arbiters and policers attached to the arbiter have a level attribute that defines the strict level at which the child is given bandwidth by the arbiter. Level 8 is the highest and 1 is the lowest. Also a weight attribute defines each child’s weight at that strict level in order to determine how bandwidth is distributed to multiple children at that level when insufficient bandwidth is available to meet each child’s required bandwidth.
Fair and Unfair Bandwidth Control
Each child policer supports three leaky buckets. The PIR bucket manages the policer’s peak rate and maximum burst size, the CIR leaky bucket manages the policer’s committed rate and committed burst size. The third leaky bucket is used by the policer control policy instance to manage the child policer’s fair rate (FIR). When multiple child policers are attached to the root arbiter at the same priority level, the policy instance uses each child’s FIR bucket rate to control how much of the traffic forwarded by the policer is fair and how much is unfair.
In the simplest case where all the child policers in the same priority level are directly attached to the root arbiter, each child’s FIR rate is set according to the child’s weight divided by the sum of the active children’s weights multiplied by the available bandwidth at the priority level. The result is that the FIR bucket will mark the appropriate amount of traffic for each child as fair-based on the weighted fair output of the policy instance.
The fair/unfair forwarding control in the root parent policer is accomplished by implementing two different discard thresholds for the priority. The first threshold is discard-unfair and the second is discard-all for packet associated with the priority level. As the parent policer PIR bucket fills (due the aggregate forwarded rate being greater than the parent policers PIR decrement rate) and the bucket depth reaches the first threshold, all unfair packets within the priority are discarded. This leaves room in the bucket for the fair packets to be forwarded.
In the more complex case where one or more tiered arbiters are attached at the priority level, the policer control policy instance must consider more than just the child policer weights associated with the attached arbiter. If the arbiter is configured with an aggregate rate limit that its children cannot exceed, the policer control policy instance will switch to calculating the rate each child serviced by the arbiter should receive and enforces that rate using each child policers PIR leaky bucket.
When the child policer PIR leaky bucket is used to limit the bandwidth for the child policer and the child’s PIR bucket discard threshold is reached, packets associated with the child policer are discarded. The child policer’s discarded packets do not consume depth in the child policer’s CIR or FIR buckets. The child policers discarded packets are also prevented from impacting the parent policer and will not consume the aggregate bandwidth managed by the parent policer.
Parent Policer Priority Level Thresholds
As stated above, each child policer is attached either to the root arbiter or explicitly to one of the tier 1 or tier 2 arbiters. When attached directly to the root arbiter, its priority relative to all other child policers is indicated by the parenting level parameter. When attached through one of the tiered arbiters, the parenting hierarchy of the arbiters must be traced through to the ultimate attachment to the root arbiter. The parenting level parameter of the arbiter parented to the root arbiter defines the child policer’s priority level within the parent policer.
The priority level is important since it defines the parent policer discard thresholds that will be applied at the parent policer. The parent policer has 8 levels of strict priority and each priority level has its own discard-unfair and discard-all thresholds. Each priority’s thresholds are larger than the thresholds of the lower priority levels. This ensures that when the parent policer is discarding, it will be priority sensitive.
To visualize the behavior of the parent policer, picture that when the aggregate forwarding rate of all child policers is currently above the decrement rate of the parent PIR leaky bucket, the bucket depth will increase over time. As the bucket depth increases, it will eventually cross the lowest priority’s discard-unfair threshold. If this amount of discard sufficiently lowers the remaining aggregate child policer rate, the parent PIR bucket will hover around this bucket depth. If however, the remaining aggregate child rate is still greater than the decrement rate, the bucket will continue to rise and eventually reach the lowest priority’s discard-all threshold which will cause all packets associated with the priority level to be discarded (fair and unfair). Again, if the remaining aggregate child rate is less than or equal to the bucket decrement rate, the parent PIR bucket will hover around this higher bucket depth. If the remaining aggregate child rate is still higher than the decrement rate, the bucket will continue to rise through the remaining priority level discards until equilibrium is achieved.
As noted above, each child’s rate feeding into the parent policer is governed by the child policer’s PIR bucket decrement rate. The amount of bandwidth the child policer offers to the parent policer will not exceed the child policer’s configured maximum rate.
Root Arbiter’s Parent Policer’s Priority Aggregate Thresholds
Each policer-control-policy root arbiter supports configurable aggregate priority thresholds which are used to control burst tolerance within each priority level. Two values are maintained per priority level; the shared-portion and the fair-portion. The shared-portion represents the amount of parent PIR bucket depth that is allowed to be consumed by both fair and unfair child packets at the priority level. The fair-portion represents the amount of parent PIR bucket depth that only the fair child policer packets may consume within the priority level. It should be noted that the fair and unfair child packets associated with a higher parent policer priority level may also consume the bucket depth set aside for this priority.
While the policy maintains a parent policer default or explicit configurable values for shared-portion and fair-portion within each priority level, it is possible that some priority levels will not be used within the parent policer. Most parent policer use cases require fewer than eight strict priority levels.
To derive the actual priority level discard-unfair and discard-all thresholds while only accounting for the actual in-use priority levels, the system maintains a child policer to parent policer association counter per priority level for each policer control policy instance. As a child policer is parented to either the root or a tiered arbiter, the system determines the parent policer priority level for the child policer and increments the association counter for that priority level on the parent policer instance.
The shared-portion for each priority level is affected by the parent policer global min-thresh-separation parameter that defines the minimum separation between any in-use discard thresholds. When more than one child policer is associated with a parent policer priority level, the shared-portion for that priority level will be the current value of min-thresh-separation. When only a single child policer is associated, the priority level’s shared-portion is zero since all packets from the child will be marked fair and the discard-unfair threshold is meaningless. When the association counter is zero, both the shared-portion and the fair-portion for that priority level are zero since neither discard thresholds will be used. Whenever the association counter is greater than 0, the fair-portion for that priority level will be derived from the current value of the priority’s mbs-contribution parameter and the global min-thresh-separation parameter.
Each priority level’s discard-unfair and discard-all thresholds are calculated based on an accumulation of lower priorities shared-portions and fair-portions and the priority level’s own shared-portion and fair-portion. The base threshold value for each priority level is equal to the sum of all lower priority level’s shared-portions and fair-portions. The discard-unfair threshold is the priority level’s base threshold plus the priority level’s shared-portion. The discard-all threshold for the priority level is the priority level’s base threshold plus both the shared-portion and fair-portion values of the priority. As can be seen, an in-use priority level’s thresholds are always greater than the thresholds of lower priority levels.
Policer Control Policy Application
A policer-control-policy may be applied on any Ethernet ingress or egress SAP that is associated with a port (or ports in the case of LAG).
The no form of this command removes a non-associated policer control policy from the system. The command will not execute when policer-name is currently associated with any SAP or subscriber management sub-profile context.
Parameters
- policy-name
-
Specifies the policy name. Each policer-control-policy must be created with a unique policy name. The name must be given as policy-name must adhere to the system policy ASCII naming requirements. If the defined policy-name already exists, the system will enter that policy’s context for editing purposes. If policy-name does not exist, the system will attempt to create a policy with the specified name. Creating a policy may require use of the create parameter when the system is configured for explicit object creation mode.
- create
-
The keyword is required when a new policy is being created and the system is configured for explicit object creation mode.
Platforms
7705 SAR Gen 2
policer-control-policy
Syntax
policer-control-policy policy-name
no policer-control-policy
Context
[Tree] (config>service>ies>if>sap>egress policer-control-policy)
[Tree] (config>service>ies>if>sap>ingress policer-control-policy)
Full Context
configure service ies interface sap egress policer-control-policy
configure service ies interface sap ingress policer-control-policy
Description
This command, within the qos CLI node, is used to create, delete or modify policer control policies. A policer control policy is very similar to the scheduler-policy which is used to manage a set of queues by defining a hierarchy of virtual schedulers and specifying how the virtual schedulers interact to provide an aggregate SLA. In a similar fashion, 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 may also be applied to the ingress or egress context of a sub-profile.
Policer Control Policy Instances
On the SAP side, an instance of a policy is created each time a policy is applied. When applied to a sub-profile, an instance of the policy is created each time a subscriber successfully maps one or more hosts to the profile per ingress SAP.
Each instance of the policer-control-policy manages the policers associated with the object that owns the policy instance (SAP or subscriber). If a policer on the object is parented to an appropriate arbiter name that exists within the policy, the policer will be managed by the instance. If a policer is not parented or is parented to a non-existent arbiter, the policer will be orphaned and will not be subject to bandwidth control by the policy instance.
Maximum Rate and Root Arbiter
The policer-control-policy supports an overall maximum rate (max-rate) that defines the total amount of bandwidth that may be distributed to all associated child policers. By default, that rate is set to max which provides an unlimited amount of bandwidth to the policers. Once the policy is created, an actual rate should be configured in order for the policy instances to be effective. At the SAP level, the maximum rate may be overridden on a per instance basis. For subscribers, the maximum rate may only be overridden on the subscriber profile which will then be applied to all instances associated with the profile.
The maximum rate is defined within the context of the root arbiter which is always present in a policer-control-policy. The system creates a parent policer which polices the output of all child policers attached to the policy instance to the configured rate. Child policers may be parented directly to the root arbiter (parent root) or parented to one of the tiered arbiters (parent arbiter-name). Since each tiered arbiter must be parented to either another tiered arbiter or the root arbiter (default), every parented child policer is associated with the root arbiter and therefore the root arbiter’s parent policer.
Parent Policer PIR Leaky Bucket Operation
The parent policer is a single leaky bucket that monitors the aggregate throughput rate of the associated child policers. Forwarded packets increment the bucket by the size of each packet. The rate of the parent policer is implemented as a bucket decrement function which attempts to drain the bucket. If the rate of the packets flowing through the bucket is less than the decrement rate, the bucket does not accumulate depth. Each packet that flows through the bucket is accompanied by a derived discard threshold. If the current depth of the bucket is less than the discard threshold, the packet is allowed to pass through, retaining the colors derived from the packet’s child policer. If the current depth is equal to or greater than the threshold value, the packet is colored red and the bucket depth is not incremented by the packet size. Also, any increased bucket depths in the child policer are canceled making any discard event an atomic function between the child and the parent.
Due to the fact that multiple thresholds are supported by the parent policer, the policer control policy is able to protect the throughput of higher priority child policers from the throughput of the lower priority child policers within the aggregate rate.
Tier 1 and Tier 2 Arbiters
As stated above, each child is attached either to the always available root arbiter or to an explicitly created tier 1 or tier 2 arbiter. Unlike the hardware parent policer based root arbiter, the arbiters at tier 1 and tier 2 are only represented in software and are meant to provide an arbitrary hierarchical bandwidth distribution capability. An arbiter created on tier 2 must parent to either to an arbiter on tier 1 or to the root arbiter. Arbiters created on tier 1 always parent to the root arbiter. In this manner, every arbiter ultimately is parented or grand-parented by the root arbiter.
Each tiered arbiter supports an optional rate parameter that defines a rate limit for all child arbiters or child policers associated with the arbiter. Child arbiters and policers attached to the arbiter have a level attribute that defines the strict level at which the child is given bandwidth by the arbiter. Level 8 is the highest and 1 is the lowest. Also a weight attribute defines each child’s weight at that strict level in order to determine how bandwidth is distributed to multiple children at that level when insufficient bandwidth is available to meet each child’s required bandwidth.
Fair and Unfair Bandwidth Control
Each child policer supports three leaky buckets. The PIR bucket manages the policer’s peak rate and maximum burst size, the CIR leaky bucket manages the policer’s committed rate and committed burst size. The third leaky bucket is used by the policer control policy instance to manage the child policer’s fair rate (FIR). When multiple child policers are attached to the root arbiter at the same priority level, the policy instance uses each child’s FIR bucket rate to control how much of the traffic forwarded by the policer is fair and how much is unfair.
In the simplest case where all the child policers in the same priority level are directly attached to the root arbiter, each child’s FIR rate is set according to the child’s weight divided by the sum of the active children’s weights multiplied by the available bandwidth at the priority level. The result is that the FIR bucket will mark the appropriate amount of traffic for each child as fair-based on the weighted fair output of the policy instance.
The fair/unfair forwarding control in the root parent policer is accomplished by implementing two different discard thresholds for the priority. The first threshold is discard-unfair and the second is discard-all for packet associated with the priority level. As the parent policer PIR bucket fills (due the aggregate forwarded rate being greater than the parent policers PIR decrement rate) and the bucket depth reaches the first threshold, all unfair packets within the priority are discarded. This leaves room in the bucket for the fair packets to be forwarded.
In the more complex case where one or more tiered arbiters are attached at the priority level, the policer control policy instance must consider more than just the child policer weights associated with the attached arbiter. If the arbiter is configured with an aggregate rate limit that its children cannot exceed, the policer control policy instance will switch to calculating the rate each child serviced by the arbiter should receive and enforces that rate using each child policers PIR leaky bucket.
When the child policer PIR leaky bucket is used to limit the bandwidth for the child policer and the child’s PIR bucket discard threshold is reached, packets associated with the child policer are discarded. The child policer’s discarded packets do not consume depth in the child policer’s CIR or FIR buckets. The child policers discarded packets are also prevented from impacting the parent policer and will not consume the aggregate bandwidth managed by the parent policer.
Parent Policer Priority Level Thresholds
As stated above, each child policer is attached either to the root arbiter or explicitly to one of the tier 1 or tier 2 arbiters. When attached directly to the root arbiter, its priority relative to all other child policers is indicated by the parenting level parameter. When attached through one of the tiered arbiters, the parenting hierarchy of the arbiters must be traced through to the ultimate attachment to the root arbiter. The parenting level parameter of the arbiter parented to the root arbiter defines the child policer’s priority level within the parent policer.
The priority level is important since it defines the parent policer discard thresholds that will be applied at the parent policer. The parent policer has 8 levels of strict priority and each priority level has its own discard-unfair and discard-all thresholds. Each priority’s thresholds are larger than the thresholds of the lower priority levels. This ensures that when the parent policer is discarding, it will be priority sensitive.
To visualize the behavior of the parent policer, picture that when the aggregate forwarding rate of all child policers is currently above the decrement rate of the parent PIR leaky bucket, the bucket depth will increase over time. As the bucket depth increases, it will eventually cross the lowest priority’s discard-unfair threshold. If this amount of discard sufficiently lowers the remaining aggregate child policer rate, the parent PIR bucket will hover around this bucket depth. If however, the remaining aggregate child rate is still greater than the decrement rate, the bucket will continue to rise and eventually reach the lowest priority’s discard-all threshold which will cause all packets associated with the priority level to be discarded (fair and unfair). Again, if the remaining aggregate child rate is less than or equal to the bucket decrement rate, the parent PIR bucket will hover around this higher bucket depth. If the remaining aggregate child rate is still higher than the decrement rate, the bucket will continue to rise through the remaining priority level discards until equilibrium is achieved.
As noted above, each child’s rate feeding into the parent policer is governed by the child policer’s PIR bucket decrement rate. The amount of bandwidth the child policer offers to the parent policer will not exceed the child policer’s configured maximum rate.
Root Arbiter’s Parent Policer’s Priority Aggregate Thresholds
Each policer-control-policy root arbiter supports configurable aggregate priority thresholds which are used to control burst tolerance within each priority level. Two values are maintained per priority level; the shared-portion and the fair-portion. The shared-portion represents the amount of parent PIR bucket depth that is allowed to be consumed by both fair and unfair child packets at the priority level. The fair-portion represents the amount of parent PIR bucket depth that only the fair child policer packets may consume within the priority level. It should be noted that the fair and unfair child packets associated with a higher parent policer priority level may also consume the bucket depth set aside for this priority.
While the policy maintains a parent policer default or explicit configurable values for shared-portion and fair-portion within each priority level, it is possible that some priority levels will not be used within the parent policer. Most parent policer use cases require fewer than eight strict priority levels.
To derive the actual priority level discard-unfair and discard-all thresholds while only accounting for the actual in-use priority levels, the system maintains a child policer to parent policer association counter per priority level for each policer control policy instance. As a child policer is parented to either the root or a tiered arbiter, the system determines the parent policer priority level for the child policer and increments the association counter for that priority level on the parent policer instance.
The shared-portion for each priority level is affected by the parent policer global min-thresh-separation parameter that defines the minimum separation between any in-use discard thresholds. When more than one child policer is associated with a parent policer priority level, the shared-portion for that priority level will be the current value of min-thresh-separation. When only a single child policer is associated, the priority level’s shared-portion is zero since all packets from the child will be marked fair and the discard-unfair threshold is meaningless. When the association counter is zero, both the shared-portion and the fair-portion for that priority level are zero since neither discard thresholds will be used. Whenever the association counter is greater than 0, the fair-portion for that priority level will be derived from the current value of the priority’s mbs-contribution parameter and the global min-thresh-separation parameter.
Each priority level’s discard-unfair and discard-all thresholds are calculated based on an accumulation of lower priorities shared-portions and fair-portions and the priority level’s own shared-portion and fair-portion. The base threshold value for each priority level is equal to the sum of all lower priority level’s shared-portions and fair-portions. The discard-unfair threshold is the priority level’s base threshold plus the priority level’s shared-portion. The discard-all threshold for the priority level is the priority level’s base threshold plus both the shared-portion and fair-portion values of the priority. As can be seen, an in-use priority level’s thresholds are always greater than the thresholds of lower priority levels.
Policer Control Policy Application
A policer-control-policy may be applied on any Ethernet ingress or egress SAP that is associated with a port (or ports in the case of LAG).
The no form of this command removes a non-associated policer control policy from the system. The command will not execute when policer-name is currently associated with any SAP or subscriber management sub-profile context.
Parameters
- policy-name
-
Specifies the policy name. Each policer-control-policy must be created with a unique policy name. The name must be given as policy-name must adhere to the system policy ASCII naming requirements. If the defined policy-name already exists, the system will enter that policy’s context for editing purposes. If policy-name does not exist, the system will attempt to create a policy with the specified name. Creating a policy may require use of the create parameter when the system is configured for explicit object creation mode.
Platforms
7705 SAR Gen 2
policer-control-policy
Syntax
policer-control-policy policy-name
no policer-control-policy
Context
[Tree] (config>service>vprn>if>sap>ingress policer-control-policy)
[Tree] (config>service>vprn>if>sap>egress policer-control-policy)
Full Context
configure service vprn interface sap ingress policer-control-policy
configure service vprn interface sap egress policer-control-policy
Description
This command, within the qos CLI node, is used to create, delete or modify policer control policies. A policer control policy is very similar to the scheduler-policy which is used to manage a set of queues by defining a hierarchy of virtual schedulers and specifying how the virtual schedulers interact to provide an aggregate SLA. In a similar fashion, 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 may also be applied to the ingress or egress context of a sub-profile.
Policer Control Policy Instances
On the SAP side, an instance of a policy is created each time a policy is applied. When applied to a sub-profile, an instance of the policy is created each time a subscriber successfully maps one or more hosts to the profile per ingress SAP.
Each instance of the policer-control-policy manages the policers associated with the object that owns the policy instance (SAP or subscriber). If a policer on the object is parented to an appropriate arbiter name that exists within the policy, the policer will be managed by the instance. If a policer is not parented or is parented to a non-existent arbiter, the policer will be orphaned and will not be subject to bandwidth control by the policy instance.
Maximum Rate and Root Arbiter
The policer-control-policy supports an overall maximum rate (max-rate) that defines the total amount of bandwidth that may be distributed to all associated child policers. By default, that rate is set to max which provides an unlimited amount of bandwidth to the policers. Once the policy is created, an actual rate should be configured in order for the policy instances to be effective. At the SAP level, the maximum rate may be overridden on a per instance basis. For subscribers, the maximum rate may only be overridden on the subscriber profile which will then be applied to all instances associated with the profile.
The maximum rate is defined within the context of the root arbiter which is always present in a policer-control-policy. The system creates a parent policer which polices the output of all child policers attached to the policy instance to the configured rate. Child policers may be parented directly to the root arbiter (parent root) or parented to one of the tiered arbiters (parent arbiter-name). Since each tiered arbiter must be parented to either another tiered arbiter or the root arbiter (default), every parented child policer is associated with the root arbiter and therefore the root arbiter’s parent policer.
Parent Policer PIR Leaky Bucket Operation
The parent policer is a single leaky bucket that monitors the aggregate throughput rate of the associated child policers. Forwarded packets increment the bucket by the size of each packet. The rate of the parent policer is implemented as a bucket decrement function which attempts to drain the bucket. If the rate of the packets flowing through the bucket is less than the decrement rate, the bucket does not accumulate depth. Each packet that flows through the bucket is accompanied by a derived discard threshold. If the current depth of the bucket is less than the discard threshold, the packet is allowed to pass through, retaining the colors derived from the packet’s child policer. If the current depth is equal to or greater than the threshold value, the packet is colored red and the bucket depth is not incremented by the packet size. Also, any increased bucket depths in the child policer are canceled making any discard event an atomic function between the child and the parent.
Due to the fact that multiple thresholds are supported by the parent policer, the policer control policy is able to protect the throughput of higher priority child policers from the throughput of the lower priority child policers within the aggregate rate.
Tier 1 and Tier 2 Arbiters
As stated above, each child is attached either to the always available root arbiter or to an explicitly created tier 1 or tier 2 arbiter. Unlike the hardware parent policer based root arbiter, the arbiters at tier 1 and tier 2 are only represented in software and are meant to provide an arbitrary hierarchical bandwidth distribution capability. An arbiter created on tier 2 must parent to either to an arbiter on tier 1 or to the root arbiter. Arbiters created on tier 1 always parent to the root arbiter. In this manner, every arbiter ultimately is parented or grand-parented by the root arbiter.
Each tiered arbiter supports an optional rate parameter that defines a rate limit for all child arbiters or child policers associated with the arbiter. Child arbiters and policers attached to the arbiter have a level attribute that defines the strict level at which the child is given bandwidth by the arbiter. Level 8 is the highest and 1 is the lowest. Also a weight attribute defines each child’s weight at that strict level in order to determine how bandwidth is distributed to multiple children at that level when insufficient bandwidth is available to meet each child’s required bandwidth.
Fair and Unfair Bandwidth Control
Each child policer supports three leaky buckets. The PIR bucket manages the policer’s peak rate and maximum burst size, the CIR leaky bucket manages the policer’s committed rate and committed burst size. The third leaky bucket is used by the policer control policy instance to manage the child policer’s fair rate (FIR). When multiple child policers are attached to the root arbiter at the same priority level, the policy instance uses each child’s FIR bucket rate to control how much of the traffic forwarded by the policer is fair and how much is unfair.
In the simplest case where all the child policers in the same priority level are directly attached to the root arbiter, each child’s FIR rate is set according to the child’s weight divided by the sum of the active children’s weights multiplied by the available bandwidth at the priority level. The result is that the FIR bucket will mark the appropriate amount of traffic for each child as fair-based on the weighted fair output of the policy instance.
The fair/unfair forwarding control in the root parent policer is accomplished by implementing two different discard thresholds for the priority. The first threshold is discard-unfair and the second is discard-all for packet associated with the priority level. As the parent policer PIR bucket fills (due the aggregate forwarded rate being greater than the parent policers PIR decrement rate) and the bucket depth reaches the first threshold, all unfair packets within the priority are discarded. This leaves room in the bucket for the fair packets to be forwarded.
In the more complex case where one or more tiered arbiters are attached at the priority level, the policer control policy instance must consider more than just the child policer weights associated with the attached arbiter. If the arbiter is configured with an aggregate rate limit that its children cannot exceed, the policer control policy instance will switch to calculating the rate each child serviced by the arbiter should receive and enforces that rate using each child policers PIR leaky bucket.
When the child policer PIR leaky bucket is used to limit the bandwidth for the child policer and the child’s PIR bucket discard threshold is reached, packets associated with the child policer are discarded. The child policer’s discarded packets do not consume depth in the child policer’s CIR or FIR buckets. The child policers discarded packets are also prevented from impacting the parent policer and will not consume the aggregate bandwidth managed by the parent policer.
Parent Policer Priority Level Thresholds
As stated above, each child policer is attached either to the root arbiter or explicitly to one of the tier 1 or tier 2 arbiters. When attached directly to the root arbiter, its priority relative to all other child policers is indicated by the parenting level parameter. When attached through one of the tiered arbiters, the parenting hierarchy of the arbiters must be traced through to the ultimate attachment to the root arbiter. The parenting level parameter of the arbiter parented to the root arbiter defines the child policer’s priority level within the parent policer.
The priority level is important since it defines the parent policer discard thresholds that will be applied at the parent policer. The parent policer has 8 levels of strict priority and each priority level has its own discard-unfair and discard-all thresholds. Each priority’s thresholds are larger than the thresholds of the lower priority levels. This ensures that when the parent policer is discarding, it will be priority sensitive.
To visualize the behavior of the parent policer, picture that when the aggregate forwarding rate of all child policers is currently above the decrement rate of the parent PIR leaky bucket, the bucket depth will increase over time. As the bucket depth increases, it will eventually cross the lowest priority’s discard-unfair threshold. If this amount of discard sufficiently lowers the remaining aggregate child policer rate, the parent PIR bucket will hover around this bucket depth. If however, the remaining aggregate child rate is still greater than the decrement rate, the bucket will continue to rise and eventually reach the lowest priority’s discard-all threshold which will cause all packets associated with the priority level to be discarded (fair and unfair). Again, if the remaining aggregate child rate is less than or equal to the bucket decrement rate, the parent PIR bucket will hover around this higher bucket depth. If the remaining aggregate child rate is still higher than the decrement rate, the bucket will continue to rise through the remaining priority level discards until equilibrium is achieved.
As noted above, each child’s rate feeding into the parent policer is governed by the child policer’s PIR bucket decrement rate. The amount of bandwidth the child policer offers to the parent policer will not exceed the child policer’s configured maximum rate.
Root Arbiter’s Parent Policer’s Priority Aggregate Thresholds
Each policer-control-policy root arbiter supports configurable aggregate priority thresholds which are used to control burst tolerance within each priority level. Two values are maintained per priority level; the shared-portion and the fair-portion. The shared-portion represents the amount of parent PIR bucket depth that is allowed to be consumed by both fair and unfair child packets at the priority level. The fair-portion represents the amount of parent PIR bucket depth that only the fair child policer packets may consume within the priority level. It should be noted that the fair and unfair child packets associated with a higher parent policer priority level may also consume the bucket depth set aside for this priority.
While the policy maintains a parent policer default or explicit configurable values for shared-portion and fair-portion within each priority level, it is possible that some priority levels will not be used within the parent policer. Most parent policer use cases require fewer than eight strict priority levels.
To derive the actual priority level discard-unfair and discard-all thresholds while only accounting for the actual in-use priority levels, the system maintains a child policer to parent policer association counter per priority level for each policer control policy instance. As a child policer is parented to either the root or a tiered arbiter, the system determines the parent policer priority level for the child policer and increments the association counter for that priority level on the parent policer instance.
The shared-portion for each priority level is affected by the parent policer global min-thresh-separation parameter that defines the minimum separation between any in-use discard thresholds. When more than one child policer is associated with a parent policer priority level, the shared-portion for that priority level will be the current value of min-thresh-separation. When only a single child policer is associated, the priority level’s shared-portion is zero since all packets from the child will be marked fair and the discard-unfair threshold is meaningless. When the association counter is zero, both the shared-portion and the fair-portion for that priority level are zero since neither discard thresholds will be used. Whenever the association counter is greater than 0, the fair-portion for that priority level will be derived from the current value of the priority’s mbs-contribution parameter and the global min-thresh-separation parameter.
Each priority level’s discard-unfair and discard-all thresholds are calculated based on an accumulation of lower priorities shared-portions and fair-portions and the priority level’s own shared-portion and fair-portion. The base threshold value for each priority level is equal to the sum of all lower priority level’s shared-portions and fair-portions. The discard-unfair threshold is the priority level’s base threshold plus the priority level’s shared-portion. The discard-all threshold for the priority level is the priority level’s base threshold plus both the shared-portion and fair-portion values of the priority. As can be seen, an in-use priority level’s thresholds are always greater than the thresholds of lower priority levels.
Policer Control Policy Application
A policer-control-policy may be applied on any Ethernet ingress or egress SAP that is associated with a port (or ports in the case of LAG).
The no form of this command removes a non-associated policer control policy from the system. The command will not execute when policer-name is currently associated with any SAP or subscriber management sub-profile context.
Parameters
- policy-name
-
Specifies the policy name. Each policer-control-policy must be created with a unique policy name. The name must be given as policy-name must adhere to the system policy ASCII naming requirements. If the defined policy-name already exists, the system will enter that policy’s context for editing purposes. If policy-name does not exist, the system will attempt to create a policy with the specified name. Creating a policy may require use of the create parameter when the system is configured for explicit object creation mode.
Platforms
7705 SAR Gen 2
policer-control-policy
Syntax
policer-control-policy policy-name [create]
no policer-control-policy policy-name
Context
[Tree] (config>qos policer-control-policy)
Full Context
configure qos policer-control-policy
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. When 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.
Parameters
- policy-name
-
Each policer-control-policy must be created with a unique policy name. The policy-name must adhere to the system policy ASCII naming requirements. If the defined policy-name already exists, the system enters that policy’s context for editing purposes. If policy-name does not exist, the system attempts to create a policy with the specified name. Creating a policy may require use of the create parameter when the system is configured for explicit object creation mode.
- create
-
The create keyword is required when a new policy is being created and the system is configured for explicit object creation mode.
Platforms
7705 SAR Gen 2
policer-control-policy
Syntax
policer-control-policy policy-name
no policer-control-policy
Context
[Tree] (config>service>cust>multi-service-site>ingress policer-control-policy)
[Tree] (config>service>cust>multi-service-site>egress policer-control-policy)
Full Context
configure service customer multi-service-site ingress policer-control-policy
configure service customer multi-service-site egress policer-control-policy
Description
This command, within the QoS CLI node, is used to create, delete or modify policer control policies. A policer control policy is very similar to the scheduler-policy which is used to manage a set of queues by defining a hierarchy of virtual schedulers and specifying how the virtual schedulers interact to provide an aggregate SLA. In a similar fashion, 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.
Policer Control Policy Instances
On the SAP side, an instance of a policy is created each time a policy is applied. When applied to a sub-profile, an instance of the policy is created each time a subscriber successfully maps one or more hosts to the profile per ingress SAP.
Each instance of the policer-control-policy manages the policers associated with the object that owns the policy instance (SAP or subscriber). If a policer on the object is parented to an appropriate arbiter name that exists within the policy, the policer will be managed by the instance. If a policer is not parented or is parented to a non-existent arbiter, the policer will be orphaned and not subject to bandwidth control by the policy instance.
Maximum Rate and Root Arbiter
The policer-control-policy supports an overall maximum rate (max-rate) that defines the total amount of bandwidth that may be distributed to all associated child policers. By default, that rate is set to max which provides an unlimited amount of bandwidth to the policers. Once the policy is created, an actual rate should be configured in order for the policy instances to be effective. At the SAP level, the maximum rate may be overridden on a per instance basis. For subscribers, the maximum rate may only be overridden on the subscriber profile which will then be applied to all instances associated with the profile.
The maximum rate is defined within the context of the root arbiter which is always present in a policer-control-policy. The system creates a parent policer which polices the output of all child policers attached to the policy instance to the configured rate. Child policers may be parented directly to the root arbiter (parent root) or parented to one of the tiered arbiters (parent arbiter-name). Since each tiered arbiter must be parented to either another tiered arbiter or the root arbiter (default), every parented child policer is associated with the root arbiter and thus the root arbiter’s parent policer.
Parent Policer PIR Leaky Bucket Operation
The parent policer is a single leaky bucket that monitors the aggregate throughput rate of the associated child policers. Forwarded packets increment the bucket by the size of each packet. The rate of the parent policer is implemented as a bucket decrement function which attempts to drain the bucket. If the rate of the packets flowing through the bucket is less than the decrement rate, the bucket does not accumulate depth. Each packet that flows through the bucket is accompanied by a derived discard threshold. If the current depth of the bucket is less than the discard threshold, the packet is allowed to pass through, retaining the colors derived from the packet’s child policer. If the current depth is equal to or greater than the threshold value, the packet is colored red and the bucket depth is not incremented by the packet size. Also, any increased bucket depths in the child policer are canceled making any discard event an atomic function between the child and the parent.
Due to the fact that multiple thresholds are supported by the parent policer, the policer control policy is able to protect the throughput of higher priority child policers from the throughput of the lower priority child policers within the aggregate rate.
Tier 1 and Tier 2 Arbiters
As stated above, each child is attached either to the always available root arbiter or to an explicitly created tier 1 or tier 2 arbiter. Unlike the hardware parent policer based root arbiter, the arbiters at tier 1 and tier 2 are only represented in software and are meant to provide an arbitrary hierarchical bandwidth distribution capability. An arbiter created on tier 2 must parent to either to an arbiter on tier 1 or to the root arbiter. Arbiters created on tier 1 always parent to the root arbiter. In this manner, every arbiter ultimately is parented or grand-parented by the root arbiter.
Each tiered arbiter supports an optional rate parameter that defines a rate limit for all child arbiters or child policers associated with the arbiter. Child arbiters and policers attached to the arbiter have a level attribute that defines the strict level at which the child is given bandwidth by the arbiter. Level 8 is the highest and 1 is the lowest. Also a weight attribute defines each child’s weight at that strict level in order to determine how bandwidth is distributed to multiple children at that level when insufficient bandwidth is available to meet each child’s required bandwidth.
Fair and Unfair Bandwidth Control
Each child policer supports three leaky buckets. The PIR bucket manages the policer’s peak rate and maximum burst size, the CIR leaky bucket manages the policer’s committed rate and committed burst size. The third leaky bucket is used by the policer control policy instance to manage the child policer’s fair rate (FIR). When multiple child policers are attached to the root arbiter at the same priority level, the policy instance uses each child’s FIR bucket rate to control how much of the traffic forwarded by the policer is fair and how much is unfair.
In the simplest case where all the child policers in the same priority level are directly attached to the root arbiter, each child’s FIR rate is set according to the child’s weight divided by the sum of the active children’s weights multiplied by the available bandwidth at the priority level. The result is that the FIR bucket will mark the appropriate amount of traffic for each child as fair based on the weighted fair output of the policy instance.
The fair/unfair forwarding control in the root parent policer is accomplished by implementing two different discard thresholds for the priority. The first threshold is discard-unfair and the second is discard-all for packet associated with the priority level. As the parent policer PIR bucket fills (due the aggregate forwarded rate being greater than the parent policers PIR decrement rate) and the bucket depth reaches the first threshold, all unfair packets within the priority are discarded. This leaves room in the bucket for the fair packets to be forwarded.
In the more complex case where one or more tiered arbiters are attached at the priority level, the policer control policy instance must consider more than just the child policer weights associated with the attached arbiter. If the arbiter is configured with an aggregate rate limit that its children cannot exceed, the policer control policy instance will switch to calculating the rate each child serviced by the arbiter should receive and enforces that rate using each child policers PIR leaky bucket.
When the child policer PIR leaky bucket is used to limit the bandwidth for the child policer and the child’s PIR bucket discard threshold is reached, packets associated with the child policer are discarded. The child policer’s discarded packets do not consume depth in the child policer’s CIR or FIR buckets. The child policers discarded packets are also prevented from impacting the parent policer and will not consume the aggregate bandwidth managed by the parent policer.
Parent Policer Priority Level Thresholds
As stated above, each child policer is attached either to the root arbiter or explicitly to one of the tier 1 or tier 2 arbiters. When attached directly to the root arbiter, its priority relative to all other child policers is indicated by the parenting level parameter. When attached through one of the tiered arbiters, the parenting hierarchy of the arbiters must be traced through to the ultimate attachment to the root arbiter. The parenting level parameter of the arbiter parented to the root arbiter defines the child policer’s priority level within the parent policer.
The priority level is important since it defines the parent policer discard thresholds that will be applied at the parent policer. The parent policer has 8 levels of strict priority and each priority level has its own discard-unfair and discard-all thresholds. Each priority’s thresholds are larger than the thresholds of the lower priority levels. This ensures that when the parent policer is discarding, it will be priority sensitive.
To visualize the behavior of the parent policer, picture that when the aggregate forwarding rate of all child policers is currently above the decrement rate of the parent PIR leaky bucket, the bucket depth will increase over time. As the bucket depth increases, it will eventually cross the lowest priority’s discard-unfair threshold. If this amount of discard sufficiently lowers the remaining aggregate child policer rate, the parent PIR bucket will hover around this bucket depth. If however, the remaining aggregate child rate is still greater than the decrement rate, the bucket will continue to rise and eventually reach the lowest priority’s discard-all threshold which will cause all packets associated with the priority level to be discarded (fair and unfair). Again, if the remaining aggregate child rate is less than or equal to the bucket decrement rate, the parent PIR bucket will hover around this higher bucket depth. If the remaining aggregate child rate is still higher than the decrement rate, the bucket will continue to rise through the remaining priority level discards until equilibrium is achieved.
As noted above, each child’s rate feeding into the parent policer is governed by the child policer’s PIR bucket decrement rate. The amount of bandwidth the child policer offers to the parent policer will not exceed the child policer’s configured maximum rate.
Root Arbiter’s Parent Policer’s Priority Aggregate Thresholds
Each policer-control-policy root arbiter supports configurable aggregate priority thresholds which are used to control burst tolerance within each priority level. Two values are maintained per priority level; the shared-portion and the fair-portion. The shared-portion represents the amount of parent PIR bucket depth that is allowed to be consumed by both fair and unfair child packets at the priority level. The fair-portion represents the amount of parent PIR bucket depth that only the fair child policer packets may consume within the priority level. It should be noted that the fair and unfair child packets associated with a higher parent policer priority level may also consume the bucket depth set aside for this priority.
While the policy maintains a parent policer default or explicit configurable values for shared-portion and fair-portion within each priority level, it is possible that some priority levels will not be used within the parent policer. Most parent policer use cases require fewer than eight strict priority levels.
In order to derive the actual priority level discard-unfair and discard-all thresholds while only accounting for the actual in-use priority levels, the system maintains a child policer to parent policer association counter per priority level for each policer control policy instance. As a child policer is parented to either the root or a tiered arbiter, the system determines the parent policer priority level for the child policer and increments the association counter for that priority level on the parent policer instance.
The shared-portion for each priority level is affected by the parent policer global min-thresh-separation parameter that defines the minimum separation between any in-use discard thresholds. When more than one child policer is associated with a parent policer priority level, the shared-portion for that priority level will be the current value of min-thresh-separation. When only a single child policer is associated, the priority level’s shared-portion is zero since all packets from the child will be marked fair and the discard-unfair threshold is meaningless. When the association counter is zero, both the shared-portion and the fair-portion for that priority level are zero since neither discard thresholds will be used. Whenever the association counter is greater than 0, the fair-portion for that priority level will be derived from the current value of the priority’s mbs-contribution parameter and the global min-thresh-separation parameter.
Each priority level’s discard-unfair and discard-all thresholds are calculated based on an accumulation of lower priorities shared-portions and fair-portions and the priority level’s own shared-portion and fair-portion. The base threshold value for each priority level is equal to the sum of all lower priority level’s shared-portions and fair-portions. The discard-unfair threshold is the priority level’s base threshold plus the priority level’s shared-portion. The discard-all threshold for the priority level is the priority level’s base threshold plus both the shared-portion and fair-portion values of the priority. As can be seen, an in-use priority level’s thresholds are always greater than the thresholds of lower priority levels.
Policer Control Policy Application
A policer-control-policy may be applied on any Ethernet ingress or egress SAP that is associated with a port (or ports in the case of LAG).
The no form of the command removes a non-associated policer control policy from the system. The command will not execute when policer-name is currently associated with any SAP context.
Parameters
- policy-name
-
Specifies the policy name up to 32 characters in length. Each policer-control-policy must be created with a unique policy name. The name must adhere to the system policy ASCII naming requirements. If the defined policy name already exists, the system will enter that policy’s context for editing purposes. If policy name does not exist, the system will attempt to create a policy with the specified name.
Platforms
7705 SAR Gen 2
policer-override
policer-override
Syntax
[no] policer-override
Context
[Tree] (config>card>fp>ingress>access>queue-group policer-override)
[Tree] (config>card>fp>ingress>network>queue-group policer-override)
Full Context
configure card fp ingress access queue-group policer-override
configure card fp ingress network queue-group policer-override
Description
This command, within the SAP ingress or egress contexts, is used to create a CLI node for specific overrides to one or more policers created on the SAP through the sap-ingress or sap-egress QoS policies.
The no form of this command removes any existing policer overrides.
Default
no policer-override
Platforms
7705 SAR Gen 2
policer-override
Syntax
[no] policer-override
Context
[Tree] (config>service>epipe>sap>ingress policer-override)
[Tree] (config>service>epipe>sap>egress policer-override)
Full Context
configure service epipe sap ingress policer-override
configure service epipe sap egress policer-override
Description
This command, within the SAP ingress or egress contexts, is used to create a CLI node for specific overrides to one or more policers created on the SAP through the sap-ingress or sap-egress QoS policies.
The no form of this command is used to remove any existing policer overrides.
Default
no policer-overrides
Platforms
7705 SAR Gen 2
policer-override
Syntax
[no] policer-override
Context
[Tree] (config>service>vpls>sap>ingress policer-override)
[Tree] (config>service>vpls>sap>egress policer-override)
Full Context
configure service vpls sap ingress policer-override
configure service vpls sap egress policer-override
Description
This command, within the SAP ingress or egress contexts, is used to create a CLI node for specific overrides to one or more policers created on the SAP through the sap-ingress or sap-egress QoS policies.
The no form of this command is used to remove any existing policer overrides.
Default
no policer-overrides
Platforms
7705 SAR Gen 2
policer-override
Syntax
[no] policer-override
Context
[Tree] (config>service>ies>if>sap>ingress policer-override)
[Tree] (config>service>ies>if>sap>egress policer-override)
Full Context
configure service ies interface sap ingress policer-override
configure service ies interface sap egress policer-override
Description
This command, within the SAP ingress or egress contexts, is used to create a CLI node for specific overrides to one or more policers created on the SAP through the sap-ingress or sap-egress QoS policies.
The no form of this command is used to remove any existing policer overrides.
Default
no policer-override
Platforms
7705 SAR Gen 2
policer-override
Syntax
[no] policer-override
Context
[Tree] (config>service>vprn>if>sap>ingress policer-override)
[Tree] (config>service>vprn>if>sap>egress policer-override)
Full Context
configure service vprn interface sap ingress policer-override
configure service vprn interface sap egress policer-override
Description
This command, within the SAP ingress or egress contexts, is used to create a CLI node for specific overrides to one or more policers created on the SAP through the sap-ingress or sap-egress QoS policies.
The no form of this command is used to remove any existing policer overrides.
Default
no policer-override
Platforms
7705 SAR Gen 2
policy
policy
Syntax
policy msap-policy-name
no policy
Context
[Tree] (config>service>vpls>sap>msap-defaults policy)
Full Context
configure service vpls sap msap-defaults policy
Description
This command sets default msap-policy for all subscribers created based on trigger packets received on the specified capture-sap in case the corresponding VSA is not included in the RADIUS authentication response. This command is applicable to capture SAP only.
Default
no policy
Platforms
7705 SAR Gen 2
policy
Syntax
policy vrrp-policy-id
no policy
Context
[Tree] (config>service>ies>if>ipv6>vrrp policy)
Full Context
configure service ies interface ipv6 vrrp policy
Description
This command creates VRRP control policies. The VRRP policy ID must be created by the policy command prior to association with the virtual router instance.
The policy command provides the ability to associate a VRRP priority control policy to a virtual router instance. The policy may be associated with more than one virtual router instance. The priority events within the policy either override or diminish the base-priority dynamically affecting the in-use priority. As priority events clear in the policy, the in-use priority may eventually be restored to the base-priority value.
The policy command is only available in the non-owner vrrp virtual-router-id nodal context. The priority of owner virtual router instances is permanently set to 255 and cannot be changed by VRRP priority control policies. For non-owner virtual router instances, if the policy command is not executed, the base-priority will be used as the in-use priority.
The no form of this command removes any existing VRRP priority control policy association from the virtual router instance. All such associations must be removed prior to the policy being deleted from the system.
Parameters
- vrrp-policy-id
-
The vrrp-policy-id parameter associated the corresponding VRRP priority control policy-id with the virtual router instance. The vrrp-policy-id must already exist in the system for the policy command to be successful.
Platforms
7705 SAR Gen 2
policy
Syntax
policy vrrp-policy-id
no policy
Context
[Tree] (config>service>ies>if>vrrp policy)
Full Context
configure service ies interface vrrp policy
Description
This command creates VRRP control policies. The VRRP policy ID must be created by the policy command prior to association with the virtual router instance.
The policy command provides the ability to associate a VRRP priority control policy to a virtual router instance. The policy may be associated with more than one virtual router instance. The priority events within the policy either override or diminish the base-priority dynamically affecting the in-use priority. As priority events clear in the policy, the in-use priority may eventually be restored to the base-priority value.
The policy command is only available in the non-owner vrrp virtual-router-id nodal context. The priority of owner virtual router instances is permanently set to 255 and cannot be changed by VRRP priority control policies. For non-owner virtual router instances, if the policy command is not executed, the base-priority will be used as the in-use priority.
The no form of this command removes any existing VRRP priority control policy association from the virtual router instance. All such associations must be removed prior to the policy being deleted from the system.
Parameters
- vrrp-policy-id
-
The vrrp-policy-id parameter associated the corresponding VRRP priority control policy-id with the virtual router instance. The vrrp-policy-id must already exist in the system for the policy command to be successful.
Platforms
7705 SAR Gen 2
policy
Syntax
policy policy-name
no policy
Context
[Tree] (config>service>vprn>bgp>next-hop-res policy)
Full Context
configure service vprn bgp next-hop-resolution policy
Description
This command specifies the name of a policy statement to use with the BGP next-hop resolution process. The policy controls which IP routes in RTM are eligible to resolve the BGP next-hop addresses of IPv4 and IPv6 routes. The policy has no effect on the resolution of BGP next-hops to MPLS tunnels. If a BGP next-hop of an IPv4 or IPv6 route R is resolved in RTM and the longest matching route for the next-hop address is an IP route N that is rejected by the policy then route R is unresolved; if the route N is accepted by the policy then it becomes the resolving route for R.
The default next-hop resolution policy (when the no policy command is configured) is to use the longest matching active route in RTM that is not a BGP route (unless use-bgp-routes is configured), an aggregate route or a subscriber management route.
Default
no policy
Parameters
- policy-name
-
Specifies the route policy name. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, ?, space), the entire string must be enclosed between double quotes. Route policies are configured in the config>router>policy-options context.
Platforms
7705 SAR Gen 2
policy
Syntax
policy vrrp-policy-id
no policy
Context
[Tree] (config>service>vprn>if>vrrp policy)
[Tree] (config>service>vprn>if>ipv6>vrrp policy)
Full Context
configure service vprn interface vrrp policy
configure service vprn interface ipv6 vrrp policy
Description
This command associates a VRRP priority control policy with the virtual router instance (non-owner context only).
Parameters
- vrrp-policy-id
-
Specifies a VRRP priority control policy.
Platforms
7705 SAR Gen 2
policy
Syntax
policy vrrp-policy-id
no policy
Context
[Tree] (config>router>if>ipv6>vrrp policy)
[Tree] (config>router>if>vrrp policy)
Full Context
configure router interface ipv6 vrrp policy
configure router interface vrrp policy
Description
This command adds a VRRP priority control policy association with the virtual router instance.
To further augment the virtual router instance base priority, VRRP priority control policies can be used to override or adjust the base priority value depending on events or conditions within the chassis.
The policy can be associated with more than one virtual router instance. The priority events within the policy either override or diminish the base priority set with the priority command dynamically affecting the in-use priority. As priority events clear in the policy, the in-use priority can eventually be restored to the base priority value.
The policy command is only available in the non-owner vrrp nodal context. The priority of owner virtual router instances is permanently set to 255 and cannot be changed by VRRP priority control policies. For non-owner virtual router instances, if the policy command is not executed, the base priority is used as the in-use priority.
The no form of the command removes existing VRRP priority control policy associations from the virtual router instance. All associations must be removed prior to deleting the policy from the system.
Default
no policy — No VRRP priority control policy is associated with the virtual router instance.
Parameters
- vrrp-policy-id
-
The policy ID of the VRRP priority control expressed as a decimal integer. The vrrp-policy-id must already exist for the command to function.
Platforms
7705 SAR Gen 2
policy
Syntax
policy policy-id context context-value
policy policy-id context name name
no policy policy-id
Context
[Tree] (config>vrrp policy)
Full Context
configure vrrp policy
Description
This command creates the context to configure a VRRP priority control policy which is used to control the VRRP in-use priority based on priority control events. It is a parental node for the various VRRP priority control policy commands that define the policy parameters and priority event conditions.
The virtual router instance priority command defines the initial or base value to be used by non-owner virtual routers. This value can be modified by assigning a VRRP priority control policy to the virtual router instance. The VRRP priority control policy can override or diminish the base priority setting to establish the actual in-use priority of the virtual router instance.
The policy policy-id command must be created first, before it can be associated with a virtual router instance.
Because VRRP priority control policies define conditions and events that must be maintained, they can be resource intensive. The number of policies is limited to 1000.
The policy-id do not have to be consecutive integers. The range of available policy identifiers is from 1 to 9999.
The no form of the command deletes the specific policy-id from the system. The policy-id must be removed first from all virtual router instances before the no policy command can be issued. If the policy-id is associated with a virtual router instance, the command will fail.
Parameters
- policy-id
-
The VRRP priority control ID expressed as a decimal integer that uniquely identifies this policy from any other VRRP priority control policy defined on the system. Up to 1000 policies can be defined.
- context-value
-
Specifies the service ID to which this policy applies. A value of zero (0) means that this policy does not apply to a service but applies to the base router instance.
Platforms
7705 SAR Gen 2
policy
Syntax
policy policy-name [create] [type {access-network | port}]
no policy policy-name
Context
[Tree] (config>sys>security>dist-cpu-protection policy)
Full Context
configure system security dist-cpu-protection policy
Description
This command configures one of the maximum 18 Distributed CPU Protection (DCP) policies. These policies can be applied to objects such as SAPs, network interfaces or ports.
Parameters
- policy-name
-
Specifies the name of the policy, up to 32 characters.
- create
-
Keyword used to create a new policy.
- type
-
Specifies the Distributed CPU protection type for the policy.
Platforms
7705 SAR Gen 2
policy
Syntax
policy policy-name
no policy
Context
[Tree] (config>router>bgp>next-hop-resolution policy)
Full Context
configure router bgp next-hop-resolution policy
Description
This command specifies the policy statement name to use with the BGP next-hop resolution process. The policy determines the eligibility of IP routes in the RTM to resolve the BGP next-hop addresses of IPv4 and IPv6 routes. The policy has no effect on the resolution of BGP next hops to MPLS tunnels.
For example, if a BGP next hop of an IPv4 or IPv6 route R is resolved in RTM and the longest matching route for the next-hop address is an IP route N that is rejected by the policy then route R is unresolved. If the route N is accepted by the policy, it becomes the resolving route for R.
The no form of this command reverts to the default next-hop resolution policy, which uses the longest matching active route in RTM that is not a BGP route (unless use-bgp-routes is configured), an aggregate route or a subscriber management route.
Default
no policy
Parameters
- policy-name
-
Specifies the route policy name. Allowed values are any string up to 64 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, ?, space), the entire string must be enclosed within double quotes. Route policies are configured in the config>router>policy-options context.
Platforms
7705 SAR Gen 2
policy
Syntax
policy plcy-or-long-expr
no policy
Context
[Tree] (config>router>policy-options>policy-statement>entry>from policy)
Full Context
configure router policy-options policy-statement entry from policy
Description
This command is used to call another policy by name and evaluate it as a subroutine, or to evaluate a logical expression of subroutine policies.
If the result of the subroutine evaluation is an 'accept', then the route is considered to match the entry in the parent policy that called the subroutine. If the result of the subroutine evaluation is a 'reject’, then the route is considered a non-match of the entry in the parent policy that called the subroutine.
Up to 3 levels of subroutine calls are supported. If a subroutine at maximum depth has this command, it is automatically considered a non-match of all routes.
The no form of this command removes the policy statement as a match criterion.
Default
no policy
Parameters
- plcy-or-long-expr
-
Specifies the name of a single policy-statement (up to 64 characters in length) or a policy logical expression (up to 255 characters in length) consisting of policy-statement names (enclosed in square brackets), logical operations ('and’, 'or’, 'not’), and parentheses for grouping.
Platforms
7705 SAR Gen 2
policy
Syntax
[no] policy association-name
Context
[Tree] (config>router>pcep>pcc>pce-assoc policy)
Full Context
configure router pcep pcc pce-associations policy
Description
This command creates a named PCE policy association from which the parameters for specified policy association are configured.
The no form of the command deletes the specified policy association.
Parameters
- association-name
-
Specifies the name of the policy association, up to 32 characters.
Platforms
7705 SAR Gen 2
policy
Syntax
[no] policy policy-assoc-name
Context
[Tree] (config>router>mpls>lsp-template>pce-assoc policy)
[Tree] (config>router>mpls>lsp>pce-assoc policy)
Full Context
configure router mpls lsp-template pce-associations policy
configure router mpls lsp pce-associations policy
Description
This command binds the LSP to a named policy association. The policy association name must exist under the PCC. Up to five policy associations can be configured per LSP.
The no form of the command removes the LSP binding from the specified policy association.
Parameters
- policy-assoc-name
-
Specifies the name of an existing policy association, up to 32 characters.
Platforms
7705 SAR Gen 2
policy-options
policy-options
Syntax
[no] policy-options
Context
[Tree] (config>router policy-options)
Full Context
configure router policy-options
Description
Commands in this context configure route policies. Route policies are applied to the routing protocol.
The no form of this command deletes the route policy configuration.
Platforms
7705 SAR Gen 2
policy-reference-checks
policy-reference-checks
Syntax
[no] policy-reference-checks
Context
[Tree] (config>router policy-reference-checks)
Full Context
configure router policy-reference-checks
Description
This command checks policy references to ensure that a policy exists and displays a CLI error if the policy does not exist. Enabling this option protects against accidentally referencing a missing or misspelled policy, that can lead to unexpected results when the policy is evaluated.
The no version of this command disables policy reference checks and allows policies that do not exist to be referenced.
Default
no policy-reference-checks
Platforms
7705 SAR Gen 2
policy-statement
policy-statement
Syntax
[no] policy-statement name
Context
[Tree] (config>router>policy-options policy-statement)
Full Context
configure router policy-options policy-statement
Description
This command creates the context to configure a route policy statement.
Route policy statements control the flow of routing information to and from a specific protocol, set of protocols, or to a specific BGP neighbor.
The policy-statement is a logical grouping of match and action criteria. A single policy-statement can affect routing in one or more protocols and/or one or more protocols peers/neighbors. A single policy-statement can also affect both the import and export of routing information.
The no form of this command deletes the policy statement.
Default
no policy-statement
Parameters
- name
-
Specifies the route policy statement name. Allowed values are any string up to 64 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, ?, space), the entire string must be enclosed within double quotes.
Platforms
7705 SAR Gen 2
policy-variables
policy-variables
Syntax
policy-variables
Context
[Tree] (config>router>policy-options>policy-statement>entry>from policy-variables)
Full Context
configure router policy-options policy-statement entry from policy-variables
Description
Commands in this context configure policy-variables parameters.
The no form of this command removes all policy variables.
Platforms
7705 SAR Gen 2
poll
poll
Syntax
poll ca ca-profile-name
Context
[Tree] (admin>certificate>cmpv2 poll)
Full Context
admin certificate cmpv2 poll
Description
This command polls the status of the pending CMPv2 request toward the specified CA.
If the response is ready, this command will resume the CMPv2 protocol exchange with server as the original command would do. The requests could be also still be pending as a result, then this command could be used again to poll the status.
SR OS allows only one pending CMP request per CA, which means no new request is allowed when a pending request is present.
Parameters
- ca-profile-name
-
Specifies a ca-profile name up to 32 characters.
Platforms
7705 SAR Gen 2
poll-interval
poll-interval
Syntax
poll-interval seconds
no poll-interval
Context
[Tree] (config>service>vprn>ospf>area>if poll-interval)
[Tree] (config>service>vprn>ospf3>area>if poll-interval)
Full Context
configure service vprn ospf area interface poll-interval
configure service vprn ospf3 area interface poll-interval
Description
This command configures the poll interval, in seconds. The poll interval is the time between two Hello packets to a dead (non-adjacent) OSPF NBMA neighbor. The default value of the poll interval timer is higher than the hello interval timer to avoid wasting bandwidth on non-broadcast networks, since OSPF messages are unicast to each configured neighbor. The poll interval timer is used only on non-broadcast interface types and has no effect if configured on other interface types.
The no form of this command removes the poll-interval configuration.
Default
120
Parameters
- seconds
-
Specifies the poll interval, in seconds.
Platforms
7705 SAR Gen 2
poll-interval
Syntax
poll-interval seconds
no poll-interval
Context
[Tree] (config>router>ospf3>area>interface poll-interval)
[Tree] (config>router>ospf>area>interface poll-interval)
Full Context
configure router ospf3 area interface poll-interval
configure router ospf area interface poll-interval
Description
This command configures the poll interval, in seconds. The poll interval is the time between two Hello packets to a dead (non-adjacent) OSPF NBMA neighbor. The default value of the poll interval timer is higher than the hello interval timer to avoid wasting bandwidth on non-broadcast networks, since OSPF messages are unicast to each configured neighbor. The poll interval timer is used only on non-broadcast interface types and has no effect if configured on other interface types.
The no form of this command removes the poll-interval configuration.
Default
120
Parameters
- seconds
-
Specifies the poll interval, in seconds.
Platforms
7705 SAR Gen 2
pool
pool
Syntax
pool pool-name [create]
no pool pool-name
Context
[Tree] (config>router>dhcp6>server pool)
[Tree] (config>service>vprn>dhcp6>server pool)
[Tree] (config>router>dhcp>server pool)
[Tree] (config>service>vprn>dhcp>server pool)
Full Context
configure router dhcp6 local-dhcp-server pool
configure service vprn dhcp6 local-dhcp-server pool
configure router dhcp local-dhcp-server pool
configure service vprn dhcp local-dhcp-server pool
Description
This command configures a DHCP address pool on the router.
The no form of this command removes the pool name from the configuration.
Parameters
- pool name
-
Specifies the name of this IP address pool. Allowed values are any string, up to 32 characters.
- create
-
Keyword used to create the pool. The create keyword requirement can be enabled or disabled in the environment>create context.
Platforms
7705 SAR Gen 2
pool
Syntax
pool [name]
Context
[Tree] (config>port>access>ingress pool)
[Tree] (config>port>network>egress pool)
[Tree] (config>port>access>egress pool)
Full Context
configure port access ingress pool
configure port network egress pool
configure port access egress pool
Description
This command configures pool policies.
On the MDA level, access and network egress and access ingress pools are only allocated on channelized MDAs. Network ingress pools are allocated on the FP level for non-channelized MDAs.
Default
pool default
Parameters
- name
-
If specified, the name must be default.
Platforms
7705 SAR Gen 2
pool
Syntax
pool [name]
Context
[Tree] (config>card>fp>ingress>network pool)
Full Context
configure card fp ingress network pool
Description
This command configures the per-FP network ingress pool.
Default
pool default
Parameters
- name
-
If specified, the name must be default.
Platforms
7705 SAR Gen 2
pool
Syntax
pool nat-pool-name [nat-group nat-group-id type pool-type [ applications applications] [create]
no pool nat-pool-name
Context
[Tree] (config>service>vprn>nat>outside pool)
Full Context
configure service vprn nat outside pool
Description
This command configures a NAT pool.
Parameters
- nat-pool-name
-
Specifies the NAT pool name.
- nat-group-id
-
Specifies the NAT group ID.
- create
-
This parameter must be specified to create the instance.
- pool-type
-
Specifies the pool type.
- applications
-
Specifies the application.
- create
-
Keyword used to create the pool.
Platforms
7705 SAR Gen 2
pool
Syntax
pool nat-pool-name nat-group nat-group-id type pool-type [applications applications] [create]
no pool nat-pool-name
Context
[Tree] (config>router>nat>outside pool)
Full Context
configure router nat outside pool
Description
This command creates a NAT pool in the outside routing context. The NAT pool defines the parameters that will be used for IP address and port translation within the pool.
Parameters
- nat-pool-name
-
Specifies the NAT pool name, up to 32 characters.
- nat-group-id
-
Specifies the NAT group ID.
- create
-
Creates the instance.
- pool-type
-
Species the pool type.
- applications
-
This creation-time parameter configures the NAT pool for protocol agnostic operation. The IP addresses are translated in 1:1 fashion regardless of the protocol. No ports are translated for TCP or UDP traffic. Traffic through the pool can be initiated from inside or outside. When nat-pool is configured in agnostic mode, certain parameters in the pool are pre-set and cannot be changed:
-
mode one-to-one
-
port-forwarding-range 0
-
port-reservation blocks 1
-
subscriber-limit 1
-
deterministic port-reservation 65536.
This pool is used to configure static 1:1 NAT, where the operator have the control of the mapping between the inside and outside IP addresses. The static IP address mapping is using CLI constructs used in deterministic NAT (prefix and map deterministic NAT commands in the inside routing context).
ALG for TCP/UDP is supported in the protocol agnostic pool.
-
Platforms
7705 SAR Gen 2
pool
Syntax
pool nat-pool-name service-name service-name
pool nat-pool-name router router-instance
no pool
Context
[Tree] (config>service>nat>nat-policy pool)
Full Context
configure service nat nat-policy pool
Description
This command configures the NAT pool of this policy.
Parameters
- nat-pool-name
-
Specifies the name of the NAT pool, up to 32 characters.
- router-instance
-
Specifies the router instance the pool belongs to, either by router name or service ID.
- service-name
-
Specifies the name of the service, up to 64 characters.
Platforms
7705 SAR Gen 2
pool-name
pool-name
Syntax
[no] pool-name
Context
[Tree] (config>service>ies>if>dhcp>option>vendor pool-name)
[Tree] (config>service>vprn>if>dhcp>option>vendor pool-name)
Full Context
configure service ies interface dhcp option vendor-specific-option pool-name
configure service vprn interface dhcp option vendor-specific-option pool-name
Description
This command sends the pool name in the Nokia vendor specific sub-option of the DHCP relay packet.
The no form of this command reverts to the default.
Platforms
7705 SAR Gen 2
pool-name
Syntax
[no] pool-name
Context
[Tree] (config>router>if>dhcp>option>vendor-specific-option pool-name)
Full Context
configure router interface dhcp option vendor-specific-option pool-name
Description
This command enables the sending of the pool name in the Nokia vendor-specific suboption of the DHCP relay packet.
The no form of this command disables the feature.
Default
no pool-name
Platforms
7705 SAR Gen 2
pop
pop
Syntax
[no] pop
Context
[Tree] (config>router>mpls>if>label-map pop)
Full Context
configure router mpls interface label-map pop
Description
This command specifies that the incoming label must be popped (removed). No label stacking is supported for a static LSP. The service header follows the top label. Once the label is popped, the packet is forwarded based on the service header.
The no form of this command removes the pop action for the in-label.
Platforms
7705 SAR Gen 2
populate
populate
Syntax
populate {static | dynamic | evpn} [ route-tag [1..255]]
no populate {static | dynamic | evpn}
Context
[Tree] (config>service>vprn>if>ipv6>nd-host-route populate)
[Tree] (config>service>vprn>if>arp-host-route populate)
[Tree] (config>service>ies>if>arp-host-route populate)
Full Context
configure service vprn interface ipv6 nd-host-route populate
configure service vprn interface arp-host-route populate
configure service ies interface arp-host-route populate
Description
This command enables the creation of ARP/ND host-route entries in the route-table out of a certain ARP/ND entry type.
The no form of this command reverts to the default.
Default
no populate
Parameters
- evpn
-
Enables the creation of ARP-ND host routes in the route table out of EVPN ARP/ND entries (entries learned from EVPN MAC/IP routes).
- dynamic
-
Enables the creation of ARP-ND host routes in the route table out of dynamic ARP/ND entries (learned from received ARP/ND messages from the hosts).
- static
-
Enables the creation of ARP-ND host routes in the route table out of configured static ARP/ND entries.
- route-tag [1..255]
-
Specifies the route tag that is added in the route table for ARP-ND host routes of type evpn, dynamic, or static. This tag can be matched on BGP VRF export and BGP peer export policies.
Platforms
7705 SAR Gen 2
port
port
Syntax
port port-id [sync-tag sync-tag] [create]
no port port-id]
Context
[Tree] (config>redundancy>multi-chassis>peer>sync port)
Full Context
configure redundancy multi-chassis peer sync port
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
- port-id
-
Specifies the port to be synchronized with the multi-chassis peer.
- sync-tag
-
Specifies a synchronization tag, up to 32 characters in length, to be used while synchronizing this port with the multi-chassis peer.
- create
-
Creates an entry; mandatory while creating an entry.
Platforms
7705 SAR Gen 2
port
Syntax
[no] port {port-id | aps-id | connector-port-id}
Context
[Tree] (config port)
Full Context
configure port
Description
This command enables access to the context to configure ports, multilink bundles, and bundle protection groups (BPGs). Before a port can be configured, the chassis slot must be provisioned with a valid card type and the MDA parameter must be provisioned with a valid MDA type.
Default
No ports are configured. All ports must be explicitly configured and enabled.
Parameters
- port-id
-
Specifies the physical port ID in the following format:
- aps-id
-
This option configures APS on unbundled SONET/SDH ports. All SONET-SDH port parameters, with certain exceptions, for the working and protection circuit ports must be configured in the config>port>aps-id context. The working and protection circuit ports inherit all those parameters configured. The exception parameters for the working and protect circuits can be configured in the config>port>sonet-sdh context. Exception list commands include:
-
clock-source
-
[no] loopback
-
[no] report-alarm
-
section-trace
-
[no] threshold
When an configure port aps-id is created all applicable parameters under the port CLI tree (including parameters under any submenus) assume aps-id defaults, or when those are not explicitly specified, default to SONET/SDH port defaults for any SONET port.
All but a few exception SONET/SDH parameters for the working channel port must be configured in the configure port sonet-sdh context. The protection channel inherits all the configured parameters. The exception parameters for the protection channel can be configured in the configure port sonet-sdh context.
Signal failure (SF) and signal degrade (SD) alarms are not enabled by default on POS interfaces. It is recommended to change the default alarm notification configuration for POS ports that belong to APS groups in order to be notified of SF/SD occurrences to be able to interpret the cause for an APS group to switch the active line.
For path alarms, modify the logical line aps-id in the configure port aps-id <sonet-sdh>path report-alarm context. For example:
configure port aps-1 sonet-sdh path report-alarm p-ais
For line alarms, separately, modify the 2 physical ports that are members of the logical aps-id port (the working and protect lines). APS reacts only to line alarms, not path alarms. For example:
configure port 1/2/3 sonet-sdh report-alarm lb2er-sd
configure port 4/5/6 sonet-sdh report-alarm lb2er-sd
If the SD and SF threshold rates must be modified, the changes must be performed at the line level on both the working and protect APS port member.
The no form of this command deletes an aps-group-id or bundle-aps-group-id. In order for an aps- group-id to be deleted,
The same rules apply for physical ports, bundles deletions apply to APS ports/bundles deletions (for example an aps-group-id must be shutdown, have no service configuration on it, and no path configuration on it). In addition working and protection circuits must be removed before an aps-group-id may be removed.
-
- connector-port-id
-
Specifies the physical port of a connector in the following format.
Platforms
7705 SAR Gen 2
port
Syntax
port port-id
no port
Context
[Tree] (config>port-xc>pxc port)
Full Context
configure port-xc pxc port
Description
This command configures the referenced Ethernet port as a loopback or a cross-connect port (PXC). When this command is executed, the system automatically creates two PXC subports under this Ethernet port.
The physical PXC port does not require any external connectivity or optical transceivers to function properly. Consequently, all optic-related alarms are disabled on the port.
The physical PXC port is automatically configured as a hybrid port. The MTU is preset to 9212 bytes, the encapsulation type is set to dot1q, and dot1x tunneling is turned on.
A single physical port can be associated with more than one PXC. In other words, multiple PXCs are supported per physical port. Because PXC subports use a single physical port to transmit traffic in both directions, the nominal port bandwidth is asymmetrically divided between the two directions. For example, a 10 Gb/s Ethernet port in PXC mode can accommodate 9 Gb/s of traffic in one direction and 1 Gb/s in the other. Any other ratio can be achieved as long as the sum of the bandwidth of the two PXC subports does not exceed the bandwidth capacity of the physical port (10 Gb/s in this case).
Since the PXC uses a single physical port to transmit traffic in both directions, the nominal port bandwidth is asymmetrically divided between the two directions. For example, a 10 Gb/s Ethernet port in PXC mode can accommodate 9 Gb/s of traffic in one direction and 1 Gb/s in the other. Any other ratio can be achieved as long as the sum of the bandwidth of the two PXC subports does not exceed the bandwidth capacity of the physical port (10 Gb/s in this case).
The following rules apply to PXC port configurations:
-
Only unused physical ports (not associated with an interface or SAP) can be referenced inside of a PXC ID configuration.
-
The physical port cannot be removed from a PXC ID configuration if the corresponding PXC subports are currently in use.
-
A physical port cannot be used outside the configured PXC context. For example, a regular IP interface cannot use this physical port, or a SAP on that port cannot be associated with a service.
The no form of this command removes the port ID from the configuration.
Parameters
- port-id
-
Specifies the physical port in the slot/mda/port format.
Platforms
7705 SAR Gen 2
port
Syntax
port port-id [port-id] [priority priority] [sub-group sub-group-id] [hash-weight weight]
no port port-id [port-id]
Context
[Tree] (config>lag port)
Full Context
configure lag port
Description
This command adds ports to a Link Aggregation Group (LAG).
The port configuration of the first port added to the LAG is used as a basis to compare to subsequently added ports. If a discrepancy is found with a newly added port, that port will not be added to the LAG.
Multiple (space separated) ports can be added or removed from the LAG link assuming the maximum of number of ports is not exceeded.
Ports that are part of a LAG must be configured with auto-negotiate limited or disabled.
The no form of this command removes ports from the LAG.
Default
No ports are defined as members of a LAG.
Parameters
- port-id
-
Specifies the port ID.
The maximum number of ports in a LAG depends on the platform type, the hardware deployment, and the SR OS software release. Adding a port over the maximum allowed per given router or switch is blocked. Some platforms support double port scale for specific port types on LAGs with LAG ID in the range of 1 to 64 inclusive. Up to 16 ports can be specified in a single statement, up to 64 ports total.
- priority
-
Specifies the port priority used by LACP. The port priority is also used to determine the primary port. The port with the lowest priority is the primary port. In the event of a tie, the smallest port ID becomes the primary port.
- sub-group-id
-
Identifies a LAG subgroup. When using subgroups in a LAG, they should only be configured on one side of the LAG, not both. Only having one side perform the active/standby selection guarantees a consistent selection and fast convergence. The active or standby selection is signaled through LACP to the other side. The hold time should be configured when using subgroups to prevent the LAG going down when switching between active and standby subgroup since momentarily all ports are down in a LAG (break-before-make).
- weight
-
Specifies the flow hashing distribution between LAG ports.
Platforms
7705 SAR Gen 2
port
Syntax
port port
no port
Context
[Tree] (config>service>vprn>aaa>rmt-srv>radius port)
Full Context
configure service vprn aaa remote-servers radius port
Description
This command configures the UDP port number to contact the RADIUS server.
The no form of this command reverts to the default value.
Default
port 1812 (as specified in RFC 2865, Remote Authentication Dial In User Service (RADIUS))
Parameters
- port
-
Specifies the UDP port number to contact the RADIUS server.
Platforms
7705 SAR Gen 2
port
Syntax
port value
no port
Context
[Tree] (config>service>vprn>log>syslog port)
Full Context
configure service vprn log syslog port
Description
This command configures the UDP port that will be used to send syslog messages to the syslog target host.
The port configuration is needed if the syslog target host uses a port other than the standard UDP syslog port 514.
Only one port can be configured. If multiple port commands are entered, the last entered port overwrites the previously entered ports.
The no form of this command reverts to default value.
Default
no port
Parameters
- value
-
The value is the configured UDP port number used when sending syslog messages.
Platforms
7705 SAR Gen 2
port
Syntax
port {port-id | lag lag-id} [egress] [ingress]
no port {port-id | lag lag-id} {[egress] [ ingress]}
Context
[Tree] (config>mirror>mirror-source port)
Full Context
configure mirror mirror-source port
Description
This command enables mirroring of traffic ingressing or egressing a port (Ethernet port, SONET/SDH channel, TDM channel, or Link Aggregation Group (LAG)).
The port command associates a port or LAG to a mirror source. The port is identified by the port-id. The defined port may be Ethernet, Access or network, SONET/SDH, or TDM channel access. A network port may be a single port or a Link Aggregation Group (LAG) ID. When a LAG ID is given as the port-id, mirroring is enabled on all ports making up the LAG. If the port is a SONET/SDH interface, the channel-id must be specified to identify which channel is being mirrored. Either a LAG port member or the LAG port can be mirrored.
The port is only referenced in the mirror source for mirroring purposes. The mirror source association does not need to be removed before deleting the card to which the port belongs. If the port is removed from the system, the mirroring association will be removed from the mirror source.
The same port may not be associated with multiple mirror source definitions with the ingress parameter defined. The same port may not be associated with multiple mirror source definitions with the egress parameter defined.
If a SAP is mirrored on an access port, the SAP mirroring will have precedence over the access port mirroring when a packet matches the SAP mirroring criteria. Filter and label mirroring destinations will also precedence over a port-mirroring destination.
If the port is not associated with a mirror-source, packets on that port will not be mirrored. Mirroring may still be defined for a SAP, label or filter entry, which will mirror based on a more specific criteria.
The encapsulation type on an access port or channel cannot be changed to Frame Relay if it is being mirrored.
The no port command disables port mirroring for the specified port. Mirroring of packets on the port may continue due to more specific mirror criteria. If the egress or ingress parameter keywords are specified in the no command, only the ingress or egress mirroring condition will be removed.
Parameters
- port-id
-
Specifies the port ID.
port-id
slot/mda/port [.channel]
eth-sat-id
esat-id/slot/port
esat
keyword
id
1 to 20
pxc-id
pxc-id.sub-port
pxc
keyword
id
1 to 64
sub-port
a, b
bgrp-id
bpgrp-type-bpgrp-num
bgrp
keyword
type
ima, ppp
bgrp-num
1 to 2000
ccag-id
ccag-id.path-id cc-type:cc-id
ccag
keyword
id
1 to 8
path-id
a, b
cc-type
sap-net, .net-sap
cc-id
0 to 4094
- lag-id
-
The LAG identifier, expressed as a decimal integer.
- egress
-
Specifies that packets egressing the port should be mirrored. Egress packets are mirrored to the mirror destination after egress packet modification.
- ingress
-
Specifies that packets ingressing the port should be mirrored. Ingress packets are mirrored to the mirror destination prior to ingress packet modification.
Platforms
7705 SAR Gen 2
port
Syntax
port {port-id | lag lag-id} {[egress] [ingress]}
no port {port-id | lag lag-id} [egress] [ ingress]
Context
[Tree] (debug>mirror-source port)
Full Context
debug mirror-source port
Description
This command enables mirroring of traffic ingressing or egressing a port (Ethernet port, SONET/SDH channel, TDM channel, or Link Aggregation Group (LAG)).
The port command associates a port or LAG to a mirror source. The port is identified by the port-id. The defined port may be Ethernet, Access or network, SONET/SDH, or TDM channel access. A network port may be a single port or a Link Aggregation Group (LAG) ID. When a LAG ID is given as the port-id, mirroring is enabled on all ports making up the LAG. If the port is a SONET/SDH interface, the channel-id must be specified to identify which channel is being mirrored. Either a LAG port member or the LAG port can be mirrored.
The port is only referenced in the mirror source for mirroring purposes. The mirror source association does not need to be removed before deleting the card to which the port belongs. If the port is removed from the system, the mirroring association will be removed from the mirror source.
The same port may not be associated with multiple mirror source definitions with the ingress parameter defined. The same port may not be associated with multiple mirror source definitions with the egress parameter defined.
If a SAP is mirrored on an access port, the SAP mirroring will have precedence over the access port mirroring when a packet matches the SAP mirroring criteria. Filter and label mirroring destinations will also precedence over a port-mirroring destination.
If the port is not associated with a mirror-source, packets on that port will not be mirrored. Mirroring may still be defined for a SAP, label or filter entry, which will mirror based on a more specific criteria.
The encapsulation type on an access port or channel cannot be changed to Frame Relay if it is being mirrored.
The no port command disables port mirroring for the specified port. Mirroring of packets on the port may continue due to more specific mirror criteria. If the egress or ingress parameter keywords are specified in the no command, only the ingress or egress mirroring condition will be removed.
Parameters
- port-id
-
Specifies the port ID.
port-id
slot/mda/port [.channel]
eth-sat-id
esat-id/slot/port
esat
keyword
id
1 to 20
pxc-id
pxc-id.sub-port
pxc
keyword
id
1 to 64
sub-port
a, b
ccag-id
ccag-id.path-id cc-type:cc-id
ccag
keyword
id
1 to 8
path-id
a,b
cc-type
sap-net, net-sap
cc-id
0 to 4094
- lag-id
-
Specifies the LAG identifier, expressed as a decimal integer.
- egress
-
Specifies that packets egressing the port should be mirrored. Egress packets are mirrored to the mirror destination after egress packet modification.
- ingress
-
Specifies that packets ingressing the port should be mirrored. Ingress packets are mirrored to the mirror destination prior to ingress packet modification.
Platforms
7705 SAR Gen 2
port
Syntax
port {lt | gt | eq} port-number
port port-list port-list-name
port range port-number port-number
no port
Context
[Tree] (config>filter>ipv6-filter>entry>match port)
[Tree] (config>filter>ipv6-exception>entry>match port)
[Tree] (config>filter>ip-filter>entry>match port)
Full Context
configure filter ipv6-filter entry match port
configure filter ipv6-exception entry match port
configure filter ip-filter entry match port
Description
This command configures a TCP/UDP/SCTP source or destination port match criterion in IPv4 and IPv6 CPM (SCTP not supported) and/or ACL filter policies. A packet matches this criterion if the packet TCP/UDP/SCTP (as configured by protocol/next-header match) source OR destination port matches either the specified port value or a port in the specified port range or port-list.
Operational Note: This command is mutually exclusive with src-port and dst-port commands. Configuring "port eq 0", may match non-initial fragments where the source/destination port values are not present in a packet fragment if other match criteria are also met.
The no form of this command deletes the specified port match criterion.
Default
no port
Parameters
- lt | gt | eq
-
Specifies the operator to use relative to port-number for specifying the port number match criteria.
- lt
-
Specifies that all port numbers less than port-number match.
- gt
-
Specifies that all port numbers greater than port-number match.
- eq
-
Specifies that the port-number must be an exact match.
- port-number
-
Specifies a source or destination port to be used as a match criterion. The port number can be expressed as a decimal integer, as well as in hexadecimal or binary format. The following value shows a decimal integer only.
- port-list port-list-name
-
Specifies an inclusive range of source or destination port values to be used as match criteria.
- range port-number port-number
-
Specifies an inclusive range of source or destination port values to be used as match criteria.
Platforms
7705 SAR Gen 2
port
Syntax
[no] port port-number
[no] port range start end
Context
[Tree] (config>filter>match-list>port-list port)
Full Context
configure filter match-list port-list port
Description
This command adds a port or a range of ports to an existing port match list. The no form of this command deletes the specified port or range of ports form the list.
Parameters
- port-number
-
Specifies the port number to add to the list. The port number can be expressed as a decimal integer, as well as in hexadecimal or binary format. Below shows decimal integer only.
- start end
-
Specifies an inclusive port range between two port numbers values. The start of the range and end of the range can be expressed as decimal integers, as well as in hexadecimal or binary format. The following value shows decimal integer only.
Platforms
7705 SAR Gen 2
port
Syntax
port port-id
no port
Context
[Tree] (config>router>origin-validation>rpki-session port)
Full Context
configure router origin-validation rpki-session port
Description
This command configures the destination port number to use when contacting the cache server. The default port number is 323. The port cannot be changed without first shutting down the session.
Default
no port
Parameters
- port-id
-
Specifies a port ID.
Platforms
7705 SAR Gen 2
port
Syntax
port port-name
no port
Context
[Tree] (config>router>if port)
Full Context
configure router interface port
Description
This command creates an association with a logical IP interface and a physical port.
An interface can also be associated with the system (loopback address).
The command returns an error if the interface is already associated with another port or the system. In this case, the association must be deleted before the command is re-attempted. The port-id or port-id for Ethernet ports can be in one of the following forms:
Ethernet interfaces
If the card in the slot has MDAs/XMAs, port-id is in the slot_number/MDA or XMA _number/port_number format; for example, 1/1/3 specifies port 3 of the MDA/XMA installed in MDA/XMA slot 1 on the card installed in chassis slot 1.
SONET/SDH interfaces
When the port-id represents a POS interface, the port-id must include the channel-id. The POS interface must be configured as a network port.
The no form of this command deletes the association with the port. The no form of this command can only be performed when the interface is administratively down.
Default
no port
Parameters
- port-name
-
The physical port identifier to associate with the IP interface.
Platforms
7705 SAR Gen 2
port
Syntax
port value
no port
Context
[Tree] (config>log>syslog port)
Full Context
configure log syslog port
Description
This command configures the UDP port that will be used to send syslog messages to the syslog target host.
The port configuration is needed if the syslog target host uses a port other than the standard UDP syslog port 514.
Only one port can be configured. If multiple port commands are entered, the last entered port overwrites the previously entered ports.
The no form of this command removes the value from the configuration.
Parameters
- value
-
Specifies the value that is the configured UDP port number used when sending syslog messages.
Platforms
7705 SAR Gen 2
port
Syntax
port port
no port
Context
[Tree] (config>system>netconf>listen port)
Full Context
configure system netconf listen port
Description
This command specifies the port on which the SR OS NETCONF server listens for new connections. Only one port can be configured for NETCONF management.
The configured port applies to both non-VPRN and VPRN management. New NETCONF connections are able to use the configured port. The SR OS NETCONF server errors if a port, different from the configured port, is used to SSH to the SR OS NETCONF server. For NETCONF connections not using VPRN management, active NETCONF connections are not disconnected if the port used to establish the connections is changed. For NETCONF connections using VPRN management, active NETCONF connections are disconnected if the port used to establish the connections is changed.
The no form of this command resets the port on which the SR OS NETCONF server listens to the default port of 830.
Parameters
- port
-
Specifies the port on which NETCONF listens for new connections.
Platforms
7705 SAR Gen 2
port
Syntax
port port
no port
Context
[Tree] (config>system>security>radius port)
Full Context
configure system security radius port
Description
This command configures the TCP port number to contact the RADIUS server.
The no form of this command reverts to the default value.
Default
port 1812 (as specified in RFC 2865, Remote Authentication Dial In User Service (RADIUS))
Parameters
- port
-
Specifies the TCP port number to contact the RADIUS server.
Platforms
7705 SAR Gen 2
port
Syntax
port port
no port
Context
[Tree] (config>system>grpc-tunnel>tunnel>handler port)
Full Context
configure system grpc-tunnel tunnel handler port
Description
This command assigns the TCP port number that the handler listens to internally.
The no form of this command disables the handler from listening to a TCP port.
Default
no port
Parameters
- port
-
Specifies the TCP port number.
Platforms
7705 SAR Gen 2
port-control
port-control
Syntax
port-control [auto | force-auth | force-unauth]
Context
[Tree] (config>port>ethernet>dot1x port-control)
Full Context
configure port ethernet dot1x port-control
Description
This command configures the 802.1x authentication mode.
The no form of this command returns the value to the default.
Default
port-control force-auth
Parameters
- force-auth
-
Disables 802.1x authentication and causes the port to transition to the authorized state without requiring any authentication exchange. The port transmits and receives normal traffic without requiring 802.1x-based host authentication.
- force-unauth
-
Causes the port to remain in the unauthorized state, ignoring all attempts by the hosts to authenticate. The switch cannot provide authentication services to the host through the interface.
- auto
-
Enables 802.1x authentication. The port starts in the unauthorized state, allowing only EAPoL frames to be sent and received through the port. Both the router and the host can initiate an authentication procedure. The port will remain in unauthorized state (no traffic except EAPoL frames is allowed) until the first client is authenticated successfully. After this, traffic is allowed on the port for all connected hosts.
Platforms
7705 SAR Gen 2
port-down
port-down
Syntax
[no] port-down port-id
Context
[Tree] (config>vrrp>policy>priority-event port-down)
Full Context
configure vrrp policy priority-event port-down
Description
This command configures a port down priority control event that monitors the operational state of a port or SONET/SDH channel. When the port or channel enters the operational down state, the event is considered set. When the port or channel enters the operational up state, the event is considered cleared.
Multiple unique port-down event nodes can be configured within the priority-event context up to the overall limit of 32 events. Up to 32 events can be defined in any combination of types.
The port-down command can reference an arbitrary port or channel. The port or channel does not need to be preprovisioned or populated within the system. The operational state of the port-down event is set as follows:
-
Set – non-provisioned
-
Set – not populated
-
Set – down
-
Cleared – up
When the port or channel is provisioned, populated, or enters the operationally up or down state, the event operational state is updated appropriately.
When the event enters the operationally down, non-provisioned, or non-populated state, the event is considered to be set. When an event transitions from clear to set, the set is processed immediately and must be reflected in the associated virtual router instances in-use priority value. As the event transitions from cleared to set, a hold-set timer is loaded with the value configured by the events hold-set command. This timer prevents the event from clearing until it expires, damping the effect of event flapping. If the event clears and becomes set again before the hold-set timer expires, the timer is reset to the hold-set value, extending the time before another clear can take effect.
When the event enters the operationally up state, the event is considered to be cleared. Once the events hold-set expires, the effects of the events priority value are immediately removed from the in-use priority of all associated virtual router instances.
The actual effect on the virtual router instance in-use priority value depends on the defined event priority and its delta or explicit nature.
The no form of the command deletes the specific port or channel monitoring event. The event may be removed at anytime. When the event is removed, the in-use priority of all associated virtual router instances will be re-evaluated. The events hold-set timer has no effect on the removal procedure.
Default
no port-down — No port down priority control events are defined.
Parameters
- port-id
-
The port ID of the port monitored by the VRRP priority control event.
The port-id can only be monitored by a single event in this policy. The port can be monitored by multiple VRRP priority control policies. A port and a specific channel on the port are considered to be separate entities. A port and a channel on the port can be monitored by separate events in the same policy.
Platforms
7705 SAR Gen 2
port-forwarding
port-forwarding
Syntax
port-forwarding
Context
[Tree] (config>service>nat port-forwarding)
Full Context
configure service nat port-forwarding
Description
Commands in this context configure NAT port forwarding parameters.
Platforms
7705 SAR Gen 2
port-forwarding-dyn-block-reservation
port-forwarding-dyn-block-reservation
Syntax
[no] port-forwarding-dyn-block-reservation
Context
[Tree] (config>router>nat>outside>pool port-forwarding-dyn-block-reservation)
[Tree] (config>service>vprn>nat>outside>pool port-forwarding-dyn-block-reservation)
Full Context
configure router nat outside pool port-forwarding-dyn-block-reservation
configure service vprn nat outside pool port-forwarding-dyn-block-reservation
Description
This command will enable the reservation of the dynamic port blocks when the first port forward for the subscriber is created. The dynamic port bloc allocation is logged only if the block is being utilized (mapping are created). In other words, dynamic port block reservation due to the port forward creation but without any dynamic mapping, will not be logged.
The reserved port block will be released only when the last mapping in the block expires and there is not port forward associated with the subscriber. The de-allocation log (syslog or Radius) will be generated when the dynamic port block is completely released.
Dynamic port block reservation can be enabled only if the configured maximum number of subscriber per outside IP address is less or equal then the maximum number of configured port blocks per outside IP address.
Default
no port-forwarding-dyn-block-reservation
Platforms
7705 SAR Gen 2
port-forwarding-range
port-forwarding-range
Syntax
port-forwarding-range [range-start] range-end
no port-forwarding-range
Context
[Tree] (config>router>nat>outside>pool port-forwarding-range)
[Tree] (config>service>vprn>nat>outside>pool port-forwarding-range)
Full Context
configure router nat outside pool port-forwarding-range
configure service vprn nat outside pool port-forwarding-range
Description
This command configures the lower and upper limit for port forwards in the ephemeral port space (wildcard port space) of all IP addresses in a NAT pool. A well-known port range (ports 1 to 1023) is always enabled for port forwards, and it cannot be disabled for pools in NAPT mode.
Pools in 1:1 mode do not support configured port forwards. These pools do not perform port translation and they automatically forward traffic initiated on the outside toward the inside.
Port 0 is always excluded from the port forwarding range.
The upper bound of the wildcard port range is reserved for port forwards. If the value for the range-start is not provided, the wildcard port range implicitly starts at 1024.
range-start 0 cannot be configured by an operator because it is reserved for 1:1 pools that do not support configured port forwards.
If you configure port-forwarding-range 3000, configures ports 1 to 3000 as port forwards. This implies that the well-known ports and wildcard ports are contiguous. If you configure port-forwarding-range 2000 3000, the router implicitly includes ports 1 to 1023, plus enables the wildcard port range 2000 to 3000, which is now disjoined from the well-known ports.
The range-start parameter has additional values that are configurable in the CLI. 0 is reserved for pools that do not support configured port forwards (those are 1:1 pools).
range-start 1 means that well-known ports and wildcard port forwards are contiguous. This is configured by omitting the range-start parameter and only configuring the range-end parameter.
The no form of this command disables the port forwards capability in the wildcard port range of all IP addresses in a NAT pool.
Default ranges in the range-start and range-end parameters in the MIB for the NAT pools that support port forwarding ranges are set to include only well-known ports, range-start 1 and range-end 1023.
Parameters
- range-start
-
Specifies the lower boundary of the wildcard port range reserved for port forwards. When configured, the value must be less than the range-end value.
- range-end
-
Specifies the upper boundary of the wildcard port range reserved for port forwards.
Platforms
7705 SAR Gen 2
port-id
port-id
Syntax
[no] port-id
Context
[Tree] (config>router>if>dhcp>option>vendor-specific-option port-id)
Full Context
configure router interface dhcp option vendor-specific-option port-id
Description
This command enables sending of the port-id in the Nokia vendor specific suboption of the DHCP relay packet
The no form of this command disables the sending.
Default
no port-id
Platforms
7705 SAR Gen 2
port-id-subtype
port-id-subtype
Syntax
port-id-subtype {tx-if-alias | tx-if-name | tx-local}
Context
[Tree] (config>port>ethernet>lldp>dstmac port-id-subtype)
Full Context
configure port ethernet lldp dest-mac port-id-subtype
Description
This command specifies how to encode the PortID TLV transmit to the peer. The default setting tx-local (ifindex value) is required by some versions of the NSP NSM-P to properly build the Layer 2 topology map using LLDP. Changing this value to transmit the ifname ( tx-if-name) or ifAlias (tx-if-alias) in place of the ifindex (tx-local) may affect the ability of the NSP NFM-P to build the Layer 2 topology map using LLDP.
Default
port-id-subtype tx-local
Parameters
- tx-if-alias
-
Transmits the ifAlias String (subtype 1) that describes the port as stored in the IF-MIB, either user configured or the default entry (i.e. 10/100/Gig Ethernet SFP).
- tx-if-name
-
Transmits the ifName string (subtype 5) that describes the port as stored in the IF-MIB ifName info.
- tx-local
-
The interface ifIndex value (subtype 7) as the PortID.
Platforms
7705 SAR Gen 2
port-id-subtype
Syntax
port-id-subtype {tx-if-alias | tx-if-name | tx-local}
Context
[Tree] (config>lag>lldp-member-template>dstmac port-id-subtype)
Full Context
configure lag lldp-member-template dest-mac port-id-subtype
Description
This command configures the encoding of the PortID TLV that is transmitted to the peer. Some versions of the NSP NFM-P require the default setting tx-local (ifIndex value) to properly build the Layer 2 topology map using LLDP. Changing this value to transmit the ifName (tx-if-name) or ifAlias (tx-if-alias) in place of the ifIndex (tx-local) may affect the ability of the NSP NFM-P to build the Layer 2 topology map using LLDP.
Default
port-id-subtype tx-local
Parameters
- tx-if-alias
-
Keyword to transmit the ifAlias String (subtype 1), which describes the port as stored in the IF-MIB, either user configured or the default entry (for example, 10/100/Gig Ethernet SFP).
- tx-if-name
-
Keyword to transmit the ifName string (subtype 5), which describes the port as stored in the IF-MIB ifName information.
- tx-local
-
Keyword to transmit the interface ifIndex value (subtype 7) as the port ID.
Platforms
7705 SAR Gen 2
port-limits
port-limits
Syntax
port-limits
Context
[Tree] (config>service>nat>nat-policy port-limits)
Full Context
configure service nat nat-policy port-limits
Description
This command configures the port limits of this policy.
Platforms
7705 SAR Gen 2
port-list
port-list
Syntax
port-list port-list-name [create]
no port-list port-list-name
Context
[Tree] (config>filter>match-list port-list)
Full Context
configure filter match-list port-list
Description
This command creates a list of TCP/UDP/SCTP port values or ranges for match criteria in IPv4 and IPv6 ACL and CPM filter policies.
The no form of this command deletes the specified list.
Operational notes:
SCTP port match is supported in ACL filter policies only.
A port-list must contain only TCP/UDP/SCTP port values or ranges.
A TCP/UDP/SCTP port match list cannot be deleted if it is referenced by a filter policy.
See general description related to match-list usage in filter policies.
Parameters
- port-list-name
-
Specifies a string of up to 32 characters of printable ASCII characters. If special characters are used, the string must be enclosed within double quotes.
Platforms
7705 SAR Gen 2
port-num
port-num
Syntax
port-num virtual-port-number
no port-num [virtual-port-number]
Context
[Tree] (config>service>vpls>sap>stp port-num)
[Tree] (config>service>vpls>spoke-sdp>stp port-num)
Full Context
configure service vpls sap stp port-num
configure service vpls spoke-sdp stp port-num
Description
This command configures the virtual port number which uniquely identifies a SAP within configuration bridge protocol data units (BPDUs). The internal representation of a SAP is unique to a system and has a reference space much bigger than the 12 bits definable in a configuration BPDU. STP takes the internal representation value of a SAP and identifies it with its own virtual port number that is unique to every other SAP defined on the TLS. The virtual port number is assigned at the time that the SAP is added to the TLS. Since the order that the SAP was added to the TLS is not preserved between reboots of the system, the virtual port number may change between restarts of the STP instance.
The virtual port number cannot be administratively modified.
Platforms
7705 SAR Gen 2
port-parent
port-parent
Syntax
port-parent [weight weight] [ level level] [cir-weight cir-weight] [cir-level cir-level]
no port-parent
Context
[Tree] (config>qos>sap-egress>queue port-parent)
Full Context
configure qos sap-egress queue port-parent
Description
This command specifies whether this queue feeds off a port-level scheduler. When configured, this SAP egress queue is parented by a port-level scheduler. This object is mutually exclusive with SAP egress queue parent. Only one kind of parent is allowed.
The port-parent command defines a child/parent association between an egress queue and a port-based scheduler or between an intermediate service scheduler and a port-based scheduler. The port-parent command allows for a set of within-CIR and above-CIR parameters that define the port priority levels and weights for the queue or scheduler. If the port-parent command is executed without any parameters, the default parameters are assumed.
In this context, the port-parent command is mutually exclusive to the parent command (used to create a parent/child association between a queue and an intermediate scheduler). Executing a port-parent command when a parent definition is in place causes the current intermediate scheduler association to be removed and replaced by the defined port-parent association. Executing a parent command when a port-parent definition exists causes the port scheduler association to be removed and replaced by the defined intermediate scheduler name.
Changing the parent context on a SAP egress policy queue may cause a SAP or subscriber or multiservice site context of the queue (policy associated with a SAP or subscriber profile or multiservice site) to enter an orphaned state. If an instance of a queue is created on a port or channel that does not have a port scheduler enabled and the sap-egress policy creating the queue has a port-parent association, the queue will be allowed to run according to its own rate parameters and will not be controlled by a virtual scheduling context. If an instance of a queue is on a port or channel that has a port scheduler configured and the sap-egress policy defines the queue as having a non-existent intermediate scheduler parent, the queue will be treated as an orphan and will be handled according to the current orphan behavior on the port scheduler.
The no form of this command removes a port scheduler parent association for the queue or scheduler. If a port scheduler is defined on the port on which the queue or scheduler instance exists, the queue or scheduler will become orphaned if an port scheduler is configured on the egress port of the queue or scheduler.
Default
no port-parent
Parameters
- weight weight
-
Specifies the weight the queue or scheduler will use at the above-CIR port priority level (defined by the level parameter).
- level level
-
Specifies the port priority the queue or scheduler will use to receive bandwidth for its above-CIR offered-load.
- cir-weight cir-weight
-
Specifies the weight the queue or scheduler will use at the within-CIR port priority level (defined by the cir-level parameter). The weight is specified as an integer value from 0 to 100 with 100 being the highest weight. When the cir-weight parameter is set to a value of 0 (the default value), the queue or scheduler does not receive bandwidth during the port schedulers within-CIR pass and the cir-level parameter is ignored. If the cir-weight parameter is 1 or greater, the cir-level parameter comes into play.
- cir-level cir-level
-
Specifies the port priority the queue or scheduler will use to receive bandwidth for its within-CIR offered-load. If the cir-weight parameter is set to a value of 0 (the default value), the queue or scheduler does not receive bandwidth during the port schedulers within-CIR pass and the cir-level parameter is ignored. If the cir-weight parameter is 1 or greater, the cir-level parameter comes into play.
Platforms
7705 SAR Gen 2
port-parent
Syntax
port-parent [weight weight] [ level level] [cir-weight cir-weight] [cir-level cir-level]
no port-parent
Context
[Tree] (config>qos>network-queue>queue port-parent)
Full Context
configure qos network-queue queue port-parent
Description
This command specifies whether this queue feeds off a port-level scheduler. For the network-queue policy context, only the port-parent command is supported. When a port scheduler exists on the port, network queues without a port-parent association will be treated as an orphan queue on the port scheduler and treated according to the current orphan behavior on the port scheduler. If the port-parent command is defined for a network queue on a port without a port scheduler defined, the network queue will operate as if a parent association does not exist. When a port scheduler policy is associated with the egress port, the port-parent command will come into effect.
When a network-queue policy is associated with an FP for ingress queue definition, the port-parent association of the queues is ignored.
The no form of this command removes a port scheduler parent association for the queue or scheduler. If a port scheduler is defined on the port then the queue or scheduler instance exists, the queue or scheduler will become orphaned.
Default
no port-parent
Parameters
- weight weight
-
Specifies the weight the queue or scheduler will use at the above-CIR port priority level (defined by the level parameter).
- level level
-
Specifies the port priority the queue or scheduler will use to receive bandwidth for its above-CIR offered-load.
- cir-weight cir-weight
-
Specifies the weight the queue or scheduler will use at the within-CIR port priority level (defined by the cir-level parameter). The weight is specified as an integer value from 0 to 100 with 100 being the highest weight. When the cir-weight parameter is set to a value of 0, the queue or scheduler does not receive bandwidth during the port scheduler’s within-CIR pass and the cir-level parameter is ignored. If the cir-weight parameter is 1 or greater, the cir-level parameter is used.
- cir-level cir-level
-
Specifies the port priority the queue or scheduler will use to receive bandwidth for its within-CIR offered-load. If the cir-weight parameter is set to a value of 0 (the default value), the queue or scheduler does not receive bandwidth during the port scheduler’s within-CIR pass and the cir-level parameter is ignored. If the cir-weight parameter is 1 or greater, the cir-level parameter comes into play.
Platforms
7705 SAR Gen 2
port-parent
Syntax
port-parent [weight weight] [ level level] [cir-weight cir-weight] [cir-level cir-level]
no port-parent
Context
[Tree] (config>qos>qgrps>egr>qgrp>queue port-parent)
Full Context
configure qos queue-group-templates egress queue-group queue port-parent
Description
This command defines the port scheduling parameters used to control the queue’s behavior when a virtual egress port scheduling is enabled where the egress queue group template is applied. The port-parent command follows the same behavior and provisioning characteristics as the parent command in the SAP egress QoS policy. The port-parent command and the parent command are mutually exclusive.
The no form of this command removes the values from the configuration.
Parameters
- weight weight
-
Specifies the weight the queue or scheduler will use at the above-CIR port priority level (defined by the level parameter).
- level level
-
Specifies the port priority the queue or scheduler will use to receive bandwidth for its above-CIR offered-load.
- cir-weight cir-weight
-
Specifies the weight the queue or scheduler will use at the within-CIR port priority level (defined by the cir-level parameter). The weight is specified as an integer value from 0 to 100 with 100 being the highest weight. When the cir-weight parameter is set to a value of 0 (the default value), the queue or scheduler does not receive bandwidth during the port schedulers within-CIR pass and the cir-level parameter is ignored. If the cir-weight parameter is 1 or greater, the cir-level parameter is used.
- cir-level cir-level
-
Specifies the port priority the queue or scheduler will use to receive bandwidth for its within-CIR offered-load. If the cir-weight parameter is set to a value of 0 (the default value), the queue or scheduler does not receive bandwidth during the port schedulers within-CIR pass and the cir-level parameter is ignored. If the cir-weight parameter is 1 or greater, the cir-level parameter is used.
Platforms
7705 SAR Gen 2
port-parent
Syntax
port-parent [weight weight] [ level level] [cir-weight cir-weight] [cir-level cir-level]
no port-parent
Context
[Tree] (config>qos>scheduler-policy>tier>scheduler port-parent)
Full Context
configure qos scheduler-policy tier scheduler port-parent
Description
The port-parent command defines a child/parent association between an egress scheduler and a port-based scheduler, or between an intermediate service scheduler and a port-based scheduler. The port-parent command allows for a set of within-CIR and above-CIR parameters that define the port priority levels and weights for the scheduler. If the port-parent command is executed without any parameters, the default parameters are assumed.
In this context, the port-parent command and the parent command (used to create a parent/child association to an intermediate scheduler) are mutually exclusive. Executing a port-parent command when a parent definition is in place causes the current intermediate scheduler association to be removed and replaced by the defined port-parent association. Executing a parent command when a port-parent definition exists causes the port scheduler association to be removed and replaced by the defined intermediate scheduler name.
Changing the parent context on a SAP egress policy policer or queue may cause a SAP or subscriber context of the policer or queue (policy associated with a SAP or subscriber profile) to enter an orphaned state. If an instance of a policer or queue is created on a port or channel that does not have a port scheduler enabled and the sap-egress policy creating the policer queue has a port-parent association, the policer or queue will be allowed to run according to its own rate parameters and will not be controlled by a virtual scheduling context. If an instance of a policer or queue is on a port or channel that has a port scheduler configured and the sap-egress policy defines the policer or queue as having a non-existent intermediate scheduler parent, the policer or queue will be treated as an orphan and will be handled according to the current orphan behavior on the port scheduler.
The no form of this command removes a port scheduler parent association for the scheduler. If a port scheduler is defined on the port that the scheduler instance exists, the scheduler will become orphaned if an port scheduler is configured on the egress port of the queue or scheduler.
Default
no port-parent
Parameters
- weight weight
-
Specifies the weight the queue or scheduler will use at the above-CIR port priority level (defined by the level parameter).
- level level
-
Specifies the port priority the queue or scheduler will use to receive bandwidth for its above-CIR offered-load.
- cir-weight cir-weight
-
Specifies the weight the queue or scheduler will use at the within-CIR port priority level (defined by the cir-level parameter). The weight is specified as an integer value from 0 to 100 with 100 being the highest weight. When the cir-weight parameter is set to a value of 0, the queue or scheduler does not receive bandwidth during the port scheduler’s within-CIR pass and the cir-level parameter is ignored. If the cir-weight parameter is 1 or greater, the cir-level parameter comes into play.
- cir-level cir-level
-
Specifies the port priority the queue or scheduler will use to receive bandwidth for its within-CIR offered-load. If the cir-weight parameter is set to a value of 0 (the default value), the queue or scheduler does not receive bandwidth during the port scheduler’s within-CIR pass and the cir-level parameter is ignored. If the cir-weight parameter is 1 or greater, the cir-level parameter comes into play.
Platforms
7705 SAR Gen 2
port-redirect-group
port-redirect-group
Syntax
port-redirect-group {queue queue-id | policer policer-id [queue queue-id]}
no port-redirect-group
Context
[Tree] (config>qos>network>egress>fc port-redirect-group)
Full Context
configure qos network egress fc port-redirect-group
Description
This command is used to redirect the FC of a packet of a pseudowire (PW) or network IP interface to an egress port queue group.
It defines the mapping of an FC to a queue ID or a policer ID and a queue ID and redirects the lookup of the queue or policer of the same ID in some egress port queue-group instance. However, the queue-group name and instance are explicitly provided only at the time the network QoS policy is applied to egress context of a spoke-sdp or a network IP interface.
The no version of this command removes the redirection of the FC.
Parameters
- queue-id
-
This parameter must be specified when executing the port-redirect-group command. The specified queue-id must exist within the egress port queue group on each IP interface where the network QoS policy is applied.
- policer id
-
The specified policer-id must exist within the queue-group template applied to the ingress context of the forwarding plane.
Platforms
7705 SAR Gen 2
port-reservation
port-reservation
Syntax
port-reservation blocks num-blocks
port-reservation ports num-ports
no port-reservation
Context
[Tree] (config>router>nat>outside>pool port-reservation)
[Tree] (config>service>vprn>nat>outside>pool port-reservation)
Full Context
configure router nat outside pool port-reservation
configure service vprn nat outside pool port-reservation
Description
This command configures the size of the port block that will be assigned to a host that is served by this pool. The number of ports configured are available to UDP, TCP, and ICMP (as identifiers).
Parameters
- num-blocks
-
Specifies the number of port blocks per IP address. Setting this parameter to one (1) for large scale NAT enables 1:1 NAT for IP addresses in this pool.
- num-ports
-
Specifies the number of ports per block.
Platforms
7705 SAR Gen 2
port-role
port-role
Syntax
[no] port-role
Context
[Tree] (debug>service>id>stp port-role)
Full Context
debug service id stp port-role
Description
This command enables STP debugging for changes in port roles.
Platforms
7705 SAR Gen 2
port-scheduler-policy
port-scheduler-policy
Syntax
port-scheduler-policy port-scheduler-name [ create]
no port-scheduler-policy port-scheduler-name
Context
[Tree] (config>qos port-scheduler-policy)
Full Context
configure qos port-scheduler-policy
Description
When a port scheduler has been 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 (1 to 8)
-
The cir associated with each priority level (1 to 8)
The orphan priority level (level 0) has no configuration parameters and cannot be overridden.
The no form of this command removes a port scheduler policy from the system. If the port scheduler policy is associated with an egress port or channel, the command will fail.
Parameters
- port-scheduler-name
-
Specifies an existing port scheduler name. Each port scheduler must be uniquely named within the system and can be up to 32 ASCII characters.
Platforms
7705 SAR Gen 2
port-state
port-state
Syntax
[no] port-state
Context
[Tree] (debug>service>id>stp port-state)
Full Context
debug service id stp port-state
Description
This command enables STP debugging for port states.
The no form of the command disables debugging.
Platforms
7705 SAR Gen 2
port-threshold
port-threshold
Syntax
port-threshold value [action { dynamic-cost | static-cost | down}] [ cost static-cost]
no port-threshold
Context
[Tree] (config>lag port-threshold)
Full Context
configure lag port-threshold
Description
This command configures the behavior for the Link Aggregation Group (LAG) if the number of operational links is equal to or below a threshold level.
Nokia recommends that operators use the weight-threshold or hash-weight-threshold command instead of the port-threshold command to control LAG operational status. For example, when 1GE and 10GE ports are mixed in a LAG, each 1GE port will have a weight of 1, while each 10GE port will have a weight of 10.
The weight-threshold or hash-weight-threshold command can also be used for LAGs with all ports of equal speed to allow a common operational model. For example, each port has a weight of 1 to mimic port-threshold and its related configuration.
The no form of this command reverts to the default values.
Default
port-threshold 0 action down
Parameters
- value
-
Specifies the decimal integer threshold number of operational links for the LAG at or below which the configured action is invoked. If the number of operational links exceeds the port-threshold value, any action taken for being below the threshold value will cease.
- action
-
Specifies the action to take if the number of active links in the LAG is at or below the threshold value.
- dynamic-cost
-
Specifies that dynamic costing is activated. As a result, the LAG remains operationally up with a cost relative to the number of operational links. The link is only regarded as operationally down when all links in the LAG are down.
- static-cost
-
Specifies that static costing is activated. As a result, the LAG remains operationally up with the configured cost, regardless of the number of operational links. The link is only regarded as operationally down when all links in the LAG are down.
- down
-
Specifies that LAG is brought operationally down if the number of operational links is equal to or less than the configured threshold value. The LAG is only regarded as up once the number of operational links exceeds the configured threshold value.
- static-cost
-
Specifies decimal integer static cost of the LAG.
Platforms
7705 SAR Gen 2
port-xc
port-xc
Syntax
port-xc
Context
[Tree] (config port-xc)
Full Context
configure port-xc
Description
Commands in this context configure port-cross connect functionality.
Platforms
7705 SAR Gen 2
ppk
ppk
Syntax
ppk list ppk-list-name id ppk-id
Context
[Tree] (config>service>ies>if>ipsec>ipsec-tunnel>dyn ppk)
[Tree] (config>service>vprn>if>sap>ipsec-tunnel>dyn ppk)
[Tree] (config>service>vprn>if>ipsec>ipsec-tunnel>dyn ppk)
[Tree] (config>ipsec>trans-mode-prof>dyn ppk)
[Tree] (config>router>if>ipsec>ipsec-tunnel>dyn ppk)
Full Context
configure service ies interface ipsec ipsec-tunnel dynamic-keying ppk
configure service vprn interface sap ipsec-tunnel dynamic-keying ppk
configure service vprn interface ipsec ipsec-tunnel dynamic-keying ppk
configure ipsec ipsec-transport-mode-profile dynamic-keying ppk
configure router interface ipsec ipsec-tunnel dynamic-keying ppk
Description
This command specifies the PPK to use for dynamic keying of the IPsec tunnel.
The no form of this command removes the PPK.
Default
no ppk
Parameters
- ppk-list-name
- Specifies the name of the PPK list, up to 32 characters.
- ppk-id
- Specifies the ID of a PPK entry in the list, up to 64 characters.
Platforms
7705 SAR Gen 2
ppk-id
ppk-id
Syntax
ppk-id ppk-id value value-string format {ascii | hex} [hash | hash2 | custom]
no ppk-id ppk-id
Context
[Tree] (config>ipsec>ppk-list ppk-id)
Full Context
configure ipsec ppk-list ppk-id
Description
This command configures the attributes for a PPK entry within the list.
The no form of this command deletes the PPK entry from the list.
Parameters
- ppk-id
- Specifies a unique ID for the PPK, up to 64 characters.
- value-string
- Specifies the PPK value.
- ascii
- Keyword to specify that the PPK value is formatted as an ASCII string, up to 64 characters.
- hex
- Keyword that specifies the PPK value is formatted as a hexadecimal string, up to 128 hex nibbles.
- hash
- Keyword that specifies the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, cleartext form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
- hash2
- Keyword that specifies the key is entered in a more complex encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, cleartext form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
- custom
- Keyword that specifies the custom encryption to the management interface.
Platforms
7705 SAR Gen 2
ppk-list
ppk-list
Syntax
ppk-list ppk-list-name [create]
no ppk-list ppk-list-name
Context
[Tree] (config>ipsec ppk-list)
Full Context
configure ipsec ppk-list
Description
Commands in this context configure a list of Post-quantum Preshared Keys (PPKs) to use for IKEv2 authentication, as described in RFC 8784.
The no form of this command deletes the PPK list.
Parameters
- ppk-list-name
- Specifies the name of the PPK list, up to 32 characters.
- create
- Keyword to create the PPK list.
Platforms
7705 SAR Gen 2
ppk-list
Syntax
ppk-list ppk-list-name
no ppk-list
Context
[Tree] (config>ipsec>tnl-temp ppk-list)
Full Context
configure ipsec tunnel-template ppk-list
Description
This command specifies a PPK list to use in the tunnel template, which represents a list of PPKs available for the IPsec gateway. The actual PPK to use depends on the tunnel initiator.
The no form of this command removes the PPK list from the tunnel template.
Default
no ppk-list
Parameters
- ppk-list-name
- Specifies the name of the PPK list, up to 32 characters.
Platforms
7705 SAR Gen 2
ppk-required
ppk-required
Syntax
[no] ppk-required
Context
[Tree] (config>ipsec>ike-policy ppk-required)
Full Context
configure ipsec ike-policy ppk-required
Description
This command configures the mandatory use of PPKs for the IKEv2 key derivation process in the IKE policy.
The no form of this command configures the use of PPKs for IKEv2 as optional. The router can fall back to derive keys without PPK.
Default
no ppk-required
Platforms
7705 SAR Gen 2
pre-login-message
pre-login-message
Syntax
pre-login-message login-text-string [name]
no pre-login-message
Context
[Tree] (config>system>login-control pre-login-message)
Full Context
configure system login-control pre-login-message
Description
This command configures a message to display before logging in to the router using Telnet, SSH, or the console port.
Only one message can be configured. If a new pre-login message is configured, the new message overwrites the previous message.
The no form of this command removes the pre-login message.
Default
no pre-login-message
Parameters
- login-text-string
-
Specifies the pre-login message text, up to 900 characters. Any printable, 7-bit ASCII characters can be used. If the string contains special characters (#, ?, space), the entire string must be enclosed within double quotes. Some special characters can be used to format the message text. Use the newline (\n) character to create multiline messages. A newline (\n) character in the message moves to the beginning of the next line by sending ASCII/UTF-8 characters 0xA (LF) and 0xD (CR) to the client terminal. A carriage return (\r) character in the message sends the ASCII/UTF-8 character 0xD (CR) to the client terminal.
- name
-
Displays the configured system name before the pre-login message. To remove the system name from the pre-login message, remove the current message and configure a new message without using the name parameter.
Platforms
7705 SAR Gen 2
pre-shared-key
pre-shared-key
Syntax
pre-shared-key pre-shared-key-index [encryption-type encryption-type] [create]
no pre-shared-key pre-shared-key-index
Context
[Tree] (config>macsec>conn-assoc>static-cak pre-shared-key)
Full Context
configure macsec connectivity-association static-cak pre-shared-key
Description
This command specifies the pre-shared key used to enable MACsec using static connectivity association key (CAK) security mode. This command also specifies the encryption algorithm used for encrypting the SAK.
A pre-shared key includes a connectivity association key name (CKN) and a connectivity association key (CAK). The pre-shared key-the CKN and CAK-must match on both ends of a link.
A pre-shared key is configured on both devices at each end of point-to-point link to enable MACsec using static CAK security mode. The MACsec Key Agreement (MKA) protocol is enabled after the successful MKA liveliness negotiation.
The encryption-type is used for encrypting the SAK and authenticating the MKA packet. The symmetric encryption key SAK (Security Association Key) needs to be encrypted (wrapped) via the MKA protocols. The AES key is derived via pre-shared-key.
The no form of this command removes the index.
Parameters
- pre-shared-key-index
-
Specifies the index of this pre-shared-key.
- encryption-type
-
Specifies the type of encryption.
- create
-
Mandatory to create an entry.
Platforms
7705 SAR Gen 2
pre-shared-key
Syntax
pre-shared-key key [hash | hash2 | custom]
no pre-shared-key
Context
[Tree] (config>ipsec>client-db>client>credential pre-shared-key)
Full Context
configure ipsec client-db client credential pre-shared-key
Description
This command specifies a pre-shared key used to authenticate peers.
The no form of this command reverts to the default.
Default
no pre-shared-key
Parameters
- key
-
An ASCII string to use as the pre-shared key for dynamic keying. When the hash or hash2 parameters are not used, the key is a clear text key; otherwise, the key text is encrypted.
- hash
-
Specifies the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
- hash2
-
Specifies the key is entered in a more complex encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
- custom
-
Specifies the custom encryption to management interface.
Platforms
7705 SAR Gen 2
pre-shared-key
Syntax
pre-shared-key key [hash | hash2 | custom]
no pre-shared-key
Context
[Tree] (config>ipsec>trans-mode-prof>dyn pre-shared-key)
[Tree] (config>service>ies>if>sap>ipsec-gw pre-shared-key)
[Tree] (config>service>vprn>if>sap>ipsec-tunnel>dynamic-keying pre-shared-key)
[Tree] (config>router>if>ipsec>ipsec-tunnel>dyn pre-shared-key)
[Tree] (config>service>vprn>if>ipsec>ipsec-tunnel>dyn pre-shared-key)
[Tree] (config>service>ies>if>ipsec>ipsec-tunnel>dyn pre-shared-key)
[Tree] (config>service>vprn>if>sap>ipsec-gw pre-shared-key)
Full Context
configure ipsec ipsec-transport-mode-profile dynamic-keying pre-shared-key
configure service ies interface sap ipsec-gw pre-shared-key
configure service vprn interface sap ipsec-tunnel dynamic-keying pre-shared-key
configure router interface ipsec ipsec-tunnel dynamic-keying pre-shared-key
configure service vprn interface ipsec ipsec-tunnel dynamic-keying pre-shared-key
configure service ies interface ipsec ipsec-tunnel dynamic-keying pre-shared-key
configure service vprn interface sap ipsec-gw pre-shared-key
Description
This command configures the pre-shared key for authentication.
The no form of this command reverts to the default.
Default
no pre-shared-key
Parameters
- key
-
Specifies an ASCII string to use as the pre-shared key for dynamic keying. When the hash or hash2 parameters are not used, the key is a clear text key; otherwise, the key text is encrypted.
- hash
-
Specifies the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
- hash2
-
Specifies the key is entered in a more complex encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
- custom
-
Specifies the custom encryption to management interface.
Platforms
7705 SAR Gen 2
pre-update-time
pre-update-time
Syntax
pre-update-time [days days] [ hrs hours] [min minutes] [sec seconds]
Context
[Tree] (config>system>security>pki>ca-prof>auto-crl-update pre-update-time)
Full Context
configure system security pki ca-profile auto-crl-update pre-update-time
Description
This command specifies the pre-download time for next-update-based update.
Default
pre-update-time hrs 1
Parameters
- days
-
Specifies the time period, in days, prior to the next update time of the current CRL.
- hours
-
Specifies the time period, in hours, prior to the next update time of the current CRL.
- minutes
-
Specifies the time period, in minutes, prior to the next update time of the current CRL.
- seconds
-
Specifies the time period, in seconds, prior to the next update time of the current CRL.
Platforms
7705 SAR Gen 2
prec
prec
Syntax
prec ip-prec-value [fc fc-name] [priority {high | low}]
no prec ip-prec-value
Context
[Tree] (config>qos>sap-ingress prec)
Full Context
configure qos sap-ingress prec
Description
This command explicitly sets the forwarding class or enqueuing priority when a packet is marked with an IP precedence value ( ip-prec-value). Adding an IP precedence rule on the policy forces packets that match the specified ip-prec-value to override the forwarding class and enqueuing priority based on the parameters included in the IP precedence rule.
When the forwarding class is not specified in the rule, a matching packet preserves (or inherits) the existing forwarding class derived from earlier matches in the classification hierarchy.
When the enqueuing priority is not specified in the rule, a matching packet preserves (or inherits) the existing enqueuing priority derived from earlier matches in the classification hierarchy.
The ip-prec-value is derived from the most significant three bits in the IP header ToS byte field (precedence bits). The three precedence bits define eight Class-of-Service (CoS) values commonly used to map packets to per-hop Quality of Service (QoS) behavior. The precedence bits are also part of the DiffServ Code Point (DSCP) method of mapping packets to QoS behavior. The DSCP uses the most significant six bits in the IP header ToS byte and so overlaps with the precedence bits. Both IP precedence and DSCP classification rules are supported. DSCP rules have a higher match priority than IP precedence rules and where a dscp-name DSCP value overlaps an ip-prec-value, the DSCP rule takes precedence.
The no form of this command removes the explicit IP precedence classification rule from the SAP ingress policy. Removing the rule on the policy immediately removes the rule on all ingress SAPs using the policy.
Parameters
- ip-prec-value
-
The ip-prec-value is a required parameter that specifies the unique IP header ToS byte precedence bits value that will match the IP precedence rule. If the command is executed more than once with the same ip-prec-value, the previous forwarding class and enqueuing priority is completely overridden by the new parameters or defined to be inherited when a forwarding class or enqueuing priority parameter is missing.
A maximum of eight IP precedence rules are allowed on a single policy.
The precedence is evaluated from the lowest to highest value.
- fc fc-name
-
The value given for the fc-name parameter must be one of the predefined forwarding classes in the system. Specifying the fc-name is optional. When a packet matches the rule, the forwarding class is only overridden when the fc fc-name parameter is defined on the rule. If the packet matches and the forwarding class is not explicitly defined in the rule, the forwarding class is inherited based on previous rule matches.
The subclass-name parameter is optional and used with the fc-name parameter to define a pre-existing subclass. The fc-name and subclass-name parameters must be separated by a period (.). If subclass-name does not exist in the context of fc-name, an error will occur. If subclass-name is removed using the no fc fc-name.subclass-name force command, the default-fc command will automatically drop the subclass-name and only use fc-name (the parent forwarding class for the subclass) as the forwarding class.
- priority
-
The priority parameter overrides the default enqueuing priority for all packets received on an ingress SAP using this policy that match this rule. Specifying the priority is optional. When a packet matches the rule, the enqueuing priority is only overridden when the priority parameter is defined on the rule. If the packet matches and priority is not explicitly defined in the rule, the enqueuing priority is inherited based on previous rule matches.
- high
-
This parameter is used in conjunction with the priority parameter. Setting the enqueuing parameter to high for a packet increases the likelihood of enqueuing the packet when the ingress queue is congested. Ingress enqueuing priority only affects ingress SAP queuing. When the packet is placed in a buffer on the ingress queue, the significance of the enqueuing priority is lost.
- low
-
This parameter is used in conjunction with the priority parameter. Setting the enqueuing parameter to low for a packet decreases the likelihood of enqueuing the packet when the ingress queue is congested. Ingress enqueuing priority only affects ingress SAP queuing. When the packet is placed in a buffer on the ingress queue, the significance of the enqueuing priority is lost.
Platforms
7705 SAR Gen 2
prec
Syntax
prec {ip-prec-value | in-profile ip-prec-value out-profile ip-prec-value [ exceed-profile ip-prec-value]}
no prec
Context
[Tree] (config>qos>sap-egress>fc prec)
Full Context
configure qos sap-egress fc prec
Description
This command defines a value to be used for remarking packets for the specified FC. If the optional in/out/exceed-profile is specified, the command will remark different IP precedence values depending on whether the packet was classified to be in, exceed, or out-of-profile. All inplus-profile traffic is marked with the same value as in-profile traffic.
Parameters
- ip-prec-value
-
This parameter specifies the IP precedence to be used to remark all traffic.
- exceed-profile ip-prec-value
-
This optional parameter specifies the IP precedence to be used to remark traffic that is exceed-profile. If not specified, this defaults to the same value configured for the out-profile parameter.
- in-profile ip-prec-value
-
This parameter specifies the IP precedence to be used to remark traffic that is in-profile.
- out-profile ip-prec-value
-
This parameter specifies the IP precedence to be used to remark traffic that is out-of-profile.
Platforms
7705 SAR Gen 2
prec
Syntax
prec ip-prec-value [fc fc-name] [profile {in | out | exceed | inplus}]
no prec ip-prec-value
Context
[Tree] (config>qos>sap-egress prec)
Full Context
configure qos sap-egress prec
Description
This command defines a specific IP precedence value that must be matched to perform the associated reclassification actions. If an egress packet on the SAP matches the specified IP precedence value, the forwarding class, or profile behavior may be overridden. By default, the forwarding class and profile of the packet is derived from ingress classification and profiling functions.
The IP precedence bits used to match against precedence reclassification rules come from the Type of Service (ToS) field within the IPv4 header. If the packet does not have an IPv4 header, precedence-based matching is not performed.
The reclassification actions from a precedence reclassification rule may be overridden by a DSCP or IP flow matching event.
The fc keyword is optional. When specified, the egress classification rule will overwrite the forwarding class derived from ingress. The new forwarding class is used for egress remarking and queue mapping decisions. If a DSCP, ipv6-criteria, or ip-criteria match occurs after the IP precedence match, the new forwarding class may be overridden by the higher priority match actions. If the higher priority match actions do not specify a new fc, the fc from the IP precedence match will be used.
The profile keyword is optional. When specified, the egress classification rule will overwrite the profile of the packet derived from ingress. The new profile value is used for egress remarking and queue congestion behavior. If a DSCP, IPv6 criteria, or IP criteria match occurs after the IP precedence match, the new profile may be overridden by the higher priority match actions. If the higher priority match actions do not specify a new profile, the profile from the IP precedence match will be used.
The no form of this command removes the reclassification rule from the SAP egress QoS policy.
Parameters
- fc fc-name
-
This keyword is optional. When specified, packets matching the IP precedence value will be explicitly reclassified to the forwarding class specified as fc-name regardless of the ingress classification decision. The explicit forwarding class reclassification may be overwritten by a higher priority DSCP, IPv6 criteria, or IP criteria reclassification match. The FC name defined must be one of the eight forwarding classes supported by the system. To remove the forwarding class reclassification action for the specified precedence value, the prec command must be re-executed without the fc parameter defined.
- profile {in | out | exceed | inplus}
-
This keyword is optional. When specified, packets matching the IP precedence value will be explicitly reclassified to the specified profile regardless of the ingress profiling decision. The explicit profile reclassification may be overwritten by a higher priority DSCP, IPv6 criteria, or IP criteria reclassification match. To remove the profile reclassification action for the specified precedence value, the prec command must be re-executed without the profile parameter defined.
- in
-
Specifies that any packets matching the reclassification rule will be treated as in-profile by the egress forwarding plane.
- out
-
Specifies that any packets matching the reclassification rule will be treated as out-of-profile by the egress forwarding plane.
- exceed
-
Specifies that any packets matching the reclassification rule will be treated as exceed-profile by the egress forwarding plane.
- inplus
-
Specifies that any packets matching the reclassification rule will be treated as inplus-profile by the egress forwarding plane.
Platforms
7705 SAR Gen 2
prec
Syntax
prec ip-prec-value fc fc-name profile {in | out | exceed | inplus}
no prec ip-prec-value
Context
[Tree] (config>qos>network>egress prec)
Full Context
configure qos network egress prec
Description
This command defines a specific IP precedence value that must be matched in order to perform the associated reclassification actions. If an egress packet on an IES/VPRN interface spoke SDP, on a CSC network interface in a VPRN, or network interface that the network QoS policy is applied to, matches the specified IP precedence value, the forwarding class and profile may be overridden.
By default, the forwarding class and profile of the packet is derived from ingress classification and profiling functions.
The IP precedence bits used to match against the reclassification rules come from the Type of Service (ToS) field within the IPv4 header or the Traffic Class field from the IPv6 header. If the packet does not have an IP header, IP precedence-based matching is not performed.
The configuration of egress prec classification and the configuration of an egress IP criteria or IPv6 criteria entry statement within a network QoS policy are mutually exclusive.
The IP precedence-based and DSCP-based reclassification are supported on a network interface, on a CSC network interface in a VPRN, and on a PW used in an IES or VPRN spoke interface.
This command will block the application of a network QoS policy with the egress reclassification commands to a spoke SDP part of a Layer 2 service. Conversely, this command will not allow the user to add the egress reclassification commands to a network QoS policy if it is being used by a Layer 2 spoke SDP.
The egress reclassification commands will only take effect if the redirection of the spoke SDP or CSC interface to use an egress port queue-group succeeds. For example, the following commands will succeed:
- config>service>vprn>if>
spoke-sdp>egress>qos network-policy-id port-redirect-group
queue-group-name instance instance-id
- config>service>ies>if>spoke-sdp>
egress>qos network-policy-id port-redirect-group queue-group-name
instance instance-id
- config>service>vprn>nw-if> qos network-policy-id port-redirect-group
queue-group-name instance instance-id
When the redirection command fails in CLI, the PW will use the network QoS policy assigned to the network IP interface; however, any reclassification in the network QoS policy applied to the network interface will be ignored.
The no form of this command removes the egress reclassification rule.
Parameters
- ip-prec-value
-
0 to 7
- fc fc-name
-
be, l2, af, l1, h2, ef, h1, nc
- profile {in | out | exceed | inplus}
-
The profile reclassification action is mandatory. When specified, packets matching the IP precedence value will be explicitly reclassified to the profile specified regardless of the ingress profiling decision. To remove the profile reclassification action for the specified IP precedence value, the no prec command must be executed.
This value may be overwritten by an explicit profile action in an DSCP reclassification match.
in - Specifies that any packets matching the reclassification rule will be treated as in-profile by the egress forwarding plane.
out - Specifies that any packets matching the reclassification rule will be treated as out-of-profile by the egress forwarding plane.
exceed - Specifies that any packets matching the reclassification rule will be treated as exceed-profile by the egress forwarding plane.
inplus - Specifies that any packets matching the reclassification rule will be treated as inplus-profile by the egress forwarding plane.
Platforms
7705 SAR Gen 2
precedence
precedence
Syntax
precedence [precedence-value | primary]
no precedence
Context
[Tree] (config>service>epipe>spoke-sdp precedence)
Full Context
configure service epipe spoke-sdp precedence
Description
This command specifies the precedence of the SDP binding when there are multiple SDP bindings attached to one service endpoint. The value of zero can only be assigned to one SDP bind making it the primary SDP bind. When an SDP binding goes down, the next highest precedence SDP binding will begin to forward traffic.
The no form of this command returns the precedence value to the default.
Default
precedence 4
Parameters
- precedence-value
-
Specifies the spoke SDP precedence.
- primary
-
Assigns primary precedence to the spoke SDP.
Platforms
7705 SAR Gen 2
precedence
Syntax
precedence prec-value
precedence primary
no precedence
Context
[Tree] (config>service>epipe>spoke-sdp-fec precedence)
Full Context
configure service epipe spoke-sdp-fec precedence
Description
This command specifies the precedence of the SDP binding when there are multiple SDP bindings attached to one service endpoint. The value of zero can only be assigned to one SDP bind making it the primary SDP bind. When an SDP binding goes down, the next highest precedence SDP binding will begin to forward traffic.
The no form of this command returns the precedence value to the default.
Default
precedence 42
Parameters
- prec-value
-
Specifies the spoke SDP precedence.
- primary
-
Assigns primary precedence to this spoke SDP.
Platforms
7705 SAR Gen 2
precedence
Syntax
precedence [precedence-value | primary]
no precedence
Context
[Tree] (config>service>vpls>spoke-sdp precedence)
Full Context
configure service vpls spoke-sdp precedence
Description
This command configures the precedence of this SDP bind when there are multiple SDP binds attached to one service endpoint. When an SDP bind goes down, the next highest precedence SDP bind begins forwarding traffic.
Parameters
- precedence-value
-
Specifies the precedence of this SDP bind
- primary
-
Assigns this as the primary spoke-SDP
Platforms
7705 SAR Gen 2
precedence
Syntax
precedence {precedence-value | primary}
no precedence
Context
[Tree] (config>mirror>mirror-dest>spoke-sdp precedence)
Full Context
configure mirror mirror-dest spoke-sdp precedence
Description
This command indicates that the SDP is of type secondary with a specific precedence value or of type primary.
The mirror or LI service always uses the primary type as the active pseudowire and only switches to a secondary pseudowire when the primary is down. The mirror service switches the path back to the primary pseudowire when it is back up. The user can configure a timer to delay reverting back to primary or to never revert back.
If the active pseudowire goes down, the mirror service switches the path to a secondary sdp with the lowest precedence value. That is, secondary SDPs which are operationally up are considered in the order of their precedence value, 1 being the lowest value and 4 being the highest value. If the precedence value is the same, then the SDP with the lowest SDP ID is selected.
An explicitly named endpoint can have a maximum of one SAP and one ICB. Once a SAP is added to the endpoint, only one more object of type ICB SDP is allowed. An explicitly named endpoint, which does not have a SAP object, can have a maximum of four SDPs, which can include any of the following: a single primary SDP, one or many secondary SDPs with precedence, and a single ICB SDP.
An SDP is created with type secondary and with the lowest precedence value of 4.
Parameters
- precedence-value
-
Specifies the precedence of the SDP.
- primary
-
Specified that a special value of the precedence which assigns the SDP the lowest precedence and enables the revertive behavior.
Platforms
7705 SAR Gen 2
preempt
preempt
Syntax
[no] preempt
Context
[Tree] (config>service>ies>if>ipv6>vrrp preempt)
Full Context
configure service ies interface ipv6 vrrp preempt
Description
The preempt mode value controls whether a specific backup virtual router preempts a lower priority master.
When preempt is enabled, the virtual router instance overrides any non-owner master with an "in use” message priority value less than the virtual router instance in-use priority value. If preempt is disabled, the virtual router only becomes master if the master down timer expires before a VRRP advertisement message is received from another virtual router.
The IP address owner will always become master when available. Preempt mode cannot be disabled on the owner virtual router.
The no form of this command disables preempt mode.
Default
preempt
Platforms
7705 SAR Gen 2
preempt
Syntax
[no] preempt
Context
[Tree] (config>service>ies>if>vrrp preempt)
Full Context
configure service ies interface vrrp preempt
Description
The preempt command provides the ability of overriding an existing non-owner master to the virtual router instance. Enabling preempt mode is almost required for proper operation of the base-priority and vrrp-policy-id definitions on the virtual router instance. If the virtual router cannot preempt an existing non-owner master, the effect of the dynamic changing of the in-use priority is greatly diminished.
The preempt command is only available in the non-owner vrrp virtual-router-id nodal context. The owner may not be preempted due to the fact that the priority of non-owners can never be higher than the owner. The owner will always preempt all other virtual routers when it is available.
Non-owner virtual router instances will only preempt when preempt is set and the current master has an in-use message priority value less than the virtual router instances in-use priority.
A master non-owner virtual router will only allow itself to be preempted when the incoming VRRP Advertisement message Priority field value is one of the following:
-
Greater than the virtual router in-use priority value
-
Equal to the in-use priority value and the source IP address (primary IP address) is greater than the virtual router instance primary IP address
The no form of this command prevents a non-owner virtual router instance from preempting another, less desirable virtual router. Use the preempt command to restore the default mode.
Default
preempt
Platforms
7705 SAR Gen 2
preempt
Syntax
[no] preempt
Context
[Tree] (config>service>vprn>if>ipv6>vrrp preempt)
Full Context
configure service vprn interface ipv6 vrrp preempt
Description
The preempt mode value controls whether a specific backup virtual router preempts a lower priority master.
When preempt is enabled, the virtual router instance overrides any non-owner master with an "in use” message priority value less than the virtual router instance in-use priority value. If preempt is disabled, the virtual router only becomes master if the master down timer expires before a VRRP advertisement message is received from another virtual router.
The IP address owner will always become master when available. Preempt mode cannot be disabled on the owner virtual router.
The default value for preempt mode is enabled.
Default
preempt
Platforms
7705 SAR Gen 2
preempt
Syntax
[no] preempt
Context
[Tree] (config>router>if>ipv6>vrrp preempt)
[Tree] (config>router>if>vrrp preempt)
Full Context
configure router interface ipv6 vrrp preempt
configure router interface vrrp preempt
Description
The preempt mode value controls whether a specific backup virtual router preempts a lower priority master.
When preempt is enabled, the virtual router instance overrides any non-owner master with an "in use” message priority value less than the virtual router instance in-use priority value. If preempt is disabled, the virtual router only becomes master if the master down timer expires before a VRRP advertisement message is received from another virtual router.
The IP address owner will always become master when available. Preempt mode cannot be disabled on the owner virtual router.
The default value for preempt mode is enabled.
Default
preempt
Platforms
7705 SAR Gen 2
preemption-timer
preemption-timer
Syntax
preemption-timer seconds
no preemption-timer
Context
[Tree] (config>router>rsvp preemption-timer)
Full Context
configure router rsvp preemption-timer
Description
This parameter configures the time in seconds a node holds to a reservation for which it triggered the soft preemption procedure.
The preempting node starts a separate preemption timer for each preempted LSP path. While this timer is on, the node should continue to refresh the Path and Resv for the preempted LSP paths. When the preemption timer expires, the node tears down the reservation if the head-end node has not already done so.
A value of zero means the LSP should be preempted immediately; hard preempted.
The no form of this command reverts to the default value.
Default
preemption-timer 300
Parameters
- seconds
-
Specifies the time (in s), of the preemption timer.
Platforms
7705 SAR Gen 2
prefer-local-time
prefer-local-time
Syntax
[no] prefer-local-time
Context
[Tree] (config>system>time prefer-local-time)
Full Context
configure system time prefer-local-time
Description
This command sets the preference to use local or UTC time in the system. This preference is applied to objects such as log file names, created and completed times reported in log files, NETCONF and gRPC date-and-time leafs, and rollback times displayed in show routines.
The operator may force the timezone used for show outputs during a CLI session using an environment variable in the environment>time-display {utc | local} command.
The preference for CLI output is set with the environment time-display command.
The format used for the date-time strings may change when the prefer-local-time option is enabled. For example, when enabled, all date-time strings include a suffix of three to five characters that indicates the timezone used for the presentation. This suffix may not be present if the option in not enabled.
The time format for timestamps on log events is controlled on a per-log basis using the config> log>log-id>time-format {utc | local} CLI command and not via prefer-local-time.
The no form of this command indicates preference for UTC time.
Default
no prefer-local-time
Platforms
7705 SAR Gen 2
prefer-protocol-stitching
prefer-protocol-stitching
Syntax
[no] prefer-protocol-stitching
Context
[Tree] (config>router>ldp prefer-protocol-stitching)
Full Context
configure router ldp prefer-protocol-stitching
Description
This command stitches an LDP ILM to an SR NHLFE rather than to an LDP NHLFE when both LDP and SR NHLFEs exist.
The no form of this command stitches an LDP ILM to an LDP NHLFE by preference over an SR NHLFE.
Default
no prefer-protocol-stitching
Platforms
7705 SAR Gen 2