Cisco IOS IP SLAs Command Reference

Cisco IOS IP SLAs Commands

access-list (epl-disc)

To add a list of discovered endpoints to an auto IP Service Level Agreements (SLAs) endpoint list, use the access-list command in IP SLA endpoint-list auto-discovery configuration mode. To remove the list, use the no form of this command.

access-list {standard-list-number | expanded-list-number}

no access-list

Syntax Description

Command Default

No access list is specified in the auto IP SLAs endpoint list being configured.

Command Modes

IP SLA endpoint-list auto-discovery configuration (config-epl-disc)

Command History

Usage Guidelines

This command assigns a name to a list of discovered IP addresses of IP SLAs destination devices and Cisco IOS IP SLAs Responder endpoints and adds the list to the auto IP SLAs endpoint list being configured.

Before you use this command, you must use the discover command in IP SLA endpoint-list configuration mode to build the list of endpoints on target Cisco devices.

To apply an endpoint list to an IP SLAs auto-measure group, use the destination command in IP SLA auto-measure group configuration mode.

Examples

The following example shows how to configure an endpoint list using the auto discovery method:

Router(config)# ip sla auto discovery

Router(config)# ip sla auto endpoint-list type ip autolist

Router(config-epl)# discover port 5000

Router(config-epl-disc)# access-list 3

Router(config-epl-disc)# end

Router# show ip sla auto endpoint-list

Endpoint-list Name: autolist

    Description: 

    Auto Discover Parameters

        Destination Port: 5000

        Access-list: 3

        Ageout: 3600    Measurement-retry: 3

    5 endpoints are discovered for autolist

Related Commands

access-list (IP SLA)

To specify the access list to apply to a Cisco IOS IP Service Level Agreements (SLAs) label switched path (LSP) Health Monitor operation, use the access-list command in auto IP SLA MPLS parameters configuration mode. To remove the access list, use the no form of this command.

access-list access-list-number

no access-list access-list-number

Syntax Description

Command Default

No access list is specified.

Command Modes

Auto IP SLA MPLS parameters configuration (config-auto-ip-sla-mpls-params)

Command History

Usage Guidelines

Standard IP access lists can be configured (using the access-list [IP standard] command in global configuration mode) to restrict the number of IP SLAs operations that are automatically created by the IP SLAs LSP Health Monitor. When the IP SLAs access list parameter is configured, the list of Border Gateway Protocol (BGP) next hop neighbors discovered by the LSP Health Monitor is filtered based on the conditions defined by the associated standard IP access list. In other words, the LSP Health Monitor will automatically create IP SLAs operations only for those BGP next hop neighbors with source addresses that satisfy the criteria permitted by the standard IP access list.

Examples

The following example shows how to configure operation parameters, proactive threshold monitoring, and scheduling options using the LSP Health Monitor. In this example, LSP Health Monitor operation 1 is configured to automatically create IP SLAs LSP ping operations for all BGP next hop neighbors in use by all VPN routing and forwarding (VRF) instances associated with the source Provider Edge (PE) router. Standard IP access list 10 is specified to restrict the number of IP SLAs operations to be created by LSP Health Monitor operation 1.

!Configure standard IP access list in global configuration mode

access-list 10 permit 10.10.10.8

!

mpls discovery vpn interval 60

mpls discovery vpn next-hop

!

auto ip sla mpls-lsp-monitor 1

 type echo ipsla-vrf-all

 timeout 1000

 scan-interval 1

 secondary-frequency connection-loss 10

 secondary-frequency timeout 10

 access-list 10

!

auto ip sla mpls-lsp-monitor reaction-configuration 1 react connectionLoss threshold-type 
consecutive 3 action-type trapOnly

auto ip sla mpls-lsp-monitor reaction-configuration 1 react timeout threshold-type 
consecutive 3 action-type trapOnly

ip sla logging traps

!

auto ip sla mpls-lsp-monitor schedule 1 schedule-period 60 start-time now

Related Commands

ageout

To add an ageout timer to an auto IP Service Level Agreements (SLAs) scheduler or endpoint list, use the ageout command in IP SLA auto-measure schedule configuration or IP SLA endpoint-list auto-discovery configuration mode. To remove the timer, use the no form of this command.

ageout seconds

no ageout

Syntax Description

Command Default

The entry is never saved in memory.

Command Modes

IP SLA auto-measure schedule configuration (config-am-schedule)
IP SLA endpoint-list auto-discovery configuration (config-epl-disc)

Command History

Usage Guidelines

This command changes the length of time an entry is kept in memory when either the operation or destination is inactive from the default (0) to the specified number, after which the entry is deleted from memory.

An operation can age out before it executes. To ensure that this does not happen, the difference between the time that the IP SLA auto-measure group is configured and the time at which the operation becomes active must be less than the value of the ageout timer.

Note The total RAM required to hold the history and statistics tables is allocated when the auto IP SLAs operation is scheduled. This prevents router memory problems when the router gets heavily loaded and lowers the amount of overhead an auto IP SLAs operation causes on a router when it is active.

Examples

The following example shows how to configure an auto IP SLAs scheduler that will cause an auto IP SLAs operation to actively collect data at 3:00 p.m. on April 5. The operation will age out after 12 hours of inactivity, which can be before it starts or after it has finished its life. When the operation ages out, all configuration information for the operation is removed from the running configuration in RAM.

Router(config)# ip sla auto schedule apr5

Router(config-am-schedule)# ageout 43200

Router(config-am-schedule)# frequency 70

Router(config-am-schedule)# life 43200

Router(config-am-schedule)# probe-interval 1500

Router(config-am-schedule)# start-time 15:00 apr 5

Router(config-am-schedule)# end

Router#

Router# show ip sla auto schedule apr5

Group sched-id: apr5

    Probe Interval (ms) : 1500

    Group operation frequency (sec): 70

    Status of entry (SNMP RowStatus): Active

    Next Scheduled Start Time: P15:00 apr 5

    Life (sec): 43200

    Entry Ageout (sec): 43200

Router#

Related CommandsICMP echo

auto ip sla mpls-lsp-monitor

To begin configuration for an IP Service Level Agreements (SLAs) label switched path (LSP) Health Monitor operation and enter auto IP SLA MPLS configuration mode, use the auto ip sla mpls-lsp-monitor command in global configuration mode. To remove all configuration information for an LSP Health Monitor operation, use the no form of this command.

auto ip sla mpls-lsp-monitor operation-number

no auto ip sla mpls-lsp-monitor operation-number

Syntax Description

Command Default

No LSP Health Monitor operation is configured.

Command Modes

Global configuration

Command History

Usage Guidelines

Entering this command automatically enables the mpls discovery vpn next-hop command.

After you configure an LSP Health Monitor operation, you must schedule the operation. To schedule an LSP Health Monitor operation, use the auto ip sla mpls-lsp-monitor schedule command in global configuration mode. You can also optionally set reaction configuration for the operation (see the auto ip sla mpls-lsp-monitor reaction-configuration command).

To display the current configuration settings of an LSP Health Monitor operation, use the show ip sla mpls-lsp-monitor configuration command in EXEC mode.

Examples

The following example shows how to configure operation parameters, proactive threshold monitoring, and scheduling options using the LSP Health Monitor. In this example, LSP Health Monitor operation 1 is configured to automatically create IP SLAs LSP ping operations for all Border Gateway Protocol (BGP) next hop neighbors in use by all VPN routing and forwarding (VRF) instances associated with the source Provider Edge (PE) router.

mpls discovery vpn interval 60

mpls discovery vpn next-hop

!

auto ip sla mpls-lsp-monitor 1

 type echo ipsla-vrf-all

 timeout 1000

 scan-interval 1

 secondary-frequency connection-loss 10

 secondary-frequency timeout 10

!

auto ip sla mpls-lsp-monitor reaction-configuration 1 react connectionLoss threshold-type 
consecutive 3 action-type trapOnly

auto ip sla mpls-lsp-monitor reaction-configuration 1 react timeout threshold-type 
consecutive 3 action-type trapOnly

ip sla logging traps

!

auto ip sla mpls-lsp-monitor schedule 1 schedule-period 60 start-time now

Related Commands

auto ip sla mpls-lsp-monitor reaction-configuration

To configure proactive threshold monitoring parameters for a Cisco IOS IP Service Level Agreements (SLAs) label switched path (LSP) Health Monitor operation, use the auto ip sla mpls-lsp-monitor reaction-configuration command in global configuration mode. To clear all threshold monitoring configuration for a specified LSP Health Monitor operation, use the no form of this command.

LSP Health Monitor Without LSP Discovery

auto ip sla mpls-lsp-monitor reaction-configuration operation-number react {connectionLoss | timeout} [action-type option] [threshold-type {consecutive [occurrences] | immediate | never}]

no auto ip sla mpls-lsp-monitor reaction-configuration operation-number

LSP Health Monitor with LSP Discovery

auto ip sla mpls-lsp-monitor reaction-configuration operation-number react lpd {lpd-group [retry number] | tree-trace} [action-type trapOnly]

no auto ip sla mpls-lsp-monitor reaction-configuration operation-number

Syntax Description

Command Default

IP SLAs proactive threshold monitoring is disabled.

Command Modes

Global configuration

Command History

Usage Guidelines

You can configure the auto ip sla mpls-lsp-monitor reaction-configuration command multiple times to enable proactive threshold monitoring for multiple elements for the same operation. However, disabling of individual monitored elements is not supported. In other words, the no auto ip sla mpls-lsp-monitor reaction-configuration command will disable all proactive threshold monitoring configuration for the specified IP SLAs operation.

SNMP traps for IP SLAs are supported by the CISCO-RTTMON-MIB and CISCO-SYSLOG-MIB. Depending on the Cisco IOS software release that you are running, use the ip sla logging traps or ip sla monitor logging traps command to enable the generation of SNMP system logging messages specific to IP SLAs trap notifications. Use the snmp-server enable traps rtr command to enable the sending of IP SLAs SNMP trap notifications.

