Chapter H through R

holddown (PfR)

To configure the Performance Routing (PfR) prefix route dampening timer to set the minimum period of time for which a new exit must be used before an alternate exit can be selected, use the holddown command in PfR master controller configuration mode. To return the prefix route dampening timer to the default value, use the no form of this command.

holddown timer

no holddown

Syntax Description

timer

The prefix route dampening time period, in seconds. The range is from 90 to 65535. With CSCtr26978, the default time period changed from 300 to 90.

Command Default

With CSCtr26978, the default value of 300 seconds changed to 90 seconds for the prefix route dampening time period if this command is not configured or if the no form of this command is entered.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3S.

15.2(3)T

This command was modified. With CSCtr26978, the default timer value changed.

15.2(2)S

This command was modified. With CSCtr26978, the default timer value changed.

Cisco IOS XE Release 3.6

This command was modified. With CSCtr26978, the default timer value changed.

Usage Guidelines

The holddown command is entered on a master controller. This command is used to configure the prefix route dampening timer to set the minimum period of time for which a new exit must be used before an alternate exit can be selected. The master controller puts a prefix in a hold-down state during an exit change to isolate the prefix during the transition period to prevent the prefix from flapping because of rapid state changes. PfR does not implement policy changes while a prefix is in the hold-down state. A prefix will remain in a hold-down state for the default or configured time period. When the hold-down timer expires, PfR will select the best exit based on performance and policy configuration. However, an immediate route change will be triggered if the current exit for a prefix becomes unreachable.

Configuring a new timer value will immediately replace the existing value if the new value is less than the amount of the time remaining. If the new value is greater than the amount of the time remaining, the new timer value will be used when the existing timer is reset.

Examples

The following example shows the commands used to set the prefix route dampening timer to 120 seconds:


Router(config)# pfr master
Router(config-pfr-mc)# holddown 120

host-address (PfR)


Note


Effective with Cisco IOS Releases 15.2(1)S, 15.2(3)T, and Cisco IOS XE Release 3.5S, the host-address command is not available in Cisco IOS software.


To configure a host device used by an application interface provider to communicate with a Performance Routing (PfR) master controller, use the host-address command in PfR master controller application interface provider configuration mode. To remove a host application interface device, use the no form of this command.

host-address ip-address key-chain key-chain-name [priority value]

no host-address ip-address

Syntax Description

ip-address

IP address of the host device.

key-chain

Specifies the key used as a password to authenticate communication for the host device.

key-chain-name

Name of the key chain used as a password for the host device.

priority

(Optional) Sets the priority of the host device.

value

(Optional) A number in the range from 1 to 65535. The lower the number, the higher the priority. The default priority is 65535.

Command Default

A host application interface device is not configured.

Command Modes

PfR master controller application interface provider configuration (config-pfr-mc-api-provider)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS 15.0(1)S.

Cisco IOS XE Release 3.1S

This command was integrated into Cisco IOS XE Release 3.1S.

15.2(1)S

This command was modified. This command was removed.

Cisco IOS XE Release 3.5S

This command was modified. This command was removed.

15.2(3)T

This command was modified. This command was removed.

Usage Guidelines

The PfR application interface defines the mode of communication and messaging between applications and the network for the purpose of optimizing the traffic associated with the applications. A provider is defined as an entity outside the network in which the router configured as a PfR master controller exists, for example, an ISP or a branch office of the same company. The provider has one or more host devices running one or more applications that use the PfR application interface to communicate with a PfR master controller. A provider must be registered with a PfR master controller before an application on a host device can interface with PfR. Use the api provider (PfR) command to register the provider, and use the host-address (PfR) command to configure a host device. After registration, a host device in the provider network can initiate a session with a PfR master controller. The PfR application interface provides an automated method for networks to be aware of applications and provides application-aware performance routing.

Use the optional priority keyword to specify a priority value for the host device when multiple host devices are configured. The number 1 assigns the highest priority to any requests from the host device. If you assign a priority, each host device must be assigned a different priority number. If you try to assign the same priority number to two different host devices, an error message is displayed on the console.

Examples

The following example shows the commands used to configure a host application interface device on a master controller. In this example, more than one provider is registered, and a priority is set for each provider. For the single host device configured for provider 1, no priority is set and the default priority value of 65535 is assigned, giving this host device a lower priority than each of the host devices configured for provider 2.


Router(config)# pfr master
Router(config-pfr-mc)# api provider 1
Router(config-pfr-mc-api-provider)# host-address 10.100.2.2 key-chain PFR_HOST
Router(config-pfr-mc-api-provider)# exit
Router(config-pfr-mc)# api provider 2 priority 4000
Router(config-pfr-mc-api-provider)# host-address 10.100.2.2 key-chain PFR_HOST
priority 3000
Router(config-pfr-mc-api-provider)# host-address 10.100.2.2 key-chain PFR_HOST
priority 4000
Router(config-pfr-mc-api-provider)# end

hub

To configure the IP address of the hub master controller, use the hub command in master controller configuration mode. To remove the IP address, use the no form of this command.

hub ip-address

Syntax Description

ip-address

Specifies the IP address of regional-hub master controller.

Command Default

IP address of regional-hub master controller is not configured.

Command Modes

Master controller configuration mode (config-domain-vrf-mc)#

Command History

Release Modification

Cisco IOS XE 3.13S

This command was introduced.

Usage Guidelines

Use this command for the branch master controller configuration.

Examples

The following example shows how to configure IP address of the regional-hub master controller when configuring branch master controller:

Device(config-domain-vrf-mc)# hub 10.1.1.1

inside bgp (PfR)

To configure Performance Routing (PfR) to learn the inside prefixes within a network, use the inside bgp command in PfR Top Talker and Top Delay learning configuration mode. To disable prefix learning of inside prefixes, use the no form of this command.

inside bgp

no inside bgp

Syntax Description

This command has no arguments or keywords.

Command Default

No inside prefixes are learned by PfR.

Command Modes

PfR Top Talker and Top Delay learning configuration (config-pfr-mc-learn)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

This command is used to implement PfR Border Gateway Protocol (BGP) inbound optimization by identifying the prefixes within a network (inside prefixes). PfR BGP inbound optimization supports best entrance selection for traffic that originates from prefixes outside an autonomous system destined for prefixes inside the autonomous system. External BGP (eBGP) advertisements from an autonomous system to another autonomous system (for example, an Internet service provider [ISP]) can influence the entrance path for traffic entering the network. PfR uses eBGP advertisements to manipulate the best entrance selection.

Examples

The following example shows how to configure a PfR master controller to automatically learn the inside prefixes in a network:


Router(config)# pfr master 
Router(config-pfr-mc)# learn 
Router(config-pfr-mc-learn)# inside bgp

interface (PfR)

To configure a border router interface as a Performance Routing (PfR) managed external or internal interface, use the interface command in PfR managed border router configuration mode. To remove an interface from PfR control, use the no form of this command.

interface type number {external | internal}[ exit-nickname]

no interface type number {external | internal}

Syntax Description

type

Specifies the type of interface.

number

Specifies the interface or subinterface number.

external

Configures an interface as external. External interfaces are used for active monitoring and traffic forwarding. Entering the external keyword also enters PfR border exit interface configuration mode.

internal

Configures an interface as internal. Internal interfaces are used for passive monitoring with NetFlow.

exit-nickname

(Optional) Specifies the nickname of the PfR-managed external interface.

Command Default

No border router interfaces are configured as PfR-managed interfaces.

Command Modes

PfR managed border router configuration (config-pfr-mc-br)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The interface command is entered on a master controller. This command is used to configure external and internal interfaces on border routers to be under PfR control. External interfaces are configured as PfR managed exit links to forward traffic. External interfaces are used by the master controller to actively monitor prefix and link performance. Internal interfaces are used only for passive performance monitoring with NetFlow.

At least one external and one internal interface must be configured on each border router to allow NetFlow to monitor inbound and outbound traffic. At least two external interfaces are required in a PfR-managed network. You can configure a maximum of 20 external interfaces for a single master controller in a PfR-managed network. Loopback interfaces are supported as external or internal interfaces.


Note


PfR does not support Ethernet interfaces that are Layer 2 only, for example, Ethernet switched interfaces.


Configuring an interface as external enters PfR border exit configuration mode. Under PfR border exit interface configuration mode, you can configure maximum link utilization on a per-interface basis with the max-xmit-utilization (PfR) command.


Note


Entering the interface command without the external or internal keyword places the router in global configuration mode and not PfR border exit configuration mode. The no form of this command should be applied carefully so that active interfaces are not removed from the router configuration.


Examples

The following example configures one internal interface and two external interfaces on a border router:


Router(config)# pfr master
Router(config-pfr-mc)# border 10.4.9.6 key-chain BR-KEY 
Router(config-pfr-mc-br)# interface FastEthernet0/1 internal
Router(config-pfr-mc-br)# interface FastEthernet0/0 external
 
Router(config-pfr-mc-br)# interface Serial 1/0 external 

interface tunnel (global configuration)

To enter interface configuration mode and configures tunnel name, use the interface tunnel command in global configuration mode.

interface tunnel tunnel-name

Syntax Description

tunnel-name

Specifies tunnel interface number. The range is from 0 to 2147483647.

Command Default

Tunnel interfaces are not configured.

Command Modes

Global configuration (config)#

Command History

Release Modification

Cisco IOS XE Release 3.13S

This command was introduced.

Examples

The following example shows how to enter interface configuration mode:

Device(config)# interface Tunnel100

jitter (PfR)

To specify the threshold jitter value that Performance Routing (PfR) will permit for an exit link, use the jitter command in PfR master controller configuration mode. To reset the maximum jitter value to its default value, use the no form of this command.

jitter threshold maximum

no jitter threshold

Syntax Description

threshold

Specifies a maximum absolute threshold value for jitter. Jitter is a measure of voice quality.

maximum

Number (in milliseconds) in the range from 1 to 1000, where 1 represents the highest voice quality, and 1000 represents the lowest voice quality. The default value is 30.

Command Default

No jitter values are specified.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The jitter command is used to specify the maximum tolerable jitter value permitted on an exit link. Jitter is a measure of voice quality where the lower the jitter value, the better the voice quality. If the jitter value is greater than the user-defined or the default value, PfR determines that the exit link is out-of-policy and searches for an alternate exit link.

Another measure of voice quality is the estimated Mean Opinion Score (MOS). Use the mos command and the jitter command in a PfR policy to define voice quality.

Examples

The following example shows how to configure the master controller to search for a new exit link if the jitter threshold value exceeds 20 milliseconds:


Router(config)# pfr master
Router(config-pfr-map)# jitter threshold 20

keepalive (PfR)

To configure the length of time that a Performance Routing (PfR) master controller will maintain connectivity with a PfR border router after no keepalive packets have been received, use the keepalive command in PfR master controller configuration mode. To return the keepalive timer to the default time interval, use the no form of this command.

keepalive [timer]

no keepalive

Syntax Description

timer

(Optional) Sets the keepalive time interval, in seconds. The configurable range for this argument is from 0 to 1000. The default time interval is 5.

Command Default

PfR sets the keepalive time interval to 5 seconds if this command is not configured or if the no form of this command is entered.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The keepalive command is entered on a master controller. The PfR master controller sends keepalive packets to border routers to maintain connectivity between the master controller and the border router. If the master controller does not receive keepalive packets from a border router before the keepalive timer expires and this situation happens three times in a row, then the master controller will not maintain the connection.

Examples

The following example sets the keepalive time interval to 10 seconds:


Router(config)# pfr master
Router(config-pfr-mc)# keepalive 10
 

learn (PfR)

To enter PfR Top Talker and Top Delay learning configuration mode to configure Performance Routing (PfR) to learn prefixes, use the learn command in PfR master controller configuration mode. To disable prefix learning, use the no form of this command.

learn

no learn

Syntax Description

This command has no arguments or keywords.

Command Default

PfR Top Talker and Top Delay learning configuration mode is not entered.


Note


With CSCtr26978, learn mode using throughput is enabled by default.


Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.2(3)T

This command was modified. The PfR simplification project introduced automatic enabling of learn mode.

Usage Guidelines

The learn command is entered on a master controller and is used to enter PfR Top Talker and Top Delay learning configuration mode to configure a master controller to learn and optimize prefixes based on the highest throughput or the highest delay. Under the Top Talker and Top Delay learning configuration mode, you can configure prefix learning based on delay and throughput statistics. You can configure the length of the prefix learning period, the interval between prefix learning periods, the number of prefixes to learn, and the prefix learning based on protocol.


Note


With CSCtr26978, learn mode using throughput is enabled by default.


Examples

The following example enters PfR Top Talker and Top Delay learning configuration mode:


Router(config)# pfr master
Router(config-pfr-mc)# learn 
Router(config-pfr-mc-learn)#

link-group (PfR)

To configure a Performance Routing (PfR) border router exit interface as a member of a link group, use the link-group command in PfR border exit interface configuration mode. To remove an interface from a link group, use the no form of this command.

link-group link-group-name [link-group-name [link-group-name] ]

no link-group link-group-name [link-group-name [link-group-name] ]

Syntax Description

link-group-name

Name of a link group.

Command Default

No link groups are configured for a PfR border router exit interface.

Command Modes

PfR border exit interface configuration (config-pfr-mc-br-if)

Command History

Release

Modification

15.1(2)T

This command was introduced.

Usage Guidelines

Link groups are used to define a group of exit links as a preferred set of links or as a fallback set of links for PfR to use when optimizing a specified traffic class. Up to three link groups can be specified for each interface. Configure this command on a master controller to define the link group for an interface, and use the set link-group (PfR) command to define the primary link group and a fallback link group for a specified traffic class in a PfR map.

