Router and Network Monitoring Commands

This chapter explains the function and syntax of the router and network monitoring commands. For more information about defaults and usage guidelines, see the corresponding chapter of the Cisco IOS Configuration Fundamentals Command Reference, 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.

size	Number of history buckets kept during the lifetime of the operation. The default is 50 buckets.

cdp advertise-v2

To enable Cisco Discovery Protocol Version 2 (CDPv2) advertising functionality on a device, use the cdp advertise-v2 global configuration command. To disable advertising CDPv2 functionality, use the no form of the command.

cdp advertise-v2

no cdp advertise-v2

Syntax Description

This command has no arguments or keywords.

c dp enable

To enable Cisco Discovery Protocol (CDP) on an interface, use the cdp enable interface configuration command. Use the no form of this command to disable CDP on an interface.

cdp enable

no cdp enable

Syntax Description

This command has no arguments or keywords.

cdp holdtime

To specify the amount of time the receiving device should hold a Cisco Discovery Protocol (CDP) packet from your router before discarding it, use the cdp holdtime global configuration command. Use the no form of this command to revert to the default setting.

cdp holdtime seconds

no cdp holdtime

Syntax Description

seconds

Specifies the hold time to be sent in the CDP update packets.

seconds	Specifies the hold time to be sent in the CDP update packets.

c dp run

To enable Cisco Discovery Protocol, use the cdp run global configuration command. Use the no form of this command to disable CDP.

cdp run

no cdp run

Syntax Description

This command has no arguments or keywords.

cdp timer

To specify how often the Cisco IOS software sends Cisco Discovery Protocol updates, use the cdp timer global configuration command. Use the no form of this command to revert to the default setting.

cdp timer seconds

no cdp timer

Syntax Description

seconds

Specifies how often the Cisco IOS software sends CDP updates.

seconds	Specifies how often the Cisco IOS software sends CDP updates.

clear c dp counters

To reset Cisco Discovery Protocol traffic counters to zero (0), use the clear cdp counters privileged EXEC command.

clear cdp counters

Syntax Description

This command has no arguments or keywords.

clear cdp table

To clear the table that contains Cisco Discovery Protocol information about neighbors, use the clear cdp table privileged EXEC command.

clear cdp table

Syntax Description

This command has no arguments or keywords.

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.

size	Number of statistic distributions kept per hop. The default is 1 distribution.

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.

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.

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.

second	Number of seconds between the operation's SA Agent operations. The default value is 60 seconds.

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.

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.

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.

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.

hours	Number of hours that the router maintains statistics. The default is 2 hours.

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.

lives	Number of lives maintained in the history table for the 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.

name	IP host name.
ip addr	IP address.

no snmp-server

To disable Simple Network Management Protocol agent operation, use the no snmp-server command.

no snmp-server

Syntax Description

This command has no arguments or keywords.

owner

To configure the Simple Network Management Protocol 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.

text	Name of the SNMP owner from 0 to 255 ASCII characters. The default is none.

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.

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.

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.

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.

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.

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.

rmon

To enable Remote Monitoring (RMON) on an Ethernet interface, use the rmon interface configuration command. Use the no form of this command to disable RMON on the interface.

rmon {native | promiscuous}

no rmon

Syntax Description

native

Enables RMON on the Ethernet interface. In native mode, the router processes only packets destined for this interface.

promiscuous

Enables RMON on the Ethernet interface. In promiscuous mode, the router examines every packet.

native	Enables RMON on the Ethernet interface. In native mode, the router processes only packets destined for this interface.
promiscuous	Enables RMON on the Ethernet interface. In promiscuous mode, the router examines every packet.

rmon alarm

To set an alarm on any MIB object, use the rmon alarm global configuration command. Use the no form of this command to disable the alarm.

rmon alarm number variable interval {delta | absolute} rising-threshold value [event-number] falling-threshold value [event-number] [owner string]

no rmon alarm number

Syntax Description

number

Alarm number, which is identical to the alarmIndex in the alarmTable in the Remote Monitoring (RMON) MIB.

variable

MIB object to monitor, which translates into the alarmVariable used in the alarmTable of the RMON MIB.

interval

Time in seconds the alarm monitors the MIB variable, which is identical to the alarmInterval used in the alarmTable of the RMON MIB.

delta

Tests the change between MIB variables, which affects the alarmSampleType in the alarmTable of the RMON MIB.

absolute

Tests each MIB variable directly, which affects the alarmSampleType in the alarmTable of the RMON MIB.

rising-threshold value

Value at which the alarm is triggered.

event-number

(Optional) Event number to trigger when the rising or falling threshold exceeds its limit. This value is identical to the alarmRisingEventIndex or the alarmFallingEventIndex in the alarmTable of the RMON MIB.

falling-threshold value

Value at which the alarm is reset.

owner string

(Optional) Specifies an owner for the alarm, which is identical to the alarmOwner in the alarmTable of the RMON MIB.

number	Alarm number, which is identical to the alarmIndex in the alarmTable in the Remote Monitoring (RMON) MIB.
variable	MIB object to monitor, which translates into the alarmVariable used in the alarmTable of the RMON MIB.
interval	Time in seconds the alarm monitors the MIB variable, which is identical to the alarmInterval used in the alarmTable of the RMON MIB.
delta	Tests the change between MIB variables, which affects the alarmSampleType in the alarmTable of the RMON MIB.
absolute	Tests each MIB variable directly, which affects the alarmSampleType in the alarmTable of the RMON MIB.
rising-threshold value	Value at which the alarm is triggered.
event-number	(Optional) Event number to trigger when the rising or falling threshold exceeds its limit. This value is identical to the alarmRisingEventIndex or the alarmFallingEventIndex in the alarmTable of the RMON MIB.
falling-threshold value	Value at which the alarm is reset.
owner string	(Optional) Specifies an owner for the alarm, which is identical to the alarmOwner in the alarmTable of the RMON MIB.

rmon capture-userdata

To disable the packet zeroing feature that initializes the user payload portion of each Remote Monitoring (RMON) MIB packet, use the rmon capture-userdata global configuration command. To enable packet zeroing, use the no form of the command.

rmon capture-userdata

no rmon capture-userdata

Syntax Description

This command has no arguments or keywords.

rm on collection history

To enable Remote Monitoring (RMON) MIB history group of statistics on an interface, use the rmon collection history interface configuration command. To remove a specified RMON history group of statistics, use the no form of the command.

rmon collection history {controlEntry integer} [owner ownername] [buckets bucket-number] [interval seconds]

no rmon collection history {controlEntry integer} [owner ownername] [buckets bucket-number] [interval seconds]

Syntax Description

controlEntry

Specifies the RMON group of statistics using a value.

integer

A value from 1 to 65535 that identifies the RMON group of statistics and matches the index value returned for Simple Network Management Protocol (SNMP) requests.

owner

(Optional) Specifies the name of the owner of the RMON group of statistics.

ownername

(Optional) Records the name of the owner of the RMON group of statistics.

buckets

(Optional) Specifies the maximum number of buckets desired for the RMON collection history group of statistics.

bucket-number

(Optional) A value associated with the number of buckets specified for the RMON collection history group of statistics.

interval

(Optional) Specifies the number of seconds in each polling cycle.

seconds

(Optional) The number of seconds in each polling cycle.