To display the current threshold monitoring configuration settings for an LSP Health Monitor operation, use the show ip sla mpls-lsp-monitor configuration command.

Examples

The following example shows how to configure operation parameters, proactive threshold monitoring, and scheduling options using the LSP Health Monitor. In this example, LSP Health Monitor operation 1 is configured to automatically create IP SLAs LSP ping operations for all Border Gateway Protocol (BGP) next hop neighbors in use by all VPN routing and forwarding (VRF) instances associated with the source Provider Edge (PE) router. As specified by the proactive threshold monitoring configuration, when three consecutive connection loss or timeout events occur, an SNMP trap notification is sent.

mpls discovery vpn interval 60

mpls discovery vpn next-hop

!

auto ip sla mpls-lsp-monitor 1

 type echo ipsla-vrf-all

 timeout 1000

 scan-interval 1

 secondary-frequency connection-loss 10

 secondary-frequency timeout 10

!

auto ip sla mpls-lsp-monitor reaction-configuration 1 react connectionLoss threshold-type 
consecutive 3 action-type trapOnly

auto ip sla mpls-lsp-monitor reaction-configuration 1 react timeout threshold-type 
consecutive 3 action-type trapOnly

ip sla logging traps

auto ip sla mpls-lsp-monitor schedule 1 schedule-period 60 start-time now

Related Commands

auto ip sla mpls-lsp-monitor reset

To remove all IP Service Level Agreements (SLAs) label switched path (LSP) Health Monitor configuration from the running configuration, use the auto ip sla mpls-lsp-monitor reset command in global configuration mode.

auto ip sla mpls-lsp-monitor reset [lpd group-number]

Syntax Description

Command Default

None

Command Modes

Global configuration

Command History

Usage Guidelines

Use the auto ip sla mpls-lsp-monitor reset lpd group-number command to remove all the stored network connectivity statistics for the specified LSP discovery group from the LSP discovery group database. The non-statistical LSP discovery group data will be set to default values or zero. However, the IP address of the associated Border Gateway Protocol (BGP) next hop neighbor, the list of LSP discovery group IP SLAs operations, and the list of LSP selector IP addresses will be preserved. After the auto ip sla mpls-lsp-monitor reset lpd group-number command is entered, statistical data for the group will start aggregating again with new data only.

To clear IP SLAs configuration information (not including IP SLAs LSP Health Monitor configuration) from the running configuration, use the ip sla reset command in global configuration mode.

Examples

The following example shows how to remove all the LSP Health Monitor configurations from the running configuration:

auto ip sla mpls-lsp-monitor reset

Related Commands

auto ip sla mpls-lsp-monitor schedule

To configure the scheduling parameters for an IP Service Level Agreements (SLAs) label switched path (LSP) Health Monitor operation, use the auto ip sla mpls-lsp-monitor schedule command in global configuration mode. To stop the operation and place it in the default state (pending), use the no form of this command.

auto ip sla mpls-lsp-monitor schedule operation-number schedule-period seconds [frequency [seconds]] [start-time {after hh:mm:ss | hh:mm[:ss] [month day | day month] | now | pending}]

no auto ip sla mpls-lsp-monitor schedule operation-number

Syntax Description

Command Default

The LSP Health Monitor operation is placed in a pending state (that is, the operation is enabled but is not actively collecting information).

Command Modes

Global configuration

Command History

Usage Guidelines

After you schedule an LSP Health Monitor operation with the auto ip sla mpls-lsp-monitor schedule command, you cannot change the configuration of the operation. To change the configuration of the operation, use the no auto ip sla mpls-lsp-monitor operation-number command in global configuration mode and then enter the new configuration information.

To display the current configuration settings of an LSP Health Monitor operation, use the show ip sla mpls-lsp-monitor configuration command in user EXEC or privileged EXEC mode.

Examples

The following example shows how to configure operation parameters, proactive threshold monitoring, and scheduling options using the LSP Health Monitor. In this example, LSP Health Monitor operation 1 is configured to automatically create IP SLAs LSP ping operations for all Border Gateway Protocol (BGP) next hop neighbors in use by all VPN routing and forwarding (VRF) instances associated with the source Provider Edge (PE) router. The schedule period for LSP Health Monitor operation 1 is set to 60 seconds and the operation is scheduled to start immediately.

mpls discovery vpn interval 60

mpls discovery vpn next-hop

!

auto ip sla mpls-lsp-monitor 1

 type echo ipsla-vrf-all

 timeout 1000

 scan-interval 1

 secondary-frequency connection-loss 10

 secondary-frequency timeout 10

!

auto ip sla mpls-lsp-monitor reaction-configuration 1 react connectionLoss threshold-type 
consecutive 3 action-type trapOnly

auto ip sla mpls-lsp-monitor reaction-configuration 1 react timeout threshold-type 
consecutive 3 action-type trapOnly

ip sla logging traps

!

auto ip sla mpls-lsp-monitor schedule 1 schedule-period 60 start-time now

Related Commands

buckets-of-history-kept

Note Effective with Cisco IOS Release 12.4(4)T, 12.2(33)SRB, 12.2(33)SB, and 12.2(33)SXI, the buckets-of-history-kept command is replaced by the history buckets-kept command. See the history buckets-kept command for more information.

To set the number of history buckets that are kept during the lifetime of a Cisco IOS IP Service Level Agreements (SLAs) operation, use the buckets-of-history-kept command in the appropriate submode of IP SLA monitor configuration mode. To return to the default value, use the no form of this command.

buckets-of-history-kept size

no buckets-of-history-kept

Syntax Description

Defaults

50 buckets

Command Modes

DHCP configuration (config-sla-monitor-dhcp)
DLSw configuration (config-sla-monitor-dlsw)
DNS configuration (config-sla-monitor-dns)
FTP configuration (config-sla-monitor-ftp)
HTTP configuration (config-sla-monitor-http)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
TCP connect configuration (config-sla-monitor-tcp)
UDP echo configuration (config-sla-monitor-udp)
VoIP configuration (config-sla-monitor-voip)

Command History

Usage Guidelines

Each time IP SLAs starts an operation, a new bucket is created until the number of history buckets matches the specified size or the operation's lifetime expires. History buckets do not wrap (that is, the oldest information is not replaced by newer information). The operation's lifetime is defined by the ip sla monitor schedule global configuration command.

Note The buckets-of-history-kept command does not support the IP SLAs User Datagram Protocol (UDP) jitter operation.

An IP SLAs operation can collect history and capture statistics. By default, the history for an IP SLAs operation is not collected. If history is collected, each history bucket contains one or more history entries from the operation. When the operation type is ICMP path echo, an entry is created for each hop along the path that the operation takes to reach its destination. The type of entry stored in the history table is controlled by the filter-for-history command. The total number of entries stored in the history table is controlled by the combination of the samples-of-history-kept, buckets-of-history-kept, and lives-of-history-kept commands.

Note Collecting history increases the RAM usage. Collect history only when you think there is a problem in the network.

Note You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.

Examples

The following example shows how to configure IP SLAs ICMP echo operation 1 to keep 25 history buckets during the operation lifetime.

ip sla monitor 1

 type echo protocol ipIcmpEcho 172.16.161.21

 buckets-of-history-kept 25

 lives-of-history-kept 1

!

ip sla monitor schedule 1 start-time now life forever

Related Commands

clock-tolerance ntp oneway

To set the acceptable Network Time Protocol (NTP) clock synchronization tolerance for a one-way Cisco IOS IP Service Level Agreements (SLAs) operation measurement, use the clock-tolerance ntp oneway command in the UDP jitter submode of IP SLA configuration, IP SLA monitor configuration, or IP SLA template parameters configuration mode. To return to the default value, use the no form of this command.

clock-tolerance ntp oneway {absolute value | percent value}

no clock-tolerance ntp oneway

Syntax Description

Command Default

The NTP clock synchronization tolerance is set to 0 percent.

Command Modes

IP SLA Configuration

UDP jitter configuration (config-ip-sla-jitter)

IP SLA Monitor Configuration

UDP jitter configuration (config-sla-monitor-jitter)

IP SLA Template Parameters Configuration

UDP jitter configuration (config-udp-jtr-params)

Note The configuration mode varies depending on the Cisco IOS release you are running and the operation type configured. See the "Usage Guidelines" section for more information.

Command History

Usage Guidelines

The precision microseconds command must be configured before the clock-tolerance ntp oneway command is used.

Note This command is supported by the IP SLAs User Datagram Protocol (UDP) jitter operation only.

If the NTP running state is true and the total offset (sum of the offset for the sender and responder) is within the specified tolerance value (defined using the clock-tolerance ntp oneway command) of a one-way IP SLAs operation measurement for all the packets in a stream, the NTP synchronization status is determined to be synchronized. If these conditions are not met, the status is determined to be not synchronized.

The following guidelines apply to the displayed output:

•If the NTP synchronization status is determined to be synchronized, the one-way IP SLAs delay measurement values will be displayed.

•If the NTP synchronization status is determined to be not synchronized, the one-way values will be zero.

•The total number of operational packets that are not synchronized will be tracked during the collection period and reported.

IP SLAs Operation Configuration Dependence on Cisco IOS Release

The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 1). You must configure the type of IP SLAs operation (such as User Datagram Protocol (UDP) jitter or Internet Control Message Protocol (ICMP) echo before you can configure any of the other parameters of the operation.

The configuration mode for the clock-tolerance ntp oneway command varies depending on the Cisco IOS release you are running (see Table 1) and the operation type configured.

If you are using auto IP SLAs in Cisco IOS IP SLAs Engine 3.0, you must enter the parameters command in IP SLA template configuration mode before you can use the clock-tolerance ntp oneway command.

Examples

The following examples show how to enable microsecond precision, configure the NTP synchronization offset tolerance to 10 percent, and set the packet priority to high for IP SLAs UDP jitter operation 1. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 1).