Use the show pfr master link-group command to view information about configured PfR link groups.

Examples

The following example configures one external interface on a border router as a member of the link group named VIDEO and another external interface as a member of two link groups named VOICE and DATA:


Router(config)# pfr master
Router(config-pfr-mc)# border 10.4.9.6 key-chain BR-KEY 
Router(config-pfr-mc-br)# interface Serial 1/0 external 
Router(config-pfr-mc-br-if)# link-group VIDEO
Router(config-pfr-mc-br-if)# exit
Router(config-pfr-mc-br)# interface Serial 2/0 external 
Router(config-pfr-mc-br-if)# link-group VOICE DATA
Router(config-pfr-mc-br-if)# exit
Router(config-pfr-mc-br)# interface FastEthernet0/1 internal
Router(config-pfr-mc-br)# end

list (PfR)

To create a Performance Routing (PfR) learn list to specify criteria for learning traffic classes and to enter learn list configuration mode, use the list command in PfR Top Talker and Top Delay learning configuration mode. To remove the learn list, use the no form of this command.

list seq number refname ref-name

no list seq number refname ref-name

Syntax Description

seq

Applies a sequence number to a learn list.

number

Number representing a sequence that is used to determine the order in which learn list criteria are applied. The range of sequence numbers that can be entered is from 1 to 65535.

refname

Specifies a reference name for the PfR learn list.

ref-name

Reference name for the learn list. The name must be unique within all the configured PfR learn lists.

Command Default

No PfR learn lists are created.

Command Modes

PfR Top Talker and Top Delay learning configuration (config-pfr-mc-learn)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

Learn lists are a way to categorize learned traffic classes. In each learn list, different criteria for learning traffic classes including prefixes, application definitions, filters, and aggregation parameters can be configured. A traffic class is automatically learned by PfR based on each learn list criteria, and each learn list is configured with a sequence number. The sequence number determines the order in which learn list criteria are applied. Learn lists allow different PfR policies to be applied to each learn list; in previous releases the traffic classes could not be divided, and a PfR policy was applied to all the traffic classes profiled during one learning session.

New traffic-class commands were introduced under learn list configuration mode to simplify the learning of traffic classes. Three types of traffic classes--to be automatically learned--can be profiled:

  • Traffic classes based on destination prefixes.

  • Traffic classes representing custom application definitions using access lists.

  • Traffic classes based on a static application mapping name with an optional prefix list filtering to define destination prefixes.

Only one type of traffic-class command can be specified per learn list, and the throughput (PfR) and delay (PfR) commands are also mutually exclusive within a learn list.

Examples

The following example shows how to configure a master controller to learn top prefixes based on the highest throughput for a learn list named LEARN_REMOTE_LOGIN_TC that learns Telnet and Secure Shell (SSH) application traffic class entries:


Router(config)# pfr master 
Router(config-pfr-mc)# learn 
Router(config-pfr-mc-learn)# list seq 10 refname LEARN_REMOTE_LOGIN_TC
Router(config-pfr-mc-learn-list)# traffic-class application telnet ssh
Router(config-pfr-mc-learn-list)# aggregation-type prefix-length 24 
Router(config-pfr-mc-learn-list)# throughput

load-balance

To configure load balancing for non-policy traffic, use the load-balance command in master controller configuration mode. To remove the load-balancing, use the no form of this command.

load-balance

no load-balance

Syntax Description

This command has no arguments or keywords.

Command Default

Load balancing is not configured for hub master controller configuration.

Command Modes

Master controller configuration mode (config-domain-vrf-mc)#

Command History

Release Modification

Cisco IOS XE 3.13S

This command was introduced.

Examples

The following example shows how to configure load-balancing:

Device(config-domain-vrf-mc)# load-balance

local (PfR)

To identify a local interface on a Performance Routing (PfR) border router as the source for communication with a PfR master controller, use the local command in PfR border router configuration mode. To remove the interface from the PfR border router configuration and disable communication between the border router and the master controller, use the no form of this command.

local interface-type interface-number

no local interface-type interface-number

Syntax Description

interface-type

Specifies the interface type.

interface-number

Specifies the interface number.

Command Default

No local interface is configured.

Command Modes

PfR border router configuration (config-pfr-br)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.1S

This command was integrated into Cisco IOS XE Release 3.1S.

Usage Guidelines

The local command is configured on a PfR border router. This command is used to specify the source interface IP address that will be used for communication between a border router and a master controller.

The IP address that is configured for the local interface must also be configured on the master controller using the border (PfR) command and the interface (PfR) command.

The no form of this command cannot be entered while the border router process is active. The border router process must first be stopped with the shutdown (PfR) command. If you stop the border router process to deconfigure the local interface with the no form of this command, you must configure another local interface before the border router process will reestablish communication with the master controller.

Examples

The following example configures Fast Ethernet interface 0/0 as a local interface:


Router(config)# pfr border 
Router(config-pfr-br)# local FastEthernet0/0

logging (PfR)

To enable syslog event logging for a Performance Routing (PfR) master controller or a PfR border router process, use the logging command in PfR master controller or PfR border router configuration mode. To disable PfR event logging, use the no form of this command.

logging

no logging

Syntax Description

This command has no keywords or arguments.

Command Default

Syslog event logging is not enabled for a PfR master controller or border router process.

Command Modes

PfR border router configuration (config-pfr-br) PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

Cisco IOS XE Release 3.1S

This command was integrated into Cisco IOS XE Release 3.1S.

Usage Guidelines

The logging command is entered on a master controller or border router. System logging is enabled and configured in Cisco IOS software under global configuration mode. The logging command in PfR master controller or PfR border router configuration mode is used only to enable or disable system logging under PfR. PfR system logging supports the following message types:

  • Error Messages—These messages indicate PfR operational failures and communication problems that can impact normal PfR operation.

  • Debug Messages—These messages are used to monitor detailed PfR operations to diagnose operational or software problems.

  • Notification Messages—These messages indicate that PfR is performing a normal operation.

  • Warning Messages—These messages indicate that PfR is functioning properly, but an event outside of PfR may be impacting normal PfR operation.


Note


With CSCtx06699, PfR syslog levels are added to minimize the number of messages displayed, and a syslog notice is added to display when 30 percent of the traffic classes are out-of-policy.



Note


With CSCts74631, PfR syslog levels are added to minimize the number of messages displayed, a syslog notice is added to display when 30 percent of the traffic classes are out-of-policy, and new syslog alerts are added for a PfR version mismatch, an MC-BR authentication error, and when minimum PfR requirements are not met and the master controller is disabled because there are less than two operational external interfaces.


To modify system, terminal, destination, and other system global logging parameters, use the logging commands in global configuration mode. For more information about system logging commands, see the Cisco IOS Configuration Fundamentals Command Reference.

Cisco IOS XE Release 3.1S

This command is supported only in PfR border router configuration mode.

Examples

The following example enables PfR system logging on a master controller:


Router(config)# pfr master
Router(config-pfr-mc)# logging 

The following example enables PfR system logging on a border router:


Router(config)# pfr border
Router(config-pfr-br)# logging

loss (PfR)

To set the relative or maximum packet loss limit that Performance Routing (PfR) will permit for an exit link, use the loss command in PfR master controller configuration mode. To return the packet loss limit to the default value, use the no form of this command.

loss {relative average | threshold maximum}

no loss

Syntax Description

relative average

Sets a relative percentage of packet loss based on a comparison of short-term and long-term packet loss percentages. The range of values that can be configured for this argument is a number from 1 to 1000. Each increment represents one tenth of a percent.

threshold maximum

Sets absolute packet loss based on packets per million (PPM). The range of values that can be configured for this argument is from 1 to 1000000.

Command Default

PfR uses the following default value if this command is not configured or if the no form of this command is entered:

relative average : 100 (10 percent packet loss)

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The loss command is used to specify the relative percentage or maximum number of packets that PfR will permit to be lost during transmission on an exit link. If packet loss is greater than the user-defined or default value, PfR determines that the exit link is out-of-policy and searches for an alternate exit link.

The relative keyword is used to configure the relative packet loss percentage. The relative packet loss percentage is based on a comparison of short-term and long-term packet loss. The short-term measurement reflects the percentage of packet loss within a 5-minute period. The long-term measurement reflects the percentage of packet loss within a 60-minute period. The following formula is used to calculate this value:

Relative packet loss = ((short-term loss - long-term loss) / long-term loss) * 100

The master controller measures the difference between these two values as a percentage. If the percentage exceeds the user-defined or default value, the exit link is determined to be out-of-policy. For example, if long-term packet loss is 200 PPM and short-term packet loss is 300 PPM, the relative loss percentage is 50 percent.

The threshold keyword is used to configure the absolute maximum packet loss. The maximum value is based on the actual number of PPM that have been lost.

Examples

The following example configures the master controller to search for a new exit link if the difference between long- and short-term measurements (relative packet loss) is greater than 20 percent:


Router(config)# pfr master
Router(config-pfr-mc)# loss relative 200 

The following example configures PfR to search for a new exit link when 20,000 packets have been lost:


Router(config)# pfr master
Router(config-pfr-mc)# loss threshold 20000

master (PfR)

To establish communication with a Performance Routing (PfR) master controller, use the master command in PfR border router configuration mode. To disable communication with the specified master controller, use the no form of this command.

master ip-address key-chain key-name

no master

Syntax Description

ip-address

IP address of the master controller.

key-chain key-name

Specifies the key chain to authenticate with the master controller.

Command Default

No communication is established between a border router and a master controller.

Command Modes

PfR border router configuration (config-pfr-br)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.1S

This command was integrated into Cisco IOS XE Release 3.1S.

Usage Guidelines

The master command is entered on a border router. This command is used to establish communication between a PfR border router and a master controller. Communication is established between the border router process and the master controller process to allow the master controller to monitor and control PfR exit links. PfR communication must also be established on the master controller with the border PfR master controller configuration command. At least one border router must be configured to enable PfR. A maximum of ten border routers can be configured to communicate with a single master controller. The IP address that is used to specify the border router must be assigned to a local interface on the border router and must be reachable by the master controller.

By default, passive monitoring in PfR observe mode is enabled when communication is established between a master controller and a border router. Communication between the master controller and the border router is protected by key-chain authentication. The authentication key must be configured on both the master controller and the border router before communication can be established. The key-chain configuration is defined in global configuration mode on both the master controller and the border router before key-chain authentication is enabled for communication between a master controller and a border router. For more information about key management in Cisco IOS software, see the "Managing Authentication Keys" section in the "Configuring IP Protocol-Independent Features" chapter of the Cisco IOS IP Routing: Protocol-Independent Configuration Guide.

Examples

The following example defines a key chain named MASTER in global configuration mode and then configures a PfR border router to communicate with the PfR master controller at 10.4.9.7. The master controller authenticates the border router based on the defined key CISCO.


Router(config)# key chain MASTER 
Router(config-keychain)# key 1 
Router(config-keychain-key)# key-string CISCO 
Router(config-keychain-key)# exit 
Router(config-keychain)# exit
 
Router(config)# pfr border
Router(config-pfr-br)# master 10.4.9.7 key-chain MASTER
Router(config-pfr-br)# end

master (domain vrf configuration)

To define a master type for the device in the Performance Routing Version 3 (PfRv3) configuration, use the master command in domain VRF configuration mode. To remove the master type configuration, use the no form of this command.

master {branch | hub | transit pop-id}

no master {branch | hub | transit}

Syntax Description

branch

Sets master type as branch hub.

hub

Sets master type as hub.

transit

Sets master type as transit.

pop-id

Specifies the POP ID.

Command Default

The master type is not defined.

Command Modes

Domain VRF configuration (config-domain-vrf)#

Command History

Release Modification

Cisco IOS XE Release 3.13S

This command was introduced.

Examples

The following example shows how to set up master type for a device:


Device> enable
Device# configure terminal
Device(config)# domain default
Device(config-domain)# vrf cisco
Device(config-domain-vrf)# master branch
Device(config-domain-vrf)# master hub
Device(config-domain-vrf)# master regional-hub

match

To specify the application or DSCP policies for class, use the match command in domain class configuration mode. To remove the class policies, use the no of this command.

match {application | dscp | {codepoint-value | af11 | af12 | af13 | af21 | af22 | af23 | af31 | af32 | af33 | af41 | af42 | af43 | cs1 | cs2 | cs3 | cs4 | cs5 | cs6 | cs7 | default | ef} | {policy | {best-effort | bulk-data | custom | low-latency-data | real-time-video | voice}}}

no match {application | dscp | {codepoint-value | af11 | af12 | af13 | af21 | af22 | af23 | af31 | af32 | af33 | af41 | af42 | af43 | cs1 | cs2 | cs3 | cs4 | cs5 | cs6 | cs7 | default | ef} | {policy | {best-effort | bulk-data | custom | low-latency-data | real-time-video | voice}}}

Syntax Description

application

Specifies the application.

dscp

Specifies the DSCP.

codepoint-value

Specifies the differentiated services code-point value. The range is from 0 to 63.

af

Specifies the match packets with AF DSCP.

cs

Specifies the match packets with CS DSCP.

default

Specifies the match packets with default DSCP.

ef

Specifies the match packets with EF DSCP.

policy

Specifies the user-defined or pre-defined policy type.

best-effort

Specifies the domain policy type as best effort.

bulk-data

Specifies the domain policy type as bulk data.

custom

Specifies the domain policy type as custom.

low-latency-data

Specifies the domain policy type as low latency data.

