Cisco IOS Configuration Fundamentals Command Reference, Release 12.1
Service Assurance Agent Commands

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:

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.


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.

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.


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:

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.


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:

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.


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:

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.


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

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.


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:

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.


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:

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

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.


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:

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.


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:

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.


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:

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.


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


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:

rtr key-chain 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:

rtr low-memory 2000000

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.