IP SLA Configuration

ip sla 1

 udp-jitter 205.199.199.2 dest-port 9006

 precision microseconds

 clock-tolerance ntp oneway percent 10

 probe-packet priority high

 frequency 300

!

ip sla schedule 1 life forever start-time after 00:00:06

IP SLA Monitor Configuration

ip sla monitor 1

 type jitter dest-ipaddr 205.199.199.2 dest-port 9006

 precision microseconds

 clock-tolerance ntp oneway percent 10

 probe-packet priority high

 frequency 300

!

ip sla monitor schedule 1 life forever start-time after 00:00:06

IP SLA Template Parameters Configuration

Router(config)# ip sla auto template type ip udp-jitter 1

Router(config-udp-jtr-tplt)# parameters

Router(config-udp-jtr-params)# precision microseconds

Router(config-udp-jtr-params)# clock-tolerance ntp oneway percent 10

Router(config-udp-jtr-params)# operation-packet high

Router(config-udp-jtr-params)# end

Router#

Router# show ip sla auto template type ip udp-jitter

IP SLAs Auto Template: 1

Measure Type: udp-jitter (control enabled)

    Description: 

    IP options:

        Source IP: 0.0.0.0      Source Port: 0

        VRF:    TOS: 0x0

    Operation Parameters:

        Request Data Size: 32   Verify Data: false

        Number of Packets: 10   Inter packet interval: 20

        Timeout: 5000           Threshold: 5000

        Granularity: usec       Operation packet priority: high

        NTP Sync Tolerance: 10 percent

    Statistics Aggregation option:

        Hours of statistics kept: 2

    Statistics Distributions options:

        Distributions characteristics: RTT

        Distributions bucket size: 20

        Max number of distributions buckets: 1

    Reaction Configuration: None

Related Commands

codec (tplt)

To configure codec in an auto IP Service Level Agreements (SLAs) operation template for a User Datagram Protocol (UDP) jitter operation that returns VoIP scores, use the codec command in UDP jitter submode of the IP SLA template configuration mode.

codec codec-type [advantage-factor value] [codec-numpackets number-of-packets] [codec-interval milliseconds] [codec-size number-of-bytes]

Syntax Description

Defaults

A codec is not configured in the auto IP SLAs operation template being configured.

Command Modes

IP SLA UDP jitter template configuration (config-tplt-udp-jtr)

Command History

Usage Guidelines

This command configures the codec in an auto IP SLAs operation template for a UDP jitter operation and generates ICPIF and MOS scores, based on the specified codec type.

The specified codec-type should match the encoding algorithm being used for VoIP transmissions.

You must configure the type of auto IP SLAs operation,such as User Datagram Protocol (UDP) jitter or Internet Control Message Protocol (ICMP) echo, before you can configure any of the other parameters of the operation.

A UDP jitter operation computes statistics by sending n UDP packets, each of size s, sent t msec apart, from a given source router to a given target router, at a given frequency f. Based on the type of codec you configure for the operation, the number of packets (n), the size of each payload (s), the interpacket time interval (t), and the operational frequency (f) are auto-configured with default values or you can manually configure these parameters using the keyword and argument combinations in this command.

Note You should not specify values for the interval, size, and number of packet options unless you have a specific reason to override the defaults; for example, to approximate a different codec.

Table 2 lists the default values for each parameter by codec.

The advantage-factor value keyword and argument allow you to specify an access Advantage Factor, also known as the Expectation Factor. Table 3, adapted from ITU-T Rec. G.113, defines a set of provisional maximum values for Advantage Factors in terms of the service provided.

These values are only suggestions. To be meaningful, the Advantage/Expectation factor (A) and its selected value in a specific application should be used consistently in any planning model you adopt. However, the values in Table 3 should be considered as the absolute upper limits for A. The default Advantage/Expectation factor for UDP jitter operations is always zero.

Examples

In the following example, an auto IP SLAs operation template for a UDP jitter (codec) operation is configured to use the default characteristics of the G.711 a-law codec, which means the operation will consist of 1000 packets, each of 172 bytes (160 plus 12 header bytes), sent 20 ms apart. The default value for the Advantage Factor and operations frequency is used.

Router(config)# ip slas auto template type ip udp-jitter voip

Router(config-tplt)# codec g711alaw

Router(config-tplt)# end

Router# show ip sla auto template type ip udp-jitter voip

IP SLAs Auto Template: voip

    Measure Type: udp-jitter (control enabled)

    Description: 

    IP options:

        Source IP: 0.0.0.0      Source Port: 0

        VRF:    TOS: 0x0

    Operation Parameters:

        Verify Data: false

        Timeout: 5000           Threshold: 5000

        Codec: g711alaw Number of packets: 1000

        Interval: 20    Payload size: 16        Advantage factor: 0

        Granularity: msec       Operation packet priority: normal

    Statistics Aggregation option:

        Hours of statistics kept: 2

    Statistics Distributions options:

        Distributions characteristics: RTT

        Distributions bucket size: 20

        Max number of distributions buckets: 1

    Reaction Configuration: None

Related Commands

control

To enable or disable control messages in an auto IP Service Level Agreements (SLAs) operation template, use the control command in the appropriate submode of the IP SLA template configuration mode. To return to the default value, use the no form of this command.

control {enable | disable}

no control

Syntax Description

Command Default

IP SLAs control messaging is enabled.

Command Modes

IP SLA Template Configuration

TCP connect template configuration (config-tplt-tcp-conn)
UDP echo template configuration (config-tplt-udp-ech)
UDP jitter template configuration (config-tplt-udp-jtr)

Command HistoryTCP connect configuration (config-tplt-tcp-conn)
UDP echo configuration (config-tplt-udp-ech)

Usage Guidelines

This command disables or enables control messages for an auto IP SLAs operation. Prior to sending an operation packet to the destination router, IP SLAs sends a control message to the IP SLAs Responder to enable the destination port. Control protocol is required when the target device is a Cisco router that does not natively provide the UDP or TCP Connect service.

If you disable control, you must define the IP address of the source for the Cisco IOS IP SLAs Responder by using the ip sla responder tcp-connect ipaddress or ip sla responder udp-echo ipaddress command on the destination device.

The no form of this command returns the configuration to the default (enabled). If control is already enabled (default), the no form of this command has no affect.

You must configure the type of IP SLAs operation, such as User Datagram Protocol (UDP) jitter or Internet Control Message Protocol (ICMP) echo, before you can configure any of the other parameters of the operation.

Examples

The following example shows how to configure an auto IP SLA operation template for a TCP connect operation from Router 2 (10.1.1.1) to host device1. In this example, the control protocol is disabled. Auto IP SLAs uses the control protocol to notify the IP SLAs Responder to enable the target port temporarily. This action allows the Responder to reply to the TCP Connect operation. Because the control is disabled, you must configure the IP address of the source for the endpoint.

Router (Destination)

Router# configure terminal

Enter configuration commands, one per line.  End with CNTL/Z.

Roter1(config)# ip sla responder ipaddress 10.1.1.1 port 23

Router(config)# exit

Router# show running-config

.

.

.

!

ip sla responder

 ip sla responder ipaddress 10.1.1.1 port 23

Router (Source)

Router#configure terminal

Enter configuration commands, one per line.  End with CNTL/Z.

Router(config)# ip sla auto template type ip tcp-connect 6

Router(config-tplt-tcp-conn)# control disable

Router(config-tplt-tcp-conn)# tos 128

Router(config-tplt-tcp-conn)# exit   

Router# show running-config

.

.

.

ip sla auto template type ip tcp-connect 6

 control disable

 tos 128

Related Commands 

cos

To set the class of service (CoS) for a Cisco IOS IP Service Level Agreements (SLAs) Ethernet operation, use the cos command in the appropriate submode of IP SLA configuration or IP SLA Ethernet monitor configuration mode. To return to the default value, use the no form of this command.

cos cos-value

no cos

Syntax Description

Command Default

The class of service value for the IP SLAs Ethernet operation is set to 0.

Command Modes

IP SLA configuration

Ethernet echo configuration (config-ip-sla-ethernet-echo)
Ethernet jitter configuration (config-ip-sla-ethernet-jitter)

IP SLA Ethernet monitor configuration

Ethernet parameters configuration (config-ip-sla-ethernet-params)

Note The configuration mode varies depending on the operation type configured. See the "Usage Guidelines" section for more information.

Command History

Usage Guidelines

You must configure the type of IP SLAs operation (such as Ethernet ping) before you can configure any of the other parameters of the operation.

The configuration mode for the cos command varies depending on the operation type configured. For example, if you are running Cisco IOS Release 12.2(33)SRB and the Ethernet ping operation type is configured using the ethernet echo mpid command in IP SLA configuration mode, you would enter the cos command in Ethernet echo configuration mode (config-ip-sla-ethernet-echo).

Examples

The following example shows how to configure operation parameters, proactive threshold monitoring, and scheduling options using an IP SLAs auto Ethernet operation. In this example, operation 10 is configured to automatically create IP SLAs Ethernet ping operations for all the discovered maintenance endpoints in the domain named testdomain and VLAN identification number 34. The class of service for each Ethernet ping operation is set to 3. As specified by the proactive threshold monitoring configuration, when three consecutive connection loss events occur, a Simple Network Management Protocol (SNMP) trap notification should be sent. The schedule period for operation 10 is 60 seconds, and the operation is scheduled to start immediately.

ip sla ethernet-monitor 10

 type echo domain testdomain vlan 34

 cos 3

!

ip sla ethernet-monitor reaction-configuration 10 react connectionLoss threshold-type 
consecutive 3 action-type trapOnly

!

