Service Assurance Agent Commands

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

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 1
 type echo protocol ipIcmpEcho 172.16.161.21
 buckets-of-history-kept 25
 lives-of-history-kept 1

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.

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

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.

rtr 1
 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.

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

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:

rtr 1
 type echo protocol ipIcmpEcho 172.16.161.21
 lives-of-history-kept 1
 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.

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

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:

rtr 1
 type echo protocol ipIcmpEcho 172.16.1.176
 frequency 90

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.

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

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 2
 type pathecho protocol ipIcmpEcho 172.16.1.177
 hops-of-statistics-kept 10

Related Commands

Command	Description
distributions-of-statistics-kept	Sets the number of statistic distributions kept per hop during the lifetime of the SA Agent.
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.

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:

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

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 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.

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

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 1
 type echo protocol ipIcmpEcho 172.16.1.176
 lives-of-history-kept 5

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.

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

Examples

The following example sets the owner of operation 1 to 172.16.1.189 cwb.cisco.com John Doe RTP 555-1212:

rtr 1
 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.

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

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 2
 type pathEcho protocol ipIcmpEcho 172.16.1.177
 paths-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.
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.
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.

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

Examples

The following example sets the request packet size to 40 bytes for operation 3:

rtr 3
 type echo protocol snalu0echoappl cwbc0a
 request-data-size 40

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.

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

• 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:

rtr 3
 type echo protocol snalu0echoappl cwbc0a
 response-data-size 1440

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.

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

For detailed configuration information of the Cisco SA Agent feature in Cisco IOS, see the "Monitoring the Router and Network" chapter in the Release 12.1 Cisco IOS Configuration Fundamentals Configuration Guide.

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 1
Router(config-rtr)# type echo protocol snalu0echoappl cwbc0a
Router(config-rtr)# request-data-size 40
Router(config-rtr)# response-data-size 1440
Router(config-rtr)# exit
Router(config)#

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.

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:

rtr key-chain csaa

Related Commands

Command	Description
rtr	Specifies an SA Agent operation and enters RTR configuration mode.

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

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
 

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.

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

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:

rtr reaction-trigger 2 1

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.

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.

Examples

The following example resets the SA Agent feature:

rtr reset

Related Commands

Command	Description
rtr	Specifies an SA Agent operation and enters RTR configuration mode.

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:

rtr responder

Related Commands

Command	Description
rtr	Specifies an SA Agent operation and enters RTR configuration mode.

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

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.

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

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:

rtr 1
 type pathecho protocol ipIcmpEcho 172.16.1.176
 lives-of-history-kept 3
 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.

Examples

The following is sample output from the show rtr application command in full format.

router#show rtr application
        Response Time Reporter
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
 
        Supported Protocols
Protocol Type:ipIcmpEcho
Protocol Type:ipUdpEchoAppl
Protocol Type:ipTcpConn
Protocol Type:httpAppl
Protocol Type:dnsAppl
Protocol Type:jitterAppl
Protocol Type:dhcp
 
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.

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

Command	Description
show rtr configuration	Displays configuration values for RTR operations (probes).

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 in full format.

Router# show rtr collection-statistics 1 
 
        Collected Statistics
Entry Number: 1
Start Time Index: *17:15:41.000 UTC Thu May 16 1996
Path Index: 1
Hop in Path Index: 1
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
        Collected Statistics
 
Entry Number:2
HTTP URL:http://172.20.150.200
Start Time:*00:01:16.000 UTC Mon Mar 1 1993
 
             Comps:1              RTTMin:343       
             OvrTh:0              RTTMax:343       
        DNSTimeOut:0              RTTSum:343       
        TCPTimeOut:0             RTTSum2:117649  
        TraTimeOut:0              DNSRTT:0         
          DNSError:0           TCPConRTT:13        
         HTTPError:0            TransRTT:330       
          IntError:0            MesgSize:1771      
            Busies:0         
 

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
        Collected Statistics
 
Entry Number:1
Target Address:10.0.55.106, Port Number:99
Start Time:*19:20:54.000 UTC Mon Mar 22 1993
RTT Values:
NumOfRTT:30    RTTSum:40      RTTSum2:160
Packet Loss Values:
PacketLossSD:0 PacketLossDS:0
PacketOutOfSequence:0  PacketMIA:0    PacketLateArrival:0
InternalError:0        Busies:0
Jitter Values:
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
 

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.
full	(Optional) Display all information using identifiers next to each displayed value. This is the default.

Defaults

Full format for all operations

Command Modes

EXEC

Command History

Release	Modification
11.2	This command was introduced.

Examples