controlEntry	Specifies the RMON group of statistics using a value.
integer	A value from 1 to 65535 that identifies the RMON group of statistics and matches the index value returned for Simple Network Management Protocol (SNMP) requests.
owner	(Optional) Specifies the name of the owner of the RMON group of statistics.
ownername	(Optional) Records the name of the owner of the RMON group of statistics.
buckets	(Optional) Specifies the maximum number of buckets desired for the RMON collection history group of statistics.
bucket-number	(Optional) A value associated with the number of buckets specified for the RMON collection history group of statistics.
interval	(Optional) Specifies the number of seconds in each polling cycle.
seconds	(Optional) The number of seconds in each polling cycle.

rmo n collection host

To enable a Remote Monitoring (RMON) MIB host collection group of statistics on the interface, use the rmon collection host interface configuration command. To remove the specified RMON host collection, use the no form of the command.

rmon collection host {controlEntry integer} [owner ownername]

no rmon collection host {controlEntry integer} [owner ownername]

controlEntry	Specifies the RMON group of statistics using a value.
integer	A value from 1 to 65535 that identifies the RMON group of statistics and matches the index value returned for Simple Network Management Protocol (SNMP) requests.
owner	(Optional) Specifies the name of the owner of the RMON group of statistics.
ownername	(Optional) Records the name of the owner of the RMON group of statistics

rmon collection matrix

To enable a Remote Monitoring (RMON) MIB matrix group of statistics on an interface, use the rmon collection matrix interface configuration command. To remove a specified RMON matrix group of statistics, use the no form of the command.

rmon collection matrix {controlEntry integer} [owner ownername]

no rmon collection matrix {controlEntry integer} [owner ownername]

Syntax Description

controlEntry

Specifies the RMON group of statistics using a value.

integer

A value between 1 and 65535 that identifies the RMON group of statistics and matches the index value returned for Simple Network Management Protocol (SNMP) requests.

owner

(Optional) Specifies the name of the owner of the RMON group of statistics.

ownername

(Optional) Records the name of the owner of the RMON group of statistics.

controlEntry	Specifies the RMON group of statistics using a value.
integer	A value between 1 and 65535 that identifies the RMON group of statistics and matches the index value returned for Simple Network Management Protocol (SNMP) requests.
owner	(Optional) Specifies the name of the owner of the RMON group of statistics.
ownername	(Optional) Records the name of the owner of the RMON group of statistics.

rmon collection rmon1

To enable all possible autoconfigurable Remote Monitoring (RMON) MIB statistic collections on the interface, use the rmon collection rmon1 interface configuration command. To disable these statistic collections on the interface, use the no form of the command.

rmon collection rmon1 {controlEntry integer} [owner ownername]

no rmon collection rmon1 {controlEntry integer} [owner ownername]

Syntax Description

controlEntry

Specifies the RMON group of statistics using a value.

integer

A value from 1 to 65535 that identifies the RMON group of statistics and matches the index value returned for Simple Network Management Protocol (SNMP) requests.

owner

(Optional) Specifies the name of the owner of the RMON group of statistics.

ownername

(Optional) Records the name of the owner of the RMON group of statistics.

controlEntry	Specifies the RMON group of statistics using a value.
integer	A value from 1 to 65535 that identifies the RMON group of statistics and matches the index value returned for Simple Network Management Protocol (SNMP) requests.
owner	(Optional) Specifies the name of the owner of the RMON group of statistics.
ownername	(Optional) Records the name of the owner of the RMON group of statistics.

rmon event

To add or remove an event in the RMON event table that is associated with an RMON event number, use the rmon event global configuration command. Use the no form of this command to disable RMON on the interface.

rmon event number [log] [trap community] [description string] [owner string]

no rmon event number

Syntax Description

number

Assigned event number, which is identical to the eventIndex in the eventTable in the RMON MIB.

log

(Optional) Generates an RMON log entry when the event is triggered and sets the eventType in the RMON MIB to log or log-and-trap.

trap community

(Optional) SNMP community string used for this trap. Configures the setting of the eventType in the RMON MIB for this row as either snmp-trap or log-and-trap. This value is identical to the eventCommunityValue in the eventTable in the RMON MIB.

description string

(Optional) Specifies a description of the event, which is identical to the event description in the eventTable of the RMON MIB.

owner string

(Optional) Owner of this event, which is identical to the eventOwner in the eventTable of the RMON MIB.

number	Assigned event number, which is identical to the eventIndex in the eventTable in the RMON MIB.
log	(Optional) Generates an RMON log entry when the event is triggered and sets the eventType in the RMON MIB to log or log-and-trap.
trap community	(Optional) SNMP community string used for this trap. Configures the setting of the eventType in the RMON MIB for this row as either snmp-trap or log-and-trap. This value is identical to the eventCommunityValue in the eventTable in the RMON MIB.
description string	(Optional) Specifies a description of the event, which is identical to the event description in the eventTable of the RMON MIB.
owner string	(Optional) Owner of this event, which is identical to the eventOwner in the eventTable of the RMON MIB.

rmon queuesize

To change the size of the queue that holds packets for analysis by the Remote Monitoring (RMON) process, use the rmon queuesize global configuration command. Use the no form of this command to restore the default value.

rmon queuesize size

no rmon queuesize

Syntax Description

size

Number of packets allowed in the queue awaiting RMON analysis. Default queue size is 64 packets.

size	Number of packets allowed in the queue awaiting RMON analysis. Default queue size is 64 packets.

rt r

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.

op-number	Operation number used for the identification of the SA Agent operation you wish to configure.

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.

name	Name of MD5 key chain.

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.

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.

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.

rtr reaction-trigger

To define a second SA Agent operation to make the transition from a pending state to an active state when one of the trigger action-type options are defined with the rtr reaction-configuration global configuration command, use the rtr reaction-trigger global configuration command. Use the no form of this command to remove the trigger combination.

rtr reaction-trigger operation target-operation

no rtr reaction-trigger operation

Syntax Description

operation

Number of the operation in the active state that has the action-type set with the rtr reaction-configuration global configuration command.

target-operation

Number of the operation in the pending state that is waiting to be triggered with the rtr global configuration command.

rtr reset

To perform a shutdown and restart of the SA Agent, use the rtr reset global configuration command.

rtr reset

Syntax Description

This command has no arguments or keywords.

rtr responder

To enable the SA Responder feature on a target router, use the rtr responder global configuration command. Use the no form of this command to disable the SA Responder.

rtr responder

no rtr responder

Syntax Description

This command has no arguments or keywords.

rtr schedule

To configure the time parameters for an SA Agent operation, use the rtr schedule global configuration command. Use the no form of this command to stop the operation and restart it with the default parameters (that is, pending).

rtr schedule operation [life seconds] [start-time {pending | now | hh:mm [month day | day month]}] [ageout seconds]

no rtr schedule operation

Syntax Description

operation

Number of the SA Agent operation to schedule.

life seconds

(Optional) Number of seconds the operation actively collects information. The default is 3600 seconds (one hour).

start-time

(Optional) Time when the operation starts collecting information. If the start-time is not specified, no information is collected until the start-time is configured or a trigger occurs that performs a start-time now.

pending

No information is collected. This is the default value.

now

Information is immediately collected.

hh:mm

Information is collected at the specified time (use a 24-hour clock). The time is the current day if you do not specify the month and day.

month

(Optional) Name of the month. If month is not specified, the current month is used. This requires a day.

day

(Optional) Number of the day in the range 1 to 31. If day is not specified, the current day is used. This requires a month.

ageout seconds