ip sla ethernet-monitor schedule 10 schedule-period 60 start-time now

Related Commands

data-pattern

To specify the data pattern in a Cisco IOS IP Service Level Agreements (SLAs) operation to test for data corruption, use the data pattern command in the appropriate submode of IP SLA configuration or IP SLA monitor configuration mode. To remove the data pattern specification, use the no form of this command.

data-pattern hex-pattern

no data-pattern hex-pattern

Syntax Description

Defaults

The default hex-pattern is ABCD.

Command Modes

IP SLA Configuration

UDP echo configuration (config-ip-sla-udp)

IP SLA Monitor Configuration

UDP echo configuration (config-sla-monitor-udp)

Note The configuration mode varies depending on the Cisco IOS release you are running and the operation type configured. See the "Usage Guidelines" section for more information.

Command History

Usage Guidelines

The data-pattern command allows users to specify an alphanumeric character string to verify that operation payload does not get corrupted in either direction (source-to-destination [SD] or destination-to-source [DS]).

Note The data-pattern command is supported by the IP SLAs User Datagram Protocol (UDP) echo operation only.

This command is supported in IPv4 networks and in IPv6 networks.

IP SLAs Operation Configuration Dependence on Cisco IOS Release

The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 4). You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.

The configuration mode for the data-pattern command varies depending on the Cisco IOS release you are running (see Table 4) and the operation type configured. For example, if you are running Cisco IOS Release 12.4 and the UDP echo operation type is configured, you would enter the data-pattern command in UDP echo configuration mode (config-sla-monitor-udp) within IP SLA monitor configuration mode.

Examples

The following examples show how to specify 1234ABCD5678 as the data pattern. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 4).

The examples show the data-pattern command being used in an IPv4 network.

IP SLA Configuration

ip sla 1

 udp-echo 10.0.54.205 dest-port 101

 data-pattern 1234ABCD5678

!

ip sla schedule 1 life forever start-time now

IP SLA Monitor Configuration

ip sla monitor 1

 type udpEcho dest-ipaddr 10.0.54.205 dest-port 101

 data-pattern 1234ABCD5678

!

ip sla monitor schedule 1 life forever start-time now

Related Commands

delete-scan-factor

To specify the number of times the IP Service Level Agreements (SLAs) label switched path (LSP) Health Monitor should check the scan queue before automatically deleting IP SLAs operations for Border Gateway Protocol (BGP) next hop neighbors that are no longer valid, use the delete-scan-factor command in auto IP SLA MPLS parameters configuration mode. To return to the default value, use the no form of this command.

delete-scan-factor factor

no delete-scan-factor

Syntax Description

Command Default

The default scan factor is 1. In other words, each time the LSP Health Monitor checks the scan queue for updates, it deletes IP SLAs operations for BGP next hop neighbors that are no longer valid.

Command Modes

Auto IP SLA MPLS parameters configuration (config-auto-ip-sla-mpls-params)

Command History

Usage Guidelines

This command must be used with the scan-interval command. Use the scan-interval command to specify the time interval at which the LSP Health Monitor checks the scan queue for BGP next hop neighbor updates.

Note If the scan factor is set to 0, IP SLAs operations will not be automatically deleted by the LSP Health Monitor. This configuration is not recommended.

Examples

The following example shows how to configure operation parameters, proactive threshold monitoring, and scheduling options using the LSP Health Monitor. In this example, LSP Health Monitor operation 1 is configured to automatically create IP SLAs LSP ping operations for all Border Gateway Protocol (BGP) next hop neighbors in use by all VPN routing and forwarding (VRF) instances associated with the source Provider Edge (PE) router. The delete scan factor is set to 2. In other words, every other time the LSP Health Monitor checks the scan queue for updates, it deletes IP SLAs operations for BGP next hop neighbors that are no longer valid.

mpls discovery vpn interval 60

mpls discovery vpn next-hop

!

auto ip sla mpls-lsp-monitor 1

 type echo ipsla-vrf-all

 timeout 1000

 scan-interval 1

 secondary-frequency connection-loss 10

 secondary-frequency timeout 10

 delete-scan-factor 2

!

auto ip sla mpls-lsp-monitor reaction-configuration 1 react connectionLoss threshold-type 
consecutive 3 action-type trapOnly

auto ip sla mpls-lsp-monitor reaction-configuration 1 react timeout threshold-type 
consecutive 3 action-type trapOnly

ip sla logging traps

!

auto ip sla mpls-lsp-monitor schedule 1 schedule-period 60 start-time now

Related Commands

description (IP SLA)

To add a description to the configuration of an IP Service Level Agreements (SLAs) auto-measure group, auto IP SLAs operation template, or auto IP SLAs endpoint list, use the description command in IP SLA auto-measure group configuration, IP SLA endpoint-list configuration, or appropriate submode of IP SLA template configuration mode. To remove the description, use the no form of this command.

description description

no description

Syntax Description

Command Default

No description is added to configuration.

Command Modes

IP SLA Configuration

IP SLA auto-measure group (config-am-group)
IP SLA endpoint-list (config-epl)

IP SLA Template Configuration

ICMP echo configuration (config-tplt-icmp-ech)
ICMP jitter configuration (config-tplt-icmp-jtr)
TCP connect configuration (config-tplt-tcp-conn)
UDP echo configuration (config-tplt-udp-ech)
UDP jitter configuration (config-tplt-udp-jtr)

Command History

Usage Guidelines

This command adds descriptive text to the configuration of an IP SLAs auto-measure group, auto IP SLAs operation template, or auto IP SLAs endpoint list. The description appears in the show command output and does not affect the operation of the template.

Examples

The following example shows how to configure this command for an auto IP SLAs operation template:

Router(config)# ip sla auto template type ip icmp-jitter 1

Router(config-tplt-icmp-jtr)# description default oper temp for icmp jitter

Router# end

Router# show ip sla auto template type ip icmp-jitter

IP SLAs Auto Template: 1

    Measure Type: icmp-jitter

    Description: default oper temp for icmp jitter

    IP options:

        Source IP: 0.0.0.0

        VRF:    TOS: 0x0

    Operation Parameters:

        Number of Packets: 10   Inter packet interval: 20

        Timeout: 5000           Threshold: 5000

    Statistics Aggregation option:

        Hours of statistics kept: 2

    Statistics Distributions options:

        Distributions characteristics: RTT

        Distributions bucket size: 20

        Max number of distributions buckets: 1

    Reaction Configuration: None

Related Commands

destination (am-group)

To add an auto IP Service Level Agreements (SLAs) endpoint list to the configuration of an IP SLAs auto-measure group, use the destination command in IP SLA auto-measure group configuration mode. To remove the endpoint list from the group configuration, use the no form of this command.

destination template-name

no destination

Syntax Description

Command Default

No endpoints are defined for the IP SLAs auto-measure group being configured.

Command Modes

IP SLA auto-measure group configuration (config-am-grp)

Command History

Usage Guidelines

This command specifies an auto IP SLAs endpoint list as a reference for the IP SLAs auto-measure group being configured. An endpoint list contains IP addresses for IP SLAs endpoints.

Only one auto IP SLAs endpoint list can be specified for each IP SLAs auto-measure group. Each endpoint list can be referenced by more than one group.

To change the auto IP SLAs endpoint list in the configuration of an existing auto-measure group, first use the no form of this command to remove the endpoint list from the group configuration and then reconfigure the group with a different endpoint list.

To create an auto IP SLAs endpoint list, use the ip sla auto endpoint-list command.

Examples

The following example shows how to add an auto IP SLAs endpoint list to the configuration of an IP SLAs auto-measure group:

Router(config)# ip sla auto group type ip 1           

Router(config-am-grp)# destination 1

Router(config-am-grp)# schedule 1

Router(config-am-grp)# end

Router#

Router# show ip sla auto group 

Group Name: 1

    Description: 

    Activation Trigger: Immediate

    Destination: 1

    Schedule: 1

IP SLAs Auto Template: default

    Measure Type: icmp-jitter

    Description: 

    IP options:

        Source IP: 0.0.0.0

        VRF:    TOS: 0x0

    Operation Parameters:

        Number of Packets: 10   Inter packet interval: 20

        Timeout: 5000           Threshold: 5000

    Statistics Aggregation option:

        Hours of statistics kept: 2

    Statistics Distributions options:

        Distributions characteristics: RTT

        Distributions bucket size: 20

        Max number of distributions buckets: 1

    Reaction Configuration: None

IP SLAs auto-generated operations of group 1

    no operation created

Related Commands

dhcp (IP SLA)

To configure a Cisco IOS IP Service Level Agreements (SLAs) Dynamic Host Configuration Protocol (DHCP) operation, use the dhcp command in IP SLA configuration mode.

dhcp {destination-ip-address | destination-hostname} [source-ip {ip-address | hostname}] [option-82 [circuit-id circuit-id] [remote-id remote-id] [subnet-mask subnet-mask]]

Syntax Description

Defaults

No IP SLAs operation type is configured for the operation being configured.

Command Modes

IP SLA configuration (config-ip-sla)

Command History

Usage Guidelines

If the source IP address is configured, then packets will be sent with that source address.

You may configure the ip dhcp-server global configuration command to identify the DHCP server that the DHCP operation will measure. If the target IP address is configured, then only that device will be measured. If the ip dhcp-server command is not configured and the target IP address is not configured, then DHCP discover packets will be sent on every available IP interface.

Option 82 is called the Relay Agent Information option and is inserted by the DHCP relay agent when client-originated DHCP packets are forwarded to a DHCP server. Servers recognizing the Relay Agent Information option may use the information to implement IP address or other parameter assignment policies. The DHCP server echoes the option back verbatim to the relay agent in server-to-client replies, and the relay agent strips the option before forwarding the reply to the client.

