-
Cisco IOS XR System Monitoring Command Reference, Release 3.6
-
Preface
-
Alarm Management and Logging Correlation Commands on Cisco IOS XR Software
-
Embedded Event 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 mpls lsp-monitor lpd
show ipsla mpls lsp-monitor scan-queue
show ipsla mpls lsp-monitor summary
show ipsla responder statistics ports
show ipsla statistics aggregated
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 in Cisco IOS XR System Management Configuration Guide.
access-list
To specify an access-list name to filter provider edge (PE) addresses to restrict operations that are automatically created by MPLS LSP monitor (MPLSLM) instance, use the access-list command in the appropriate configuration mode. To return to the default value, use the no form of this command.
access-list acl-name
no access-list
Syntax Description
Defaults
No access list is configured by default.
Command Modes
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configurationCommand History
Release 3.6.0
This command was introduced on the Cisco CRS-1 and Cisco XR 12000 Series Router.
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.
Access-list changes are processed before the scan interval expires to display a planned list of changes in the scan-queue.
Note
There is no verification check between the access list and the IPSLA configuration.
Task ID
Examples
The following example shows how to use the access-list command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipslaRP/0/RP0/CPU0:router(config-ipsla)# mpls lsp-monitorRP/0/RP0/CPU0:router(config-ipsla-mplslm)# monitor 1RP/0/RP0/CPU0:router(config-ipsla-mplslm-def)# type mpls lsp pingRP/0/RP0/CPU0:router(config-ipsla-mplslm-lsp-ping)# access-list ipslaRelated Commands
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 the appropriate 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
IP SLA MPLS LSP monitor reaction configurationCommand 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.
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.
When the action command is used from IP SLA MPLS LSP monitor reaction configuration mode, only the logging keyword is available.
If the action command is used in IP SLA operation mode, the action defined applies to the specific operation being configured. If the action command is used in IP SLA MPLS LSP monitor mode, the action defined applies to all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
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)# ipslaRP/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 loggingThe following example shows how to use the action command from the IP SLA MPLS LSP monitor reaction configuration mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipslaRP/0/RP0/CPU0:router(config-ipsla)# mpls lsp-monitorRP/0/RP0/CPU0:router(config-ipsla-mplslm)# reaction monitor 1RP/0/RP0/CPU0:router(config-ipsla-mplslm-react)# react connection-lossRP/0/RP0/CPU0:router(config-ipsla-mplslm-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. 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.
Release 3.5.0
No modification.
Release 3.6.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)# ipslaRP/0/RP0/CPU0:router(config-ipsla)# schedule operation 1RP/0/RP0/CPU0:router(config-ipsla-sched)# ageout 3600Related Commands
buckets (history)
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. Range is 1 to 60.
Defaults
The default value is 15 buckets.
Command Modes
IP SLA operation history 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.
The buckets command is supported only to configure the following operations:
•
•
•
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)# ipslaRP/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 (statistics hourly)
To set the number of hours for which statistics are kept, use the bucket command in the appropriate configuration mode. To use the default value, use the no form of this command.
buckets hours
no buckets
Syntax Description
Defaults
The default value is 2.
Command Modes
IP SLA operation statistics configuration
IP SLA MPLS LSP monitor statistics configurationCommand 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.
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)# ipslaRP/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 (statistics interval)
To specify the maximum number of 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. Range is 1 to 100. Default is 100.
Defaults
No default behavior or values
Command Modes
IP SLA operation statistics 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.
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)# ipslaRP/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 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 configurationCommand 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.
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)#ipslaRP/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 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 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 ICMP path-echo configuration
IP SLA ICMP echo configuration
IP SLA MPLS LSP ping configuration
IP SLA MPLS LSP monitor ping configurationCommand 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.
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)# ipslaRP/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 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 configurationCommand 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.
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)# ipslaRP/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 the appropriate 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 configurationCommand 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.
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)# ipslaRP/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
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)# ipslaRP/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. Range is 1 to 100. Default is 20.
Defaults
The default value is 20.
Command Modes
IP SLA operation statistics 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.
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)# ipslaRP/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 command in the appropriate 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 request 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
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configurationCommand 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 request packet. You can configure different MPLS EXP levels for different operations to create differentiated levels of response.
If the exp command is used in IP SLA operation mode, it acts on the headers of echo request packets for the specific operation being configured. If the exp command is used in IP SLA MPLS LSP monitor mode, it acts on the headers of echo request packets for all operations associated with the monitored provider edge (PE) routers. This configuration is inherited by all LSP operations that are created automatically.
Task ID
Examples
The following example shows how to use the exp command:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipslaRP/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 5The following example shows how to use the exp command in MPLS LSP monitor mode:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# ipslaRP/0/RP0/CPU0:router(config-ipsla)# mpls lsp-monitorRP/0/RP0/CPU0:router(config-ipsla-mplslm)# monitor 1RP/0/RP0/CPU0:router(config-ipsla-mplslm-def)# type mpls lsp traceRP/0/RP0/CPU0:router(config-ipsla-mplslm-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
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)# ipslaRP/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 the appropriate 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
IP SLA MPLS LSP monitor ping configuration
IP SLA MPLS LSP monitor trace configurationCommand 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.
This command can be accessed through the IP SLA operation mode or through the IP SLA MPLS LSP monitor mode.
Use the force explicit-null command to force an unsolicited explicit null label to be ad