(Optional) Number of seconds to keep the operation when it is not actively collecting information. The default is 0 seconds (never ages out).

samples-of-history-kept

To set the number of entries kept in the history table per bucket for the SA Agent operation, use the samples-of-history-kept RTR configuration command. Use the no form of this command to return to the default value.

samples-of-history-kept samples

no samples-of-history-kept

Syntax Description

samples

Number of entries kept in the history table per bucket. The default is 16 entries for type pathEcho and 1 entry for type echo.

show cdp

To display global Cisco Disovery Protocol information, including timer and hold-time information, use the show cdp privileged EXEC command.

show cdp

Syntax Description

This command has no arguments or keywords.

show cdp entry

To display information about a specific neighboring device discovered using Cisco Discovery Protocol, use the show cdp entry privileged EXEC command.

show cdp entry {* | entry-name [protocol | version]}

Syntax Description

*

Shows all of the CDP neighbors.

entry-name

Name of neighbor about which you want information.

You can enter an asterisk (*) at the end of an entry-name, such as show cdp entry dev*, which would show information about the neighbor, device.cisco.com.

protocol

(Optional) Limits the display to information about the protocols enabled on a router.

version

(Optional) Limits the display to information about the version of software running on the router.

sh ow cdp interface

To display information about the interfaces on which Cisco Discovery Protocol is enabled, use the show cdp interface privileged EXEC command.

show cdp interface [type number]

Syntax Description

type

(Optional) Type of interface about which you want information.

number

(Optional) Number of the interface about which you want information.

s how cdp neighbors

To display detailed information about neighboring devices discovered using Cisco Discovery Protocol (CDP), use the show cdp neighbors privileged EXEC command.

show cdp neighbors [type number] [detail]

Syntax Description

type

(Optional) Type of the interface connected to the neighbors about which you want information.

number

(Optional) Number of the interface connected to the neighbors about which you want information.

detail

(Optional) Displays detailed information about a neighbor (or neighbors) including network address, enabled protocols, hold time, and software version.

show cdp traffic

To display information about traffic between devices gathered using Cisco Discovery Protocol (CDP), use the show cdp traffic privileged EXEC command.

show cdp traffic

Syntax Description

This command has no arguments or keywords.

show rmon

To display the current RMON agent status on the router, use the show rmon EXEC command.

Syntax Description

alarms

(Optional) Displays the RMON alarm table.

capture

(Optional) Displays the RMON buffer capture table. Available on Cisco 2500 series and Cisco AS5200 series only.

events

(Optional) Displays the RMON event table.

filter

(Optional) Displays the RMON filter table. Available on Cisco 2500 series and Cisco AS5200 series only.

history

(Optional) Displays the RMON history table. Available on Cisco 2500 series and Cisco AS5200 series only.

hosts

(Optional) Displays the RMON hosts table. Available on Cisco 2500 series and Cisco AS5200 series only.

matrix

(Optional) Displays the RMON matrix table. Available on Cisco 2500 series and Cisco AS5200 series only.

statistics

(Optional) Displays the RMON statistics table. Available on Cisco 2500 series and Cisco AS5200 series only.

task

(Optional) Displays general RMON statistics. This is the default.

topn

(Optional) Displays the RMON top-n hosts table. Available on Cisco 2500 series and Cisco AS5200 series only.

show rmon alarms

To display the contents of the RMON alarm table of the router, use the show rmon alarms EXEC command.

show rmon alarms

Syntax Description

This command has no arguments or keywords.

show rmon capture

To display the contents of the router's RMON capture table, use the show rmon capture EXEC command.

show rmon capture

Syntax Description

This command has no arguments or keywords.

show rmon events

To display the contents of the router's RMON event table, use the show rmon events EXEC command.

show rmon events

Syntax Description

This command has no arguments or keywords.

show r mon filter

To display the contents of the router's RMON filter table, use the show rmon filter EXEC command.

Syntax Description

This command has no arguments or keywords.

show rmon history

To display the contents of the router's RMON history table, use the show rmon history EXEC command.

show rmon history

Syntax Description

This command has no arguments or keywords.

show rmon hosts

To display the contents of the router's RMON hosts table, use the show rmon hosts EXEC command.

show rmon hosts

Syntax Description

This command has no arguments or keywords.

show rmon matrix

To display the contents of the router's RMON matrix table, use the show rmon matrix EXEC command.

show rmon matrix

Syntax Description

This command has no arguments or keywords.

show rmon statistics

To display the contents of the router's RMON statistics table, use the show rmon statistics EXEC command.

show rmon statistics

Syntax Description

This command has no arguments or keywords.

show rmon topn

To display the contents of the router's RMON Top-N host table, use the show rmon topn EXEC command.

show rmon topn

Syntax Description

This command has no arguments or keywords.

show rtr application

To display global information about the SA Agent feature, use the show rtr application EXEC command.

show rtr application [tabular | full]

Syntax Description

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.

show rtr authentication

To display SA Agent RTR authentication information, use the show rtr authentication EXEC command.

show rtr authentication

Syntax Description

This command has no arguments or keywords.

show rtr collection-statistics

To display statistical errors for all SA Agent operations or the specified operation, use the show rtr collection-statistics EXEC command.

show rtr collection-statistics [operation] [tabular | full]

Syntax Description

operation

(Optional) Number of the SA Agent operation to display.

tabular

(Optional) Display information in a column format reducing the number of screens required to display the information.

full

(Optional) Display all information using identifiers next to each displayed value. This is the default.

show rtr configuration

To display configuration values including all defaults for all SA Agent operations or the specified operation, use the show rtr configuration EXEC command.

show rtr configuration [operation] [tabular | full]

show rtr distributions-statistics

To display statistic distribution information (captured response times) for all SA Agent operations or the specified operation, use the show rtr distributions-statistics EXEC command.

show rtr distributions-statistics [operation] [tabular | full]

Syntax Description

operation

(Optional) Number of the SA Agent operation to display.

tabular

(Optional) Display information in a column format reducing the number of screens required to display the information. This is the default.

full

(Optional) Display all information using identifiers next to each displayed value.

show rtr history

To display history collected for all SA Agent operations or the specified operation, use the show rtr history EXEC command.

show rtr history [operation] [tabular | full]

Syntax Description

operation

(Optional) Number of the SA Agent operation to display.

tabular

(Optional) Display information in a column format reducing the number of screens required to display the information. This is the default.

full

(Optional) Display all information using identifiers next to each displayed value.

show rtr operational-state

To display the operational state of all SA Agent operations or the specified operation, use the show rtr operational-state EXEC command.

show rtr operational-state [operation] [tabular | full]

show rtr reaction-trigger

To display the reaction trigger information for all SA Agent operations or the specified operation, use the show rtr reaction-trigger EXEC command.

show rtr reaction-trigger [operation] [tabular | full]

show rtr responder

To display SA Agent RTR Responder information, use the show rtr responder EXEC command.

show rtr responder

Syntax Description

This command has no arguments or keywords.

show rtr totals-statistics

To display the total statistical values (accumulation of error counts and completions) for all SA Agent operations or the specified operation, use the show rtr totals-statistics EXEC command.

show rtr totals-statistics [number] [tabular | full]

Syntax Description

number

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

show snmp

To check the status of SNMP communications, use the show snmp EXEC command.

show snmp

Syntax Description

This command has no arguments or keywords.

show snmp engineID

To display the identification of the local Simple Network Management Protocol engine and all remote engines that have been configured on the router, use the show snmp engineID EXEC command.