real-time-video

Specifies the domain policy type as real time video.

scavenger

Specifies the domain policy type as scavenger.

voice

Specifies the domain policy type as voice.

Command Default

User-defined or pre-defined policies are not defined.

Command Modes

Domain class configuration (config-domain-vrf-mc-class)

Command History

Release Modification

Cisco IOS XE Release 3.13S

This command was introduced.

Usage Guidelines

Use this command to configure domain policies on a master hub controller. Domain policies are defined only on the hub-master controller and then sent over peering infrastructure to all the branch-master controllers. Policies can be defined per application or per differentiated service code point (DSCP). You cannot mix and match DSCP and application-based policies in the same class group. Traffic that does not match any of the classification and match statements falls into a default group, which is load balanced (no performance measurement is done).


Note


You can define policies based on either per application or per differentiated services code point (DSCP) but, you cannot mix and match DSCP and application-based policies in the same class group. You can use predefined policies from the template or create custom policies.


Examples

The following example shows how to configure DSCP policies:

Device(config)# domain one
Device(config-domain)# vrf default
Device(config-domain-vrf)# master hub
Device(config-domain-vrf-mc)# monitor-interval 2 dscp ef
Device(config-domain-vrf-mc)# load-balance
Device(config-domain-vrf-mc)# class VOICE sequence 10
Device(config-domain-vrf-mc-class)# match dscp ef policy voice
Device(config-domain-vrf-mc-class)# path-preference MPLS fallback INET
Device(config-domain-vrf-mc-class)# exit
Device(config-domain-vrf-mc)# class VIDEO sequence 20
Device(config-domain-vrf-mc-class)# match dscp af41 policy real-time-video
Device(config-domain-vrf-mc-class)# match dscp cs4 policy real-time-video
Device(config-domain-vrf-mc-class)# path-preference INET fallback MPLS
Device(config-domain-vrf-mc-class)# exit
Device(config-domain-vrf-mc)# class CRITICAL sequence 30
Device(config-domain-vrf-mc-class)# match dscp af31 policy custom
Device(config-domain-vrf-mc-class-type)# priority 2 loss threshold 10
Device(config-domain-vrf-mc-class-type)# priority 1 one-way-delay threshold 600
Device(config-domain-vrf-mc-class-type)# priority 2 jitter threshold 600
Device(config-domain-vrf-mc-class)# exit
Device(config-domain-vrf-mc-class)# path-preference MPLS fallback INET

match ip address (PfR)

To reference an extended IP access list or an IP prefix as match criteria in a Performance Routing (PfR) map, use the match ip address command in PfR map configuration mode. To delete the match clause entry, use the no form of this command.

match ip address {access-list name | prefix-list name [inside]}

no match ip address

Syntax Description

access-list name

Specifies a named extended access list (created with the ip access-list command) as the match criterion in a PfR map.

prefix-list name

Specifies a prefix list (created with the ip prefix-list command) as the match criterion in a PfR map.

inside

(Optional) Specifies an inside prefix.

Command Default

No match is performed.

Command Modes

PfR map configuration (config-pfr-map)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The match ip address (PfR) command defines a policy, within a PfR map, for a list of prefixes. The match ip address (PfR) command is entered on a master controller in PfR map configuration mode. This command is used to configure a named extended access list or IP prefix list as a match criteria in a PfR map. Only one match clause can be configured for each PfR map sequence. The access list is created with the ip access-list command. Only named extended IP access lists are supported. The IP prefix list is created with the ip prefix-list command. A prefix can be any IP network number combined with a prefix mask that specifies the prefix length.

The inside keyword is used to support PfR BGP inbound optimization which in turn supports best entrance selection for traffic that originates from prefixes outside an autonomous system destined for prefixes inside the autonomous system. External BGP (eBGP) advertisements from an autonomous system to an Internet service provider (ISP) can influence the entrance path for traffic entering the network. PfR uses eBGP advertisements to manipulate the best entrance selection.

Examples

The following example creates a prefix list named CUSTOMER. The prefix list creates a filter for the 10.4.9.0/24 network. The match ip address (PfR) command configures the prefix list as match criterion in a PfR map.


Router(config)# ip prefix-list CUSTOMER permit 10.4.9.0/24
Router(config)# pfr-map SELECT_EXIT 10 
Router(config-pfr-map)# match ip address prefix-list CUSTOMER 
Router(config-pfr-map)# set mode select-exit good 

The following example creates an extended access list named FTP. The named extended access list creates a filter for FTP traffic that is sourced from the 10.1.1.0/24 network. The match ip address (PfR) command configures the access list as the match criterion in a PfR map. FTP traffic is policy-routed to the first in-policy exit.


Router(config)# ip access-list extended FTP 
Router(config-ext-nacl)# permit tcp 10.1.1.0 0.0.0.255 any eq ftp 
Router(config-ext-nacl)# exit
 
Router(config)# pfr-map SELECT_EXIT 10 
Router(config-pfr-map)# match ip address access-list FTP 
Router(config-pfr-map)# set mode select-exit good 

The following example creates a prefix list named INSIDE1. The prefix list creates a filter for the 10.2.2.0/24 network. The match ip address (PfR) command configures the prefix list as the match criterion in a PfR map.


Router(config)# ip prefix-list INSI
DE1 seq 5 permit 10.2.2.0/24 
Router(config)# pfr-map INSIDE_PREFIXES 10 
Router(config-pfr-map)# match ip address prefix-list INSIDE1 inside 
Router(config-pfr-map)# set as-path prepend 45000

match pfr learn

To create a match clause entry in a Performance Routing (PfR) map to match PfR-learned prefixes, use the match pfr learn command in PfR map configuration mode. To delete the match clause entry, use the no form of this command.

match pfr learn {delay | inside | list refname | throughput}

no match pfr learn {delay | inside | list | throughput}

Syntax Description

delay

Specifies prefixes learned based on highest delay.

inside

Specifies prefixes learned based on prefixes that are inside the network.

list

Specifies prefixes learned based on a PfR learn list.

refname

Reference name for a learn list. The name is defined using the list (PfR) command and must be unique within all the configured PfR learn lists.

throughput

Specifies prefixes learned based on highest throughput.

Command Default

No match is performed.

Command Modes

PfR map configuration (config-pfr-map)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The match pfr learn command is entered on a master controller in PfR map configuration mode. PfR can be configured to learn prefixes based on delay, inside prefix, criteria specified in a learn list, or throughput. This command is used to configure PfR learned prefixes as match criteria in a PfR map. Only one match clause can be configured for each PfR map sequence.

Examples

The following example shows the commands used to create a PfR map named DELAY that matches traffic learned based on delay. The set clause applies a route control policy that configures PfR to actively control this traffic.


Router(config)# pfr-map DELAY 20
Router(config-pfr-map)# match pfr learn delay
Router(config-pfr-map)# set mode route control 

The following example shows the commands used to create a PfR map named INSIDE that matches traffic learned based on inside prefixes. The set clause applies a route control policy that configures PfR to actively control this traffic.


Router(config)# pfr-map INSIDE 40
Router(config-pfr-map)# match pfr learn inside
Router(config-pfr-map)# set mode route control 

The following example shows the commands used to create a PfR map named LIST that matches traffic learned based on criteria defined in the PfR learn list named LEARN_LIST_TC. The learn list policy map is activated using the policy-rules (PfR) command.


Router(config)# pfr-map LIST 40
Router(config-pfr-map)# match pfr learn LEARN_LIST_TC
Router(config-pfr-map)# exit 
Router(config)# pfr master
Router(config-pfr-mc)# policy-rules LIST 

The following example shows the commands used to create a PfR map named THROUGHPUT that matches traffic learned based on throughput. The set clause applies a route control policy that configures PfR to actively control this traffic.


Router(config)# pfr-map THROUGHPUT 30
Router(config-pfr-map)# match pfr learn throughput
Router(config-pfr-map)# set mode route control 

match traffic-class access-list (PfR)

To define a match clause using an access list in a Performance Routing (PfR) map to create a traffic class, use the match traffic-class access-list command in PfR map configuration mode. To remove the match clause, use the no form of this command.

match traffic-class access-list access-list-name

no match traffic-class access-list

Syntax Description

access-list-name

Name of an access list. Names cannot contain either a space or quotation marks and must begin with an alphabetic character to distinguish them from numbered access lists.

Command Default

PfR traffic classes are not defined using match criteria in a PfR map.

Command Modes

PfR map configuration (config-pfr-map)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The match traffic-class access-list command is used to manually configure a traffic class that matches destination prefixes in an access list used in a PfR map. Only one access list can be specified, but the access list may contain many access list entries to help define the traffic class.


Note


The match traffic-class application (PfR) command, the match traffic-class application nbar (PfR) command, the match traffic-class access-list (PfR) command, and the match traffic-class prefix-list (PfR) commands are all mutually exclusive in a PfR map. Only one of these commands can be specified per PfR map.


Examples

The following example, starting in global configuration mode, shows how to define a custom traffic class using an access list. Every entry in the access list defines one destination network and can include optional criteria. A PfR map is used to match the destination prefixes and create the custom traffic class.


Router(config)# ip access-list extended CONFIGURED_TC
Router(config-ext-nacl)# permit tcp any 10.1.1.0 0.0.0.255 eq 500
Router(config-ext-nacl)# permit tcp any 172.16.1.0 0.0.0.255 eq 500 range 700 750
Router(config-ext-nacl)# permit tcp any 172.16.1.0 0.0.0.255 range 700 750
Router(config-ext-nacl)# permit tcp 192.168.0.0 0.0.255.255 10.1.2.0 0.0.0.255 eq 800
Router(config-ext-nacl)# exit
Router(config)# pfr-map ACCESS_MAP 10
Router(config-pfr-map)# match traffic-class access-list CONFIGURED_TC
Router(config-pfr-map)# end

match traffic-class application (PfR)

To define a match clause using a static application mapping in a Performance Routing (PfR) map to create a traffic class, use the match traffic-class application command in PfR map configuration mode. To remove the match clause entry, use the no form of this command.

match traffic-class application application-name [application-name . . . ] prefix-list prefix-list-name

no match traffic-class application application-name . . . [prefix-list prefix-list-name]

Syntax Description

application-name

Name of a predefined static application using fixed ports. See the Usage Guidelines section for a table of application keywords.One application must be specified, but the ellipsis shows that more than one application keyword can be specified up to a maximum of ten.

prefix-list

Specifies that the traffic flows are matched on the basis of destinations specified in a prefix list.

prefix-list-name

Name of a prefix list (created using the ip prefix-list command).

Command Default

PfR traffic classes are not defined using match criteria in a PfR map.

Command Modes

PfR map configuration (config-pfr-map)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The match traffic-class application command is used to manually configure the master controller to profile traffic destined for prefixes defined in an IP prefix list that match one or more applications. The applications are predefined with a protocol--TCP or UDP, or both--and one or more ports and this mapping is shown in the table below. More than one application can be configured as part of the traffic class.


Note


The match traffic-class application (PfR) command, the match traffic-class application nbar (PfR) command, the match traffic-class access-list (PfR) command, and the match traffic-class prefix-list (PfR) commands are all mutually exclusive in a PfR map. Only one of these commands can be specified per PfR map.


The table below displays the keywords that represent the application that can be configured with the match traffic-class application command. Replace the application-name argument with the appropriate keyword from the table.

Table 1. Static Application List Keywords

Keyword

Protocol

Port

cuseeme

TCP UDP

7648 7649 7648 7649 24032

dhcp (Client)

UDP/TCP

68

dhcp (Server)

UDP/TCP

67

dns

UDP/TCP

53

finger

TCP

79

ftp

TCP

20 21

gopher

TCP/UDP

70

http

TCP/UDP

80

httpssl

TCP

443

imap

TCP/UDP

143 220

irc

TCP/UDP

194

kerberos

TCP/UDP

88 749

l2tp

UDP

1701

ldap

TCP/UDP

389

mssql

TCP

1443

nfs

TCP/UDP

2049

nntp

TCP/UDP

119

notes

TCP/UDP

1352

ntp

TCP/UDP

123

pcany

UDP TCP

22 5632 65301 5631

pop3

TCP/UDP

110

pptp

TCP

17233

simap

TCP/UDP

585 993 (Preferred)

sirc

TCP/UDP

994

sldap

TCP/UDP

636

smtp

TCP

25

snntp

TCP/UDP

563

spop3

TCP/UDP

123

ssh

TCP

22

telnet

TCP

23

Examples

The following example, starting in global configuration mode, shows how to define application traffic classes in a PfR map named APP_MAP using predefined Telnet and Secure Shell (SSH) application criteria that are matched with destination prefixes specified in a prefix list, LIST1.


Router(config)# ip prefix-list LIST1 permit 10.1.1.0/24
Router(config)# ip prefix-list LIST1 permit 10.1.2.0/24
Router(config)# ip prefix-list LIST1 permit 172.16.1.0/24
Router(config)# pfr-map APP_MAP 10
Router(config-pfr-map)# match traffic-class application telnet ssh prefix-list LIST1
Router(config-pfr-map)# end

match traffic-class application nbar (PfR)

To define a match clause using a network-based application recognition (NBAR) application mapping in a Performance Routing (PfR) map to create a traffic class, use the match traffic-class application nbar command in PfR map configuration mode. To remove the match clause entry, use the no form of this command.

match traffic-class application nbar nbar-app-name [nbar-app-name . . . ] prefix-list prefix-list-name

no match traffic-class application nbar [nbar-app-name . . . ]

Syntax Description

nbar-app-name

