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.

Command Default

No MIB objects are configured for an object list.

Command Modes

Bulk statistics object list configuration

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.

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.

Command Default

The default bulk statistics transfer buffer is 2048 bytes.

Command Modes

Bulk statistics transfer configuration

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.

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.

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.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC mode

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.

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

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.

Syntax Description

This command has no keywords or arguments.

Command Default

Bulk statistics transfer is disabled.

Command Modes

Bulk statistics transfer configuration

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.

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.

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.

Command Default

The default bulk statistics transfer format is schemaASCII

Command Modes

Bulk statistics transfer configuration

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.

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

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.

Syntax Description

This command has no keywords or arguments.

Command Default

Index persistence is disabled.

Command Modes

SNMP interface configuration

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.

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.

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.

Command Default

No instances are configured.

Command Modes

Bulk statistics schema configuration

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.

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.

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.

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.

Command Default

No instances are configured.

Command Modes

Bulk statistics schema configuration

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.

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

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.

Command Default

No instance repetition is configured.

Command Modes

Bulk statistics schema configuration

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.

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

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

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.

Syntax Description

This command has no keywords or arguments.

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

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.

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.

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.

Command Default

No bulk statistics object list is specified.

Command Modes

Bulk statistics schema configuration

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.

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.

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.

Command Default

Object instances are polled once every five minutes.

Command Modes

Bulk statistics schema configuration

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.

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.

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.

Command Default

The bulk statistics file retention interval is 0 minutes.

Command Modes

Bulk statistics transfer configuration

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.

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.

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.

Command Default

No retry attempts are made.

Command Modes

Bulk statistics transfer configuration

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.

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.

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.

Command Default

No bulk statistics schema is specified.

Command Modes

Bulk statistics transfer configuration

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.

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

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

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.

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

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

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

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

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.

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.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC mode

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.

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

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

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.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

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.

Command Default

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

Command Modes

EXEC

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.

To display the linkUp and linkDown notification status for a subset of interfaces, use the show snmp interface notification command in EXEC mode.

Command Default

None

Command Modes

EXEC

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.

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.

Refer to the Understanding Regular Expressions, Special Characters, and Patterns module in Cisco IOS XR Getting Started Guide for the Cisco CRS Router 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.

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.

Command Default

None

Command Modes

EXEC

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

Refer to the Understanding Regular Expressions, Special Characters, and Patterns module in Cisco IOS XR Getting Started Guide for the Cisco CRS Router for more information regarding regular expressions.

Command Default

None

Command Modes

EXEC

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.

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.

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.

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

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

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.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

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

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

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.

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

Global configuration

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.

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.

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.

Command Modes

Global configuration

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.

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 all SDRs in the system.

Note	In a non-owner SDR, a community name provides access only to the object instances that belong to that SDR, regardless of the access privilege assigned to the community name. Access to the owner SDR and system-wide access privileges are available only from the owner SDR.

Command Default

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

Command Modes

Global configuration

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.

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

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

Command Default

No system contact is set.

Command Modes

Global configuration

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.

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.

Command Default

None

Command Modes

Global configuration

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.

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.

To map an SNMP context with a protocol instance, topology or VRF entity, use the snmp-server context mapping command in global configuration mode.

Command Default

No context mappings exist by default.

Command Modes

Global configuration

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.

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.

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

To avoid error PDUs being sent out of router when polled with incorrect SNMPv3 user name, use the snmp-server drop unknown-user command in the appropriate mode. If the configuration is not set, by default it will respond with error PDUs.

Command Default

None

Command Modes

XR config

Usage Guidelines

No specific guidelines impact the use of this command.

Command Default

An SNMP engine ID is generated automatically.

Command Modes

Global configuration

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.

Command Default

An SNMP engine ID is generated automatically.

Command Modes

Global configuration

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.

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

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Global configuration

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.

Command Default

See Table 1.

Command Modes

Global configuration

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.

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:

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

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

Global configuration

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.

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.

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.

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

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.

Syntax Description

This command has no keywords or arguments.

Command Default

Global interface persistence is disabled.

Command Modes

Global configuration

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.

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.

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.

Syntax Description

This command has no keywords or arguments.

Command Default

Global interface persistence is disabled.

The alias name is 64 bytes in length.

Command Modes

Global configuration

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.

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.

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.

Command Default

timeout: 15 seconds

Command Modes

Global configuration

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.

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.

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.

Syntax Description

This command has no keywords or arguments.

Command Default

Cached statistics are not enabled.

Command Modes

Global configuration

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.

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.

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.

Command Default

None

Command Modes

Global configuration

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.

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.

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.

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

Global configuration

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.

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 processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0. Example: interface MgmtEth0/RP1/CPU0/0.

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.

Command Default

None

Command Modes

Global configuration

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.

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.

Refer to the Understanding Regular Expressions, Special Characters, and Patterns module in Cisco IOS XR Getting Started Guide for the Cisco CRS Router for more information regarding regular expressions.

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.

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.

Command Default

The IP DSCP default value for SNMP traffic is 0.

Command Modes

Global configuration

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.

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

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.

Command Default

The IP Precedence default value for SNMP traffic is 0.

Command Modes

Global configuration

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.

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

Command Default

No system location string is set.

Command Modes

Global configuration

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.