The Relay Agent Information option is organized as a single DHCP option that contains one or more suboptions that convey information known by the relay agent. The initial suboptions are defined for a relay agent that is colocated in a public circuit access unit. These suboptions are as follows: a circuit ID for the incoming circuit, a remote ID that provides a trusted identifier for the remote high-speed modem, and a subnet mask designation for the logical IP subnet from which the relay agent received the client DHCP packet.

Note If an odd number of characters are specified for the circuit ID, a zero will be added to the end of the string.

You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation. To change the operation type of an existing IP SLAs operation, you must first delete the IP SLAs operation (using the no ip sla global configuration command) and then reconfigure the operation with the new operation type.

Examples

In the following example, IP SLAs operation number 4 is configured as a DHCP operation enabled for DHCP server 172.16.20.3:

ip sla 4 

 dhcp option-82 circuit-id 10005A6F1234 

ip dhcp-server 172.16.20.3

!

ip sla schedule 4 start-time now

Related Commands

discover (epl)

To enter IP SLA endpoint-list auto-discovery configuration mode for building a list of destination IP addresses for Cisco routing devices or Cisco IP Service Level Agreements (SLAs) Responders, use the discover command in IP SLA endpoint-list configuration mode. To remove the list, use the no form of this command.

discover [port port]

no discover [port port]

Syntax Description

Command Default

No destination IP addresses are identified.

Command Modes

IP SLA endpoint-list configuration (config-epl)

Command History

Usage Guidelines

This command discovers and builds a list of destination IP addresses to be added to an endpoint list for IP SLAs auto-measure groups.

Before using this command, use the ip sla auto discovery command to enable auto-discovery.

Before using this command, use the ip sla responder auto-register command on the destination Cisco device to enable endpoints to register with source upon configuration.

Destination IP addresses can either be automatically discovered by using this command or manually configured using the ip-address command. If you use this command to build an endpoint list, you cannot use the ip-address command to manually add or remove IP addresses in an endpoint list.

To add the discovered list of destination IP addresses to the endpoint list being configured, use the access-list command in IP SLA endpoint-list auto-discovery configuration mode.

Examples

The following example shows how to configure an endpoint list using the auto discovery method:

Destination Router

Router(config)# ip sla responder auto-register 10.1.1.25

Router(config)#

Source Router

Router(config)# ip sla auto discovery

Router(config)# ip sla auto endpoint-list type ip autolist

Router(config-epl)# discover port 5000

Router(config-epl-disc)# access-list 3

Router(config-epl-disc)# end

Router# show ip sla auto endpoint-list

Endpoint-list Name: autolist

    Description: 

    Auto Discover Parameters

        Destination Port: 5000

        Access-list: 3

        Ageout: 3600    Measurement-retry: 3

.

.

.

Related Commands

distributions-of-statistics-kept

Note Effective with Cisco IOS Release 12.4(4)T, 12.2(33)SRB, 12.2(33)SB, and 12.2(33)SXI, the distributions-of-statistics-kept command is replaced by the history distributions-of-statistics-kept command. See the history distributions-of-statistics-kept command for more information.

To set the number of statistics distributions kept per hop during a Cisco IOS IP Service Level Agreements (SLAs) operation, use the distributions-of-statistics-kept command in the appropriate submode of IP SLA monitor configuration mode. To return to the default value, use the no form of this command.

distributions-of-statistics-kept size

no distributions-of-statistics-kept

Syntax Description

Defaults

1 distribution

Command Modes

DHCP configuration (config-sla-monitor-dhcp)
DLSw configuration (config-sla-monitor-dlsw)
DNS configuration (config-sla-monitor-dns)
FTP configuration (config-sla-monitor-ftp)
HTTP configuration (config-sla-monitor-http)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
TCP connect configuration (config-sla-monitor-tcp)
UDP echo configuration (config-sla-monitor-udp)
UDP jitter configuration (config-sla-monitor-jitter)
VoIP configuration (config-sla-monitor-voip)

Command History

Usage Guidelines

In most situations, you do not need to change the number of statistics distributions kept or the time interval for each distribution. Only change these parameters when distributions are needed, for example, when performing statistical modeling of your network. To set the statistics distributions interval, use the statistics-distribution-interval command.

When the number of distributions reaches the size specified, no further distribution-based information is stored.

For the IP SLAs Internet Control Message Protocol (ICMP) path echo operation, the amount of router memory required to maintain the distribution statistics table is based on multiplying all of the values set by the following four commands:

•distributions-of-statistics-kept

•hops-of-statistics-kept

•paths-of-statistics-kept

•hours-of-statistics-kept

The general equation used to calculate the memory requirement to maintain the distribution statistics table for an ICMP path echo operation is as follows:
Memory allocation = (160 bytes) * (distributions-of-statistics-kept size) * (hops-of-statistics-kept size) * (paths-of-statistics-kept size) * (hours-of-statistics-kept hours)

Note To avoid significant impact on router memory, careful consideration should be used when configuring the distributions-of-statistics-kept, hops-of-statistics-kept, paths-of-statistics-kept, and hours-of-statistics-kept commands.

Note You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.

Examples

The following example shows how to set the statistics distribution to 5 and the distribution interval to 10 ms for IP SLAs ICMP echo operation 1. Consequently, the first distribution will contain statistics from 0 to 9 ms, the second distribution will contain statistics from 10 to 19 ms, the third distribution will contain statistics from 20 to 29 ms, the fourth distribution will contain statistics from 30 to 39 ms, and the fifth distribution will contain statistics from 40 ms to infinity.

ip sla monitor 1

 type echo protocol ipIcmpEcho 172.16.161.21

 distributions-of-statistics-kept 5

 statistics-distribution-interval 10

!

ip sla monitor schedule 1 life forever start-time now

Related Commands

dlsw peer-ipaddr

To configure a Cisco IOS IP Service Level Agreements (SLAs) Data Link Switching Plus (DLSw+) operation, use the dlsw peer-ipaddr command in IP SLA configuration mode.

dlsw peer-ipaddr ip-address

Syntax Description

Defaults

No IP SLAs operation type is configured for the operation being configured.

Command Modes

IP SLA configuration (config-ip-sla)

Command History

Usage Guidelines

To configure an IP SLAs DLSw+ operation, the DLSw+ feature must be configured on the local and target routers.

For DLSw+ operations, the default request packet data size is 0 bytes (use the request-data-size command to modify this value) and the default amount of time the operation waits for a response from the request packet is 30 seconds (use the timeout command to modify this value).

You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation. To change the operation type of an existing IP SLAs operation, you must first delete the IP SLAs operation (using the no ip sla global configuration command) and then reconfigure the operation with the new operation type.

Examples

In the following example, IP SLAs operation number 10 is configured as a DLSw+ operation enabled for remote peer IP address 172.21.27.11. The data size is 15 bytes:

ip sla 10

 dlsw peer-ipaddr 172.21.27.11

 request-data-size 15

!

ip sla schedule 4 start-time now

Related Commands

dns (IP SLA)

To configure a Cisco IOS IP Service Level Agreements (SLAs) Domain Name System (DNS) operation, use the dns command in IP SLA configuration mode.

dns {destination-ip-address | destination-hostname} name-server ip-address [source-ip {ip-address | hostname} source-port port-number]

Syntax Description

Defaults

No IP SLAs operation type is configured for the operation being configured.

Command Modes

IP SLA configuration (config-ip-sla)

Command History

Usage Guidelines

You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation. To change the operation type of an existing IP SLAs operation, you must first delete the IP SLAs operation (using the no ip sla global configuration command) and then reconfigure the operation with the new operation type.

Examples

In the following example, IP SLAs operation 7 is configured as a DNS operation using the target IP address 172.20.2.132:

ip sla 7

 dns host1 name-server 172.20.2.132

!

ip sla schedule 7 start-time now

Related Commands

enhanced-history

Note Effective with Cisco IOS Release 12.4(4)T, 12.2(33)SRB, 12.2(33)SB, and 12.2(33)SXI, the enhanced-history command is replaced by the history enhanced command. See the history enhanced command for more information.

To enable enhanced history gathering for a Cisco IOS IP Service Level Agreements (SLAs) operation, use the enhanced-history command in the appropriate submode of IP SLA monitor configuration mode.

enhanced-history [interval seconds] [buckets number-of-buckets]

Syntax Description

Defaults

900 seconds and 100 buckets

Command Modes

DHCP configuration (config-sla-monitor-dhcp)
DLSw configuration (config-sla-monitor-dlsw)
DNS configuration (config-sla-monitor-dns)
FTP configuration (config-sla-monitor-ftp)
HTTP configuration (config-sla-monitor-http)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
TCP connect configuration (config-sla-monitor-tcp)
UDP echo configuration (config-sla-monitor-udp)
UDP jitter configuration (config-sla-monitor-jitter)
VoIP configuration (config-sla-monitor-voip)

Command History

Usage Guidelines

Performance statistics are stored in "buckets" that separate the accumulated data. Each bucket consists of data accumulated over the specified time interval.

Note You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.

Examples

In the following example, Internet Control Message Protocol (ICMP) echo operation 3 is configured with the standard enhanced history characteristics.

ip sla monitor 3

 type echo protocol ipIcmpEcho 172.16.1.175

 enhanced-history interval 900 buckets 100

!

ip sla monitor schedule 3 start-time now life forever

Related Commands

ethernet echo mpid

To manually configure an individual Cisco IOS IP Service Level Agreements (SLAs) Ethernet ping operation, use the ethernet echo mpid command in IP SLA configuration mode.

ethernet echo mpid mp-id domain domain-name {evc evc-id | port | vlan vlan-id}

Syntax Description

Command Default

No IP SLAs Ethernet ping operation is configured.

Command Modes

IP SLA configuration (config-ip-sla)

Command History

Usage Guidelines

Unlike the EVC and VLAN statistical measurements, the port level measurement is performed at the physical layer level and does not cross a bridge boundary.