show snmp engineID

Syntax Description

This command has no arguments or keywords.

show snmp group

To display the names of groups on the router and the security model, the status of the different views, and the storage type of each group, use the show snmp group EXEC command.

show snmp group

Syntax Description

This command has no arguments or keywords.

show snmp pending

To display the current set of pending Simple Network Management Protocol requests, use the show snmp pending EXEC command.

show snmp pending

Syntax Description

This command has no arguments or keywords.

show snmp sessions

To display the current SNMP sessions, use the show snmp sessions EXEC command.

show snmp sessions [brief]

Syntax Description

brief

(Optional) Displays a list of sessions only. Does not display session statistics.

show snmp user

To display information on each Simple Network Management Protocol username in the group username table, use the show snmp user EXEC command.

show snmp user

Syntax Description

This command has no arguments or keywords.

snmp-server access-policy

This command is no longer valid. The functionality provided by this command has been removed from the Cisco IOS software.

snmp-server chassis-id

To provide a message line identifying the Simple Network Management Protocol server serial number, use the snmp-server chassis-id global configuration command. Use the no form of this command to restore the default value, if any.

snmp-server chassis-id text

no snmp-server chassis-id

Syntax Description

text

Message you want to enter to identify the chassis serial number.

snmp-server community

To set up the community access string to permit access to the Simple Network Management Protocol protocol, use the snmp-server community global configuration command. The no form of this command removes the specified community string.

snmp-server community string [view view-name] [ro | rw] [number]

no snmp-server community string

Syntax Description

string

Community string that acts like a password and permits access to the SNMP protocol.

view view-name

(Optional) Name of a previously defined view. The view defines the objects available to the community.

ro

(Optional) Specifies read-only access. Authorized management stations are only able to retrieve MIB objects.

rw

(Optional) Specifies read-write access. Authorized management stations are able to both retrieve and modify MIB objects.

number

(Optional) Integer from 1 to 99 that specifies an access list of IP addresses that are allowed to use the community string to gain access to the SNMP agent.

snmp-server contact

To set the system contact (sysContact) string, use the snmp-server contact global configuration command. Use the no form to remove the system contact information.

snmp-server contact text

no snmp-server contact

Syntax Description

text

String that describes the system contact information.

snmp-server context

This command is no longer valid. The functionality provided by this command has been removed from the Cisco IOS software.

snmp-server enable traps

To enable the router to send Simple Network Management Protocol traps and informs, use the snmp-server enable traps global configuration command. Use the no form of this command to disable SNMP notifications.

snmp-server enable traps [notification-type] [notification-option]

no snmp-server enable traps [notification-type] [notification-option]

Syntax Description

notification-type

(Optional) Type of notification to enable. If no type is specified, all notifications are sent (including the envmon and repeater notifications). The notification type can be one of the following keywords:

bgp---Sends Border Gateway Protocol (BGP) state change notifications.

config---Sends configuration notifications.

entity---Sends Entity MIB modification notifications.

envmon---Sends Cisco enterprise-specific environmental monitor notifications when an environmental threshold is exceeded. When the envmon keyword is used, you can specify a notification-option value.

frame-relay---Sends Frame Relay notifications.

hsrp---Sends Hot Standby Routing Protocol (HSRP) notifications.

isdn---Sends Integrated Services Digital Network (ISDN) notifications. When the isdn keyword is used, you can specify a notification-option value.

repeater---Sends Ethernet hub repeater notifications. When the repeater keyword is selected, you can specify a notification-option value.

rsvp---Sends Resource Reservation Protocol (RSVP) notifications.

rtr---Sends Service Assurance Agent RTR (RTR) notifications.

snmp---Sends Simple Network Management Protocol (SNMP) notifications. When the snmp keyword is used, you can specify a notification-option value.

syslog---Sends error message notifications (Cisco Syslog MIB). Specify the level of messages to be sent with the logging history level command.

notification-option

(Optional)

envmon [voltage | shutdown | supply | fan | temperature]
When the envmon keyword is used, you can enable a specific environmental notification type, or accept all notification types from the environmental monitor system. If no option is specified, all environmental notifications are enabled. The option can be one or more of the following keywords: voltage, shutdown, supply, fan, and temperature.

isdn [call-information | isdn u-interface]
When the isdn keyword is used, you can specify the call-information keyword to enable an SNMP ISDN call information notification for the ISDN MIB subsystem, or you can specify the isdnu-interface keyword to enable an SNMP ISDN U interface notification for the ISDN U interface MIB subsystem.

repeater [health | reset]
When the repeater keyword is used, you can specify the repeater option. If no option is specified, all repeater notifications are enabled. The option can be one or more of the following keywords:

health---Enables IETF Repeater Hub MIB (RFC 1516) health notification.

reset---Enables IETF Repeater Hub MIB (RFC 1516) reset notification.

snmp [authentication]
When the snmp keyword is used, you can specify the authentication option to enable SNMP Authentication Failure notifications. (The snmp-sever enable traps snmp authentication command replaces the snmp-server trap-authentication command.) If no option is specified, all SNMP notifications are enabled.

snmp-server engineID

To configure a name for either the local or remote Simple Network Management Protocol engine on the router, use the snmp-server engineID global configuration command. Use the no form of this command to remove a specified SNMP group.

snmp-server engineID [local engineid-string] | [remote ip-address udp-port port engineid-string]

no snmp-server engineID

Syntax Description

local

(Optional) Specifies the local copy of SNMP on the router.

engineid-string

(Optional) The name of a copy of SNMP.

remote

(Optional) Specifies the remote copy of SNMP on the router.

ip-address

(Optional) The IP address of the device that contains the remote copy of SNMP.

udp-port

(Optional) Specifies a UDP port of the host to use.

port

(Optional) The socket number on the remote device that contains the remote copy of SNMP. The default is 161.

snmp-server group

To configure a new Simple Network Management Protocol group, or a table that maps SNMP users to SNMP views, use the snmp-server group global configuration command. To remove a specified SNMP group, use the no form of this command.

snmp-server group [groupname {v1 | v2c | v3 {auth | noauth | priv}}] [read readview] [write writeview] [notify notifyview ] [access access-list]

no snmp-server group

Syntax Description

groupname

(Optional) The name of the group.

v1

(Optional) The least secure of the possible security models.

v2c

(Optional) The second least secure of the possible security models. It allows for the transmission of informs and counter 64, which allows for integers twice the width of what is normally allowed.

v3

(Optional) The most secure of the possible security models.

auth

(Optional) Specifies authentication of a packet without encrypting it.

noauth

(Optional) Specifies no authentication of a packet.

priv

(Optional) Specifies authentication of a packet with encryption.

read

(Optional) The option that allows you to specify a read view.

readview

(Optional) A string (not to exceed 64 characters) that is the name of the view that enables you only to view the contents of the agent.

write

(Optional) The option that allows you to specify a write view.

writeview

(Optional) A string (not to exceed 64 characters) that is the name of the view that enables you to enter data and configure the contents of the agent.

notify

(Optional) The option that allows you to specify a notify view

notifyview

(Optional) A string (not to exceed 64 characters) that is the name of the view that enables you to specify a notify, inform, or trap.

access

(Optional) The option that enables you to specify an access list.

access-list

(Optional) A string (not to exceed 64 characters) that is the name of the access list.

snmp-server host

