SNMP Server Commands

SNMP Server Commands

This chapter describes the Cisco IOS XR software commands used to configure and monitor the Simple

Network Management Protocol (SNMP) for network monitoring and management.

For detailed information about SNMP concepts, configuration tasks, and examples, see the Implementing

SNMP on Cisco IOS XR Software configuration module in Cisco ASR 9000 Series Aggregation Services

Router System Management Configuration Guide.

Note

The snmp-server commands enable SNMP on Management Ethernet interfaces by default. For information about how to enable SNMP server support on other inband interfaces, see the Implementing Management

Plane Protection on Cisco IOS XR Software module in Cisco ASR 9000 Series Aggregation Services

Router System Security Configuration Guide.

•

add (bulkstat object), page 6

•

buffer-size, page 8

•

clear snmp counters, page 9

•

enable (bulkstat), page 10

•

format (bulkstat), page 12

•

index persistence, page 14

•

instance (bulkstat schema), page 16

•

instance range, page 18

•

instance repetition, page 20

•

notification linkupdown, page 22

•

object-list, page 24

•

poll-interval, page 26

•

retain, page 28

•

retry, page 30

•

schema, page 32

Cisco ASR 9000 Series Aggregation Services Router System Management Command Reference, Release 5.3.x

1

•

show snmp, page 34

•

show snmp context, page 37

•

show snmp context-mapping, page 39

•

show snmp engineid, page 41

•

show snmp entity, page 42

•

show snmp group, page 45

•

show snmp host, page 47

•

show snmp interface, page 49

•

show snmp interface notification, page 51

•

show snmp interface regular-expression, page 53

•

show snmp mib, page 55

•

show snmp mib bulkstat transfer, page 58

•

show snmp request duplicates, page 60

•

show snmp request incoming-queue detail, page 61

•

show snmp request type summary, page 63

•

show snmp request type detail, page 65

•

show snmp request drop summary, page 67

•

show snmp request overload stats, page 69

•

show snmp statistics oid group, page 71

•

show snmp statistics pdu, page 73

•

show snmp statistics slow oid, page 75

•

show snmp statistics poll oid all, page 77

•

Show snmp statistics poll oid nms, page 79

•

show snmp statistics slow oid [after/before] hh:mm:ss day mday year, page 80

•

show snmp mib ifmib general, page 82

•

show snmp mib ifmib cache, page 84

•

show snmp mib ifmib statsd, page 86

•

show snmp traps details, page 88

•

show snmp informs details, page 90

•

show snmp users, page 92

•

show snmp view, page 94

•

snmp-server chassis-id, page 96

•

snmp-server community, page 98


2



•

snmp-server community-map, page 101

•

snmp-server contact, page 103

•

snmp-server context, page 105

•

snmp-server context mapping, page 107

•

snmp-server engineid local, page 109

•

snmp-server engineid remote, page 111

•

snmp-server entityindex persist, page 113

•

snmp-server group, page 114

•

snmp-server host, page 117

•

snmp-server ifindex persist, page 121

•

snmp-server ifmib ifalias long, page 123

•

snmp-server ifmib internal cache max-duration, page 124

•

snmp-server ifmib ipsubscriber, page 126

•

snmp-server ifmib stats cache, page 127

•

snmp-server inform, page 129

•

snmp-server interface, page 131

•

snmp-server interface subset, page 133

•

snmp-server ipv4 dscp, page 135

•

snmp-server ipv4 precedence , page 136

•

snmp-server location, page 138

•

snmp-server mib bulkstat max-procmem-size, page 140

•

snmp-server mib bulkstat object-list, page 141

•

snmp-server mib bulkstat schema, page 143

•

snmp-server mib bulkstat transfer-id, page 145

•

snmp-server mibs cbqosmib cache, page 147

•

snmp-server mibs cbqosmib persist, page 149

•

snmp-server mibs eventmib congestion-control, page 150

•

snmp-server mibs eventmib packet-loss, page 152

•

snmp-server mibs subscriber threshold, page 154

•

snmp-server mibs subscriber threshold access-if, page 156

•

snmp-server notification-log-mib, page 158

•

snmp-server packetsize, page 160

•

snmp-server queue-length, page 161


3

•

snmp-server target list, page 162

•

snmp-server throttle-time, page 164

•

snmp-server timeouts subagent, page 166

•

snmp-server timeouts duplicate, page 167

•

snmp-server trap authentication vrf disable, page 168

•

snmp-server trap link ietf, page 169

•

snmp-server trap throttle-time, page 171

•

snmp-server traps, page 172

•

snmp-server traps bgp, page 179

•

snmp-server traps frequency synchronization, page 181

•

snmp-server traps mpls l3vpn, page 182

•

snmp-server traps ospf errors, page 184

•

snmp-server traps ospf lsa, page 186

•

snmp-server traps ospf retransmit, page 188

•

snmp-server traps ospf state-change, page 190

•

snmp-server traps pim interface-state-change, page 192

•

snmp-server traps pim invalid-message-received, page 194

•

snmp-server traps pim neighbor-change, page 196

•

snmp-server traps pim rp-mapping-change, page 198

•

snmp-server traps rsvp, page 200

•

snmp-server traps selective-vrf-download role-change, page 201

•

snmp-server traps snmp, page 202

•

snmp-server traps syslog, page 205

•

snmp-server trap-source, page 207

•

snmp-server traps subscriber session-aggregation, page 209

•

snmp-server trap-timeout, page 210

•

snmp-server user, page 212

•

snmp-server view, page 215

•

snmp-server vrf, page 217

•

snmp test trap all, page 220

•

snmp test trap entity, page 222

•

snmp test trap infra, page 224

•

snmp test trap interface, page 226

4




•

snmp test trap snmp, page 227

•

transfer-interval, page 228

•

url, page 230


5

SNMP Server Commands add (bulkstat object)

add (bulkstat object)

To add a MIB object to a Simple Network Management Protocol (SNMP) bulk statistics object list, use the

add command in bulk statistics object list configuration mode. To remove a MIB object from an SNMP bulk statistics object list, use the no form of this command.

add {object-name| OID}

no add {object-name| OID}

Syntax Description

object-name

OID

Name of the MIB object to add to the list. Object names are limited to those with mappings shown in the show snmp mib object-name command.

Object identifier (OID) of the MIB object to add to the list.

Command Default

No MIB objects are configured for an object list.

Command Modes

Bulk statistics object list configuration

Command History

Release

Release 4.2.0

Modification

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task

IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

All object names and OIDs in a single object list should belong to the same MIB index, but the objects need not belong to the same MIB table. For example, it is possible to group ifInoctets and a

CISCO-IF-EXTENSION-MIB object in the same schema because the containing tables are indexed by the ifIndex (in the IF-MIB).

The add command should be repeated as necessary until all MIB objects have been added to the object list.

Task ID

Task ID

snmp

Operation

read, write

6


SNMP Server Commands add (bulkstat object)

Examples

The following example shows how to add various MIB objects to an object list.

RP/0/RSP0/CPU0:router(config-bulk-objects)# add 1.3.6.1.2.1.2.2.1.11

RP/0/RSP0/CPU0:router(config-bulk-objects)# add ifAdminStatus

RP/0/RSP0/CPU0:router(config-bulk-objects)# add ifDescr

Related Commands

Command

show snmp mib

Description

Displays a list of MIB module object identifiers registered on the system.


7

SNMP Server Commands buffer-size

buffer-size

To configure a maximum buffer size for the transfer of bulk statistics files, use the buffer-size command in bulk statistics transfer configuration mode. To remove a previously configured buffer size from the configuration, use the no form of this command.

buffer-size bytes

no buffer-size [ bytes ]


bytes

Size of the bulk statistics transfer buffer, in bytes. The valid range is from 1024 to

2147483647. The default is 2048.

Command Default

The default bulk statistics transfer buffer is 2048 bytes.

Command Modes

Bulk statistics transfer configuration

Command History

Release

Release 4.2.0

Modification





A configured buffer size limit is available primarily as a safety feature. Normal bulk statistics files should not generally meet or exceed the default value while being transferred.

Task ID

Task ID

snmp

Operation

read, write

Examples

This example shows how to set the buffer size to 1024 bytes:

RP/0/RSP0/CPU0:router#

configure

RP/0/RSP0/CPU0:router(config)#

snmp-server mib bulkstat transfer bulkstat1

RP/0/RSP0/CPU0:router(config-bulk-tr)#

buffer-size 1024

8


SNMP Server Commands clear snmp counters

clear snmp counters

To clear the Simple Network Management Protocol (SNMP) packet statistics shown by the show snmp command, use the clear snmp counters command in EXEC mode.



This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC mode

Command History

Release

Release 3.7.2

Modification





The clear snmp counters command provides the ability to clear all SNMP counters used in the show snmp command without restarting any processes.

Task ID

Task ID

snmp

Operations

read, write

Examples

The following example shows how to clear the SNMP counters:




Command

show snmp

Description

Displays the status of SNMP communications


9

SNMP Server Commands enable (bulkstat)

enable (bulkstat)

To begin the bulk statistics data collection and transfer process for a specific bulk statistics configuration, use the enable command in bulk statistics transfer configuration mode. To disable the bulk statistics data collection and transfer process for a specific bulk statistics configuration, use the no form of this command.

enable no enable



Command Default

Bulk statistics transfer is disabled.

Command Modes


Command History

Release

Release 4.2.0

Modification





Specific bulk statistics configurations are identified with a name, as specified in the snmp-server mib bulkstat

transfer-id command. The enable command begins the periodic MIB data collection and transfer process.

Collection (and subsequent file transfer) starts only if this command is used. Conversely, the no enable command stops the collection process. Subsequently, issuing the enable command starts the operations again.

Each time the collection process is started using the enable command, data is collected into a new bulk statistics file. When the no enable command is used, the transfer process for any collected data immediately begins

(in other words, the existing bulk statistics file are transferred to the specified management station).

To successfully enable a bulk statistics configuration, at least one schema with a non-zero number of objects must be configured.

Task ID

Task ID

snmp

Operation

read, write

10


SNMP Server Commands enable (bulkstat)

Examples

The following example shows the bulk statistics transfer configuration named bulkstat1 as enabled:


configure




schema ATM2/0-IFMIB


url primary ftp://user:pswrd@host/folder/bulkstat1


enable


exit


Command

show snmp mib bulkstat transfer

snmp-server mib bulkstat transfer-id

Description

Displays completed local bulk statistics files.

Identifies the bulk statistics transfer configuration and enters bulk statistics transfer configuration mode.


11

SNMP Server Commands format (bulkstat)

format (bulkstat)

To specify the format to be used for the bulk statistics data file, use the format command in bulk statistics transfer configuration mode. To disable a previously configured format specification and return to the default, use the no form of this command.

format {bulkBinary| bulkASCII| schemaASCII}

no format [bulkBinary| bulkASCII| schemaASCII]

Syntax Description bulkBinary bulkASCII schemaASCII

Binary format.

ASCII format.

A human-readable ASCII format that contains additional bulk statistics schema tags. This is the default.

Command Default

The default bulk statistics transfer format is schemaASCII

Command Modes


Command History

Release

Release 4.2.0

Modification





The bulk statistics data file (VFile) contains two types of fields: tags and data. Tags are used to set off data to distinguish fields of the file. All other information is in data fields.

Transfers can only be performed using schemaASCII format.

For each transfer/schema pair there is a header with tags for each object collected, followed by the collected data. For example, if the transfer name is T1 and the schemas in it are S1 (which collects ifInOctets and ifOutOctets) and S2 (which collects ifInUcastPkts and ifInDiscards). Then the output file looks like this:

Schema-def cempt1.cempWild "%u, %s, %s, %d" Epochtime instanceoid

1.3.6.1.4.1.9.9.221.1.1.1.1.3 1.3.6.1.4.1.9.9.221.1.1.1.1.2

cempt1.cempWild: 1339491515, 8695772.1, processor, 2 cempt1.cempWild: 1339491515, 8695772.2, reserved, 11 cempt1.cempWild: 1339491515, 8695772.3, image, 12 cempt1.cempWild: 1339491575, 8695772.1, processor, 2 cempt1.cempWild: 1339491575, 8695772.2, reserved, 11 cempt1.cempWild: 1339491575, 8695772.3, image, 12

12


SNMP Server Commands format (bulkstat)

Task ID

Schema-def cempt1.cempRepeat "%u, %s, %s, %d" Epochtime instanceoid

1.3.6.1.4.1.9.9.221.1.1.1.1.3 1.3.6.1.4.1.9.9.221.1.1.1.1.2

cempt1.cempRepeat: 1339491515, 8695772.1, processor, 2 cempt1.cempRepeat: 1339491515, 8695772.2, reserved, 11 cempt1.cempRepeat: 1339491515, 8695772.3, image, 12 cempt1.cempRepeat: 1339491515, 26932192.1, processor, 2 cempt1.cempRepeat: 1339491515, 26932192.2, reserved, 11 cempt1.cempRepeat: 1339491515, 26932192.3, image, 12 cempt1.cempRepeat: 1339491515, 35271015.1, processor, 2 cempt1.cempRepeat: 1339491515, 35271015.2, reserved, 11 cempt1.cempRepeat: 1339491515, 35271015.3, image, 12 cempt1.cempRepeat: 1339491515, 36631989.1, processor, 2 cempt1.cempRepeat: 1339491515, 36631989.2, reserved, 11 cempt1.cempRepeat: 1339491515, 36631989.3, image, 12 cempt1.cempRepeat: 1339491515, 52690955.1, processor, 2 cempt1.cempRepeat: 1339491515, 52690955.2, reserved, 11 cempt1.cempRepeat: 1339491515, 52690955.3, image, 12

Task ID

snmp

Operation

read, write

Examples

This example shows how to specify the data format:


configure




format schemaASCII


Command



Description




13

SNMP Server Commands index persistence

index persistence

To enable index persistence on an Simple Network Management Protocol (SNMP) interface, use the index

persistence command in SNMP interface configuration mode. To restore the default conditions with respect to this command, use the no form of this command.

index persistence no index persistence



Command Default

Index persistence is disabled.

Command Modes

SNMP interface configuration

Command History

Release

Release 3.7.2

Modification





Use the index persistence command to enable ifIndex persistence for individual entries (corresponding to individual interfaces) in the ifIndex table of the IF-MIB. IfIndex persistence retains the mapping between the ifName object values and the ifIndex object values (generated from the IF-MIB) across reboots, allowing for consistent identification of specific interfaces using SNMP.

Task ID

Task ID

snmp

Operations

read, write

Examples

The following example shows how to assign ifIndex persistence on interface 0/0/1/0:


snmp-server interface tengige 0/0/1/0

RP/0/RSP0/CPU0:router(config-snmp-if)#

index persistence

14


SNMP Server Commands index persistence


Command

show snmp interface

snmp-server engineid local

snmp-server ifindex persist

snmp-server interface

Description

Displays the interface index identification numbers (ifIndex values) for all the interfaces or a specified interface.

Specifies an SNMP engine ID on the local device.

Enables ifIndex persistence globally on all SNMP interfaces.

Enables an interface to send SNMP trap notifications and enters SNMP interface configuration mode.


15

SNMP Server Commands instance (bulkstat schema)

instance (bulkstat schema)

To configure the MIB object instances to be used in a Simple Network Management Protocol (SNMP) bulk statistics schema, use the instance command in bulk statistics configuration mode. To remove the instance definition, use the no form of this command.

instance {exact | wild } {interface interface-id [sub-if]| oid oid}

no instance

Syntax Description exact wild

interface interface-id

[sub-if]

oid oid

Specifies that the specified interface or object identifier (OID), when appended to the object list, is the complete OID to be used in this schema.

Specifies that all instances that fall within the the specified OID or interface are included in this schema.

Specifies an interface to be used to define the schema instance.

(Optional) Specifies that the object instances are polled for all subinterfaces of the specified interface in addition to the object instances for the main interface.

Specifies an OID to be used to define the schema instance.

Command Default

No instances are configured.

Command Modes

Bulk statistics schema configuration

Command History

Release

Release 4.2.0

Modification





The instance command specifies the instance information for objects in the schema being configured. The specific instances of MIB objects for which data is collected are determined by appending the value of the instance command to the objects specified in the associated object list. In other words, the schema object-list when combined with the schema instance specifies a complete MIB object identifier.

The instance exact command indicates that the specified instance, when appended to the object list, is the complete OID.

16


SNMP Server Commands instance (bulkstat schema)

Task ID

The instance wild command indicates that all subindices of the specified OID belong to this schema. For example, the command instance wild oid 1 includes all subindices of the instance, such as 1.1, 1.2 and so on. It does not include other instances that start with the number 1, such as 10 and 11.

Instead of specifying an OID, you can specify a specific interface. The interface interface-id keyword and argument allow you to specify an interface name and number (for example, gigabitethernet 0/6/5/0) instead of specifying the ifIndex OID for the interface.

The optional sub-if keyword, when added after specifying an interface, includes the ifIndexes for all subinterfaces of the interface you specified.

Only one instance command can be configured per schema. If multiple instance commands are used, the later commands overwrite the earlier ones.

Task ID

snmp

Operation

read, write

Examples

The following examples show two different ways to configure an instance.

RP/0/RSP0/CPU0:router(config-bulk-sc)#

instance wild oid 1


instance exact interface FastEthernet 0/1.25


Command

instance range

Description

Specifies a range of instances for objects in a schema.

instance repetition

snmp-server mib bulkstat schema

Configures bulk statistics data collection to begin at a particular instance of a MIB object and to repeat for a given number of instances.

Configures an SNMP bulk statistics schema and enters bulk statistics schema configuration mode.


17

SNMP Server Commands instance range

instance range

To specify a range of instances for objects in a schema, use the instance command in bulk statistics schema configuration mode. To remove the configured instance information, use the no form of this command.

instance range start start-oid end end-oid

no instance


start start-oid

end end-oid

Specifies the first OID value of a range of values.

Specifies the last OID value of a range of values.

Command Default

No instances are configured.

Command Modes


Command History

Release

Release 4.2.0

Modification






Task ID

Task ID

snmp

Operation

read, write

Examples

The following example shows how to configure a range of instances.


instance range start 1 end 2

18


SNMP Server Commands instance range


Command

instance (bulkstat schema)


Description

Configures the MIB object instances to be used in a bulk statistics schema.



19

SNMP Server Commands instance repetition

instance repetition

To configure bulk statistics data collection to begin at a particular instance of a MIB object and to repeat for a given number of instances , use the instance repetition command in bulk statistics schema configuration mode. To delete a previously configured repetition of instances, use the no form of this command.

instance repetition oid-instance max repeat-number

no instance


oid-instance

max repeat-number

Object ID of the instance to be monitored.

Specifies the number of times the instance should repeat.

Command Default

No instance repetition is configured.

Command Modes


Command History

Release

Release 4.2.0

Modification





The instance repetition command is used to configure data collection to repeat for a certain number of instances of a MIB object.


Task ID

Task ID

snmp

Operation

read, write

Examples

The following example configures 4 repetitions of the OID of value 1.


configure


snmp-server mib bulkstat object-list ifmib

20


SNMP Server Commands instance repetition

RP/0/RSP0/CPU0:router(config-bulk-objects)#

add ifOutOctets


add ifInOctets


exit


snmp mib-server bulkstat schema IFMIB


object-list ifmib


poll-interval 1


instance repetition 1 max 4


Command


instance range


Description


Specifies a range of instances for objects in a schema.



21

SNMP Server Commands notification linkupdown

notification linkupdown

To enable or disable linkUp and linkDown trap notifications on a Simple Network Management Protocol

(SNMP) interface, use the notification linkupdown command in SNMP interface configuration mode. To revert to the default setting, use the no form of this command.

notification linkupdown disable no notification linkupdown disable

Syntax Description disable

Disables linkUp and linkDown trap notifications on an SNMP interface.



Command Default

By default, for all main interfaces the linkUp and linkDown trap notifications are enabled; for all subinterfaces they are disabled.

Command Modes

SNMP interface configuration

SNMP interface subset configuration

Command History

Release

Release 3.7.2

Release 3.9.0

Modification


This command was supported in the SNMP interface subset configuration mode.




Enabling of linkUp and linkDown notifications is performed globally using the snmp-server traps snmp command. Issue the notification linkupdown command to disable linkUp and linkDown notifications on an interface.

Use the no form of this command to enable linkUp and linkDown notifications on an interface, if linkUp and linkDown notifications have been disabled.

You can also use the snmp-server interface subset command to enable or disable groups of interfaces.

22


SNMP Server Commands notification linkupdown

Task ID

Task ID

snmp

Operations

read, write

Examples

The following example shows how to disable linkUp and linkDown trap notifications on interface 0/0/1/0:


snmp-server interface tengige 0/0/1/0


notification linkupdown disable


Command

show snmp interface




snmp-server interface subset

snmp-server traps snmp

Description




Enables an interface to send SNMP trap notifications and enters

SNMP interface configuration mode.

Enters snmp-server interface mode for a subset of interfaces.

Enables the sending of RFC 1157 SNMP notifications.


23

SNMP Server Commands object-list

object-list

To specify the bulk statistics object list to be used in the bulk statistics schema, use the object-list command in bulk statistics schema configuration mode. To remove an object list from the schema, use the no form of this command.

object-list list-name

no object-list [ list-name ]


list-name

Name of a previously configured bulk statistics object list.

Command Default

No bulk statistics object list is specified.

Command Modes


Command History

Release

Release 4.2.0

Modification





This command associates a bulk statistics object list with the schema being configured. The object list should contain a list of MIB objects to be monitored. Only one object list can be specified for each schema. Use the

snmp-server mib bulkstat object-list command to create an object list.

Task ID

Task ID

snmp

Operation

read, write

Examples


configure

RP/0/RSP0/CPU0:router(config)# snmp-server mib bulkstat schema schema1

RP/0/RSP0/CPU0:router(config-bulk-sc)# object-list obj1

24


SNMP Server Commands object-list


Command



snmp-server mib bulkstat object-list

Description



Configures an SNMP bulk statistics object list and enters bulk statistics objects configuration mode.


25

SNMP Server Commands poll-interval

poll-interval

To configure the polling interval for a bulk statistics schema, use the poll-interval command in bulk statistics schema configuration mode. To remove a previously configured polling interval, use the no form of this command.

poll-interval minutes

no poll-interval


minutes

Integer in the range from 1 to 20000 that specifies, in minutes, the polling interval of data for this schema. The default is 5.

Command Default

Object instances are polled once every five minutes.

Command Modes


Command History

Release

Release 4.2.0

Modification





The poll-interval command sets how often the MIB instances specified by the schema and associated object list are to be polled. Collected data is stored in the local bulk statistics file for later transfer.

Task ID

Task ID

snmp

Operation

read, write

Examples

In this example, the polling interval for bulk statistics collection is set to once every 3 minutes in the schema called GigE2/1-CAR:


config


snmp-server mib bulk schema GigE2/1-CAR


poll-interval 3

26


SNMP Server Commands poll-interval


Command


Description



27

SNMP Server Commands retain

retain

To configure the retention interval for bulk statistics files, use the retain command in bulk statistics transfer configuration mode. To remove a previously configured retention interval from the configuration, use the no form of this command.

retain minutes

no retain [ minutes ]


minutes