Keyword representing the name of an application identified using NBAR. One application keyword must be specified, but more than one can be specified up to a maximum of ten. See the “Usage Guidelines” section for more details.

prefix-list

Specifies that the traffic flows are matched on the basis of destinations specified in a prefix list.

prefix-list-name

Name of a prefix list (created using the ip prefix-list command).

Command Default

PfR traffic classes identified using NBAR are not defined using match criteria in a PfR map.

Command Modes

PfR map configuration (config-pfr-map)

Command History

Release

Modification

15.1(2)T

This command was introduced.

Cisco IOS XE Release 3.7S

This command was integrated into Cisco IOS XE Release 3.7S.

Usage Guidelines

The match traffic-class application nbar command is used to manually configure the master controller to profile traffic destined for prefixes defined in an IP prefix list that match one or more applications identified using NBAR. More than one application can be configured as part of the traffic class with a maximum of ten applications entered per command line. Enter multiple match traffic-class application nbar command statements if you need to specify more than ten applications.

NBAR can identify applications based on the following three types of protocols:

  • Non-UDP and non-TCP IP protocols—For example, generic routing encapsulation (GRE) and Internet Control Message Protocol (ICMP).

  • TCP and UDP protocols that use statically assigned port numbers—For example, CU-SeeMe desktop video conference (CU-SeeMe-Server), Post Office Protocol over Transport Layer Security (TLS), and Secure Sockets Layer (SSL) server (SPOP3-Server).

  • TCP and UDP protocols that dynamically assign port numbers and require stateful inspection—For example, Real-Time Transport Protocol audio streaming (RTP-audio) and BitTorrent file transfer traffic (BitTorrent).

Use the match traffic-class application nbar ? command to determine if an application can be identified using NBAR and replace the nbar-app-name argument with the appropriate keyword from the screen display.

The list of applications identified using NBAR and available for profiling PfR traffic classes is constantly evolving. For lists of many of the NBAR applications defined using static or dynamically assigned ports, see the “Performance Routing with NBAR/CCE Application and Recognition” module.

For more details about NBAR, see the “Classifying Network Traffic Using NBAR” section of the QoS: NBAR Configuration Guide.


Note


The following commands mutually exclusive in a PfR map. Only one of these commands can be specified per PfR map.
  • match traffic-class access-list (PfR) command
  • match traffic-class application (PfR) command
  • match traffic-class application nbar (PfR) command
  • match traffic-class prefix-list (PfR) command

Examples

The following example, starting in global configuration mode, shows the commands used to define an application traffic class in a PfR map named APP_NBAR_MAP. The traffic class consists of RTP-audio traffic identified using NBAR and matched with destination prefixes specified in a prefix list, LIST1.

The traffic streams that the PfR map profiles for the RTP-audio application are:


10.1.1.1
10.2.2.1
172.16.1.1
172.17.1.2

The traffic classes that are learned for the RTP-audio application are:


10.2.2.0/24
172.17.1.0/24

Only traffic that matches both the RTP-audio application and the destination prefixes is learned:


Router(config)# ip prefix-list LIST1 permit 10.2.1.0/24
Router(config)# ip prefix-list LIST1 permit 10.2.2.0/24
Router(config)# ip prefix-list LIST1 permit 172.17.1.0/24
Router(config)# pfr-map APP_NBAR_MAP 10
Router(config-pfr-map)# match traffic-class application nbar rtp-audio prefix-list LIST1
Router(config-pfr-map)# end

match traffic-class prefix-list (PfR)

To define a match clause using a prefix list in a Performance Routing (PfR) map to create a traffic class, use the match traffic-class prefix-list command in PfR map configuration mode. To remove the match clause, use the no form of this command.

match traffic-class prefix-list prefix-list-name [inside]

no match traffic-class prefix-list

Syntax Description

prefix-list-name

Name of a prefix list.

inside

(Optional) Specifies that the prefix list contains inside prefixes.

Command Default

PfR traffic classes are not defined using match criteria in a PfR map.

Command Modes

PfR map configuration (config-pfr-map)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The match traffic-class prefix-list command is used to manually configure a traffic class that matches destination prefixes in a prefix list.

Use the optional inside keyword to specify prefixes that are within the internal network.


Note


The match traffic-class prefix-list (PfR) command, the match traffic-class access-list (PfR) command, the match traffic-class application (PfR), and the match traffic-class application nbar (PfR) commands are all mutually exclusive in a PfR map. Only one of these commands can be specified per PfR map.


Examples

The following example, starting in global configuration mode, shows how to manually configure a traffic class based only on destination prefixes. The traffic class is created using the prefix list LIST1 in a PfR map named PREFIX_MAP. Every entry in the prefix list, LIST1, defines one destination network of the traffic class.


Router(config)# ip prefix-list LIST1 permit 10.1.1.0/24
Router(config)# ip prefix-list LIST1 permit 10.1.2.0/24
Router(config)# ip prefix-list LIST1 permit 172.16.1.0/24
Router(config)# pfr-map PREFIX_MAP 10
Router(config-pfr-map)# match traffic-class prefix-list LIST1
Router(config-pfr-map)# end

max prefix (PfR)

To set the maximum number of prefixes that a Performance Routing (PfR) master controller will monitor or learn, use the max prefix command in PfR master controller configuration mode. To return the master controller to default values, use the no form of this command.

max prefix total number [learn number]

no max prefix total

Syntax Description

total number

Sets the total number of prefixes that the master controller will monitor. The range of values that can be entered for this argument is a number from 1 to 20000. Default value is 5000.

learn number

(Optional) Sets the total number of prefixes that the master controller will learn. The range of values that can be entered for this argument is a number from 1 to 20000. Default value is 2500.

Command Default

PfR uses the following default values if this command is not configured or if the no form of this command is entered:

  • total number : 5000

  • learn number : 2500

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Cisco IOS XE Release 3.8S

This command was modified. New default values were introduced by PfR/PBR Traffic Class Scaling Enhancement feature.

Usage Guidelines

The max prefix command is entered on a PfR master controller. This command is used to limit the number of prefixes that a master controller will monitor and learn to reduce memory and system resource consumption.

The PfR/PBR Traffic Class Scaling Enhancement feature introduced new PFR and dynamic route-map scaling improvement on BR to support a maximum of 20,000 application traffic classes (TC) with a maximum of 500 dynamic route-map sequences. Currently only 5000 application traffic classes and 32 route map entries are allowed. On a Route Processor 2 (RP2)/ESP40 Cisco recommends a maximum of 500 branches with 20,000 application traffic classes. On a Route Processor 1 (RP1)/ESP10 Cisco recommends a maximum of 500 branches with 10,000 application traffic classes.


Note


If you configure a lower value for the total keyword than for the learn keyword, the value for the total keyword will also set the maximum number of prefixes that a master controller will learn.


Examples

The following example configures PfR to monitor a maximum of 3000 prefixes and to learn a maximum of 1500 prefixes:


Device(config)# pfr master
Device(config-pfr-mc)# max prefix total 3000 learn 1500
 

The following example configures PfR to monitor a maximum of 15000 prefixes and to learn a maximum of 5000 prefixes. The PfR master controller must be running an image that supports the PfR/PBR Traffic Class Scaling Enhancement feature.


Device(config)# pfr master
Device(config-pfr-mc)# max prefix total 15000 learn 5000
 

max range receive (PfR)

To set the maximum utilization range for all Performance Routing (PfR) managed entrance links, use the max range receive command in PfR master controller configuration mode. To return the maximum utilization range for entrance links to the default value, use the no form of this command.

max range receive percent maximum

no max range receive

Syntax Description

percent

Specifies the maximum utilization range for all PfR entrance links as a percentage.

maximum

Maximum utilization range as a percentage. The range for this argument is from 1 to 100. The default is 20 percent.

Command Default

PfR uses the following default value (20 percent) if this command is not configured or if the no form of this command is entered:

percent maximum : 20

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The max range receive command is configured on a master controller. This command is used to set a threshold link utilization range for all entrance interfaces on PfR border routers.

PfR entrance link range functionality attempts to keep the entrance links within a utilization range relative to each other to ensure that the traffic load is distributed. The range is specified either as an absolute value in kilobits per second (kb/s) or as a percentage and is configured on the master controller to apply to all the entrance links on border routers managed by the master controller. For example, in a PfR-managed network with two entrance links, if the range is specified as 25 percent and the utilization of the first entrance link is 70 percent, then if the utilization of the second entrance link falls to 40 percent, the percentage range between the two entrance links will be more than 25 percent and PfR will attempt to move some traffic classes to use the second entrance to even the traffic load.

Examples

The following example shows how to enforce an entrance link selection for learned inside prefixes using the BGP autonomous system number community prepend technique. The max range receive command is configured under PfR master controller configuration mode to set a maximum receive range for all PfR-managed entrance links. In this example, the receive range between all the entrance links on the border routers must be within 35 percent.


Router> enable
Router# configure terminal
Router(config)# pfr master
Router(config-pfr-mc)# max range receive percent 35
Router(config-pfr-mc)# border 10.1.1.2 key-chain pfr
Router(config-pfr-mc-br)# interface ethernet1/0 external
Router(config-pfr-mc-br-if)# maximum utilization receive absolute 25000
Router(config-pfr-mc-br-if)# downgrade bgp community 3:1
Router(config-pfr-mc-br-if)# exit
Router(config-pfr-mc-br)# exit
Router(config-pfr-mc)# exit
Router(config)# pfr-map INSIDE_LEARN 10
Router(config-pfr-map)# match pfr learn inside
Router(config-pfr-map)# set delay threshold 400
Router(config-pfr-map)# set resolve delay priority 1
Router(config-pfr-map)# set mode route control
Router(config-pfr-map)# end

maximum utilization receive (PfR)

To set the maximum utilization on a single Performance Routing (PfR) managed entrance link, use the maximum utilization receive command in PfR border exit interface configuration mode. To return the maximum utilization on an entrance link to the default value, use the no form of this command.

maximum utilization receive {absolute kb/s | percentage bandwidth}

no maximum utilization receive

Syntax Description

absolute

Sets the maximum utilization on a PfR-managed entrance link to an absolute value.

kb/s

Maximum utilization for a PfR-managed entrance link, in kilobits per second (kb/s). The configurable range for this argument is a number from 1 to 1000000000.

percent

Sets the maximum utilization on a PfR-managed entrance link to a bandwidth percentage.

bandwidth

Entrance link bandwidth percentage. The range for this argument is from 1 to 100. The default is 75.

Command Default

PfR uses a default maximum of 75-percent bandwidth utilization for a PfR-managed entrance link if this command is not configured or if the no form of this command is entered.

Command Modes

PfR border exit interface configuration (config-pfr-mc-br-if)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The maximum utilization receive command is entered on a master controller to set the maximum utilization threshold of incoming traffic that can be transmitted over a PfR-managed entrance link interface. This command is configured on a per-entrance-link basis. Use this command with the downgrade bgp (PfR) command to configure PfR BGP inbound optimization. This command can also be used with the max range receive (PfR) command to configure entrance link load balancing.

If traffic utilization goes above the threshold, PfR tries to move the traffic from this entrance link to another underutilized entrance link.

Examples

The following example shows how to enforce an entrance link selection for learned inside prefixes using the BGP autonomous system number community prepend technique. The maximum utilization receive command is configured under PfR border exit interface configuration mode to set a maximum threshold value of 25000 kb/s for packets received through the entrance link Ethernet interface 1/0 on the border router.


Router> enable
Router# configure terminal
Router(config)# pfr master
Router(config-pfr-mc)# max range receive percent 35
Router(config-pfr-mc)# border 10.1.1.2 key-chain CISCO
Router(config-pfr-mc-br)# interface ethernet1/0 external
Router(config-pfr-mc-br-if)# maximum utilization receive absolute 25000
Router(config-pfr-mc-br-if)# downgrade bgp community 3:1
Router(config-pfr-mc-br-if)# exit
Router(config-pfr-mc-br)# exit
Router(config-pfr-mc)# exit
Router(config)# pfr-map INSIDE_LEARN 10
Router(config-pfr-map)# match pfr learn inside
Router(config-pfr-map)# set delay threshold 400
Router(config-pfr-map)# set resolve delay priority 1
Router(config-pfr-map)# set mode route control
Router(config-pfr-map)# end

max-range-utilization (PfR)

To set the maximum utilization range for all Performance Routing (PfR) managed exit links, use the max-range-utilization command in PfR master controller configuration mode. To return the maximum utilization range to the default value, use the no form of this command.

max-range-utilization percent maximum

no max-range-utilization

Syntax Description

percent

Specifies the maximum utilization range for all PfR exit links as a percentage.

maximum

Maximum utilization range percentage. The range for this argument is from 1 to 100. The default is 20.

Command Default

PfR uses the default value of a 20-percent maximum utilization range for all PfR-managed exit links if this command is not configured or if the no form of this command is entered.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

Usage Guidelines

The max-range-utilization command is configured on a master controller. This command is used to set a threshold link utilization range for all external interfaces on PfR border routers.

PfR exit link range functionality attempts to keep the exit links within a utilization range, relative to each other, to ensure that the traffic load is distributed. The range is specified as a percentage and is configured on the master controller to apply to all the exit links on border routers managed by the master controller. For example, in a PfR-managed network with two exit links, if the range is specified as 25-percent and the utilization of the first exit link is 70-percent, then if the utilization of the second exit link falls to 40-percent, the percentage range between the two exit links will be more than 25-percent and PfR will attempt to move some traffic classes to use the second exit to even the traffic load.

Examples

The following example sets the maximum utilization range for PfR-managed exit links to 25-percent:


Router(config)# pfr master
Router(config-pfr-mc)# max-range-utilization 25
 

max-xmit-utilization (PfR)

To set the maximum utilization bandwidth on a single Performance Routing (PfR) managed exit link, use the max-xmit-utilization command in PfR border exit interface configuration mode. To return the maximum utilization bandwidth on an exit link to the default value, use the no form of this command.

max-xmit-utilization {absolute kb/s | percentage bandwidth}

no max-xmit-utilization

Syntax Description

absolute

Sets the maximum utilization bandwidth on a PfR-managed exit link to an absolute value.

kb/s

Maximum utilization bandwidth for a PfR-managed exit link, in kilobits per second (kb/s). The configurable range for this argument is a number from 1 to 1000000000.

percentage

Sets the maximum utilization on a PfR-managed exit link to a bandwidth percentage.

bandwidth

Exit link bandwidth percentage. The range for this argument is from 1 to 100. With CSCtr26978, the default value changed from 75 to 90 percent.

Command Default

With CSCtr26978, the default value of 75 percent changed to 90 percent for the maximum utilization bandwidth on a single PfR-managed exit link if this command is not configured or if the no form of this command is entered.

Command Modes

PfR border exit interface configuration (config-pfr-mc-br-if)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3S.

15.2(3)T

This command was modified. With CSCtr26978, the default bandwidth value changed.

15.2(2)S

This command was modified. With CSCtr26978, the default bandwidth value changed.

Cisco IOS XE Release 3.6

This command was modified. With CSCtr26978, the default bandwidth value changed.

Usage Guidelines

The max-xmit-utilization command is entered on a master controller and allows you to set the maximum utilization bandwidth of outbound traffic that can be transmitted over a PfR-managed exit interface. The maximum utilization threshold can be expressed as an absolute value in kb/s or as a percentage. This command is configured on a per-exit-link basis and cannot be configured on PfR internal interfaces; internal interfaces are not used to forward traffic.

If the rate of traffic exceeds the threshold, PfR tries to move the traffic from this exit link to another underutilized exit link.

Examples

The following example shows the commands used to set the maximum exit link utilization bandwidth to 1,000,000 kb/s on Fast Ethernet interface 0/0:


Router(config-pfr-mc-br)# interface GigabitEthernet2/0/0 external
Router(config-pfr-mc-br-if)# max-xmit-utilization absolute 1000000
 

The following example shows the commands used to set the maximum percentage of exit utilization to 80 percent on serial interface 1/0:


Router(config-pfr-mc-br)# interface Serial 1/0 external
Router(config-pfr-mc-br-if)# max-xmit-utilization percentage 80

mc-peer

To configure Performance Routing (PfR) master controller (MC) peering, use the mc-peer command in PfR master controller configuration mode. To disable MC peering, use the no form of this command.

mc-peer [eigrp | head-end loopback interface-number | peer-address loopback interface-number] [domain domain-id] [description text]

no mc-peer

Domain-Only Syntax

mc-peer [domain domain-id]

no mc-peer

Syntax Description

domain

(Optional) Specifies a Service Advertisement Framework (SAF) domain ID to be used for MC peering.

domain-id

(Optional) SAF domain ID in the range of 1 to 65535.

eigrp

(Optional) Specifies that explicit Enhanced Interior Gateway Routing Protocol (EIGRP) configuration is to be used instead of autoconfiguration.

Note

 

With CSCud06237, when using the eigrp keyword option, a loopback interface must be specified to enable PfR to select a local ID.

head-end

(Optional) Specifies that this router is a head-end MC peer.

peer-address

(Optional) IP address of the head-end peer.

loopback

(Optional) Specifies a loopback interface.

interface-number

(Optional) Loopback interface number.

description

(Optional) Specifies a description of the MC site.

text

(Optional) Text description of the MC site using up to 40 characters.

Command Default

No PfR master controller peers are configured.

Command Modes

PfR master controller configuration (config-pfr-mc)
      

Command History

Release

Modification

Cisco IOS XE Release 3.5S

This command was introduced.

15.2(3)T

This command was integrated into Cisco IOS Release 15.2(3)T.

Usage Guidelines

The PfR Target Discovery feature introduces master controller peering using the configuration of Service Router (SR) forwarders on each master controller to establish peering between MCs at different sites and allow the advertisement of target-discovery data and the sharing of probe statistics from each site.

The MC-MC peering aspect of the target-discovery feature supports two different customer network deployments:
  • Multihop or Darknet—Networks in which the customer head-end and branch offices are separated by one or more routers not under the administrative control of the customer.

  • SAF-Everywhere—Networks in which all routers are under the control of the customer and the routers are enabled for EIGRP SAF in a contiguous path from the head-end MC to the branch office MC.

Depending on the network structure and the degree of control required over the configuration of probe targets and IP SLA responders, there are three main methods of configuring MC peering using the mc-peer command:

  • Configuring a domain ID or using the default domain ID of 59501. This option requires EIGRP SAF configuration on both head-office and branch-office master controller routers and can be used in the SAF-everywhere type of network.

  • Configuring the head-end (at the head office) or the peer IP address (at the branch office). This option requires a loopback interface to be configured as the source of EIGRP SAF adjacency. This configuration option is used in multihop/Darknet types of networks.

  • Configuring the EIGRP option where there is no autoconfiguration of EIGRP SAF. This option is used in the SAF-everywhere type of network.


Note


With CSCud06237, when using the mc-peer eigrp command option in PfR target discovery, a loopback interface must be specified to enable PfR to select a local ID.


Examples

The following example shows how to configure an MC peer using the domain ID of an existing EIGRP SAF domain. To use the default domain ID of 59501, use the mc-peer command without any keywords or arguments.


Router(config)# enable
Router(config)# configure terminal
Router(config)# pfr master
Router(config-pfr-mc)# mc-peer domain 45000
Router(config-pfr-mc)# end  

The following example shows how to configure an MC peer with the head-end keyword and an associated loopback interface. This example shows how to configure the head office in a multihop/Darknet type of network. To configure the branch office, use the peer-address argument and enter the IP address of the head-end MC and its associated loopback address.


Router(config)# enable
Router(config)# configure terminal
Router(config)# pfr master
Router(config-pfr-mc)# mc-peer head-end loopback 1
Router(config-pfr-mc)# end

The following example shows how to configure an MC peer using the EIGRP option.


Router(config)# enable
Router(config)# configure terminal
Router(config)# pfr master
Router(config-pfr-mc)# mc-peer eigrp
Router(config-pfr-mc)# end

minimum-mask-length

To configure minimum mask length value to be applied on egress flows, use the minimum-mask-length command in advanced configuration mode. To remove the mask length value, use the no form of this command.

minimum-mask-length {value | enterprise | internet}

no minimum-mask-length [enterprise | internet]

Syntax Description

value

Specifies the minimum mask length. The range is from 1 to 32.

enteprise

Specifies the enterprise minimum mask length.

internet

Specifies the internet minimum mask length.

Command Default

Default minimum mask length is used for hub master controller configuration.

Command Modes

Advanced configuration mode (config-domain-vrf-mc-advanced)#

Command History

Release Modification

Cisco IOS XE 3.13S

This command was introduced.

Cisco IOS XE Denali 16.3.1

This command was modifed. The keywords enterprise and internet were added.

Usage Guidelines

Minimum mask value is applied on IP addresses to generate a prefix to be used on egress flows

Examples

The following example shows how to configure minimum mask length value for hub master controller configuration:

Device(config-domain-vrf-mc-advanced)# minimum-mask-length 28

mitigation-mode

To configure mitigation mode for hub master controller configuration, use the mitigation-mode command in advanced configuration mode.

mitigation-mode aggressive

no mitigation-mode aggressive

Syntax Description

aggressive

Specifies the aggressive brownout.

Command Default

Brownout mitigation is not configured.

Command Modes

advanced (config-domain-vrf-mc-advanced)

Command History

Release Modification

Cisco IOS XE 3.13S

This command was introduced.

Examples

The below example shows how to configure brownout mitigation mode:

Device(config-domain-vrf-mc-advanced)# mitigation-mode aggressive

mode auto-tunnels


Note


Effective with CSCty36217 and CSCua59073, the mode auto-tunnels command is removed because the PfR BR Auto Neighbors feature was removed from all platforms.


mode monitor

To configure route monitoring on a Performance Routing (PfR) master controller, use the mode monitor command in PfR master controller configuration mode. To return the PfR master controller to the default monitoring state, use the no form of this command.

mode monitor {active [throughput] | both | fast | passive}

no mode monitor

Syntax Description

monitor

Enables the configuration of PfR monitoring settings.

active

Enables active monitoring.

throughput

(Optional) Enables active monitoring with throughput data from passive monitoring.

both

Enables both active and passive monitoring. This is the default monitoring mode.

fast

Enables continuous active monitoring and passive monitoring.

passive

Enables passive monitoring.

Command Default

PfR enables both active and passive monitoring if this command is not configured or if the no form of this command is entered.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The mode monitor command is entered on a master controller. This command is used to configure passive monitoring and active monitoring. A prefix can be monitored both passively and actively.

Passive Monitoring

The master controller passively monitors IP prefixes and TCP traffic flows. Passive monitoring is configured on the master controller. Monitoring statistics are gathered on the border routers and then reported back to the master controller. PfR uses NetFlow to collect and aggregate passive monitoring statistics on a per prefix basis. No explicit NetFlow configuration is required. NetFlow support is enabled by default when passive monitoring is enabled. PfR uses passive monitoring to measure the following information:

  • Delay --PfR measures the average delay of TCP flows for a prefix. Delay is the measurement of the time between the transmission of a TCP synchronization message and the receipt of the TCP acknowledgment.

  • Packet Loss --PfR measures packet loss by tracking TCP sequence numbers for each TCP flow. PfR estimates packet loss by tracking the highest TCP sequence number. If a subsequent packet is received with a lower sequence number, PfR increments the packet loss counter.

  • Reachability --PfR measures reachability by tracking TCP synchronization messages that have been sent repeatedly without receiving a TCP acknowledgment.

  • Throughput --PfR measures outbound throughput for optimized prefixes. Throughput is measured in bits per second (bps).


Note


PfR passively monitors TCP traffic flows for IP traffic. Passive monitoring of non-TCP sessions is not supported.


Active Monitoring

PfR uses Cisco IOS IP Service Level Agreements (SLAs) to enable active monitoring. IP SLA support is enabled by default. IP SLA support allows PfR to be configured to send active probes to target IP addresses to measure the jitter and delay, determining if a prefix is out-of-policy and if the best exit is selected. The border router collects these performance statistics from the active probe and transmits this information to the master controller. The master controller uses this information to optimize the prefix and select the best available exit based on default and user-defined policies. The active-probe (PfR) command is used to create an active probe.

Examples

The following example enables both active and passive monitoring:


Router(config)# pfr master
Router(config-pfr-mc)# mode monitor both

The following example enables fast failover monitoring:


Router(config)# pfr master
Router(config-pfr-mc)# mode monitor fast

The following example configures the master controller to enable active monitoring with throughput data from passive monitoring:


Router(config)# pfr master
Router(config-pfr-mc)# mode monitor active throughput

mode route

To configure route control on a Performance Routing (PfR) master controller, use the mode route command in PfR master controller configuration mode. To return the PfR master controller to the default control state, use the no form of this command.

mode route { {control | observe} | metric {bgp local-pref preference | eigrp tag community | static tag value} | protocol pbr}

no mode route {control | observe | metric {bgp | eigrp | static} | protocol pbr}

Syntax Description

control

Enables automatic route control.

observe

Configures PfR to passively monitor and report without making any changes. This is the default route control mode.

metric

Enables the configuration of route control based on the Border Gateway Protocol (BGP) local preference, Enhanced Interior Gateway Routing Protocol (EIGRP), or for specific static routes.

bgp local-pref

Sets the BGP local preference for PfR-controlled routes.

preference

A number from 1 to 65535.

eigrp tag

Applies a community value to an EIGRP route under PfR control.

community

A number from 1 to 65535.

static tag

Applies a tag to a static route under PfR control.

value

A number from 1 to 65535.

protocol pbr

Enables the route control of destination-only traffic using dynamic Policy-Based Routing (PBR) independent of the routing protocol of the parent prefix.

Command Default

With CSCtr26978, the default mode route was changed to control mode from observe mode if this command is not configured or if the no form of this command is entered. With CSCtr26978, the mode route protocol pbr command is enabled by default.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3S.

15.1(1)S1

This command was modified. The protocol and pbr keywords were added.

15.2(3)T

This command was modified. With CSCtr26978, the default mode route was changed to control mode from observe mode and the mode route protocol pbr command is enabled by default..

15.2(2)S

This command was modified. With CSCtr26978, the default mode route was changed to control mode from observe mode and the mode route protocol pbr command is enabled by default.

Cisco IOS XE Release 3.6

This command was modified. With CSCtr26978, the default mode route was changed to control mode from observe mode and the mode route protocol pbr command is enabled by default.

Usage Guidelines

The mode route command is entered on a master controller. This command is used to enable and configure route control mode and observe mode settings.

If you have different routing protocols operating on your PfR border routers (for example, BGP on one border router and EIGRP on another) you must configure the protocol and pbr keywords with the mode route command to allow destination-only traffic classes to be controlled using dynamic PBR. Entering the no mode route protocol pbr command will initially set the destination-only traffic classes to be uncontrolled and PfR will revert to the default behavior using a single protocol to control the traffic class in the following order: BGP, EIGRP, static, and PBR.


Note