To specify the recipient of an Simple Network Management Protocol notification operation, use the snmp-server host global configuration command. To remove the specified host, use the no form of this command.

snmp-server host host-addr [traps | informs] [version {1 | 2c | 3 [auth | noauth | priv]}] community-string [udp-port port] [notification-type]

no snmp-server host host [traps | informs]

Syntax Description

host-addr

Name or Internet address of the host (the targeted recipient).

traps

(Optional) Send SNMP traps to this host. This is the default.

informs

(Optional) Send SNMP informs to this host.

version

(Optional) Version of the Simple Network Management Protocol (SNMP) used to send the traps. Version 3 is the most secure model, as it allows packet encryption with the priv keyword. If you use the version keyword, one of the following must be specified:

1 ---SNMPv1. This option is not available with informs.

2c ---SNMPv2C.

3 ---SNMPv3. The following three optional keywords can follow the version 3 keyword:

auth (Optional). Enables Message Digest 5 (MD5) and Secure Hash Algorithm (SHA) packet authentication

noauth (Default). The noAuthNoPriv security level. This is the default if the [auth | noauth | priv] keyword choice is not specified.

priv (Optional). Enables Data Encryption Standard (DES) packet encrytion (also called "privacy").

community-string

Password-like community string sent with the notification operation. Though you can set this string using the snmp-server host command by itself, we recommend you define this string using the snmp-server community command prior to using the snmp-server host command.

udp-port port

UDP port of the host to use. The default is 162.

notification-type

(Optional) Type of notification to be sent to the host. If no type is specified, all notifications are sent. The notification type can be one or more of the following keywords:

bgp---Sends Border Gateway Protocol (BGP) state change notifications.

config---Sends configuration notifications.

dspu---Sends downstream physical unit (DSPU) notifications.

entity---Sends Entity MIB modification notifications.

envmon---Sends Cisco enterprise-specific environmental monitor notifications when an environmental threshold is exceeded.

frame-relay---Sends Frame Relay notifications.

hsrp---Sends Hot Stanby Routing Protocol (HSRP) notifications.

isdn---Sends Integrated Services Digital Network (ISDN) notifications.

llc2---Sends Logical Link Control, type 2 (LLC2) notifications.

repeater---Sends standard repeater (hub) notifications.

rsrb---Sends remote source-route bridging (RSRB) notifications.

rsvp---Sends Resource Reservation Protocol (RSVP) notifications.

rtr---Sends SA Agent (RTR) notifications.

sdlc---Sends Synchronous Data Link Control (SDLC) notifications.

sdllc---Sends SDLLC notifications.

snmp---Sends Simple Network Management Protocol (SNMP) notifications (as defined in RFC 1157).

stun---Sends serial tunnel (STUN) notifications.

syslog---Sends error message notifications (Cisco Syslog MIB). Specify the level of messages to be sent with the logging history level command.

tty---Sends Cisco enterprise-specific notifications when a Transmission Control Protocol (TCP) connection closes.

x25---Sends X.25 event notifications.

snmp-server informs

To specify inform request options, use the snmp-server informs global configuration command. The no form of this command returns the settings to the defaults.

snmp-server informs [retries retries] [timeout seconds] [pending pending]

no snmp-server informs [retries retries] [timeout seconds] [pending pending]

Syntax Description

retries retries

(Optional) Maximum number of times to resend an inform request. The default is 3.

timeout second

(Optional) Number of seconds to wait for an acknowledgment before resending. The default is 30 seconds.

pending pending

(Optional) Maximum number of informs waiting for acknowledgments at any one time. When the maximum is reached, older pending informs are discarded. The default is 25.

snmp-server location

To set the system location string, use the snmp-server location global configuration command. Use the no form of this command to remove the location string.

snmp-server location text

no snmp-server location

Syntax Description

text

String that describes the system location information.

snmp-server manager

To start the Simple Network Management Protocol manager process, use the snmp-server manager global configuration command. The no form of this command stops the SNMP manager process.

snmp-server manager

no snmp-server manager

Syntax Description

This command has no arguments or keywords.

snmp-server manager session-timeout

To set the amount of time before a nonactive session is destroyed, use the snmp-server manager session-timeout global configuration command. The no form of this command returns the value to its default.

snmp-server manager session-timeout seconds

no snmp-server manager session-timeout

Syntax Description

seconds

Number of seconds before an idle session is timed out. The default is 600 seconds.

snmp-server packetsize

To establish control over the largest Simple Network Management Protocol packet size permitted when the SNMP server is receiving a request or generating a reply, use the snmp-server packetsize global configuration command. Use the no form of this command to restore the default value.

snmp-server packetsize byte-count

no snmp-server packetsize

Syntax Description

byte-count

Integer byte count from 484 to 8192. The default is 1500 bytes.

snmp-server queue-length

To establish the message queue length for each trap host, use the snmp-server queue-length global configuration command.

snmp-server queue-length length

Syntax Description

length

Integer that specifies the number of trap events that can be held before the queue must be emptied.

snmp-server system-shutdown

To use the Simple Network Management Protocol message reload feature, the router configuration must include the snmp-server system-shutdown global configuration command. The no form of this command prevents an SNMP system-shutdown request (from an SNMP manager) from resetting the Cisco agent.

snmp-server system-shutdown

no snmp-server system-shutdown

Syntax Description

This command has no arguments or keywords.

snmp-server tftp-server-list

To limit the TFTP servers used via Simple Network Management Protocol-controlled TFTP operations (saving and loading configuration files) to the servers specified in an access list, use the snmp-server tftp-server-list global configuration command. To disable this feature, use the no form of this command.

snmp-server tftp-server-list number

no snmp-server tftp-server-list

Syntax Description

number

Standard IP access list number from 1 to 99.

snmp-server trap-authentication

The snmp-server enable traps snmp authentication command replaces this command. See the snmp-server host command in this chapter for more information.

snmp-server trap-source

To specify the interface (and hence the corresponding IP address) that an Simple Network Management Protocol trap should originate from, use the snmp-server trap-source global configuration command. Use the no form of the command to remove the source designation.

snmp-server trap-source interface

no snmp-server trap-source

Syntax Description

interface

Interface from which the SNMP trap originates. The argument includes the interface type and number in platform-specific syntax.

snmp-server trap-timeout

To define how often to try resending trap messages on the retransmission queue, use the snmp-server trap-timeout global configuration command.

snmp-server trap-timeout seconds

Syntax Description

seconds

Integer that sets the interval, in seconds, for resending the messages.

s nmp-server user

To configure a new user to an Simple Network Management Protocol group, use the snmp-server user global configuration command. To remove a user from an SNMP group, use the no form of the command.

