15.5. SNMP Commands
15.5.1. snmp-server access
Command Purpose
To set the access security of MIB view, use the snmp-server access command in Global Config mode. To remove the access security of MIB view, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server access GROUP_NAME security-model usm ( noauth | auth | priv ) ( { read READ | write WRITE | notify NOTIFY | context CONTEXT ( prefix | exact | ) } | )
no snmp-server access GROUP_NAME security-model usm ( noauth | auth | priv ) ( context CONTEXT | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
GROUP_NAME |
Name of the group |
Up to 31 characters |
security-model |
Define the security model of the group |
- |
usm |
SNMPv3 usm security model |
- |
auth |
Specifies authentication of a packet without encrypting it |
- |
noauth |
Specifies no authentication of a packet |
- |
priv |
Specifies authentication of a packet with encryption |
- |
context CONTEXT |
(Optional) Specifies the SNMP context to associate with this SNMP group and its views. |
Up to 31 characters |
prefix |
The context only match the prefix |
- |
exact |
The context should match the whole part |
- |
READ |
Optional) Specifies a read view for the SNMP group. This view enables you to view only the contents of the agent |
Up to 31 characters |
WRITE |
(Optional) Specifies a write view for the SNMP group. This view enables you to enter data and configure the contents of the agent. |
Up to 31 characters |
NOTIFY |
(Optional) Specifies a notify view for the SNMP group. This view enables you to specify a notify, inform, or trap |
Up to 31 characters |
Command Mode
Global Config
Default
No SNMP access group is defined
Usage
The command is used to create a access security for MIB view.
Examples
The following is sample output from the snmp-server access command:
Switch# configure terminal
Switch(config)# snmp-server access manage security-model usm auth write _all_ read _all_
15.5.2. snmp-server community
Command Purpose
To set up the community access string to permit access to the Simple Network Management Protocol (SNMP), use the snmp-server community command in Global Config mode. To remove the specified community string, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server community STRING ( read-only | read-write ) ( view NAME | )
no snmp-server community string
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
STRING |
Community string that consists of 1 to 256 alphanumeric characters and functions much like a password, permitting access to SNMP. Blank spaces are not permitted in the community string ,support digit char and special char as ~!@$%^&*()_+`-= ,./;[]<:{} |
A string with 1-256 characters |
read-only |
Specifies read-only access. Authorized management stations can retrieve only MIB objects |
- |
read-write |
Specifies read-write access. Authorized management stations can both retrieve and modify MIB objects |
- |
view NAME |
Specifies a previously defined view. The view defines the objects available to the SNMP community |
Up to 31 characters |
Command Mode
Global Config
Default
No SNMP community string is defined
Usage
The no snmp-server command disables all versions of SNMP (SNMPv1, SNMPv2C, SNMPv3).
Examples
The following example shows how to set the read/write community string to newstring:
Switch# configure terminal
Switch(config)# snmp-server community newstring read-write
Related Commands
snmp-server enable
15.5.3. snmp-server context
Command Purpose
To create a Simple Network Management Protocol (SNMP) context, use the snmp-server context command in Global Config mode. To delete an SNMP context, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server context CONTEXT
no snmp-server context CONTEXT
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
CONTEXT |
Name of the SNMP context being created |
Up to 31 characters |
Command Mode
Global Config
Default
No SNMP contexts are configured
Usage
When you use the no snmp-server context command, all SNMP instances in that context are deleted.
Examples
The following is sample output from the snmp-server context command:
Switch# configure terminal
Switch(config)# snmp-server context contextA
Related Commands
show snmp-server context
15.5.4. snmp-server enable
Command Purpose
To enable the SNMP function, use the snmp-server enable command in Global Config mode. To disable the SNMP function, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server enable
no snmp-server enable
Command Mode
Global Config
Default
SNMP function is disabled
Usage
The command is used to enable or disable snmp global.
Examples
The following is sample output from the snmp-server enable command:
Switch# configure terminal
Switch(config)# snmp-server enable
Related Commands
show snmp
15.5.5. snmp-server engineID
Command Purpose
To specify the Simple Network Management Protocol (SNMP) engine ID on the local device, use the snmp-server engineID command in global configuration mode. To remove the configured engine ID, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server engineID STRING
no snmp-server engineID
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
STRING |
A string identifies the engine ID |
String of a maximum of 64 characters that identifies the engine ID |
Command Mode
Global Config
Default
An SNMP engine ID is generated automatically but is not displayed or stored in the running configuration. You can display the default or configured engine ID by using the show snmp-server engineID command.
Usage
The SNMP engine ID is a unique string used to identify the device for administration purposes. You do not need to specify an engine ID for the device. For further details on the SNMP engine ID, see RFC 2571.
Examples
The following is sample output from the snmp-server engineID command:
Switch# configure terminal
Switch(config)# snmp-server engineID 30383038303830383038
Related Commands
show snmp-server engineID
15.5.6. snmp-server group
Command Purpose
To configure a new Simple Network Management Protocol (SNMP) group, use the snmp-server group command in Global Config mode. To remove a specified SNMP group, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server group GROUP_NAME user USER_NAME security-model usm
no snmp-server group GROUP_NAME user user-name security-model usm
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
GROUP_NAME |
Name of the group |
Up to 31 characters |
USER_NAME |
Name of the user in that group |
Up to 31 characters |
security-model |
Define the group security model |
- |
usm |
SNMPv3 usm model |
- |
Command Mode
Global Config
Default
No SNMP server groups are configured.
Usage
This command is used to add a new SNMP server group.
Examples
The following is sample output from the snmp-server group command:
Switch# configure terminal
Switch(config)# snmp-server group SampleA user User1 security-model usm
Related Commands
show snmp-server group
15.5.7. snmp-server notify
Command Purpose
To set the notification of traps for Simple Network Management Protocol (SNMP), use the snmp-server notify command in Global Config mode. To restore to the default value, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server notify notify-name tag tag-name ( inform | trap | )
no snmp-server notify notify-name
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
NOTIFY_NAME |
Name of the notification |
Up to 31 characters |
TAG_NAME |
Name of the tag |
Up to 32 characters |
inform |
Set notify type(default is trap) to INFOR |
- |
trap |
Set notify type(default is trap) to TRAP |
- |
Command Mode
Global Config
Default
No SNMP notify names are configured
Usage
This command is used to send events with the notification type of error to the SNMP server.
Examples
The following is sample output from the snmp-server notify command:
Switch# configure terminal
Switch(config)# snmp-server notify note tag tt
Related Commands
show snmp-server notify
15.5.8. snmp-server system-contact
Command Purpose
To set the system contact (sysContact) string, use the snmp-server system-contact command in Global Config mode. To remove the system contact information, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server system-contact TEXT
no snmp-server system-contact
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
TEXT |
String that describes the system contact information |
Up to 255 characters |
Command Mode
Global Config
Default
No system contact string is set
Usage
This command is used to set the system contact of the SNMP agent so that these descriptions can be accessed through the configuration file.
Examples
The following is an example of a system contact string:
Switch# configure terminal
Switch(config)# snmp-server system-contact <admin@exampledomain.com>
Related Commands
snmp-server system-location
15.5.9. snmp-server system-location
Command Purpose
To set the system location string, use the snmp-server system-location command in Global Config mode. To remove the location string, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server system-location TEXT
no snmp-server system-location
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
TEXT |
String that describes the system contact information |
Up to 255 characters |
Command Mode
Global Config
Default
No system location string is set
Usage
This command is used to set the system location of the SNMP agent so that these descriptions can be accessed through the configuration file.
Examples
The following is an example of a system location string:
Switch# configure terminal
Switch(config)# snmp-server system-location Sample Place
Related Commands
snmp-server system-contact
15.5.10. snmp-server target-address
Command Purpose
To specify the recipient of a Simple Network Management Protocol (SNMP) notification message, use the snmp-server trap target-address command in Global Config mode. To remove the specified host from the configuration, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server target-address NAME param PARAM ( IPV4_ADDR | IPV6_ADDR ) ( { udpport UDP_PORT | timeout TIMEOUT | retries RETRY } | ) ( taglist LINE | )
snmp-server target-address WORD param WORD mgmt-if IPV4_ADDR ( { udpport UDP_PORT | timeout TIMEOUT | retries RETRY } | ) ( taglist LINE | )
no snmp-server target-address WORD ( mgmt-if | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
NAME |
The name of the target address |
Up to 31 characters |
PARAM |
Define a param name which help to find target params table |
Up to 31 characters |
mgmt-if |
Management port |
- |
IPV4_ADDR |
IPv4 address |
IPv4 Address |
IPV6_ADDR |
IPv6 address |
IPv6 Address |
udpport port |
(Optional) Specifies that SNMP notifications or informs are to be sent to an SNMP manager. The default port is 162 |
0-65535 |
timeout number |
(Optional) The timeout value the default value is 15000 millisecond |
1-1800000 millisecond |
retries number |
(Optional) The retry time the default value is 3 |
0-10 |
taglist LINE |
(Optional) The name of the taglist (128 tags are supported).split by blank.max length is 255 character |
Up to 255 characters |
Command Mode
Global Config
Default
No snmp server is configured.
Usage
This command is used to configure a remote manager’s IP address.
This command is used for SNMP v3.
Examples
The following is sample output from the snmp-server target-address command:
Switch# configure terminal
Switch(config)# snmp-server target-address targ1 param parm1 10.0.0.2 taglist tmptag
Related Commands
show snmp-server target-address
15.5.11. snmp-server target-params
Command Purpose
To configure the parameters of the host to accept SNMP request message in Global Config mode. To remove the host`s parameters, use the no form of the command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server target-params PARAM user USER_NAME security-model v3 message-processing v3 ( noauth | auth | priv )
no snmp-server target-params USER_NAME
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
PARAM |
Define a param name which help to find target params table |
Up to 31 characters |
USER_NAME |
Name of user |
Up to 31 characters |
noauth |
Specifies no authentication of a packet |
- |
auth |
Specifies authentication of a packet without encrypting it |
- |
priv |
Specifies authentication of a packet with encryption |
- |
Command Mode
Global Config
Default
No snmp params is configured
Usage
This command is used for SNMP v3.
Examples
The following example shows how to set p1 parameters:
Switch# configure terminal
Switch(config)# snmp-server target-params p1 user u1 security-model v3 message-processing v3 auth
Related Commands
show snmp-server target-params
15.5.12. snmp-server trap enable
Command Purpose
To enable all Simple Network Management Protocol (SNMP) notification types that are available on your system, use the snmp-server trap enable command in Global Config mode. To disable all available SNMP notifications, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server trap enable NOTIFICATION-TYPE
no snmp-server trap enable NOTIFICATION-TYPE
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
NOTIFICATION-TYPE |
Type of notification to enable or disable. If the all argument is specified, all notifications available on your device are enabled or disabled (if the no form is used) |
- all/bgp/coldstart/ip sla/linkdown/linkup/l oopback-detect/ptp/sy nce/system/warmstart/ bfd/cpu-traffic-limit |
Command Mode
Global Config
Default
No notifications controlled by this command are sent
Usage
The snmp-server trap enable command is used in conjunction with the snmp-server trap target-address command. Use the snmp-server trap target-address command to specify which host or hosts receive SNMP notifications. To send notifications, you must configure at least one snmp-server trap target-address command.
Examples
The following is sample output from the snmp-server trap enable command:
Switch# configure terminal
Switch(config)# snmp-server trap enable all
Related Commands
snmp-server trap target-address
15.5.13. snmp-server trap delay
Command Purpose
To delay snmp-server trap send, use the snmp-server trap delay command in Global Config mode. To disable trap delay, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server trap delay ( linkup | linkdown ) TIMER
no snmp-server trap delay ( linkup | linkdown )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
TIMER |
The time to delay up/down.Unit:100 millisecond |
1-100 |
Command Mode
Global Config
Default
No delay is enabled
Usage
The link down and up trap will send immediately while link state change. The command can configure a delay time for link status trap. The unit is 100ms.
Examples
The following is sample output from the snmp-server trap enable command:
Switch# configure terminal
Switch(config)# snmp-server trap delay linkup 10
Related Commands
snmp-server trap target-address
15.5.14. snmp-server trap target-address
Command Purpose
To configure a remote trap manager’s IP address, use the snmp-server target-address command in Global Config mode. To remove the configuration, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server trap target-address ( mgmt-if | vrf VRF_NAME | ) ( IPV4_ADDR | IPV6_ADDR ) community COMMUINTY ( udpport UDP_PORT | )
no snmp-server trap target-address ( mgmt-if | vrf VRF_NAME | ) ( IPV4_ADDR | IPV6_ADDR ) community COMMUINTY ( udpport UDP_PORT | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
mgmt-if |
Management port |
- |
vrf VRF_NAME |
VRF name |
Up to 15 characters |
IPV4_ADDR |
IPv4 address |
IPv4 Address |
IPV6_ADDR |
IPv6 address |
IPv6 Address |
COMMUINTY |
Password-like community string sent with the notification operation |
Up to 255 characters |
UDP_PORT |
(Optional) Specifies that SNMP notifications or informs are to be sent to an SNMP manager. The default port is 162 |
1-65535 |
Command Mode
Global Config
Default
The router does not send any trap messages.
Usage
This command is used to specify the server target address to which the trap is sent.
Examples
The following is sample output from the snmp-server trap target-address command:
Switch# configure terminal
Switch(config)# snmp-server trap target-address mgmt-if 192.168.1.100 community test udpport 6000
Related Commands
snmp-server trap enable
snmp-server trap source-address
15.5.15. snmp-server trap source-address
Command Purpose
To configure the trap’s source IP address, use the snmp-server source-address command in Global Config mode. To remove the configuration, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server trap source-address ( vrf WORD | ) ( IPV4_ADDR )
no snmp-server trap source-address
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
vrf WORD |
VRF name |
Up to 15 characters |
IPV4_ADDR |
IPv4 address |
IPv4 Address |
Command Mode
Global Config
Default
The router does not send any trap messages.
Usage
This command is used to specify the server source IP address to which the trap is sent.Please check if the source IP exists in an interface which is up
Examples
The following is sample output from the snmp-server trap source-address command:
Switch# configure terminal
Switch(config)# snmp-server trap source-address 192.168.1.100
Related Commands
snmp-server trap target-address
15.5.16. snmp-server inform target-address
Command Purpose
To specify the recipient of a Simple Network Management Protocol (SNMP) inform message, use the snmp-server inform target-address command in Global Config mode. To remove the specified host from the configuration, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server inform target-address ( mgmt-if | vrf VRF_NAME | ) ( IPV4_ADDR | IPV6_ADDR ) community COMMUINTY ( udpport UDP_PORT | )
no snmp-server inform target-address ( mgmt-if | vrf VRF_NAME | ) ( IPV4_ADDR | IPV6_ADDR ) community COMMUINTY ( udpport UDP_PORT | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
mgmt-if |
Management port |
- |
vrf VRF_NAME |
VRF name |
Up to 15 characters |
IPV4_ADDR |
IPv4 address |
IPv4 Address |
IPV6_ADDR |
IPv6 address |
IPv6 Address |
COMMUINTY |
Password-like community string sent with the notification operation |
Up to 255 characters |
UDP_PORT |
(Optional) Specifies that SNMP notifications or informs are to be sent to an SNMP manager. The default port is 162 |
1-65535 |
Command Mode
Global Config
Default
The router does not send any inform messages
Usage
This command is used to specify the server target address to which the inform is sent.
Examples
The following is sample output from the snmp-server inform target-address command:
Switch# configure terminal
Switch(config)# snmp-server inform target-address mgmt-if 192.168.1.100 community test udpport 6000
Related Commands
None
15.5.17. snmp-server inform
Command Purpose
Use this command in global to configure Simple Network Management Protocol (SNMP) inform message parameters, include timeout and retries.Use the no form of this command to remove inform parameters.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server inform ( { retries RETRY | timeout TIMEOUT } )
no snmp-server inform ( retries | timeout | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
RETRY |
The retry time, the default value is 3 |
0-10 |
TIMEOUT |
The timeout value, the default value is 15 second |
1-1800s |
Command Mode
Global Config
Default
No snmp inform parameters is configured
Usage
This command is used for SNMP v2.
Examples
The following example shows how to configure inform message parameters:
Switch(config)# snmp-server inform timeout 10 retries 5
Related Commands
None
15.5.18. snmp-server version
Command Purpose
To specify the support of SNMP version, use the snmp-server version command in Global Config mode. To restore to the default value, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server version ( all | v1 | v2c | v3 )
no snmp-server version
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
all |
Support all versions (v1, v2c, and v3) |
- |
v1 |
Support only v1 version |
- |
v2c |
Support only v2c version |
- |
v3 |
Support only v3 version |
- |
Command Mode
Global Config
Default
Support all SNMP versions
Usage
This command is used to set the SNMP version the switch supported.
Examples
The following is sample output from the snmp-server version command:
Switch# configure terminal
Switch(config)# snmp-server version all
Related Commands
show snmp-server version
15.5.19. snmp-server view
Command Purpose
To create or update a view entry, use the snmp-server view command in Global Config mode. To remove the specified Simple Network Management Protocol (SNMP) server view entry, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server view NAME ( included | excluded ) sub-tree
no snmp-server view NAME ( included | excluded ) sub-tree
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
NAME |
Label for the view record that you are updating or creating. The name is used to reference the record |
Up to 31 characters |
included |
Configures the OID (and subtree OIDs) specified in sub-tree argument to be included in the SNMP view |
- |
excluded |
Configures the OID (and subtree OIDs) specified in sub-tree argument to be explicitly excluded from the SNMP view |
- |
sub-tree |
Object identifier of the ASN.1 subtree to be included or excluded from the view |
- |
Command Mode
Global Config
Default
No view entry exists
Usage
Other SNMP commands require an SMP view as an argument. You use this command to create a view to be used as arguments for other commands.
Examples
The following is sample output from the snmp-server view command:
Switch# configure terminal
Switch(config)# snmp-server view abc excluded 1.3.6.2
Related Commands
show snmp-server view
15.5.20. snmp-server access-group NAME in
Command Purpose
To set the access group, use the snmp-server access-group command in Global Config mode. To remove the access group, use the no form of this command.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
snmp-server access-group NAME in
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
NAME |
Access-list name |
Up to 40 characters |
in |
Inbound packets |
- |
Command Mode
Global Config
Default
No access group is defined
Usage
The command is used to apply ACL in snmp.
Examples
The following is sample output from the snmp-server access command:
Switch# configure terminal
Switch(config)# snmp-server access-group abc in
Related Commands
None
15.5.21. show snmp
Command Purpose
To display the services information of SNMP, use the show snmp command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp
Command Mode
Privileged EXEC
Default
None
Usage
This command is used to display the service information of SNMP (enable or disable).
Examples
The following is sample output from the show snmp command:
Switch# show snmp
SNMP services: enable
Related Commands
snmp-server enable
15.5.22. show snmp-server access
Command Purpose
To display the ACL information of SNMP, use the show snmp-server access command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server access ( GROUP_NAME | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
GROUP_NAME |
Specify a group name |
Up to 31 characters |
Command Mode
Privileged EXEC
Default
None
Usage
This command is used to display the access information configured by command snmp-server access.
Examples
The following is sample output from the show snmp-server access command:
Switch# show snmp-server access gp1
Group name: gp1
Context: test
Security model: usm
Security level: auth
Context Match: exact
Read view: _all_
Write view: none
Notify view: none
Storage Type: permanent
Row status: active
Related Commands
snmp-server access
15.5.23. show snmp-server community
Command Purpose
To display the SNMP community information, use the show snmp-server community command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server community
Command Mode
Privileged EXEC
Default
None
Usage
This command is used to display the community information configured by command snmp-server community.
Examples
The following is sample output from the show snmp-server community command:
Switch# show snmp-server community
Community-Access Community-String Security-name
==================================================================
read-only public comm1
read-write private comm3
read-only public comm2
read-write private comm4
Related Commands
snmp-server community
15.5.24. show snmp-server context
Command Purpose
To display the SNMP context information, use the show snmp-server context command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server context
Command Mode
Privileged EXEC
Default
None
Usage
This command is used to display the context information configured by command snmp-server context.
Examples
The following is sample output from the show snmp-server context command:
Switch# show snmp-server context
samplecontext
Related Commands
snmp-server context
15.5.25. show snmp-server engineID
Command Purpose
To display the identification of the local Simple Network Management Protocol (SNMP) engine and all remote engines that have been configured on the router, use the show snmp-server engineID command in EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server engineID
Command Mode
Privileged EXEC
Default
None
Usage
An SNMP engine is a copy of SNMP that can reside on a local or remote device.
Examples
The following example specifies 00000009020000000c025808 as the local engineID:
Switch# show snmp-server engineID
Engine ID : 00000009020000000c025808
Related Commands
snmp-server engineID
15.5.26. show snmp-server group
Command Purpose
To display the names of configured SNMP groups, the security model being used, the status of the different views, and the storage type of each group, use the show snmp-server group command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server group ( GROUP_NAME | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
GROUP_NAME |
Specify a group name |
Up to 31 characters |
Command Mode
Privileged EXEC
Default
None
Usage
SNMP groups are configured using the snmp-server group command.
Examples
The following is sample output from the show snmp-server group command:
Switch# show snmp-server community
Community-Access Community-String Security-name
==================================================================
read-only public comm1
read-write private comm3
read-only public comm2
read-write private comm4
Related Commands
snmp-server group
15.5.27. show snmp-server notify
Command Purpose
To display notification information of SNMP, use the show snmp-server notify command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server notify ( GROUP_NAME | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
GROUP_NAME |
Specify a group name |
Up to 31 characters |
Command Mode
Privileged EXEC
Default
None
Usage
This command is used to display the notification information configured by command snmp-server notify.
Examples
The following is sample output from the show snmp-server notify command:
Switch# show snmp-server notify
Notify-name Notify-type
===========================================================
sample trap
Related Commands
snmp-server notify
15.5.28. show snmp-server sys-info
Command Purpose
To display the system information of SNMP, use the show snmp-server sys-info command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server sys-info
Command Mode
Privileged EXEC
Default
None
Usage
The system contact can be set by using the snmp-server system-contact command. The system location can be set by using the snmp-server system-location command.
Examples
The following is sample output from the show snmp-server sys-info command:
Switch# show snmp-server sys-info
Contact: <admin@sampledomain.com>
Location: Denvor
Related Commands
snmp-server system-contact
snmp-server system-location
15.5.29. show snmp-server trap-receiver
Command Purpose
To display the SNMP traps receiver, use the show snmp-server trap-receiver command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server trap-receiver
Command Mode
Privileged EXEC
Default
None
Usage
This command is used to display traps receiver information configured by command snmp-server trap target-addres.
Examples
The following is sample output from the show snmp-server trap-receiver command:
Switch# show snmp-server trap-receiver
Target-ipaddress udpport version pdu-type community
===========================================================
1.1.1.1 234 v2c inform public
1.1.1.1 234 v2c trap public
1.1.1.1 234 v1 trap public
Related Commands
snmp-server trap target-addres
15.5.30. show snmp-server usm-user
Command Purpose
To display information about the configured characteristics of Simple Network Management Protocol (SNMP) users, use the show snmp-server usm-user command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server usm-user ( USERNAME | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
USERNAME |
(Optional) Name of a specific user or users about which to display SNMP information |
Up to 31 characters |
Command Mode
Privileged EXEC
Default
None
Usage
An SNMP user must be part of an SNMP group, as configured using the snmp-server usm-user command.
Examples
The following is sample output from the show snmp-server usm-user command:
Switch# show snmp-server usm-user user1
EnginedID: 01234567890123456789
User Name: user1
Auth Protocol: md5
priv Protocol: des
Storage Type: nonvolatile
Row status: active
Related Commands
snmp-server usm-user
15.5.31. show snmp-server version
Command Purpose
To display the supported version of SNMP, use the show snmp-server version command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server version
Command Mode
Privileged EXEC
Default
None
Usage
This command is used to display snmp version information configured by command snmp-server version.
Examples
The following is sample output from the show snmp-server version command:
Switch# show snmp-server version
SNMPv1/SNMPv2c/SNMPv3
Related Commands
snmp-server version
15.5.32. show snmp-server view
Command Purpose
To display the family name, storage type, and status of a Simple Network Management Protocol (SNMP) configuration and associated MIB, use the show snmp-server view command in privileged EXEC mode.
Prerequisites
Platform |
Software |
License |
Comments |
---|---|---|---|
AQ-N3000 |
7.0 |
Base |
|
AQ-N5000 |
7.0 |
Base |
|
AQ-N6000 |
7.0 |
Base |
Command Syntax
show snmp-server view ( NAME | )
Parameter |
Parameter Description |
Parameter Value |
---|---|---|
NAME |
Specify a view name |
Up to 31 characters |
Command Mode
Privileged EXEC
Default
None
Usage
Use this command to display the SNMP view configuration.
Examples
The following is sample output from the show snmp-server view command:
Switch# show snmp-server view
View-name View-type Subtree
===========================================================
abc excluded .1.3.6.2
_all_ included .0
_all_ included .1
_all_ included .2
_none_ excluded .0
_none_ excluded .1
_none_ excluded .2
Related Commands
snmp-server view