With CSCtr26978, the mode route protocol pbr command is enabled by default.


Observe Mode

Observe mode monitoring is enabled by default. In observe mode, the master controller monitors prefixes and exit links based on the default and user-defined policies and then reports the status of the network and the decisions that should be made, but it does not implement any changes. This mode allows you to verify the effectiveness of this feature before it is actively deployed.


Note


With CSCtr26978, the default mode route was changed to control mode from observe mode.


Control Mode

In control mode, the master controller coordinates information from the border routers and makes policy decisions just as it does in observe mode. The master controller monitors prefixes and exits based on the default and user-defined policies, but then it implements changes to optimize prefixes and to select the best exit. In this mode, the master controller gathers performance statistics from the border routers and then transmits commands to the border routers to alter routing as necessary in the PfR managed network.


Note


With CSCtr26978, the default mode route was changed to control mode from observe mode.


Examples

The following example shows the commands used to enable route control mode:


Router(config)# pfr master
Router(config-pfr-mc)# mode route control 

The following example shows the commands used to configure the master controller to enable route control mode and to enable EIGRP route control that applies a community value of 700 to EIGRP routes under PfR control:


Router(config)# pfr master
Router(config-pfr-mc)# mode route control
Router(config-pfr-mc)# mode route metric eigrp tag 700

The following example shows the commands used to configure the master controller to allow destination-only traffic classes to be controlled using dynamic PBR. This form of the command is used when different protocols are operating at the border routers.


Router(config)# pfr master
Router(config-pfr-mc)# mode route protocol pbr

mode select-exit


Note


Effective with Cisco IOS Releases 15.2(1)S, 15.2(3)T, and Cisco IOS XE Release 3.5S, the mode select-exit command is not available in Cisco IOS software.


To configure route exit selection on a Performance Routing (PfR) master controller, use the mode select-exit command in PfR master controller configuration mode. To return the PfR master controller to the default exit selection state, use the no form of this command.

mode select-exit {best | good}

no mode select-exit

Syntax Description

best

Configures PfR to select the best available exit based on performance or policy.

good

Configures PfR to select the first exit that is in-policy. This is the default exit selection.

Command Default

PfR selects the first in-policy exit if this command is not configured or if the no form of this command is entered.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3.

15.2(1)S

This command was modified. This command was removed.

Cisco IOS XE Release 3.5S

This command was modified. This command was removed.

15.2(3)T

This command was modified. This command was removed.

Usage Guidelines

The master controller can be configured to select a new exit for an out-of-policy prefix based on performance or policy. You can configure the master controller to select the first in-policy exit by entering the good keyword, or you can configure the master controller to select the best exit with the best keyword. If the good keyword is used and there is no in-policy exit, the prefix is uncontrolled.

With CSCtr26978, the default behavior changed to select-exit good. No other option is available and the mode select-exit command was removed.

Examples

The following example shows the commands used to configure the master controller to select the first in-policy exit:


Router(config)# pfr master
Router(config-pfr-mc)# mode select-exit good 

mode verify bidirectional

To verify that Performance Routing (PfR) application traffic is bidirectional, use the mode verify bidirectional command in PfR master controller configuration mode. To disable bidirectional verification of PfR application traffic, use the no form of this command.

mode verify bidirectional

no mode verify bidirectional

Syntax Description

This command has no arguments or keywords.

Command Default

Bidirectional verification is enabled by default if this command is not configured or if the no form of this command is entered.

With CSCtr26978, no bidirectional verification is enabled by default if this command is not configured or if the no form of this command is entered.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3S.

15.2(3)T

This command was modified. With CSCtr26978, bidirectional verification is disabled by default.

15.2(2)S

This command was modified. With CSCtr26978, bidirectional verification is disabled by default.

Cisco IOS XE Release 3.6

This command was modified. With CSCtr26978, bidirectional verification is disabled by default.

Usage Guidelines

The mode verify bidirectional command is entered on a master controller. With CSCtr26978, the default behavior changed to disable the verification of bidirectional traffic.

Examples

Prior to CSCtr26978, the following example shows the commands used to disable the verification of bidirectional PfR application traffic:


Router(config)# pfr master
Router(config-pfr-mc)# no mode verify bidirectional

With CSCtr26978, the following example shows the commands used to enable the verification of bidirectional PfR application traffic:


Router(config)# pfr master
Router(config-pfr-mc)# mode verify bidirectional

monitor-interval

To configure interval time that defines monitoring interval on ingress monitors, use the monitor-interval command in master controller configuration mode. To remove the monitoring interval time, use the no form of this command.

monitor-interval seconds dscp {dscp-value | af11 | af12 | af13 | af21 | af22 | af23 | af31 | af32 | af33 | af41 | af42 | af43 | cs1 | cs2 | cs3 | cs4 | cs5 | cs6 | cs7 | default | ef}

no monitor-interval

Syntax Description

seconds

Specifies the monitoring interval in seconds. The range is from 1 to 300.

dscp

Specifies the Differentiated Services Code Point (DSCP).

dscp-value

Specifies the DSCP value codes. The range is from 0 to 63.

af11

Match packets with AF11 dscp (001010).

af12

Match packets with AF12 dscp (001100).

af13

Match packets with AF13 dscp (001110).

af21

Match packets with AF21 dscp (010010).

af22

Match packets with AF22 dscp (010100).

af23

Match packets with AF23 dscp (010110).

af31

Match packets with AF31 dscp (011010).

af32

Match packets with AF32 dscp (011100).

af33

Match packets with AF33 dscp (011110).

af41

Match packets with AF41 dscp (100010).

af42

Match packets with AF42 dscp (100100).

af43

Match packets with AF43 dscp (100110).

cs1

Match packets with CS1(precedence 1) dscp (001000).

cs2

Match packets with CS2(precedence 2) dscp (010000).

cs3

Match packets with CS3(precedence 3) dscp (011000).

cs4

Match packets with CS4(precedence 4) dscp (100000).

cs5

Match packets with CS5(precedence 5) dscp (101000).

cs6

Match packets with CS6(precedence 6) dscp (110000).

cs7

Match packets with CS7(precedence 7) dscp (111000).

default

Match packets with default dscp (000000).

ef

Match packets with EF dscp (101110).

Command Default

Monitor interval time is not configured.

Command Modes

Master controller configuration mode (config-domain-vrf-mc)

Command History

Release Modification

Cisco IOS XE 3.13S

This command was introduced.

Usage Guidelines

Use this command on the hub device for the master controller configuration to configure monitor interval on ingress monitors.

Examples

The following example shows how to configure monitor interval time:

Device(config-domain-vrf-mc)# monitor-interval 1 dscp ef

monitor-period (PfR)

To set the time period in which a Performance Routing (PfR) master controller learns traffic flows, use the monitor-period command in PfR Top Talker and Top Delay learning configuration mode. To return the monitoring period to the default time period, use the no form of this command.

monitor-period minutes

no monitor-period

Syntax Description

minutes

The prefix learning period, in minutes. The range is from 1 to 1440. With CSCtr26978, the default value changed from 5 to 1.

Command Default

If this command is not configured or if the no form of this command is entered, the default prefix learning period is 5 minutes. With CSCtr26978, the default value changed to 1.

Command Modes

PfR Top Talker and Top Delay learning configuration (config-pfr-mc-learn)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3S.

15.2(3)T

This command was modified. With CSCtr26978, the default value of the prefix learning period was changed.

15.2(2)S

This command was modified. With CSCtr26978, the default value of the prefix learning period was changed.

Cisco IOS XE Release 3.6

This command was modified. With CSCtr26978, the default value of the prefix learning period was changed.

Usage Guidelines

The monitor-period command is configured on a master controller. This command is used to adjust the length of time during which a master controller learns traffic flows on border routers. The length of time between monitoring periods is configured with the periodic-interval (PfR) command. The number of prefixes that are learned is configured with the prefixes (PfR) command.

Examples

The following example shows the commands used to set the PfR monitoring period to 6 minutes on a master controller:


Router(config)# pfr master
Router(config-pfr-mc)# learn
Router(config-pfr-mc-learn)# monitor-period 6 

mos (PfR)

To specify the threshold and percentage Mean Opinion Score (MOS) values that Performance Routing (PfR) will permit for an exit link, use the mos command in PfR master controller configuration mode. To reset the threshold and percentage MOS values to their default value, use the no form of this command.

mos threshold minimum percent percent

no mos threshold minimum percent percent

Syntax Description

threshold

Specifies a threshold MOS value that represents a minimum voice quality for exit link utilization.

minimum

Number (to two decimal places) in the range from 1.00 to 5.00, where 1.00 represents the lowest voice quality and 5.00 represents the highest voice quality. The default MOS value is 3.60.

percent

Specifies a percentage value that is compared with the percentage of MOS samples that are below the MOS threshold.

percent

Number, as a percentage.

Command Default

The default MOS value is 3.60.

Command Modes

Master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3S

This command was integrated into Cisco IOS XE Release 3.3S.

Usage Guidelines

The mos command is used to determine voice quality. The number of MOS samples over a period of time that are below the threshold MOS value are calculated. If the percentage of MOS samples below the threshold is greater than the configured percentage, PfR determines that the exit link is out-of-policy and searches for an alternate exit link.

Another measure of voice quality is the jitter value. Use the mos (PfR) command and the jitter (PfR) command in a PfR policy to define voice quality.

Examples

The following example shows how to configure the master controller to search for a new exit link if more than 30 percent of the MOS samples are below the MOS threshold of 3.75:


Router(config)# pfr master
Router(config-pfr-mc)# mos threshold 3.75 percent 30

password

To specify a password for enabling secure connection, use the password command in domain border configuration mode. To remove the password, use the no form of this command.

password {0 | 7 | LINE}

no password

Syntax Description

0

Specifies an unencrypted password.

7

Specifies a hidden password.

LINE

Specifies an unencrypted clear text line password.

Command Default

The password for secure connection is not specified.

Command Modes

Domain border configuration mode (config-domain-vrf-br)

Command History

Release Modification

Cisco IOS XE 3.13S

This command was introduced.

Examples

The following example shows how to specify the password:


Device (config-domain-vrf-br)# password 7 13061E010803

path-preference

To set a preferred path for a traffic class policy, use the path-preference command in domain-class configuration mode. To remove the path preference, use the no form of this command.

path-preference path1 {path 2 | [pathn] | fallback fallback-path1 | [fallback-path2 | [fallback-pathn] | next-fallback] | {next-fallback-path1 [next-fallback-pathn ] | {blackhole | routing}}}

no path-preference path1 {path 2 | [pathn] | fallback fallback-path1 | [fallback-path2 | [fallback-pathn] | next-fallback] | {next-fallback-path1 [next-fallback-pathn ] | {blackhole | routing}}}

Syntax Description

path-name

Specifies the path preference name.

Note

 

You can specify up to five primary paths and four fallback paths.

fallback

Specifies the fallback path(s) preference to used when the primary path(s) are out of policy.

blackhole

Specifies the blackhole fallback action. If the primary path is out of policy, then the packets are dropped.

routing

Specifies the routing fallback action. If the primary path is out of policy, then the routing table is used to forward the traffic.

fallback-path

Specifies the fallback path preferences.

Note

 

You can specify multiple fallback paths.

next-fallback

Specify the next-fallback path preferences.

Command Default

Path preference is not defined.

Command Modes

Domain class configuration mode (config-domain-vrf-mc-class)

Command History

Release Modification

Cisco IOS XE 3.13S

This command was introduced.

Cisco IOS XE Denali 16.3.1

This command was modified. The next-fallback keyword was added.

Usage Guidelines

The path-preference command is configured on the hub-master controller to configure the WAN paths.

Examples

The following example shows how to set up the path preference for an ISP:

Device(config)# domain default
Device(config-domain)# vrf default
Device(config-domain-vrf)# master hub
Device(config-domain-vrf-mc)# class VOICE sequence 10
Device(config-domain-vrf-mc-class)# path-preference MPLS1 MPLS2 fallback ISP3 ISP4

periodic (PfR)

To configure Performance Routing (PfR) to periodically select the best exit link, use the periodic command in PfR master controller configuration mode. To disable periodic exit selection, use the no form of this command.

periodic timer

no periodic

Syntax Description

timer

Sets the length of time, in seconds, for the periodic timer. The range of configurable values is from 90 to 7200.

Command Default

Periodic exit selection is disabled.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

Usage Guidelines

The periodic command is entered on a master controller. This command is used to configure the master controller to evaluate and then make policy decisions for PfR managed exit links. When the periodic timer expires, the master controller evaluates current exit links based on default or user-defined policies. If all exit links are in-policy, no changes are made. If an exit link is out-of-policy, the affected prefixes are moved to an in-policy exit link. If all exit links are out-of-policy, the master controller will move out-of-policy prefixes to the best available exit links.

The master controller can be configured to select the first in-policy exit when the periodic timer expires, by configuring the mode select-exit command with the good keyword. The master controller can also be configured to select the best available in-policy exit, by configuring the mode select-exit command with the best keyword.

The periodic timer is reset to the default or configured value each time the timer expires. Configuring a new timer value will immediately replace the existing value if the new value is less than the time remaining. If the new value is greater than the time remaining, the new timer value will be used when the existing timer value expires.

Examples

The following example sets the periodic timer to 300 seconds. When the periodic timer expires, PfR will select either the best exit or the first in-policy exit.


Router(config)# pfr master
Router(config-pfr-mc)# periodic 300
 

periodic-interval (PfR)

To set the time interval between prefix learning periods, use the periodic-interval command in PfR Top Talker and Top Delay learning configuration mode. To set the time interval between prefix learning periods to the default value, use the no form of this command.

