- Table of Contents
- Related Documents
-
Title | Size | Download |
---|---|---|
05-SNMP Commands | 211.88 KB |
display snmp-agent local-engineid
snmp-agent trap if-mib link extended
snmp-agent usm-user { v1 | v2c }
SNMP configuration commands
display snmp-agent community
Syntax
display snmp-agent community [ read | write ] [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
1: Monitor level
Parameters
read: Displays information about SNMP read-only communities.
write: Displays information about SNMP read and write communities.
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display snmp-agent community to display community information for SNMPv1 or SNMPv2c.
Examples
# Display information about all SNMPv1 and SNMPv2c communities.
<Sysname> display snmp-agent community
Community name: aa
Group name: aa
Acl:2001
Storage-type: nonVolatile
Community name: bb
Group name: bb
Storage-type: nonVolatile
Community name: userv1
Group name: testv1
Storage-type: nonVolatile
Field |
Description |
Community name |
Displays the community name created by using the snmp-agent community command or the username created by using the snmp-agent usm-user { v1 | v2c } command. |
Group name |
SNMP group name: · If the community is created by using the snmp-agent community command, the group name is the same as the community name. · If the community is created by using the snmp-agent usm-user { v1 | v2c } command, the name of the group to which the user belongs is displayed. |
Acl |
Number of the ACL that controls the access of the NMSs in the community to the device. Only the NMSs with the IP addresses permitted in the ACL can access the device with the community name. |
Storage-type |
Storage type: · volatile—Settings are lost when the system reboots. · nonVolatile—Settings remain after the system reboots. · permanent—Settings remain after the system reboots and can be modified but not deleted. · readOnly—Settings remain after the system reboots and cannot be modified or deleted. · other—Any other storage type. |
display snmp-agent group
Syntax
display snmp-agent group [ group-name ] [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
1: Monitor level
Parameters
group-name: Specifies the SNMP group name, a case-sensitive string of 1 to 32 characters.
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display snmp-agent group to display information about an SNMP group, including the group name, security model, MIB view, and storage type. If no group is specified, the command displays information about all SNMP groups.
Examples
# Display information about all SNMP groups.
<Sysname> display snmp-agent group
Group name: groupv3
Security model: v3 noAuthnoPriv
Readview: ViewDefault
Writeview: <no specified>
Notifyview: <no specified>
Storage-type: nonVolatile
Table 2 Command output
Field |
Description |
Group name |
SNMP group name. |
Security model |
Security model of the SNMP group: · authPriv—authentication with privacy. · authNoPriv—authentication without privacy. · noAuthNoPriv—no authentication, no privacy. Security model of an SNMPv1 or SNMPv2c group can only be noAuthNoPriv. |
Readview |
Read only MIB view accessible to the SNMP group. |
Writeview |
Write MIB view accessible to the SNMP group. |
Notifyview |
Notify MIB view for the SNMP group. The SNMP users in the group can send traps only for the nodes in the notify MIB view. |
Storage-type |
Storage type, including volatile, nonVolatile, permanent, readOnly, and other (see Table 1). |
display snmp-agent local-engineid
Syntax
display snmp-agent local-engineid [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
1: Monitor level
Parameters
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display snmp-agent local-engineid to display the local SNMP agent engine ID.
The local SNMP engine ID uniquely identifies the SNMP engine of the SNMP agent in an SNMP domain.
Every SNMP agent has one SNMP engine to provide services for sending and receiving messages, authenticating and encrypting messages, and controlling access to managed objects.
Examples
# Display the local SNMP agent engine ID.
<Sysname> display snmp-agent local-engineid
SNMP local EngineID: 800007DB7F0000013859
display snmp-agent mib-view
Syntax
display snmp-agent mib-view [ exclude | include | viewname view-name ] [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
1: Monitor level
Parameters
exclude: Displays the subtrees excluded from any MIB view.
include: Displays the subtrees included in any MIB view.
viewname view-name: Displays information about the specified MIB view.
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display snmp-agent mib-view to display MIB views.
If you do not specify any parameter, the command displays all MIB views.
Examples
# Display all SNMP MIB views of the device.
<Sysname> display snmp-agent mib-view
View name:ViewDefault
MIB Subtree:iso
Subtree mask:
Storage-type: nonVolatile
View Type:included
View status:active
View name:ViewDefault
MIB Subtree:snmpUsmMIB
Subtree mask:
Storage-type: nonVolatile
View Type:excluded
View status:active
View name:ViewDefault
MIB Subtree:snmpVacmMIB
Subtree mask:
Storage-type: nonVolatile
View Type:excluded
View status:active
View name:ViewDefault
MIB Subtree:snmpModules.18
Subtree mask:
Storage-type: nonVolatile
View Type:excluded
View status:active
ViewDefault is the default MIB view. The output shows that all MIB objects in the iso subtree are accessible except for the MIB objects in the snmpUsmMIB, snmpVacmMIB, and snmpModules.18 subtrees.
Table 3 Command output
Field |
Description |
View name |
MIB view name. |
MIB Subtree |
MIB subtree covered by the MIB view. |
Subtree mask |
MIB subtree mask. |
Storage-type |
Type of the medium where the subtree view is stored. |
View Type |
Access privilege for the MIB subtree in the MIB view: · Included—All objects in the MIB subtree are accessible in the MIB view. · Excluded—None of the objects in the MIB subtree is accessible in the MIB view. |
View status |
Status of the MIB view. |
display snmp-agent statistics
Syntax
display snmp-agent statistics [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
1: Monitor level
Parameters
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display snmp-agent statistics to display SNMP message statistics.
Examples
# Display SNMP message statistics.
<Sysname> display snmp-agent statistics
1684 Messages delivered to the SNMP entity
5 Messages which were for an unsupported version
0 Messages which used a SNMP community name not known
0 Messages which represented an illegal operation for the community supplied
0 ASN.1 or BER errors in the process of decoding
1679 Messages passed from the SNMP entity
0 SNMP PDUs which had badValue error-status
0 SNMP PDUs which had genErr error-status
0 SNMP PDUs which had noSuchName error-status
0 SNMP PDUs which had tooBig error-status (Maximum packet size 1500)
16544 MIB objects retrieved successfully
2 MIB objects altered successfully
7 GetRequest-PDU accepted and processed
7 GetNextRequest-PDU accepted and processed
1653 GetBulkRequest-PDU accepted and processed
1669 GetResponse-PDU accepted and processed
2 SetRequest-PDU accepted and processed
0 Trap PDUs accepted and processed
0 Alternate Response Class PDUs dropped silently
0 Forwarded Confirmed Class PDUs dropped silently
Table 4 Command output
Field |
Description |
Messages delivered to the SNMP entity |
Number of messages that the SNMP agent has received. |
Messages which were for an unsupported version |
Number of messages that had an SNMP version not configured on the SNMP agent. |
Messages which used a SNMP community name not known |
Number of messages that had a community name not configured on the SNMP agent. |
Messages which represented an illegal operation for the community supplied |
Number of messages carrying an operation that the community has no right to perform. |
ASN.1 or BER errors in the process of decoding |
Number of messages that had ASN.1 or BER errors during decoding. |
Messages passed from the SNMP entity |
Number of messages sent by the SNMP agent. |
SNMP PDUs which had badValue error-status |
Number of SNMP PDUs with a badValue error. |
SNMP PDUs which had genErr error-status |
Number of SNMP PDUs with a genErr error. |
SNMP PDUs which had noSuchName error-status |
Number of PDUs with a noSuchName error. |
SNMP PDUs which had tooBig error-status (Maximum packet size 1500) |
Number of PDUs with a tooBig error (the maximum packet size is 1500 bytes). |
MIB objects retrieved successfully |
Number of MIB objects that have been successfully retrieved. |
MIB objects altered successfully |
Number of MIB objects that have been successfully modified. |
GetRequest-PDU accepted and processed |
Number of get requests that have been received and processed. |
GetNextRequest-PDU accepted and processed |
Number of getNext requests that have been received and processed. |
GetBulkRequest-PDU accepted and processed |
Number of getBulk requests that have been received and processed. |
GetResponse-PDU accepted and processed |
Number of get responses that have been received and processed. |
SetRequest-PDU accepted and processed |
Number of set requests that have been received and processed. |
Trap PDUs accepted and processed |
Number of traps that have been received and processed. |
Alternate Response Class PDUs dropped silently |
Number of dropped response packets. |
Forwarded Confirmed Class PDUs dropped silently |
Number of forwarded packets that have been dropped. |
display snmp-agent sys-info
Syntax
display snmp-agent sys-info [ contact | location | version ] * [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
1: Monitor level
Parameters
contact: Displays the system contact.
location: Displays the system location.
version: Displays the version of the current SNMP agent.
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display snmp-agent sys-info to display the current SNMP system information.
If no keyword is specified, the command displays all SNMP agent system information.
Examples
# Display the current SNMP agent system information.
<Sysname> display snmp-agent sys-info
The contact person for this managed node:
Hangzhou H3C Tech. Co., Ltd.
The physical location of this node:
Hangzhou, China
SNMP version running in the system:
SNMPv3
display snmp-agent trap queue
Syntax
display snmp-agent trap queue [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
1: Monitor level
Parameters
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display snmp-agent trap queue to display basic information about the trap queue, including the trap queue name, queue length, and number of traps in the queue.
Related commands: snmp-agent trap life and snmp-agent trap queue-size.
Examples
# Display the trap queue configuration and usage status.
<Sysname> display snmp-agent trap queue
Queue name: SNTP
Queue size: 100
Message number: 6
Table 5 Command output
Field |
Description |
Queue name |
Trap queue name. |
Queue size |
Trap queue size. |
Message number |
Number of traps in the current trap queue. |
display snmp-agent trap-list
Syntax
display snmp-agent trap-list [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
1: Monitor level
Parameters
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display snmp-agent trap-list to display modules that can generate traps and their trap status (enable or disable). You can use the snmp-agent trap enable command to enable or disable the trap function of a module. For a module that has multiple sub-modules, the trap status is enable if the trap function of any of its sub-modules is enabled.
Related commands: snmp-agent trap enable.
Examples
# Display the modules that can generate traps and whether their trap function is enabled or not.
<Sysname> display snmp-agent trap-list
configuration trap enable
flash trap enable
standard trap enable
system trap enable
Enable traps: 4; Disable traps: 0
display snmp-agent usm-user
Syntax
display snmp-agent usm-user [ engineid engineid | username user-name | group group-name ] * [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
1: Monitor level
Parameters
engineid engineid: Displays SNMPv3 user information for the SNMP engine ID identified by engineid. When an SNMPv3 user is created, the system records the current local SNMP entity engine ID of the device. If the engine ID is modified, the user becomes invalid and will become valid again if the engine ID is restored.
username user-name: Displays SNMPv3 user information for a specified user name. It is case sensitive.
group group-name: Displays SNMPv3 user information for a specified SNMP group name. It is case sensitive.
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display snmp-agent usm-user to display SNMPv3 user information.
Examples
# Display SNMPv3 information for all created users.
<Sysname> display snmp-agent usm-user
User name: userv3
Group name: mygroupv3
Engine ID: 800063A203000FE240A1A6
Storage-type: nonVolatile
UserStatus: active
User name: userv3code
Group name: groupv3code
Engine ID: 800063A203000FE240A1A6
Storage-type: nonVolatile
UserStatus: active
Table 6 Command output
Field |
Description |
User name |
SNMP user name. |
Group name |
SNMP group name. |
Engine ID |
Engine ID for an SNMP entity. |
Storage-type |
Storage type: · volatile. · nonvolatile. · permanent. · readOnly. · other. See Table 1 for details. |
UserStatus |
SNMP user status. |
enable snmp trap updown
Syntax
enable snmp trap updown
undo enable snmp trap updown
View
Interface view
Default level
2: System level
Parameters
None
Description
Use enable snmp trap updown to enable link state traps on an interface.
Use undo enable snmp trap updown to disable link state traps on an interface.
By default, the link state traps are enabled.
For an interface to generate linkUp/linkDown traps when its state changes, you must also enable the linkUp/linkDown trap function globally by using the enable snmp trap updown command.
Related commands: snmp-agent target-host and snmp-agent trap enable.
Examples
# Enable port GigabitEthernet 1/0/1 to send linkUp/linkDown SNMP traps in the community public.
<Sysname> system-view
[Sysname] snmp-agent trap enable
[Sysname] snmp-agent target-host trap address udp-domain 10.1.1.1 params securityname public
[Sysname] interface gigabitethernet 1/0/1
[Sysname-GigabitEthernet1/0/1] enable snmp trap updown
sample-interval
Syntax
sample-interval sample-interval
undo sample-interval
View
System view
Default level
3: Manage level
Parameters
sample-interval: Specifies the sampling interval, in the range 0 to 300 seconds.
Description
Use sample-interval to set the interval for collecting data (for example, member usage and CPU usage) for calculating statistics for certain user specified MIB nodes.
Use undo sample-interval to restore the default.
By default, the sampling interval is 0, and the system does not sample data for calculating statistics for the user specified MIB nodes.
To make sure the system performs at least one data poll for each statistics interval, set the statistics interval equal to or greater than the sampling interval.
Related commands: statistics-interval.
Examples
# Set the sampling interval to 100 seconds for calculating statistics for the user specified MIB nodes.
<Sysname> system-view
[Sysname] statistics-interval 600
[Sysname] sample-interval 100
snmp-agent
Syntax
snmp-agent
undo snmp-agent
View
System view
Default level
3: Manage level
Parameters
None
Description
Use snmp-agent to enable the SNMP agent.
Use undo snmp-agent to disable the SNMP agent.
By default, the SNMP agent is disabled.
You can enable SNMP agent through any commands that begin with snmp-agent except the snmp-agent calculate-password command.
Examples
# Enable the SNMP agent on the device.
<Sysname> system-view
[Sysname] snmp-agent
snmp-agent calculate-password
Syntax
snmp-agent calculate-password plain-password mode { 3desmd5 | 3dessha | md5 | sha } { local-engineid | specified-engineid engineid }
View
System view
Default level
3: Manage level
Parameters
plain-password: Specifies a plaintext authentication or privacy key.
mode: Specifies authentication and privacy algorithms. Select a mode option, depending on the authentication and privacy algorithm you are configuring with the snmp-agent usm-user v3 command. The three privacy algorithms Advanced Encryption Standard (AES), Triple Data Encryption Standard (3DES), and Data Encryption Standard (DES) are in descending order of security strength. Higher security means more complex implementation mechanism and lower speed. DES is enough to meet general requirements. The Message-Digest Algorithm 5 (MD5) and Secure Hash Algorithm (SHA-1) are the two authentication algorithms. MD5 is faster than SHA-1, while SHA-1 provides higher security than MD5.
· 3desmd5: Converts the plaintext privacy key to an encrypted key for 3DES encryption used together with MD5 authentication.
· 3dessha: Converts the plaintext privacy key to an encrypted key for 3DES encryption used together with SHA-1 authentication.
· md5: Converts the plaintext authentication key to an encrypted key for MD5 authentication, or converts the plaintext privacy key to an encrypted key for AES or DES encryption used in conjunction with MD5.
· sha: Converts the plaintext authentication key to an encrypted key for SHA-1 authentication, or converts the plaintext privacy key to an encrypted key for AES or DES encryption used in conjunction with SHA-1 authentication.
local-engineid: Uses the local engine ID to calculate the encrypted key. For engine ID-related configuration, see the snmp-agent local-engineid command.
specified-engineid: Uses a user-defined engine ID to calculate the encrypted key.
engineid: Specifies an SNMP engine ID as a hexadecimal string. It must comprise an even number of hexadecimal characters, which ranges from 10 to 64. All-zero and all-F strings are invalid.
Description
Use snmp-agent calculate-password to convert a plaintext key to an encrypted key for authentication or encryption in SNMPv3.
This command helps you calculate encrypted authentication and privacy keys for SNMPv3 users that use encrypted authentication and privacy keys. To create an SNMPv3 user, see the snmp-agent usm-user v3 command.
Make sure the SNMP agent is enabled before you execute the snmp-agent calculate-password command.
In SHA mode, the converted encrypted key is a string of 40 hexadecimal characters. If this key is an authentication key, the entire key string is used for authentication. If this key is a privacy key, only the first 32 hexadecimal characters are used for encryption.
The converted key is valid only under the engine ID specified for key conversion.
Related commands: snmp-agent usm-user v3.
Examples
# Use the local engine and the MD5 algorithm to convert the plaintext key authkey to an encrypted key.
<Sysname> system-view
[Sysname] snmp-agent calculate-password authkey mode md5 local-engineid
The secret key is: 09659EC5A9AE91BA189E5845E1DDE0CC
snmp-agent community
Syntax
snmp-agent community { read | write } community-name [ acl acl-number | mib-view view-name ] *
undo snmp-agent community { read | write } community-name
View
System view
Default level
3: Manage level
Parameters
read: Assigns the specified community the read only access to MIB objects. A read-only community can only inquire MIB information.
write: Assigns the specified community the read and write access to MIB objects. A read and write community can configure MIB information.
community-name: Sets a community name, a string of 1 to 32 characters.
acl acl-number: Specifies a basic ACL to filter NMSs by source IP address. The acl-number argument represents a basic ACL number in the range of 2000 to 2999. In the specified community, only the NMSs with the IP addresses permitted in the ACL can access the SNMP agent.
mib-view view-name: Specifies the MIB view available for the community. The view-name argument represents a MIB view name, which is a string of 1 to 32 characters. A MIB view represents a set of accessible MIB objects. If no MIB view is specified, the specified community can access the MIB objects in the default MIB view ViewDefault. To create a MIB view, use the snmp-agent mib-view command.
Description
Use snmp-agent community to configure an SNMP community.
Use undo snmp-agent community to delete an SNMP community.
This command is for SNMPv1 and SNMPv2c.
A community comprises NMSs and SNMP agents, and is identified by a community name. When devices in a community communicate with each other, they use the community name for authentication. An NMS and an SNMP agent can access each other only when they are configured with the same community name. Typically, public is used as the read-only community name, and private is used as the read and write community name. To improve security, assign your SNMP communities a name other than public and private.
To make sure the MIB objects are accessible only to a specific NMS, use a basic ACL to identify the source IP address of the NMS. To set the range of the MIB objects available for the community, use a MIB view.
Related commands: snmp-agent mib-view.
Examples
# Create the read-only community readaccess so an NMS can use the protocol SNMPv1 or SNMPv2c and community name readaccess to read the MIB objects in the default view ViewDefault.
<Sysname> system-view
[Sysname] snmp-agent sys-info version v1 v2c
[Sysname] snmp-agent community read readaccess
# Create the read and write community writeaccess so only the host at 1.1.1.1 can use the protocol SNMPv2c and community name writeaccess to read and set the MIB objects in the default view ViewDefault.
<Sysname> system-view
[Sysname] acl number 2001
[Sysname-acl-basic-2001] rule permit source 1.1.1.1 0.0.0.0
[Sysname-acl-basic-2001] rule deny source any
[Sysname-acl-basic-2001] quit
[Sysname] snmp-agent sys-info version v2c
[Sysname] snmp-agent community write writeaccess acl 2001
# Create the read and write community wr-sys-acc so an NMS can use the protocol SNMPv1 or SNMPv2c, community name wr-sys-acc to read and set the MIB objects in the system subtree (OID 1.3.6.1.2.1.1).
<Sysname> system-view
[Sysname] snmp-agent sys-info version v1 v2c
[Sysname] undo snmp-agent mib-view ViewDefault
[Sysname] snmp-agent mib-view included test system
[Sysname] snmp-agent community write wr-sys-acc mib-view test
snmp-agent group
Syntax
SNMPv1 and SNMP v2c:
snmp-agent group { v1 | v2c } group-name [ read-view view-name ] [ write-view view-name ] [ notify-view view-name ] [ acl acl-number ]
undo snmp-agent group { v1 | v2c } group-name
SNMPv3:
snmp-agent group v3 group-name [ authentication | privacy ] [ read-view view-name ] [ write-view view-name ] [ notify-view view-name ] [ acl acl-number ]
undo snmp-agent group v3 group-name [ authentication | privacy ]
View
System view
Default level
3: Manage level
Parameters
v1: Specifies SNMPv1.
v2c: Specifies SNMPv2c.
v3: Specifies SNMPv3.
group-name: Specifies a group name, a string of 1 to 32 characters.
authentication: Specifies the security model of the SNMPv3 group to be authentication only (without privacy).
privacy: Specifies the security model of the SNMPv3 group to be authentication and privacy.
read-view view-name: Specifies a read-only MIB view. The view-name represents a MIB view, a string of 1 to 32 characters. The users in the specified group have read only access to the objects included in the MIB view. The default read view is ViewDefault.
write-view view-name: Specifies a read and write MIB view. The view-name argument represents a MIB view, a string of 1 to 32 characters. The users in the specified group have read and write access to the objects included in the MIB view. By default, no write view is configured, which means the NMS cannot perform the write operations to all MIB objects on the device.
notify-view view-name: Specifies a trap MIB view. The view-name argument represents a MIB view, a string of 1 to 32 characters. The system sends traps to the users in the specified group for the objects included in the MIB view. By default, no notify view is configured, which means the agent does not send traps to the NMS.
acl acl-number: Specifies a basic ACL to filter NMSs by source IPv4 address. The acl-number argument represents a basic ACL number in the range of 2000 to 2999. In the specified SNMP group, only the NMSs with the IP addresses permitted in the ACL can access the SNMP agent.
Description
Use snmp-agent group to configure an SNMP group and specify its access right.
Use undo snmp-agent group to delete an SNMP group.
By default, SNMP groups configured by the snmp-agent group v3 command use a no-authentication-no-privacy security model.
An SNMP group defines security model, access right, and so on. A user in this SNMP group has all these public properties.
Related commands: snmp-agent mib-view and snmp-agent usm-user.
Examples
# Create the SNMPv3 group group1 and assign the no authentication, no privacy security model to the group.
<Sysname> system-view
[Sysname] snmp-agent group v3 group1
snmp-agent local-engineid
Syntax
snmp-agent local-engineid engineid
undo snmp-agent local-engineid
View
System view
Default level
3: Manage level
Parameters
engineid: Specifies an SNMP engine ID as a hexadecimal string. It must comprise an even number of hexadecimal characters, which ranges from 10 to 64. All-zero and all-F strings are invalid.
Description
Use snmp-agent local-engineid to configure a local engine ID for an SNMP entity.
Use undo snmp-agent local-engineid to restore the default local engine ID.
By default, the local engine ID is the combination of company ID and device ID. Device ID is the MAC address.
An SNMP engine ID uniquely identifies an SNMP entity in an SNMP managed network. Make sure that the local SNMP engine ID is unique within your SNMP managed network to avoid communication problems.
If you have configured SNMPv3 users, change the local SNMP engine ID only if necessary. The change can void the SNMPv3 usernames and encrypted keys you have configured.
Related commands: snmp-agent usm-user.
Examples
# Configure the local engine ID as 123456789A.
<Sysname> system-view
[Sysname] snmp-agent local-engineid 123456789A
snmp-agent log
Syntax
snmp-agent log { all | get-operation | set-operation }
undo snmp-agent log { all | get-operation | set-operation }
View
System view
Default level
3: Manage level
Parameters
all: Enables logging of SNMP GET and SET operations.
get-operation: Enables logging of SNMP GET operation.
set-operation: Enables logging of SNMP SET operation.
Description
Use snmp-agent log to enable SNMP logging.
Use undo snmp-agent log to restore the default.
By default, SNMP logging is disabled.
Use SNMP logging to record the SNMP operations performed on the SNMP agent for auditing NMS behaviors. The SNMP agent sends log data to the information center. You can configure the information center to output the data to a specific destination as needed.
Examples
# Enable logging of SNMP GET operation.
<Sysname> system-view
[Sysname] snmp-agent log get-operation
# Enable logging of SNMP SET operation.
<Sysname> system-view
[Sysname] snmp-agent log set-operation
snmp-agent mib-view
Syntax
snmp-agent mib-view { excluded | included } view-name oid-tree [ mask mask-value ]
undo snmp-agent mib-view view-name
View
System view
Default level
3: Manage level
Parameters
excluded: Denies access to any nodes in the specified MIB subtree.
included: Permits access to the nodes in the specified MIB subtree.
view-name: Specify a view name, a string of 1 to 32 characters.
oid-tree: Specifies a MIB subtree by its root node's OID, such as 1.4.5.3.1, or object name, such as system. An OID is made up of a series of integers. It marks the position of a node in the MIB tree and uniquely identifies a MIB object.
mask mask-value: Sets a MIB subtree mask, a hexadecimal string. Its length must be an even number in the range of 2 to 32. For example, you can specify 0a, aa, but not 0aa. If no subtree mask is specified, the MIB subtree mask is an all-F hexadecimal string. The MIB subtree and the subtree mask together identify a set of objects to be included or excluded from the view.
Description
Use snmp-agent mib-view to create or update a MIB view.
Use undo snmp-agent mib-view to delete a MIB view.
By default, the system creates the ViewDefault view when the SNMP agent is enabled. In the default MIB view, all MIB objects in the iso subtree but the snmpUsmMIB, snmpVacmMIB, and snmpModules.18 subtrees are accessible.
A MIB view represents a set of MIB objects (or MIB object hierarchies) with certain access privilege. The MIB objects included in the MIB view are accessible while those excluded from the MIB view are inaccessible.
Each view-name oid-tree pair represents a view record. If you specify the same record with different MIB subtree masks multiple times, the last configuration takes effect.
The system can store entries for up to 20 unique MIB view records. Except for the four subtrees in the default MIB view, you can create up to 16 unique MIB view records. After you delete the default view with the undo snmp-agent mib-view command, you can create up to 20 unique MIB view records.
Be cautious with deleting the default MIB view. The operation blocks access to any MIB object on the device from NMSs that use the default view.
Related commands: snmp-agent community and snmp-agent group.
Examples
# Include the mib-2 (OID 1.3.6.1) subtree in the mibtest view, exclude the ip subtree from the mibtest view.
<Sysname> system-view
[Sysname] snmp-agent mib-view included mibtest 1.3.6.1
[Sysname] snmp-agent mib-view excluded mibtest ip
[Sysname] snmp-agent community read public mib-view mibtest
An SNMPv1 NMS in the public community can query the objects in the mib-2 subtree, but not any objects (for example, the ipForwarding or ipDefaultTTL node) in the ip subtree.
snmp-agent packet max-size
Syntax
snmp-agent packet max-size byte-count
undo snmp-agent packet max-size
View
System view
Default level
3: Manage level
Parameters
byte-count: Specifies the maximum size (in bytes) of SNMP packets that the SNMP agent can receive or send. The value range is 484 to 17,940, and the default is 1500.
Description
Use snmp-agent packet max-size to set the maximum size (in bytes) of SNMP packets that the SNMP agent can receive or send.
Use undo snmp-agent packet max-size to restore the default packet size.
By default, the maximum size of SNMP packets that the SNMP agent can receive or send is 2000 bytes.
If any device on the path to the NMS does not support packet fragmentation, limit the SNMP packet size to prevent large-sized packets from being discarded. In any other cases, the default value is sufficient.
Examples
# Set the maximum SNMP packet size to 1024 bytes.
<Sysname> system-view
[Sysname] snmp-agent packet max-size 1024
snmp-agent proxy
Syntax
snmp-agent proxy { ip ipv4-address | ipv6 ipv6-address }
undo snmp-agent proxy }
View
System view
Default level
2: System level
Parameters
ip ipv4-address: Specifies the IPv4 address of the SNMP agent that uses the SNMP agent proxy service.
ipv6 ipv6-address: Specifies the IPv6 address of the SNMP agent that uses the SNMP agent proxy service.
Description
Use snmp-agent proxy to set the local access controller as the SNMP proxy agent for an SNMP agent.
Use undo snmp-agent proxy to restore the default.
By default, the SNMP proxy agent function is disabled.
The SNMP proxy agent function is designed for access controllers installed with a SecBlade IAG card. The function enables the access controller to communicate with the SNMP management station on behalf of the SecBlade IAG card and transparently forwards SNMP messages to the SecBlade IAG card. From the perspective of the management station, the access controller and the SecBlade IAG card appear as if they were one managed node.
An access controller can work as the SNMP proxy agent for only one device.
To use this function, you must set up a tunnel between the SNMP proxy agent and the SNMP agent by using the Inter AC Tunneling Protocol (IACTP) mobility group feature.
For more information about the IACTP mobility group, see WLAN Configuration Guide.
Examples
# Configure the access controller at 192.168.1.56 as the SNMP proxy agent for the SecBlade IAG card at 192.168.1.55.
<Sysname> system-view
[Sysname] wlan mobility-group abc
[Sysname-wlan-mg-abc] member ip 192.168.1.55
[Sysname-wlan-mg-abc] source ip 192.168.1.56
[Sysname-wlan-mg-abc] mobility-group enable
[Sysname-wlan-mg-abc] quit
[Sysname] snmp-agent proxy ip 192.168.1.55
# Configure the access controller at 3FFE:A6B0:AA00:16EF:122A:001A:F9E0:3BF5 as the SNMP proxy agent for the SecBlade IAG card at 3FFE:A6B0:AA00:16EF:122A:001A:F9E0:3BF4.
<Sysname> system-view
[Sysname] wlan mobility-group abc
[Sysname-wlan-mg-abc] member ipv6 3FFE:A6B0:AA00:16EF:122A:001A:F9E0:3BF4
[Sysname-wlan-mg-abc] source ipv6 3FFE:A6B0:AA00:16EF:122A:001A:F9E0:3BF5
[Sysname-wlan-mg-abc] mobility-group enable
[Sysname-wlan-mg-abc] quit
[Sysname] snmp-agent proxy ip 3FFE:A6B0:AA00:16EF:122A:001A:F9E0:3BF4
snmp-agent sys-info
Syntax
snmp-agent sys-info { contact sys-contact | location sys-location | version { all | { v1 | v2c | v3 }* } }
undo snmp-agent sys-info { contact | location | version { all | { v1 | v2c | v3 }* } }
View
System view
Default level
3: Manage level
Parameters
contact sys-contact: Specifies the system contact, a string of 1 to 200 characters.
location sys-location: Specifies the system location, a string of 1 to 200 characters.
version: Specifies SNMP versions.
· all: Specifies SNMPv1, SNMPv2c, and SNMPv3.
· v1: Specifies SNMPv1.
· v2c: Specifies SNMPv2c.
· v3: Specifies SNMPv3.
Description
Use snmp-agent sys-info to configure system information for the SNMP agent, including the contact, location, and SNMP versions.
Use undo snmp-agent sys-info contact and undo snmp-agent sys-info location to restore the default.
Use undo snmp-agent sys-info version to disable an SNMP version.
By default, the contact is Hangzhou H3C Technologies Co., Ltd., the location is Hangzhou China, and the version is SNMPv3.
Configure the SNMP agent with the same SNMP version as the NMS for successful communications between them.
Network maintenance engineers can use the system contact information to get in touch with the manufacturer in case of network failures. The system location information is a management variable under the system branch as defined in RFC 1213-MIB, identifying the location of the managed object.
Related commands: display snmp-agent sys-info.
Examples
# Configure the contact information as Dial System Operator at beeper # 27345.
<Sysname> system-view
[Sysname] snmp-agent sys-info contact Dial System Operator at beeper # 27345
snmp-agent target-host
Syntax
snmp-agent target-host trap address udp-domain { ip-address | ipv6 ipv6-address } [ udp-port port-number ] params securityname security-string [ v1 | v2c | v3 [ authentication | privacy ] ]
undo snmp-agent target-host trap address udp-domain { ip-address | ipv6 ipv6-address } params securityname security-string
View
System view
Default level
3: Manage level
Parameters
trap: Specifies the host to be the target host which receives traps and notifications from the device.
address: Specifies the destination IP address in the SNMP messages sent from the device.
udp-domain: Indicates that the trap is transmitted using UDP.
ip-address: Specifies the IPv4 address of the trap target host.
ipv6 ipv6-address: Specifies the IPv6 address of the trap target host.
udp-port port-number: Specifies the number of the port on the target host to receive traps. The value defaults to 162.
params securityname security-string: Specifies the authentication related parameter, which is an SNMPv1 or SNMPv2c community name or an SNMPv3 user name, a string of 1 to 32 characters.
v1: Specifies SNMPv1.
v2c: Specifies SNMPv2c.
v3: Specifies SNMPv3.
· authentication: Specifies the security model to be authentication without privacy. You must specify the authentication key when you create the SNMPv3 user.
· privacy: Specifies the security model to be authentication with privacy. You must specify the authentication key and privacy key when you create the SNMPv3 user.
Description
Use snmp-agent target-host to configure a target host for receiving traps sent by the SNMP agent.
Use undo snmp-agent target-host to remove settings for an SNMP trap target host.
You can configure up to 20 SNMP trap target hosts.
Make sure the SNMP agent uses the same UDP port number as the target host for traps. If udp-port port-number is not specified, UDP port 162 is used by default. Port 162 is the SNMP-specified port used for receiving traps, and is used by most NMSs, including iMC and MIB Browser.
Make sure the SNMP agent uses the same SNMP version as the trap host so the host can receive traps. If none of the keywords v1, v2 and v3 is specified, SNMPv1 is used.
If neither authentication nor privacy is specified, the authentication mode is no authentication, no privacy.
Related commands: enable snmp trap updown, snmp-agent trap enable, snmp-agent trap life, and snmp-agent trap source.
Examples
# Configure the SNMP agent to send SNMPv1 traps to 10.1.1.1 in the community public.
<Sysname> system-view
[Sysname] snmp-agent trap enable standard
[Sysname] snmp-agent target-host trap address udp-domain 10.1.1.1 params securityname public
snmp-agent trap enable
Syntax
snmp-agent trap enable [ configuration | flash [ authentication | coldstart | linkdown | linkup | warmstart ]* | system | vrrp [ authfailure | newmaster ] | wlan ]
undo snmp-agent trap enable [ configuration | flash [ authentication | coldstart | linkdown | linkup | warmstart ]* | system | vrrp [ authfailure | newmaster ] | wlan ]
View
System view
Default level
3: Manage level
Parameters
configuration: Enables configuration traps.
flash: Enables Flash-related SNMP traps.
standard: Standard traps.
· authentication: Enables the sending of authentication failure traps in the event of authentication failure.
· coldstart: Sends coldstart traps when the device restarts.
· linkdown: Sends linkdown traps when the port is in linkdown status. It should be configured globally.
· linkup: Sends linkup traps when the port is in linkup status. It should be configured globally.
· warmstart: Sends warmstart traps when the SNMP restarts.
system: Sends H3C-SYS-MAN-MIB (a private MIB) traps.
vrrp: Enables traps for the VRRP module.
· authfailure: VRRP authentication failure traps.
· newmaster: VRRP newmaster traps, which are sent when the device becomes the master.
wlan: Enables SNMP traps for the WLAN module.
Description
Use snmp-agent trap enable to enable traps globally.
Use undo snmp-agent trap enable to disable traps globally.
By default, the trap function of all modules is enabled.
After you globally enable a trap function for a module, whether the module generates traps also depends on the configuration of the module. For more information, see the sections for each module.
To generate linkUp or linkDown traps when the link state of an interface changes, you must enable the linkUp or linkDown trap function globally by using the snmp-agent trap enable [ standard [ linkdown | linkup ] * ] command and on the interface by using the enable snmp trap updown command.
Support for the snmp-agent trap enable command depends on your device model. For more information, see About the WX Series Access Controllers Command References.
Related commands: snmp-agent target-host and enable snmp trap updown.
Examples
# Enable the SNMP agent to send SNMP authentication failure traps to 10.1.1.1 in the community public.
<Sysname> system-view
[Sysname] snmp-agent target-host trap address udp-domain 10.1.1.1 params securityname public
[Sysname] snmp-agent trap enable standard authentication
snmp-agent trap if-mib link extended
Syntax
snmp-agent trap if-mib link extended
undo snmp-agent trap if-mib link extended
View
System view
Default level
3: Manage level
Parameters
None
Description
Use snmp-agent trap if-mib link extended to configure the SNMP agent to send extended linkUp/linkDown traps. The extended linkUp and linkDown traps adds interface description and interface type to the standard linkUp and linkDown traps for fast failure point identification. When you configure the snmp-agent trap if-mib link extended command, make sure that the NMS supports the extended linkUp and linkDown traps.
Use undo snmp-agent trap if-mib link extended to restore the default.
By default, the SNMP agent sends standard linkUp/linkDown traps.
· A standard linkUp trap is in the following format:
#Apr 24 11:48:04:896 2008 Sysname IFNET/4/INTERFACE UPDOWN:
Trap 1.3.6.1.6.3.1.1.5.4<linkUp>: Interface 983555 is Up, ifAdminStatus is 1, ifOperStatus is 1
· An extended linkUp trap is in the following format:
#Apr 24 11:43:09:896 2008 Sysname IFNET/4/INTERFACE UPDOWN:
Trap 1.3.6.1.6.3.1.1.5.4<linkUp>: Interface 983555 is Up, ifAdminStatus is 1, ifOperStatus is 1, ifDescr is GigabitEthernet1/0/1, ifType is 6
· A standard linkDown trap is in the following format:
#Apr 24 11:47:35:224 2008 Sysname IFNET/4/INTERFACE UPDOWN:
Trap 1.3.6.1.6.3.1.1.5.3<linkDown>: Interface 983555 is Down, ifAdminStatus is 2, ifOperStatus is 2
· An extended linkDown trap is in the following format:
#Apr 24 11:42:54:314 2008 AR29.46 IFNET/4/INTERFACE UPDOWN:
Trap 1.3.6.1.6.3.1.1.5.3<linkDown>: Interface 983555 is Down, ifAdminStatus is 2, ifOperStatus is 2, ifDescr is GigabitEthernet1/0/1, ifType is 6
The format of an extended linkup/ linkDown trap is the standard format followed with the ifDescr and ifType information, facilitating problem location.
When this command is configured, the device sends extended linkUp/linkDown traps. If the extended messages are not supported on NMS, the device may not be able to resolve the messages.
Examples
# Extend standard linkUp/linkDown traps.
[Sysname] snmp-agent trap if-mib link extended
snmp-agent trap life
Syntax
snmp-agent trap life seconds
undo snmp-agent trap life
View
System view
Default level
3: Manage level
Parameters
seconds: Specifies the timeout time, in the range of 1 to 2,592,000 seconds.
Description
Use snmp-agent trap life to configure the holding time of the traps in the queue. Traps are discarded when the holding time expires.
Use undo snmp-agent trap life to restore the default holding time of traps in the queue.
By default, the holding time of SNMP traps in the queue is 120 seconds.
The SNMP module sends traps in queues. As soon as the traps are saved in the trap queue, a timer is started. If traps are not sent out until the timer times out (in other words, the holding time configured by using this command expires), the system removes the traps from the trap sending queue.
Related commands: snmp-agent trap enable and snmp-agent target-host.
Examples
# Configure the holding time of traps in the queue as 60 seconds.
<Sysname> system-view
[Sysname] snmp-agent trap life 60
snmp-agent trap queue-size
Syntax
snmp-agent trap queue-size size
undo snmp-agent trap queue-size
View
System view
Default level
3: Manage level
Parameters
size: Specifies the number of traps that can be stored in the trap sending queue. The value range is 1 to 3000.
Description
Use snmp-agent trap queue-size to set the size of the trap sending queue.
Use undo snmp-agent trap queue-size to restore the default queue size.
By default, up to 1000 traps can be stored in the trap sending queue.
Traps are saved into the trap sending queue when generated. The size of the queue determines the maximum number of the traps that can be stored in the queue. When the size of the trap sending queue reaches the configured value, the newly generated traps are saved into the queue, and the earliest ones are discarded.
Related commands: snmp-agent target-host, snmp-agent trap enable, and snmp-agent trap life.
Examples
# Set the maximum number of traps that can be stored in the trap sending queue to 200.
<Sysname> system-view
[Sysname] snmp-agent trap queue-size 200
snmp-agent trap source
Syntax
snmp-agent trap source interface-type interface-number
undo snmp-agent trap source
View
System view
Default level
3: Manage level
Parameters
interface-type interface-number: Specifies an interface by its type and number.
Description
Use snmp-agent trap source to specify a source IP address for the traps sent by the SNMP agent.
Use undo snmp-agent trap source to restore the default.
By default, the SNMP agent automatically chooses the IP address of an interface as the source IP address of traps.
The snmp-agent trap source command enables the SNMP agent to use the primary IP address of an interface or subinterface as the source IP address in all its SNMP traps, regardless of their outgoing interfaces. An NMS can use this IP address to filter all the traps sent by the SNMP agent.
Make sure the specified interface has been created and assigned a valid IP address. The configuration will fail if the interface has not been created and will take effect only after a valid IP address is assigned to the specified interface.
Related commands: snmp-agent target-host and snmp-agent trap enable.
Examples
# Configure the IP address of VLAN-interface 1 as the source address for traps.
<Sysname> system-view
[Sysname] snmp-agent trap source vlan-interface 1
snmp-agent usm-user { v1 | v2c }
Syntax
snmp-agent usm-user { v1 | v2c } user-name group-name [ acl acl-number ]
undo snmp-agent usm-user { v1 | v2c } user-name group-name
View
System view
Default level
3: Manage level
Parameters
v1: Specifies SNMPv1.
v2c: Specifies SNMPv2c.
user-name: Specifies a username, a case-sensitive string of 1 to 32 characters.
group-name: Specifies a group name, a case-sensitive string of 1 to 32 characters.
acl acl-number: Specifies a basic ACL to filter NMSs by source IPv4 address. The acl-number argument represents a basic ACL number in the range of 2000 to 2999. Only the NMSs with the IPv4 addresses permitted in the ACL can use the specified username (community name) to access the SNMP agent.
Use snmp-agent usm-user { v1 | v2c } to add a user to an SNMPv1 or SNMPv2c group.
Use undo snmp-agent usm-user { v1 | v2c } to delete a user from an SNMPv1 or SNMPv2c group.
Make sure you have created the SNMPv1 or SNMPv2c group.
When you create an SNMPv1 or SNMPv2c user, the system automatically creates a read-only community that has the same name as the SNMPv1 or SNMPv2c username. To change the access right of this community to write access, use the snmp-agent community command or the snmp-agent group { v1 | v2c } command. To display the SNMPv1 and SNMPv2c communities created in this way, use the display snmp-agent community command.
The snmp-agent usm-user { v1 | v2c } command enables managing SNMPv1 and SNMPv2c users in the same way as managing SNMPv3 users. It does not affect the way of configuring SNMPv1 and SNMPv2c communities on the NMS.
Related commands: snmp-agent community, snmp-agent group, and snmp-agent usm-user v3.
Examples
# Add the user userv2c to the SNMPv2c group readCom so an NMS can use the protocol SNMPv2c and the read-only community name userv2c to access the SNMP agent.
<Sysname> system-view
[Sysname] snmp-agent sys-info version v2c
[Sysname] snmp-agent group v2c readCom
[Sysname] snmp-agent usm-user v2c userv2c readCom
# Add the user userv2c in the SNMPv2c group readCom so only the NMS at 1.1.1.1 can use the protocol SNMPv2c and read-only community name userv2c to access the SNMP agent.
<Sysname> system-view
[Sysname] acl number 2001
[Sysname-acl-basic-2001] rule permit source 1.1.1.1 0.0.0.0
[Sysname-acl-basic-2001] rule deny source any
[Sysname-acl-basic-2001] quit
[Sysname] snmp-agent sys-info version v2c
[Sysname] snmp-agent group v2c readCom
[Sysname] snmp-agent usm-user v2c userv2c readCom acl 2001
snmp-agent usm-user v3
Syntax
snmp-agent usm-user v3 user-name group-name [ cipher ] [ authentication-mode { md5 | sha } auth-password [ privacy-mode { 3des | aes128 | des56 } priv-password ] ] [ acl acl-number ]
undo snmp-agent usm-user v3 user-name group-name { local | engineid engineid-string }
View
System view
Default level
3: Manage level
Parameters
user-name: Specifies a username, a case-sensitive string of 1 to 32 characters.
group-name: Specifies a group name, a case-sensitive string of 1 to 32 characters.
cipher: Specifies that auth-password and priv-password are encrypted keys, which can be calculated by using the snmp-agent calculate-password command.
authentication-mode: Specifies an authentication algorithm. MD5 is faster than SHA, while SHA provides a higher security than MD5.
· md5: Specifies the MD5 authentication algorithm.
· sha: Specifies the SHA-1 authentication protocol algorithm.
auth-password: Specifies an authentication key. If the cipher keyword is not specified, auth-password represents a plaintext key, which is a string of 1 to 64 visible characters. If the cipher keyword is specified, auth-password represents an encrypted key. If the md5 keyword is specified, auth-password is a string of 32 hexadecimal characters. If the sha keyword is specified, auth-password is a string of 40 hexadecimal characters.
privacy-mode: Specifies an encryption algorithm for privacy. The three encryption algorithms AES, 3DES, and DES are in descending order in terms of security. Higher security means more complex implementation mechanism and lower speed. DES is enough to meet general requirements.
· 3des: Specifies the 3DES algorithm.
· des56: Specifies the DES algorithm.
· aes128: Specifies the AES algorithm.
priv-password: Specifies a privacy key. If the cipher keyword is not specified, priv-password represents a plaintext key, which is a string of 1 to 64 characters. If the cipher keyword is specified, priv-password represents an encrypted key. If the md5 keyword is specified, priv-password is a string of 32 hexadecimal characters. If the sha keyword is specified, priv-password is a string of 40 hexadecimal characters.
acl acl-number: Specifies a basic ACL to filter NMSs by source IPv4 address. The acl-number argument represents a basic ACL number in the range of 2000 to 2999. Only the NMSs with the IPv4 addresses permitted in the ACL can use the specified username to access the SNMP agent.
local: Represents a local SNMP entity user.
engineid engineid-string: Specifies an SNMP engine ID as a hexadecimal string. The engineid-string argument must comprise an even number of hexadecimal characters, which ranges from 10 to 64. All-zero and all-F strings are invalid.
Description
Use snmp-agent usm-user v3 to add an SNMPv3 user to an SNMP group.
Use undo snmp-agent usm-user v3 to delete an SNMPv3 user from an SNMP group.
You must create an SNMPv3 user for the agent and the NMS to use SNMPv3.
You must create an SNMP group before you assign an SNMP user to the group. Otherwise, the user cannot take effect after it is created. An SNMP group can contain multiple users. It defines SNMP objects accessible to the group of users in the MIB view and specifies whether to enable authentication and privacy functions. The authentication and encryption algorithms are defined when a user is created.
· If you specify the cipher keyword, the system considers the arguments auth-password and priv-password as encrypted keys, and does not encrypt them when executing this command.
· If you do not specify the cipher keyword, the system considers the arguments auth-password and priv-password as plaintext keys, and encrypts them when executing this command.
Specify the cipher keyword when you roll back, copy or paste the running configuration. For example, assume that you have created SNMPv3 user A and configured both authentication and privacy keys of this user as xyz. To make the configuration of user A still effective after the configuration is copied, pasted, and re-executed, specify the cipher keyword when you create user A with this command. Otherwise, after you copy, paste, or re-execute the configuration, the device creates user A, but the corresponding keys are not xyz.
When you use the snmp-agent usm-user v3 cipher command, the pri-password argument in this command can be obtained by the snmp-agent calculate-password command. To make the calculated encrypted key applicable to the snmp-agent usm-user v3 cipher command and have the same effect as that in the snmp-agent usm-user v3 cipher command, make sure that the same encryption algorithm is specified for the two commands and the local engine ID specified in the snmp-agent usm-user v3 cipher command is consistent with the SNMP entity engine ID specified in the snmp-agent calculate-password command.
When you execute this command repeatedly to configure the same user (namely, the user names are the same, no limitation to other keywords and arguments), the last configuration takes effect.
Remember the username and the plaintext password when you create a user. A plaintext password is required when the NMS accesses the SNMP agent.
Related commands: snmp-agent calculate-password, snmp-agent group, and snmp-agent usm-user { v1 | v2c }.
Examples
# Add the user testUser to the SNMPv3 group testGroup. Configure the security model as authentication without privacy, the authentication algorithm as MD5, the plaintext key as authkey.
<Sysname> system-view
[Sysname] snmp-agent group v3 testGroup authentication
[Sysname] snmp-agent usm-user v3 testUser testGroup authentication-mode md5 authkey
To access the SNMP agent, specifically, the default view (ViewDefault) in this example, the NMS can use the protocol SNMPv3, username testUser, authentication algorithm MD5, and authentication key authkey.
# Add the user testUser to the SNMPv3 group testGroup. Configure the security model as authentication and privacy, the authentication algorithm as MD5, the privacy algorithm as DES56, the plain-text authentication key as authkey, and the plain-text privacy key as prikey.
<Sysname> system-view
[Sysname] snmp-agent group v3 testGroup privacy
[Sysname] snmp-agent usm-user v3 testUser testGroup authentication-mode md5 authkey privacy-mode des56 prikey
To access the SNMP agent, specifically, the default view (ViewDefault) in this example, the NMS must use the protocol SNMPv3, username testUser, authentication algorithm MD5, authentication key authkey, privacy algorithm DES, and privacy key prikey.
# Add the user testUser to the SNMPv3 group testGroup with the cipher keyword specified. Configure the security model as authentication and privacy, the authentication algorithm as MD5, the privacy algorithm as DES56, and specify the authentication key authkey and the privacy key prikey in their encrypted forms.
<Sysname> system-view
[Sysname] snmp-agent group v3 testGroup privacy
[Sysname] snmp-agent calculate-password authkey mode md5 local-engineid
The secret key is: 09659EC5A9AE91BA189E5845E1DDE0CC
[Sysname] snmp-agent calculate-password prikey mode md5 local-engineid
The secret key is: 800D7F26E786C4BECE61BF01E0A22705
[Sysname] snmp-agent usm-user v3 testUser testGroup cipher authentication-mode md5 09659EC5A9AE91BA189E5845E1DDE0CC privacy-mode des56 800D7F26E786C4BECE61BF01E0A22705
To access the SNMP agent, specifically, the default view (ViewDefault) in this example, the NMS must use the protocol SNMPv3, username testUser, authentication algorithm MD5, authentication key authkey, privacy algorithm DES, and privacy key prikey.
statistics-interval
Syntax
statistics-interval statistics-interval
undo statistics-interval
View
System view
Default level
3: Manage level
Parameters
Statistics-interval: Specifies the statistics interval (in seconds) for the user specified MIB nodes. The value range is 0 to 900.
Description
Use statistics-interval to set the interval for calculating statistics for certain user specified MIB nodes.
Use undo statistics-interval to restore the default.
By default, the statistics interval is 0, and the system does not calculate statistics for the user specified MIB nodes.
To make sure the system performs at least one data poll for each statistics interval, set the statistics interval equal to or greater than the sampling interval.
Related commands: sample-interval.
Examples
# Set the statistics interval to 600 seconds for the user specified MIB nodes.
<Sysname> system-view
[Sysname] statistics-interval 600
trap-send times
Syntax
trap-send times timevalue
undo trap-send times
View
System view
Default level
3: Manage level
Parameters
timevalue: Specifies the maximum number of traps that the SNMP agent can send for an event.
Description
Use trap-send times to configure the maximum number of traps that the SNMP agent can send for an alarm condition. If the limit is reached, the SNMP agent stops sending traps even if the alarm condition has not been removed.
Use undo trap-send times to restore the default.
By default, no limit is set on the number of traps that can be sent for an alarm condition.
This command applies only to some traps, including high CPU usage, system cold start, and RADIUS server unreachable.
Examples
# Set the maximum number of traps that the SNMP agent can send for an alarm condition to 5.
<Sysname> system-view
[Sysname] trap-send times 5
display mib-style
Syntax
display mib-style [ | { begin | exclude | include } regular-expression ]
View
Any view
Default level
3: Manage level
Parameters
|: Filters command output by specifying a regular expression. For more information about regular expressions, see Fundamentals Configuration Guide.
begin: Displays the first line that matches the specified regular expression and all lines that follow.
exclude: Displays all lines that do not match the specified regular expression.
include: Displays all lines that match the specified regular expression.
regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Description
Use display mib-style to display the MIB style of the device.
Two MIB styles are available on the device: new and compatible. After obtaining the MIB style, you can select matched H3C network management software based on the MIB style.
Related commands: mib-style.
Examples
# After getting the device ID from node sysObjectID, you find that it is an H3C device, and hope to know the current MIB style or the MIB style after next boot of the device.
<Sysname> display mib-style
Current MIB style: new
Next reboot MIB style: new
The output shows that the current MIB style of the device is new, and the MIB style after next boot is still new.
mib-style
Syntax
mib-style [ new | compatible ]
View
System view
Default level
3: Manage level
Parameters
new: Specifies the MIB style of the device as H3C new, which means both sysOID and private MIB of the device are located under the H3C enterprise ID 25506.
compatible: Specifies the MIB style of the device as H3C compatible, which means sysOID of the device is located under the H3C enterprise ID 25506, and private MIB is located under the enterprise ID 2011.
Description
Use mib-style to set the MIB style of the device.
By default, the MIB style of the device is new.
The configuration takes effect only when the device reboots.
Examples
# Change the MIB style of the device to compatible.
<Sysname> system-view
[Sysname] mib-style compatible
[Sysname] quit
<Sysname> display mib-style
Current MIB style: new
Next reboot MIB style: compatible
<Sysname> reboot