You must configure the type of IP SLAs operation (such as Ethernet ping) before you can configure any of the other parameters of the operation. To change the operation type of an existing IP SLAs operation, you must first delete the IP SLAs operation (using the no ip sla global configuration command) and then reconfigure the operation with the new operation type.

Examples

The following example shows how to configure an IP SLAs Ethernet ping operation. In this example, the maintenance endpoint identification number is 23, the maintenance domain name is testdomain, and the VLAN identification number is 34. Operation 1 is scheduled to start immediately.

ip sla 1

 ethernet echo mpid 23 domain testdomain vlan 34

!

ip sla schedule 1 start-time now

Related Commands

ethernet jitter mpid

To manually configure an individual Cisco IOS IP Service Level Agreements (SLAs) Ethernet jitter operation, use the ethernet jitter mpid command in IP SLA configuration mode.

ethernet jitter mpid mp-id domain domain-name {evc evc-id | port | vlan vlan-id} [interval interframe-interval] [num-frames frames-number]

Syntax Description

Command Default

No IP SLAs Ethernet jitter operation is configured.

Command Modes

IP SLA configuration (config-ip-sla)

Command History

Usage Guidelines

Unlike the EVC and VLAN statistical measurements, the port level measurement is performed at the physical layer level and does not cross a bridge boundary.

You must configure the type of IP SLAs operation (such as Ethernet jitter) before you can configure any of the other parameters of the operation. To change the operation type of an existing IP SLAs operation, you must first delete the IP SLAs operation (using the no ip sla global configuration command) and then reconfigure the operation with the new operation type.

Examples

The following example shows how to configure an IP SLAs Ethernet jitter operation. In this example, the maintenance endpoint identification number is 23, the maintenance domain name is testdomain, the VLAN identification number is 34, the interframe interval is 20 ms, and the number of frames to be sent is 30. Operation 2 is scheduled to start immediately.

ip sla 2

 ethernet jitter mpid 23 domain testdomain vlan 34 interval 20 num-frames 30

!

ip sla schedule 2 start-time now

Related Commands

exp (IP SLA)

To specify the experimental field value in the header for an echo request packet of a Cisco IOS IP Service Level Agreements (SLAs) operation, use the exp command in the appropriate submode of auto IP SLA MPLS configuration, IP SLA configuration, or IP SLA monitor configuration mode. To return to the default value, use the no form of this command.

exp exp-bits

no exp

Syntax Description

Command Default

The experimental field value is set to 0.

Command Modes

Auto IP SLA MPLS Configuration

MPLS parameters configuration (config-auto-ip-sla-mpls-params)

IP SLA Configuration and IP SLA Monitor Configuration

LSP ping configuration (config-sla-monitor-lspPing)
LSP trace configuration (config-sla-monitor-lspTrace)
VCCV configuration (config-sla-vccv)

Note The configuration mode varies depending on the Cisco IOS release you are running and the operation type configured. See the "Usage Guidelines" section for more information.

Command History

Usage Guidelines

IP SLAs Operation Configuration Dependence on Cisco IOS Release

The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 5). Note that if you are configuring an IP SLAs label switched path (LSP) Health Monitor operation, see Table 6 for information on Cisco IOS release dependencies. You must configure the type of IP SLAs operation (such as LSP ping) before you can configure any of the other parameters of the operation.

The configuration mode for the exp (IP SLA) command varies depending on the Cisco IOS release you are running and the operation type configured. For example, if you are running Cisco IOS Release 12.4(6)T and the LSP ping operation type is configured (without using the LSP Health Monitor), you would enter the exp (IP SLA) command in LSP ping configuration mode (config-sla-monitor-lspPing) within IP SLA configuration mode.

Examples

The following example shows how to configure operation parameters, proactive threshold monitoring, and scheduling options using the LSP Health Monitor. In this example, LSP Health Monitor operation 1 is configured to automatically create IP SLAs LSP ping operations for all Border Gateway Protocol (BGP) next hop neighbors in use by all VPN routing and forwarding (VRF) instances associated with the source Provider Edge (PE) router. The experimental field value for each IP SLAs operations created by LSP Health Monitor operation 1 is set to 5.

mpls discovery vpn interval 60

mpls discovery vpn next-hop

!

auto ip sla mpls-lsp-monitor 1

 type echo ipsla-vrf-all

 timeout 1000

 scan-interval 1

 secondary-frequency connection-loss 10

 secondary-frequency timeout 10

 delete-scan-factor 2

 exp 5

!

auto ip sla mpls-lsp-monitor reaction-configuration 1 react connectionLoss threshold-type 
consecutive 3 action-type trapOnly

auto ip sla mpls-lsp-monitor reaction-configuration 1 react timeout threshold-type 
consecutive 3 action-type trapOnly

ip sla logging traps

!

auto ip sla mpls-lsp-monitor schedule 1 schedule-period 60 start-time now

Related Commands

filter-for-history

Note Effective with Cisco IOS Release 12.4(4)T, 12.2(33)SRB, 12.2(33)SB, and 12.2(33)SXI, the filter-for-history command is replaced by the history filter command. See the history filter command for more information.

To define the type of information kept in the history table for a Cisco IOS IP Service Level Agreements (SLAs) operation, use the filter-for-history command in the appropriate submode of IP SLA monitor configuration mode. To return to the default value, use the no form of this command.

filter-for-history {none | all | overThreshold | failures}

no filter-for-history {none | all | overThreshold | failures}

Syntax Description

Defaults

No IP SLAs history is kept for an operation.

Command Modes

DHCP configuration (config-sla-monitor-dhcp)
DLSw configuration (config-sla-monitor-dlsw)
DNS configuration (config-sla-monitor-dns)
FTP configuration (config-sla-monitor-ftp)
HTTP configuration (config-sla-monitor-http)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
TCP connect configuration (config-sla-monitor-tcp)
UDP echo configuration (config-sla-monitor-udp)
VoIP configuration (config-sla-monitor-voip)

Command History

Usage Guidelines

Use the filter-for-history command to control what gets stored in the history table for an IP SLAs operation. To control how much history gets saved in the history table, use the lives-of-history-kept, buckets-of-history-kept, and the samples-of-history-kept commands.

Note The filter-for-history command does not support the IP SLAs User Datagram Protocol (UDP) jitter operation.

An IP SLAs operation can collect history and capture statistics. By default, the history for an IP SLAs operation is not collected. If history is collected, each history bucket contains one or more history entries from the operation. When the operation type is ICMP path echo, an entry is created for each hop along the path that the operation takes to reach its destination. The type of entry stored in the history table is controlled by the filter-for-history command. The total number of entries stored in the history table is controlled by the combination of the samples-of-history-kept, buckets-of-history-kept, and lives-of-history-kept commands.

Note Collecting history increases the RAM usage. Collect history only when you think there is a problem in the network.

Note You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.

Examples

In the following example, only operation packets that fail are kept in the history table.

ip sla monitor 1

 type echo protocol ipIcmpEcho 172.16.161.21

 lives-of-history-kept 1

 filter-for-history failures

!

ip sla monitor schedule 1 life forever start-time now

Related Commands

flow-label (IP SLA)

To define the flow label field in the IPv6 header of a Cisco IOS IP Service Level Agreements (SLAs) operation, use the flow-label (IP SLA) command in the appropriate submode of IP SLA configuration or IP SLA monitor configuration mode. To return to the default value, use the no form of this command.

flow-label number

no flow-label

Syntax Description

Defaults

The default flow label value is 0.

Command Modes

ICMP echo configuration (config-ip-sla-echo)
TCP connect configuration (config-ip-sla-tcp)
UDP echo configuration (config-ip-sla-udp)
UDP jitter configuration (config-ip-sla-jitter)

Note The configuration mode varies depending on the operation type configured.

Command History

Usage Guidelines

The flow label value is stored in a a 20-bit field in the IPv6 packet header and is used by a source to label packets of a flow.

A flow label value of zero is used to indicate packets that are not part of any flow.

When the flow label is defined for an operation, the IP SLAs Responder will reflect the flow-label value it receives.

Note This command is applicable only to IPv6 networks.

To display the flow label value for all Cisco IOS IP SLAs operations or a specified operation, use the show ip sla configuration command.

Examples

In the following example, IP SLAs operation 1 is configured as an Internet Control Message Protocol (ICMP) echo operation with destination IPv6 address 2001:DB8:100::1. The value in the flow label field of the IPv6 header is set to 0x1B669.

ip sla 1

 icmp-echo 2001:DB8:100::1

 flow-label 0x1B669 

!

ip sla schedule 1 start-time now

Related Commands

force-explicit-null

To add an explicit null label to all echo request packets of a Cisco IOS IP Service Level Agreements (SLAs) LSP Health Monitor operation, use the force-explicit-null command in the appropriate submode of auto IP SLA MPLS configuration mode. To return to the default value, use the no form of this command.

force-explicit-null

no force-explicit-null

Syntax Description

This command has no arguments or keywords.

Command Default

An explicit null label is not added.

Command Modes

Auto IP SLA MPLS Configuration

MPLS parameters configuration (config-auto-ip-sla-mpls-params)
LSP discovery parameters configuration (config-auto-ip-sla-mpls-lpd-params)

Command History

Usage Guidelines

You must configure the type of LSP Health Monitor operation (such as LSP ping) before you can configure any of the other parameters of the operation.

Examples

The following example shows how to configure operation parameters, proactive threshold monitoring, and scheduling options using the LSP Health Monitor. In this example, LSP Health Monitor operation 1 is configured to automatically create IP SLAs LSP ping operations for all Border Gateway Protocol (BGP) next hop neighbors in use by all VPN routing and forwarding (VRF) instances associated with the source PE router. In this example, an explicit null label will be added to all the echo request packets of IP SLAs operations created by LSP Health Monitor operation 1.