Length of time, in minutes, that the local bulk statistics file should be kept in system memory (the retention interval). The valid range is 0 to 20000. The default is 0.

Command Default

The bulk statistics file retention interval is 0 minutes.

Command Modes


Command History

Release

Release 4.2.0

Modification





The retain command specifies how long the bulk statistics file should be kept in system memory, in minutes, after the completion of the collection interval and a transmission attempt is made. The default value of zero

(0) indicates that the file is deleted immediately from local memory after a successful transfer.

If the retry command is used, you should configure a retention interval greater than 0. The interval between retries is the retention interval divided by the retry number. For example, if retain 10 and retry 2 are configured, retries are attempted once every 5 minutes. Therefore, if the retain command is not configured (retain default is 0), no retries are attempted.

Note

Once a successful transmission has occurred the bulk file is not retained regardless of the retain time.

Task ID

Task ID

snmp

Operation

read, write

28


SNMP Server Commands retain

Examples

In the following example, the bulk statistics transfer retention interval is set to 10 minutes:


configure








retry 2


retain 10


exit


Command

retry

Description

Configures the number of retries that should be attempted for a bulk statistics file transfer.






29

SNMP Server Commands retry

retry

To configure the number of retries that should be attempted for a bulk statistics file transfer, use the retry command in bulk statistics transfer configuration mode. To return the number of bulk statistics retries to the default, use the no form of this command.

retry number

no retry [ number ]


number

Number of transmission retries. The valid range is from 0 to 100.

Command Default

No retry attempts are made.

Command Modes


Command History

Release

Release 4.2.0

Modification





If an attempt to send the bulk statistics file fails, the system can be configured to attempt to send the file again using the retry command. One retry includes an attempt first to the primary destination and then, if the transmission fails, to the secondary location; for example, if the retry value is 1, an attempt will be made first to the primary URL, then to the secondary URL, then to the primary URL again, and then to the secondary

URL again.

If the retry command is used, you should also use the retain command to configure a retention interval greater than 0. The interval between retries is the retention interval divided by the retry number. For example, if retain

10 and retry 2 are configured, retries are attempted once every 5 minutes. Therefore, if the retain command is not configured (or the retain 0 command is used) no retries are attempted.

Task ID

Task ID

snmp

Operation

read, write

30


SNMP Server Commands retry

Examples

In the following example, the number of retries for the bulk statistics transfer is set to 2:


configure








retry 2


retain 10


exit


Command

retain



Description

Configures the retention interval for bulk statistics files.




31

SNMP Server Commands schema

schema

To specify the bulk statistics schema to be used in a specific bulk statistics transfer configuration, use the

schema command in bulk statistics transfer configuration mode. To remove a previously configured schema from a specific bulk statistics transfer configuration, use the no form of this command.

schema schema-name

no schema [ schema-name ]


schema-name

Name of a previously configured bulk statistics schema.

Command Default

No bulk statistics schema is specified.

Command Modes


Command History

Release

Release 4.2.0

Modification





The schema must be previously defined using the snmp-server mib bulkstat schema command.

Repeat the schema command as desired for a specific bulk statistics transfer configuration. Multiple schemas can be associated with a single transfer configuration; all collected data will be in a single bulk statistics data file (VFile).

Task ID

Task ID

snmp

Operation

read, write

Examples

This example adds three different schemas to a bulk statistics transfer configuration:


configure


snmp-server mib bulkstat transfer-id bulkstat1




schema ATM2/0-CAR

32


SNMP Server Commands schema


schema Ethernet2/1-IFMIB


Command



Description




33

SNMP Server Commands show snmp

show snmp

To display the status of Simple Network Management Protocol (SNMP) communications, use the show snmp command in

EXEC mode.

show snmp



Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.7.2

Modification





Use the show snmp command to show counter information for SNMP operations. It also displays the chassis

ID string defined with the snmp-server chassis-id command.

Task ID

Task ID

snmp

Operations

read

Examples

This example shows sample output from the show snmp command:


show snmp

Chassis: 01506199

37 SNMP packets input

0 Bad SNMP version errors

4 Unknown community name

0 Illegal operation for community name supplied

0 Encoding errors

24 Number of requested variables

0 Number of altered variables

0 Get-request PDUs

34



28 Get-next PDUs

0 Set-request PDUs

78 SNMP packets output

0 Too big errors (Maximum packet size 1500)

0 No such name errors

0 Bad values errors

0 General errors

24 Response PDUs

13 Trap PDUs

SNMP logging: enabled

Logging to 172.25.58.33.162, 0/10, 13 sent, 0 dropped.

Table 1: show snmp Field Descriptions, on page 35

describes the significant fields shown in the display.

Table 1: show snmp Field Descriptions

Field

Chassis

SNMP packets input

Bad SNMP version errors

Unknown community name

Illegal operation for community name supplied

Encoding errors

Number of requested variables

Number of altered variables

Get-request PDUs

Get-next PDUs

Set-request PDUs

SNMP packets output

Too big errors

Maximum packet size

No such name errors

Description

Chassis ID string.

Total number of SNMP packets input.

Number of packets with an invalid SNMP version.

Number of SNMP packets with an unknown community name.

Number of packets requesting an operation not allowed for that community.

Number of SNMP packets that were improperly encoded.

Number of variables requested by SNMP managers.

Number of variables altered by SNMP managers.

Number of get requests received

Number of get-next requests received.

Number of set requests received.

Total number of SNMP packets sent by the device.

Number of SNMP packets that were larger than the maximum packet size.

Maximum size of SNMP packets.

Number of SNMP requests that specified a MIB object that does not exist.


35


Field

Bad values errors

General errors

Response PDUs

Trap PDUs

SNMP logging sent dropped


Command

show snmp mib

snmp-server chassis-id

snmp-server queue-length

Description

Number of SNMP set requests that specified an invalid value for a MIB object.

Number of SNMP set requests that failed due to some other error. (It is not a noSuchName error, badValue error, or any of the other specific errors.)

Number of responses sent in reply to requests.

Number of SNMP traps sent.

Enabled or disabled logging.

Number of traps sent.

Number of traps dropped. Traps are dropped when the trap queue for a destination exceeds the maximum length of the queue, as set by the snmp-server

queue-length command.

Description

Displays a list of MIB module object identifiers registered on the system.

Provides a message line identifying the SNMP server serial number.

Establishes the message queue length for each trap host for SNMP.

36


SNMP Server Commands show snmp context

show snmp context

To display the enhanced SNMP context mappings, use the show snmp context command in EXEC mode.




Command Default

None

Command Modes

EXEC

Command History

Release

Release 4.2.0

Modification





Use the show snmp context command to display the protocol instance, topology and VRF mappings associated with an SNMP context.

Task ID

Task ID

snmp

Operation

read

Examples

This example illustrates sample output from the show snmp context command:



Tue Dec 21 03:41:08.065 PST

Context-name con5 con6

Vrf-name vf5 vf6 con7 con8 vf7 vf8

Topology-Name tp5 tp6 tp7 tp8

Instance-Name in5 in6 in7 in8

Feature

OSPF

OSPF

OSPF

OSPF


37

SNMP Server Commands show snmp context


Command

snmp-server context mapping

Description

Maps an SNMP context with a protocol instance, topology or

VRF entity.

38


SNMP Server Commands show snmp context-mapping

show snmp context-mapping

To display the SNMP context mapping table, use the show snmp context-mapping command in

EXEC mode.




Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.8.0

Modification





The SNMP agent handles queries based on SNMP contexts created by client features. Use the show snmp

context-mapping command to display the SNMP context mapping table. Each entry in the table includes the name of an SNMP context created by a client instance and the name of the client that created the context.

Task ID

Task ID

snmp

Operations

read

Examples

The following example shows sample output from the show snmp context-mapping command:



Wed Aug 6 01:42:35.227 UTC

Context-name Feature-name Feature

ControlEthernet0_RP0_CPU0_S0 ControlEthernet0_RP0_CPU0_S0 BRIDGEINST

ControlEthernet0_RP1_CPU0_S0 ControlEthernet0_RP1_CPU0_S0 BRIDGEINST


39

SNMP Server Commands show snmp context-mapping

Table 2: show snmp context-mapping Field Descriptions

Field

Context-name

Feature-name

Feature

Definition

Name of an SNMP context.

Name of the instance that created the context.

Name of the client whose instance created the context.

40


SNMP Server Commands show snmp engineid

show snmp engineid

To display the identification of the local Simple Network Management Protocol (SNMP) engine that has been configured on the router, use the show snmp engineid command in EXEC mode.




Command Default

None

Command Modes

EXEC mode

Command History

Release

Release 3.7.2

Modification





An SNMP engine is a copy of SNMP that can reside on a local device.

Task ID

Task ID

snmp

Operations

read

Examples

The following example shows sample output from the show snmp engineid command:



Local SNMP engineID: 00000009020000000C025808


Command


Description



41

SNMP Server Commands show snmp entity

show snmp entity

To display the entPhysicalName and entPhysicalIndex mappings, use the show snmp entity command in

EXEC mode.




Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.9.1

Modification





Use the show snmp entity command to view the entity index to use in the snmp test trap entity command.

To use the show snmp entity command, SNMP must be configured on the router.

Task ID

Task ID

snmp

Operation

read

Examples

This example illustrates sample output from the show snmp entity command:



Thu Aug 13 02:10:06.741 UTC entPhysicalIndex: 22001 entPhysicalName: portslot 0/0/CPU0/7 entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex:

23006 entPhysicalName: portslot 0/0/CPU0/129

23557 entPhysicalName: portslot 0/0/CPU0/3