periodic-interval minutes

no periodic-interval

Syntax Description

minutes

The time interval between prefix learning periods, in minutes. The range is from 0 to 10080. With CSCtr26978, the default time interval changed from 120 to 0.

Command Default

With CSCtr26978, the default time interval that Performance Routing (PfR) uses changed from 120 to 0 minutes if this command is not configured or if the no form of this command is entered.

Command Modes

PfR Top Talker and Top Delay learning configuration (config-pfr-mc-learn)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3S.

15.2(3)T

This command was modified. With CSCtr26978, the default time interval value changed.

15.2(2)S

This command was modified. With CSCtr26978, the default time interval value changed.

Cisco IOS XE Release 3.6

This command was modified. With CSCtr26978, the default time interval value changed.

Usage Guidelines

The periodic-interval command is configured on a master controller. This command is used to adjust the length of time between traffic flow monitoring periods. The length of time of the learning period is configured with the monitor-period (PfR) command. The number of prefixes that are monitored is configured with the prefixes (PfR) command.

Examples

The following example shows the commands used to set the length of time between PfR monitoring periods to 20 minutes on a master controller:


Router(config)# pfr master
Router(config-pfr-mc)# learn
Router(config-pfr-mc-learn)# periodic-interval 20
 

pfr

To enable a Cisco IOS Performance Routing (PfR) process and configure a router as a PfR border router or as a PfR master controller, use the pfr command in global configuration mode. To disable a border router or master controller process and delete the PfR configuration from the running configuration file, use the no form of this command.

pfr {border | master}

no pfr {border | master}

Cisco IOS XE Releases 3.1S and 3.2S

pfr border

no pfr border

Syntax Description

border

Designates a router as a border router and enters PfR border router configuration mode.

master

Designates a router as a master controller and enters PfR master controller configuration mode.

Command Default

PfR is not enabled.

Command Modes

Global configuration (config)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.1S

This command was integrated into Cisco IOS XE, Release 3.1S.

Cisco IOS XE Release 3.3S

This command was modified. On the Cisco ASR 1000 Series, support for master controller was implemented.

Usage Guidelines

The pfr command is entered on a router to create a border router or master controller process to enable Cisco IOS PfR, which allows you to enable automatic outbound route control and load distribution for multihomed and enterprise networks. Configuring PfR allows you to monitor IP traffic flows and then define policies and rules based on link performance and link load distribution to alter routing and improve network performance.

Performance Routing comprises two components: the master controller (MC) and the border router (BR). A PfR deployment requires one MC and one or more BRs. Communication between the MC and the BR is protected by key-chain authentication. Depending on your Performance Routing deployment scenario and scaling requirements, the MC may be deployed on a dedicated router or may be deployed along with the BR on the same physical router.

Master Controller—The MC is a single router that acts as the central processor and database for the Performance Routing system. The MC component does not reside in the forwarding plane and, when deployed in a standalone fashion, has no view of routing information contained within the BR. The master controller maintains communication and authenticates the sessions with the BRs. The role of the MC is to gather information from the BR or BRs to determine whether traffic classes are in or out of policy and to instruct the BRs how to ensure that traffic classes remain in policy using route injection or dynamic PBR injection.

Border Router—The BR component resides within the data plane of the edge router with one or more exit links to an ISP or other participating network. The BR uses NetFlow to passively gather throughput and TCP performance information. The BR also sources all IP service-level agreement (SLA) probes used for explicit application performance monitoring. The BR is where all policy decisions and changes to routing in the network are enforced. The BR participates in prefix monitoring and route optimization by reporting prefix and exit link measurements to the master controller and then by enforcing policy changes received from the master controller. The BR enforces policy changes by injecting a preferred route to alter routing in the network.

Disabling a Border Router or a Master Controller

To disable a master controller or border router and completely remove the process configuration from the running configuration file, use the no form of this command in global configuration mode.

To temporarily disable a master controller or border router process, use the shutdown (PfR) command in PfR master controller or PfR border router configuration mode. Entering the shutdown (PfR) command stops an active master controller or border router process but does not remove any configuration parameters. The shutdown (PfR) command is displayed in the running configuration file when enabled.

Cisco IOS XE Releases 3.1S and 3.2S

In Cisco IOS XE Releases 3.1S and 3.2S, only the border keyword is supported.


Note


In Cisco IOS XE Release 3.3S, support for master controller was introduced.


Examples

The following example designates a router as a master controller and enters PfR master controller configuration mode:


Router(config)# pfr master
Router(config-pfr-mc)#

The following is an example of the minimum required configuration on a master controller to create a PfR-managed network:

A key-chain configuration named PFR_KEY is defined in global configuration mode.


Router(config)# key chain PFR_KEY
Router(config-keychain)# key 1 
Router(config-keychain-key)# key-string CISCO 
Router(config-keychain-key)# exit
Router(config-keychain)# exit

The master controller is configured to communicate with the 10.4.9.6 border router in PfR master controller configuration mode. The key chain PFR_KEY is applied to protect communication. Internal and external PfR-controlled border router interfaces are defined.


Router(config)# pfr master 
Router(config-pfr-mc)# border 10.4.9.6 key-chain PFR_KEY 
Router(config-pfr-mc-br)# interface FastEthernet0/0 external 
Router(config-pfr-mc-br)# interface FastEthernet0/1 internal 
Router(config-pfr-mc-br)# exit 

Examples

The following example designates a router as a border router and enters PfR border router configuration mode:


Router(config)# pfr border 
Router(config-pfr-br)#

The following is an example of the minimum required configuration to configure a border router in a PfR-managed network:

The key-chain configuration is defined in global configuration mode.


Router(config)# key chain PFR_KEY 
Router(config-keychain)# key 1 
Router(config-keychain-key)# key-string CISCO 
Router(config-keychain-key)# exit
 
Router(config-keychain)# exit

The key chain PFR_KEY is applied to protect communication. An interface is identified as the local source interface to the master controller.


Router(config)# pfr border 
Router(config-pfr-br)# local FastEthernet0/0 
Router(config-pfr-br)# master 10.4.9.4 key-chain PFR_KEY 
Router(config-pfr-br)# end

pfr-map

To enter PfR map configuration mode to configure a Performance Routing (PfR) map to apply policies to selected IP prefixes, use the pfr-map command in global configuration mode. To delete the PfR map, use the no form of this command.

pfr-map map-name [sequence-number]

no pfr-map map-name

Syntax Description

map-name

Name or tag for the PfR map.

sequence-number

(Optional) Sequence number for the PfR map entry. The configurable range for this argument is from 1 to 65535.

Command Default

No PfR maps are created.

Command Modes

Global configuration (config)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3.

Usage Guidelines

The pfr-map command is configured on a master controller. The operation of a PfR map is similar to the operation of a route map. A PfR map is designed to select IP prefixes or to select PfR learn policies using a match clause and then to apply PfR policy configurations using a set clause. The PfR map is configured with a sequence number like a route map, and the PfR map with the lowest sequence number is evaluated first. The operation of a PfR map differs from a route map at this point. There are two important distinctions:

  • Only a single match clause may be configured for each sequence. An error message will be displayed on the console if you attempt to configure multiple match clauses for a single PfR map sequence.

  • A PfR map is not configured with permit or deny statements. However, a permit or deny sequence can be configured for an IP traffic flow by configuring a permit or deny statement in an IP prefix list and then applying the prefix list to the PfR map with the match ip address (PfR) command.


Tip


Deny prefixes should be combined in a single prefix list and applied to the PfR map with the lowest sequence number.


A PfR map can match a prefix or prefix range with the match ip address (PfR) command. A prefix can be any IP network number combined with a prefix mask that specifies the prefix length. The prefix or prefix range is defined with the ip prefix-list command in global configuration mode. Any prefix length can be specified. A PfR map can also match PfR learned prefixes with the match pfr learn command. Matching can be configured for prefixes learned based on delay or based on throughput.

The PfR map applies the configuration of the set clause after a successful match occurs. A PfR set clause can be used to set policy parameters for the backoff timer, packet delay, holddown timer, packet loss, mode settings, periodic timer, resolve settings, and unreachable hosts.

Policies that are applied by a PfR map do not override global policies configured under PfR master controller configuration mode and PfR Top Talker and Delay learning configuration mode. Policies are overridden on a per-prefix-list basis. If a policy type is not explicitly configured in a PfR map, the default or configured values will apply. Policies applied by a PfR map take effect after the current policy or operational timer expires. The PfR map configuration can be viewed in the output of the show running-config command. PfR policy configuration can be viewed in the output of the show pfr master policy command.

Examples

The following example creates a PfR map named SELECT_EXIT that matches traffic defined in the IP prefix list named CUSTOMER and sets exit selection to the first in-policy exit when the periodic timer expires. This PfR map also sets a resolve policy that sets the priority of link utilization policies to 1 (highest priority) and allows for a 10-percent variance in exit link utilization statistics.


Router(config)# ip prefix-list CUSTOMER permit 10.4.9.0/24
Router(config)# pfr-map SELECT_EXIT 10
Router(config-pfr-map)# match ip address prefix-list CUSTOMER 
Router(config-pfr-map)# set mode select-exit good
Router(config-pfr-map)# set resolve utilization priority 1 variance 10 

The following example creates a PfR map named THROUGHPUT that matches traffic learned based on the highest outbound throughput. The set clause applies a relative loss policy that will permit 10-percent packet loss:


Router(config)# pfr-map THROUGHPUT 20
Router(config-pfr-map)# match pfr learn throughput
Router(config-pfr-map)# set loss relative 10 

platform nft-summarization enable

To enable the collection of the packets punted to the CPU, use the platform nft_summarization enable command in the configuration mode. To disable the collection of NFT data, use the no form of this command.

platform nft_summarization enable


Note


As the scale of the network devices increases, utilization of the CPU and memory increases. Control plane sessions also increase the CPU and memory utilization. To mitigate this, we recommend that you enable NFT summarization for debugging sessions only.

Command Default

By default, the platform-nft-summarization command is disabled to avoid high CPU utilization.

Command Modes

To enable the collection of the packets punted to the CPU, use the platform-nft-summarization enable command in the global configuration mode.

Command History

Release

Modification

Cisco IOS XE Release 17.15.1

This command was introduced in Cisco IOS XE ASR 900 and ASR 920 platforms. It is supported in the RSP2 and RSP3 Interface Modules.

Usage Guidelines

The platform nft_summarization command is used to enable the collection of the packets punted to the CPU by using the NFT hash table. Data is collected until the user disables the command.

Examples

The following example shows how to enable NFT summarization:


Router(config)# platform nft_summarization enable
Router(config)# end

platform nft-summarization timer-value

To enable the timer to clean up the NFT data, use the platform nft_summarization timer-value command in the configuration mode. To disable the timer, use the no form of this command.

platform nft_summarization timer-value number

Syntax Description

timer-value number

(Optional) Specifies the time interval (in seconds) that the router waits for cleaning the NFT data as per the timestamps, which are collected for each entry in the hash table. Enter a value in the range from 30 to 60. The default value is 30.

Command Default

The timer-value to clean up the NFT data can be specified only if the platform nft-summarization enable command is enabled.

Command Modes

Command History

Release

Modification

Cisco IOS XE Release 17.15.1

This command was introduced in Cisco IOS XE ASR 900 and ASR 920 platforms. It is supported in the RSP2 and RSP3 Interface Modules.

Usage Guidelines

You can use the platform nft_summarization timer-value command to enable the optional timer value to clean up the NFT data as per the timestamps, which are collected for each entry in the hash table. Some of these entries in the hash table are source MAC address, destination MAC address, Ethertype, and Prototype. Whenever an entry is added to the hash table, the corresponding timestamp will be added. After the configured timer expires, the hash table clean-up will be triggered to remove the entries that have older timestamps greater than the configured seconds.

Examples

The following example shows how to enable the optional timer to clean up the NFT hash table:


Router(config)#platform nft_summarization timer-value 30
Router(config)#end

policy-rules (PfR)

To apply a configuration from a Performance Routing (PfR) map to a master controller configuration, use the policy-rules command in PfR master controller configuration mode. To remove a configuration applied by the policy-rules command, use the no form of this command.

policy-rules map-name

no policy-rules

Syntax Description

map-name

Name of the PfR map.

Command Default

No configuration from a PfR map is applied to a master controller.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3.

Usage Guidelines

The policy-rules command allows you to select a PfR map and apply the configuration under PfR master controller configuration mode, providing an improved method to switch between predefined PfR maps.

The policy-rules command is entered on a master controller. This command is used to apply the configuration from a PfR map to a master controller configuration in PfR master controller configuration mode.

Reentering this command with a new PfR map name will immediately overwrite the previous configuration. This behavior is designed to allow you to quickly select and switch between predefined PfR maps.

Examples

The following example, starting in global configuration mode, shows how to configure the policy-rules command to apply the PfR map named BLUE under PfR master controller configuration mode:


Router(config)# pfr-map BLUE 10 
Router(config-pfr-map)# match pfr learn delay
Router(config-pfr-map)# set loss relative 900
Router(config-pfr-map)# exit
Router(config)# pfr master 
Router(config-pfr-mc)# policy-rules BLUE 
Router(config-pfr-mc)# end

port (PfR)

To optionally configure a dynamic port number for communication between a Performance Routing (PfR) master controller and border router, use the port command in PfR master controller or PfR border router configuration mode. To close the port and disable communication, use the no form of this command.

port [port-number]

no port

Syntax Description

port-number

(Optional) Specifies the port number. The configurable range for this argument is a number from 1 to 65535.

