-
Cisco IOS XR System Monitoring Command Reference, Release 3.4
-
Preface
-
Alarm Management and Logging Correlation Commands on Cisco IOS XR Software
-
Fault Manager Commands on Cisco IOS XR Software
-
IP Service Level Agreement Commands on Cisco IOS XR Software
-
Logging Services Commands on Cisco IOS XR Software
-
Onboard Failure Logging Commands on Cisco IOS XR Software
-
Performance Management Commands on Cisco IOS XR Software
-
Statistics Service Commands on Cisco IOS XR Software
-
Index
-
Table Of Contents
IP Service Level Agreement Commands on Cisco IOS XR Software
show ipsla responder statistics ports
show ipsla statistics aggregated
show ipsla statistics aggregated detail
show ipsla statistics enhanced aggregated
IP Service Level Agreement Commands on Cisco IOS XR Software
This module describes the Cisco IOS XR software commands used to configure IP Service Level Agreements (IP SLAs). For detailed information about IP SLA concepts, configuration tasks, and examples, see the Implementing IP Service Level Agreements on Cisco IOS XR Software module of the Cisco IOS XR System Management Configuration Guide.
action (IP SLA)
To specify what action or combination of actions the operation performs when you configure the react command or when threshold events occur, use the action command in IP SLA reaction condition configuration mode. To clear action or combination of actions (no action can happen), use the no form of this command.
action {logging | trigger}
no action {logging | trigger}
Syntax Description
Defaults
No default behavior or values
Command Modes
IP SLA reaction condition configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
For the action command to occur for threshold events, the threshold type must be defined. Absence of threshold type configuration is considered if the threshold check is not activated.
Task ID
Examples
The following example shows how to use the action command with the logging keyword:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react connection-lossRP/0/RP0/CPU0:router(config-ipsla-react-cond)# action loggingRelated Commands
ageout
To specify the number of seconds to keep the operation in memory when it is not actively collecting information, use the ageout command in IP SLA schedule configuration mode. To use the default value and the operation will never age out, use the no form of this command.
ageout seconds
no ageout
Syntax Description
seconds
Age-out interval in seconds. The value 0 seconds means that the collected data is not aged out.The range is 0 to 2073600.
Defaults
The default value is 0 seconds (never aged out).
Command Modes
IP SLA schedule configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the ageout command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla schedule operation 1RP/0/RP0/CPU0:router(config-ipsla-sched)# ageout 3600
Related Commands
buckets (history command)
To set the number of history buckets that are kept during the lifetime of the IP SLA operation, use the buckets command in IP SLA operation history configuration mode. To use the default value, use the no form of this command.
buckets buckets
no buckets
Syntax Description
buckets
Number of history buckets that are kept during the lifetime of an IP SLA operation. The range is 1 to 60.
Defaults
The default value is 15 buckets.
Command Modes
IP SLA operation history configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The buckets command is supported only to configure the following operations:
•
IP SLA ICMP path-echo
•
•
Task ID
Examples
The following example shows how to use the buckets command in IP SLA UDP Echo configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp echoRP/0/RP0/CPU0:router(config-ipsla-udp-echo)# historyRP/0/RP0/CPU0:router(config-ipsla-op-hist)# buckets 30Related Commands
Configures the history parameters for the IP SLA operation.
Configures an IP SLA operation.
Schedules an IP SLA operation.
buckets (hourly)
To set the number of hours in which statistics are kept, use the bucket command in IP SLA operation statistics configuration mode. To use the default value, use the no form of this command.
buckets hours
no buckets
Syntax Description
hours
Sets the number of hours in which statistics are maintained for the IP SLA operations. The range is 0 to 25.
Defaults
The default value is 2.
Command Modes
IP SLA operation statistics configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The buckets command with the hours argument is valid only for the statistics command with the hourly keyword.
Task ID
Examples
The following example shows how to set the number of hours in which statistics are maintained for the IP SLA UDP jitter operation for the buckets command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# statistics hourlyRP/0/RP0/CPU0:router(config-ipsla-op-stats)# buckets 10Related Commands
buckets (interval)
To refer to the data buckets in which the enhanced history statistics are kept, use the buckets command in IP SLA operation statistics configuration mode. To remove the statistics collection of the specified interval, use the no form of this command.
buckets bucket-size
no buckets
Syntax Description
bucket-size
bucket-size is when the configured bucket limit is reached. Therefore, statistics gathering for the operation ends. The range is 1 to 100. The default value is 100.
Defaults
No default behavior or values
Command Modes
IP SLA operation statistics configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The buckets command with the bucket-size argument is valid only for the statistics command with the interval keyword.
Examples
The following example shows how to collect statistics for a given time interval for the IP SLA UDP jitter operation for the buckets command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# statistics interval 60RP/0/RP0/CPU0:router(config-ipsla-op-stats)# buckets 50Related Commands
control disable
To disable the control packets, use the control disable command in the appropriate IP SLA configuration mode. To use the control packets again, use the no form of this command.
control disable
no control disable
Syntax Description
This command has no arguments or keywords.
Defaults
Control packets are enabled by default.
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
When you configure the control disable command on the agent side, you need to configure a permanent port on the responder side or the operation returns a timeout error. If you configure the control disable command, a permanent port of the IP SLA Responder or some other functionality, such as the UDP echo server, is required on the remote device.
The control disable command is valid for operations that require a responder.
The IP SLA control protocol is disabled, which is used to send a control message to the IP SLA Responder prior to sending an operation packet. By default, IP SLA control messages are sent to the destination device to establish a connection with the IP SLA Responder.
Task ID
Examples
The following example shows how to use the control disable command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)#ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# control disableRelated Commands
datasize request
To set the protocol data size in the request packet in the payload of an operation, use the datasize request command in the appropriate IP SLA configuration mode. To reset the default data size, use the no form of this command.
datasize request size
no datasize request
Syntax Description
Defaults
For a UDP jitter operation, the default value is 32 B.
For a UDP echo operation, the default value is 16 B.
For an ICMP echo operation, the default value is 36 B.
For an ICMP path-echo operation, the default value is 36 B.
For an ICMP path-jitter operation, the default value is 36 B.
For an IP SLA MPLS LSP ping operation, the default value is 100 B.
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
IP SLA Path-Echo configuration
IP SLA ICMP Echo configuration
IP SLA MPLS LSP Ping configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
Support was added for the IP SLA MPLS LSP Ping configuration mode.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the datasize request command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# datasize request 512Related Commands
destination address (IP SLA)
To identify the address of the target device, use the destination address command in the appropriate IP SLA configuration mode. To unset the destination address, use the no form of this command.
destination address ipv4 address
no destination address
Syntax Description
Defaults
No default behavior or values
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
IP SLA ICMP Path-Echo configuration
IP SLA ICMP Echo configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
You must specify the address of the target device. The configuration for the destination address command is mandatory for all operations.
Task ID
Examples
The following example shows how to designate an IP address for the destination address command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# destination address 12.25.26.10Related Commands
destination port
To identify the port of the target device, use the destination port command in IP SLA UDP Echo configuration mode or IP SLA UDP Jitter configuration mode. To unset the destination port, use the no form of this command.
destination port port
no destination port
Syntax Description
Defaults
No default behavior or values
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The destination port command is not supported when you configure an ICMP operation; it is supported only to configure UDP operations.
You must specify the port of the target device. The configuration for the destination port command is mandatory for both IP SLA UDP echo and IP SLA UDP jitter configurations.
Task ID
Examples
The following example shows how to designate a port for the destination port command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# destination port 11111Related Commands
distribution count
To set the number of statistics distributions that are kept for each hop during the lifetime of the IP SLA operation, use the distribution count command in IP SLA operation statistics configuration mode. To use the default value, use the no form of this command.
distribution count slot
no distribution count
Syntax Description
Defaults
The default value is 1.
Command Modes
IP SLA operation statistics configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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 distribution interval command in IP SLA operation statistics configuration mode. The total number of statistics distributions captured is the value set by the distribution count command times the value set by the maximum hops command times the value set by the maximum path command times the value set by the buckets command.
Task ID
Examples
The following example shows how to set the number of statistics distribution for the distribution count command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# statistics hourlyRP/0/RP0/CPU0:router(config-ipsla-op-stats)# distribution count 15Related Commands
distribution interval
To set the time interval (in milliseconds) for each statistical distribution, use the distribution interval command in IP SLA operation statistics configuration mode. To use the default value, use the no form of this command.
distribution interval interval
no distribution interval
Syntax Description
interval
Number of milliseconds used for each statistics distribution that is kept. The range is 1 to 100. The default value is 20.
Defaults
The default value is 20.
Command Modes
IP SLA operation statistics configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
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 count, use the distribution count command in IP SLA operation statistics configuration mode. The total number of statistics distributions captured is the value set by the distribution count command times the value set by the maximum hops command times the value set by the maximum path command times the value set by the buckets command.
Task ID
Examples
The following example shows how to set the time interval for the distribution interval command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# statistics hourlyRP/0/RP0/CPU0:router(config-ipsla-op-stats)# distribution interval 50Related Commands
exp
To specify the MPLS experimental field (EXP) value in the header of echo request packets, use the exp in IP SLA MPLS LSP Ping or IP SLA MPLS LSP Trace configuration mode. To return to the default value, use the no form of this command.
exp exp-bits
no exp
Syntax Description
exp-bits
Experimental field value in the header of an echo reply packet. Valid values are from 0 to 7. Default is 0.
Defaults
The experimental field value is set to 0.
Command Modes
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the exp command to set the MPLS experimental field in the headers of echo request packets in an MPLS LSP ping or MPLS LSP trace operation. The experimental (EXP) field allows for eight different quality-of-service (QoS) markings that determine the treatment (per-hop behavior) that a transit LSR node gives to a reply packet. You can configure different MPLS EXP levels for different operations to create differentiated levels of response.
Task ID
Examples
The following example shows how to use the exp command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp traceRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-trace)# exp 5Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an MPLS VPN.
filter
To define the type of information that are kept in the history table for the IP SLA operation, use the filter command in IP SLA operation history configuration mode. To unset the history filter, use the no form of this command.
filter {all | failures}
no filter
Syntax Description
all
Stores history data for all operations, if set.
failures
Stores data for operations that failed, if set.
Defaults
The default is not to collect the history unless the filter command is enabled.
Command Modes
IP SLA operation history configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The filter command is supported only to configure the following operations:
•
•
•
If you use the no form of the filter command, the history statistics are not collected.
Task ID
Examples
The following example shows how to use the filter command in IP SLA UDP Echo configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp echoRP/0/RP0/CPU0:router(config-ipsla-udp-echo)# historyRP/0/RP0/CPU0:router(config-ipsla-op-hist)# filter allRelated Commands
force explicit-null
To add an explicit null label to the label stack of an LSP when an echo request is sent, use the force explicit-null command in IP SLA MPLS LSP Ping or IP SLA MPLS LSP Trace 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.
Defaults
An explicit null label is not added.
Command Modes
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the force explicit-null command to force an unsolicited explicit null label to be added to the MPLS label stack of the LSP when an echo request packet is sent in an MPLS LSP ping or MPLS LSP trace operation.
Task ID
Examples
The following example shows how to use the force explicit-null command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp traceRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-trace)# force explicit-nullRelated Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an MPLS VPN.
frequency (IP SLA)
To set the frequency for probing, use the frequency command in the appropriate IP SLA configuration mode. To use the default value, use the no form of this command.
frequency seconds
no frequency
Syntax Description
seconds
Rate at which the specific IP SLA operation is sent into the network. The range is from 1 to 604800.
Defaults
If the frequency command is not used, the default value is 60 seconds.
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
IP SLA ICMP Path-Echo configuration
IP SLA ICMP Echo configuration
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
Support was added for the IP SLA MPLS Ping and IP SLA MPLS Trace configuration modes.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the frequency command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# frequency 300Related Commands
history
To configure the history parameters for the IP SLA operation, use the history command in the appropriate IP SLA configuration mode. To use the default value, use the no form of this command.
history
no history
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
IP SLA ICMP Path-Echo configuration
IP SLA ICMP Echo configuration
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
Support was added for the IP SLA MPLS LSP Ping and IP SLA MPLS LSP Trace configuration modes.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The history command enters IP SLA operation history configuration mode in which you can configure more history configuration parameters.
Task ID
Examples
The following example shows how to use the history command in IP SLA UDP Echo configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp echoRP/0/RP0/CPU0:router(config-ipsla-udp-echo)# historyRP/0/RP0/CPU0:router(config-ipsla-op-hist)#Related Commands
ipsla key-chain
To configure the MD5 authentication for the IP SLA control message, use the ipsla key-chain command in configuration mode. To unset the key chain name and not use MD5 authentication, use the no form of this command.
ipsla key-chain key-chain name
no ipsla key-chain
Syntax Description
Defaults
No default values are defined. No authentication is used.
Command Modes
Global configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
When you configure the ipsla key-chain command, you must also configure the key chain command to provide MD5 authentication.
Task ID
Examples
The following example shows how to use the ipsla key-chain command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla key-chain ipsla-keysRelated Commands
key chain
Creates or modifies a key chain. For more information, see Cisco IOS XR System Security Command Reference.
Configures an IP SLA operation.
Schedules an IP SLA operation.
ipsla low-memory
To configure a low-water memory mark, use the ipsla low-memory command in global configuration mode. To use the default value, use the no form of this command.
ipsla low-memory value
no ipsla low-memory
Syntax Description
Defaults
The default value is 20 MB (free memory).
Command Modes
Global configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
IP SLA ensures that the system provides the specified memory before adding new operations or scheduling the pending operation.
When the 0 value is used, no memory limitation is enforced.
Task ID
Examples
The following example shows how to use the ipsla low-memory command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla low-memory 102400Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Displays the information for the IP SLA application.
ipsla operation
To configure an IP SLA operation, use the ipsla operation command in global configuration mode. To remove the operation, use the no form of this command.
ipsla operation operation-number
no ipsla operation operation-number
Syntax Description
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the ipsla operation command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)#Related Commands
ipsla reaction operation
To configure certain actions that are based on events under the control of the IP SLA agent, use the ipsla reaction operation command in global configuration mode.To remove the reaction so no reaction will occur, use the no form of this command.
ipsla reaction operation operation-number
no ipsla reaction operation operation-number
Syntax Description
operation-number
Number of the IP SLA operations for the reactions to be configured. The range is from 1 to 2048.
Defaults
No reaction is configured.
Command Modes
Global configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the ipsla reaction operation command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 1RP/0/RP0/CPU0:router(config-ipsla-react)#Related Commands
ipsla reaction trigger
To define a second IP SLA operation to make the transition from a pending state to an active state when one of the trigger-type options is defined with the ipsla reaction operation command, use the ipsla reaction trigger command in global configuration mode. To remove the reaction trigger and the triggering-operation argument does not trigger any other operation, use the no form of this command.
ipsla reaction trigger [triggering-operation] [triggered-operation]
no ipsla reaction trigger [triggering-operation] [triggered-operation]
Syntax Description
Defaults
No triggered operation is configured.
Command Modes
Global configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Both the triggering-operation and triggered-operation arguments must be configured. The triggered operation must be in the pending state.
Task ID
Examples
The following example shows how to use the ipsla reaction trigger command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction trigger 1 2Related Commands
ipsla responder
To enable the IP SLA responder for UDP echo or jitter operations, use the ipsla responder command in global configuration mode. To disable the responder, use the no form of this command.
ipsla responder
no ipsla responder
Syntax Description
This command has no arguments or keywords.
Defaults
The ipsla responder command is disabled.
Command Modes
Global configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
An IP address and port are configured and identified as a permanent port (for example, a port to which the responder is permanently listening). If no IP address and port are configured, the responder handles only dynamic ports (for example, ports that are listened to when requested by a remote operation).
Task ID
Examples
The following example shows how to enable the IP SLA responder for the ipsla responder command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla responderRP/0/RP0/CPU0:router(config-ipsla-resp)#Related Commands
Configures a permanent port in the IP SLA Responder for UDP echo or jitter operations
ipsla schedule operation
To enter schedule configuration mode, use the ipsla schedule operation command in IP SLA schedule configuration mode. To remove the scheduler, use the no form of this command.
ipsla schedule operation operation-number
no ipsla schedule operation operation-number
Syntax Description
operation-number
Configuration number or schedule number that is used to schedule an IP SLA operation. The range is from 1 to 2048.
Defaults
No default behavior or values
Command Modes
IP SLA schedule configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The ipsla schedule operation command enters the IP SLA schedule configuration mode. You can configure more schedule configuration parameters to schedule the operation.When an operation is scheduled, it continues collecting information until the configured life expires.
Task ID
Examples
The following example shows how to use the ipsla schedule operation command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla schedule operation 1RP/0/RP0/CPU0:router(config-ipsla-sched)#Related Commands
life
To specify the length of time to execute, use the life command in IP SLA schedule configuration mode. To use the default value, use the no form of this command.
life {forever | seconds}
no life
Syntax Description
Defaults
The default value is 3600 seconds.
Command Modes
IP SLA schedule configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the life command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla schedule operation 1RP/0/RP0/CPU0:router(config-ipsla-sched)# life forever
Related Commands
lives
To set the number of lives that are maintained in the history table for an IP SLA operation, use the lives command in IP SLA operation history configuration mode. To use the default value, use the no form of this command.
lives lives
no lives
Syntax Description
lives
Number of lives that are maintained in the history table for an IP SLA operation. The range is 0 to 2.
Defaults
The default value is 0 lives.
Command Modes
IP SLA operation history configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The lives command is supported only to configure the following operations:
•
•
•
If you use the no form of the lives command, the history statistics are not collected.
Task ID
Examples
The following example shows how to use the lives command in IP SLA UDP Echo configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp echoRP/0/RP0/CPU0:router(config-ipsla-udp-echo)# historyRP/0/RP0/CPU0:router(config-ipsla-op-hist)# lives 2Related Commands
lsp selector ipv4
To specify the local host IPv4 address used to select an LSP, use the lsp selector ipv4 command in IP SLA MPLS LSP Ping or IP SLA MPLS LSP Trace configuration mode. To unset the host address, use the no form of this command.
lsp selector ipv4 ip-address
no lsp selector ipv4
Syntax Description
Defaults
The local host IP address used to select the LSP is 127.0.0.1.
Command Modes
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the lsp selector ipv4 command to force an MPLS LSP ping or MPLS LSP trace operation to use a specific LSP when there are multiple equal cost paths between provider edge (PE) routers. This situation occurs when transit label switching routers (LSRs) use the destination address in IP packet headers for load balancing.
The IPv4 address configured with the lsp selector ipv4 command is the destination address in the User Datagram Protocol (UDP) packet sent as the MPLS echo request. Valid IPv4 addresses are defined in the subnet 127.0.0.0/8 and used to:
•
•
•
Task ID
Examples
The following example shows how to use the lsp selector ipv4 command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp traceRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-trace)# lsp selector ipv4 127.10.10.1Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an MPLS VPN.
lsr-path
To specify a loose source routing path in which to measure the ICMP, use the lsr-path command in IP SLA ICMP Path-Jitter configuration mode or IP SLA ICMP Path-Echo configuration mode. To not use the specified path, use the no form of this command.
lsr-path ipaddress1 {ipaddress2 {... {ipaddress8}}}
no lsr-path
Syntax Description
Defaults
No path is configured.
Command Modes
IP SLA ICMP Path-Jitter configuration
IP SLA ICMP Path-Echo configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The lsr-path command applies only to ICMP path-echo and ICMP path-jitter operation types.
You can configure up to a maximum of eight hop addresses by using the lsr-path command, as shown in the following example:
lsr-path ipaddress1 {ipaddress2 {... {ipaddress8}}}Task ID
Examples
The following example shows how to use the lsr-path command in IP SLA ICMP Path-echo configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type icmp path-echoRP/0/RP0/CPU0:router((config-ipsla-icmp-path-echo)# lsr-path 20.25.22.1Related Commands
maximum hops
To set the number of hops in which statistics are maintained for each path for the IP SLA operation, use the maximum hops command in IP SLA operation statistics configuration mode. To use the default value, use the no form of this command.
maximum hops hops
no maximum hops
Syntax Description
hops
Number of hops for which statistics are maintained for each path. The range is 1 to 30. The default value is 16 for path operations; for example, pathecho.
Defaults
The default value is 16 hops.
Command Modes
IP SLA operation statistics configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The maximum hops command is supported only when you configure path operations and the IP SLA ICMP path-echo operation.
Task ID
Examples
The following example shows how to set the number of hops for the statistics for the maximum command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type icmp path-echoRP/0/RP0/CPU0:router(config-ipsla-icmp-path-echo)# statistics hourlyRP/0/RP0/CPU0:router(config-ipsla-op-stats)# maximum hops 20Related Commands
maximum paths (IP SLA)
To set the number of paths in which statistics are maintained for each hour for an IP SLA operation, use the maximum paths command in IP SLA operation statistics configuration mode. To use the default value, use the no form of this command.
maximum paths paths
no maximum paths
Syntax Description
paths
Number of paths for which statistics are maintained for each hour. The range is 1-128. The default value is 5 for path operations; for example, pathecho.
Defaults
The default value is 5 paths.
Command Modes
IP SLA operation statistics configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The maximum paths command is supported only when you configure path operations and the IP SLA ICMP path-echo operation.
Task ID
Examples
The following example shows how to set the number of paths for the statistics for the maximum paths command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type icmp path-echoRP/0/RP0/CPU0:router(config-ipsla-icmp-path-echo)# statistics hourlyRP/0/RP0/CPU0:router(config-ipsla-op-stats)# maximum paths 20Related Commands
packet count
To specify the number of packets that are to be transmitted during a probe, such as a sequence of packets being transmitted for a jitter probe, use the packet count command in IP SLA ICMP Path-Jitter configuration mode or IP SLA UDP Jitter configuration mode. To use the default value, use the no form of this command.
packet count count
no packet count
Syntax Description
count
Number of packets to be transmitted in each operation. For a UDP jitter operation, the range is 1 to 60000; for an ICMP path-jitter operation, the range is 1 to 100.
Defaults
The default packet count is 10.
Command Modes
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the packet count command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# packet count 30Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Specifies the interval between packets.
packet interval
To specify the interval between packets, use the packet interval command in IP SLA ICMP Path-Jitter configuration mode or IP SLA UDP Jitter configuration mode. To use the default value, use the no form of this command.
packet interval interval
no packet interval
Syntax Description
Defaults
The default packet interval is 20 ms.
Command Modes
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the packet interval command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# packet interval 30Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Specifies the number of packets that are to be transmitted during a probe.
react
To specify an element to be monitored for a reaction, use the react command in IP SLA reaction configuration mode. To remove the specified reaction type, use the no form of this command.
react [connection-loss | jitter-average {dest-to-source | source-to-dest}| packet-loss [dest-to-source | source-to-dest] | rtt | timeout | verify-error]
no react [connection-loss | jitter-average {dest-to-source | source-to-dest}| packet-loss {dest-to-source | source-to-dest}| rtt | timeout | verify-error]
Syntax Description
Defaults
If there is no default value, no reaction is configured.
Command Modes
IP SLA reaction configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
For the connection-loss keyword, jitter-average keyword, and rtt keyword, the reaction does not occur when the value violates the upper or the lower threshold. The reaction condition is set when the upper threshold is passed, and it is cleared when values go below the lower threshold.
For the connection-loss keyword and verify-error keyword, thresholds do not apply to the monitored element.
For the jitter-average keyword, packet-loss keyword, and rtt keyword, if the upper threshold for react threshold type average 3 is configured as 5000 ms and the last three results of the operation are 6000, 6000, and 5000 ms, the average is 6000 + 6000 + 5000=17000/3 = 5667—therefore violating the 5000-ms upper threshold. The threshold type average must be configured when setting the type. These keywords are not available if connection-loss, timeout, or verify-error is specified as the monitored element, because upper and lower thresholds do not apply to these options.
Task ID
Examples
The following example shows how to use the react command with the connection-loss keyword:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react connection-lossRP/0/RP0/CPU0:router(config-ipsla-react-cond)#The following example shows how to use the react command with the jitter-average keyword:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react jitter-averageRP/0/RP0/CPU0:router(config-ipsla-react-cond)#The following example shows how to use the react command with the packet-loss keyword:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react packet-loss dest-to-sourceRP/0/RP0/CPU0:router(config-ipsla-react-cond)#The following example shows how to use the react command with the rtt keyword:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react rttRP/0/RP0/CPU0:router(config-ipsla-react-cond)#The following example shows how to use the react command with the timeout keyword:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react timeoutRP/0/RP0/CPU0:router(config-ipsla-react-cond)#The following example shows how to use the react command with the verify-error keyword:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react verify-errorRP/0/RP0/CPU0:router(config-ipsla-react-cond)#Related Commands
recurring
To indicate that the operation starts automatically at the specified time and for the specified duration every day, use the recurring command in IP SLA schedule configuration mode. To not start the operation everyday, use the no form of this command.
recurring
no recurring
Syntax Description
This command has no arguments or keywords.
Defaults
Recurring is disabled.
Command Modes
IP SLA schedule configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the recurring command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla schedule operation 1RP/0/RP0/CPU0:router(config-ipsla-sched)# recurring
Related Commands
reply dscp
To specify the differentiated services codepoint (DSCP) value used in echo reply packets, use the reply dscp command in the appropriate IP SLA configuration mode. To return to the default value, use the no form of this command.
reply dscp dscp-bits
no reply dscp
Syntax Description
Defaults
The default DSCP value is 0.
Command Modes
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the reply dscp command to set the DCSP value used in the headers of IPv4 UDP packets sent as echo replies in an MPLS LSP ping or MPLS LSP trace operation.
The DSCP value consists of the six most significant bits of the 1-byte IP type of service (ToS) field. These bits determine the quality-of-service (QoS) treatment (per-hop behavior) that an transit LSR node gives to an echo reply packet. For information about how packets are classified and processed depending on the value you assign to the 6-bit DSCP field, refer to The Differentiated Services Model (DiffServ) at the following URL:
http://www.cisco.com/en/US/products/ps6610/products_data_sheet09186a00800a3e30.html
Task ID
Examples
The following example shows how to use the reply dscp command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp pingRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-ping)# reply dscp 5Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an MPLS VPN.
reply mode router-alert
To set echo requests to reply as an IPv4 UDP packet with IP router alert, use the reply mode router-alert command in IP SLA MPLS LSP Ping or IP SLA MPLS LSP Trace configuration mode. To return to the default value, use the no form of this command.
reply mode router-alert
no reply mode
Syntax Description
This command has no arguments or keywords.
Defaults
The default reply mode for an echo request packet is an IPv4 UDP packet without IP router alert set.
Command Modes
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the reply mode router-alert command to set the reply mode of echo reply packets in an MPLS LSP ping or MPLS LSP trace operation. After you enter this command, echo reply packets are set to reply as an IPv4 UDP packet with the IP router alert option in the UDP packet header.
The router-alert reply mode forces an echo reply packet to be specially handled by the transit LSR router at each intermediate hop as it moves back to the destination. Because this reply mode is more expensive, it is recommended only if the headend router does not receive echo replies using the default reply mode.
Task ID
Examples
The following example shows how to use the reply dscp command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp traceRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-trace)# reply mode router-alertRelated Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an MPLS VPN.
samples
To set the number of hop entries that are kept in the history table for an IP SLA ICMP path-echo operation, use the samples command in IP SLA operation history configuration mode. To use the default value, use the no form of this command.
samples sample count
no samples
Syntax Description
sample count
Number of history samples that are kept in the history table for an IP SLA ICMP path-echo operation. The range is from 1 to 30.
Defaults
The default value is 16.
Command Modes
IP SLA operation history configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The samples command is supported only when you configure an IP SLA ICMP path-echo operation.
Task ID
Examples
The following example shows how to use the samples command in IP SLA ICMP Path-Echo configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp echoRP/0/RP0/CPU0:router(config-ipsla-icmp-path-echo)# historyRP/0/RP0/CPU0:router(config-ipsla-op-hist)# samples 30Related Commands
show ipsla application
To display the information for the IP SLA application, use the show ipsla application command in EXEC mode.
show ipsla application
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following sample output is from the show ipsla application command:
RP/0/RP0/CPU0:router# show ipsla applicationIP Service Level Agreement Agent Version: 1.0.0Estimated system max number of entries: 2048Number of Entries configured: 1Number of active Entries : 0Number of pending Entries : 0Number of inactive Entries : 1Supported Operation Types: 5Type of Operation: ICMP ECHOType of Operation: ICMP PATH JITTERType of Operation: ICMP PATH ECHOType of Operation: UDP JITTERType of Operation: UDP ECHONumber of configurable probes : 2047SA Agent low memory water mark: 20480 (KB)Table 12 describes the significant fields shown in the display.
Related Commands
show ipsla history
To display the history collected for all IP SLA operations or for a specified operation, use the show ipsla history command in EXEC mode.
show ipsla history [op_num]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
By default, history statistics are not collected. To have any data displayed by using the show ipsla history command, you must configure the history collection.
Table 13 lists the response return values that are used in the show ipsla history command.
If the default tabular format is used, the response return description is displayed as code in the Sense column. The Sense field is always used as a return code.
Task ID
Examples
The following sample output is from the show ipsla history command:
RP/0/RP0/CPU0:router# show ipsla history 1Point by point HistoryMultiple Lines per EntryLine 1:Entry = Entry numberLifeI = Life indexBucketI = Bucket indexSampleI = Sample indexSampleT = Sample start timeCompT = RTT (milliseconds)Sense = Response return codeLine 2 has the Target AddressEntry LifeI BucketI SampleI SampleT CompT SenseTargetAddr1 0 0 0 1134419252539 9 112.7.34.131 0 1 0 1134419312509 6 112.7.34.131 0 2 0 1134419372510 6 112.7.34.131 0 3 0 1134419432510 5 112.7.34.13Table 14 describes the significant fields shown in the display.
Related Commands
Displays the statistical errors for all the IP SLA operations or for a specified operation.
show ipsla responder statistics ports
To display the number of probes that are received or handled by the currently active ports on the responder, use the show ipsla responder statistics ports command in EXEC mode.
show ipsla responder statistics ports
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The output of the show ipsla responder statistics port command is available only for specific intervals of time in which only nonpermanent ports are being used at the responder. The reason is that the responder closes the nonpermanent ports after each operation cycle. However, if both permanent and nonpermanent ports are used, the output always contains rows for the permanent ports. The rows for the nonpermanent ports are displayed only if those nonpermanent ports are enabled at the instant the command is issued.
Task ID
Examples
The following sample output is from the show ipsla responder statistics port command:
RP/0/RP0/CPU0:router# show ipsla responder statistics portPort 12709 Local Address 12.29.11.21NumberOfProbes 2Port 12213 Local Address 12.29.11.21NumberOfProbes 1Port 55690 Local Address 12.29.11.21NumberOfProbes 376Table 15 describes the significant fields shown in the display.
show ipsla statistics
To display the operational data and the latest statistics for the IP SLA operation in tabular format, use the show ipsla statistics command in EXEC mode.
show ipsla statistics [operation-number]
Syntax Description
operation-number
(Optional) Operation for which the latest statistics are to be displayed. The range is from 1 to 2048.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The output of the show ipsla statistics command varies depending on the operation type. The following sample output is from the show ipsla statistics command for an ICMP echo operation:
RP/0/RP0/CPU0:router# show ipsla statistics 1Entry number: 1Modification time: 20:27:30.989 UTC Mon Dec 12 2005Start time : 20:27:30.992 UTC Mon Dec 12 2005Number of operations attempted: 10Number of operations skipped : 0Current seconds left in Life : 3047Operational state of entry : ActiveConnection loss occurred : FALSETimeout occurred : FALSELatest RTT (milliseconds) : 5Latest operation start time : 20:36:32.510 UTC Mon Dec 12 2005Latest operation return code : OKRTT Values:RTTAvg : 5 RTTMin: 5 RTTMax : 5NumOfRTT: 1 RTTSum: 5 RTTSum2: 25Table 16 describes the significant fields shown in the display.
Related Commands
show ipsla statistics aggregated
To display the hourly statistical errors and the hourly statistics for all the IP SLA operations or specified operation, use the show ipsla statistics aggregated command in EXEC mode.
show ipsla statistics aggregated [operation-number]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The show ipsla statistics aggregated command displays information such as the number of failed operations and the reason for failure. Unless you configured a different amount of time for the buckets command (statistics command with hourly keyword), the show ipsla statistics aggregated command displays the information collected over the past two hours.
For one-way delay and jitter operations to be computed for UDP jitter operations, the clocks on local and target devices must be synchronized using NTP or GPS systems. If the clocks are not synchronized, one-way measurements are discarded. If the sum of the source to destination (SD) and the destination to source (DS) values is not within 10 percent of the round-trip time, the one-way measurement values are assumed to be faulty, and are discarded.
Task ID
Examples
The output of the show ipsla statistics aggregated command varies depending on operation type. The following sample output shows the aggregated statistics for UDP echo operation from the show ipsla statistics aggregated command:
RP/0/RP0/CPU0:router# show ipsla statistics aggregated 1Entry number: 1Hour Index: 0Start Time Index: 21:02:32.510 UTC Mon Dec 12 2005Number of Failed Operations due to a Disconnect : 0Number of Failed Operations due to a Timeout : 0Number of Failed Operations due to a Busy : 0Number of Failed Operations due to a No Connection : 0Number of Failed Operations due to an Internal Error: 0Number of Failed Operations due to a Sequence Error : 0Number of Failed Operations due to a Verify Error : 0RTT Values:RTTAvg : 6 RTTMin: 4 RTTMax : 38NumOfRTT: 36 RTTSum: 229 RTTSum2: 2563Table 17 describes the show ipsla statistics aggregated command field descriptions.
The following sample output is from the show ipsla statistics aggregated command in which operation 10 is a UDP jitter operation:
RP/0/RP0/CPU0:router# show ipsla statistics aggregated 10Entry number: 10Hour Index: 0Start Time Index: 00:35:07.895 UTC Thu Mar 16 2006Number of Failed Operations due to a Disconnect : 0Number of Failed Operations due to a Timeout : 0Number of Failed Operations due to a Busy : 0Number of Failed Operations due to a No Connection : 0Number of Failed Operations due to an Internal Error: 0Number of Failed Operations due to a Sequence Error : 0Number of Failed Operations due to a Verify Error : 0RTT Values:RTTAvg : 14 RTTMin: 2 RTTMax : 99NumOfRTT: 70 RTTSum: 1034 RTTSum2: 60610Packet Loss Values:PacketLossSD : 0 PacketLossDS: 0PacketOutOfSequence: 0 PacketMIA : 0PacketLateArrival : 0Errors : 0 Busies : 0Jitter Values :MinOfPositivesSD: 1 MaxOfPositivesSD: 19NumOfPositivesSD: 17 SumOfPositivesSD: 65Sum2PositivesSD : 629MinOfNegativesSD: 1 MaxOfNegativesSD: 16NumOfNegativesSD: 24 SumOfNegativesSD: 106Sum2NegativesSD : 914MinOfPositivesDS: 1 MaxOfPositivesDS: 7NumOfPositivesDS: 17 SumOfPositivesDS: 44Sum2PositivesDS : 174MinOfNegativesDS: 1 MaxOfNegativesDS: 8NumOfNegativesDS: 24 SumOfNegativesDS: 63Sum2NegativesDS : 267Interarrival jitterout: 0 Interarrival jitterin: 0One Way Values :NumOfOW: 0OWMinSD : 0 OWMaxSD: 0 OWSumSD: 0OWSum2SD: 0OWMinDS : 0 OWMaxDS: 0 OWSumDS: 0OWSum2DS: 0Table 17 describes the significant fields shown in the display.
Related Commands
show ipsla statistics aggregated detail
To display the statistics distribution information that is captured for response times for all IP SLA operations or the specified operation, use the show ipsla statistics aggregated detail command in EXEC mode.
show ipsla statistics aggregated detail [operation-number]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The output of the show ipsla statistics aggregated detail command varies depending on operation type. The following sample output is from the show ipsla statistics aggregated detail command in tabular format, when the output is split over multiple lines:
RP/0/RP0/CPU0:router# show ipsla statistics aggregated detail 2Captured StatisticsMultiple Lines per EntryLine1:Entry = Entry numberStartT = Start time of entry (hundredths of seconds)Pth = Path indexHop = Hop in path indexDst = Time distribution indexComps = Operations completedSumCmp = Sum of RTT (milliseconds)Line2:SumCmp2H = Sum of RTT squared high 32 bits (milliseconds)SumCmp2L = Sum of RTT squared low 32 bits (milliseconds)TMax = RTT maximum (milliseconds)TMin = RTT minimum (milliseconds)Entry StartT Pth Hop Dst Comps SumCmpSumCmp2H SumCmp2L TMax TMin2 1134423910701 1 1 0 12 3670 1231 6 62 1134423851116 1 1 1 2 1290 2419 41 412 1134423070733 1 1 2 1 1010 1119 16 162 0 1 1 3 0 00 0 0 0Table 18 describes the significant fields shown in the display.
Related Commands
Displays the operational data for the IP SLA operation.
Displays the statistical errors for all the IP SLA operations or a specified operation.
show ipsla statistics enhanced aggregated
To display the enhanced history statistics for all collected enhanced history buckets for the specified IP SLA operation, use the show ipsla statistics enhanced aggregated command in EXEC mode.
show ipsla statistics enhanced aggregated [operation-number] [interval seconds]
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The show ipsla statistics enhanced aggregated command displays data for each bucket of enhanced history data shown individually; for example, one after the other. The number of buckets and the collection interval is set using the interval keyword, seconds argument, buckets keyword, and number-of-buckets argument.
Task ID
Examples
The output of the show ipsla statistics enhanced aggregated command varies depending on the operation type. The following sample output is from the show ipsla statistics enhanced aggregated command for the UDP echo operation:
RP/0/RP0/CPU0:router# show ipsla statistics enhanced aggregated 20Entry number: 20Interval : 300 secondsBucket : 1 (0 - 300 seconds)Start Time Index: 00:38:14.286 UTC Thu Mar 16 2006Number of Failed Operations due to a Disconnect : 0Number of Failed Operations due to a Timeout : 0Number of Failed Operations due to a Busy : 0Number of Failed Operations due to a No Connection : 0Number of Failed Operations due to an Internal Error: 0Number of Failed Operations due to a Sequence Error : 0Number of Failed Operations due to a Verify Error : 0RTT Values:RTTAvg : 2 RTTMin: 2 RTTMax : 5NumOfRTT: 5 RTTSum: 13 RTTSum2: 41Bucket : 2 (300 - 600 seconds)Start Time Index: 00:43:12.747 UTC Thu Mar 16 2006Number of Failed Operations due to a Disconnect : 0Number of Failed Operations due to a Timeout : 0Number of Failed Operations due to a Busy : 0Number of Failed Operations due to a No Connection : 0Number of Failed Operations due to an Internal Error: 0Number of Failed Operations due to a Sequence Error : 0Number of Failed Operations due to a Verify Error : 0RTT Values:RTTAvg : 2 RTTMin: 2 RTTMax : 2NumOfRTT: 1 RTTSum: 2 RTTSum2: 4Table 19 describes the significant fields shown in the display.
Related Commands
Displays the operational data for the IP SLA operation.
Displays the statistical errors for all the IP SLA operations or a specified operation.
source address
To identify the address of the source device, use the source address command in the appropriate IP SLA configuration mode. To use the best local address, use the no form of this command.
source address ipv4 address
no source address
Syntax Description
Defaults
IP SLA finds the best local address to the destination and uses it as the source address.
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
IP SLA ICMP Path-Echo configuration
IP SLA ICMP Echo configuration
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
Support was added for the IP SLA MPLS LSP Ping and IP SLA MPLS LSP Trace configuration modes.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to designate an IP address for the source address command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# source address 12.7.34.10Related Commands
source port
To identify the port of the source device, use the source port command in the appropriate IP SLA configuration mode. To use the unused port number, use the no form of this command.
source port port
no source port
Syntax Description
Defaults
IP SLA uses an unused port that is allocated by system.
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The source port command is not supported to configure ICMP operations; it is supported only to configure UDP operations.
Task ID
Examples
The following example shows how to designate a port for the source port command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# source port 11111Related Commands
start-time
To determine the time when the operation starts, use the start-time command in IP SLA schedule configuration mode. To stop the operation and place it in the default state, such as inactive, use the no form of this command.
start-time {hh:mm:ss [day | month day] | now | pending | after hh:mm:ss}
no start-time
Syntax Description
Defaults
If a month and day are not specified, the current month and day are used.
Command Modes
IP SLA schedule configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the start-time command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla schedule operation 1RP/0/RP0/CPU0:router(config-ipsla-sched)# start-time after 01:00:00
Related Commands
statistics
To set the statistics collection parameters for the operation, use the statistics command in IP SLA operation statistics configuration mode. To remove the statistics collection or use the default value, use the no form of this command.
statistics {hourly| interval seconds}
no statistics {hourly | interval seconds}
Syntax Description
Defaults
interval keyword: No default behavior or values
Command Modes
IP SLA operation statistics configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The statistics interval command is not supported for the configuration of ICMP path-echo and ICMP path-jitter operations.
Task ID
Examples
The following example shows how to set the number of hours in which statistics are maintained for the IP SLA UDP jitter operation for the statistics command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# statistics hourlyRP/0/RP0/CPU0:router(config-ipsla-op-stats)#The following example shows how to collect statistics for a specified time interval, using the statistics command in an IP SLA UDP jitter operation:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# statistics interval 60RP/0/RP0/CPU0:router(config-ipsla-op-stats)#Related Commands
tag (IP SLA)
To create a user-specified identifier for an IP SLA operation, use the tag command in the appropriate IP SLA configuration mode. To unset the tag string, use the no form of this command.
tag [text]
no tag
Syntax Description
Defaults
No tag string is configured.
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
IP SLA ICMP Path-Echo configuration
IP SLA ICMP Echo configuration
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
Support was added for the IP SLA MPLS LSP Ping and IP SLA MPLS LSP Trace configuration modes.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the tag command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# tag ipslaRelated Commands
target ipv4
To specify the IPv4 address of the target router to be used in an MPLS LSP ping or MPLS LSP trace operation, use the target ipv4 command in the appropriate IP SLA configuration mode. To unset the address, use the no form of this command.
target ipv4 destination-address destination-mask
no target ipv4
Syntax Description
Defaults
No default behavior or values
Command Modes
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the target ipv4 command to specify the IPv4 address of the target router at the end of the LSP to be tested or traced and to indicate the destination as an Label Distribution Protocol (LDP) IPv4 address. The target IPv4 address identifies the appropriate label stack associated with the LSP.
Note
An MPLS LSP ping operation tests connectivity in the LSP using verification on the specified Forwarding Equivalence Class (FEC)— in this case, LDP IPv4 prefix—between the ping origin and the egress node identified with the target ipv4 command. This test is carried out by sending an MPLS echo request along the same data path as other packets belonging to the FEC. When the ping packet reaches the end of the path, it is sent to the control plane of the egress label switching router (LSR), which then verifies that it is indeed an egress for the LSP. The MPLS echo request contains information about the LSP that is being verified.
In an MPLS network, an MPLS LSP trace operation traces LSP paths to the target router identified with the target ipv4 command. In the verification of LSP routes, a packet is sent to the control plane of each transit LSR, which performs various checks, including one that determines if it is a transit LSR for the LSP path. Each transit LSR also returns information related to the LSP being tested (that is, the label bound to the LDP IPv4 prefix).
Task ID
Examples
The following example shows how to use the target ipv4 command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp pingRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-ping)# target ipv4 192.168.1.4 255.255.255.255Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an MPLS VPN.
target traffic-eng
To specify the target MPLS traffic engineering tunnel to be used in an MPLS LSP ping or MPLS LSP trace operation, use the target traffic-eng command in the appropriate IP SLA configuration mode. To unset the tunnel, use the no form of this command.
target traffic-eng tunnel tunnel-interface
no target traffic-eng
Syntax Description
tunnel tunnel-interface
Tunnel ID of an MPLS traffic-engineering tunnel (for example, tunnel 10) configured on the router. The valid range is from 0 to 65535.
Defaults
No default behavior or values
Command Modes
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the target traffic-eng command to specify a target router and to indicate the destination as an MPLS traffic-engineering (TE) tunnel in an MPLS LSP ping or MPLS LSP trace operation. The target traffic-eng command identifies the tunnel interface and the appropriate label stack associated with the LSP to be pinged or traced. An LSP tunnel interface is the head-end of a unidirectional virtual link to a tunnel destination.
Note
An IP SLA ping operation tests connectivity in the LSP using verification on the specified Forwarding Equivalence Class (FEC)—in this case, MPLS TE tunnel—between the ping origin and the egress node identified with the target traffic-eng command. This test is carried out by sending an MPLS echo request along the same data path as other packets belonging to the tunnel. When the ping packet reaches the end of the path, it is sent to the control plane of the egress label switching router (LSR), which then verifies that it is indeed an egress for the MPLS TE tunnel. The MPLS echo request contains information about the tunnel whose LSP path is being verified.
In an MPLS network, an IP SLA trace operation traces the LSP paths to a target router identified with the target traffic-eng command. In the verification of LSP routes, a packet is sent to the control plane of each transit LSR, which performs various checks, including one that determines if it is a transit LSR for the LSP path. Each transit LSR also returns information related to the MPLS TE tunnel to see if the local forwarding information matches what the routing protocols determine as the LSP path.
MPLS traffic engineering automatically establishes and maintains LSPs across the backbone. The path that an LSP uses is determined by the LSP resource requirements and network resources, such as bandwidth. For more information on MPLS traffic-engineering tunnels, refer to MPLS Traffic Engineering and Enhancements at the following URL:
http://www.cisco.com/en/US/products/sw/iosswrel/ps1834/products_feature_guide09186a008008029b.html
Task ID
Examples
The following example shows how to use the target traffic-eng tunnel command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp traceRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-trace)# target traffic-eng tunnel 101Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an MPLS VPN.
threshold
To set the lower-limit and upper-limit values, use the threshold command in IP SLA reaction condition configuration mode. To use the default value, use the no form of this command.
threshold lower-limit value upper-limit value
no threshold lower-limit value upper-limit value
Syntax Description
Defaults
The default lower-limit is 3000 ms.
The default upper-limit is 5000 ms.
Command Modes
IP SLA reaction condition configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The threshold command is supported only when used with the react command and jitter-average and packet-loss keywords.
Task ID
Examples
The following example shows how to set the lower-limit and upper-limit values for the react command with the jitter-average keyword for the threshold command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react jitter-averageRP/0/RP0/CPU0:router(config-ipsla-react-cond)# threshold lower-limit 8000 upper-limit 10000The following example shows how to set the lower-limit and upper-limit values for the react command with the packet-loss keyword for the threshold command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react packet-loss dest-to-sourceRP/0/RP0/CPU0:router(config-ipsla-react-cond)# threshold lower-limit 8000 upper-limit 10000Related Commands
threshold type average
To take action on average values to violate a threshold, use the threshold type average command in IP SLA reaction condition configuration mode. To clear the threshold type (reaction will never happen), use the no form of this command.
threshold type average number-of-probes
no threshold type
Syntax Description
Defaults
If there is no default value, no threshold type is configured.
Command Modes
IP SLA reaction condition configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The threshold type average command is supported only when used with the react command and jitter-average, packet-loss, and rtt keywords.
Task ID
Examples
The following example shows how to set the number of probes for the react command with the jitter-average keyword for the threshold type average command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react jitter-averageRP/0/RP0/CPU0:router(config-ipsla-react-cond)# threshold type average 8The following example shows how to set the number of probes for the react command with the packet-loss keyword for the threshold type average command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react packet-loss dest-to-sourceRP/0/RP0/CPU0:router(config-ipsla-react-cond)# threshold type average 8Related Commands
threshold type consecutive
To take action after a number of consecutive violations, use the threshold type consecutive command in IP SLA reaction condition configuration mode. To clear the threshold type (reaction will never happen), use the no form of this command.
threshold type consecutive occurrences
no threshold type
Syntax Description
Defaults
No default behavior or values
Command Modes
IP SLA reaction condition configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the threshold type consecutive command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react connection-lossRP/0/RP0/CPU0:router(config-ipsla-react-cond)# threshold type consecutive 8Related Commands
threshold type immediate
To take action immediately upon a threshold violation, use the threshold type immediate command in IP SLA reaction condition configuration mode. To clear the threshold type (reaction will never happen), use the no form of this command.
threshold type immediate
no threshold type
Syntax Description
This command has no arguments or keywords.
Defaults
If there is no default value, no threshold type is configured.
Command Modes
IP SLA reaction condition configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
When the reaction conditions, such as threshold violations, are met for the monitored element, the action is immediately performed as defined by the action command.
Task ID
Examples
The following example shows how to use the threshold type immediate command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react timeoutRP/0/RP0/CPU0:router(config-ipsla-react-cond)# threshold type immediateRelated Commands
threshold type xofy
To take action upon X violations in Y probe operations, use the threshold type xofy command in IP SLA reaction condition configuration mode. To clear the threshold type (reaction will never happen), use the no form of this command.
threshold type xofy X value Y value
no threshold type
Syntax Description
Defaults
If there is no default value, no threshold type is configured.
Command Modes
IP SLA reaction condition configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the threshold type xofy command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla reaction operation 432RP/0/RP0/CPU0:router(config-ipsla-react)# react verify-errorRP/0/RP0/CPU0:router(config-ipsla-react-cond)# threshold type xofy 1 5Related Commands
timeout
To set the probe or control timeout interval, use the timeout command in the appropriate IP SLA configuration mode. To use the default value, use the no form of this command.
timeout milliseconds
no timeout
Syntax Description
milliseconds
Sets the amount of time (in milliseconds) that the IP SLA operation waits for a response from the request packet. The range is 1 to 604800000.
Defaults
The default value is 5000 ms.
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
IP SLA ICMP Path-Echo configuration
IP SLA ICMP Echo configuration
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
Support was added for the IP SLA MPLS LSP Ping and IP SLA MPLS LSP Trace configuration modes.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the timeout command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# timeout 10000Related Commands
tos
To set the type of service (ToS) in a probe packet, use the tos command in the appropriate IP SLA configuration mode. To use the default value, use the no form of this command.
tos number
no tos
Syntax Description
Defaults
The type of service number is 0.
Command Modes
IP SLA UDP Echo configuration
IP SLA UDP Jitter configuration
IP SLA ICMP Path-Jitter configuration
IP SLA ICMP Path-Echo configuration
IP SLA ICMP Echo configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
The ToS value is an 8-bit field in IP headers. The field contains information, such as precedence and ToS. The information is useful for policy routing and for features like Committed Access Rate (CAR) in which routers examine ToS values. When the type of service is defined for an operation, the IP SLA probe packet contains the configured tos value in the IP header.
Task ID
Examples
The following example shows how to use the tos command in IP SLA UDP Jitter configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp jitterRP/0/RP0/CPU0:router(config-ipsla-udp-jitter)# tos 60Related Commands
ttl
To specify the time-to-live (TTL) value in the MPLS label of echo request packets, use the ttl command in the appropriate IP SLA configuration mode. To return to the default value, use the no form of this command.
ttl time-to-live
no ttl
Syntax Description
Defaults
For an MPLS LSP ping operation, the default time-to-live value is 255.
For an MPLS LSP trace operations, the default time-to-live value is 30.
Command Modes
IP SLA MPLS LSP Ping configuration
IP SLA MPLS LSP Trace configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the ttl command to set the maximum number of hops allowed for echo request packets in an MPLS LSP ping or MPLS LSP trace operation. Note that the number of possible hops differs depending the type of IP SLA operation:
•
•
Task ID
Examples
The following example shows how to use the ttl command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp pingRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-ping)# ttl 200Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
Traces the hop-by-hop route of an LSP path in an MPLS VPN.
type icmp echo
To use the ICMP echo operation type, use the type icmp echo command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type icmp echo
no type icmp echo
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
IP SLA operation configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the type icmp echo command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type icmp echoRP/0/RP0/CPU0:router(config-ipsla-icmp-echo)#Related Commands
type icmp path-echo
To use the ICMP path-echo operation type, use the type icmp path-echo command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type icmp path-echo
no type icmp path-echo
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
IP SLA operation configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the type icmp path-echo command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type icmp path-echoRP/0/RP0/CPU0:router(config-ipsla-icmp-path-echo)#Related Commands
type icmp path-jitter
To use the ICMP path-jitter operation type, use the type icmp path-jitter command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type icmp path-jitter
no type icmp path-jitter
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
IP SLA operation configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the type icmp path-jitter command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type icmp path-jitterRP/0/RP0/CPU0:router(config-ipsla-icmp-path-jitter)#Related Commands
type mpls lsp ping
To verify the end-to-end connectivity of a label switched path (LSP) and the integrity of an MPLS network, use the type mpls lsp ping command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type mpls lsp ping
no type mpls lsp ping
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
IP SLA operation configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the type mpls lsp ping command to configure parameters for an IP SLA LSP ping operation. After you enter the command, you enter IP SLA MPLS LSP Ping configuration mode.
An MPLS LSP ping operation tests connectivity between routers along an LSP path in an MPLS network and measures round-trip delay of the LSP by using an echo request and echo reply.
The MPLS LSP ping operation verifies LSP connectivity by using one of the supported Forwarding Equivalence Class (FEC) entities between the ping origin and egress node of each FEC. The following FEC types are supported for an MPLS LSP ping operation:
•
•
Task ID
Examples
The following example shows how to use the type mpls lsp ping command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp pingRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-ping)#Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Traces the hop-by-hop route of an LSP path in an MPLS VPN.
type mpls lsp trace
To trace LSP paths and localize network faults in an MPLS network, use the type mpls lsp trace command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type mpls lsp trace
no mpls lsp trace
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
IP SLA operation configuration
Command History
Usage Guidelines
To For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the type mpls lsp trace command to configure parameters for an IP SLA LSP trace operation. After you enter the command, you enter IP SLA MPLS LSP Trace configuration mode.
An MPLS LSP trace operation traces the hop-by-hop route of LSP paths to a target router and measures the hop-by-hop round-trip delay for IPv4 LDP prefixes and TE tunnel FECs in an MPLS network. Echo request packets are sent to the control plane of each transit label switching router (LSR). A transit LSR performs various checks to determine if it is a transit LSR for the LSP path. A trace operation allows you to troubleshoot network connectivity and localize faults hop-by-hop.
In an MPLS LSP trace operation, each transit LSR returns information related to the type of Forwarding Equivalence Class (FEC) entity that is being traced. This information allows the trace operation to check if the local forwarding information matches what the routing protocols determine as the LSP path.
An MPLS label is bound to a packet according to the type of FEC used for the LSP. The following FEC types are supported for an MPLS LSP trace operation:
•
•
Task ID
Examples
The following example shows how to use the type mpls lsp trace command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type mpls lsp traceRP/0/RP0/CPU0:router(config-ipsla-mpls-lsp-trace)#Related Commands
Configures an IP SLA operation.
Schedules an IP SLA operation.
Tests connectivity in an LSP path in an MPLS VPN.
type udp echo
To use the UDP echo operation type, use the type udp echo command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type udp echo
no type udp echo
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
IP SLA operation configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to use the type udp echo command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipsla operation 1RP/0/RP0/CPU0:router(config-ipsla-op)# type udp echoRP/0/RP0/CPU0:router(config-ipsla-udp-echo)#Related Commands
type udp jitter
To use the UDP jitter operation type, use the type udp jitter command in IP SLA operation configuration mode. To remove the operation, use the no form of this command.
type udp jitter
no