mpls discovery vpn interval 60

mpls discovery vpn next-hop

!

auto ip sla mpls-lsp-monitor 1

 type echo ipsla-vrf-all

 force-explicit-null

 timeout 1000

 scan-interval 1

 secondary-frequency connection-loss 10

 secondary-frequency timeout 10

 delete-scan-factor 2

!

auto ip sla mpls-lsp-monitor reaction-configuration 1 react connectionLoss threshold-type 
consecutive 3 action-type trapOnly

auto ip sla mpls-lsp-monitor reaction-configuration 1 react timeout threshold-type 
consecutive 3 action-type trapOnly

ip sla logging traps

!

auto ip sla mpls-lsp-monitor schedule 1 schedule-period 60 start-time now

Related Commands

frequency (am-schedule)

To set the frequency characteristic in an auto IP Service Level Agreements (SLAs) scheduler for restarting auto IP SLAs operations, use the frequency command in IP SLA auto-measure schedule configuration mode. To return to the default value, use the no form of this command.

frequency {seconds | range random-frequency-range}

no frequency

Syntax Description

Command Default

Auto IP SLAs operations restart every 60 sec.

Command Modes

IP SLA auto-measure schedule configuration (config-am-schedule)

Command History

Usage Guidelines

This command changes the value of frequency in an auto IP SLAs scheduler from the default (every 60 sec) to the specified value. The frequency characteristic determines how often an operation in an IP SLAs auto-measure group will repeat once it is started.

Use the probe-interval command to configure the interval between the start time of one operation and the start time of the next operation being controlled by the same auto IP SLAs scheduler.

Random Scheduler

The random scheduler option provides the capability to schedule auto IP SLAs operations that share the same scheduler to begin at random intervals over a specified duration of time. The random scheduler option is disabled by default.

To enable the random scheduler option, you must configure the range random-frequency-range keyword and argument combination. Auto IP SLAs operations being controlled by a random scheduler restart at uniformly distributed random frequencies within the specified frequency range. The following guidelines apply for setting the random frequency range:

•The starting value of the range should be greater than the timeout value of the operations controlled by the scheduler being configured.

•The starting value of the frequency range should be greater than the schedule period (amount of time for which the operations are scheduled). This guideline ensures that the same operation does not get scheduled more than once within the schedule period.

The following guidelines apply if the random scheduler option is enabled:

•The individual operations being controlled by the same auto IP SLAs scheduler will be uniformly distributed to begin at random intervals over the schedule period.

•The operations being controlled by the same auto IP SLAs scheduler restart at uniformly distributed random frequencies within the specified frequency range.

•The minimum interval between the start of each operation being controlled by the same auto IP SLAs scheduler is 100 ms (0.1 sec).

•Only one operation can be scheduled to begin at any given time. If the random scheduler option is disabled, multiple operations can begin at the same time.

•The first operation will always begin at 0 ms of the schedule period.

•The order in which each operation in a multioperation schedule begins is random.

Multioperation Scheduling

Note A multioperation schedule is created by specifying the same auto IP SLA scheduler for two or more IP SLA auto-measure groups.

The following guidelines apply when you add or delete an operation from an existing multioperation schedule by modifying the configuration of an IP SLAs auto-measure group to add or remove the auto IP SLAs scheduler:

•If two or more operations are added after the multioperation schedule has started, then the start times of the newly added operations will be uniformly distributed based on a time interval that was calculated prior to the addition of the new operations. If two or more operations are added before the multioperation schedule has started, then the time interval is recalculated based on both the existing and newly added operations.

•If an operation is added to a multioperation schedule in which the random scheduler option is enabled, then the start time and frequency of the newly added operation will be randomly chosen within the specified parameters.

•If an operation is added to a multioperation schedule in which the existing operations have aged out or the lifetimes of the existing operations have ended, the newly added operation will start and remain active for the amount of time specified by the multioperation schedule.

•If an active operation is deleted, then the operation will stop collecting information and become inactive.

Examples

The following example shows how to configure an auto IP SLAs scheduler that will cause an auto IP SLAs operation to actively collect data at 3:00 p.m. on April 5. The operation will age out after 12 hours of inactivity, which can be before it starts or after it has finished its life. When the operation ages out, all configuration information for the operation is removed from the running configuration in RAM.

Router(config)# ip sla auto schedule apr5

Router(config-am-schedule)# ageout 43200

Router(config-am-schedule)# frequency 70

Router(config-am-schedule)# life 43200

Router(config-am-schedule)# probe-interval 1500

Router(config-am-schedule)# start-time 15:00 apr 5

Router(config-am-schedule)# end

Router# show ip sla auto schedule apr5

Group sched-id: apr5

    Probe Interval (ms) : 1500

    Group operation frequency (sec): 70

    Status of entry (SNMP RowStatus): Active

    Next Scheduled Start Time: P15:00 apr 5

    Life (sec): 43200

    Entry Ageout (sec): 43200

The following example shows how to schedule auto IP SLAs operations 3, 4, and 6 using multioperation scheduling. In this example, the operations are scheduled to begin at equal intervals over a schedule period of 20 seconds. The first operation (or set of operations) is scheduled to start immediately.

Router(config)# ip sla auto schedule multi

Router(config-am-schedule)# probe-interval 20

Router(config-am-schedule)# start-time now

Router(config-am-schedule)# end

Router#

Router# show ip sla auto schedule multi

Group sched-id: multi

    Probe Interval (ms) : 20

    Group operation frequency (sec): 60 

	Status of entry (SNMP RowStatus): Active

    Next Scheduled Start Time: Now

    Life (sec): 3600

    Entry Ageout (sec): never

Router#configure terminal

Router(config)# ip sla auto group type ip icmp-echo 3

Router(config-am-group)# template 3

Router(config-am-group)# schedule multi

Router(config-am-group)# destination 3

Router(config-am-group)# exit

Router(config)# ip sla auto group type ip icmp-echo 4

Router(config-am-group)# template 4

Router(config-am-group)# schedule multi

Router(config-am-group)# destination 4

Router(config-am-group)# exit

Router(config)# ip sla auto group type ip icmp-echo 6

Router(config-am-group)# template 6

Router(config-am-group)# schedule multi

Router(config-am-group)# destination 6

Router(config-am-group)# exit

Router(config)#

Related Commands

frequency (IP SLA)

To set the rate at which a specified IP Service Level Agreements (SLAs) operation repeats, use the frequency (IP SLA) command in the appropriate submode of IP SLA configuration or IP SLA monitor configuration mode. To return to the default value, use the no form of this command.

frequency seconds

no frequency

Syntax Description

Defaults

60 seconds

Command Modes

IP SLA Configuration

DHCP configuration (config-ip-sla-dhcp)
DLSw configuration (config-ip-sla-dlsw)
DNS configuration (config-ip-sla-dns)
Ethernet echo (config-ip-sla-ethernet-echo)
Ethernet jitter (config-ip-sla-ethernet-jitter)
FTP configuration (config-ip-sla-ftp)
HTTP configuration (config-ip-sla-http)
ICMP echo configuration (config-ip-sla-echo)
ICMP jitter configuration (config-ip-sla-icmpjitter)
ICMP path echo configuration (config-ip-sla-pathEcho)
ICMP path jitter configuration (config-ip-sla-pathJitter)
TCP connect configuration (config-ip-sla-tcp)
UDP echo configuration (config-ip-sla-udp)
UDP jitter configuration (config-ip-sla-jitter)
VCCV configuration (config-sla-vccv)
VoIP configuration (config-ip-sla-voip)

IP SLA Monitor Configuration

DHCP configuration (config-sla-monitor-dhcp)
DLSw configuration (config-sla-monitor-dlsw)
DNS configuration (config-sla-monitor-dns)
FTP configuration (config-sla-monitor-ftp)
HTTP configuration (config-sla-monitor-http)
ICMP echo configuration (config-sla-monitor-echo)
ICMP path echo configuration (config-sla-monitor-pathEcho)
ICMP path jitter configuration (config-sla-monitor-pathJitter)
TCP connect configuration (config-sla-monitor-tcp)
UDP echo configuration (config-sla-monitor-udp)
UDP jitter configuration (config-sla-monitor-jitter)
VoIP configuration (config-sla-monitor-voip)

Note The configuration mode varies depending on the Cisco IOS release you are running and the operation type configured. See the "Usage Guidelines" section for more information.

Command History

Usage Guidelines

A single IP SLAs operation will repeat at a given frequency for the lifetime of the operation. For example, a User Datagram Protocol (UDP) jitter operation with a frequency of 60 sends a collection of data packets (simulated network traffic) once every 60 seconds, for the lifetime of the operation. The default simulated traffic for a UDP jitter operation consists of ten packets sent 20 milliseconds apart. This "payload" is sent when the operation is started, then is sent again 60 seconds later.

If an individual IP SLAs operation takes longer to execute than the specified frequency value, a statistics counter called "busy" is incremented rather than immediately repeating the operation.

Consider the following guidelines before configuring the frequency (IP SLA), timeout (IP SLA), and threshold (IP SLA) commands. For the IP SLAs UDP jitter operation, the following guidelines are recommended:

•(frequency seconds) > ((timeout milliseconds) + N)

•(timeout milliseconds) > (threshold milliseconds)

where N = (num-packets number-of-packets) * (interval interpacket-interval). Use the udp-jitter command to configure the num-packets number-of-packets and interval interpacket-interval values.

For all other IP SLAs operations, the following configuration guideline is recommended:

(frequency seconds) > (timeout milliseconds) > (threshold milliseconds)

Note We recommend that you do not set the frequency value to less than 60 seconds because the potential overhead from numerous active operations could significantly affect network performance.

The frequency (IP SLA) command is supported in IPv4 networks. This command is also supported in IPv6 networks when configuring an IP SLAs operation that supports IPv6 addresses.