snmp-server user username [groupname remote ip-address [udp-port port] {v1 | v2c | v3} [encrypted] [auth {md5 | sha} auth-password [priv des56 priv password]] [access access-list]

no snmp-server user

Syntax Description

username

The name of the user on the host that connects to the agent.

groupname

(Optional) The name of the group to which the user is associated.

remote

(Optional) Specifies the remote copy of SNMP on the router.

ip-address

(Optional) The IP address of the device that contains the remote copy of SNMP.

udp-port

(Optional) Specifies a UDP port of the host to use.

port

(Optional) A UDP port number that the host uses. The default is 162.

v1

(Optional) The least secure of the possible security models.

v2c

(Optional) The second least secure of the possible security models. It allows for the transmission of informs and counter 64, which allows for integers twice the width of what is normally allowed.

v3

(Optional) The most secure of the possible security models.

encrypted

(Optional) Specifies whether the password appears in encrypted format (a series of digits, masking the true characters of the string).

auth

(Optional) Initiates an authentication level setting session.

md5

(Optional) The HMAC-MD5-96 authentication level.

sha

(Optional) The HMAC-SHA-96 authentication level.

auth-password

(Optional) A string (not to exceed 64 characters) that enables the agent to receive packets from the host.

priv

(Optional) The option that initiates a privacy authentication level setting session.

des56

(Optional) The CBC-DES privacy authentication algorithm.

priv password

(Optional) A string (not to exceed 64 characters) that enables the host to encrypt the contents of the message it sends to the agent.

access

(Optional) The option that enables you to specify an access list.

access-list

(Optional) A string (not to exceed 64 characters) that is the name of the access list.

snmp-server view

To create or update a view entry, use the snmp-server view global configuration command. To remove the specified Simple Network Management Protocol server view entry, use the no form of this command.

snmp-server view view-name oid-tree {included | excluded}

no snmp-server view view-name

Syntax Description

view-name

Label for the view record that you are updating or creating. The name is used to reference the record.

oid-tree

Object identifier of the ASN.1 subtree to be included or excluded from the view. To identify the subtree, specify a text string consisting of numbers, such as 1.3.6.2.4, or a word, such as system. Replace a single subidentifier with the asterisk (*) wildcard to specify a subtree family; for example 1.3.*.4.

included | excluded

Type of view. You must specify either included or excluded.

snmp trap link-status

To enable Simple Network Management Protocol link trap generation, use the snmp trap link-status interface configuration command. To disable SNMP link traps, use the no form of this command.

snmp trap link-status

no snmp trap link-status

Syntax Description

This command has no arguments or keywords.

statistics-di stribution-interval

To set the time interval for each statistics distribution kept for the SA Agent, use the statistics-distribution-interval RTR configuration command. Use the no form of this command to return to the default value.

statistics-distribution-interval milliseconds

no statistics-distribution-interval

Syntax Description

milliseconds

Number of milliseconds used for each statistics distribution kept. The default is 20 ms.

ta g

To create a user-specified identifier for an SA Agent operation, use the tag RTR configuration command. It is normally used to logically link operations in a group. Use the no form of this command to remove a tag from a operation.

tag text

no tag

Syntax Description

text

Name of a group that this operation belongs to. From 0 to 16 ASCII characters.

thre shold

To set the rising threshold (hysteresis) that generates a reaction event and stores history information for the SA Agent operation, use the threshold RTR configuration command. Use the no form of this command to return to the default value.

threshold millisecond

no threshold

Syntax Description

millisecond

Number of milliseconds required for a rising threshold to be declared. The default value is 5000 ms.

timeout

To set the amount of time the SA Agent operation waits for a response from its request packet, use the timeout RTR configuration command. Use the no form of this command to return to the default value.

timeout millisecond

no timeout

Syntax Description

millisecond

Number of milliseconds the operation waits to receive a response from its request packet. The default is 5000 ms.

to s

To define a type of service byte in the IP header of an RTR probe, use the tos RTR configuration command. Use the no form of this command to return to the default value.

tos number

no tos

Syntax Description

number

Service type byte in the IP header. The range is 0 to 255. The default is 0.

type dhcp

To configure a Dynamic Host Configuartion Protocol SA Agent operation, use the type dhcp RTR configuration command. To disable a DHCP SA Agent operation, use the no form of this command.

type dhcp

no type dhcp

Syntax Description

This command has no arguments or keywords.

type dlsw

To configure a data-link switching (DLSw) SA Agent operation, use the type dlsw RTR configuration command. To remove the type configuration for the operation, use the no form of this command.

type dlsw peer-ipaddr ipaddr

no type dlsw peer-ipaddr ipaddr

Syntax Description

peer-ipaddr

Peer destination.

ipaddr

IP address.

type dns

To configure a Domain Name System (DNS) SA Agent operation, use the type dns RTR configuration command. To remove the type configuration for the operation, use the no form of this command.

type dns target-addr target address name-server ipaddress

no type dns target-addr target address name-server ipaddress

Syntax Description

target-addr

Target IP address for the operation to measure.

target address

IP address or IP host name.

name-server

Name server of the Domain Name Server.

ipaddress

IP address of the Domain Name Server.

type echo

To configure an SA Agent end-to-end echo response time probe operation, use the type echo RTR configuration command. Use the no form of this command to remove the type configuration for the operation.

type echo protocol type type-target

no type echo protocol type type-target

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.

type http

To configure a Hyptertext Transfer Protocol (HTTP) SA Agent operation, use the type http RTR configuration command. To remove the type configuration for the operation, use the no form of this command.

type http operation {get | raw} url url [name-server ipaddress] [version version number] [source-ipaddr {name | ipaddr}] [source-port port number] [cache {enable | disable}] [proxy proxy-url]

no type http operation {get | raw} url url [name-server ipaddress] [version version number] [source-ipaddr {name | ipaddr}] [source-port port number] [cache {enable | disable}] [proxy proxy-url]

Syntax Description

operation get

Specifies an HTTP GET operation.

operation raw

Specifies an HTTP RAW operation.

url url

Specifies the URL of destination HTTP server.

name-server

(Optional) Specifies name of destination Domain Name Server.

ipaddress

(Optional) IP address of Domain Name Server.

version

(Optional) Specifies version number.

version number

(Optional) Version number.

source-ipaddr

(Optional) Specifies source name or IP address.

name

Source name.

ipaddr

Source IP address.

source-port

(Optional) Specifies source port.

port number

(Optional) Source port number.

cache

(Optional) Enables or disables download of cached HTTP page.

enable

Enables downloads of cached HTTP page.

disable

Disables download of cached HTTP page.

proxy

(Optional) Proxy information.

proxy-url

(Optional) Proxy information or URL.

type jitter

To configure a jitter SA Agent operation, use the type jitter RTR configuration command. To disable a jitter operation, use the no form of this command.

type jitter dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name | ipaddr}] [source-port port-number] [control {enable | disable}] [num-packets number-of-packets] [interval inter-packet-interval]

no type jitter dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name | ipaddr}] [source-port port-number] [control {enable | disable}] [num-packets number-of-packets] [interval inter-packet-interval]

Syntax Description

dest-ipaddr

Destination.

name

IP host name.

ipaddr

IP address.

dest-port

Destination port.

port-number

Port number of the destination port.

source-ipaddr

(Optional) Source IP address.

name

IP host name.

ipaddr

IP address.

source-port

(Optional) Source port.

port-number

(Optional) Port number of the source.

control

(Optional) Combined with the enable or disable keyword, enables or disables sending a control message to the destination port.

enable

Enables the SA Agent to send a control message to the destination port prior to sending a operation packet. This is the default value.

disable

Disables sending of control messages to the responder prior to sending a operation packet.

num-packets number

(Optional) Number of packets, as specified by the number argument. The default value is 10.

interval inter-packet-interval

(Optional) Interpacket interval in milliseconds. The default value of the inter-packet-interval argument is 20 ms.

type pathEcho

To configure an IP/ICMP Path Echo SA Agent operation, use the type pathEcho RTR configuration command. Use the no form of this command to remove the operation from the configuration.

type pathEcho protocol ipIcmpEcho {ip-address | ip-host-name}

no type pathEcho protocol ipIcmpEcho {ip-address | ip-host-name}

