Table Of Contents
Service Assurance Agent Commands
buckets-of-history-kept
distributions-of-statistics-kept
filter-for-history
frequency
hops-of-statistics-kept
http-raw-request
hours-of-statistics-kept
lives-of-history-kept
lsr-path
owner
paths-of-statistics-kept
request-data-size
response-data-size
rtr
rtr key-chain
rtr low-memory
rtr reaction-configuration
rtr reaction-trigger
rtr reset
rtr responder
rtr schedule
samples-of-history-kept
show rtr application
show rtr authentication
show rtr collection-statistics
show rtr configuration
show rtr distributions-statistics
show rtr history
show rtr operational-state
show rtr reaction-trigger
show rtr responder
show rtr totals-statistics
statistics-distribution-interval
tag
threshold
timeout
tos
type dhcp
type dlsw
type dns
type echo
type http
type jitter
type pathEcho
type tcpConnect
type udpEcho
verify-data
Service Assurance Agent Commands
This chapter describes commands used to monitor network performance using Cisco Service Assurance Agent (SA Agent).
For SA Agent configuration tasks and examples, refer to the "Network Monitoring Using Cisco Service Assurance Agent" chapter in the Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.1.
buckets-of-history-kept
To set the number of history buckets that are kept during the operation lifetime of the SA Agent, use the buckets-of-history-kept RTR configuration command. Use the no form of this command to return to the default value.
buckets-of-history-kept size
no buckets-of-history-kept
Syntax Description
size
|
Number of history buckets kept during the lifetime of the operation. The default is 50 buckets.
|
Defaults
50 buckets
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
History collection and statistics capturing is enabled for the following SA Agent operations: ICMP Echo, SNA Echo, ICMP PathEcho, UDP Echo, TcpConnect, DNS, and DLSW. History collection is not supported for HTTP and Jitter (UDP+) operations.
By default, history is not collected. When a problem arises where history is useful (for example, a large number of timeouts are occurring), you can configure the lives-of-history-kept RTR configuration command to collect history. You can optionally adjust the buckets-of-history-kept, filter-for-history, and samples-of-history-kept RTR configuration commands.
When the number of buckets reaches the size specified, no further history for this life is stored.
Note
Collecting history increases the RAM usage. Only collect history when you think there is a problem in the network. For general network response time information, use the statistics gathering feature of SA Agent.
If history is collected, each bucket contains one or more history entries from the operation. When the operation type is pathEcho, an entry is created for each hop along the path that the operation takes to reach its destination. The type of entry stored in the history table is controlled by the filter-for-history RTR configuration command. The total number of entries stored in the history table is controlled by the combination of samples-of-history-kept, buckets-of-history-kept, and lives-of-history-kept RTR configuration commands.
Each time the SA Agent starts an operation, a new bucket is created until the number of history buckets matches the specified size or the operation's lifetime expires. History buckets do not wrap. The operation's lifetime is defined by the rtr schedule global configuration command. The operation starts an SA Agent operation based on the seconds specified by the frequency RTR configuration command.
Examples
The following example configures operation 1 to keep 25 history buckets during the lifetime of the operation lifetime:
type echo protocol ipIcmpEcho 172.16.161.21
buckets-of-history-kept 25
Related Commands
Command
|
Description
|
filter-for-history
|
Defines the type of information kept in the history table for the SA Agent operation.
|
lives-of-history-kept
|
Sets the number of lives maintained in the history table for the SA Agent operation.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
rtr schedule
|
Configures the time parameters for an SA Agent operation.
|
samples-of-history-kept
|
Sets the number of entries kept in the history table per bucket for the SA Agent operation.
|
distributions-of-statistics-kept
To set the number of statistic distributions kept per hop during the lifetime operation of the SA Agent, use the distributions-of-statistics-kept RTR configuration command. Use the no form of this command to return to the default value.
distributions-of-statistics-kept size
no distributions-of-statistics-kept
Syntax Description
size
|
Number of statistic distributions kept per hop. The default is 1 distribution.
|
Defaults
1 distribution
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
In most situations, you do not need to change the statistic distribution size for the SA Agent. Only change the size when distributions are needed (for example, when performing statistical modeling of your network).
Note
Increasing the distributions also increases the RAM usage. The total number of statistics distributions captured will be: the value of distributions-of-statistics-kept times the value of hops-of-statistics-kept times the value of paths-of-statistics-kept times the value of hours-of-statistics-kept.
When the number of distributions reaches the size specified, no further distribution information is stored.
Examples
The following example sets the distribution to 5 and the distribution interval to 10 ms. This means that the first distribution will contain statistics from 0 to 9 ms, the second distribution will contain statistics from 10 to 19 ms, the third distribution will contain statistics from 20 to 29 ms, the fourth distribution will contain statistics from 30 to 39 ms, and the fifth distribution will contain statistics from 40 ms to infinity.
type echo protocol ipIcmpEcho 172.16.161.21
distributions-of-statistics-kept 5
statistics-distribution-interval 10
Related Commands
Command
|
Description
|
hops-of-statistics-kept
|
Set the number of hops for which statistics are maintained per path for the SA Agent operation.
|
hours-of-statistics-kept
|
Sets the number of hours for which statistics are maintained for the SA Agent operation.
|
paths-of-statistics-kept
|
Sets the number of paths for which statistics are maintained per hour for the SA Agent operation.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
statistics-distribution-interval
|
Sets the time interval for each statistics distribution kept for the SA Agent.
|
filter-for-history
To define the type of information kept in the history table for an SA Agent operation, use the filter-for-history RTR configuration command. Use the no form of this command to return to the default value.
filter-for-history {none | all | overThreshold | failures}
no filter-for-history {none | all | overThreshold | failures}
Syntax Description
none
|
No history kept. This is the default.
|
all
|
All operation operations attempted are kept in the history table.
|
overThreshold
|
Only packets that are over the threshold are kept in the history table.
|
failures
|
Only packets that fail for any reason are kept in the history table.
|
Defaults
No default behavior or values.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Use the filter-for-history command to control what gets stored in the history table for the SA Agent. To control how much history gets saved in the history table, use the lives-of-history-kept, buckets-of-history-kept, and the samples-of-history-kept RTR configuration commands.
A operation can collect history and capture statistics. By default, history is not collected. When a problem arises where history is useful (for example, a large number of timeouts are occurring), you can configure the lives-of-history-kept command to collect history.
Note
Collecting history increases the RAM usage. Only collect history when you think there is a problem. For general network response time information, use statistics.
Examples
In the following example, only operation packets that fail are kept in the history table:
type echo protocol ipIcmpEcho 172.16.161.21
filter-for-history failures
Related Commands
Command
|
Description
|
buckets-of-history-kept
|
Sets the number of history buckets that are kept during the lifetime of the SA Agent.
|
lives-of-history-kept
|
Sets the number of lives maintained in the history table for the SA Agent operation.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
samples-of-history-kept
|
Sets the number of entries kept in the history table per bucket for the SA Agent operation.
|
frequency
To set the rate at which the SA Agent operation starts a response time operation, use the frequency RTR configuration command. Use the no form of this command to return to the default value.
frequency second
no frequency
Syntax Description
second
|
Number of seconds between the operation's SA Agent operations. The default value is 60 seconds.
|
Defaults
60 seconds
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
If the operation takes longer to execute the current SA Agent operation than the specified frequency value, a statistics counter called busy is incremented rather than starting a second operation.
Caution 
For normal operation, do not set the frequency value to less than 60 seconds for the following reasons: It is not needed when keeping statistics (the default), and it can slow down the WAN because of the potential overhead that numerous operations can cause.
The value specified for the frequency command cannot be less than the value specified for the timeout RTR configuration command.
Examples
The following example configures the operation to execute an SA Agent operation every 90 seconds:
type echo protocol ipIcmpEcho 172.16.1.176
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
timeout
|
Sets the amount of time the SA Agent operation waits for a response from its request packet.
|
hops-of-statistics-kept
To set the number of hops for which statistics are maintained per path for the SA Agent operation, use the hops-of-statistics-kept RTR configuration command. Use the no form of this command to return to the default value.
hops-of-statistics-kept size
no hops-of-statistics-kept
Syntax Description
size
|
Number of hops for which statistics are maintained per path. The default is 16 hops for type pathEcho and 1 hop for type echo.
|
Defaults
16 hops for type pathEcho
1 hop for type echo
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
One hop is the passage of a timed packet from this router to another network device. The other network device (is assumed to) be a device along the path to the destination (including the destination) when the operation type is pathEcho, or just the destination when the type is echo.
When the number of hops reaches the size specified, no further hop information is stored.
Examples
The following example monitors the statistics of operation 2 for only 10 hops:
type pathecho protocol ipIcmpEcho 172.16.1.177
hops-of-statistics-kept 10
Related Commands
http-raw-request
To explicitly specify the options for a GET request for an SA Agent HTTP operation, use the http-raw-request command in RTR configuration mode.
http-raw-request
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(5)T
|
This command was introduced.
|
Usage Guidelines
Using the http-raw-request puts you in HTTP Raw configuration mode, indicated by the (config-rtr-http) router prompt.
The http-raw-request command should follow the type http operation raw command. Use the raw-request option when you wish to explicitly specify the content of an HTTP request. Use HTTP 1.0 commands in HTTP Raw configuration mode.
The SA Agent will specify the content of an HTTP request for you if you use the type http operation get command. SA Agent will send the HTTP request, receive the reply, and report RTT statistics (including the size of the page returned).
Examples
In the following example, SA Agent operation 6 is created an configured as an HTTP operation. The HTTP "get" command is explicitly specified:
Router(config-rtr)# type http operation raw url http://www.cisco.com
Router(config-rtr)# http-raw-request
Router(config-rtr-http)# GET /index.html HTTP/1.0\r\n
Router(config-rtr-http)# \r\n
Router(config-rtr-http)# exit
Router(config)# rtr schedule 6 start-time now
Related Commands
Command
|
Description
|
type http
|
Configures an HTTP SA Agent operation.
|
hours-of-statistics-kept
To set the number of hours for which statistics are maintained for the SA Agent operation, use the hours-of-statistics-kept RTR configuration command. Use the no form of this command to return to the default value.
hours-of-statistics-kept hours
no hours-of-statistics-kept
Syntax Description
hours
|
Number of hours that the router maintains statistics. The default is 2 hours.
|
Defaults
2 hours
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
When the number of hours exceeds the specified value, the statistics table wraps (that is, the oldest information is replaced by newer information).
This command sets the amount of time statistics are kept for use by the show rtr collection-statistics command and show rtr distribution command.
Examples
The following example maintains 3 hours of statistics for SA Agent operation 2:
type pathecho protocol ipIcmpEcho 172.16.1.177
hours-of-statistics-kept 3
Related Commands
Command
|
Description
|
distributions-of-statistics-kept
|
Sets the number of statistic distributions kept per hop during the lifetime of the SA Agent.
|
hops-of-statistics-kept
|
Set the number of hops for which statistics are maintained per path for the SA Agent operation.
|
paths-of-statistics-kept
|
Sets the number of paths for which statistics are maintained per hour for the SA Agent operation.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
statistics-distribution-interval
|
Sets the time interval for each statistic distribution kept for the SA Agent.
|
lives-of-history-kept
To set the number of lives maintained in the history table for the SA Agent operation, use the lives-of-history-kept RTR configuration command. Use the no form of this command to return to the default value.
lives-of-history-kept lives
no lives-of-history-kept
Syntax Description
lives
|
Number of lives maintained in the history table for the operation.
|
Defaults
0 lives
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
The default value (0 lives) means that history is not collected for the operation. To disable history collection, use the default value for the lives-of-history-kept command rather than the filter-for-history none RTR configuration command. The lives-of-history-kept command disables history collection before the operation's operation is attempted, and the filter-for-history command checks for history inclusion after the operation's operation attempt is made.
When the number of lives exceeds the specified value, the history table wraps (that is, the oldest information is replaced by newer information).
When an operation makes a transition from pending to active, a life starts. When the life of an operation ends, the operation makes a transition from active to pending.
Examples
The following example maintains the history for 5 lives of operation 1:
type echo protocol ipIcmpEcho 172.16.1.176
Related Commands
Command
|
Description
|
buckets-of-history-kept
|
Sets the number of history buckets that are kept during the lifetime of the SA Agent.
|
filter-for-history
|
Defines the type of information kept in the history table for the SA Agent operation.
|
rtr
|
Enters RTR configuration mode.
|
samples-of-history-kept
|
Sets the number of entries kept in the history table per bucket for the SA Agent operation.
|
lsr-path
To define a loose source routing (LSR) path for a Cisco SA Agent IP echo operation, use the lsr-path RTR configuration command. Use the no form of this command to remove the definition.
lsr-path {name | ip addr} [{name | ip addr}] ...
no lsr-path
Syntax Description
name
|
IP host name.
|
ip addr
|
IP address.
|
Defaults
LSR path is disabled.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(3)T
|
This command was introduced.
|
Usage Guidelines
The maximum number of hops available is 8 when an LSR path is configured.
Examples
In the following example, LSR is defined for the echo probe with IP address 172.16.1.176:
type echo protocol ipIcmpEcho 172.16.1.176
lsr-path 172.18.4.149 172.18.26.155
Related Commands
Command
|
Description
|
rtr
|
Specifies an identification for an SA Agent operation and begins RTR configuration mode.
|
owner
To configure the Simple Network Management Protocol (SNMP) owner of an SA Agent operation, use the owner RTR configuration command. Use the no form of this command to return to the default value.
owner text
no owner
Syntax Description
text
|
Name of the SNMP owner from 0 to 255 ASCII characters. The default is none.
|
Defaults
No owner is specified.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
The owner name contains one or more of the following: ASCII form of the network management station's transport address, network management station name (that is, the domain name), and network management personnel's name, location, or phone number. In some cases, the agent itself will be the owner of the operation. In these cases, the name can begin with "agent."
Examples
The following example sets the owner of operation 1 to 172.16.1.189 cwb.cisco.com John Doe RTP 555-1212:
type echo protocol ipIcmpEcho 172.16.1.176
owner 172.16.1.189 cwb.cisco.com John Doe RTP 555-1212
Related Commands
Command
|
Description
|
rtr
|
Enters RTR configuration mode.
|
paths-of-statistics-kept
To set the number of paths for which statistics are maintained per hour for the SA Agent operation, use the paths-of-statistics-kept RTR configuration command. Use the no form of this command to return to the default value.
paths-of-statistics-kept size
no paths-of-statistics-kept
Syntax Description
size
|
Number of paths for which statistics are maintained per hour. The default is 5 paths for type pathEcho and 1 path for type echo.
|
Defaults
5 paths for type pathEcho
1 path for type echo
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
A path is the route the request packet of the operation takes through the network to get to its destination. The operation may take a different path to reach its destination for each SA Agent operation.
When the number of paths reaches the size specified, no further path information is stored.
Examples
The following example maintains statistics for only 3 paths for operation 2:
type pathEcho protocol ipIcmpEcho 172.16.1.177
paths-of-statistics-kept 3
Related Commands
request-data-size
To set the protocol data size in the payload of the SA Agent operation's request packet, use the request-data-size RTR configuration command. Use the no form of this command to return to the default value.
request-data-size byte
no request-data-size
Syntax Description
byte
|
Size of the protocol data in the payload of the request packet of the operation. Range is 0 to the maximum of the protocol. The default is 1 byte.
|
Defaults
1 byte
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
When the protocol name has the suffix "appl," the packet uses both a request and respond data size (see the response-data-size RTR configuration command), and the data size is 12 bytes smaller than the normal payload size (this 12 bytes is the ARR Header used to control send and data response sizes).
Examples
The following example sets the request packet size to 40 bytes for operation 3:
type echo protocol snalu0echoappl cwbc0a
Related Commands
Command
|
Description
|
response-data-size
|
Sets the protocol data size in the payload of the SA Agent operation's response packet.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
response-data-size
To set the protocol data size in the payload of an SA Agent operation's response packet, use the response-data-size RTR configuration command. Use the no form of this command to return to the default value.
response-data-size byte
no response-data-size
Syntax Description
byte
|
Size of the protocol data in the payload in the operation's response packet. For "appl" protocols, the default is 0 bytes. For all others, the default is the same value as the request-data-size.
|
Defaults
0 bytes
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
The response-data-size command is only applicable for the following operations:
•
type echo protocol snaLU0EchoAppl
•
type echo protocol snaLU2EchoAppl
•
type pathEcho protocol snaLU0EchoAppl
•
type pathEcho protocol snaLU2EchoAppl
Note that these protocols are defined with the type command that end in "appl" (for example, snalu0echoappl). When the protocol ends in "appl," the response data size is 12 bytes smaller than normal payload size.
Examples
The following example configures the response packet size of snaLU0 Echo operation 3 to 1440 bytes:
type echo protocol snalu0echoappl cwbc0a
Related Commands
Command
|
Description
|
request-data-size
|
Sets the protocol data size in the payload of the SA Agent operation's request packet.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
rtr
To begin configuring an SA Agent operation by entering RTR configuration mode, use the rtr command in global configuration mode. Use the no form of this command to remove all configuration information for an operation, including the schedule of the operation, reaction configuration, and reaction triggers.
rtr op-number
no rtr op-number
Syntax Description
op-number
|
Operation number used for the identification of the SA Agent operation you wish to configure.
|
Defaults
None
Command Modes
Global configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
The rtr command is used to configure Cisco Service Assurance Agent (SA Agent) operations. Use this command to specify an identification number for the operation you are about to configure. After you enter this command, you will enter the RTR configuration mode, indicated by the (config-rtr) router prompt. The "Related Commands" table lists the commands you can use in RTR configuration mode.
For detailed configuration information of the Cisco SA Agent feature in Cisco IOS, see the "Monitoring the Router and Network" chapter in the Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.1.
SA Agent allows a maximum of 500 operations.
Debugging is supported only on the first 32 operation numbers.
Note
After you schedule an operation with the rtr schedule global configuration command, you cannot modify the configuration of the operation. To modify the configuration of the operation after it is scheduled, use the no rtr command. You can now reenter the operation's configuration with the rtr command.
After you configure a operation, you must schedule the operation. For information on scheduling a operation, refer to the rtr schedule global configuration command. You can also optionally set reaction triggers for the operation. For information on reaction triggers, refer to the rtr reaction-configuration and rtr reaction-trigger global configuration commands.
To display the current configuration settings of the operation, use the show rtr configuration EXEC command.
Examples
In the following example, operation 1 is configured to perform end-to-end response time operations using an SNA LU Type 0 connection with the host name cwbc0a. Only the type RTR configuration command is required; all others are optional.
Router(config-rtr)# type echo protocol snalu0echoappl cwbc0a
Router(config-rtr)# request-data-size 40
Router(config-rtr)# response-data-size 1440
Note
If operation 1 already existed and it has not been scheduled, you are placed into RTR configuration command mode. If the operation already exists and has been scheduled, this command will fail.
Related Commands
Command
|
Description
|
buckets-of-history-kept
|
Sets the number of history buckets that are kept during a SAA operation's lifetime.
|
distributions-of-statistics-kept
|
Sets the number of statistic distributions kept per hop during a RTR operation's lifetime.
|
filter-for-history
|
Defines the types of information to be kept in the history table for RTR operations.
|
frequency
|
Sets the frequency at which the operation should execute.
|
hops-of-statistics-kept
|
Sets the number of hops for which statistics are maintained per path for the RTR probe.
|
hours-of-statistics-kept
|
Sets the number of hours for which statistics are maintained for RTR operations.
|
lives-of-history-kept
|
Sets the number of lives maintained in the history table for an RTR operation.
|
lsr path
|
Specifies the path on which to measure the ICMP echo response time.
|
owner
|
Configures the SNMP owner of an SA Agent operation.
|
paths-of-statistics-kept
|
Sets the number of paths for which statistics are maintained per hour for an RTR operation.
|
request-data-size
|
Sets the protocol data size in the payload of an operation's request packet.
|
response-data-size
|
Sets the protocol data size in the payload of an operation's response packet.
|
samples-of-history-kept
|
Sets the number of entries kept in the history table for an RTR operation.
|
statistics-distribution-interval
|
Sets the time interval for each statistical distribution.
|
tag
|
Logically links operations together in a group.
|
threshold
|
Sets the rising threshold (hysteresis) that generates a reaction event and stores history information for the probe.
|
type
|
Configures an RTR operation type.
|
type dlsw
|
Configures a DLSw RTR operation.
|
type tcpConnect
|
Defines an RTR tcpConnect operation.
|
timeout
|
Sets the amount of time the operation waits for a response from its request packet.
|
tos
|
Defines the IP ToS for request packets.
|
verify-data
|
Checks each operation response for corruption.
|
rtr key-chain
To enable SA Agent control message authentication and specify an MD5 key chain, use the rtr key-chain global configuration command. Use the no form of this command to remove control message authentication.
rtr key-chain name
no rtr key-chain
Syntax Description
name
|
Name of MD5 key chain.
|
Defaults
None
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(3)T
|
This command was introduced.
|
Usage Guidelines
The authentication configuration on the SA Agent collector and SA Agent Responder must be the same. Both sides must configure the same key chain or both sides must not use authentication.
Examples
In the following example, the SA Agent control message uses MD5 authentication, and the key chain name is CSAA:
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
rtr low-memory
To specify how much unused memory must be available to allow SA Agent configuration, use the rtr low-memory global configuration command. To remove the type configuration for the operation, use the no form of this command.
rtr low-memory value
no rtr low-memory
Syntax Description
value
|
Specifies amount of memory, in bytes, that must be available to configure SA Agent (RTR). The range is from 0 to the maximum amount of free memory bytes available.
|
Defaults
The default value is 25 percent of the memory available on the system.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(5)T
|
This command was introduced.
|
Usage Guidelines
The rtr low-memory command allows the user to specify the amount of memory that the SA Agent can use. If the amount of available free memory falls below the value specified in the rtr low-memory command, then the SA Agent will not allow new operations to be configured. If this command is not used, the default low-memory value is 25 percent. This means that if 75 percent of system memory has been utilized you will not be able to configure any SA Agent characteristics.
The value of the rtr low-memory command should not exceed the amount of free memory available on the system. To determine the amount of free memory available on the system, usethe show memory EXEC command.
Examples
In the following example, the router is configured so that no less than 2 MB of memory will be free for RTR configuration:
Related Commands
Command
|
Description
|
rtr
|
Specifies an identification number for an operation and enters RTR configuration mode.
|
show memory
|
Displays statistics about memory, including memory-free pool statistics.
|
rtr reaction-configuration
To configure certain actions to occur based on events under the control of the SA Agent, use the rtr reaction-configuration global configuration command. Use the no form of this command to return to the default values of the operation.
rtr reaction-configuration operation [connection-loss-enable] [timeout-enable]
[threshold-falling milliseconds] [threshold-type option] [action-type option]
no rtr reaction-configuration operation
Syntax Description
operation
|
Number of the SA Agent operation to configure.
|
connection-loss-enable
|
(Optional) Enable checking for connection loss in connection-oriented protocols. The default is disabled.
|
timeout-enable
|
(Optional) Enable checking for response time reporting operation timeouts based on the timeout value configured for the operation with the timeout RTR configuration command. The default is disabled.
|
threshold-falling milliseconds
|
(Optional) Set the falling threshold (standard RMON-type hysteresis mechanism) in milliseconds. When the falling threshold is met, generate a resolution reaction event. The rising of the operation over threshold is set with the threshold RTR configuration command. The default value is 3000 ms.
|
threshold-type option
|
(Optional) Specify the algorithm used by the SA Agent to calculate over and falling threshold violations. Option can be one of the following keywords:
• never—Do not calculate threshold violations (the default).
• immediate—When the response time exceeds the rising over threshold or drops below the falling threshold, immediately perform the action defined by action-type.
• consecutive [occurrences]—When the response time exceeds the rising threshold consecutively five times or drops below the falling threshold consecutively five times, perform the action defined by action-type. Optionally specify the number of consecutive occurrences. The default is 5.
• xofy [x-value y-value]—When the response time exceeds the rising threshold five out of the last five times or drops below the falling threshold five out of the last five times, perform the action defined by action-type. Optionally specify the number of violations that must occur and the number that must occur within a specified number. The default is 5 for both x-value and y-value.
• average [attempts]—When the average of the last five response times exceeds the rising threshold or when the average of the last five response times drops below the falling threshold, perform the action defined by action-type. Optionally specify the number of operations to average. The default is the average of the last five response time operations. For example: if the threshold of the operation is 5000 ms and the last three attempts results of the operation are 6000, 6000, and 5000 ms, the average would be 6000 + 6000 + 5000=17000/3 > 5000, thus violating the 5000-ms threshold.
|
action-type option
|
(Optional) Specify what action or combination of actions the operation performs when you configure connection-loss-enable or timeout-enable, or threshold events occur. For the action-type to occur for threshold events, the threshold-type must be defined to anything other than never. Option can be one of the following keywords:
• none—No action is taken.
• trapOnly—Send an SNMP trap on both over and falling threshold violations.
• nmvtOnly—Send an SNA NMVT Alert on over threshold violation and an SNA NMVT Resolution on falling threshold violations.
• triggerOnly—Have one or more target operation's operational state make the transition from "pending" to "active" on over (and falling) threshold violations. The target operations are defined with the rtr reaction-trigger command. A target operation will continue until its life expires as specified by the target operation's life value configured with the rtr schedule global configuration command. A triggered target operation must finish its life before it can be triggered again.
• trapAndNmvt—Send a combination of trapOnly and nmvtOnly.
• trapAndTrigger—Send a combination of trapOnly and triggerOnly.
• nmvtAndTrigger—Send a combination of nmvtOnly and triggerOnly.
• trapNmvtAndTrigger—Send a combination of trapOnly, nmvtOnly, and triggerOnly.
|
Defaults
No reactions are generated.
Command Modes
Global configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Triggers are used for diagnostics purposes and are not used in normal operation.
You can use triggers to assist you in determining where delays are happening in the network when excessive delays are being seen on an end-to-end basis.
The reaction applies only to attempts to the target (that is, attempts to any hops along the path in pathEcho do not generate reactions).
Note
Keywords are not case sensitive and are shown in mixed case for readability only.
Examples
In the following example, operation 19 sends an SNMP trap when there is an over or falling threshold violation:
rtr reaction-configuration 19 threshold-type immediate action-type trapOnly
Figure 1 shows that an alert (rising trap) would be issued immediately when the response time exceeds the rising threshold and a resolution (falling trap) would be issued immediately when the response time drops below the falling threshold.
Figure 1 Example of Rising and Falling Thresholds
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
rtr reaction-trigger
|
Defines a second SA Agent operation to make the transition from a pending state to an active state when one of the trigger action-type options are defined with the rtr reaction-configuration global configuration command.
|
threshold
|
Sets the rising threshold (hysteresis) that generates a reaction event and stores history information for the SA Agent operation.
|
timeout
|
Sets the amount of time the SA Agent operation waits for a response from its request packet.
|
rtr reaction-trigger
To define a second SA Agent operation to make the transition from a pending state to an active state when one of the trigger action-type options are defined with the rtr reaction-configuration global configuration command, use the rtr reaction-trigger global configuration command. Use the no form of this command to remove the trigger combination.
rtr reaction-trigger operation target-operation
no rtr reaction-trigger operation
Syntax Description
operation
|
Number of the operation in the active state that has the action-type set with the rtr reaction-configuration global configuration command.
|
target-operation
|
Number of the operation in the pending state that is waiting to be triggered with the rtr global configuration command.
|
Defaults
No trigger combination is defined.
Command Modes
Global configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Triggers are usually used for diagnostics purposes and are not used in normal operation.
Examples
In the following example, the state of operation 1 is changed from pending state to active state when action-type of operation 2 occurs:
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
rtr reaction-configuration
|
Configures certain actions to occur based on events under the control of the SA Agent.
|
rtr schedule
|
Configures the time parameters for an SA Agent operation.
|
rtr reset
To perform a shutdown and restart of the SA Agent, use the rtr reset global configuration command.
rtr reset
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Caution 
Use the
rtr reset command only in extreme situations such as the incorrect configuration of a number of operations.
The rtr reset command stops all operations, clears RTR configuration information, and returns the SA Agent feature to the startup condition. This command does not reread the RTR configuration stored in startup-config in NVRAM. You must retype the configuration or perform a config memory command.
Examples
The following example resets the SA Agent feature:
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
rtr responder
To enable the SA Responder feature on a target router, use the rtr responder global configuration command. Use the no form of this command to disable the SA Responder.
rtr responder
no rtr responder
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(3)T
|
This command was introduced.
|
Usage Guidelines
This command is used on the intended target router of SA Agent operations to enable certain types of operations on non-native interfaces.
Examples
The following example enables the SA Responder:
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
rtr schedule
To configure the time parameters for an SA Agent operation, use the rtr schedule global configuration command. Use the no form of this command to stop the operation and restart it with the default parameters (that is, pending).
rtr schedule operation [life seconds] [start-time {pending | now | hh:mm [month day | day
month]}] [ageout seconds]
no rtr schedule operation
Syntax Description
operation
|
Number of the SA Agent operation to schedule.
|
life seconds
|
(Optional) Number of seconds the operation actively collects information. The default is 3600 seconds (one hour).
|
start-time
|
(Optional) Time when the operation starts collecting information. If the start-time is not specified, no information is collected until the start-time is configured or a trigger occurs that performs a start-time now.
|
pending
|
No information is collected. This is the default value.
|
now
|
Information is immediately collected.
|
hh:mm
|
Information is collected at the specified time (use a 24-hour clock). The time is the current day if you do not specify the month and day.
|
month
|
(Optional) Name of the month. If month is not specified, the current month is used. This requires a day.
|
day
|
(Optional) Number of the day in the range 1 to 31. If day is not specified, the current day is used. This requires a month.
|
ageout seconds
|
(Optional) Number of seconds to keep the operation when it is not actively collecting information. The default is 0 seconds (never ages out).
|
Defaults
Place the operation in a pending state (that is, the operation is started but not actively collecting information).
Command Modes
Global configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
After you schedule the operation with the rtr schedule command, you cannot change the configuration of the operation(with the rtr global configuration command). To change the configuration of the operation, use the no form of the rtr global command and reenter the configuration information.
If the operation is in a pending state, you can define the conditions under which the operation makes the transition from pending to active with the rtr reaction-trigger and rtr reaction-configuration global configuration commands. When the operation is in an active state, it immediately begins collecting information.
The following time line shows the age-out process of the operation:
W----------------------X----------------------Y----------------------Z
where:
•
W is the time the operation was configured with the rtr global configuration command.
•
X is the start time or start of life of the operation (that is, when the operation became "active").
•
Y is the end of life as configured with the rtr schedule global configuration command (life seconds have counted down to zero).
•
Z is the age out of the operation.
Age out starts counting down at W and Y, is suspended between X and Y, and is reset to its configured size at Y.
It is possible for the operation to age out before it executes (that is, Z can occur before X). To ensure that this does not happen, the difference between the operation's configuration time and start time (X and W) must be less than the age-out seconds.
Note
The total RAM required to hold the history and statistics tables is allocated at this time. This is to prevent router memory problems when the router gets heavily loaded and to lower the amount of overhead the feature causes on a router when it is active.
Examples
In the following example, operation 25 begins actively collecting data at 3:00 p.m. on April 5. This operation will age out after 12 hours of inactivity, which can be before it starts or after it has finished with its life. When this operation ages out, all configuration information for the operation is removed (that is, the configuration information is no longer in the running-config in RAM.
rtr schedule 25 life 43200 start-time 15:00 apr 5 ageout 43200
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
rtr reaction-configuration
|
Configures certain actions to occur based on events under the control of the SA Agent.
|
rtr reaction-trigger
|
Defines a second SA Agent operation to make the transition from a pending state to an active state when one of the trigger action-type options are defined with the rtr reaction-configuration global configuration command.
|
samples-of-history-kept
To set the number of entries kept in the history table per bucket for the SA Agent operation, use the samples-of-history-kept RTR configuration command. Use the no form of this command to return to the default value.
samples-of-history-kept samples
no samples-of-history-kept
Syntax Description
samples
|
Number of entries kept in the history table per bucket. The default is 16 entries for type pathEcho and 1 entry for type echo.
|
Defaults
16 entries for type pathEcho
1 entry for type echo
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Use the samples-of-history-kept command to control how many entries are saved in the history table. To control the type of information that gets saved in the history table, use the filter-for-history command. To set how many buckets get created in the history table, use the buckets-of-history-kept command.
A operation can collect history and capture statistics. By default, history is not collected. When a problem arises where history is useful (for example, a large number of timeouts are occurring), you can configure the lives-of-history-kept RTR configuration command to collect history.
Note
Collecting history increases the usage of RAM. Only collect history when you think there is a problem. For general network response time information, use statistics.
Examples
In the following example, ten entries are kept in the history table for each of the lives of operation 3:
type pathecho protocol ipIcmpEcho 172.16.1.176
samples-of-history-kept 10
Related Commands
Command
|
Description
|
buckets-of-history-kept
|
Sets the number of history buckets that are kept during the lifetime of the SA Agent.
|
filter-for-history
|
Defines the type of information kept in the history table for the SA Agent operation.
|
lives-of-history-kept
|
Sets the number of lives maintained in the history table for the SA Agent operation.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
show rtr application
To display global information about the SA Agent feature, use the show rtr application EXEC command.
show rtr application
Syntax Description
This command has no arguements or keywords.
Defaults
None.
Command Modes
EXEC
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Use the show rtr application command to display information such as supported operation types and supported protocols.
Examples
The following is sample output from the show rtr application command in full format.
router#show rtr application
Version:2.1.0 Round Trip Time MIB
Max Packet Data Size (ARR and Data):16384
Time of Last Change in Whole RTR:*22:37:12.000 UTC Sat Mar 6 1993
System Max Number of Entries:500
Number of Entries configured:5
Number of active Entries:5
Number of pending Entries:0
Number of inactive Entries:0
Supported Operation Types
Type of Operation to Perform: echo
Type of Operation to Perform: pathEcho
Type of Operation to Perform: udpEcho
Type of Operation to Perform: tcpConnect
Type of Operation to Perform: http
Type of Operation to Perform: dns
Type of Operation to Perform: jitter
Type of Operation to Perform: dlsw
Type of Operation to Perform: dhcp
Protocol Type:ipUdpEchoAppl
Number of configurable probe is 490
Related Commands
Command
|
Description
|
show rtr configuration
|
Displays configuration values including all defaults for all SA Agent operations or the specified operation.
|
show rtr authentication
To display SA Agent RTR authentication information, use the show rtr authentication EXEC command.
show rtr authentication
Syntax Description
This command has no arguments or keywords.
Command Modes
EXEC
Command History
Release
|
Modification
|
12.0(3)T
|
This command was introduced.
|
Usage Guidelines
Use the show rtr authentication command to display information such as supported operation types and supported protocols.
Examples
The following is sample output from the show rtr application command:
Router# show rtr authentication
RTR control message uses MD5 authentication, key chain name is: rtr
Related Commands
show rtr collection-statistics
To display statistical errors for all SA Agent operations or the specified operation, se the show rtr collection-statistics EXEC command.
show rtr collection-statistics [operation]
Syntax Description
operation
|
(Optional) Number of the SA Agent operation to display.
|
Defaults
Shows statistics for the past two hours.
Command Modes
EXEC
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
12.0(5)T
|
The output for this command was expanded to show information for Jitter operations.
|
Usage Guidelines
Use the show rtr collection-statistics command to display information such as the number of failed operations and the failure reason. You can also use the show rtr distribution-statistics and show rtr totals-statistics commands to display additional statistical information.
This command shows information collected over the past two hours, unless you specify a different amount of time using the hours-of-statistics-kept command.
Examples
The following is sample output from the show rtr collection-statistics command.
Router# show rtr collection-statistics 1
Start Time Index: *17:15:41.000 UTC Thu May 16 1996
Number of Failed Operations due to a Disconnect: 0
Number of Failed Operations due to a Timeout: 0
Number of Failed Operations due to a Busy: 0
Number of Failed Operations due to a No Connection: 0
Number of Failed Operations due to an Internal Error: 0
Number of Failed Operations due to a Sequence Error: 0
Number of Failed Operations due to a Verify Error: 0
Target Address: 172.16.1.176
The following example verifies that the statistics are being collected for an HTTP operation:
router#show rtr collection-statistics 2
HTTP URL:http://172.20.150.200
Start Time:*00:01:16.000 UTC Mon Mar 1 1993
TCPTimeOut:0 RTTSum2:117649
The following shows sample output from the show rtr collection-statistics command, where operation 1 is a Jitter operation:
router#show rtr collection-statistics 1
Target Address:10.0.55.106, Port Number:99
Start Time:*19:20:54.000 UTC Mon Mar 22 1993
NumOfRTT:30 RTTSum:40 RTTSum2:160
PacketLossSD:0 PacketLossDS:0
PacketOutOfSequence:0 PacketMIA:0 PacketLateArrival:0
MinOfPositivesSD:4 MaxOfPositivesSD:4
NumOfPositivesSD:2 SumOfPositivesSD:8 Sum2PositivesSD:32
MinOfNegativesSD:4 MaxOfNegativesSD:4
NumOfNegativesSD:3 SumOfNegativesSD:12 Sum2NegativesSD:48
MinOfPositivesDS:0 MaxOfPositivesDS:0
NumOfPositivesDS:0 SumOfPositivesDS:0 Sum2PositivesDS:0
MinOfNegativesDS:4 MaxOfNegativesDS:4
NumOfNegativesDS:1 SumOfNegativesDS:4 Sum2NegativesDS:16
The values shown indicate the aggregated values for the current hour. RTT stands for Round-Trip-Time. SD stands for Source-to-Destination. DS stands for Destination-to-Source. Table 61 describes the significant fields shown in this output.
Table 61 show rtr collection-statistics Field Descriptions
Field
|
Description
|
NumOfRTT
|
The number of successful round trips.
|
RTTSum
|
The sum of those round trip values (in milliseconds).
|
RTTSum2
|
The sum of squares of those round trip values (in milliseconds).
|
PacketLossSD
|
The number of packets lost from source to destination.
|
PacketLossDS
|
The number of packets lost from destination to source.
|
PacketOutOfSequence
|
The number of packets returned out of order.
|
PacketMIA
|
The number of packets lost where the direction (SD/DS) cannot be determined.
|
PacketLateArrival
|
The number of packets that arrived after the timeout.
|
InternalError
|
The number of times an operation could not be started due to other internal failures.
|
Busies
|
The number of times this operation could not be started because the previously scheduled run was not finished.
|
MinOfPositivesSD MaxOfPositivesSD
|
The minimum and maximum positive jitter values from source to destination, in milliseconds.
|
NumOfPositivesSD
|
The number of jitter values from source to destination that are positive (i.e., network latency increases for two consecutive test packets).
|
SumOfPositivesSD
|
The sum of those postive values (in milliseconds).
|
Sum2PositivesSD
|
The sum of squares of those positive values.
|
MinOfNegativesSD MaxOfNegativesSD
|
The minimum and maximum negative jitter values from source to destination. The absolute value is given.
|
NumOfNegativesSD
|
The number of jitter values from source to destination that are negative (i.e., network latency decreases for two consecutive test packets).
|
SumOfNegativesSD
|
The sum of those values.
|
Sum2NegativesSD
|
The sum of the squares of those values.
|
The DS values show the same information as above for Destination-to-Source Jitter values.
Related Commands
Command
|
Description
|
show rtr configuration
|
Displays configuration values including all defaults for all SA Agent operations or the specified operation.
|
show rtr distributions-statistics
|
Displays statistic distribution information (captured response times) for all SA Agent operations or the specified operation.
|
show rtr totals-statistics
|
Displays the total statistical values (accumulation of error counts and completions) for all SA Agent operations or the specified operation.
|
show rtr configuration
To display configuration values including all defaults for all SA Agent operations or the specified operation, use the show rtr configuration EXEC command.
show rtr configuration [operation]
Syntax Description
operation
|
(Optional) Number of the SA Agent operation to display.
|
Defaults
Data is shown for all operations.
Command Modes
EXEC
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Examples
The following is sample output from the show rtr configuration command in full format:
Router# show rtr configuration 1 full
Complete Configuration Table (includes defaults)
Type of Operation to Perform: echo
Reaction and History Threshold (milliseconds): 5000
Operation Frequency (seconds): 60
Operation Timeout (milliseconds): 5000
Status of Entry (SNMP RowStatus): active
Protocol Type: ipIcmpEcho
Target Address: 172.16.1.176
Request Size (ARR data portion): 1
Response Size (ARR data portion): 1
Next Start Time: Start Time already passed
Entry Ageout (seconds): 3600
Connection Loss Reaction Enabled: FALSE
Timeout Reaction Enabled: FALSE
Threshold Reaction Type: never
Threshold Falling (milliseconds): 3000
Number of Statistic Hours kept: 2
Number of Statistic Paths kept: 1
Number of Statistic Hops kept: 1
Number of Statistic Distribution Buckets kept: 1
Number of Statistic Distribution Intervals (milliseconds): 20
Number of History Lives kept: 0
Number of History Buckets kept: 50
Number of History Samples kept: 1
History Filter Type: none
Related Commands
show rtr distributions-statistics
To display statistic distribution information (captured response times) for all SA Agent operations or the specified operation, use the show rtr distributions-statistics EXEC command.
show rtr distributions-statistics [operation] [tabular | full]
Syntax Description
operation
|
(Optional) Number of the SA Agent operation to display.
|
tabular
|
(Optional) Display information in a column format reducing the number of screens required to display the information. This is the default.
|
full
|
(Optional) Display all information using identifiers next to each displayed value.
|
Defaults
Tabular format for all operations
Command Modes
EXEC
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
The distributions statistics consist of the following:
•
The sum of completion times (used to calculate the mean)
•
The sum of the completions times squared (used to calculate standard deviation)
•
The maximum and minimum completion time
•
The number of completed attempts
You can also use the show rtr collection-statistics and show rtr totals-statistics commands to display additional statistical information.
Examples
The following is sample output from the show rtr distributions-statistics command in tabular format:
Router# show rtr distributions-statistics
StartT = Start Time of Entry (hundredths of seconds)
Dst = Time Distribution Index
Comps = Operations Completed
OvrTh = Operations Completed Over Thresholds
SumCmp = Sum of Completion Times (milliseconds)
SumCmp2L = Sum of Completion Times Squared Low 32 Bits (milliseconds)
SumCmp2H = Sum of Completion Times Squared High 32 Bits (milliseconds)
TMax = Completion Time Maximum (milliseconds)
TMin = Completion Time Minimum (milliseconds)
Entry StartT Pth Hop Dst Comps OvrTh SumCmp
SumCmp2L SumCmp2H TMax TMin
Related Commands
Command
|
Description
|
show rtr collection-statistics
|
Displays statistical errors for all SA Agent operations or the specified operation.
|
show rtr configuration
|
Displays configuration values including all defaults for all SA Agent operations or the specified operation.
|
show rtr totals-statistics
|
Displays the total statistical values (accumulation of error counts and completions) for all SA Agent operations or the specified operation.
|
show rtr history
To display history collected for all SA Agent operations or the specified operation, use theshow rtr history EXEC command.
show rtr history [operation] [tabular | full]
Syntax Description
operation
|
(Optional) Number of the SA Agent operation to display.
|
tabular
|
(Optional) Display information in a column format reducing the number of screens required to display the information. This is the default.
|
full
|
(Optional) Display all information using identifiers next to each displayed value.
|
Defaults
Tabular format for all operations
Command Modes
EXEC
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
The response return codes are listed in Table 62.
Table 62 Response Return Codes
Code
|
Description
|
1
|
Okay.
|
2
|
Disconnected.
|
3
|
Over threshold.
|
4
|
Timeout.
|
5
|
Busy.
|
6
|
Not connected.
|
7
|
Dropped.
|
8
|
Sequence error.
|
9
|
Verify error.
|
10
|
Application specific.
|
Examples
The following is sample output from the show rtr history command in tabular format:
SampleT = Sample Start Time
CompT = Completion Time (milliseconds)
Sense = Response Return Code
Line 2 has the Target Address
Entry LifeI BucketI SampleI SampleT CompT Sense
Related Commands
Command
|
Description
|
show rtr configuration
|
Displays configuration values including all defaults for all SA Agent operations or the specified operation.
|
show rtr operational-state
To display the operational state of all SA Agent operations or the specified operation, use the show rtr operational-state EXEC command.
show rtr operational-state [operation-number]
Syntax Description
operation-number
|
(Optional) Number of the SA Agent operation to display.
|
Defaults
Full format for all operations
Command Modes
EXEC
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
12.0(5)T
|
This command was expanded to show information about Jitter operations.
|
Usage Guidelines
Use the show rtr operational-state command to determine whether a connection loss, timeout, and over threshold occurred; how much life the operation has left; whether the operation is active; and the completion time. It also displays the results of the latest operation attempt.
Examples
The following example shows sample output from the show rtr operational-state command:
router#show rtr operational-state
Current Operational State
Modification Time:*22:15:43.000 UTC Sat Mar 6 1993
Last Time this Entry was Reset:Never
Number of Octets in use by this Entry:1332
Number of Operations Attempted:2
Current Seconds Left in Life:3511
Operational State of Entry:active
Latest Completion Time (milliseconds):544
Latest Operation Start Time:*22:16:43.000 UTC Sat Mar 6 1993
Latest Sense Description:200 OK
The following example shows sample output when the specified operation is a Jitter operation:
router#show rtr operational-state 1
Current Operational State
Modification Time:*19:20:55.000 UTC Mon Mar 22 1993
Last Time this Entry was Reset:Never
Number of Octets in use by this Entry:1382
Number of Operations Attempted:1
Current Seconds Left in Life:3545
Operational State of Entry:active
Latest Operation Start Time:*19:20:55.000 UTC Mon Mar 22 1993
NumOfRTT:10 RTTSum:32 RTTSum2:128
PacketLossSD:0 PacketLossDS:0
PacketOutOfSequence:0 PacketMIA:0 PacketLateArrival:0
MinOfPositivesSD:4 MaxOfPositivesSD:4
NumOfPositivesSD:2 SumOfPositivesSD:8 Sum2PositivesSD:32
MinOfNegativesSD:4 MaxOfNegativesSD:4
NumOfNegativesSD:1 SumOfNegativesSD:4 Sum2NegativesSD:16
MinOfPositivesDS:0 MaxOfPositivesDS:0
NumOfPositivesDS:0 SumOfPositivesDS:0 Sum2PositivesDS:0
MinOfNegativesDS:4 MaxOfNegativesDS:4
NumOfNegativesDS:1 SumOfNegativesDS:4 Sum2NegativesDS:16
The values shown indicate the values for the last SA Agent operation. RTT stands for Round-Trip-Time. SD stands for Source-to-Destination. DS stands for Destination-to-Source. For a description of the output fields, see Table 61 in the show rtr collection-statistics command documentation.
Related Commands
Command
|
Description
|
show rtr configuration
|
Displays configuration values including all defaults for all SA Agent operations or the specified operation.
|
show rtr reaction-trigger
To display the reaction trigger information for all SA Agent operations or the specified operation, use the show rtr reaction-trigger EXEC command.
show rtr reaction-trigger [operation-number]
Syntax Description
operation-number
|
(Optional) Number of the SA Agent operation to display.
|
Defaults
Displays data for all operations.
Command Modes
EXEC
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Use the show rtr reaction-trigger command to display the configuration status and operational state of target operations that will be triggered as defined with the rtr reaction-configuration global command.
Examples
The following is sample output from the show rtr reaction-trigger command:
Router# show rtr reaction-trigger 1
Status of Entry (SNMP RowStatus): active
Operational State: pending
Related Commands
Command
|
Description
|
show rtr configuration
|
Displays configuration values including all defaults for all SA Agent operations or the specified operation.
|
show rtr responder
To display SA Agent RTR Responder information, use the show rtr responder EXEC command.
show rtr responder
Syntax Description
This command has no arguments or keywords.
Command Modes
EXEC
Command History
Release
|
Modification
|
12.0(3)T
|
This command was introduced.
|
Usage Guidelines
Use the show rtr responder command to display information about recent sources of SA Agent control messages, such as who has sent recent control messages and who has sent invalid control messages.
Examples
The following is sample output from the show rtr responder command:
Router# show rtr responder
RTR Responder is: Enabled
Number of control message received: 19 Number of errors: 1
4.0.0.1 [19:11:49.035 UTC Sat Dec 2 1995]
4.0.0.1 [19:10:49.023 UTC Sat Dec 2 1995]
4.0.0.1 [19:09:48.707 UTC Sat Dec 2 1995]
4.0.0.1 [19:08:48.687 UTC Sat Dec 2 1995]
4.0.0.1 [19:07:48.671 UTC Sat Dec 2 1995]
4.0.0.1 [19:10:49.023 UTC Sat Dec 2 1995] RTT_AUTH_FAIL
Related Commands
show rtr totals-statistics
To display the total statistical values (accumulation of error counts and completions) for all SA Agent operations or the specified operation, use the show rtr totals-statistics EXEC command.
show rtr totals-statistics [operation-number]
Syntax Description
number
|
(Optional) Number of the SA Agent operation to display.
|
Defaults
Displays data for all operations.
Command Modes
EXEC
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
The total statistics consist of the following items:
•
The operation number
•
The start time of the current hour of statistics
•
The age of the current hour of statistics
•
The number of attempted operations
You can also use the show rtr distributions-statistics and show rtr collection-statistics commands to display additional statistical information.
Examples
The following is sample output from the show rtr totals-statistics command in full format:
Router# show rtr totals-statistics
Start Time Index: *17:15:41.000 UTC Thu May 16 1996
Age of Statistics Entry (hundredths of seconds): 48252
Number of Initiations: 10
Related Commands
Command
|
Description
|
show rtr collection-statistics
|
Displays statistical errors for all SA Agent operations or the specified operation.
|
show rtr configuration
|
Displays configuration values including all defaults for all SA Agent operations or the specified operation.
|
show rtr distributions-statistics
|
Displays statistic distribution information (captured response times) for all SA Agent operations or the specified operation.
|
statistics-distribution-interval
To set the time interval for each statistics distribution kept for the SA Agent, use the statistics-distribution-interval RTR configuration command. Use the no form of this command to return to the default value.
statistics-distribution-interval milliseconds
no statistics-distribution-interval
Syntax Description
milliseconds
|
Number of milliseconds used for each statistics distribution kept. The default is 20 ms.
|
Defaults
20 ms
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
In most situations, you do not need to change the statistical distribution interval or size. Only change the interval or size when distributions are needed, for example, when performing statistical modeling of your network. To set the statistical distributions size, use the distributions-of-statistics-kept RTR configuration command.
Examples
In the following example, the distribution is set to five and the distribution interval is set to 10 ms. This means that the first distribution will contain statistics from 0 to 9 ms, the second distribution will contain statistics from 10 to 19 ms, the third distribution will contain statistics from 20 to 29 ms, the fourth distribution will contain statistics from 30 to 39 ms, and the fifth distribution will contain statistics from 40 ms to infinity.
type echo protocol ipIcmpEcho 172.28.161.21
distribution-of-statistics-kept 5
statistics-distribution-interval 10
Related Commands
Command
|
Description
|
distributions-of-statistics-kept
|
Sets the number of statistic distributions kept per hop during the SA Agent operation's lifetime.
|
hops-of-statistics-kept
|
Set the number of hops for which statistics are maintained per path for the SA Agent operation.
|
hours-of-statistics-kept
|
Sets the number of hours for which statistics are maintained for the SA Agent operation.
|
paths-of-statistics-kept
|
Sets the number of paths for which statistics are maintained per hour for the SA Agent operation.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
tag
To create a user-specified identifier for an SA Agent operation, use the tag RTR configuration command. It is normally used to logically link operations in a group. Use the no form of this command to remove a tag from a operation.
tag text
no tag
Syntax Description
text
|
Name of a group that this operation belongs to. From 0 to 16 ASCII characters.
|
Defaults
No operations are tagged.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Tags can be used to support automation (for example, by using the same tag for two different operations on two different routers echoing the same target).
Examples
In the following example, operation 1 is tagged with the label bluebell:
type echo protocol ipIcmpEcho 172.16.1.176
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
threshold
To set the rising threshold (hysteresis) that generates a reaction event and stores history information for the SA Agent operation, use the threshold RTR configuration command. Use the no form of this command to return to the default value.
threshold millisecond
no threshold
Syntax Description
millisecond
|
Number of milliseconds required for a rising threshold to be declared. The default value is 5000 ms.
|
Defaults
5000 ms
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
The value specified for the threshold command must not exceed the value specified for the timeout RTR configuration command.
The threshold value is used by the rtr reaction-configuration and filter-for-history commands.
Examples
In the following example, the threshold of operation 1 is set to 2500 ms:
type echo protocol ipIcmpEcho 172.16.1.176
Related Commands
Command
|
Description
|
filter-for-history
|
Defines the type of information kept in the history table for the SA Agent operation.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
rtr reaction-configuration
|
Configures certain actions to occur based on events under the control of the SA Agent.
|
timeout
To set the amount of time the SA Agent operation waits for a response from its request packet, use the timeout RTR configuration command. Use the no form of this command to return to the default value.
timeout millisecond
no timeout
Syntax Description
millisecond
|
Number of milliseconds the operation waits to receive a response from its request packet. The default is 5000 ms.
|
Defaults
5000 ms
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Use the timeout command to set how long the operation waits to receive a response, and use the frequency command to set the rate at which the SA Agent starts an operation.
The value specified for the timeout command cannot be greater than the value specified for the frequency RTR configuration command.
Examples
In the following example, the timeout is set for 2500 ms:
type echo protocol ipIcmpEcho 172.16.1.176
Related Commands
Command
|
Description
|
frequency
|
Sets the rate at which the SA Agent operation starts a response time operation.
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
tos
To define a type of service byte in the IP header of an RTR probe, use the tos RTR configuration command. Use the no form of this command to return to the default value.
tos number
no tos
Syntax Description
number
|
Service type byte in the IP header. The range is 0 to 255. The default is 0.
|
Defaults
The default type of service value is 0.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(3)T
|
This command was introduced.
|
Examples
In the following example, probe 1 is configured as an echo probe using the IP/ICMP Echo protocol and the destination IP address 172.16.1.175. The ToS value is set to 0x80.
type echo protocol ipIcmpEcho 172.16.1.176
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
type dhcp
To configure a Dynamic Host Configuartion Protocol SA Agent operation, use the type dhcp RTR configuration command. To disable a DHCP SA Agent operation, use the no form of this command.
type dhcp
no type dhcp
Syntax Description
This command has no arguments or keywords.
Defaults
The IP limited broadcast address of 255.255.255.255 is used for transactions if no DHCP server is specified. This allows automatic detection of DHCP servers.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(5)T
|
This command was introduced.
|
Usage Guidelines
To specify the DHCP server that should be targeted for the DCHP operation , use the ip dhcp-server [ip-address | name] command. If the ip dhcp-server command is not used, then DHCP discover packets will be sent on every available IP interface.
Examples
In the following example, SA Agent operation number 4 is configured as a DHCP operation enabled for DHCP server 172.16.20.3:
(config)#ip dhcp-server 172.16.20.3
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
ip dhcp-server
|
Specifies which DHCP servers to use on a network, and specifies the IP address of one or more DHCP servers available on the network.
|
type dlsw
To configure a data-link switching (DLSw) SA Agent operation, use the type dlsw RTR configuration command. To remove the type configuration for the operation, use the no form of this command.
type dlsw peer-ipaddr ipaddr
no type dlsw peer-ipaddr ipaddr
Syntax Description
peer-ipaddr
|
Peer destination.
|
ipaddr
|
IP address.
|
Defaults
The default for the optional characteristic request-data-size for a DLSw SA Agent operation is 0 bytes.
The default for the optional characteristic timeout for a DLSw SA Agent operation is 30 seconds.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(5)T
|
This command was introduced.
|
Usage Guidelines
In order to configure a DLSw operation, the DLSw feature must be configured on the local and target routers.
You must configure the type of operation before you can configure any of the other characteristics of the operation.
Examples
In the following example, SA Agent operation number 4 is configured as a DLSw operation enabled for remote peer ip address 172.21.27.11. The data size is 15 bytes.
(config-rtr)# type dlsw peer-ipaddr 172.21.27.11
(config-rtr)# request-data-size 15
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
request-data-size
|
Sets the protocol data size in the payload of the SA Agent operation's request packet.
|
show dlsw peers
|
Displays DLSw peer information.
|
type dns
To configure a Domain Name System (DNS) SA Agent operation, use the type dns RTR configuration command. To remove the type configuration for the operation, use the no form of this command.
type dns target-addr target address name-server ipaddress
no type dns target-addr target address name-server ipaddress
Syntax Description
target-addr
|
Target IP address for the operation to measure.
|
target address
|
IP address or IP host name.
|
name-server
|
Name server of the Domain Name Server.
|
ipaddress
|
IP address of the Domain Name Server.
|
Defaults
No default behavior or values.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(5)T
|
This command was introduced.
|
Usage Guidelines
You must configure the type of operation before you can configure any of the other characteristics of the operation.
Examples
In the following example, SA Agent operation 7 is created and configured as a DNS operation using the target IP address 172.20.2.132:
type dns target-addr lethe name-server 172.20.2.132
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
type echo
To configure an SA Agent end-to-end echo response time probe operation, use the type echo RTR configuration command. Use the no form of this command to remove the type configuration for the operation.
type echo protocol typetarget [source-ipaddr ipaddr]
no type echo protocol type target
Syntax Description
protocol type target
|
Protocol used by the operation. The protocol type can be one of the following keywords (whether the keyword is available depends on the Cisco IOS software features installed on your router) followed by the required target address (target):
• ipIcmpEcho {ip-address | ip-host-name}—IP/ICMP Echo. Requires a destination IP address or IP host name.
• snaRUEcho sna-host-name—SNA's SSCP Native Echo. Requires the host name defined for the SNA's PU connection to VTAM.
• snaLU0EchoAppl sna-host-name [sna-application] [sna-mode]— SNA LU type 0 connection to Cisco's NSPECHO host application that requires the host name defined for the SNA's PU connection to VTAM. Optionally, specify the host application name (the default is NSPECHO) and SNA mode to access the application.
• snaLU2EchoAppl sna-host-name [sna-application] [sna-mode]— SNA LU type 2 connection to Cisco's NSPECHO host application that requires the host name defined for the SNA's PU connection to VTAM. Optionally, specify the host application name (the default is NSPECHO) and SNA mode to access the application.
|
source-ipaddr ipaddr
|
IP address of source for echo operation.
|
Defaults
The default SNA host sna-application name for a SNA LU type echo is NSPEcho.
The default data size for a IP/ICMP echo operation is 28 bytes.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
12.0(5)T
|
The source-ipaddr ipaddr keyword/argument combination was added to support the specification of a IP source for the operation.
|
Usage Guidelines
Support of echo to a protocol and pathEcho to a protocol is dependent on the protocol type and implementation. In general most protocols support echo and few protocols support pathEcho.
Note
Keywords are not case sensitive and are shown in mixed case for readability only.
Prior to sending a operation packet to the Responder, the SA Agent sends a control message to the Responder to enable the destination port.
The default for the optional characteristic request-data-size for a type echo ipIcmpEcho SA Agent operation is 28 bytes. This is the payload portion of the Icmp packet, which makes a 64 byte IP packet.
Examples
In the following example, operation 10 is created and configured as an echo probe using the IP/ICMP Echo protocol and the destination IP address 172.16.1.175:
type echo protocol ipIcmpEcho 172.16.1.175
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
show rtr configuration
|
Displays configuration values for RTR operations (probes).
|
type http
To configurea Hyptertext Transfer Protocol (HTTP) SA Agent operation, use the type http RTR configuration command. To remove the type configuration for the operation, use the no form of this command.
type http operation {get | raw} url url [name-server ipaddress] [version version number]
[source-ipaddr {name | ipaddr}] [source-port port number] [cache {enable | disable}]
[proxy proxy-url]
no type http operation {get | raw} url url [name-server ipaddress] [version version number]
[source-ipaddr {name | ipaddr}] [source-port port number] [cache {enable | disable}]
[proxy proxy-url]
Syntax Description
operation get
|
Specifies an HTTP GET operation.
|
operation raw
|
Specifies an HTTP RAW operation.
|
url url
|
Specifies the URL of destination HTTP server.
|
name-server
|
(Optional) Specifies name of destination Domain Name Server.
|
ipaddress
|
(Optional) IP address of Domain Name Server.
|
version
|
(Optional) Specifies version number.
|
version number
|
(Optional) Version number.
|
source-ipaddr
|
(Optional) Specifies source name or IP address.
|
name
|
Source name.
|
ipaddr
|
Source IP address.
|
source-port
|
(Optional) Specifies source port.
|
port number
|
(Optional) Source port number.
|
cache
|
(Optional) Enables or disables download of cached HTTP page.
|
enable
|
Enables downloads of cached HTTP page.
|
disable
|
Disables download of cached HTTP page.
|
proxy
|
(Optional) Proxy information.
|
proxy-url
|
(Optional) Proxy information or URL.
|
Defaults
No default behavior or values.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(5)T
|
This command was introduced.
|
Usage Guidelines
You must configure the type of operation before you can configure any of the other characteristics of the operation.
Examples
HTTP GET operation
In this example operation 5 is created and configured as an HTTP GET operation. The destination URL is http://www.cisco.com.
(config-rtr)# type http operation get url http://www.cisco.com
(config)# rtr schedule 5 start-time now
HTTP RAW operation using RAW submode
In this example operation 6 is created and configured as an HTTP RAW operation. To use the raw request commands, HTTP-RAW submode is entered using the http-raw-request command. The RTR HTTP-RAWsubmode is indicated by the (config-rtr-http) router prompt.
(config-rtr)# type http operation raw url http://www.cisco.com
(config-rtr)# http-raw-request
(config-rtr-http)# GET /index.html HTTP/1.0\r\n
(config)# rtr schedule 6 start-time now
HTTP RAW operation through a Proxy Server
In this example http://www.proxy.cisco.com is the proxy server and http://www.yahoo.com is the HTTP Server:
(config-rtr)# type http operation raw url http://www.proxy.cisco.com
(config-rtr)# http-raw-request
(config-rtr-http)# GET http://www.yahoo.com HTTP/1.0\r\n
(config)# rtr schedule 6 start-time now
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
type jitter
To configure a jitter SA Agent operation, use the type jitter RTR configuration command. To disable a jitter operation, use the no form of this command.
type jitter dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name | ipaddr}]
[source-port port-number] [control {enable | disable}] [num-packets number-of-packets]
[interval inter-packet-interval]
no type jitter dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name |
ipaddr}] [source-port port-number] [control {enable | disable}] [num-packets
number-of-packets] [interval inter-packet-interval]
Syntax Description
dest-ipaddr
|
Destination.
|
name
|
IP host name.
|
ipaddr
|
IP address.
|
dest-port
|
Destination port.
|
port-number
|
Port number of the destination port.
|
source-ipaddr
|
(Optional) Source IP address.
|
name
|
IP host name.
|
ipaddr
|
IP address.
|
source-port
|
(Optional) Source port.
|
port-number
|
(Optional) Port number of the source.
|
control
|
(Optional) Combined with the enable or disable keyword, enables or disables sending a control message to the destination port.
|
enable
|
Enables the SA Agent to send a control message to the destination port prior to sending a operation packet. This is the default value.
|
disable
|
Disables sending of control messages to the responder prior to sending a operation packet.
|
num-packets number
|
(Optional) Number of packets, as specified by the number argument. The default value is 10.
|
interval inter-packet-interval
|
(Optional) Interpacket interval in milliseconds. The default value of the inter-packet-interval argument is 20 ms.
|
Defaults
The default for the optional characteristic request-data-size for a SA Agent Jitter operation is 32 bytes of UDP data.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(5)T
|
This command was introduced.
|
Usage Guidelines
The type jitter command configures a UDP Plus SA Agent operation. The UDP Plus operation is a superset of the UDP echo operation. In addition to measuring UDP round trip time, the UDP Plus operation measures per-direction packet-loss and Jitter. Jitter is inter-packet delay variance. Packet loss is a critical element in SLAs, and Jitter statistics are useful for analyzing traffic in a VoIP network.
You must enable the SA Agent Responder on the target router before you can configure a Jitter operation. Prior to sending a operation packet to the responder, the SA Agent sends a control message to the SA Agent Responder to enable the destination port.
You must configure the type of operation before you can configure any of the other characteristics of the operation.
Examples
In the following example, operation 6 is created and configured as a UDP+ Jitter operation using the destination IP address 172.30.125.15, the destination port number 2000, 20 packets, and an interval of 20:
type jitter dest-ip 172.30.125.15 dest-port 2000 num-packets 20 interval 20
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
request-data-size
|
Sets the payload size for SA Agent opeartion requests.
|
type pathEcho
To configure an IP/ICMP Path Echo SA Agent operation, use the type pathEcho RTR configuration command. Use the no form of this command to remove the operation from the configuration.
type pathEcho protocol ipIcmpEcho {ip-address | ip-host-name}
no type pathEcho protocol ipIcmpEcho {ip-address | ip-host-name}
Syntax Description
protocol ipIcmpEcho
|
Specifies an IP/ICMP Echo operation. This is currently the only protocol type supported for the SA Agent Path Echo operation.
|
ip-address
|
Specifies the IP address of the target device.
|
ip-host-name
|
Specifies the designated IP name of the target device.
|
Defaults
None
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Keywords are not case sensitive and are shown in mixed case for readability only.
Examples
In the following example, SA Agent operation 10 is created and configured as pathEcho probe using the IP/ICMP Echo protocol and the destination IP address 172.16.1.175:
type pathEcho protocol ipIcmpEcho 172.16.1.175
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
show rtr configuration
|
Displays configuration values for RTR operations (probes).
|
type tcpConnect
To define a tcpConnect SA Agent operation, use the type tcpConnect RTR configuration command. Use the no form of this command to remove the operation from the SA Agent configuration.
type tcpConnect dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name |
ipaddr} source-port port-number] [control {enable | disable}]
no type tcpConnect dest-ipaddr {name | ipaddr} dest-port port-number
Syntax Description
dest-ipaddr name | ipaddr
|
Destination of tcpConnect operation, where name indicates the host name and ipaddr indicates the IP address.
|
dest-port port-number
|
Destination port number.
|
source-ipaddr name | ipaddr
|
(Optional) Source IP host name or IP address.
|
source-port port-number
|
(Optional) Port number of the source. When a port number is not specified, SA Agent picks the best IP address (nearest to the target) and available UDP port.
|
control
|
(Optional) Specifies that the SA Agent control protocol should be used when running this probe. The control protocol is required when the probe's target is a Cisco router that does not natively provide the service (TCP service in this case). Combined with the enable or disable keyword, enables or disables sending a control message to the destination port. The default is that the control protocol is enabled.
|
enable
|
Enables the SA Agent collector to send a control message to the destination port prior to sending a probe packet.
|
disable
|
Disables the SA Agent from sending a control message to the Responder prior to sending a probe packet.
|
Defaults
The control protocol is enabled. Prior to sending a probe packet to the Responder, the SA Agent collector sends a control message to the Responder to enable the destination port.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(3)T
|
This command was introduced.
|
Usage Guidelines
You must configure the SA Agent operation type before you can configure any of the other characteristics of the operation.
The tcpConnect opertation makes a connection to the specified target and reports the time it takes for the connection setup. Note that "request size" and "response size" do not apply to this operation because only connection and termination messages are sent.
In the following example, SA Agent operation 11 is created and configured as a tcpConnect probe using the destination IP address 172.16.1.175, and the destination port 2400:
Router# configure terminal
Router(config-rtr)# type tcpConnect dest-ipaddr 172.16.1.175 dest-port 2400
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation begins configuration for that operation.
|
show rtr configuration
|
Displays configuration values for SA Agent operations.
|
type udpEcho
To define a udpEcho probe, use the type udpEcho RTR configuration command. Use the no form of this command to remove the type configuration for the probe.
type udpEcho dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name |
ipaddr} source-port port-number] [control {enable | disable}]
no type udpEcho dest-ipaddr {name | ipaddr} dest-port port-number
Syntax Description
dest-ipaddr name | ipaddr
|
Destination of the udpEcho probe. Use an IP host name or IP address.
|
dest-port port-number
|
Destination port number. The range of port numbers is from 1 to 65,535.
|
source-ipaddr name | ipaddr
|
(Optional) Source IP host name or IP address.
|
source-port port-number
|
(Optional) Port number of the source. When a port number is not specified, SA Agent picks the best IP address (nearest to the target) and available UDP port
|
control
|
(Optional) Specifies that the SA Agent RTR control protocol should be used when running this probe. The control protocol is required when the probe's target is a Cisco router that does not natively provide the service (UDP service in this case). Combined with the enable or disable keyword, enables or disables sending of a control message to the destination port. The default is that the control protocol is enabled.
|
enable
|
Enable the SA Agent collector to send a control message to the destination port prior to sending a probe packet.
|
disable
|
Disable the SA Agent from sending a control message to the responder prior to sending a probe packet.
|
Defaults
The control protocol is enabled. Prior to sending a probe packet to the Responder, the SA Agent collector sends a control message to the Responder to enable the destination port.
Command Modes
RTR configuration
Command History
Release
|
Modification
|
12.0(3)T
|
This command was introduced.
|
Usage Guidelines
You must configure an operation type before you can configure any of the other characteristics of the operation.
The source IP address and port number are optional. If they are not specified, SA Agent selects the IP address nearest to the target and an available UDP port.
Examples
In the following example, SA Agent operation 12 is created and configured as udpEcho probe using the destination IP address 172.16.1.175 and destination port 2400:
Router# configure terminal
Router(config-rtr)# type udpEcho dest-ipaddr 172.16.1.175 dest-port 2400
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|
show rtr configuration
|
Displays configuration values for SA Agent operations.
|
verify-data
To cause the SA Agent operation to check each response for corruption, use the verify-data RTR configuration command. Use the no form of this command to return to the default value.
verify-data
no verify-data
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
RTR configuration
Command History
Release
|
Modification
|
11.2
|
This command was introduced.
|
Usage Guidelines
Only use the verify-data command when corruption may be an issue.
Caution 
Do not enable this feature during normal operation because it causes unnecessary overhead.
Examples
In the following example, operation 5 is configured to verify the data for each response:
type echo protocol ipIcmpEcho 172.16.1.174
Related Commands
Command
|
Description
|
rtr
|
Specifies an SA Agent operation and enters RTR configuration mode.
|