IP SLAs Operation Configuration Dependence on Cisco IOS Release

The Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 7). You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation.

The configuration mode for the frequency (IP SLA) command varies depending on the Cisco IOS release you are running (see Table 7) and the operation type configured. For example, if you are running Cisco IOS Release 12.4 and the ICMP echo operation type is configured, you would enter the frequency (IP SLA) command in ICMP echo configuration mode (config-sla-monitor-echo) within IP SLA monitor configuration mode.

Examples

The following examples show how to configure an IP SLAs ICMP echo operation (operation 10) to repeat every 90 seconds. Note that the Cisco IOS command used to begin configuration for an IP SLAs operation varies depending on the Cisco IOS release you are running (see Table 7).

IP SLA Configuration

This example shows the frequency (IP SLA) command being used in an IPv4 network in ICMP echo configuration mode within IP SLA configuration mode:

ip sla 10

 icmp-echo 172.16.1.175

 frequency 90

!

ip sla schedule 10 life 300 start-time after 00:05:00

IP SLA Monitor Configuration

This example shows the frequency (IP SLA) command being used in an IPv4 network in ICMP echo configuration mode within IP SLA monitor configuration mode:

ip sla monitor 10

 type echo protocol ipIcmpEcho 172.16.1.175

 frequency 90

!

ip sla monitor schedule 10 life 300 start-time after 00:05:00

Related Commands

ftp get

To configure a Cisco IOS IP Service Level Agreements (SLAs) File Transfer Protocol (FTP) GET operation, use the ftp get command in IP SLA configuration mode.

ftp get url [source-ip {ip-address | hostname}] [mode {passive | active}

Syntax Description

Defaults

No IP SLAs operation type is configured for the operation being configured.

Command Modes

IP SLA configuration (config-ip-sla)

Command History

Usage Guidelines

The url argument must be in one of the following formats:

•ftp://username:password@host/filename

•ftp://host/filename

If the username and password are not specified, the defaults are anonymous and test, respectively.

You must configure the type of IP SLAs operation (such as User Datagram Protocol [UDP] jitter or Internet Control Message Protocol [ICMP] echo) before you can configure any of the other parameters of the operation. To change the operation type of an existing IP SLAs operation, you must first delete the IP SLAs operation (using the no ip sla global configuration command) and then reconfigure the operation with the new operation type.

Examples

In the following example, an FTP operation is configured. User1 is the username and password1 is the password; host1 is the host and file1 is the filename.

ip sla 3

 ftp get ftp://user1:password1@host1/file1

!

ip sla schedule 3 start-time now

Related Commands

history buckets-kept

To set the number of history buckets that are kept during the lifetime of a Cisco IOS IP Service Level Agreements (SLAs) operation, use the history buckets-kept command in the appropriate submode of IP SLA configuration or IP SLA template parameters configuration mode. To return to the default value, use the no form of this command.

history buckets-kept size

no history buckets-kept

Syntax Description

Command Default

The default number of buckets kept is 50 buckets.

Command Modes

IP SLA Configuration

DHCP configuration (config-ip-sla-dhcp)
DLSw configuration (config-ip-sla-dlsw)
DNS configuration (config-ip-sla-dns)
Ethernet echo (config-ip-sla-ethernet-echo)
Ethernet jitter (config-ip-sla-ethernet-jitter)
FTP configuration (config-ip-sla-ftp)
HTTP configuration (config-ip-sla-http)
ICMP echo configuration (config-ip-sla-echo)
ICMP path echo configuration (config-ip-sla-pathEcho)
ICMP path jitter configuration (config-ip-sla-pathJitter)
TCP connect configuration (config-ip-sla-tcp)
UDP echo configuration (config-ip-sla-udp)
VCCV configuration (config-sla-vccv)
VoIP configuration (config-ip-sla-voip)

IP SLA Template Parameters Configuration

ICMP echo configuration (config-icmp-ech-params)
TCP connect configuration (config-tcp-conn-params)
UDP echo configuration (config-udp-ech-params)

Command History

Usage Guidelines

Each time IP SLAs starts an operation, a new bucket is created until the number of history buckets matches the specified size or the lifetime of the operation expires. History buckets do not wrap.

To define the lifetime of an IP SLAs operation, use the ip sla schedule global configuration command. To define the lifetime of an auto IP SLAs operation template in Cisco IP SLAs Engine 3.0, use the life command in IP SLAs auto-measure schedule configuration mode.

Before you can use this command to configure auto IP SLAs operation templates, you must enter the parameters command in IP SLA template configuration mode.

The history buckets-kept command is supported in IPv4 networks. This command is also supported in IPv6 networks to configure an IP SLAs operation that supports IPv6 addresses.

By default, the history for an IP SLAs operation is not collected. If history is collected, each bucket contains one or more history entries from the operation. When the operation type is Internet Control Message Protocol (ICMP) path echo, an entry is created for each hop along the path that the operation takes to reach its destination.

The type of entry stored in the history table is controlled by the history filter command.

The total number of entries stored in the history table is controlled by the combination of the samples-of-history-kept, history buckets-kept, and history lives-kept commands.

Note Collecting history increases the RAM usage. Collect history only if you think there is a problem in the network.

Examples

The following example shows how to configure an ICMP echo operation to keep 25 history buckets during the operation lifetime. The example shows the history buckets-kept command being used in an IPv4 network.

IP SLA Configuration

ip sla schedule 1 start-time now life forever

ip sla 1

 icmp-echo 172.16.161.21

 history buckets-kept 25

 history lives-kept 1

!

ip sla schedule 1 start-time now life forever

IP SLA Template Parameters Configuration

Router(config)# ip sla auto template type ip icmp-echo 1

Router(config-tplt-icmp-ech)# parameters

Router(config-icmp-ech-params)# history buckets-kept 25

Router(config-icmp-ech-params)# end

Router# show ip sla auto template type ip icmp-echo 1

IP SLAs Auto Template: 1

    Measure Type: icmp-echo

.

.

.

Statistics Aggregation option:

        Hours of statistics kept: 5

    History options:

        History filter: none

        Max number of history records kept: 25

        Lives of history kept: 1

    Statistics Distributions options:

        Distributions characteristics: RTT

        Distributions bucket size: 20

        Max number of distributions buckets: 1

    Reaction Configuration: None

Related Commands

history distributions-of-statistics-kept

To set the number of statistics distributions kept per hop during a Cisco IOS IP Service Level Agreements (SLAs) operation, use the history distributions-of-statistics-kept command in the appropriate submode of IP SLA configuration or IP SLA template parameters configuration mode. To return to the default value, use the no form of this command.

history distributions-of-statistics-kept size

no history distributions-of-statistics-kept

Syntax Description

Command Default

The default is 1 distribution.

Command Modes

IP SLA Configuration

DHCP configuration (config-ip-sla-dhcp)
DLSw configuration (config-ip-sla-dlsw)
DNS configuration (config-ip-sla-dns)
Ethernet echo (config-ip-sla-ethernet-echo)
Ethernet jitter (config-ip-sla-ethernet-jitter)
FTP configuration (config-ip-sla-ftp)
HTTP configuration (config-ip-sla-http)
ICMP echo configuration (config-ip-sla-echo)
ICMP jitter configuration (config-ip-sla-icmpjitter)
ICMP path echo configuration (config-ip-sla-pathEcho)
ICMP path jitter configuration (config-ip-sla-pathJitter)
TCP connect configuration (config-ip-sla-tcp)
UDP echo configuration (config-ip-sla-udp)
UDP jitter configuration (config-ip-sla-jitter)
VCCV configuration (config-sla-vccv)
VoIP configuration (config-ip-sla-voip)

IP SLA Template Parameters Configuration

ICMP echo configuration (config-icmp-ech-params)
ICMP jitter configuration (config-icmp-jtr-params)
TCP connect configuration (config-tcp-conn-params)
UDP echo configuration (config-udp-ech-params)
UDP jitter configuration (config-udp-jtr-params)

Command History

Usage Guidelines

In most situations, you do not need to change the number of statistics distributions kept or the time interval for each distribution. Change these parameters only when distributions are needed, for example, when performing statistical modeling of your network.

Before you can use this command to configure auto IP SLAs operation templates, you must enter the parameters command in IP SLA template configuration mode.

To set the statistics distributions interval, use the history statistics-distribution-interval command.

When the number of distributions reaches the size specified, no further distribution-based information is stored.

The history distributions-of-statistics-kept command is supported in IPv4 networks. This command is also supported in IPv6 networks to configure an IP SLAs operation that supports IPv6 addresses.

For the IP SLAs Internet Control Message Protocol (ICMP) path echo operation, the amount of router memory required to maintain the distribution statistics table is based on multiplying all of the values set by the following four commands:

•history distributions-of-statistics-kept

•hops-of-statistics-kept

•paths-of-statistics-kept

•history hours-of-statistics-kept

The general equation used to calculate the memory requirement to maintain the distribution statistics table for an ICMP path echo operation is as follows:
Memory allocation = (160 bytes) * (history distributions-of-statistics-kept size) * (hops-of-statistics-kept size) * (paths-of-statistics-kept size) * (history hours-of-statistics-kept hours)

Note To avoid significant impact on router memory, careful consideration should be used when configuring the history distributions-of-statistics-kept, hops-of-statistics-kept, paths-of-statistics-kept, and history hours-of-statistics-kept commands.

Examples

In the following examples, the statistics distribution is set to five and the distribution interval is set to 10 ms for an ICMP echo operation. Consequently, the first distribution will contain statistics from 0 to 9 ms, the second distribution will contain statistics from 10 to 19 ms, the third distribution will contain statistics from 20 to 29 ms, the fourth distribution will contain statistics from 30 to 39 ms, and the fifth distribution will contain statistics from 40 ms to infinity. The examples show the history distributions-of-statistics-kept command being used in an IPv4 network.