Syntax Description

protocol ipIcmpEcho

Specifies an IP/ICMP Echo operation. This is currently the only protocol type supported for the SA Agent Path Echo operation.

ip-address

Specifies the IP address of the target device.

ip-host-name

Specifies the designated IP name of the target device.

type tcpConnect

To define a tcpConnect probe, use the type tcpConnect RTR configuration command. Use the no form of this command to remove the type configuration for the probe.

type tcpConnect dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name | ipaddr} source-port port-number] [control {enable | disable}]

no type tcpConnect dest-ipaddr {name | ipaddr} dest-port port-number

Syntax Description

dest-ipaddr
name | ipaddr

Destination of tcpConnect 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.

type udpEcho

To define a udpEcho probe, use the type udpEcho RTR configuration command. Use the no form of this command to remove the type configuration for the probe.

type udpEcho dest-ipaddr {name | ipaddr} dest-port port-number [source-ipaddr {name | ipaddr} source-port port-number] [control {enable | disable}]

no type udpEcho dest-ipaddr {name | ipaddr} dest-port port-number

Syntax Description

dest-ipaddr name | ipaddr

Destination of the udpEcho probe. Use an IP host name or IP address.

dest-port port-number

Destination port number. The range of port numbers is from 1 to 65,535.

source-ipaddr name | ipaddr

(Optional) Source IP host name or IP address.

source-port port-number

(Optional) Port number of the source. When a port number is not specified, SA Agent picks the best IP address (nearest to the target) and available UDP port

control

(Optional) Specifies that the SA Agent RTR control protocol should be used when running this probe. The control protocol is required when the probe's target is a Cisco router that does not natively provide the service (UDP service in this case). Combined with the enable or disable keyword, enables or disables sending of a control message to the destination port. The default is that the control protocol is enabled.

enable

Enable the SA Agent collector to send a control message to the destination port prior to sending a probe packet.

disable

Disable the SA Agent from sending a control message to the responder prior to sending a probe packet.

verify-data

To cause the SA Agent operation to check each response for corruption, use the verify-data RTR configuration command. Use the no form of this command to return to the default value.

verify-data

no verify-data

Syntax Description

This command has no arguments or keywords.

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.

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.

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

*	Shows all of the CDP neighbors.
entry-name	Name of neighbor about which you want information. You can enter an asterisk () at the end of an entry-name, such as `show cdp entry dev`, which would show information about the neighbor, device.cisco.com.
protocol	(Optional) Limits the display to information about the protocols enabled on a router.
version	(Optional) Limits the display to information about the version of software running on the router.

type	(Optional) Type of interface about which you want information.
number	(Optional) Number of the interface about which you want information.

type	(Optional) Type of the interface connected to the neighbors about which you want information.
number	(Optional) Number of the interface connected to the neighbors about which you want information.
detail	(Optional) Displays detailed information about a neighbor (or neighbors) including network address, enabled protocols, hold time, and software version.

alarms	(Optional) Displays the RMON alarm table.
capture	(Optional) Displays the RMON buffer capture table. Available on Cisco 2500 series and Cisco AS5200 series only.
events	(Optional) Displays the RMON event table.
filter	(Optional) Displays the RMON filter table. Available on Cisco 2500 series and Cisco AS5200 series only.
history	(Optional) Displays the RMON history table. Available on Cisco 2500 series and Cisco AS5200 series only.
hosts	(Optional) Displays the RMON hosts table. Available on Cisco 2500 series and Cisco AS5200 series only.
matrix	(Optional) Displays the RMON matrix table. Available on Cisco 2500 series and Cisco AS5200 series only.
statistics	(Optional) Displays the RMON statistics table. Available on Cisco 2500 series and Cisco AS5200 series only.
task	(Optional) Displays general RMON statistics. This is the default.
topn	(Optional) Displays the RMON top-n hosts table. Available on Cisco 2500 series and Cisco AS5200 series only.

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.

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.

string	Community string that acts like a password and permits access to the SNMP protocol.
view view-name	(Optional) Name of a previously defined view. The view defines the objects available to the community.
ro	(Optional) Specifies read-only access. Authorized management stations are only able to retrieve MIB objects.
rw	(Optional) Specifies read-write access. Authorized management stations are able to both retrieve and modify MIB objects.
number	(Optional) Integer from 1 to 99 that specifies an access list of IP addresses that are allowed to use the community string to gain access to the SNMP agent.

notification-type	(Optional) Type of notification to enable. If no type is specified, all notifications are sent (including the envmon and repeater notifications). The notification type can be one of the following keywords: bgp---Sends Border Gateway Protocol (BGP) state change notifications. config---Sends configuration notifications. entity---Sends Entity MIB modification notifications. envmon---Sends Cisco enterprise-specific environmental monitor notifications when an environmental threshold is exceeded. When the envmon keyword is used, you can specify a notification-option value. frame-relay---Sends Frame Relay notifications. hsrp---Sends Hot Standby Routing Protocol (HSRP) notifications. isdn---Sends Integrated Services Digital Network (ISDN) notifications. When the isdn keyword is used, you can specify a notification-option value. repeater---Sends Ethernet hub repeater notifications. When the repeater keyword is selected, you can specify a notification-option value. rsvp---Sends Resource Reservation Protocol (RSVP) notifications. rtr---Sends Service Assurance Agent RTR (RTR) notifications. snmp---Sends Simple Network Management Protocol (SNMP) notifications. When the snmp keyword is used, you can specify a notification-option value. syslog---Sends error message notifications (Cisco Syslog MIB). Specify the level of messages to be sent with the logging history level command.
notification-option	(Optional) envmon [voltage \| shutdown \| supply \| fan \| temperature] When the envmon keyword is used, you can enable a specific environmental notification type, or accept all notification types from the environmental monitor system. If no option is specified, all environmental notifications are enabled. The option can be one or more of the following keywords: voltage, shutdown, supply, fan, and temperature. isdn [call-information \| isdn u-interface] When the isdn keyword is used, you can specify the call-information keyword to enable an SNMP ISDN call information notification for the ISDN MIB subsystem, or you can specify the isdnu-interface keyword to enable an SNMP ISDN U interface notification for the ISDN U interface MIB subsystem. repeater [health \| reset] When the repeater keyword is used, you can specify the repeater option. If no option is specified, all repeater notifications are enabled. The option can be one or more of the following keywords: health---Enables IETF Repeater Hub MIB (RFC 1516) health notification. reset---Enables IETF Repeater Hub MIB (RFC 1516) reset notification. snmp [authentication] When the snmp keyword is used, you can specify the authentication option to enable SNMP Authentication Failure notifications. (The snmp-sever enable traps snmp authentication command replaces the snmp-server trap-authentication command.) If no option is specified, all SNMP notifications are enabled.

local	(Optional) Specifies the local copy of SNMP on the router.
engineid-string	(Optional) The name of a copy of SNMP.
remote	(Optional) Specifies the remote copy of SNMP on the router.
ip-address	(Optional) The IP address of the device that contains the remote copy of SNMP.
udp-port	(Optional) Specifies a UDP port of the host to use.
port	(Optional) The socket number on the remote device that contains the remote copy of SNMP. The default is 161.

