- Cisco IOS Configuration Fundamentals Command Reference, Release 12.1
Table Of Contents
Service Assurance Agent Commands
distributions-of-statistics-kept
show rtr collection-statistics
show rtr distributions-statistics
statistics-distribution-interval
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
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:
rtr 1type echo protocol ipIcmpEcho 172.16.161.21buckets-of-history-kept 25lives-of-history-kept 1Related Commands
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
Defaults
1 distribution
Command Modes
RTR configuration
Command History
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
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.
rtr 1type echo protocol ipIcmpEcho 172.16.161.21distributions-of-statistics-kept 5statistics-distribution-interval 10Related Commands
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
Defaults
No default behavior or values.
Command Modes
RTR configuration
Command History
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
Examples
In the following example, only operation packets that fail are kept in the history table:
rtr 1type echo protocol ipIcmpEcho 172.16.161.21lives-of-history-kept 1filter-for-history failuresRelated Commands
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
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
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:
rtr 1type echo protocol ipIcmpEcho 172.16.1.176frequency 90Related Commands
Specifies an SA Agent operation and enters RTR configuration mode.
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
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:
rtr 2type pathecho protocol ipIcmpEcho 172.16.1.177hops-of-statistics-kept 10Related 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
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 6Router(config-rtr)# type http operation raw url http://www.cisco.comRouter(config-rtr)# http-raw-requestRouter(config-rtr-http)# GET /index.html HTTP/1.0\r\nRouter(config-rtr-http)# \r\nRouter(config-rtr-http)# exitRouter(config)# rtr schedule 6 start-time nowRelated Commands
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
Defaults
2 hours
Command Modes
RTR configuration
Command History
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:
rtr 2type pathecho protocol ipIcmpEcho 172.16.1.177hours-of-statistics-kept 3Related Commands
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
Defaults
0 lives
Command Modes
RTR configuration
Command History
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:
rtr 1type echo protocol ipIcmpEcho 172.16.1.176lives-of-history-kept 5Related Commands
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
Defaults
LSR path is disabled.
Command Modes
RTR configuration
Command History
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:
rtr 1type echo protocol ipIcmpEcho 172.16.1.176lsr-path 172.18.4.149 172.18.26.155Related Commands
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
Defaults
No owner is specified.
Command Modes
RTR configuration
Command History
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:
rtr 1type echo protocol ipIcmpEcho 172.16.1.176owner 172.16.1.189 cwb.cisco.com John Doe RTP 555-1212Related Commands
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
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:
rtr 2type pathEcho protocol ipIcmpEcho 172.16.1.177paths-of-statistics-kept 3Related 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
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:
rtr 3type echo protocol snalu0echoappl cwbc0arequest-data-size 40Related Commands
Sets the protocol data size in the payload of the SA Agent operation's response packet.
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
Usage Guidelines
The response-data-size command is only applicable for the following operations:
•
•
•
•
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:
rtr 3type echo protocol snalu0echoappl cwbc0aresponse-data-size 1440Related Commands
Sets the protocol data size in the payload of the SA Agent operation's request packet.
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
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 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 1Router(config-rtr)# type echo protocol snalu0echoappl cwbc0aRouter(config-rtr)# request-data-size 40Router(config-rtr)# response-data-size 1440Router(config-rtr)# exitRouter(config)#
Note
Related Commands
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
Defaults
None
Command Modes
Global configuration
Command History
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:
rtr key-chain csaaRelated Commands
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
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:
rtr low-memory 2000000Related Commands
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
Defaults
No reactions are generated.
Command Modes
Global configuration
Command History
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
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 trapOnlyFigure 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