Command Default

Port 3949 is used for PfR communication unless a dynamic port number is configured on both the master controller and the border router. Port configuration is not shown in the running configuration file when port 3949 is used.

Command Modes

PfR border router configuration (config-pfr-br) PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.1(1)S

This command was integrated into Cisco IOS Release 15.1(1)S.

Cisco IOS XE Release 3.1S

This command was integrated into Cisco IOS XE Release 3.1S.

Usage Guidelines

Communication between a master controller and a border router is automatically carried over port 3949 when connectivity is established. Port 3949 is registered with IANA for PfR communication. Manual port number configuration is required only if you are running Cisco IOS Release 12.3(8)T or if you need to configure PfR communication to use a dynamic port number.

The port command is entered on a master controller or a border router. This command is used to specify a dynamic port number to be used for border router and master controller communication. The same port number must be configured on both the master controller and border router. Closing the port by entering the no form of this command disables communication between the master controller and the border router.

Cisco IOS XE Releases 3.1S and 3.2S

This command is supported only in PfR border router configuration mode.


Note


In Cisco IOS XE Release 3.3S, master controller support was introduced.


Examples

The following example opens port 49152 for master controller communication with a border router:


Router(config)# pfr master
Router(config-pfr-mc)# port 49152

The following example opens port 49152 for border router communication with a master controller:


Router(config)# pfr border
Router(config-pfr-br)# port 49152 

The following example closes the default or user-defined port and disables communication between a master controller and border router:


Router(config)# pfr master
Router(config-pfr-mc)# no port
 

prefixes (PfR)

To set the number of prefixes that Performance Routing (PfR) will learn during a monitoring period, use the prefixes command in PfR Top Talker and Top Delay learning configuration mode. To return the number of prefixes to the default value, use the no form of this command.

prefixes number

no prefixes

Syntax Description

number

Number of prefixes that a master controller will learn during a monitoring period. The range is from 1 to 2500.

Command Default

PfR uses 100 prefixes by default if this command is not configured or if the no form of this command is entered.

Command Modes

PfR Top Talker and Top Delay learning configuration (config-pfr-mc-learn)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3.

Usage Guidelines

The prefixes command is configured on a master controller. This command is used to set the number of prefixes that a master controller will learn during a monitoring period. The length of time of the learning period is configured with the monitor-period (PfR) command. The length of time between monitoring periods is configured with the periodic-interval (PfR) command.

Examples

The following example configures a master controller to learn 200 prefixes during a monitoring period:


Router(config)# pfr master
Router(config-pfr-mc)# learn
Router(config-pfr-mc-learn)# prefixes 200

priority

To specify thresholds for user-defined policy, use the priority command in master controller class type configuration mode. To remove the specifications, use the no form of this command.

priority number {jitter | loss | one-way-delay}threshold threshold-value

no priority number {jitter | loss | one-way-delay}threshold threshold-value

Syntax Description

number

Specifies the priority number. The range is from 1 to 65535, 1 being the highest priority.

jitter

Specifies the jitter threshold value.

loss

Specifies the loss threshold value.

one-way-delay

Specifies the one-way-delay threshold value.

Command Default

Threshold values for the user-defined policy is not specified.

Command Modes

Master controller class type mode (config-domain-vrf-mc-class-type)

Command History

Release Modification

Cisco IOS XE 3.13S

This command was introduced.

Usage Guidelines

The priority command is entered in the hub master controller to specify the threshold for user-defined policies. You can specify the jitter, loss rate, and one-way-delay.

Examples

The following example shows how to specify threshold values:

Device(config-domain-vrf-mc-class-type)# priority 1 loss threshold 10

probe (PfR)

To set the number of packets for a Performance Routing (PfR) active probe, use the probe command in PfR master controller configuration mode. To reset the number of packets of a PfR active probe to its default value, use the no form of this command.

probe packets packet-count

no probepackets packet-count

Syntax Description

packets

Specifies the number of probe packets for an active probe.

packet-count

Number of probe packets in the range from 2 to 255. The default is 100.

Command Default

The default number of packets per probe is 100.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.2(1)T

This command was introduced.

15.2(1)S

This command was integrated into Cisco IOS Release 15.2(1)S.

Cisco IOS XE Release 3.5

This command was integrated into Cisco IOS XE Release 3.5.

Usage Guidelines

The probe (PfR) command is entered on a master controller in PfR maaster controller configuration mode. This command is used within a PfR map configuration to set the frequency of the active probes.

Using the packets keyword and the packet-count argument, the number of probe packets per active probe can be set. The new keyword is supported only at a global level and not under PfR map configuration mode. The configuration affects global probes and forced probes for all traffic classes.

Examples

The following example shows how to set the number of probe packets for a PfR probe at 33:


Router(config)# pfr master
Router(config-pfr-mc)# probe packets 33 

resolve (PfR)

To set the priority of a policy when multiple overlapping policies are configured, use the resolve command in PfR master controller configuration mode. To disable the policy priority configuration and to restore default policy priority settings, use the no form of this command.

resolve { {cost | range} priority value | {delay | jitter | loss | mos | utilization} priority value variance percentage | equivalent-path-round-robin}

no resolve {cost | delay | equivalent-path-round-robin | jitter | loss | mos | range | utilization}

Syntax Description

cost

Specifies policy priority settings for cost optimization.

range

Specifies policy priority settings for the range. With CSCtr33991, the range keyword was removed.

priority

Sets the priority of the policy. With CSCtr33991, the priority keyword was disabled for the cost keyword.

value

A number in the range from 1 to 10. The number 1 has the highest priority, and the number 10 has the lowest priority. With CSCtr33991, the value argument was disabled for the cost keyword.

delay

Specifies policy priority settings for packet delay.

jitter

Specifies policy priority settings for jitter.

loss

Specifies policy priority settings for packet loss.

mos

Specifies policy priority settings for the Mean Opinion Score (MOS).

utilization

Specifies policy priority settings for exit link utilization. With CSCtr33991, the utilization keyword was removed.

variance

Sets the allowable variance for the policy, as a percentage.

percentage

A number in the range from 1 to 100.

equivalent-path-round-robin

Specifies the use of the equivalent-path round-robin resolver.

Command Default

Performance Routing (PfR) uses the following default settings if this command is not configured or if the no form of this command is entered:

  • An unreachable prefix: highest priority

  • delay priority : 11

  • utilization priority : 12

  • The equivalent-path round-robin resolver is not used.

With CSCtr33991, all default resolver values were removed from the default global policy and PfR automatically performs load-balancing.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.1(2)T

This command was introduced.

15.0(1)S

This command was integrated into Cisco IOS Release 15.0(1)S.

Cisco IOS XE Release 3.3

This command was integrated into Cisco IOS XE Release 3.3S.

Cisco IOS XE 3.4S

This command was modified. The equivalent-path-round-robin keyword was added.

15.2(1)T

This command was modified. The equivalent-path-round-robin keyword was added.

15.2(3)T

This command was modified. With CSCtr33991, the range and utilization keywords were removed and the priority keyword and value argument were disabled for the cost keyword.

Usage Guidelines

The resolve command is entered on a master controller. This command is used to set priority when multiple policies are configured for the same prefix. When this command is configured, the policy with the highest priority will be selected to determine the policy decision.

The priority keyword is used to specify the priority value. The number 1 assigns the highest priority to a policy. The number 10 sets the lowest priority. Each policy must be assigned a different priority number. If you try to assign the same priority number to two different policy types, an error message will be displayed on the console. By default, delay has a priority value of 11 and utilization has a priority value of 12. These values can be overridden by specifying a value from 1 to 10.


Note


An unreachable prefix will always have the highest priority regardless of any other settings. This behavior is designed and cannot be overridden because an unreachable prefix indicates an interruption in a traffic flow.


The variance keyword is used to set an allowable variance for a user-defined policy. This keyword configures the allowable percentage by which an exit link or prefix can vary from the user-defined policy value and still be considered equivalent. For example, if an exit link delay is set to a delay value of 80 percent and a 10 percent variance is configured, exit links that have delay values from 80 to 89 percent will be considered equal.


Note


Variance cannot be configured for cost or range policies.



Note


You must configure a PfR active jitter probe for a target prefix using the active-probe (PfR) command in order for the resolve jitter , resolve loss , and resolve mos commands to function.


The equivalent-path-round-robin keyword is used to specify that the equivalent-path round-robin resolver is used to choose between equivalent paths instead of the random resolver. The no resolve equivalent-path-round-robin form of this command resets the software to use of the random resolver.


Note


Effective with CSCtr33991, the range and utilization keywords were removed to simplify PfR. All default resolver values were removed from the default global policy and PfR automatically performs load-balancing. The cost resolver cannot be configured with a performance resolver. The priority keyword and value argument were disabled for the cost resolver.


Examples

The following example shows how to set the delay policy priority to 1 and the allowable variance percentage to 20 percent:


Router(config)# pfr master
Router(config-pfr-mc)# resolve delay priority 1 variance 20 

The following example shows how to set the loss policy priority to 2 and the allowable variance percentage to 30 percent:


Router(config)# pfr master
Router(config-pfr-mc)# resolve loss priority 2 variance 30

The following example shows how to set the jitter policy priority to 3 and the allowable variance percentage to 5 percent:


Router(config)# pfr master
Router(config-pfr-mc)# resolve jitter priority 3 variance 5

The following example shows how to set the MOS policy priority to 4 and the allowable variance percentage to 25 percent:


Router(config)# pfr master
Router(config-pfr-mc)# resolve mos priority 4 variance 25

The following example shows how to set the range policy priority to 5:


Router(config)# pfr master
Router(config-pfr-mc)# resolve range priority 5 

The following example shows how to set the link utilization policy priority to 6 and the allowable variance percentage to 10 percent:


Router(config)# pfr master
Router(config-pfr-mc)# resolve utilization priority 6 variance 10

The following example shows how to configure the use of the equivalent-path round-robin resolver to choose between equivalent paths:


Router(config)# pfr master
Router(config-pfr-mc)# resolve equivalent-path-round-robin

rsvp (PfR)

To configure Performance Routing (PfR) to learn traffic classes based on Resource Reservation Protocol (RSVP) flows, use the rsvp command in PfR learn list configuration mode. To disable learning traffic classes based on RSVP flows, use the no form of this command.

rsvp

no rsvp

Syntax Description

This command has no arguments or keywords.

Command Default

No prefixes are learned based on RSVP flows.

Command Modes

Learn list configuration (config-pfr-mc-learn-list)

Command History

Release

Modification

15.2(1)T

This command was introduced.

Cisco IOS XE Release 3.4S

This command was integrated into Cisco IOS XE Release 3.4S.

Usage Guidelines

The rsvp command is entered on a master controller and is used to allow PfR to learn RSVP flows using a learn list. PfR uses application-aware path selection to determine the best path for RSVP traffic flows.

Examples

The following example shows how to configure a master controller to learn prefixes based on RSVP flows for a learn list named LEARN_RSVP_TC:


Router(config)# pfr master 
Router(config-pfr-mc)# learn 
Router(config-pfr-mc-learn)# list seq 10 refname LEARN_RSVP_TC
Router(config-pfr-mc-learn-list)# rsvp

rsvp post-dial-delay

To configure the Resource Reservation Protocol (RSVP) post dial delay timer to set the delay before Performance Routing (PfR) returns the routing path to RSVP, use the rsvp post-dial-delay command in PfR master controller configuration mode. To reset the post dial delay timer to its default value, use the no form of this command.

rsvp post-dial-delay msecs

no rsvp post-dial-delay

Syntax Description

msecs

Post dial delay timer value, in milliseconds. Range is from 0 to 500. Default is 0.

Command Default

The default post dial delay timer value is 0.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.2(1)T

This command was introduced.

Cisco IOS XE Release 3.4S

This command was integrated into Cisco IOS XE Release 3.4S.

Usage Guidelines

The rsvp post-dial-delay command is used to set a value for the RSVP post dial delay timer that runs on the border routers. The timer is updated on the border routers at the start of every PfR learn cycle, and the timer determines the delay, in milliseconds, before the routing path is returned to RSVP. When the PfR and RSVP integration is enabled, PfR tries to locate a best path for any RSVP flows that are learned before the delay timer expires.

Examples

The following example shows how to configure PfR to set the RSVP post dial delay to 100 milliseconds:


Router(config)# pfr master
Router(config-pfr-mc)# rsvp post-dial-delay 100

rsvp signaling-retries

To specify the number of alternate paths that Performance Routing (PfR) provides for a Resource Reservation Protocol (RSVP) reservation when a reservation error condition is detected, use the rsvp signaling-retries command in PfR master controller configuration mode. To reset the number of alternate paths to its default value, use the no form of this command.

rsvp signaling-retries number

no rsvp signaling-retries

Syntax Description

number

Number, 0 or 1. Default is 0.

Command Default

The default number of signaling retries is 0.

Command Modes

PfR master controller configuration (config-pfr-mc)

Command History

Release

Modification

15.2(1)T

This command was introduced.

Cisco IOS XE Release 3.4S

This command was integrated into Cisco IOS XE Release 3.4S.

Usage Guidelines

The rsvp signaling-retries command is configured on a master controller and is used to instruct PfR to provide an alternate reservation path when an RSVP reservation returns an error condition. If an alternate path is provided, RSVP can resend the reservation signal. If no signaling retries are to be permitted, set the value to 0.

Examples

The following example shows how to configure PfR to set the number of alternate paths for RSVP signaling retries to 1:


Router(config)# pfr master
Router(config-pfr-mc)# rsvp signaling-retries 1