groupname	(Optional) The name of the group.
v1	(Optional) The least secure of the possible security models.
v2c	(Optional) The second least secure of the possible security models. It allows for the transmission of informs and counter 64, which allows for integers twice the width of what is normally allowed.
v3	(Optional) The most secure of the possible security models.
auth	(Optional) Specifies authentication of a packet without encrypting it.
noauth	(Optional) Specifies no authentication of a packet.
priv	(Optional) Specifies authentication of a packet with encryption.
read	(Optional) The option that allows you to specify a read view.
readview	(Optional) A string (not to exceed 64 characters) that is the name of the view that enables you only to view the contents of the agent.
write	(Optional) The option that allows you to specify a write view.
writeview	(Optional) A string (not to exceed 64 characters) that is the name of the view that enables you to enter data and configure the contents of the agent.
notify	(Optional) The option that allows you to specify a notify view
notifyview	(Optional) A string (not to exceed 64 characters) that is the name of the view that enables you to specify a notify, inform, or trap.
access	(Optional) The option that enables you to specify an access list.
access-list	(Optional) A string (not to exceed 64 characters) that is the name of the access list.

host-addr	Name or Internet address of the host (the targeted recipient).
traps	(Optional) Send SNMP traps to this host. This is the default.
informs	(Optional) Send SNMP informs to this host.
version	(Optional) Version of the Simple Network Management Protocol (SNMP) used to send the traps. Version 3 is the most secure model, as it allows packet encryption with the priv keyword. If you use the version keyword, one of the following must be specified: 1 ---SNMPv1. This option is not available with informs. 2c ---SNMPv2C. 3 ---SNMPv3. The following three optional keywords can follow the version 3 keyword: auth (Optional). Enables Message Digest 5 (MD5) and Secure Hash Algorithm (SHA) packet authentication noauth (Default). The noAuthNoPriv security level. This is the default if the [auth \| noauth \| priv] keyword choice is not specified. priv (Optional). Enables Data Encryption Standard (DES) packet encrytion (also called "privacy").
community-string	Password-like community string sent with the notification operation. Though you can set this string using the snmp-server host command by itself, we recommend you define this string using the snmp-server community command prior to using the snmp-server host command.
udp-port port	UDP port of the host to use. The default is 162.
notification-type	(Optional) Type of notification to be sent to the host. If no type is specified, all notifications are sent. The notification type can be one or more of the following keywords: bgp---Sends Border Gateway Protocol (BGP) state change notifications. config---Sends configuration notifications. dspu---Sends downstream physical unit (DSPU) notifications. entity---Sends Entity MIB modification notifications. envmon---Sends Cisco enterprise-specific environmental monitor notifications when an environmental threshold is exceeded. frame-relay---Sends Frame Relay notifications. hsrp---Sends Hot Stanby Routing Protocol (HSRP) notifications. isdn---Sends Integrated Services Digital Network (ISDN) notifications. llc2---Sends Logical Link Control, type 2 (LLC2) notifications. repeater---Sends standard repeater (hub) notifications. rsrb---Sends remote source-route bridging (RSRB) notifications. rsvp---Sends Resource Reservation Protocol (RSVP) notifications. rtr---Sends SA Agent (RTR) notifications. sdlc---Sends Synchronous Data Link Control (SDLC) notifications. sdllc---Sends SDLLC notifications. snmp---Sends Simple Network Management Protocol (SNMP) notifications (as defined in RFC 1157). stun---Sends serial tunnel (STUN) notifications. syslog---Sends error message notifications (Cisco Syslog MIB). Specify the level of messages to be sent with the logging history level command. tty---Sends Cisco enterprise-specific notifications when a Transmission Control Protocol (TCP) connection closes. x25---Sends X.25 event notifications.

retries retries	(Optional) Maximum number of times to resend an inform request. The default is 3.
timeout second	(Optional) Number of seconds to wait for an acknowledgment before resending. The default is 30 seconds.
pending pending	(Optional) Maximum number of informs waiting for acknowledgments at any one time. When the maximum is reached, older pending informs are discarded. The default is 25.

username	The name of the user on the host that connects to the agent.
groupname	(Optional) The name of the group to which the user is associated.
remote	(Optional) Specifies the remote copy of SNMP on the router.
ip-address	(Optional) The IP address of the device that contains the remote copy of SNMP.
udp-port	(Optional) Specifies a UDP port of the host to use.
port	(Optional) A UDP port number that the host uses. The default is 162.
v1	(Optional) The least secure of the possible security models.
v2c	(Optional) The second least secure of the possible security models. It allows for the transmission of informs and counter 64, which allows for integers twice the width of what is normally allowed.
v3	(Optional) The most secure of the possible security models.
encrypted	(Optional) Specifies whether the password appears in encrypted format (a series of digits, masking the true characters of the string).
auth	(Optional) Initiates an authentication level setting session.
md5	(Optional) The HMAC-MD5-96 authentication level.
sha	(Optional) The HMAC-SHA-96 authentication level.
auth-password	(Optional) A string (not to exceed 64 characters) that enables the agent to receive packets from the host.
priv	(Optional) The option that initiates a privacy authentication level setting session.
des56	(Optional) The CBC-DES privacy authentication algorithm.
priv password	(Optional) A string (not to exceed 64 characters) that enables the host to encrypt the contents of the message it sends to the agent.
access	(Optional) The option that enables you to specify an access list.
access-list	(Optional) A string (not to exceed 64 characters) that is the name of the access list.

view-name	Label for the view record that you are updating or creating. The name is used to reference the record.
oid-tree	Object identifier of the ASN.1 subtree to be included or excluded from the view. To identify the subtree, specify a text string consisting of numbers, such as 1.3.6.2.4, or a word, such as system. Replace a single subidentifier with the asterisk () wildcard to specify a subtree family; for example 1.3..4.
included \| excluded	Type of view. You must specify either included or excluded.

target-addr	Target IP address for the operation to measure.
target address	IP address or IP host name.
name-server	Name server of the Domain Name Server.
ipaddress	IP address of the Domain Name Server.

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.

operation get	Specifies an HTTP GET operation.
operation raw	Specifies an HTTP RAW operation.
url url	Specifies the URL of destination HTTP server.
name-server	(Optional) Specifies name of destination Domain Name Server.
ipaddress	(Optional) IP address of Domain Name Server.
version	(Optional) Specifies version number.
version number	(Optional) Version number.
source-ipaddr	(Optional) Specifies source name or IP address.
name	Source name.
ipaddr	Source IP address.
source-port	(Optional) Specifies source port.
port number	(Optional) Source port number.
cache	(Optional) Enables or disables download of cached HTTP page.
enable	Enables downloads of cached HTTP page.
disable	Disables download of cached HTTP page.
proxy	(Optional) Proxy information.
proxy-url	(Optional) Proxy information or URL.

Table of Contents

Router and Network Monitoring Commands

dest-ipaddr	Destination.
name	IP host name.
ipaddr	IP address.
dest-port	Destination port.
port-number	Port number of the destination port.
source-ipaddr	(Optional) Source IP address.
name	IP host name.
ipaddr	IP address.
source-port	(Optional) Source port.
port-number	(Optional) Port number of the source.
control	(Optional) Combined with the enable or disable keyword, enables or disables sending a control message to the destination port.
enable	Enables the SA Agent to send a control message to the destination port prior to sending a operation packet. This is the default value.
disable	Disables sending of control messages to the responder prior to sending a operation packet.
num-packets number	(Optional) Number of packets, as specified by the number argument. The default value is 10.
interval inter-packet-interval	(Optional) Interpacket interval in milliseconds. The default value of the inter-packet-interval argument is 20 ms.

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.

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.

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.