47719 entPhysicalName: 0/0/* - ingresspse - 1.2V

320862 entPhysicalName: 0/0/* - host - 5V_C entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex:

322450 entPhysicalName: 0/0/* - host - 1.5V

428209 entPhysicalName: 0/PL2/*

1038801 entPhysicalName: 0/0/* - ingressq - 2.5V

1040485 entPhysicalName: 0/0/* - ingressq - 1.25V_0123

1152042 entPhysicalName: 0/2/CPU0/7

42


SNMP Server Commands show snmp entity

entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex:

--More

—

2031334 entPhysicalName: 0/SM0/* - host - Inlet1

2032954 entPhysicalName: 0/SM0/* - host - 1.8V_L

2034510 entPhysicalName: 0/SM0/* - host - brd-ok-led

2110001 entPhysicalName: 0/PL2/* - plimasic - Exhaust0

2111557 entPhysicalName: 0/PL2/* - plimasic - 1.8V

2358084 entPhysicalName: 0/0/* - egressq

2359704 entPhysicalName: 0/0/* - cpu

2469162 entPhysicalName: 0/2/* - egressq - Hotspot0

2559937 entPhysicalName: 0/0/* - egressq - 1.2V

2577533 entPhysicalName: 0/2/CPU0/0

2853020 entPhysicalName: 0/0/* - egresspse - 5V

3497583 entPhysicalName: 0/SM1/* - host - brd-ok-led

3500791 entPhysicalName: 0/SM1/* - host - Inlet1



Mon Nov 15 11:19:23.609 UTC entPhysicalIndex: 172193 entPhysicalName: portslot 0/0/CPU0/1 entPhysicalIndex: entPhysicalIndex:

322450 entPhysicalName: voltages 0/0/CPU0

345071 entPhysicalName: voltages 0/7/CPU0 entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex:





847586 entPhysicalName: voltages 0/7/CPU0 entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex:

1192623 entPhysicalName: 0/25/CPU0


1460256 entPhysicalName: temperatures 0/18/CPU0




3082421 entPhysicalName: slot 7/0 entPhysicalIndex: entPhysicalIndex: entPhysicalIndex: entPhysicalIndex:

5037675 entPhysicalName: 0/21/CPU0



6369487 entPhysicalName: portslot 0/9/CPU0/2 entPhysicalIndex: entPhysicalIndex:


8548798 entPhysicalName: 0/21/CPU0 - host entPhysicalIndex: 10735504 entPhysicalName: voltages 0/1/CPU0 entPhysicalIndex: 10737188 entPhysicalName: voltages 0/1/CPU0 entPhysicalIndex: 10738808 entPhysicalName: slot 1/1 entPhysicalIndex: 11312388 entPhysicalName: slot 7 entPhysicalIndex: 11314008 entPhysicalName: slot 3 entPhysicalIndex: 12644344 entPhysicalName: voltages 0/19/CPU0 entPhysicalIndex: 12761695 entPhysicalName: slot 24 entPhysicalIndex: 12763283 entPhysicalName: slot 20 entPhysicalIndex: 12907576 entPhysicalName: voltages 0/0/CPU0 entPhysicalIndex: 13262622 entPhysicalName: slot 16 entPhysicalIndex: 13290941 entPhysicalName: temperatures 0/16/CPU0 entPhysicalIndex: 13404457 entPhysicalName: voltages 0/2/CPU0 entPhysicalIndex: 13406077 entPhysicalName: voltages 0/2/CPU0 entPhysicalIndex: 13701859 entPhysicalName: voltages 0/2/CPU0 entPhysicalIndex: 13900492 entPhysicalName: voltages 0/2/CPU0 entPhysicalIndex: 13903700 entPhysicalName: voltages 0/2/CPU0 entPhysicalIndex: 13905384 entPhysicalName: voltages 0/2/CPU0 entPhysicalIndex: 14106204 entPhysicalName: portslot 0/8/CPU0/2 entPhysicalIndex: 14256525 entPhysicalName: voltages 0/8/CPU0 entPhysicalIndex: 14979942 entPhysicalName: slot 2/2 entPhysicalIndex: 14981562 entPhysicalName: voltages 0/2/CPU0 entPhysicalIndex: 15141782 entPhysicalName: 0/19/CPU0 entPhysicalIndex: 15873651 entPhysicalName: temperatures 0/22/CPU0 entPhysicalIndex: 15986678 entPhysicalName: voltages 0/1/CPU0 entPhysicalIndex: 15988234 entPhysicalName: voltages 0/1/CPU0 entPhysicalIndex: 15991442 entPhysicalName: voltages 0/1/CPU0 entPhysicalIndex: 16136999 entPhysicalName: voltages 0/1/CPU0 entPhysicalIndex: 16138619 entPhysicalName: voltages 0/1/CPU0 entPhysicalIndex: 16285636 entPhysicalName: temperatures 0/1/CPU0 entPhysicalIndex: 16287256 entPhysicalName: voltages 0/1/CPU0 entPhysicalIndex: 16606045 entPhysicalName: voltages 0/8/CPU0 entPhysicalIndex: 16607633 entPhysicalName: voltages 0/8/CPU0 entPhysicalIndex: 16733769 entPhysicalName: 0/2/CPU0 - host


43


entPhysicalIndex: 16949774 entPhysicalName: portslot 0/0/CPU0/0 entPhysicalIndex: 17098539 entPhysicalName: temperatures 0/0/CPU0 entPhysicalIndex: 17122684 entPhysicalName: voltages 0/7/CPU0 entPhysicalIndex: 17124272 entPhysicalName: voltages 0/7/CPU0 entPhysicalIndex: 17127448 entPhysicalName: voltages 0/7/CPU0 entPhysicalIndex: 17205790 entPhysicalName: 0/2/CPU0 entPhysicalIndex: 17322905 entPhysicalName: temperatures 0/7/CPU0 entPhysicalIndex: 17324589 entPhysicalName: voltages 0/7/CPU0 entPhysicalIndex: 17595466 entPhysicalName: 0/25/CPU0 - host entPhysicalIndex: 17620307 entPhysicalName: voltages 0/7/CPU0 entPhysicalIndex: 17621991 entPhysicalName: voltages 0/7/CPU0 entPhysicalIndex: 17623611 entPhysicalName: voltages 0/7/CPU0 entPhysicalIndex: 18003523 entPhysicalName: temperatures 0/21/CPU0 entPhysicalIndex: 18237837 entPhysicalName: voltages 0/18/CPU0 entPhysicalIndex: 18571163 entPhysicalName: voltages 0/20/CPU0

---More---


44


SNMP Server Commands show snmp group

show snmp group

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

EXEC mode.

show snmp group



Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.7.2

Modification





Task ID

Task ID

snmp

Operations

read

Examples

This example shows sample output from the show snmp group command:


show snmp group

groupname: public security model:snmpv1 readview : v1default writeview: notifyview: v1default row status: nonVolatile groupname: public security model:snmpv2c readview : v1default writeview: notifyview: v1default row status: nonVolatile


45

SNMP Server Commands show snmp group


Table 3: show snmp group Field Descriptions

Field

groupname readview security model writeview notifyview row status

Command

snmp-server group

Definition

Name of the Simple Network Management Protocol

(SNMP) group or collection of users that have a common access policy.

String identifying the read view of the group.

Security model used by the group, either v1, v2c, or v3.

String identifying the write view of the group.

String identifying the notify view of the group.

Settings that are set in volatile or temporary memory on the device, or in nonvolatile or persistent memory where settings remain after the device is turned off and on again.

Description

Configures a new SNMP group, or a table that maps SNMP users to

SNMP views.

46


SNMP Server Commands show snmp host

show snmp host

To display the configured Simple Network Management Protocol (SNMP) notification recipient host, User

Datagram Protocol (UDP) port number, user, and security model, use the show snmp host command in

EXEC mode.

show snmp host



Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.7.2

Modification





Task ID

Task ID

snmp

Operations

read

Examples

The following example shows sample output from the show snmp host command:


show snmp host

Notification host: 10.50.32.170 udp-port: 2345 type: trap user: userV3auth security model: v3 auth

Notification host: 10.50.32.170 udp-port: 2345 type: trap user: userV3noauth security model: v3 noauth

Notification host: 10.50.32.170 udp-port: 2345 type: trap user: userV3priv security model: v3 priv

Notification host: 10.50.32.170 udp-port: 2345 type: trap user: userv2c security model: v2c


47

show snmp host


Table 4: show snmp host Field Descriptions

Field

Notification host udp-port type user security model

Definition

Name or IP address of target host.

UDP port number to which notifications are sent.

Type of notification configured.

Security level of the user.

Version of SNMP used to send the trap, either v1, v2c, or v3.

48


SNMP Server Commands show snmp interface

show snmp interface

To display the interface index identification numbers (ifIndex values) for all the interfaces or a specified interface, use the show snmp interface command in the appropriate mode.

show snmp interface [type interface-path-id ifindex]


type interface-path-id

ifindex

(Optional) Interface type. For more information, use the question mark (?) online help function.

(Optional) Physical interface or virtual interface.

Note

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

(Optional) Displays the ifIndex value for the specified interface.

Command Default

Enter the show snmp interface command without keywords or arguments to display the ifIndex value for all interfaces.

Command Modes

EXEC

Command History

Release

Release 3.7.2

Modification





Task ID

Task ID

snmp

Operations

read

Examples

This example displays the ifIndex value for a specific interface:


show snmp interface pos 0/1/0/1 ifindex


49

SNMP Server Commands show snmp interface

ifName : POS0/1/0/1 ifIndex : 12

The following example displays the ifIndex value for all interfaces:


show snmp interface

ifName : Loopback0 ifName : POS0/1/0/1 ifName : POS0/1/4/2 ifName : POS0/1/4/3 ifName : POS0/6/0/1 ifName : POS0/6/4/4 ifName : POS0/6/4/5 ifName : POS0/6/4/6 ifName : Bundle-POS24 ifName : Bundle-Ether28 ifName : Bundle-Ether28.1

ifName : Bundle-Ether28.2

ifIndex : 1 ifIndex : 12 ifIndex : 14 ifIndex : 15 ifIndex : 2 ifIndex : 18 ifIndex : 19 ifIndex : 20 ifIndex : 4 ifIndex : 5 ifIndex : 7 ifIndex : 8 ifName : Bundle-Ether28.3

ifIndex : 9 ifName : MgmtEth0/RP0/CPU0/0 ifIndex : 6 ifName : MgmtEth0/RP1/CPU0/0 ifIndex : 10 ifName : GigabitEthernet0/1/5/0 ifIndex : 11 ifName : GigabitEthernet0/1/5/1 ifIndex : 13 ifName : GigabitEthernet0/1/5/2 ifIndex : 3 ifName : GigabitEthernet0/6/5/1 ifIndex : 16 ifName : GigabitEthernet0/6/5/2 ifIndex : 17 ifName : GigabitEthernet0/6/5/7 ifIndex : 21

Table 5: show snmp interface Field Descriptions

Field

ifName ifIndex

Definition

Interface name.

ifIndex value.


Command



Description


Enables an interface to send SNMP trap notifications and enters

SNMP interface configuration mode.

50


SNMP Server Commands show snmp interface notification

show snmp interface notification

To display the linkUp and linkDown notification status for a subset of interfaces, use the show snmp interface

notification command in EXEC mode.

show snmp interface notification {subset subset-number| regular-expression expression| [type

interface-path-id]}


subset subset-number

regular-expression

expression type interface-path-id

Specifies the identifier of the interface subset. The subset-number argument is configured using the snmp-server interface subset command.

Specifies a subset of interfaces matching a regular expression, for which to display information.

(Optional) Interface type. For more information, use the question mark (?) online help function.

(Optional) Physical interface or virtual interface.

Note


For more information about the syntax for the router, use the question mark (

? ) online help function.

Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.9.0

Modification





Regular expressions have two constraints:

• Regular expressions must always be entered within double quotes to ensure that the CLI interprets each character correctly.

• All characters that are part of a regular expression are considered regular characters with no special meaning. In order to enter special characters, such as "\" or "?," they must be preceded by the backslash


51


Task ID show snmp interface notification

Examples

character "\." For example, to enter the regular expression ([A-Z][A-Z0-9]*)\b[^>]*>(.*?)</\1, you would enter ([A-Z][A-Z0-9]*)\\b[^>]*>(.*\?)</\\1.

Refer to the Understanding Regular Expressions, Special Characters, and Patterns module in Cisco ASR 9000

Series Aggregation Services Router Getting Started Guide for more information regarding regular expressions.

When using the subset or regular-expression keywords, the actual display might not match the configuration if there are higher priority subset-number values that actually apply to the interface. This can happen for a set of interfaces that are included in two or more configured regular expressions or where an individual interface configuration is enabled.

Task ID

snmp

Operation

read

The following example illustrates how to display linkUp and linkDown notification status for a subset of interfaces identified by a specific subset-number :


show snmp interface notification subset 3

This example illustrates how to display linkUp and linkDown notification status for a subset of interfaces identified by a regular expression:


show snmp interface notification regular-expression

"^Gig[a-zA-Z]+[0-9/]+\."

52


SNMP Server Commands show snmp interface regular-expression

show snmp interface regular-expression

To display interface names and indices assigned to interfaces that match a regular expression, use the show

snmp interface regular-expression command in EXEC mode.

show snmp interface regular-expression expression


expression

Specifies a subset of interfaces matching a regular expression, for which to display information.

Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.9.0




All characters that are part of a regular expression are considered regular characters with no special meaning.

In order to enter special characters, such as "\" or "?," they must be preceded by the backslash character "\."

For example, to enter the regular expression ([A-Z][A-Z0-9]*)\b[^>]*>(.*?)</\1, you would enter

([A-Z][A-Z0-9]*)\\b[^>]*>(.*\?)</\\1.



Task ID

Task ID

snmp

Operation

read

Examples

Modification


This example illustrates how to display information for interfaces that match the given regular expression:


show snmp interface regular-expression "^Gig[a-zA-Z]+[0-9/]+\."


53

SNMP Server Commands show snmp interface regular-expression


Command

snmp-server interface subset

Description

Enters snmp-server interface mode for a subset of interfaces.

54


SNMP Server Commands show snmp mib

show snmp mib

To display a list of MIB module object identifiers (OIDs) registered on the system, use the show snmp mib command in

EXEC mode.

show snmp mib [object-name| dll]


object-name

dll

(Optional) Specific MIB object identifier or object name.

(Optional) Displays a list of all MIB DLL filenames and the OID supported by each DLL filename on the system.

Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.7.2

Release 3.9.0

Modification


The detailed keyword was not supported.




Use the show snmp mib command to display a list of the MIB module instance identifiers registered on the system.

Although the show snmp mib command can be used to display a list of MIB OIDs registered on the system, the use of a Network Management System (NMS) application is the recommended alternative for gathering this information.

The show snmp mib command is intended only for network managers who are familiar with Abstract Syntax

Notation One (ASN.1) syntax and the Structure of Management Information (SMI) of Open Systems

Interconnection (OSI) Reference Model.

SNMP management information is viewed as a collection of managed objects residing in a virtual information store termed the MIB. Collections of related objects are defined in MIB modules. These modules are written using a subset of ASN.1 termed the SMI.


55


Task ID

The definitions for the OIDs displayed by this command can be found in the relevant RFCs and MIB modules.

For example, RFC 1907 defines the system.x, sysOREntry.x, snmp.x, and snmpTrap.x OIDs, and this information is supplemented by the extensions defined in the CISCO-SYSTEM-MIB.

Use the detailed keyword to display a list of the MIB module instance identifiers registered on the system.

The output displays additional details, such as DLL and configuration information.

Use the dll keyword to display a list of the MIB modules loaded into the agent. This command can be used to find the supported MIBs.

Note

This command produces a high volume of output if SNMP is enabled on the system. To exit from a

--More-- prompt, press Crtl-Z.

Task ID

snmp

Operations

read

Examples

The following example shows sample output from the show snmp mib command:


show snmp mib

1.3.6.1.2.1.47.1.1.1.1.2

1.3.6.1.2.1.47.1.1.1.1.3

1.3.6.1.2.1.47.1.1.1.1.4

1.3.6.1.2.1.47.1.1.1.1.5

1.3.6.1.2.1.47.1.1.1.1.6

1.3.6.1.2.1.47.1.1.1.1.7

1.3.6.1.2.1.47.1.1.1.1.8

1.3.6.1.2.1.47.1.1.1.1.9

1.3.6.1.2.1.47.1.1.1.1.10

1.3.6.1.2.1.47.1.1.1.1.11

1.3.6.1.2.1.47.1.1.1.1.12

1.3.6.1.2.1.47.1.1.1.1.13

1.3.6.1.2.1.47.1.1.1.1.14

1.3.6.1.2.1.47.1.1.1.1.15

1.3.6.1.2.1.47.1.1.1.1.16

1.3.6.1.2.1.47.1.2.1.1.2

1.3.6.1.2.1.47.1.2.1.1.3

1.3.6.1.2.1.47.1.2.1.1.4

1.3.6.1.2.1.47.1.2.1.1.5

1.3.6.1.2.1.47.1.2.1.1.6

1.3.6.1.2.1.47.1.2.1.1.7

1.3.6.1.2.1.47.1.2.1.1.8

1.3.6.1.2.1.47.1.3.1.1.1

--More-

This example shows sample output from the show snmp mib command with the detailed keyword:


show snmp mib detailed

Entitymib:dll=/pkg/lib/mib/libEntitymib.dll, config=Entity.mib, loaded

1.3.6.1.2.1.47.1.1.1.1.2

1.3.6.1.2.1.47.1.1.1.1.3

1.3.6.1.2.1.47.1.1.1.1.4

1.3.6.1.2.1.47.1.1.1.1.5

1.3.6.1.2.1.47.1.1.1.1.6

1.3.6.1.2.1.47.1.1.1.1.7

56



1.3.6.1.2.1.47.1.1.1.1.8

1.3.6.1.2.1.47.1.1.1.1.9

1.3.6.1.2.1.47.1.1.1.1.10

1.3.6.1.2.1.47.1.1.1.1.11

1.3.6.1.2.1.47.1.1.1.1.12

1.3.6.1.2.1.47.1.1.1.1.13

1.3.6.1.2.1.47.1.1.1.1.14

1.3.6.1.2.1.47.1.1.1.1.15

1.3.6.1.2.1.47.1.1.1.1.16

1.3.6.1.2.1.47.1.2.1.1.2

1.3.6.1.2.1.47.1.2.1.1.3

1.3.6.1.2.1.47.1.2.1.1.4

1.3.6.1.2.1.47.1.2.1.1.5

1.3.6.1.2.1.47.1.2.1.1.6

1.3.6.1.2.1.47.1.2.1.1.7

1.3.6.1.2.1.47.1.2.1.1.8

--More--

This example shows sample output from the show snmp mib command with the dll keyword:


show snmp mib dll

Entitymib:dll=/pkg/lib/mib/libEntitymib.dll, config=Entity.mib, loaded bgp4mib:dll=/pkg/lib/mib/libbgp4mib.dll, config=bgp4.mib, loaded cdpmib:dll=/pkg/lib/mib/libcdpmib.dll, config=cdp.mib, loaded ciscoprocessmib:dll=/pkg/lib/mib/libciscoprocessmib.dll, config=ciscoprocess.mib, loaded ciscosyslogmib:dll=/pkg/lib/mib/libciscosyslogmib.dll, config=ciscosyslog.mib, loaded ciscosystemmib:dll=/pkg/lib/mib/libciscosystemmib.dll, config=ciscosystem.mib, loaded confcopymib:dll=/pkg/lib/mib/libconfcopymib.dll, config=confcopy.mib, loaded configmanmib:dll=/pkg/lib/mib/libconfigmanmib.dll, config=configman.mib, loaded dot3admib:dll=/pkg/lib/mib/libdot3admib.dll, config=dot3ad.mib, loaded fabhfrmib:dll=/pkg/lib/mib/libfabhfrmib.dll, config=fabhfr.mib, loaded fabmcastapplmib:dll=/pkg/lib/mib/libfabmcastapplmib.dll, config=fabmcastappl.mib, loaded fabmcastmib:dll=/pkg/lib/mib/libfabmcastmib.dll, config=fabmcast.mib,

.

.

.

loaded flashmib:dll=/pkg/lib/mib/libflashmib.dll, config=flash.mib, loaded hsrpmib:dll=/pkg/lib/mib/libhsrpmib.dll, config=hsrp.mib, loaded icmpmib:dll=/pkg/lib/mib/libicmpmib.dll, config=icmp.mib, loaded ifmib:dll=/pkg/lib/mib/libifmib.dll, config=if.mib, loaded ipmib:dll=/pkg/lib/mib/libipmib.dll, config=ip.mib, loaded mempoolmib:dll=/pkg/lib/mib/libmempoolmib.dll, config=mempool.mib, loaded mplsldpmib:dll=/pkg/lib/mib/libmplsldpmib.dll, config=mplsldp.mib, loaded


Command

show snmp

Description



57

SNMP Server Commands show snmp mib bulkstat transfer

show snmp mib bulkstat transfer

To display completed local bulk statistics files, use the show snmp mib bulkstat transfer command in EXEC mode.

show snmp mib bulkstat transfer [ transfer-name ]


transfer-name

Specifies a named transfer file to display.



Command Default

None

Command Modes

EXEC

Command History

Release

Release 4.2.0

Modification





The show snmp mib bulkstat transfer command lists all bulk statistics virtual files (VFiles) on the system that have finished collecting data. (Data files that are not complete are not displayed.)

The output lists all of the completed local bulk statistics files, the remaining time left before the bulk statistics file is deleted (remaining retention period), and the state of the bulk statistics file. The state of the bulk statistics file should be Retry. Retry indicates that one or more transfer attempts have failed and that the file transfer will be attempted again. The number of retry attempts remaining is displayed in parenthesis. After the successful retry or retry attempts, the local files created by the MIB process in the router are deleted and data collection begins again.

To display only the status of a named transfer (as opposed to all configured transfers), specify the name of the transfer in the transfer-name argument. The transfer-name argument names a file which is supposed to be created even before the retries.

Task ID

Task ID

snmp

Operation

read

58


SNMP Server Commands show snmp mib bulkstat transfer

Examples


show snmp mib bulkstat transfer

Transfer Name : ifmib

Retained files

File Name : Time Left (in seconds) :STATE

------------------------------------------------------ifmib_Router_020421_100554683 : 173 : Retry (2 Retry attempt(s) Left)


59

SNMP Server Commands show snmp request duplicates

show snmp request duplicates

To display the number of duplicate protocol data unit (PDU) requests dropped by the SNMP agent, use the

show snmp request duplicates command in

EXEC mode.




Command Default

None

Command Modes

EXEC

Command History

Release

Release 4.0.0

Modification





Task ID

Task ID

snmp

Operation

read

Examples

This example illustrates sample output from the show snmp request duplicates command:



No of Duplicate request received/Dropped : 0

60


SNMP Server Commands show snmp request incoming-queue detail

show snmp request incoming-queue detail

To show the details of the queue of incoming SNMP requests, use the show snmp request incoming-queue

detail command in EXEC mode.



Command Modes

Global configuration

Command History

Release

Release 5.2.2

Modification





This command shows an output for maximum of 15 queues and an additional general queue. The entry will be deleted when any queue is not polled for 30 minutes.

This command shows these details:

Field

NMS Address

Description

Source address (IPv4 or IPv6) of network management system (NMS) queue. Specifies the NMS packet requests in this queue.

Q Depth Number of packets to be processed in the queue.

Deque Count

Priority

Enque time

Number of packets that are processed.

Priority of queue with packets to be processed. The priority ranges from 1 to 5, 1 indicates low priority and 5 indicates high priority.

Time stamp of last request in the queue.

Task ID

Task ID

snmp

Operations

read, write


61

SNMP Server Commands show snmp request incoming-queue detail

Examples



Wed Mar 12 05:16:59.505 PDT

NMS ADDRESS

4.5.6.7

05:16:25

Q Depth

0

Deque count

1223

Priority

1

0 1193 1 1.2.3.4

05:15:06

General Q

05:14:49

0 0 0

NMS ADDRESS

Q Depth

0

NMS ADDRESS

Q Depth

0

: 4:5:6::7

Deque count

1220

: 1:2:3::4

Deque count

1221

Priority

1

Priority

1

Enque time

Wed Mar 12 05:16:02

Enque time

Enque time

Wed Mar 12

Wed Mar 12

Wed Mar 12

Wed Mar 12 05:15:37

62


SNMP Server Commands show snmp request type summary

show snmp request type summary

To show the types of requests sent from each network management system (NMS), use the show snmp

request type summary command in EXEC mode.



Command Modes


Command History

Release

Release 5.2.2

Modification





The show snmp request type summary command shows these details:

Field

NMS address

Description

IP address of the NMS that sent the request.

Get

Getnext

Number of requests of Get type.

Number of requests of Getnext type.

Getbulk

Set

Test

Number of requests of Getbulk type.

Number of requests of Set type.

Number of requests of Test type that is part of Set request.

Task ID

Task ID

snmp

Operations

read, write

Examples




63


Wed Mar 12 05:17:14.643 PDT

NMS Address Get

1.2.3.4

4.5.6.7

0

0

GetNext

1254

5101

NMS Address : 1:2:3::4

Get GetNext

0 2536


Get

0

GetNext

3817

GetBulk

0

GetBulk

0

Set

0

Set

0

GetBulk

0

0

Test

0

Test

0

Set

0

0

Test

0

0


64


SNMP Server Commands show snmp request type detail

show snmp request type detail

To shows the group that is polled frequently and from which network management system (NMS), use the

show snmp reqest type detail command in EXEC mode.



Command Modes


Command History

Release

Release 5.2.2

Modification





The show snmp request type detail command shows these details:

Field

NMS Address

Description

Address of Network Management Station from which the request is received.

Request

SNMPD

Number of requests from NMS.

Number of requests to snmpd.

Interface

Entity

Route

Infra

Number of requests to mibd_interface.

Number of requests to mibd_entity.

Number of requests to mibd_route.

Number of requests to mibd_infra.

Task ID

Task ID

snmp

Operations

read, write


65

SNMP Server Commands show snmp request type detail

Examples



Wed Mar 12 05:17:34.838 PDT

NMS Address Request

1.2.3.4

1193

AGENT

52

INTERFACE

742

ENTITY

70

4.5.6.7

1:2:3::4

4:5:6::7

1223

1221

1220

52

52

52

742

742

742

100

100

100

ROUTE

267

267

265

265

INFRA

123

123

123

122

66


SNMP Server Commands show snmp request drop summary

show snmp request drop summary

To show the summary of overall packet drop, use the show snmp request drop summary command in

EXEC mode.



Command Modes


Command History

Release

Release 5.2.2

Modification





The show snmp request drop summary command shows these details:

Field

NMS Address

Description

Address of network management station from which request is received.

IN Q Number of packets dropped in incoming queue as the dropped packets are not processed more than 10 seconds.

Number of packets dropped because of encode errors.

Encode

Duplicate

Stack

AIPC

Number of requests dropped with duplicate request feature.

Numbers of requests are dropped in stack.

Number of packets dropped at AIPC module.

Overload

Timeout

Number of packets dropped because of overload control notification.

Number of packets are dropped because of slow response from MIB.


67

SNMP Server Commands show snmp request drop summary

Field

Internal

Description

Number of packets dropped because of internal failures.

Operations

read, write

Task ID

Examples

Task ID

snmp



Fri Mar 14 05:32:31.732 PDT

INQ Encode Duplicate Stack NMS Address

Internal

1.2.3.4

0 0 0 0


INQ Encode Duplicate

0 0 0

Stack

0

AIPC

0

Overload

109

AIPC Overload Timeout

0 218 0

Timeout

0

Internal

0

0

68


SNMP Server Commands show snmp request overload stats

show snmp request overload stats

To show the number of packets dropped due to overload feature, use the snmp request overload stats command in EXEC mode.



Command Modes


Command History

Release

Release 5.2.2

Modification





This command displays the latest 100 entries.

The show snmp request overload stats command shows these details:

Field

StartTime

Description

Time when overload control notification is received.

InQInDrop

InQOutDrop

Number of packet drops before inserting in incoming queue.

Number of packets dropped from incoming queue.

EndTime Time when overload control notification ends.

Task ID

Task ID

snmp

Operations

read, write

Examples



Thu Mar 13 07:00:45.575 UTC

StartTime InQInDrop InQOutDrop EndTime


69


Thu Mar 13 07:00:28

13 07:00:38

1 0


Thu Mar

70


SNMP Server Commands show snmp statistics oid group

show snmp statistics oid group

To show the statistics of object ID (OID), use the show snmp statistics oid group command in EXEC mode.

show snmp statistics oid group{interface| infra| route| entity}

Syntax Description interface infra route entity

mibd_interface sub-agent process mibd_infra sub-agent process mibd_route sub-agent process mibd_entity sub-agent process

Command Modes


Command History

Release

Release 5.2.2

Modification





The latest 500 entries for each group is displayed and a maximum of 2000 entries is displayed for four groups.

The show snmp statistics oid group command shows these details:

Field

SerNum

Description

Unique serial number for each request processing in sub-agents.

Type Request type.

NumObj

MIBMGR-IN

PDU-IN

Number of OIDs processing in this request.

Time stamp of request received from AIPC.

Time stamp of request sent to MIB for processing.

This will be offset in milli seconds from

MIBMGR_IN time stamp.


71

SNMP Server Commands show snmp statistics oid group

Task ID

Field

FROM-MIB

PDU-OUT

OID

MIB-IN

MIB-OUT

ExpNext

Task ID

snmp

Description

Time stamp of response sent from MIB after processing. This will be offset in milli seconds from

MIBMGR_IN time stamp.

Time stamp of response sent to SNMP through AIPC

. This will be offset in milli seconds from

MIBMGR_IN.

OID info processing this request.

Time stamp of the request sent to MIB for each OID.

Time stamp of response sent from MIB after processing. This will be offset in milli seconds from

MIB-IN.

Request Exp-Next.

Operations

read, write

Examples


show snmp statistics oid group interface

Thu Mar 13 07:10:30.310 UTC

SerNum: 2489 Type: GETNEXT

MIBMGR-IN PDU-IN[ms]

Mar 13 07:00:49.933

NumObj: 1

PDU-OUT[ms]

1030

MIBMGR-OUT[ms]

1030

OID: 1.3.6.1.2.1.10.32.4.2.0

Exp-Next: Yes

MIB-IN : Mar 13 07:00:49.933

MIB-OUT[ms] : 1030

SerNum: 10203

MIBMGR-IN

Type: GETNEXT

PDU-IN[ms]

Mar 13 06:36:16.976

0

NumObj: 1

PDU-OUT[ms]

1031

OID: 1.3.6.1.2.1.10.32.4.2.0

Exp-Next: Yes

MIB-IN : Mar 13 06:36:16.976

MIB-OUT[ms] : 1031

MIBMGR-OUT[ms]

1031

72


SNMP Server Commands show snmp statistics pdu

show snmp statistics pdu

To show if processing time of any protocol data unit (PDU) is more than threshold limit, use the show snmp

statistics pdu nms command in EXEC mode.

show snmp statistics pdu nms[address]

Syntax Description nms [address]

Address of Network Management Station from which request has arrived. The

PDU statistics is filtered for each NMS.

Command Modes


Command History

Release

Release 5.2.2

Modification





The PDU processing time can exceed the threshold limit in these scenarios:

• SNMPD not able to dispatch the request to MIB because of any failures in snmpd.

• MIB response after threshold limit.

• MIB does not respond to SNMPD.

Default threshold limit is 2 seconds. To change the default threshold value, use the command:

Snmp-server timeouts pdu stats <1-10>

The maximum number of entries per network management system (NMS) is 500 and the maximum number of NMS is 30.

This command shows these details:

Field Description

NMS Address of Network Management Station from which request has arrived.

Port

REQID

Type

Port number of application that requested the SNMP query.

Request ID for each PDU.

Type of PDU.


73

SNMP Server Commands show snmp statistics pdu

Field

SerNum

Timeout

InputQ-In

InputQ-Out

ProcQ-In

Response

Description

The unique number generated for every request and sent to all MIBDs.

If the request was timeout out set to TRUE, else set to FALSE.

Time stamp of the PDU when queued into input Q.

Time stamp of the PDU when queued into input Q,

This will be in milliseconds, Offset from INPUT-IN time stamp.

Time stamp of the PDU when queued into Processing

Q. This will be in milliseconds, Offset from

INPUT-IN time stamp.

Time stamp in milli seconds of the PDU when response is received from sub agents. Offset from

INPUT-IN time stamp.

Operations

read, write

Task ID

Examples

Task ID

snmp


show snmp statistics pdu nms

Thu Mar 13 08:03:17.322 UTC

NMS: 64.103.222.6

PORT: 35028

REQID:962974264 TYPE: 161 SerNum: 9428 TIMEOUT: No

INPUTQ-IN INPUTQ-OUT[ms] PROCQ-IN[ms]

Mar 13 08:03:15.269

0 0

RESPONSE[ms]

1056

74


SNMP Server Commands show snmp statistics slow oid

show snmp statistics slow oid

To show the object ID (OID) that has exceeded beyond the threshold time for processing and the number of times that the threshold limit is exceeded with the latest timestamp, use the show snmp statistics slow oid command in EXEC mode.



Command Modes


Command History

Release

Release 5.2.2

Modification





Default threshold limit for this data as 500 milli seconds. To change the default value, use the command:

Snmp-server logging threshold oid-processing < <0-20000>

The latest 500 entries for each sub agent is displayed and a total of upto 2000 entries is maintained.

The show snmp statistics slow oid command shows these details:

Field

Type

Description

Request type for slow OID.

Exact OID

Resp OID

Requested OID from NMS.

Response OID for the Request type and EXACT OID.

Slow Count

Slow Time

Time Stamp

Number of times OID is slow.

Time taken for processing the OID in milli seconds.

Time stamp of the slow OID when MIB responded to MIBD.

Task ID

Task ID

snmp

Operations

read, write


75

SNMP Server Commands show snmp statistics slow oid

Examples

This example shows a slow OIDs that exceeds the specified threshold time.



Group:agent

TYPE

REQ_OID

RESP_OID

COUNT

TIME[ms]

TIME_STAMP

: GETNEXT

: 1.3.6.1.2.1.1.1.0

: 1.3.6.1.2.1.1.1.2

: 2

: 0

: Mar 13 05:36:52.279

Group:infra

Group:route

TYPE

REQ_OID :

: GETNEXT

1.3.6.1.2.1.4.34.1.3.4.20.254.128.0.0.0.0.0.0.0.254.8.255.254.203.38.197.0.0.0.2

RESP_OID :

1.3.6.1.2.1.4.34.1.3.4.20.254.128.0.0.0.0.0.0.0.254.8.255.254.203.38.197.0.0.0.2

COUNT : 4

TIME[ms] : 14

TIME_STAMP : Mar 13 05:36:52.279

TYPE

REQ_OID :

: GET

1.3.6.1.2.1.4.34.1.3.4.20.254.128.0.0.0.0.0.0.0.254.8.255.254.203.38.197.0.0.0.2

RESP_OID :

1.3.6.1.2.1.4.34.1.3.4.20.254.128.0.0.0.0.0.0.0.254.8.255.254.203.38.197.0.0.0.2

COUNT

TIME[ms]

: 4

: 14

TIME_STAMP : Mar 13 05:36:52.279

Group:entity

Group:interface

TYPE

REQ_OID

RESP_OID

: GETNEXT

: 1.3.6.1.2.1.2.1

: 1.3.6.1.2.1.2.1.0

COUNT

TIME[ms]

: 1

: 0

TIME_STAMP : Mar 13 05:36:52.279

76


SNMP Server Commands show snmp statistics poll oid all

show snmp statistics poll oid all

To show all object IDs (OIDs) polled from all network management system (NMS) and how many times it has polled, use the show snmp statistics poll oid all command in EXEC mode.



Command Modes


Command History

Release

Release 5.2.2

Modification





The maximum number of entries equals the number of OIDs that were polled. The maximum number of NMS details for each OID is 15.

The show snmp statistics poll oid all command shows these details:

Field

Object ID

Description

OID requested from NMS.

NMS List of NMS IP address requested for each OID.

Count Number of times OID is polled for each NMS.

Task ID

Task ID

snmp

Operations

read, write

Examples



Object ID : 1.3.6.1.2.1.1.3

NMS

10.2.1.3

COUNT

10

10.3.1.2

10.4.1.3

10.12.1.3

30

20

5


77


Object ID

NMS

10.2.1.3

10.3.1.2

10.4.1.3

10.12.1.3

: 1.3.6.1.2.1.1.4

COUNT

10

5

20

30

Object ID : 1.3.6.1.2.1.1.5

NMS COUNT

10.2.1.3

10.3.1.2

10.4.1.3

10

3

2


78



Show snmp statistics poll oid nms

Show snmp statistics poll oid nms

To show which object ID (OID) is polled from which network management system (NMS) and how many times it has polled, use the show snmp statistics poll oid nms command in EXEC mode.

show snmp statistics poll oid nms<V4 / V6 address>


Command Modes


Command History

Release

Release 5.2.2

Modification





The show snmp statistics poll oid nms command shows these details:

Field

Object ID

Description

OID requested from NMS.

NMS

Count

List of NMS IP address requested for each OID.

Number of times OID is polled for each NMS.

Task ID

Task ID

snmp

Operations

read, write

Examples


show snmp statistics poll nms 1.2.3.4

NMS Address : 1.2.3.4

Object ID

1.3.6.1.2.1.2.2.1.2

Count

14


79

SNMP Server Commands show snmp statistics slow oid [after/before] hh:mm:ss day mday year

show snmp statistics slow oid [after/before] hh:mm:ss day mday year

To show the object ID (OID) that has exceeded beyond the threshold time for processing and the number of times that the threshold limit is exceeded with the latest timestamp, use the show snmp statistics slow oid

[after/before] hh:mm:ss day mday year command in EXEC mode.

show snmp statistics slow oid[after/before] hh:mm:ss day mday year


Command Modes


Command History

Release

Release 5.2.2

Modification





Default threshold limit for this data as 500 milli seconds. To change the default value, use the command:

Snmp-server logging threshold oid-processing < <0-20000>

The latest 500 entries for each sub agent is displayed and a total of upto 2000 entries is maintained.

The show snmp statistics slow oid [after/before] hh:mm:ss day mday year command shows these details:

Field

Type

Description

Request type for slow OID.

Exact OID

Resp OID

Requested OID from NMS.

Response OID for the Request type and EXACT OID.

Slow Count

Slow Time

Time Stamp

Number of times OID is slow.

Time taken for processing the OID in milli seconds.

Time stamp of the slow OID when MIB responded to MIBD.

80


SNMP Server Commands show snmp statistics slow oid [after/before] hh:mm:ss day mday year

Task ID

Examples

Task ID

snmp

Operations

read, write

This example shows a slow OIDs that exceeds the specified threshold time.



Group:agent

TYPE

REQ_OID

RESP_OID

COUNT

TIME[ms]

TIME_STAMP

: GETNEXT

: 1.3.6.1.2.1.1.1.0

: 1.3.6.1.2.1.1.1.2

: 2

: 0

: Mar 13 05:36:52.279

Group:infra

Group:route

TYPE

REQ_OID :

: GETNEXT

1.3.6.1.2.1.4.34.1.3.4.20.254.128.0.0.0.0.0.0.0.254.8.255.254.203.38.197.0.0.0.2

RESP_OID :

1.3.6.1.2.1.4.34.1.3.4.20.254.128.0.0.0.0.0.0.0.254.8.255.254.203.38.197.0.0.0.2

COUNT

TIME[ms]

: 4

: 14

TIME_STAMP : Mar 13 05:36:52.279

TYPE

REQ_OID :

: GET

1.3.6.1.2.1.4.34.1.3.4.20.254.128.0.0.0.0.0.0.0.254.8.255.254.203.38.197.0.0.0.2

RESP_OID :

1.3.6.1.2.1.4.34.1.3.4.20.254.128.0.0.0.0.0.0.0.254.8.255.254.203.38.197.0.0.0.2

COUNT

TIME[ms]

: 4

: 14

TIME_STAMP : Mar 13 05:36:52.279

Group:entity

Group:interface

TYPE

REQ_OID

RESP_OID

: GETNEXT

: 1.3.6.1.2.1.2.1

: 1.3.6.1.2.1.2.1.0

COUNT

TIME[ms]

: 1

: 0

TIME_STAMP : Mar 13 05:36:52.279


81

SNMP Server Commands show snmp mib ifmib general

show snmp mib ifmib general

To show how many requests get data from internal cache and how many requests are sent to statsd to get data, use the show snmp mib ifmib general command in EXEC mode.



Command Modes


Command History

Release

Release 5.2.2

Modification





Default IFMIB internal cache is 15 seconds. To change the duration, use the command: snmp-server ifmib internal cache max-duration <0-60>

The default duration is 15 seconds, 0 seconds to disable the IFMIB internal cache.

To service the requests from Stats cache instead of Drivers, use the command: snmp-server ifmib stats cache

The show snmp mib ifmib general command shows these details:

Field

Cache Hit

Description

Number of times the request retrieves data from

IFMIB internal cache.

Cache Miss Number of times the request processed from statsd, and not from IFMIB internal cache

Last Access Time

Count

Latest time stamp of corresponding hit or miss.

Number of times the data is retrieved.

Task ID

The Cache Hit and Cache Miss are 32 bit counters. The maximum value is 2^31 and reset to 0 if the maximum value is exceeded.

Task ID

snmp

Operations

read, write

82



Examples


Show snmp mib ifmib general

Fri Mar 14 05:05:50.408 PDT

Type

Cache Hit

Count

328

Last Access Time

Mar 14 05:05:47.480

Cache Miss 2 Mar 14 05:05:47.386



83

SNMP Server Commands show snmp mib ifmib cache

show snmp mib ifmib cache

To show the Ifindex that has exceeded the threshold time for processing, the request type and the time stamp, use the show snmp mib ifmib cache command in EXEC mode. The threshold time for the data to create an entry is 500 milli seconds.



Command Modes


Command History

Release

Release 5.2.2

Modification





This command displays the latest 500 entries. An entry will be added when the difference between Cache in and Cache out time is more than 500 milli seconds. The timeout value cannot be changed.

The show snmp mib ifmib cache command shows these details:

Field

Index

Description

Interface index.

MIB IN Time stamp of the request when IFMIB starts processing.

Cache In

Cache Out

MIB Out

Time stamp in milli seconds when data retrieval from the cache starts for the request. It is offset from MIB

IN time stamp.

Time stamp in milli seconds when data is retrieved from cache. It is offset from MIB IN time stamp.

Time stamp in milli seconds of the response from IF

MIB. It is offset from MIB IN time stamp.

84


SNMP Server Commands show snmp mib ifmib cache

Task ID

Examples

Task ID

snmp

Operations

read, write



IFIndex Type

MIB OUT[ms]

MIB IN

2 Mar 18 07:14:41.815

2

2

NEXT

701

NEXT

679

NEXT

684

Mar 18 07:15:36.815

Mar 18 07:16:00.735

CACHE IN[ms]

4

0

0

CACHE OUT[ms]

701

679

684


85

SNMP Server Commands show snmp mib ifmib statsd

show snmp mib ifmib statsd

To show the Ifindex that has exceeded the threshold time for processing, the request type and the time stamp, use the show snmp mib ifmib statsd command in EXEC mode. The threshold time for the data to create an entry is 500 milli seconds.



Command Modes


Command History

Release

Release 5.2.2

Modification





This command displays the latest 500 entries. An entry will be added when the difference between Stats in and Stats out time is more than 500 milli seconds. The timeout value cannot be changed.

The show snmp mib ifmib statsd command shows these details:

Field

Index

Description

Interface index.

MIB IN Time stamp of the request when IFMIB starts processing.

Stats In

Stats Out

MIB Out

Time stamp in milli seconds when data retrieval from the Statsd starts for the request. It is offset from MIB

IN time stamp.

Time stamp in milli seconds when data is retrieved from Statsd. It is offset from MIB IN time stamp.

Time stamp in milli seconds of the response from IF

MIB. It is offset from MIB IN time stamp.

86


SNMP Server Commands show snmp mib ifmib statsd

Task ID

Examples

Task ID

snmp

Operations

read, write



IFIndex

OUT[ms]

Type MIB IN

NEXT Mar 18 07:14:41.815

STATS IN[ms]

4 2

701

2

679

2

684

NEXT

NEXT

Mar 18 07:15:36.815

Mar 18 07:16:00.735

0

0

STATS OUT[ms]

701

679

684

MIB


87

SNMP Server Commands show snmp traps details

show snmp traps details

To show the details about the traps generated for each host, the sent and drop count and the timestamp, use the show snmp traps details command in EXEC mode.



Command Modes


Command History

Release

Release 5.2.2

Modification





The show snmp traps details command shows these details:

Field

TrapOID

Description

Generated trap.

Sent

Drop

Number of times the trap sent from the host and port configured.

Number of times the trap dropped from the host and port configured.

Last-sent

Last-drop

Host udp-port

Time stamp when the last trap was sent from the host and port.

Time stamp when the last trap dropped from the host and port.

Configured address of the host to receive traps

Configured port to receive traps

Task ID

Task ID

snmp

Operations

read, write

88


SNMP Server Commands show snmp traps details

Examples



Mon Apr 7 17:14:07.241 UTC

HOST:9.22.24.150, udp-port:3333

------------------------------

TrapOID ciscoConfigManMIB.2.0.1

ciscoFlashDeviceInsertedNotif ciscoFlashDeviceRemovedNotif

Sent

2

1

1

Drop

0

0

0

Last-sent

Mon Apr 07 14 17:12:29

Mon Apr 07 14 17:12:28

Mon Apr 07 14 17:12:28

Last-drop

~

~

~


89

SNMP Server Commands show snmp informs details

show snmp informs details

To show the details about the informs generated for each host, the drop and retry count and the timestamp, use the show snmp informs details command in EXEC mode.



Command Modes


Command History

Release

Release 5.2.2

Modification





The show snmp informs details command shows these details:

Field

InformOID

Description

Generated inform.

Sent

Drop

Number of times the Inform is sent from the inform host and port configiured.

Number of times the Inform is sent from the inform host and port configiured.

Retry

Last-sent

Last-drop

Host udp-port

Number of times the Inform retries from the inform host and port configiured

Time stamp when the last inform was sent from the host and port.

Time stamp when the last inform dropped from the host and port.

Configured address of the host to receive traps.

Configured port to receive traps.

90


SNMP Server Commands show snmp informs details

Task ID

Examples

Task ID

snmp

Operations

read, write



Mon Apr 7 17:14:17.212 UTC

HOST:9.22.24.150, udp-port:5555

------------------------------

InformOID Sent Drop

Last-drop ciscoConfigManMIB.2.0.1

Apr 07 14 17:12:42 ciscoFlashDeviceInsertedNotif

Apr 07 14 17:12:42 ciscoFlashDeviceRemovedNotif

Apr 07 14 17:12:42 ciscoMgmt.117.2.0.1

Apr 07 14 17:12:42 ciscoMgmt.117.2.0.2

Apr 07 14 17:12:42|

8

4

4

8

4

2

1

1

2

1

6

3

3

3

6

Retry Last-sent

Mon Apr 07 14 17:12:54

Mon Apr 07 14 17:12:55

Mon Apr 07 14 17:12:54

Mon Apr 07 14 17:12:53

Mon Apr 07 14 17:12:52

Mon

Mon

Mon

Mon

Mon


91

SNMP Server Commands show snmp users

show snmp users

To display information about the configured characteristics of Simple Network Management Protocol (SNMP) users, use the show snmp users command in

EXEC mode.

show snmp users



Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.7.2

Modification





An SNMP user must be part of an SNMP group, as configured using the snmp-server user command.

Use the show snmp users command to display information about all configured users.

When configuring SNMP, you may see the logging message “Configuring snmpv3 USM user.” USM stands for the User-Based Security Model (USM) for SNMP Version 3 (SNMPv3). For further information about

USM, see RFC 3414, User-based Security Model (USM) for version 3 of the Simple Network Management

Protocol (SNMPv3).

Task ID

Task ID

snmp

Operations

read

Examples

This example shows sample output from the show snmp users command:


show snmp users

User name:user1

Engine ID:localSnmpID

92


SNMP Server Commands show snmp users


storage-type:nonvolatile active

Table 6: show snmp users Field Descriptions

Field

User name

Engine ID storage-type

Command

snmp-server group

snmp-server user

Definition

String identifying the name of the SNMP user.

String identifying the name of the copy of SNMP on the device.

Settings that are set in volatile or temporary memory on the device, or in nonvolatile or persistent memory where settings remain after the device is turned off and on again.

Description


SNMP views.

Configures a new user to an SNMP group.


93

SNMP Server Commands show snmp view

show snmp view

To display the configured views and the associated MIB view family name, storage type, and status, use the

show snmp view command in

EXEC mode.

show snmp view



Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.7.2

Modification





Task ID

Task ID

snmp

Operations

read

Examples

This example shows sample output from the show snmp view command:


show snmp view

view1 1.3 - included nonVolatile active v1default 1.3.6.1 - included nonVolatile active


Command

snmp-server group

Description


SNMP views.

94



Command

snmp-server user

Description

Configures a new user to an SNMP group.

show snmp view


95

SNMP Server Commands snmp-server chassis-id

snmp-server chassis-id

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

snmp-server chassis-id serial-number

no snmp-server chassis-id


serial-number

Unique identification string to identify the chassis serial number.

Command Default

On hardware platforms, where the serial number can be read by the device, the default is the serial number.

For example, some Cisco devices have default chassis ID values of their serial numbers.

Command Modes


Command History

Release

Release 3.7.2

Modification





Use the snmp-server chassis-id command to provide a message line identifying the SNMP server serial number.

The chassis ID message can be displayed with the show snmp command.

Task ID

Task ID

snmp

Operations

read, write

Examples

The following example shows how to specify the chassis serial number 1234456:


snmp-server chassis-id 1234456

96




Command

show snmp

snmp-server chassis-id

Description



97

SNMP Server Commands snmp-server community

snmp-server community

To configure the community access string to permit access to the Simple Network Management Protocol

(SNMP), use the snmp-server community command in global configuration mode. To remove the specified community string, use the no form of this command.

snmp-server community [clear| encrypted] community-string [view view-name] [RO| RW] [SDROwner|

SystemOwner] [ access-list-name ]

no snmp-server community community-string

Syntax Description clear encrypted

community-string

view view-name

RO

RW

SDROwner

SystemOwner

access-list-name

(Optional) Specifies that the entered community-string is clear text and should be encrypted when displayed by the show running command.

(Optional) Specifies that the entered community-string is encrypted text and should be displayed as such by the show running command.

Community string that acts like a password and permits access to the SNMP protocol. The maximum length of the community-string argument is 32 alphabetic characters.

If the clear keyword was used, community-string is assumed to be clear text. If the encrypted keyword was used, community-string is assumed to be encrypted.

If neither was used, community-string is assumed to be clear text.

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

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

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

(Optional) Limits access to the owner service domain router (SDR).

(Optional) Provides system-wide access.

(Optional) Name of an access list of IP addresses allowed to use the community string to gain access to the SNMP agent.

Command Default

By default, an SNMP community string permits read-only access to all MIB objects.

By default, a community string is assigned to the SDR owner.

98


SNMP Server Commands snmp-server community

Command Modes


Command History

Examples

Release

Release 3.7.2

Release 4.2.0

Modification


IPv6 was supported.




Use the snmp-server community command to configure the community access string to permit access to

SNMP.

To remove the specified community string, use the no form of this command.

Use the clear keyword to specify that the clear text community string you enter is displayed encrypted in the show running command output. To enter an encrypted string, use the encrypted keyword. To enter a clear text community string that is not encrypted by the system, use neither of these keywords.

When the snmp-server community command is entered with the SDROwner keyword, SNMP access is granted only to the MIB object instances in the owner SDR.

When the snmp-server community command is entered with the SystemOwner keyword, SNMP access is granted to the entire system.

Task ID

Task ID

snmp

Operations

read, write

This example shows how to assign the string comaccess to SNMP, allowing read-only access, and to specify that IP access list 4 can use the community string:


snmp-server community comaccess ro 4

The following example shows how to assign the string mgr to SNMP, allowing read-write access to the objects in the restricted view:


snmp-server community mgr view restricted rw

This example shows how to remove the community comaccess:


no snmp-server community comaccess


99

snmp-server community


Command

snmp-server view


Description

Creates or updates an SNMP view entry.

100


SNMP Server Commands snmp-server community-map

snmp-server community-map

To associate a Simple Network Management Protocol (SNMP) community with an SNMP context, security name, or a target-list use the snmp-server community-map command in global configuration mode. To change an SNMP community mapping to its default mapping, use the no form of this command.

snmp-server community-map [clear| encrypted] community-string [context context-name] [security-name

security-name] [target-list target]

no snmp-server community-map [clear| encrypted] community-string

Syntax Description clear encrypted

community-string

context context-name

security-name security-name

target-list target

(Optional) Specifies that the community-string argument is clear text.

(Optional) Specifies that the community-string argument is encrypted text.

Name of the community.

(Optional) Name of the SNMP context to which this community name is to be mapped.

(Optional) Security name for this community. By default, the string is the security name.

(Optional) Name of the target list for this community.

Command Default

The value of the community-string argument is also the security name.

Command Modes


Command History

Release

Release 3.7.2

Modification





Use the snmp-server community-map command to map an SNMPv1 or SNMPv2c community name to one or more of the following:


101

SNMP Server Commands snmp-server community-map

Task ID

• context name—Maps a community name to a specific SNMP context name. This allows MIB instances in an SNMP context to be accessed through SNMPv1 or SNMPv2c using this community name.

• security name—By default, the community name is used to authenticate SNMPv1 and SNMPv2c.

Configure a security name for a community name to override the default and authenticate SNMP with the security name.

• target—Target list identifies a list of valid hosts from which SNMP access can be made using a specific security name. When such mapping is done for a particular community name, SNMP access is allowed only from hosts included in the target list.

Use the clear keyword to specify that the clear text community string you enter is displayed encrypted in the

show running command output. To enter an encrypted string, use the encrypted keyword. To enter a clear text community string that is not encrypted by the system, use neither of these keywords.

Task ID

snmp

Operations

read, write

Examples

This example maps the community name “sample 2” to the SNMP context name “sample1”:


snmp-server community-map sample2 context sample1


Command

snmp-server context

snmp-server target list

Description

Creates a Simple Network Management Protocol (SNMP) context.

Creates an SNMP target list.

102


SNMP Server Commands snmp-server contact

snmp-server contact

To set the Simple Network Management Protocol (SNMP) system contact, use the snmp-server contact command in global configuration mode. To remove the system contact information, use the no form of this command.

snmp-server contact system-contact-string

no snmp-server contact


system-contact-string

String that describes the system contact information. The maximum string length is 255 alphanumeric characters.

Command Default

No system contact is set.

Command Modes


Command History

Release

Release 3.7.2




Use the snmp-server contact command to set the system contact string. Use the no form of this command to remove the system contact information.

Task ID

Task ID

snmp

Operations

read, write

Examples

Modification


This example shows how to specify a system contact string:


snmp-server contact Dial System Operator at beeper # 27345


103

snmp-server contact


Command

snmp-server location


Description

Specifies the system location for SNMP.

104


SNMP Server Commands snmp-server context

snmp-server context

To create a Simple Network Management Protocol (SNMP) context, use the snmp-server context command in global configuration mode. To remove an SNMP context, use the no form of this command.

snmp-server context context-name

no snmp-server context context-name


context-name

Name of the SNMP context.

Command Default

None

Command Modes


Command History

Release

Release 3.7.2




This command creates an SNMP context. By default, all the SNMP MIB instances are in a default context.

Create an SNMP context and map it to a particular feature to enable similar instances of the same object to co-exist in different SNMP contexts.

Task ID

Task ID

snmp

Operations

read, write

Examples

Modification


This example creates a new SNMP context named “sample1:”


snmp-server context sample1


105

SNMP Server Commands snmp-server context


Command

snmp-server community-map

snmp-server vrf

Description

Associates an SNMP community with an SNMP context, security name, or a target-list.

Configures the VPN routing and forwarding (VRF) properties of

SNMP.

106


SNMP Server Commands snmp-server context mapping

snmp-server context mapping

To map an SNMP context with a protocol instance, topology or VRF entity, use the snmp-server context

mapping command in global configuration mode.

snmp-server context mapping context-name [feature feature-name] [instance instance-name] [topology

topology-name] [vrf vrf-name]


context-name

feature feature-name

instance instance-name

topology topology-name

vrf vrf-name

Name of the SNMP context.

Specifies the protocol for which to map the context. Available options are:

• bridge—Layer 2 VPN bridge

• vrf—Virtual Routing and Forwarding

Maps the context to the specified protocol instance.

Maps the context to the specified protocol topology.

Maps the context to the specified VRF logical entity.

Command Default

No context mappings exist by default.

Command Modes


Command History

Release

Release 4.2.0

Modification





A device can support multiple instances of a logical network entity, such as protocol instances or VRFs. Most existing MIBs cannot distinguish between these multiple logical network entities. For example, the original

OSPF-MIB assumes a single protocol instance on a device, but you can now configure multiple OSPF instances on a device.

The snmp-server context mapping command maps a context to a protocol instance, topology or VRF logical entity.


107

SNMP Server Commands snmp-server context mapping

Task ID

Note

The snmp-server context mapping command does not work for OSPF and OSPFv3. Refer to the snmp

context commands.

Task ID

snmp

Operation

read, write

Examples

This example illustrates how to map an snmp context to an OSPF instance:

RP/0/RSP0/CPU0:router(config)# snmp-server context mapping con5 feature ospf instance in1


Command

show snmp context

snmp context (OSPF)

Description

Displays the enhanced SNMP context mappings.

Specifies SNMP context for an OSPF instance.

108


SNMP Server Commands snmp-server engineid local

snmp-server engineid local

To specify Simple Network Management Protocol (SNMP) engine ID on the local device, use the snmp-server

engineid local command in global configuration mode. To return the engine ID to the default, use the no form of this command.

snmp-server engineid local engine-id

no snmp-server engineid local engine-id


engine-id

Character string that identifies the engine ID. Consists of up to 24 characters in hexadecimal format. Each hexadecimal number is separated by a colon (:).

Command Default

An SNMP engine ID is generated automatically.

Command Modes


Command History

Release

Release 3.7.2

Modification





Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to configure the SNMP engine ID on the local device:


snmp-server engineID local 00:00:00:09:00:00:00:a1:61:6c:20:61


109

SNMP Server Commands snmp-server engineid local


Command

show snmp engineid

Description

Displays the identification of the local Simple Network Management

Protocol (SNMP) engine that has been configured on the router.

110


SNMP Server Commands snmp-server engineid remote

snmp-server engineid remote

To specify a Simple Network Management Protocol (SNMP) engine ID on a remote device, use the

snmp-server engineid remote command in global configuration mode. To return the engine ID to the default, use the no form of this command.

snmp-server engineid remote ip-address engine-id udp-port port

no snmp-server engineid remote ip-address engine-id udp-port port


ip-address engine-id

udp-port port

IP address of remote SNMP notification host

Character string that identifies the engine ID. Consists of up to 24 characters in hexadecimal format. Each hexadecimal number is separated by a colon (:).

(Optional) Specifies the User Datagram Protocol (UDP) port of the host to use.

Range is from 1 to 65535. The default UDP port is 161.

Command Default

An SNMP engine ID is generated automatically.

Command Modes


Command History

Release

Release 3.7.2

Release 4.2.0

Modification


Support for IPv6 was added.




The IP address of the remote host can be in either IPv4 or IPv6 format.

Task ID

Task ID

snmp

Operation

read, write


111

SNMP Server Commands snmp-server engineid remote

Examples

This example shows how to configure the SNMP engine ID on the local device:

RP/0/RP0/CPU0:Router(config)#

snmp-server engineID remote 172.16.4.1

00:00:00:09:00:00:00:a1:61:6c:20:61


Command

show snmp engineid


Description

Displays the identification of the local Simple Network Management

Protocol (SNMP) engine that has been configured on the router.


112


SNMP Server Commands snmp-server entityindex persist

snmp-server entityindex persist

To enable the persistent storage of ENTITY-MIB data across process restarts, switchovers, and device reloads, use the snmp-server entityindex persist command in global configuration mode. To disable the persistent storage of ENTITY-MIB data, use the no form of this command.

snmp-server entityindex persist no snmp-server entityindex persist



Command Default

None

Command Modes


Command History

Release

Release 3.9.0

Modification





Task ID

Task ID

snmp

Operation

read, write

Examples

This example illustrates how to enable persistent storage of ENTITY-MIB indices:


snmp-server entityindex persist


Command

snmp-server mibs cbqosmib persist

Description

Enables persistent storage of

CISCO-CLASS-BASED-QOS-MIB data.


113

SNMP Server Commands snmp-server group

snmp-server group

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

snmp-server group name {v1| v2c| v3 {auth| noauth| priv}} [read view] [write view] [notify view] [context

context-name] [ access-list-name ]

no snmp-server group name


name

v1 v2c v3 auth noauth priv

read view

write view

notify view


access-list-name

Name of the group.

Specifies a group that uses the SNMPv1 security model. The SNMP v1 security model is the least secure of the possible security models.

Specifies a group that uses the SNMPv2c security model. The SNMPv2c security model is the second least secure of the possible security models.

Specifies a group that uses the SNMPv3 security model. The SNMP v3 security is the most secure of the possible security models.

Specifies authentication of a packet without encrypting it.

Specifies no authentication of a packet.

Specifies authentication of a packet with encryption.

(Optional) Specifies a read view string (not to exceed 64 characters) that is the name of the view that allows only the contents of the agent to be viewed.

(Optional) Specifies a write view string (not to exceed 64 characters) that is the name of the view used to enter data and configure the contents of the agent.

(Optional) Specifies a notify view string (not to exceed 64 characters) that is the name of the view used to specify a notify or trap.

(Optional) Specifies the SNMP context to associate with this SNMP group and associated views.

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

Command Default

See

Table 7: snmp-server group Default Descriptions, on page 115

.

114



Command Modes


Command History

Release

Release 3.7.2

Modification





This table describes the default values for the different views:

Table 7: snmp-server group Default Descriptions

Default

read view

write view

notify view

Definition

Assumed to be every object belonging to the Internet

(1.3.6.1) object identifier (OID) space, unless the user uses the read option to override this state.

Nothing is defined for the write view (that is, the null OID). You must configure write access.

Nothing is defined for the notify view (that is, the null OID). If a view is specified, any notifications in that view that are generated are sent to all users associated with the group (provided an SNMP server host configuration exists for the user).

Configuring Notify Views

Do not specify a notify view when configuring an SNMP group for the following reasons:

• The snmp-server host command autogenerates a notify view for the user, and then adds it to the group associated with that user.

• Modifying the notify view of the group affects all users associated with that group.

The notify view option is available for two reasons:

• If a group has a notify view that is set using SNMP, you may need to change the notify view.

• The snmp-server host command may have been configured before the snmp-server group command.

In this case, reconfigure the snmp-server host command or specify the appropriate notify view.

Instead of specifying the notify view for a group as part of the snmp-server group command, use the following commands in global configuration mode:


115


Task ID

• snmp-server user—Configures an SNMP user.

• snmp-server group—Configures an SNMP group, without adding a notify view.

• snmp-server host—Autogenerates the notify view by specifying the recipient of a trap operation.

Working with Passwords and Digests

No default values exist for authentication or privacy algorithms when this command is configured. In addition, no default passwords exist. The minimum length for a password is one character, although we recommend using eight characters for security. A plain-text password or localized Message Digest 5 (MD5) password can be specified. Forgotten passwords cannot be recovered, and the user must be reconfigured.

SNMP Contexts

SNMP contexts provide Virtual Private Network (VPN) users with a secure way of accessing MIB data. When a VPN is associated with a context, that VPN’s specific MIB data exists in that context. Associating a VPN with a context enables service providers to manage networks with multiple VPNs. Creating and associating a context with a VPN enables a provider to prevent the users of one VPN from accessing information about users of other VPNs on the same networking device.

Task ID

snmp

Operations

read, write

Examples

The following example shows how to configure an SNMP version 3 group named group1 that requires the authentication of packets with encryption:


snmp-server group group1 v3 priv


Command

show snmp

show snmp group

snmp-server host

snmp-server view

Description


Displays the names of groups on the router, security model, status of the different views, and storage type of each group.

Specifies the recipient of a Simple Network Management Protocol (SNMP) notification operation.

Creates or updates an SNMP view entry.

116


SNMP Server Commands snmp-server host

snmp-server host

To specify the recipient of a Simple Network Management Protocol (SNMP) notification operation, use the

snmp-server host command in global configuration mode. To remove the specified host, use the no form of this command.

snmp-server host address [clear| encrypted] [informs] [traps] [version {1| 2c| 3 {auth| noauth| priv}}]

community-string [udp-port port] [ notification-type ]

nosnmp-server host address [clear| encrypted] [informs] [traps] [version {1| 2c| 3 {auth| noauth| priv}}]

community-string [udp-port port] [ notification-type ]


address

clear encrypted informs traps version

1

2c

3 auth noauth priv

community-string

udp-port port

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


(Optional) Specifies that the community-string argument is encrypted text.

(Optional) Specifies to send inform messages to this host.

(Optional) Specifies that notifications should be sent as traps. This is the default.

(Optional) Specifies the version of the SNMP used to send the traps.

Specifies SNMPv1, the default.

Specifies SNMPv2C.

Specifies SNMPv3. Version 3 is the most secure model because it allows packet encryption. If you specify the SNMPv3 keyword, you must specify the security level.

Enables Message Digest 5 (MD5) algorithm and Secure Hash Algorithm

(SHA) packet authentication.

Specifies that the noAuthNoPriv security level applies to this host. This is the default security level for SNMPv3.

Enables Data Encryption Standard (DES) packet encryption (also called

“privacy”).

Password-like community string sent with the notification operation. We recommend defining this string using the snmp-server community command prior to using the snmp-server host command.

(Optional) Specifies the User Datagram Protocol (UDP) port of the host to use. Range is from 1 to 65535. The default UDP port is 161.


117


notification-type

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

• bgp —Enables SNMP Border Gateway Protocol Version 4 (BGPv4) traps.

• config —Controls configuration notifications, as defined in the

CISCO-CONFIG-MAN-MIB (enterprise 1.3.6.1.4.1.9.9.43.2). The notification type is (1) ciscoConfigManEvent.

• copy-complete —Enables CISCO-CONFIG-COPY-MIB ccCopyCompletion traps.

• entity —Controls Entity MIB modification notifications. This notification type is defined in the ENTITY-MIB (enterprise

1.3.6.1.2.1.47.2) as: (1) entConfigChange.

• fabric —Enables SNMP fabric traps.

• fru-ctrl —Enables SNMP entity field-replaceable unit (FRU) control traps.

• mpls —Enables SNMP Multiprotocol Label Switching (MPLS) traps.

• sensor —Enables SNMP entity sensor traps.

• snmp —Enables SNMP traps.

• syslog —Controls error message notifications (Cisco-syslog-MIB).

Specify the level of messages to be sent with the logging history command.

Command Default

This command is disabled by default. No notifications are sent.

The default UDP port is 161.

When this command is entered without keywords, the default is to send all trap types to the host.

If no version keyword is entered, the default is version 1.

If version 3 is specified, but the security level is not specified, the default security level is noauth.

Command Modes


Command History

Release

Release 3.7.2

Release 4.1.0

Release 4.2.0

Modification


The informs keyword was added.


118






SNMP notifications can be sent as traps. Traps are unreliable because the receiver does not send acknowledgments when it receives traps. The sender cannot determine if the traps were received. Traps are discarded as soon as they are sent. Traps are also sent only once.

When the snmp-server host command is not entered, no notifications are sent. To configure the device to send SNMP notifications, configure at least one snmp-server host command. When the command is entered without keywords, all trap types are enabled for the host.

To enable multiple hosts, issue a separate snmp-server host command for each host. You can specify multiple notification types in the command for each host.

When multiple snmp-server host commands are given for the same host and kind of notification (trap), each succeeding snmp-server host command overwrites the previous command. Only the last snmp-server host command is in effect. For example, if an snmp-server host command with the traps keyword is entered for a host and then another command with the traps keyword is entered for the same host, the second command replaces the first.

Either a host name or IP address can be used to specify the host. Both IPv4 and IPv6 IP address formats are supported.

The snmp-server host command is used with the snmp-server engineid command. Use the snmp-server

traps command to specify which SNMP notifications are sent globally. For a host to receive most notifications, at least one snmp-server traps command and the snmp-server host command for that host must be enabled.

However, some notification types cannot be controlled with the snmp-server traps command. For example, some notification types are always enabled. Other notification types are enabled by a different command.

The availability of a notification-type depends on the device type and Cisco software features supported on the device.

To display which notification types are available on the system, use the question mark (?) online help function at the end of the snmp-server host command.

The no snmp-server host command used with no keywords disables traps.



If the informs keyword is used, the SNMP version can be only SNMPv2C or SNMPv3.

Task ID

Task ID

snmp

Operations

read, write


119


Examples

This example shows how to send RFC 1157 SNMP traps to the host specified by the name myhost.cisco.com.

Other traps are enabled, but only SNMP traps are sent because only the snmp keyword is specified in the

snmp-server host command. The community string is defined as comaccess.


snmp-server traps


snmp-server host myhost.cisco.com comaccess snmp

This example shows how to send the SNMP traps to address 172.30.2.160:


snmp-server traps snmp


snmp-server host 172.30.2.160 public snmp

This example shows how to enable the router to send all traps to the host, myhost.cisco.com, using the community string public:




snmp-server host myhost.cisco.com public

This example shows how to prevent traps from being sent to any host. The BGP traps are enabled for all hosts, but only the configuration traps are enabled to be sent to a host.


snmp-server traps bgp


snmp-server host hostabc public config

This example shows how to send SNMPv3 informs to a host:


snmp-server host 172.30.2.160 informs version 3


Command


snmp-server inform

snmp-server traps bgp

Description


Configures SNMP inform message options.

Enables BGP state-change SNMP notifications.

120


SNMP Server Commands snmp-server ifindex persist

snmp-server ifindex persist

To enable ifIndex persistence globally on all Simple Network Management Protocol (SNMP) interfaces, use the snmp-server ifindex persist command in global configuration mode. To disable global interface persistence, use the no form of this command.

snmp-server ifindex persist no snmp-server ifindex persist



Command Default

Global interface persistence is disabled.

Command Modes


Command History

Release

Release 3.7.2

Modification





Use the snmp-server ifindex persist command to enable ifIndex persistence on all interfaces that have entries in the ifIndex table of the IF-MIB. When enabled, this command retains the mapping between the ifName object values and the ifIndex object values (generated from the IF-MIB) persistent during reloads, allowing for consistent identification of specific interfaces using SNMP. Applications such as device inventory, billing, and fault detection depend on this feature.

Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to enable ifIndex persistence globally:


snmp-server ifindex persist


121

SNMP Server Commands snmp-server ifindex persist


Command

index persistence

notification linkupdown

show snmp interface

Description

Enables index persistence on an SNMP interface.

Enables or disables linkUp and linkDown trap notifications on an SNMP interface.


122


SNMP Server Commands snmp-server ifmib ifalias long

snmp-server ifmib ifalias long

To enable the ifAlias IF-MIB object to accept an interface alias name that exceeds the 64-byte default, use the snmp-server ifmib ifalias long command. Use the no form of this command to revert to the default length.

snmp-server ifmib ifalias long no snmp-server ifmib ifalias long



Command Default

Global interface persistence is disabled.

The alias name is 64 bytes in length.

Command Modes


Command History

Release

Release 3.7.2

Modification





Use the snmp-server ifmib ifalias long command to enable the IF-MIB object ifAlias to accept an interface alias name that is greater than 64 bytes in length. The default length for the alias name is 64 bytes.

Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to enable the IF-MIB object ifAlias:


snmp-server ifmib ifalias long


exit

Uncommitted changes found, commit them before exiting(yes/no/cancel)? [cancel]:

yes



123

SNMP Server Commands snmp-server ifmib internal cache max-duration

snmp-server ifmib internal cache max-duration

To configure the refresh interval for the IF-MIB statistics cache, use the snmp-server ifmib internal cache

max-duration command in global configuration mode. To revert to the default cache interval, use the no form of this command.

snmp-server ifmib internal cache max-duration timeout


timeout

Length of time before the cache is refreshed. Values can range from 0 to 60 seconds.

The default is 15.

Command Default

timeout: 15 seconds

Command Modes


Command History

Release

Release 4.2.3




The snmp-server ifmib internal cache max-duration command controls the refresh interval of the cache.

If the timeout value in the snmp-server ifmib internal cache max-duration command is set to zero, the cache is disabled. By default, the counters are cached for 15 secs in the ifmib internal cache, after which it will be discarded.

Task ID

Task ID

snmp

Operation

read, write

Examples

Modification


This example shows how to change the refresh interval for the IF-MIB statistics cache.

RP/0/RSP0/CPU0:routerrouter(config)#

snmp-server ifmib internal cache max-duration 60

124


SNMP Server Commands snmp-server ifmib internal cache max-duration


Command

snmp-server ifmib stats cache

Description

Enables retrieval of cached statistics instead of real-time statistics.


125

SNMP Server Commands snmp-server ifmib ipsubscriber

snmp-server ifmib ipsubscriber

To enable IP subscriber interfaces in the interfaces MIB (IF-MIB), use the snmp-server ifmib ipsubscriber command in global configuration mode. To disable IP subscriber interfaces, use the no form of this command.

snmp-server ifmib ipsubscriber no snmp-server ifmib ipsubscriber



Command Default

Ip subscriber interfaces are not enabled.

Command Modes


Command History

Release

Release 4.2.0

Modification





Task ID

Task ID

snmp

Operation

read, write

Examples

This example shows how to enable IP subscriber interfaces in the IF-MIB:


configure


snmp-server ifmib ipsubscriber

126


SNMP Server Commands snmp-server ifmib stats cache

snmp-server ifmib stats cache

To enable retrieval of cached statistics instead of real-time statistics, use the snmp-server ifmib stats cache command. To revert to the default, use the no form of this command.

snmp-server ifmib stats cache no snmp-server ifmib stats cache



Command Default

Cached statistics are not enabled.

Command Modes


Command History

Release

Release 3.7.2

Modification





Cisco IOS XR statistics infrastructure maintains a cache of statistics for all interfaces. This cache is updated every 30 seconds. Use the snmp-server ifmib stats cache command to enable the IF-MIB to retrieve these cached statistics rather than real-time statistics. Accessing cached statistics is less CPU-intensive than accessing real-time statistics.

Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to enable the IF-MIB caches statistics:


snmp-server ifmib stats cache


exit

Uncommitted changes found, commit them before exiting(yes/no/cancel)? [cancel]:

yes



127

SNMP Server Commands snmp-server ifmib stats cache


Command

snmp-server ifmib internal cache max-duration

Description

Configures the refresh interval for the IF-MIB statistics cache.

128


SNMP Server Commands snmp-server inform

snmp-server inform

To configure Simple Network Management Protocol (SNMP) inform message options, use the snmp-server

inform command in global configuration mode. To revert to the default informs options, use the no form of this command.

snmp-server inform {pending max-no| retries no-retries| timeout seconds}

no snmp-server inform {pending max-no| retries no-retries| timeout seconds}


pending max-no

retries no-retries

timeout seconds

Specifies the maximum number of inform messages to hold in the queue.

The default is 25.

Specifies the retry count for inform messages. Values can be from 1 to 100.

The default is three.

Specifies the inform message timeout value in seconds. The default is 15.

Command Default

None

Command Modes


Command History

Release

Release 4.2.0

Modification





To enable the sending of SNMP inform messages, use the snmp-server host command with the informs keyword. When SNMP server informs are enabled, the SNMP version can be only SNMPv2C or SNMPv3.

Task ID

Task ID

snmp

Operations

read, write


129

SNMP Server Commands snmp-server inform

Examples

This example shows how to configure SNMP inform messages:


snmp-server host myhost.cisco.com informs comaccess


snmp-server inform pending 40


snmp-server inform retries 10


Command

snmp-server host

Description

Specifies the recipient of a Simple Network Management Protocol

(SNMP) notification operation.

130


SNMP Server Commands snmp-server interface

snmp-server interface

To enable an interface to send Simple Network Management Protocol (SNMP) trap notifications and enter

SNMP interface configuration mode, use the snmp-server interface command in global configuration mode.

To disable the sending of SNMP trap notifications on an interface, use the no form of this command.

snmp-server interface type interface-path-id

no snmp-server interface type interface-path-id



Interface type. For more information, use the question mark (?) online help function.

Physical interface or virtual interface.

Note



Command Default

Ethernet interfaces are enabled to send SNMP trap notifications. SNMP trap notifications are disabled on all other physical and logical interfaces.

Command Modes


Command History

Release

Release 3.7.2

Modification





The snmp-server interface command enters SNMP interface configuration mode for you to configure the available SNMP options.

Note

In references to a Management Ethernet interface located on a route switch processor card, the physical slot number is numeric (0 through n-1 where n is the number of line card slots in the chassis) and the module is CPU0. Example: interface MgmtEth0/1/CPU0/0.


131

SNMP Server Commands snmp-server interface

Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to assign ifIndex persistence on Packet-over-SONET/SDH (POS) interface 0/0/1/0:


snmp-server interface pos 0/0/1/0



Command

show snmp interface



Description




132


SNMP Server Commands snmp-server interface subset

snmp-server interface subset

To enter snmp-server interface subset configuration mode for a set of interfaces, use the snmp-server interface

subset command in global configuration mode. To revert to the default interface settings, use the no form of this command.

snmp-server interface subset subset-number regular-expression expression

no snmp-server interface subset subset-number


subset-number

regular-expression expression

Identifying number of the interface subset, which also indicates its relative priority.

Specifies for which subset of interfaces to enter snmp-server interface subset configuration mode. The expression argument must be entered surrounded by double quotes.

Command Default

None

Command Modes


Command History

Release

Release 3.9.0

Modification





The subset-number argument is used to set the priority for an interface that matches more than one configured regular expressions. Lower values of the subset-number have a higher priority. If a single interface becomes part of a multiple-interface configured regular expression, the configuration with the lower subset-number value is applied.

Regular expressions have two constraints:

• Regular expressions must always be entered within double quotes to ensure that the CLI interprets each character correctly.

• All characters that are part of a regular expression are considered regular characters with no special meaning. In order to enter special characters, such as "\" or "?," they must be preceded by the backslash character "\." For example, to enter the regular expression ([A-Z][A-Z0-9]*)\b[^>]*>(.*?)</\1, you would enter ([A-Z][A-Z0-9]*)\\b[^>]*>(.*\?)</\\1.


133

SNMP Server Commands snmp-server interface subset

Task ID



From the snmp-server interface mode of a subset of interfaces, SNMP linkUp and linkDown notifications can be enabled or disabled using the notification linkupdown disable command.

Task ID

snmp

Operation

read, write

Examples

This example illustrates how to configure all Gigabit Ethernet interfaces:


config


snmp-server int subset 2 regular-expression "^Gig[a-zA-Z]+[0-9/]+\."

RP/0/RSP0/CPU0:router(config-snmp-if-subset)#


Command Description

notification linkupdown

show snmp interface notification

Enables or disables linkUp and linkDown trap notifications on an

SNMP interface.

Displays the linkUp and linkDown notification status for the specified interfaces.

show snmp interface regular-expression

Displays interface names and indices assigned to interfaces that match a regular expression.

134


SNMP Server Commands snmp-server ipv4 dscp

snmp-server ipv4 dscp

To mark packets with a specific differentiated services code point (DSCP) value, use the snmp-server ipv4

dscp command in global configuration mode. To remove matching criteria, use the no form of this command.

snmp-server ipv4 dscp value

no snmp-server ipv4 dscp [ value ]


value

Value of the DSCP. The DSCP value can be a number from 0 to 63, or it can be one of the following keywords: default, ef, af11, af12, af13, af21, af22, af23, af31, af32, af33,

af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7.

Command Default

The IP DSCP default value for SNMP traffic is 0.

Command Modes


Command History

Release

Release 3.7.2

Modification





Use the snmp-server ipv4 dscp command to specify an IP DSCP value to give SNMP traffic higher or lower priority in your network.

Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to configure the DSCP value to af32:


snmp-server ipv4 dscp af32


135

SNMP Server Commands snmp-server ipv4 precedence

snmp-server ipv4 precedence

To mark packets with a specific precedence level to use for packet matching, use the snmp-server ipv4

precedence command in global configuration mode. To restore the system to its default interval values, use the no form of this command.

snmp-server ipv4 precedence value

no snmp-server ipv4 precedence [ value ]


value

Value of the precedence. The precedence value can be a number from 0 to 7, or it can be one of the following keywords:

critical

Set packets with critical precedence (5)

flash

Set packets with flash precedence (3)

flash-override

Set packets with flash override precedence (4)

immediate

Set packets with immediate precedence (2)

internet

Set packets with internetwork control precedence (6)

network

Set packets with network control precedence (7)

priority

Set packets with priority precedence (1)

routine

Set packets with routine precedence (0)

Command Default

The IP Precedence default value for SNMP traffic is 0.

Command Modes


136


SNMP Server Commands snmp-server ipv4 precedence

Command History

Release

Release 3.7.2




Use the snmp-server ipv4 precedence command to specify an IP Precedence value to give SNMP traffic higher or lower priority in your network.

Task ID

Task ID

snmp

Operations

read, write

Examples

Modification


This example shows how to set the precedence to 2:


snmp-server ipv4 precedence 2


137

SNMP Server Commands snmp-server location

snmp-server location

To specify the system location for Simple Network Management Protocol (SNMP), use the snmp-server

location command in global configuration mode. To remove the location string, use the no form of this command.

snmp-server location system-location

no snmp-server location


system-location

String indicating the physical location of this device. The maximum string length is 255 alphanumeric characters.

Command Default

No system location string is set.

Command Modes


Command History

Release

Release 3.7.2

Modification





Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to specify a system location string:


snmp-server location Building 3/Room 214

138




Command

snmp-server contact

Description

Sets the SNMP system contact.

snmp-server location


139

SNMP Server Commands snmp-server mib bulkstat max-procmem-size

snmp-server mib bulkstat max-procmem-size

To configure the overall per-process memory size limit used by all bulk statistics files in the process, use the

snmp-server mib bulkstat max-procmem-size command in global configuration mode. To remove the overall per-process memory size, use the no form of this command.

snmp mib bulkstat max-procmem-size size

no snmp mib bulkstat max-procmem-size [ size ]


size

Overall per-process memory size limit in kilobytes. The valid range is from 100 to

200000. The default is 200000.

Command Default

The maximum process memory size is 200000 KB.

Command Modes


Command History

Release

Release 4.2.0

Modification





Currently 300 MB is the maximum process memory available for MIB and SNMP processes.

Task ID

Task ID

snmp

Operation

read, write

Examples

This example sets the maximum process memory size to 100000 KB.


configure


snmp-server mib bulkstat max-procmem-size 100000

140


SNMP Server Commands snmp-server mib bulkstat object-list

snmp-server mib bulkstat object-list

To configure a Simple Network Management Protocol (SNMP) bulk statistics object list and enter bulk statistics objects configuration mode, use the snmp-server mib bulkstat object-list in global configuration mode. To remove an SNMP object list configuration, use the no form of this command.

snmp-server mib bulkstat object-list object-list-name

no snmp-server mib bulkstat object-list object-list-name


object-list-name

Name or object identifier (OID) of the bulk statistics object list to configure.

Command Default

No SNMP bulk statistics object list is configured.

Command Modes


Command History

Release

Release 4.2.0

Modification





The snmp-server mib bulkstat object-list command allows you to name an object list. Bulk statistics object lists are used for the Periodic MIB Data Collection and Transfer Mechanism.Use the add command to add objects to the object list configured with the snmp-server mib bulkstat object-list command. Bulk statistics object lists can be reused in multiple schemas.

Task ID

Task ID

snmp

Operation

read, write

Examples

In this example, a bulk statistics object list called ifmib is configured to include two objects:


config


snmp-server mib bulkstat object-list ifmib


141

SNMP Server Commands snmp-server mib bulkstat object-list


add ifOutOctets


add ifInOctets


Command

add (bulkstat object)


Description

Adds a MIB object to an SNMP bulk statistics object list.


142


SNMP Server Commands snmp-server mib bulkstat schema

snmp-server mib bulkstat schema

To configure a Simple Network Management Protocol (SNMP) bulk statistics schema and enter bulk statistics schema configuration mode, use the snmp-server mib bulkstat schema command in global configuration mode. To remove the SNMP bulk statistics schema, use the no form of this command.

snmp-server mib bulkstat schema schema-name

no snmp-server mib bulkstat schema schema-name


schema-name

Specifies the name of the schema to configure.

Command Default

No schemas are configured.

Command Modes


Command History

Release

Release 4.2.0

Modification





The snmp-server mib bulkstat schema command names the schema and enters bulk statistics schema configuration mode. Bulk statistics schema configuration mode is used to configure the object list, instance, and polling interval to be used in the schema.

The specific instances of MIB objects for which data should be collected are determined by appending the value of the instance command to the objects specified in the object list.

Multiple schemas can be associated with a single bulk statistics file when configuring the bulk statistics transfer options.

Task ID

Task ID

snmp

Operation

read, write


143

SNMP Server Commands snmp-server mib bulkstat schema

Examples

The following example shows how to configure a bulk statistics schema called GigE0/6/5/0:


configure


snmp-server mib bulkstat schema tengige 0/6/5/0


object-list ifmib


poll-interval 3


instance exact interface tengige 0/6/5/0 subif


exit


Command


poll-interval

Description


Configures the polling interval for a bulk statistics schema.

144


SNMP Server Commands snmp-server mib bulkstat transfer-id

snmp-server mib bulkstat transfer-id

To identify the bulk statistics transfer configuration and enter bulk statistics transfer configuration mode, use the snmp-server mib bulkstat transfer-id command in global configuration mode. To remove a previously configured transfer, use the no form of this command

snmp-server mib bulkstat transfer-id transfer-id

no snmp-server mib bulkstat transfer-id transfer-id


transfer-id

Name of the transfer configuration.

Command Default

Bulk statistics transfer is not configured.

Command Modes


Command History

Release

Release 4.2.0

Modification





The name, transfer-id, you specify for the bulk statistics transfer configuration is used in the filename of the bulk statistics file when it is generated and is used to identify the transfer configuration in the output of the

show snmp mib bulkstat transfer command.

Task ID

Task ID

snmp

Operation

read, write

Examples

In this example, The bulk statistics transfer is given the name bulkstat1 and contains two schemas:


configure




schema IFMIB


schema CAR


url primary


145

SNMP Server Commands snmp-server mib bulkstat transfer-id ftp://user1:pswrd@cbin2-host/users/user1/bulkstat1


url secondary tftp://[email protected]/tftpboot/user1/bulkstat1


format schemaASCII


transfer-interval 30


retry 5


buffer-size 1024


retain 30


end


Command

buffer-size

format (bulkstat)

retain

retry

schema


transfer-interval

url

Description

Configures a maximum buffer size for the transfer of bulk statistics files.

Specifies the format to be used for the bulk statistics data file.

Configures the retention interval for bulk statistics files.

Configures the number of retries that should be attempted for a bulk statistics file transfer.

Specifies the bulk statistics schema to be used in a specific bulk statistics transfer configuration.


Configures how long bulk statistics should be collected before a bulk statistics transfer is initiated.

Specifies the host to which bulk statistics files should be transferred.

146


SNMP Server Commands snmp-server mibs cbqosmib cache

snmp-server mibs cbqosmib cache

To enable and configure caching of the QoS MIB statistics, use the snmp-server mibs cbqosmib cache command in global configuration mode. To disable caching, use the no form of this command.

snmp-server mibs cbqosmib cache {refresh time time| service-policy count count}

no snmp-server mibs cbqosmib cache [refresh time time| service-policy count count]

Syntax Description refresh

time time

service-policy

count count

Enables QoS MIB caching with a specified cache refresh time.

Specifies the cache refresh time, in seconds. The time argument can be between 5 and 60. The default is 30.

Enables QoS MIB caching with a limited number of service policies to cache.

Specifies the maximum number of service policies to cache. The count argument can be between 1 and 5000.

Command Default

None

Command Modes


Command History

Release

Release 3.9.0




Task ID

Task ID

snmp

Operation

read, write

Examples

Modification


This example illustrates how to enable QoS MIB caching with a refresh time:


snmp-server mibs cbqosmib cache refresh time 45


147

SNMP Server Commands snmp-server mibs cbqosmib cache

This example illustrates how to enable QoS MIB caching with a service policy count limitation:


snmp-server mibs cbqosmib cache service-policy count 10


Command

snmp-server entityindex persist

snmp-server mibs cbqosmib persist

Description

Enables the persistent storage of ENTITY-MIB data.

Enables persistent storage of

CISCO-CLASS-BASED-QOS-MIB data.

148


SNMP Server Commands snmp-server mibs cbqosmib persist

snmp-server mibs cbqosmib persist

To enable persistent storage of the CISCO-CLASS-BASED-QOS-MIB data across process restarts, switchovers, and device reloads, use the snmp-server mibs cbqosmib persist command in global configuration mode.

To disable persistent storage of the MIB data, use the no form of this command.

snmp-server mibs cbqosmib persist no snmp-server mibs cbqosmib persist



Command Default

None

Command Modes


Command History

Release

Release 3.9.0

Modification





Task ID

Task ID

snmp

Operation

read, write

Examples

This example illustrates how to enable persistent storage of CISCO-CLASS-BASED-QOS-MIB data:


snmp-server mibs cbqosmib persist


Command

snmp-server entityindex persist

Description

Enables the persistent storage of ENTITY-MIB data.


149

SNMP Server Commands snmp-server mibs eventmib congestion-control

snmp-server mibs eventmib congestion-control

To configure the generation of SNMP traps when congestion exceeds configured thresholds, use the

snmp-server mibs eventmib congestion-control command in global configuration mode. To restore the default values, use the no form of this command.

snmp-server mibs eventmib congestion-control type interface-path-id falling lower-threshold interval

sampling-interval rising upper-threshold

no snmp-server mibs eventmib congestion-control type interface-path-id



falling lower-threshold

interval sampling-interval

rising upper-threshold



Note

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark

(?) online help function.

Specifies the lower threshold for which to determine whether an mteTriggerFalling SNMP Trap is generated.

Specifies how often the congestion statistics are polled. The interval argument, in minutes, can be between 5 and 1440; it must be a multiple of 5.

Specifies the upper threshold for which to determine whether an mteTriggerRising SNMP Trap is generated.

Command Default

None

Command Modes


Command History

Release

Release 4.2.0

Modification





150


SNMP Server Commands snmp-server mibs eventmib congestion-control

Task ID

Note

A maximum of 100 interfaces can be monitored for congestion.

Congestion configurations using the snmp-server mibs eventmib congestion-control command cannot be modified using SNMP SET and vice versa.

When the congestion between two intervals increases above the upper-threshold argument, an mteTriggerRising

SNMP trap is generated. This trap is not generated until the congestion drops below the lower threshold and then rises above the upper threshold.

When the congestion between two intervals falls below the lower-threshold argument, and an SNMP mteTriggerRising trap was generated previously, an SNMP mteTriggerFalling trap is generated. The mteTriggreRising trap is not generated until the congestion goes above the upper threshold and then falls back below the lower threshold.

The lower-threshold value (falling) should be set to a value less than or equal to the upper-threshold value

(rising).

The snmp-server mibs eventmib congestion-control command is configured on a specific interface and is supported on the following cards:

• 8-port 10 Gigabit Ethernet PLIM

• 16-port OC-48c/STM-16 POS/DPT PLIM

• 1-port OC-768c/STM-256 POS PLIM


• All Ethernet SPAs

• 2-port and 4-port OC-3c/STM-1 POS SPAs

• 2-port, 4-port, and 8-port OC-12c/STM-4 POS SPAs

• 2-port and 4-port OC-48c/STM-16 POS/RPR SPAs

• 1-port OC-192c/STM-64 POS/RPR SPA

Task ID

snmp

Operations

read, write

Examples

This example shows how to configure the generation of SNMP traps in response to congestion:


snmp-server mibs eventmib congestion-control pos 0/1/0/0 falling 1 interval 5 rising 2


151

SNMP Server Commands snmp-server mibs eventmib packet-loss

snmp-server mibs eventmib packet-loss

To configure the generation of SNMP traps when packet loss exceeds configured thresholds, use the

snmp-server mibs eventmib packet-loss command in global configuration mode. To restore the default values, use the no form of this command.

snmp-server mibs eventmib packet-loss type interface-path-id falling lower-threshold interval

sampling-interval rising upper-threshold

no snmp-server mibs eventmib packet-loss type interface-path-id



falling lower-threshold

interval sampling-interval

rising upper-threshold



Note

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark

(?) online help function.

Specifies the lower threshold for which to determine whether an mteTriggerFalling SNMP Trap is generated.

Specifies how often the packet loss statistics are polled. The interval argument, in minutes, can be between 5 and 1440; it must be a multiple of 5.

Specifies the upper threshold for which to determine whether an mteTriggerRising SNMP Trap is generated.

Command Default

None

Command Modes


Command History

Release

Release 3.9.0

Modification





152


SNMP Server Commands snmp-server mibs eventmib packet-loss

Task ID

Note

A maximum of 100 interfaces can be monitored for packet loss.

Packet loss configurations using the snmp-server mibs eventmib packet-loss command cannot be modified using SNMP SET and vice versa.

When the packet loss between two intervals increases above the upper-threshold argument, an mteTriggerRising

SNMP trap is generated. This trap is not generated until the packet loss drops below the lower threshold and then rises above the upper threshold.

When the packet loss between two intervals falls below the lower-threshold argument, and an SNMP mteTriggerRising trap was generated previously, an SNMP mteTriggerFalling trap is generated. The mteTriggreRising trap is not generated until the packet loss goes above the upper threshold and then falls back below the lower threshold.

The lower-threshold value (falling) should be set to a value less than or equal to the upper-threshold value

(rising).

The snmp-server mibs eventmib packet-loss command is configured on a specific interface and is supported on the following cards:

• 8-port 10 Gigabit Ethernet PLIM


• 1-port OC-768c/STM-256 POS PLIM


• All Ethernet SPAs

• 2-port and 4-port OC-3c/STM-1 POS SPAs

• 2-port, 4-port, and 8-port OC-12c/STM-4 POS SPAs

• 2-port and 4-port OC-48c/STM-16 POS/RPR SPAs

• 1-port OC-192c/STM-64 POS/RPR SPA

Task ID

snmp

Operations

read, write

Examples

This example shows how to configure the generation of SNMP traps in response to packet loss:


snmp-server mibs eventmib packet-loss pos 0/1/0/0 falling 1 interval 5 rising 2


153

SNMP Server Commands snmp-server mibs subscriber threshold

snmp-server mibs subscriber threshold

To set the snmp-server mibs server threshold parameters, use the snmp-server mibs subscriber threshold command in the global configuration mode. To delete any of the set parameters, use the no form of the command.

snmp-server mibs subscriber threshold [ rising | falling | delta-loss percent | delta-loss evaluation ]

[access-if location interface-path-id interval seconds][session-count ]

nosnmp-server mibs subscriber threshold

Syntax Description rising falling delta-loss percent delta-loss evaluation access-if

location name

interval seconds

session-count

Rising threshold value. The set value triggers the traps. Traps are generated when the number of sessions exceed the rising threshold value.

Falling threshold value. The set value triggers the traps. Traps are generated when the number of sessions are lesser than the falling threshold value.

Delta-loss percentage.

The actual subscriber sessions (after delta-loss) . This is based on the set delta-loss percentage. If the number of sessions exceed the loss percentage, traps are generated.

Access-interface.

Location name.

Interval between the rising and the falling thresholds (in seconds).

Subscriber-session count.

Command Default

None

Command Modes


Command History

Release

Release 5.1

Modification


154


SNMP Server Commands snmp-server mibs subscriber threshold




The minimum delta loss interval is 30 seconds and can be incremented by 10 seconds till the time period reaches 5 minutes.

Task ID

Task ID

snmp

Operation

read, write

Examples

RP/0/RSP0/CPU0:router (config) #

snmp-server mibs subscriber threshold delta-loss evaluation access-if tengige 0/4/0/0 interval 100


155

SNMP Server Commands snmp-server mibs subscriber threshold access-if

snmp-server mibs subscriber threshold access-if

To disable the per-session access notifications by the session monitoring process, use the snmp-server mibs

subscriber threshold access-if in the global configuration mode. To enable notifications, use the no form of the command.

snmp-server mibs subscriber threshold access-if subsetnumber regular expression word notification

rising-falling disable nosnmp-server mibs subscriber threshold access-if


subset number

regular expression word

notification rising-falling disable

Subset number of the subscriber threshold. Lower the subset value, higher is the priority. Range is 1 to

255.

Regular expression to match the interface name. Traps on the corresponding access interface(s) are disabled.

Name of the notification.

The rising and falling thresholds.

Disables the access interface notifications.

Command Default

Session monitoring is enabled by default

Command Modes


Command History

Release

Release 5.1

Modification





The regular expression keyword disables notifications of the access-interface.

156


SNMP Server Commands snmp-server mibs subscriber threshold access-if

Task ID

Examples

Task ID

snmp

Operation

read, write


snmp-server mibs subscriber threshold access-if subset 100 regular expression notification rising-falling disable


157

SNMP Server Commands snmp-server notification-log-mib

snmp-server notification-log-mib

To configure the NOTIFICATION-LOG-MIB, use the snmp-server notification-log-mib command in global configuration mode. To remove the specified configuration, use the no form of this command.

snmp-server notification-log-mib {globalAgeOut time| globalSize size| default| disable| size size}

no snmp-server notification-log-mib {globalAgeOut| globalSize| default| disable| size}


globalAgeOut time

globalSize size

default disable

size size

Specifies how much time, in minutes, a notification remains in the log.

Values for the time argument can range from 0 to 4294967295; the default is 15.

Specifies the maximum number of notifications that can be logged in all logs. The default is 500.

Specifies to create a default log.

Specifies to disable logging to the default log.

Specifies the maximum number of notifications that the default log can hold.

The default is 500.

Command Default

NOTIFICATION-LOG-MIB notifications are not logged.

Command Modes


Command History

Release

Release 3.7.2

Modification





Logging of NOTIFICATION-LOG-MIB notifications begins when the default log is created. Named logs are not supported, therefore only the default log can be created.

158


SNMP Server Commands snmp-server notification-log-mib

Task ID

Task ID

snmp

Operations

read, write

Examples

The following example creates a default log for notifications:


snmp-server notification-log-mib default

This example removes the default log:


no snmp-server notification-log-mib default

This example configures the size of all logs to be 1500:


snmp-server notification-log-mib globalSize 1500


Command


Description



159

SNMP Server Commands snmp-server packetsize

snmp-server packetsize

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

snmp-server packetsize size

no snmp-server packetsize


size

Packet size, in bytes. Range is from 484 to 65500. The default is 1500.

Command Default

size: 1500

Command Modes


Command History

Release

Release 3.7.2




Use the snmp-server packetsize command to establish control over the largest SNMP packet size permitted when the SNMP server is receiving a request or generating a reply.

Task ID

Task ID

snmp

Operations

read, write

Examples

Modification


This example shows how to set the maximum size of SNMP packets to 1024 bytes:


snmp-server packetsize 1024

160


SNMP Server Commands snmp-server queue-length

snmp-server queue-length

To establish the message queue length for each trap host for Simple Network Management Protocol (SNMP), use the snmp-server queue-length command in global configuration mode. To restore the default value, use the no form of this command.

snmp-server queue-length length

no snmp-server queue-length


length Integer that specifies the number of trap events that can be held before the queue must be emptied. Range is from 1 to 5000.

Command Default

length : 100

Command Modes


Command History

Release

Release 3.7.2




Use the snmp-server queue-length command to define the length of the message queue for each trap host.

After a trap message is successfully sent, Cisco IOS XR software continues to empty the queue at a throttled rate to prevent trap flooding.

Task ID

Task ID

snmp

Operations

read, write

Examples

Modification


This example shows how to set the SNMP notification queue to 20 events:


snmp-server queue-length 20


161

SNMP Server Commands snmp-server target list

snmp-server target list

To create a Simple Network Management Protocol (SNMP) target list, use the snmp-server target list command in global configuration mode. To remove an SNMP target list, use the no form of this command.

snmp-server target list target-list {vrf vrf-name| host hostname}

no snmp-server target list target-list


target-list

vrf vrf-name

host hostname

Name of the target list.

Specifies the name of the VRF hosts included in the target list.

Assigns a hostname to the target list. The hostname variable is a name or IP address.

Command Default

None

Command Modes


Command History

Release

Release 3.7.2

Release 4.2.0

Modification






Use this command to create an SNMP target list and assign hosts to the list. When a target list is mapped to a community name using the snmp-server community-map command, SNMP access is restricted to the hosts in the target list (for that community name).

The host IP address can be in either IPv4 or IPv6 format.

Task ID

Task ID

snmp

Operations

read, write

162


SNMP Server Commands snmp-server target list

Examples

In this example, a new target list “sample3” is created and assigned to the vrf server “server2:”


snmp-server target list sample3 vrf server2


Command


Description



163

SNMP Server Commands snmp-server throttle-time

snmp-server throttle-time

To specify the throttle time for handling incoming Simple Network Management Protocol (SNMP) messages, use the snmp-server throttle-time command in global configuration mode. To restore the throttle time to its default value, use the no form of this command.

snmp-server throttle-time time

no snmp-server throttle-time


time

Throttle time for the incoming queue, in milliseconds. Values can be from 50 to

1000.

Command Default

time : 0

Command Modes


Command History

Release

Release 3.7.2




Task ID

Task ID

snmp

Operations

read, write

Examples

Modification


In the following example, the throttle time is set to 500 milliseconds:


snmp-server throttle-time 500

164


SNMP Server Commands snmp-server throttle-time


Command


Description



165

SNMP Server Commands snmp-server timeouts subagent

snmp-server timeouts subagent

To change the timeout used by the SNMP agent while it waits for a response from a subagent, use the

snmp-server timeouts subagent command in global configuration mode. SNMP subagents are feature-specific entities that register with the SNMP agent and implement sets of

MIB objects.

snmp-server timeouts subagent timeout

no snmp-server timeouts subagent timeout


timeout

The timeout used by the SNMP agent when waiting for a response from a MIB module, in seconds. The default is 10.

Command Default

timeout : 10

Command Modes


Command History

Release

Release 3.8.0




Task ID

Task ID

snmp

Operations

read, write

Examples

Modification


In the following example, the timeout is set to 8 seconds:


snmp-server timeouts subagent 8

166


SNMP Server Commands snmp-server timeouts duplicate

snmp-server timeouts duplicate

To set the timeout value for the snmp-sever duplicate request feature, use the snmp-server timeouts duplicate command in the appropriate mode. To delete the set value, use the no form of the command.

snmp-server timeouts duplicate timeout-value

no snmp-server timeouts duplicate timeout-value


timeout-value

Timeout value in seconds. Range is 0 to 20 seconds.

• 0- To Remove this feature support. i.e SNMP will process all the packets irrespective of duplicate (retry) Packets.

• 1- This is the default value, i.e if no configuration is present , then, the timeout value is set to 1. If any packet takes more than 1 second for getting processed, then the

Duplicate drop feature is enabled.

• 2 to 20 - if the packet processing is done between 2 and 20 seconds, then the Duplicate drop feature is enabled.

Command Default

1 second

Command Modes


Command History

Release

Release 5.1.1




Task ID

Task ID

snmp

Operation

read, write

Examples

Modification

This feature was introduced.

This example shows how to use the snmp-server timeouts duplicate command:


snmp-server timeouts duplicate 10


167

SNMP Server Commands snmp-server trap authentication vrf disable

snmp-server trap authentication vrf disable

To disable authentication traps on VPNs, use the snmp-server trap authentication vrf disable command in global configuration mode.




Command Default

Authentication traps are enabled on VPNs by default.

Command Modes


Command History

Release

Release 3.7.2

Modification





Task ID

Task ID

snmp

Operation

read, write

Examples

This example illustrates how to disable authentication traps on VPNs:




Command

snmp-server vrf

Description

Configures the VPN routing and forwarding (VRF) properties of

SNMP.

168


SNMP Server Commands snmp-server trap link ietf

snmp-server trap link ietf

To enable the varbind used for linkUp and linkDown SNMP traps to utilize the RFC 2863 standard varbind, use the snmp-server trap link ietf command in global configuration mode. To restore the default value, use the no form of this command..

snmp-server trap link ietf nosnmp-server trap link ietf



Command Default

The default varbind used is cisco.

Command Modes


Command History

Release

Release 3.7.2

Modification





For more information about linkUP and linkDown notifications, see RFC 2863, The Interface Group MIB, and RFC 3418, Management Information Base (MIB) for the Simple Network Management Protocol (SNMP).

Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to enable the RFC 2863 standard varbind:


snmp-server trap link ietf


Command


Description



169

SNMP Server Commands snmp-server trap link ietf

Command

snmp-server host



snmp-server traps syslog

Description





Enables SNMP notifications of Cisco-syslog-MIB error messages.

170


SNMP Server Commands snmp-server trap throttle-time

snmp-server trap throttle-time

To specify the throttle time for handling more Simple Network Management Protocol (SNMP) traps, use the

snmp-server trap throttle-time command in global configuration mode. To restore the throttle time to its default value, use the no form of this command.

snmp-server trap throttle-time time

no snmp-server trap throttle-time


time

Throttle time in milliseconds. Values can be from 10 to 500.

Command Default

250

Command Modes


Command History

Release

Release 3.7.2

Modification





Task ID

Task ID

snmp

Operations

read, write

Examples

In the following example, the trap throttle time is set to 500 milliseconds:


snmp-server trap throttle-time 500


Command

snmp-server throttle-time

Description

Specifies the throttle time for handling incoming SNMP messages.


171

SNMP Server Commands snmp-server traps


To enable Simple Network Management Protocol (SNMP) trap notifications, use the snmp-server traps command in global configuration mode. To disable SNMP notifications, use the no form of this command.

snmp-server traps notification-type

no snmp-server traps [ notification-type ]

172




notification-type



173



(Optional) Type of notification (trap) to enable or disable. If no type is specified, all notifications available on the device are enabled or disabled.

The notification type can be one or more of the following keywords:

bfd

Enables Bidirectional Forwarding Detection (BFD) traps.

bgp

Enables BGP4-MIB and CISCO-BGP4-MIB traps.

bridgemib

Enables SNMP traps for the Bridge MIB.

config

Controls configuration notifications, as defined in the CISCO-CONFIG-MAN-MIB

(enterprise 1.3.6.1.4.1.9.9.43.2). The notification type is: (1) ciscoConfigManEvent.

copy-complete

Enables CISCO-CONFIG-COPY-MIB ccCopyCompletion traps.

ds1

Enables SNMP Cisco DS1 traps.

ds2

Enables SNMP Cisco DS2 traps.

entity

Controls Entity MIB modification notifications. This notification type is defined in the ENTITY-MIB (enterprise 1.3.6.1.2.1.47.2) as: (1) entConfigChange.

ethernet

Enables Ethernet link OAM and 802.1ag connectivity fault management traps.

flash insertion

Enables ciscoFlashDeviceInsertedNotif.

flash removal

Enables ciscoFlashDeviceRemovedNotif.

fru-ctrl

Enables SNMP entity field-replaceable unit (FRU) control traps.

hsrp

Enables SNMP HSRP traps.

174


SNMP Server Commands snmp-server traps ipsec tunnel start

Enables SNMP IPsec tunnel start traps.

ipsec tunnel stop

Enables SNMP IPsec tunnel stop traps.

isakmp

Enables ISAKMP traps.

l2vpn all

Enables all Layer 2 VPN traps.

l2vpn vc-down

Enables Layer 2 VPN VC down traps.

l2vpn vc-up

Enables Layer 2 VPN VC up traps.

mpls frr all

Enables all MPLS fast reroute MIB traps.

mpls frr protected

Enables MPLS fast reroute tunnel protected traps.

mpls ldp

Enables SNMP Multiprotocol Label Switching (MPLS) Label Distribution Protocol

(LDP) traps.

mpls traffic-eng

Enables SNMP MPLS traffic engineering traps.

msdp peer-state-change

Enables SNMP MSDP Peer state change traps.

ntp

Enables SNMP Cisco NTP traps.

otn

Enables SNMP Cisco optical transport network (OTN) traps.

pim

Enables SNMP PIM traps.

rf


175


Enables RF-MIB traps.

sensor

Enables SNMP entity sensor traps.

snmp

Enables SNMP traps.

sonet

Enables SONET traps.

syslog

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

system

Enables SNMP SYSTEMMIB-MIB traps.

vpls

Enables virtual private LAN service (VPLS) traps.

vrrp events

Enables Virtual Router Redundancy Protocol (VRRP) traps.

Note

To display the trap notifications supported on a platform, use the online help ( ? ) function.

Command Default

SNMP notifications are disabled by default.

Command Modes


Command History

Release

Release 3.7.2

Release 3.9.0

Modification


The bridgemib , ds1 , ds3 , otn , , system , and vrrp events keywords were introduced.




176



Task ID snmp-server traps

Use the snmp-server traps command to enable trap requests for the specified notification types. To configure the router to send SNMP notifications, specify at least one snmp-server traps command. When the command is entered with no keyword, all notification types are enabled. When a notification type keyword is specified, only the notification type related to that keyword is enabled. To enable multiple types of notifications, issue a separate snmp-server traps command for each notification type.

More information about individual MIBs can be found in the SNMP Object Navigator, available through cisco.com at http://tools.cisco.com/Support/SNMP/do/BrowseMIB.do?local=en&step=2 .

The snmp-server traps command is used with the snmp-server host command. Use the snmp-server host command to specify which host or hosts receive SNMP notifications.

Task ID

snmp

Operations

read, write

Some SNMP trap notifications require additional Task IDs as indicated in the following table:

Notification Type

bfd

Task ID

bgp

Operations

read, write ospf isis read, write read, write bgp copy-complete ipsec isakmp l2vpn mpls frr mpls-te snmp bgp config-services crypto crypto l2vpn read, write read, write read, write read, write read, write read, write read, write mpls l3vpn mpls-ldp mpls-te ipv4 mpls-ldp mpls-te read, write read, write read, write read, write read, write


177


Notification Type

mpls ldp mpls traffic-eng ospf syslog vpls

Task ID

mpls-ldp mpls-te mpls-ldp mpls-te ospf sysmgr l2vpn

Operations

read, write read, write read, write read, write read, write read, write read, write

Examples

This example shows how to enable the router to send all traps to the host specified by the name myhost.cisco.com, using the community string defined as public:




snmp-server host myhost.cisco.com public


Command

snmp-server host




Description






178


SNMP Server Commands snmp-server traps bgp


To enable Border Gateway Protocol (BGP) state-change Simple Network Management Protocol (SNMP) notifications, use the snmp-server traps bgp command in global configuration mode. To disable BGP state-change SNMP notifications, use the no form of this command.

snmp-server traps bgp no snmp-server traps bgp



Command Default


Command Modes


Command History

Release

Release 3.7.2

Modification





SNMP notifications can be sent as traps.

Use the snmp-server traps bgp command to enable or disable BGP server state-change notifications, as defined in the BGP4-MIB (enterprise 1.3.6.1.2.1.15.7). The notifications types are:

• bgpEstablished

• bgpBackwardTransition

The BGP notifications are defined in the BGP-4 MIB as follows: bgpTraps OBJECT IDENTIFIER ::= { bgp 7 } bgpEstablished NOTIFICATION-TYPE

OBJECTS { bgpPeerLastError, bgpPeerState }

STATUS current

DESCRIPTION

"The BGP Established event is generated when the BGP FSM enters the ESTABLISHED state."

::= { bgpTraps 1 } bgpBackwardTransition NOTIFICATION-TYPE

OBJECTS { bgpPeerLastError, bgpPeerState

STATUS current

}


179

SNMP Server Commands snmp-server traps bgp

Task ID

DESCRIPTION

"The BGPBackwardTransition Event is generated when the BGP FSM moves from a higher numbered state to a lower numbered state."

::= {bgpTraps 2}

For a complete description of these notifications and additional MIB functions, see the BGP4-MIB in the

SNMP Object Navigator, available through cisco.com at http://tools.cisco.com/Support/SNMP/do/

BrowseMIB.do?local=en&step=2 .

The snmp-server traps bgp command is used with the snmp-server host command. Use the snmp-server

host command to specify which host or hosts receive SNMP notifications.

Task ID

snmp bgp

Operations

read, write read, write

Examples

The following example shows how to enable the router to send BGP state-change notifications to the host at the address myhost.cisco.com using the community string defined as public:




snmp-server host myhost.cisco.com version 2c public


Command


snmp-server host



Description






180


SNMP Server Commands snmp-server traps frequency synchronization

snmp-server traps frequency synchronization

To enable frequency synchronization MIB traps, use the snmp-server traps frequency synchronization command in global configuration mode. To disable frequency synchronization MIB traps, use the no form of this command.

snmp-server traps frequency synchronization no snmp-server traps frequency synchronization



Command Default

Frequency synchronization MIB traps are disabled.

Command Modes


Command History

Release

Release 4.3.1

Modification





Task ID

Task ID

snmp

Operation

read, write

Examples

This example shows how to enable frequency synchronization MIB traps:


snmp-server traps frequency synchronization


181

SNMP Server Commands snmp-server traps mpls l3vpn

snmp-server traps mpls l3vpn

To enable the sending of MPLS Layer 3 VPN Simple Network Management Protocol (SNMP) notifications, use the snmp-server traps mpls l3vpn command in global configuration mode. To disable MPLS Layer 3

VPN SNMP notifications, use the no form of this command.

snmp-server traps mpls l3vpn {all| max-threshold-cleared| max-threshold-exceeded|

max-threshold-reissue-notif-time seconds| mid-threshold-exceeded| vrf-down| vrf-up}

no snmp-server traps mpls l3vpn

Syntax Description all max-threshold-cleared

Enables all MPLS Layer 3 VPN traps.

Enables maximum threshold cleared traps.

max-threshold-exceeded

Enables maximum threshold exceeded traps.

max-threshold-reissue-notif-time seconds Specifies the time interval for reissuing a maximum threshold notification, in seconds.

mid-threshold-exceeded vrf-down

Enables mid-threshold exceeded traps.

Enables VRF down traps.

vrf-up

Enables VRF up traps.

Command Default


Command Modes


Command History

Release

Release 3.7.2

Modification





Task ID

Task ID

snmp

Operations

read, write

182


SNMP Server Commands snmp-server traps mpls l3vpn

Examples

The following example shows how to enable the device to send MPLS Layer 3 VPN traps:


snmp-server traps mpls l3vpn all


Command

snmp-server traps

Description

Enables SNMP trap notifications.


183

SNMP Server Commands snmp-server traps ospf errors

snmp-server traps ospf errors

To enable Open Shortest Path First (OSPF) error Simple Network Management Protocol (SNMP) notifications, use the snmp-server traps ospf errors command in global configuration mode. To disable OSPF error SNMP notifications, use the no form of this command.

snmp-server traps ospf errors {authentication-failure| bad-packet| config-error|

virt-authentication-failure| virt-bad-packet| virt-config-error}

no snmp-server traps ospf errors {authentication-failure| bad-packet| config-error|

virt-authentication-failure| virt-bad-packet| virt-config-error}

Syntax Description authentication-failure bad-packet config-error virt-authentication-failure virt-bad-packet virt-config-error

Enables SNMP traps for authentication failure errors on physical interfaces.

Enables SNMP traps for bad packet errors on physical interfaces.

Enables SNMP traps for configuration errors on physical interfaces.

Enables SNMP traps for authentication failure errors on virtual interfaces.

Enables SNMP traps for bad packet errors on virtual interfaces.

Enables SNMP traps for configuration errors on virtual interfaces.

Command Default


Command Modes


Command History

Release

Release 3.7.2

Modification






For a complete description of OSPF error notifications and additional MIB functions, see the OSPF-TRAP-MIB in the SNMP Object Navigator, available through cisco.com at http://tools.cisco.com/Support/SNMP/do/


184


SNMP Server Commands snmp-server traps ospf errors

Task ID

The snmp-server traps ospf errors command is used with the snmp-server host command. Use the

snmp-server host command to specify which host or hosts receive SNMP notifications.

Task ID

snmp

Operations

read, write

Examples

This example shows how to enable the router to send OSPF error notifications to the host at the address myhost.cisco.com using the community string defined as public:


snmp-server traps ospf errors




Command


snmp-server host



Description







185

SNMP Server Commands snmp-server traps ospf lsa

snmp-server traps ospf lsa

To enable Open Shortest Path First (OSPF) link-state advertisement Simple Network Management Protocol

(SNMP) notifications, use the snmp-server traps ospf lsa command in global configuration mode. To disable

OSPF link state SNMP notifications, use the no form of this command.

snmp-server traps ospf lsa {lsa-maxage| lsa-originate}

no snmp-server traps ospf lsa {lsa-maxage| lsa-originate}

Syntax Description lsa-maxage lsa-originate

Enables SNMP traps for link-state advertisement maxage.

Enables SNMP traps for new link-state advertisement origination.

Command Default


Command Modes


Command History

Release

Release 3.7.2

Modification






For a complete description of OSPF link-state advertisement notifications and additional MIB functions, see the OSPF-TRAP-MIB in the SNMP Object Navigator, available through cisco.com at http://tools.cisco.com/

Support/SNMP/do/BrowseMIB.do?local=en&step=2 .

The snmp-server traps ospf lsa command is used with the snmp-server host command. Use the snmp-server


Task ID

Task ID

snmp

Operations

read, write

186


SNMP Server Commands snmp-server traps ospf lsa

Examples

This example shows how to enable the router to send OSPF link-state advertisement notifications to the host at the address myhost.cisco.com using the community string defined as public:


snmp-server traps ospf lsa lsa-maxage




Command


snmp-server host



Description







187

SNMP Server Commands snmp-server traps ospf retransmit

snmp-server traps ospf retransmit

To enable Open Shortest Path First (OSPF) retransmission Simple Network Management Protocol (SNMP) notifications, use the snmp-server traps ospf retransmit command in global configuration mode. To disable

OSPF retransmission SNMP notifications, use the no form of this command.

snmp-server traps ospf retransmit {packets| virt-packets}

no snmp-server traps ospf retransmit {packets| virt-packets}

Syntax Description packets virt-packets

Enables SNMP traps for packet retransmissions on physical interfaces.

Enables SNMP traps for packet retransmissions on virtual interfaces.

Command Default


Command Modes


Command History

Release

Release 3.7.2

Modification






For a complete description of OSPF retransmission notifications and additional MIB functions, see the

OSPF-TRAP-MIB in the SNMP Object Navigator, available through cisco.com at http://tools.cisco.com/

Support/SNMP/do/BrowseMIB.do?local=en&step=2 .

The snmp-server traps ospf retransmit command is used with the snmp-server host command. Use the


Task ID

Task ID

snmp

Operations

read, write

188


SNMP Server Commands snmp-server traps ospf retransmit

Examples

This example shows how to enable the router to send OSPF retransmission notifications to the host at the address myhost.cisco.com using the community string defined as public:


snmp-server traps ospf retransmit packets




Command


snmp-server host



Description







189

SNMP Server Commands snmp-server traps ospf state-change

snmp-server traps ospf state-change

To enable Simple Network Management Protocol (SNMP) notifications for Open Shortest Path First (OSPF) neighbor state change, use the snmp-server traps ospf state-change command in global configuration mode.

To disable OSPF state-change SNMP notifications, use the no form of this command.

snmp-server traps ospf state-change {if-state-change| neighbor-state-change| virtif-state-change|

virtneighbor-state-change}

no snmp-server traps ospf state-change {if-state-change| neighbor-state-change| virtif-state-change|

virtneighbor-state-change}

Syntax Description if-state-change neighbor-state-change virtif-state-change virtneighbor-state-change

Enables SNMP traps for OSPF non-virtual interface state chages.

Enables SNMP traps for OSPF neighbor state changes

Enables SNMP traps for OSPF virtual interface state changes.

Enables SNMP traps for OSPF virtual neighbor state changes.

Command Default


Command Modes


Command History

Release

Release 3.7.2

Modification



!

!

!

!

!




Use the snmp-server traps ospf state-change command to enable or disable OSPF server state-change notifications, as defined in the MIB. One notification type is ospfNbrStateChange.

For example, the OSPF ospfNbrStateChange notification is defined in the OSPF MIB as follows: ospfNbrStateChange NOTIFICATION-TYPE

OBJECTS { ospfRouterId, -- The originator of the trap ospfNbrIpAddr, ospfNbrAddressLessIndex,

190


SNMP Server Commands snmp-server traps ospf state-change

Task ID

!

!

!

!

STATUS

} ospfNbrRtrId, ospfNbrState -- The new state current

For a complete description of these notifications and additional MIB functions, see the OSPF-TRAP-MIB in the SNMP Object Navigator, available through cisco.com at http://tools.cisco.com/Support/SNMP/do/


The snmp-server traps ospf state-change command is used with the snmp-server host command. Use the


Task ID

snmp

Operations

read, write

Examples

The following example shows how to enable the router to send OSPF state-change notifications to the host at the address myhost.cisco.com using the community string defined as public:


snmp-server traps ospf state-change neighbor-state-change




Command


snmp-server host



Description







191

SNMP Server Commands snmp-server traps pim interface-state-change

snmp-server traps pim interface-state-change

To enable Protocol Independent Multicast (PIM) interface status notification, use the snmp-server traps pim

interface-state-change command in global configuration mode. To disable this command so no notification is sent, use the no form of this command.

snmp-server traps pim interface-state-change no snmp-server traps pim interface-state-change



Command Default

Simple Network Management Protocol (SNMP) notifications are disabled by default.

Command Modes


Command History

Release

Release 3.7.2

Modification





Use the snmp-server host command to specify which host or hosts receive SNMP notifications.

Use the snmp-server traps pim interface-state-change command to send notifications when a PIM interface changes status from up to down. When the status is up, the notification signifies the restoration of a PIM interface. When the status is down, the notification signifies the loss of a PIM interface.

PIM notifications are defined in the CISCO-PIM-MIB.my and PIM-MIB.my files that can be accessed from the SNMP Object Navigator, available through cisco.com at http://tools.cisco.com/Support/SNMP/do/


Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to use the snmp-server traps pim interface-state-change command:


snmp-server traps pim interface-state-change



192


SNMP Server Commands snmp-server traps pim interface-state-change


Command


Description


snmp-server host

snmp-server traps pim invalid-message-received



Enables notifications for monitoring invalid PIM protocol operations.

snmp-server traps pim neighbor-change

Enables Protocol Independent Multicast (PIM) neighbor status down notifications.

snmp-server traps pim rp-mapping-change


Enables notifications indicating a change in the rendezvous point

(RP) mapping information due to either Auto-RP or bootstrap router

(BSR) messages.





193

SNMP Server Commands snmp-server traps pim invalid-message-received

snmp-server traps pim invalid-message-received

To enable notifications for monitoring invalid Protocol Independent Multicast (PIM) protocol operations, such as invalid register received and invalid join or prune received, use the snmp-server traps pim

invalid-message-received command in global configuration mode. To disable this command so that no notification is sent, use the no form of this command.

snmp-server traps pim invalid-message-received no snmp-server traps pim invalid-message-received



Command Default

Simple Network Management Protocol (SNMP) notifications are disabled by default.

Command Modes


Command History

Release

Release 3.7.2

Modification






A router can receive a join or prune message in which the RP specified in the packet is not the RP for the multicast group. Or a router can receive a register message from a multicast group in which it is not the RP.



Task ID

Task ID

snmp

Operations

read, write

194


SNMP Server Commands snmp-server traps pim invalid-message-received

Examples

The following example shows how to use the snmp-server traps pim invalid-message-received command:


snmp-server traps pim invalid-message-received




Command


Description


snmp-server host



Enables PIM interface status notification.

snmp-server traps pim interface-state-change






(RP) mapping information due to either Auto-RP or bootstrap router

(BSR) messages.





195

SNMP Server Commands snmp-server traps pim neighbor-change

snmp-server traps pim neighbor-change

To enable Protocol Independent Multicast (PIM) neighbor status down notifications, use the snmp-server

traps pim neighbor-change command in global configuration mode. To disable PIM neighbor down notifications, use the no form of this command.

snmp-server traps pim neighbor-change no snmp-server traps pim neighbor-change



Command Default

PIM Simple Network Management Protocol (SNMP) notifications are disabled by default.

Command Modes


Command History

Release

Release 3.7.2

Modification





Use the snmp-server traps pim neighbor-change command to send notifications when a PIM neighbor changes status from up to down on an interface. Use the snmp-server host command to specify which host or hosts receive SNMP notifications.



Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to enable the router to send PIM neighbor status down notifications to the host at the address myhost.cisco.com using the community string defined as public:


snmp-server traps pim neighbor-change



196


SNMP Server Commands snmp-server traps pim neighbor-change


Command


Description


snmp-server host









(RP) mapping information due to either Auto-RP or bootstrap router (BSR) messages.






197

SNMP Server Commands snmp-server traps pim rp-mapping-change

snmp-server traps pim rp-mapping-change

To enable notifications indicating a change in the rendezvous point (RP) mapping information due to either

Auto-RP or bootstrap router (BSR) messages, use the snmp-server traps pim rp-mapping-change command in global configuration mode. To disable this command so no notification is sent, use the no form of this command.

snmp-server traps pim rp-mapping-change no snmp-server traps pim rp-mapping-change



Command Default

PIM SNMP notifications are disabled by default.

Command Modes


Command History

Release

Release 3.7.2

Modification








Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to use the snmp-server traps pim rp-mapping-change command:


snmp-server traps pim rp-mapping-change



198


SNMP Server Commands snmp-server traps pim rp-mapping-change


Command


Description


snmp-server host

Specifies the recipient of a Simple Network Management

Protocol (SNMP) notification operation.












199

SNMP Server Commands snmp-server traps rsvp

snmp-server traps rsvp

To enable the sending of Resource Reservation Protocol (RSVP) notifications, use the snmp-server traps

rsvp command in global configuration mode. To disable RSVP notifications, use the no form of this command.

snmp-server traps rsvp {all| lost-flow| new-flow}

Syntax Description all lost-flow new-flow

Enables the sending of both new flow lost flow traps.

Enables the sending of traps when a flow is deleted.

Enables the sending of traps when a flow is created.

Command Default

None

Command Modes


Command History

Release

Release 3.9.0




Task ID

Task ID

mpls-te ouni snmp

Operation

read, write read, write read, write

Examples

Modification


This example illustrates how to enable all SNMP RSVP MIB traps.


configure


snmp-server traps rsvp all

200


SNMP Server Commands snmp-server traps selective-vrf-download role-change

snmp-server traps selective-vrf-download role-change

To attempt to download only those prefixes and labels to a physical entity required to forward traffic through the physical entity, use the snmp-server trap selective-vrf-download role-change command in global configuration mode.

snmp-server trap selective-vrf-download role-change


Command Default

Selective VRF downloads are disabled.

Command Modes


Command History

Release

Release 4.2.0

Modification



The selective VRF download feature makes a best effort to download only those prefixes and labels to a physical entity required to forward traffic through the physical entity. This is accomplished by characterizing roles for physical entities based on their configuration.

From a network management point of view the CISCO-SELECTIVE-VRF-DOWNLOAD-MIB:

• Lists the state relating to the selective VRF download feature for each physical entity capable of forwarding packets.

• Lists the role change history per address family (ipv4 and ipv6) for each physical entity capable of forwarding packets.

• Lists the VRF tables selectively downloaded to each physical entity capable of forwarding packets.

Task ID

Task ID

snmp basic-services

Operation

read, write read, write

Examples

This example shows how to enable the selective VRF downloads:

RP/0/RSP0/CPU0:router(config)# snmp-server traps selective-vrf-download role-change


201

SNMP Server Commands snmp-server traps snmp


To enable the sending of RFC 1157 Simple Network Management Protocol (SNMP) notifications, use the

snmp-server traps snmp command in the appropriate configuration mode. To disable RFC 1157 SNMP notifications, use the no form of this command.

snmp-server traps snmp [authentication| coldstart| linkdown| linkup| warmstart]

no snmp-server traps snmp [authentication| coldstart| linkdown| linkup| warmstart]

Syntax Description authentication linkup linkdown coldstart warmstart

(Optional) Controls the sending of SNMP authentication failure notifications.

(Optional) Controls the sending of SNMP linkUp notifications

(Optional) Controls the sending of SNMP linkDown notifications

(Optional) Controls the sending of SNMP coldStart notifications.

(Optional) Controls the sending of SNMP warmStart notifications.

Command Default


Command Modes


Command History

Release

Release 3.7.2

Release 3.9.0

Modification


The authentication, linkup, linkdown, coldstart, and warmstart keywords were added.




The snmp-server traps snmp command is used with the snmp-server host command. Use the snmp-server


202



Task ID

Examples snmp-server traps snmp

The optional authentication keyword controls the sending of SNMP authentication failure notifications. In order to send notifications, you must configure at least one snmp-server host command. An authentication

Failure (4) trap signifies that the sending device is the addressee of a protocol message that is not properly authenticated. The authentication method depends on the version of SNMP being used. For SNMPv1 or

SNMPv2c, authentication failure occurs for packets with an incorrect community string. For SNMPv3, authentication failure occurs for packets with an incorrect Secure Hash Algorithm (SHA) or Message Digest

5 (MD5) authentication key or for a packet that is outside the window of the authoritative SNMP engine.

The optional linkup keyword controls the sending of SNMP linkUp notifications. The linkUp(3) trap signifies that the sending device recognizes one of the communication links represented in the agent's configuration coming up.

The optional linkdown keyword controls the sending of SNMP linkDown notifications. The linkDown(2) trap signifies that the sending device recognizes a failure in one of the communication links represented in the agent's configuration.

The snmp-server traps snmp command with the linkup or linkdown keywords globally enables or disables

SNMP linkUp and linkDown traps. After enabling either of these traps globally, you can enable or disable these traps on specific interfaces using the no notification linkupdown disable command in interface configuration mode. According to RFC 2863, linkUp and linkDown traps are enabled for interfaces that do not operate on top of any other interface (as defined in the ifStackTable), and are disabled otherwise. This means that you do not have to enable linkUp and linkdown notifications on such interfaces. However, linkUp and linkDown notifications will not be sent unless you enable them globally using the snmp-server traps

snmp command.

The optional coldstart keyword controls the sending of SNMP coldStart notifications. The coldStart(0) trap signifies that the sending device is reinitializing itself such that the agent's configuration or the protocol entity implementation may be altered.

The optional warmstart keyword controls the sending of SNMP coldStart notifications. The warmStart(1) trap signifies that the sending device is reinitializing itself such that neither the agent configuration nor the protocol entity implementation is altered.

Task ID

snmp

Operations

read, write

This example shows how to enable the device to send all traps to the host myhost.cisco.com using the community string defined as public:




snmp-server host myhost.cisco.com public snmp

The following example shows how to enable only linkUp and linkDown traps:


snmp-server traps snmp linkup


snmp-server traps snmp linkdown


203

SNMP Server Commands snmp-server traps snmp


Command


snmp-server host



Description






204


SNMP Server Commands snmp-server traps syslog

snmp-server traps syslog

To enable Simple Network Management Protocol (SNMP) notifications of Cisco-syslog-MIB error messages, use the snmp-server traps syslog command in the appropriate configuration mode. To disable these types of notifications, use the no form of this command.

snmp-server traps syslog no snmp-server traps syslog



Command Default


Command Modes


Command History

Release

Release 3.7.2

Modification





The snmp-server traps syslog command is used with the snmp-server host command. Use the snmp-server


Task ID

Task ID

snmp

Operations

read, write

Examples

The following example shows how to enable Cisco-syslog-MIB error message notifications to the host at the address myhost.cisco.com, using the community string defined as public:


snmp-server traps syslog




205

SNMP Server Commands snmp-server traps syslog


Command


snmp-server host



Description






206


SNMP Server Commands snmp-server trap-source

snmp-server trap-source

To specify the interface (and hence the corresponding IP address) from which a Simple Network Management

Protocol (SNMP) trap should originate, use the snmp-server trap-source command in global configuration mode. To remove the source designation, use the no form of this command.

snmp-server trap-source type interface-path-id

no snmp-server trap-source





Note



Command Default

No interface is specified.

Command Modes


Command History

Release

Release 3.7.2

Modification





When an SNMP trap is sent from a Cisco SNMP device, it has a notification address of the interface it happened to exit at that time. Use the snmp-server trap-source command to monitor notifications from a particular interface.

Note

In references to a Management Ethernet interface located on a route switch processor card, the physical slot number is numeric (0 through n-1 where n is the number of line card slots in the chassis) and the module is CPU0. Example: interface MgmtEth0/1/CPU0/0.


207

SNMP Server Commands snmp-server trap-source

Task ID

Task ID

snmp

Operations

read, write

Examples

The following example shows how to specify that the IP address for interface 0/0/1/0 is the source for all

SNMP notifications:


snmp-server trap-source tengige 0/0/1/0


Command


snmp-server host




Description







208


SNMP Server Commands snmp-server traps subscriber session-aggregation

snmp-server traps subscriber session-aggregation

To set the session aggregation parameters, use the snmp-server traps subscriber session command in global configuration mode. To delete the set parameters, use the no form of the command.

snmp-server traps subscriber session-agregation [ access-interface | node ]

no snmp-server traps subscriber session-agregation [ access-interface | node ]

Syntax Description access-interface node

Subscriber notification at access interface level.

Subscriber notification at node level.

Command Default

None

Command Modes


Command History

Release

Release 5.1

Modification





Use the snmp-server traps subscriber session-agregation command to enable

CISCO-SUBSCRIBER-SESSION-MIB notifications (traps). Notifications will include MIB's asynchronous events.

Task ID

Task ID

snmp

Operation

read, write

Examples

RP/0/RSP0/CPU0:router (config)#

snmp-server traps subscriber session-aggregation node


209

SNMP Server Commands snmp-server trap-timeout

snmp-server trap-timeout

To define how often to try resending trap messages on the retransmission queue, use the snmp-server

trap-timeout command in global configuration mode. To restore the default value, use the no form of this command.

snmp-server trap-timeout seconds

no snmp-server trap-timeout seconds


seconds

Integer that sets the interval for resending the messages, in seconds). Value can be from 1 to 1000.

Command Default

seconds : 30

Command Modes


Command History

Release

Release 3.7.2




Before Cisco IOS XR software tries to send a trap, it looks for a route to the destination address. If there is no known route, the trap is saved in a retransmission queue. Use the snmp-server trap-timeout command to determine the number of seconds between retransmission attempts.

Task ID

Task ID

snmp

Operations

read, write

Examples

Modification


The following example shows how to set an interval of 20 seconds to try resending trap messages on the retransmission queue:


snmp-server trap-timeout 20

210


SNMP Server Commands snmp-server trap-timeout


Command


snmp-server host




Description








211

SNMP Server Commands snmp-server user

snmp-server user

To configure a new user to a Simple Network Management Protocol (SNMP) group, use the snmp-server

user command in global configuration mode. To remove a user from an SNMP group, use the no form of this command.

snmp-server user username groupname {v1| v2c| v3 [auth {md5| sha} {clear| encrypted} auth-password

[priv {3des| aes aes-bit-encryption| des56} {clear| encrypted} priv-password]]} [SDROwner| SystemOwner]

[ access-list-name ]

no snmp-server user username groupname


username groupname

v1 v2c v3 auth md5 sha clear encrypted

auth-password

priv

3des

aes aes-bit-encryption

des56

Name of the user on the host that connects to the agent.

Name of the group to which the user belongs.

Specifies that the SNMPv1 security model should be used.

Specifies that the SNMPv2c security model should be used.

Specifies that the SNMPv3 security model should be used.

(Optional) Specifies which authentication level should be used. If this keyword is used, you must specify an authentication level and an authorization password.

Specifies the HMAC-MD5-96 authentication level.

Specifies the HMAC-SHA-96 authentication level.

Specifies that an unencrypted password follows.

Specifies that an encrypted password follows.

Authentication password, which is a string (not to exceed 64 characters) that enables the agent to receive packets from the host.

(Optional) Specifies that encryption parameters follow.

Specifies the 168-bit Triple Data Encryption Standard (3DES) level of encryption for the user.

Specifies the Advanced Encryption Standard (AES) level of encryption for the user. Supported options are 128, 192 and 256 bit encryption.

Specifies the 56-bit Data Encryption Standard (DES) level of encryption for the user.

212



priv-password

SDROwner

SystemOwner

access-list-name

Privacy password, which can be clear or encrypted text, according to what is specified.

(Optional) Limits access to the agents for the owner secure domain router (SDR) only.

(Optional) Provides system-wide access to the agents for all SDRs.

(Optional) Access list to be associated with this SNMP user. The

access-list-name argument represents a value from 1 to 99, that is, the identifier of the standard IP access list.

Command Default

By default, access is limited to agents on the owner SDR only.

See also

Table 8: snmp-server user Default Descriptions, on page 213

.

Command Modes


Command History

Release

Release 3.7.2

Release 3.9.0

Modification


AES and 3DES encryption formats were supported.




To use 3DES and AES encryption standards, you must have installed the security package (k9sec). For information on installing software packages, see Upgrading and Managing Cisco IOS XR Software in

Cisco ASR 9000 Series Aggregation Services Router System Management Configuration Guide.

Table 8: snmp-server user Default Descriptions

Characteristic

passwords access lists

Default

Text strings are assumed.

Access from all IP access lists is permitted.

SDR and System-wide Access

When the snmp-server user command is entered with the SDROwner keyword, SNMP access is granted only to the MIB object instances in the owner SDR.


213


Task ID

When the snmp-server user command is entered with the SystemOwner keyword, SNMP access is granted to the entire system.

Task ID

snmp

Operations

read, write

Examples

The following example shows how to enter a plain-text password for the string abcd for user2 in group2:


snmp-server user user2 group2 v3 auth md5 clear abcd

To learn if this user has been added to the configuration, use the show snmp user command.

If the localized Message Digest 5 (MD5) or Secure Hash Algorithm (SHA) digest is known, specify that string instead of the plain-text password. The digest should be formatted as AA:BB:CC:DD where AA, BB, CC, and DD are hexadecimal values. The digest should also be exactly 16 octets long.

This example shows how to specify the command with a digest name of

00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:


snmp-server user user2 group2 v3 auth md5 encrypted

00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF


Command

snmp-server group

Description


SNMP views.

214


SNMP Server Commands snmp-server view

snmp-server view

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

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

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


view-name oid-tree

excluded included

Label for the view record being updated or created. The name is used to reference the record.

Object identifier (OID) 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.

Excludes the MIB family from the view.

Includes the MIB family in the view.

Command Default

No view entry exists.

Command Modes


Command History

Release

Release 3.7.2

Modification





Other SNMP commands require a view as a keyword. Use the snmp-server view command to create a view to be used as keywords for other commands that create records including a view.

Instead of defining a view explicitly, you can rely on the following predefined views, which are supported by the SNMP agent:


215

SNMP Server Commands snmp-server view

Task ID all

Predefined view indicating that a user can see all objects.

CfgProt

Predefined view indicating that a user can see all objects except the SNMPv3 configuration tables.

vacmViewTreeFamilyEntry

Predefined view indicating that a user can see the default configuration of vacmViewTreeFamilyEntry.

The predefined views supported on Cisco IOS XR software, however, do not match the predefined views specified in RFC 3415.

Task ID

snmp

Operations

read, write

Examples

This example creates a view that includes all objects in the MIB-II subtree:


snmp-server view mib2 1.3.6.1.2.1 included

This example shows how to create a view that includes all objects in the MIB-II system group and all objects in the Cisco enterprise MIB:


snmp-server view view1 1.3.6.1.2.1.1 included



This example shows how to create a view that includes all objects in the MIB-II system group except for sysServices (System 7) and all objects for interface 1 in the MIB-II interfaces group:




snmp-server view view1 1.3.6.1.2.1.1.7 excluded


snmp-server view view1 1.3.6.1.2.1.2.2.1.*.1 included


Command

show snmp view

snmp-server group

Description

Displays the configured views and the associated MIB view family name, storage type, and status.

Configures a new SNMP group, or a table that maps SNMP users to SNMP views.

216


SNMP Server Commands snmp-server vrf

snmp-server vrf

To configure the VPN routing and forwarding (VRF) properties of Simple Network Management Protocol

(SNMP), use the snmp-server vrf command in global configuration mode. To remove the configuration, use the no form of this command.

snmp-server vrf vrf-name[host address [clear| encrypted][traps][version {1| 2c| 3 security-level}]

community-string[udp-port port]][context context-name]

no snmp-server vrf vrf-name


vrf-name

host address

clear encrypted traps

version {1 | 2c | 3}

security-level community-string

udp-port port


Name of the VRF.

(Optional) Specifies the name or IP address of the host (the targeted recipient).


(Optional) Specifies that the community-string argument is encrypted text.

(Optional) Specifies that notifications should be sent as traps. This is the default.

(Optional) Specifies the version of the SNMP used to send the traps. The default is SNMPv1. When the version keyword is used, one of these keywords must be specified:

• 1—SNMPv1

• 2c—SNMPv2C

• 3—SNMPv3

(Optional) Security level for SNMPv3. Options are:

• auth—authNoPriv

• noauth—noAuthNoPriv

• priv—authPriv

Specifies the community string for SNMPv1 and SNMPv2, or the SNMPv3 user.

(Optional) Specifies the UDP port to which notifications should be sent.

(Optional) Name of the context that must be mapped to VRF identified by value of the vrf-name argument.


217

SNMP Server Commands snmp-server vrf

Command Default

None

Command Modes


Command History

Release

Release 3.7.2

Release 4.2.0

Modification






Use this command to enter SNMP VRF configuration mode and configure an SNMP notification recipient on a VRF. You can also map a VRF to an SNMP context.

SNMP notification recipient that is reachable by way of a VRF can be configured. Notification is forwarded to the recipient represented by its address using the routing table instance identified by the VRF name.

The address argument can be either a host name or an IP address. Both IPv4 and IPv6 formats are supported.



An SNMP context identified by the value of the context-name argument can be mapped to a VRF in this mode.

This context must be created using snmp-server context command.

Task ID

Task ID

snmp

Operations

read, write

Examples

This example shows how to configure a host IP address for a VRF name:


snmp-server vrf vrfa

RP/0/RSP0/CPU0:router(config-snmp-vrf)#

host 12.21.0.1 traps version

2c public udp-port 2525


Command

snmp-server context

Description

Creates a Simple Network Management Protocol (SNMP) context.

218



Command

snmp-server host

snmp-server vrf

Description




219

SNMP Server Commands snmp test trap all

snmp test trap all

To send a Simple Network Management Protocol (SNMP) trap message to the trap receivers for all supported traps, use the snmp test trap all command in

EXEC mode.




Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.9.1

Modification





To use the snmp test trap command, SNMP must be configured on the router. This command is not intended for testing scalability, performance, or high availability scenarios.

Use the snmp test trap all command to generate test traps for all supported traps. The following traps are supported:

• coldStart—SNMP agent Initializing and its configuration may have changed.

• warmStart—SNMP agent Initializing and its configuration is unaltered.

• linkUp—Interface ifOperStatus is Up.

• linkDown—Interface ifOperStatus is Down.

• clogMessage Generated—Syslog message generated.

• ciscoFlashDeviceInsertedNotif—Flash device inserted.

• ciscoFlashDeviceRemovedNotif—Flash device removed.

• ciscoRFProgressionNotif—RF state change.

• ciscoRFSwactNotif—Switchover.

• ciscoConfigManEvent—Command-line interface (CLI) configuration management event.

220


SNMP Server Commands snmp test trap all

Task ID

• newRoot—SNMP agent is a new root of the spanning tree.

• topologyChange—Bridge port has transitioned to the Forwarding state.

• cefcFanTrayOperStatus—Fan tray cefcFanTrayOperStatus is Up.

• cefcModuleStatusChange—Module cefcModuleOperStatus is OK (module up) or module cefcModuleOperStatus is Failed (module down).

• entSensorThresholdNotification—entSensorValue crossed the entSensorthresholdValue.

• cefcPowerStatusChange—Redundant PowerSupply fails.

Task ID

snmp

Operation

read

Examples

This example illustrates how to use the snmp test trap all command:




Command

show snmp entity

Description

Displays the entPhysicalName and entPhysicalIndex mappings.


221

SNMP Server Commands snmp test trap entity

snmp test trap entity

To send a test SNMP Entity trap message to the trap receivers, use the snmp test trap entity command in

EXEC mode.

snmp test trap entity {fru {power status-change failed| module status-change {up| down}| fan-tray

oper-status up}| sensor threshold-notification}[entity-index index]

Syntax Description fru power status-change failed

module status-change{up | down}

fan-tray oper-status up sensor threshold-notification

entity-index index

Sends a field replacement unit trap.

Sends a cefcPowerStatusChange trap for the

CISCO-ENTITY-FRU-CONTROL-MIB.

Sends a cefcModuleStatusChange trap for the


Sends a cefcFanTrayOperStatus trap for the


Sends a sensor trap.

Sends a entSensorThresholdNotification trap for the CISCO-ENTITY-SENSOR-MIB.

Specifies the physical index for which to generate the trap.

Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.9.1

Modification





222


SNMP Server Commands snmp test trap entity

Task ID

The snmp test trap entity command tests the sending of Entity MIB traps. It is not intended for testing scalability, performance, or high availability scenarios. To use the snmp test trap command, SNMP must be configured on the router.

Task ID

snmp

Operation

read

Examples

This example illustrates how to use the snmp test trap entity command:


snmp test trap entity sensor threshold index


Command

show snmp entity

Description

Displays the entPhysicalName and entPhysicalIndex mappings.


223

SNMP Server Commands snmp test trap infra

snmp test trap infra

To send a test Simple Network Management Protocol (SNMP) Infra trap message to the trap receivers, use the snmp test trap infra command in

EXEC mode.

snmp test trap infra {bridge {new-root| topology-change}| config event| flash {device-inserted|

device-removed}| redundancy {progression| switch}| syslog message-generated}

Syntax Description bridge new-root topology-change config event flash device-inserted device-removed redundancy progression switch syslog message-generated

Sends a bridge trap.

Sends a newRoot trap for the BRIDGE-MIB.

Sends a topologyChange trap for the

BRIDGE-PORT.

Sends a ciscoConfigManEvent trap for the

CISCO-CONFIG-MAN-MIB.

Sends a flash trap.

Sends a ciscoFlashDeviceInsertedNotif trap for the CISCO-FLASH-MIB.

Sends a ciscoFlashDeviceRemovedNotif trap for the CISCO-FLASH-MIB.

Sends an RF trap.

Sends a ciscoRFProgressionNotif trap for the

CISCO-RF-MIB.

Sends a ciscoRFSwactNotif trap for the

CISCO-RF-MIB.

Sends a clogMessageGenerated for the

CISCO-SYSLOG-MIB.

Command Default

None

Command Modes

EXEC

224


SNMP Server Commands snmp test trap infra

Command History

Release

Release 3.9.1




The snmp test trap infra command tests the sending of Infra MIB traps. It is not intended for testing scalability, performance, or high availability scenarios. To use this command, SNMP must be configured on the router.

Task ID

Task ID

snmp

Operation

read

Examples

Modification


This example illustrates how to use the snmp test trap infra command:


snmp test trap infra syslog message-generated


225

SNMP Server Commands snmp test trap interface

snmp test trap interface

To send a test Simple Network Management Protocol (SNMP) interface trap message to the trap receivers, use the snmp test trap interface command in

EXEC mode.

snmp test trap interface {link-down| link-up}ifindex index

Syntax Description link-down link-up

ifindex index

Sends a linkDown trap for the IF-MIB.

Sends a linkUp trap for the IF-MIB.

Specifies the interface index for which to send the IF-MIB trap.

Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.9.1




The snmp test trap interface command tests the sending of IF-MIB traps. It is not intended for testing scalability, performance, or high availability scenarios. To use this command, SNMP must be configured on the router.

Task ID

Task ID

snmp

Operation

read

Examples

Modification


This example illustrates how to use the snmp test trap interface command:


snmp test trap interface link-down

226


SNMP Server Commands snmp test trap snmp

snmp test trap snmp

To send a test Simple Network Management Protocol (SNMP) trap message to the trap receivers, use the

snmp test trap snmp command in

EXEC mode.

snmp test trap snmp {cold-start| warm-start}

Syntax Description cold-start warm-start

Sends a coldStart trap for the SNMPv2-MIB.

Sends a warmStart trap for the SNMPv2-MIB.

Command Default

None

Command Modes

EXEC

Command History

Release

Release 3.9.1




The snmp test trap snmp command tests the sending of MIB traps. It is not intended for testing scalability, performance, or high availability scenarios. To use this command, SNMP must be configured on the router.

Task ID

Task ID

snmp

Operation

read

Examples

Modification


The following example illustrates how to use the snmp test trap snmp command:


snmp test trap snmp cold-start


227

SNMP Server Commands transfer-interval

transfer-interval

To configure how long bulk statistics should be collected before a bulk statistics transfer is initiated, use the

transfer-interval command in bulk statistics transfer configuration mode. To remove a previously configured interval from a bulk statistics configuration, use the no form of this command.

transfer-interval minutes

no transfer-interval minutes


minutes

Length of time, in minutes, that the system should collect MIB data before attempting the transfer operation. The valid range is from 1 to 2147483647. The default is 30.

Command Default

Bulk statistics file transfer operations start 30 minutes after the enable (bulkstat) command is used.

Command Modes


Command History

Release

Release 4.2.0

Modification





Bulk statistics data is collected into a new file when a transfer attempt begins, which means that this command also configures the collection interval.

If the maximum buffer size for a bulk statistics file is reached before the transfer interval time expires, the transfer operation is still initiated, and bulk statistics MIB data are collected into a new file in the system buffer.

Task ID

Task ID

snmp

Operation

read, write

Examples

The following example shows how to configure a transfer interval of 20 minutes for the bulk statistics configuration bulkstat1:


configure

228


SNMP Server Commands transfer-interval




transfer-interval 20


Command

enable (bulkstat)



Description

Begins the bulk statistics data collection and transfer process for a specific bulk statistics configuration.




229

SNMP Server Commands url

url

To specify the host to which bulk statistics files should be transferred, use the url command in bulk statistics transfer configuration mode. To remove a previously configured destination host, use the no form of this command.

url [primary| secondary] url

no url [primary| secondary] url

Syntax Description primary secondary

url

Specifies the URL to be used first for bulk statistics transfer attempts.

Specifies the URL to be used for bulk statistics transfer attempts if the transfer to the primary URL is not successful.

Destination URL address for the bulk statistics file transfer. Use FTP or TFTP. The syntax for these URLs is as follows:

• ftp:[[[//username [:password]@]location]/directory]/filename

• tftp:[[/location]/directory]/filename

The location argument is typically an IP address.

Command Default

No host is specified.

Command Modes


Command History

Release

Release 4.2.0

Modification





For bulk statistics transfer retry attempts, a single retry consists of an attempt to send first to the primary URL, and then to the secondary URL.

Task ID

Task ID

snmp

Operation

read, write

230


SNMP Server Commands url

Examples

In the following example, an FTP server is used as the primary destination for the bulk statistics file. If a transfer to that address fails, an attempt is made to send the file to the TFTP server at 192.168.10.5. No retry command is specified, which means that only one attempt to each destination will be made.


configure


snmp-server mib bulkstat transfer ifMibTesting


schema carMibTesting1


schema carMibTesting2


url primary ftp://user2:[email protected]/functionality/


url secondary tftp://[email protected]/tftpboot/


enable


exit


Command


Description



231

url


232


No results