Router# show rtr configuration 1 full
 
        Complete Configuration Table (includes defaults)
Entry Number: 1
Owner: "Sample Owner"
Tag: "Sample Tag Group"
Type of Operation to Perform: echo
Reaction and History Threshold (milliseconds): 5000
Operation Frequency (seconds): 60
Operation Timeout (milliseconds): 5000
Verify Data: FALSE
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
Life (seconds): 3600
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
Threshold Count: 5
Threshold Count2: 5
Reaction Type: none
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

Command	Description
show rtr application	Displays global information about the SA Agent feature.
show rtr collection-statistics	Displays statistical errors 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 history	Displays history collected for all SA Agent operations or the specified operation.
show rtr operational-state	Displays the operational state of all SA Agent operations or the specified operation.
show rtr reaction-trigger	Displays the reaction trigger information 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.

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.

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 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 
 
        Captured Statistics
        Multiple Lines per Entry
Line 1
Entry    = Entry Number
StartT   = Start Time of Entry (hundredths of seconds)
Pth      = Path Index
Hop      = Hop in Path Index
Dst      = Time Distribution Index
Comps    = Operations Completed
OvrTh    = Operations Completed Over Thresholds
SumCmp   = Sum of Completion Times (milliseconds)
Line 2
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
1     17417068   1   1   1   2          0           128
   8192      0          64         64

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.

Examples

The following is sample output from the show rtr history command in tabular format:

Router# show rtr history 
 
        Point by point History
          Multiple Lines per Entry
Line 1
Entry    = Entry Number
LifeI    = Life Index
BucketI  = Bucket Index
SampleI  = Sample Index
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
2     1          1          1          17436548   16          1
  AB 45 A0 16 
2     1          2          1          17436551   4           1
  AC 12 7  29 
2     1          2          2          17436551   1           1
  AC 12 5  22 
2     1          2          3          17436552   4           1
  AB 45 A7 22 
2     1          2          4          17436552   4           1
  AB 45 A0 16 

Related Commands

Command	Description
show rtr configuration	Displays configuration values including all defaults for all SA Agent operations or the specified operation.

Examples

The following example shows sample output from the show rtr operational-state command in full format:

router#show rtr operational-state full
        Current Operational State
Entry Number:3
Modification Time:*22:15:43.000 UTC Sat Mar 6 1993
Diagnostics Text:
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 Oper Sense:ok
Latest Sense Description:200  OK
Total RTT:544
DNS RTT:12
TCP Connection RTT:28
HTTP Transaction RTT:504
HTTP Message Size:9707
 

The following example shows sample output when the specified operation is a Jitter operation:

router#show rtr operational-state 1
        Current Operational State
Entry Number:1
Modification Time:*19:20:55.000 UTC Mon Mar 22 1993
Diagnostics Text:
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
RTT Values:
NumOfRTT:10    RTTSum:32      RTTSum2:128
Packet Loss Values:
PacketLossSD:0 PacketLossDS:0
PacketOutOfSequence:0  PacketMIA:0    PacketLateArrival:0
InternalError:0        Busies:0
Jitter Values:
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
 

Examples

The following is sample output from the show rtr reaction-trigger command in full format:

Router# show rtr reaction-trigger 1
 
        Reaction Table
Entry Number: 1
Target Entry Number: 2
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.

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
Recent sources:
        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]

Recent error sources:
        4.0.0.1 [19:10:49.023 UTC Sat Dec 2 1995] RTT_AUTH_FAIL

Related Commands

Command	Description
show rtr configuration	Displays configuration values for SA Agent operations.

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.

rtr 1
 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.

Examples

In the following example, operation 1 is tagged with the label bluebell:

rtr 1
 type echo protocol ipIcmpEcho 172.16.1.176
 tag bluebell

Related Commands

Command	Description
rtr	Specifies an SA Agent operation and enters RTR configuration mode.

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:

rtr 1
 type echo protocol ipIcmpEcho 172.16.1.176
 threshold 2500

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.

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

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:

rtr 1
 type echo protocol ipIcmpEcho 172.16.1.176
 timeout 2500

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.

Syntax Description

protocol type 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 (type-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

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:

rtr 10
 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).

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:

rtr 10
 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).

Syntax Description

dest-ipaddr name | ipaddr	Destination of tcpConnect probe. name indicates IP host name. ipaddr indicates 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.

Examples

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 11
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.

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 12
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.

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

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:

rtr 5
 type echo protocol ipIcmpEcho 172.16.1.174
 response-data-size 2
 verify-data

Related Commands

Command	Description
rtr	Specifies an SA Agent operation and enters RTR configuration mode.