SNMP Agent Commands
This chapter describes the command-line interface (CLI) commands that you can use to manage and monitor the SNMP agent on the Broadband Access Center (BAC) Device Provisioning Engine (DPE).
The commands described in this chapter are:
•snmp-server community
•no snmp-server community
•snmp-server contact
•no snmp-server contact
•snmp-server host
•no snmp-server host
•snmp-server inform
•no snmp-server inform
•snmp-server location
•no snmp-server location
•snmp-server reload
•snmp-server start | stop
•snmp-server udp-port
•no snmp-server udp-port
snmp-server community
Use this command to set up the community access string to allow access for external SNMP managers to the DPE SNMP agent.
After you use this command, run the snmp-server reload command so that the changes take effect. See snmp-server reload.
To delete the specified community string, use the no form of this command. See no snmp-server community.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
snmp-server community string [ro | rw]
•string—Identifies the SNMP community.
•ro—Assigns a read-only community string. Only Get requests (queries) can be performed. The network management system and the managed device must reference the same community string.
•rw—Assigns a read-write community string. SNMP applications require rw access for Set operations. The rw community string enables write access to OID values.
Defaults
The default ro and rw community strings are baccread and baccwrite, respectively. We recommend that you change these values before deploying BAC.
Examples
dpe# snmp-server community test_community ro
Requires SNMP agent restart "> snmp-server reload"
no snmp-server community
Use this command to delete the specified community string that allows access for external SNMP managers to the DPE SNMP agent.
After you use this command, run the snmp-server reload command to restart the SNMP agent. See snmp-server reload.
To set up the community access string, see snmp-server community.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
no snmp-server community string
string—Identifies the SNMP community.
Examples
dpe# no snmp-server community test_community
Requires SNMP agent restart "> snmp-server reload"
snmp-server contact
Use this command to enter a string of characters that identify the system contact (sysContact) as defined in the MIB II.
After you use this command, run the snmp-server reload command to restart the SNMP agent. See snmp-server reload.
To remove the system contact, use the no form of this command. See no snmp-server contact.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
snmp-server contact text
text—Identifies the name of the contact responsible for the DPE.
Examples
dpe# snmp-server contact terry
% OK (Requires SNMP server restart "> snmp-server reload")
no snmp-server contact
Use this command to remove the system contact that is responsible for the DPE.
After you use this command, run the snmp-server reload command to restart the SNMP agent. See snmp-server reload.
To enter a string of characters that identify the system contact, use the snmp-server contact command. See snmp-server contact.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
No keywords or arguments.
Examples
dpe# no snmp-server contact
% OK (Requires SNMP server restart "> snmp-server reload")
snmp-server host
Use this command to specify the recipient of all SNMP notifications and to configure the SNMP agent to send traps or informs to multiple hosts. You can use multiple instances of this command to specify more than one notification recipient.
After you use this command, run the snmp-server reload command so that the changes take effect. See snmp-server reload.
To remove the specified notification recipient, use the no form of this command. See no snmp-server host.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
snmp-server host host-addr notification community community [udp-port port]
•host-addr—Specifies the IP address of the host to which notifications are sent.
•community—Specifies the community string to use while sending SNMP notifications.
•port—Identifies the UDP port used to send SNMP notifications. The default port number is 162.
Examples
dpe# snmp-server host 10.10.10.5 notification community public udp-port 162
Requires SNMP agent restart "> snmp-server reload"
no snmp-server host
Use this command to remove the specified notification recipient.
After you use this command, run the snmp-server reload command so that the changes take effect. See snmp-server reload.
To specify the recipient of all SNMP notifications, see snmp-server host.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
no snmp-server host host-add notification
•host-add—Identifies the IP address of the host.
Examples
dpe# no snmp-server host 10.10.10.5 notification
Requires SNMP agent restart "> snmp-server reload"
snmp-server inform
Use this command to specify the type of SNMP notification sent from the SNMP agent to the SNMP manager. Use it to send SNMP informs rather than traps, although traps are sent by default.
After you use this command, run the snmp-server reload command to restart the SNMP agent. See snmp-server reload.
To switch the SNMP notifications back to the default setting of traps, use the no form of this command. See no snmp-server inform.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
snmp-server inform [retries count timeout time]
•count—Identifies the number of times an inform can be sent from the SNMP agent to the manager. If the timeout period expires before the configured number of retries is reached, the SNMP server stops sending informs.
•time—Identifies the length of time (in milliseconds) that the SNMP server continues to send informs. If the maximum number of retries is reached before the timeout expires, the SNMP server stops sending informs.
Note Specifying the retry count and the timeout while configuring SNMP informs is optional. If you do not specify any values, the default values are used.
Defaults
The default number of retries is 1 and the default timeout is 5000 milliseconds.
Examples
dpe# snmp-server inform retries 5 timeout 500
Requires SNMP agent restart "> snmp-server reload"
In this example, an SNMP inform will be sent up to a maximum of 5 times before the retries stop. If the timeout of 500 milliseconds expires before the 5 retries take place, the inform is not sent again.
no snmp-server inform
Use this command to switch the SNMP notifications that are sent to the SNMP manager back to the default setting of traps.
After you use this command, run the snmp-server reload command to restart the SNMP agent. See snmp-server reload.
To specify the type of SNMP notification sent, see snmp-server inform.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
No keywords or arguments.
Examples
dpe# no snmp-server inform
Requires SNMP agent restart "> snmp-server reload"% OK
snmp-server location
Use this command to enter a string of characters that identify the system location (sysLocation) as defined in the MIB II.
After you use this command, run the snmp-server reload command to restart the SNMP agent. See snmp-server reload.
To remove a system location, use the no form of this command. See no snmp-server location.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
snmp-server location text
text—Identifies the physical location of the DPE.
Examples
dpe# snmp-server location st_louis
% OK (Requires SNMP agent restart "> snmp-server reload")
no snmp-server location
Use this command to remove a system location.
After you use this command, run the snmp-server reload command to restart the SNMP agent. See snmp-server reload.
To enter a string of characters that identify the system location, see snmp-server location.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
No keywords or arguments.
Examples
dpe# no snmp-server location
% OK (Requires SNMP server restart "> snmp-server reload")
snmp-server reload
Use this command to reload the SNMP agent process on the DPE.
Note When the SNMP process is started on the RDU and DPE, a trap containing the system uptime is sent. BAC trap notifications, however, are disabled by default. You can enable trap notifications only by setting the corresponding MIB object via SNMP. You cannot enable trap notifications via the CLI or the administrator user interface.
This BAC release supports only the trap notifications defined in the CISCO-BACC-SERVER-MIB and CISCO-BACC-RDU-MIB files. For more information, refer to the MIB files in the BPR_HOME/rdu/mibs directory.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
No keywords or arguments.
Examples
Example 1
nativeSnmpAgent has been restarted
snmpAgent has been restarted
This result occurs on a hardware DPE.
Example 2
nativeSnmpAgent has been restarted
dpeSnmpAgent has been restarted
This result occurs on a Solaris DPE.
snmp-server start | stop
Use this command to start or stop the SNMP agent process on the DPE.
Usage Guidelines
Use this command on both hardware and Solaris DPEs.
Syntax Description
snmp-server start | stop
•start—Starts the SNMP agent process on the DPE.
Note Use this command only when the SNMP agent is not running. If you run this command when the SNMP agent is already running, the following message appears:
Process snmpAgent is already running
•stop—Stops the SNMP agent process on the DPE.
Examples
Example 1
nativeSnmpAgent has been started
snmpAgent has been started
Example 2
nativeSnmpAgent has been stopped
snmpAgent has been stopped
These results occur when you run snmp-server start and snmp-server stop on a hardware DPE.
Example 3
nativeSnmpAgent has been started
dpeSnmpAgent has been started
Example 4
nativeSnmpAgent has been stopped
dpeSnmpAgent has been stopped
These results occur when you run snmp-server start and snmp-server stop on a Solaris DPE.
snmp-server udp-port
Use this command to identify the UDP port number on which the SNMP agent listens.
The DPE requires this command to prevent potential sharing violations between ports that other applications use. The changing of port numbers is used to resolve potential port conflict.
To change the port to which the SNMP agent listens back to the default UDP port number, use the no form of this command. See no snmp-server udp-port.
Usage Guidelines
Use this command only on a Solaris DPE.
Syntax Description
snmp-server udp-port port
port—Identifies the UDP port to which the SNMP agent listens.
Defaults
The default port number of the SNMP agent is 8001.
Note To eliminate potential port conflicts with other SNMP agents on the Solaris computer, the default port number is different from the standard well-known SMNP agent port.
We recommend that you change the SNMP agent port to the well-known port number 161.
Examples
dpe# snmp-server udp-port 161
no snmp-server udp-port
Use this command to change the UDP port to which the SNMP agent listens to the default port (8001).
Note Using a port number other than the standard well-known SNMP agent port number of 161 increases the likelihood of potential port conflicts with other SNMP agents running on the same Solaris computer.
To specify the UDP port number to which the SNMP agent listens, see snmp-server udp-port.
Usage Guidelines
Use this command only on a Solaris DPE.
Syntax Description
No keywords or arguments.
Examples
dpe# no snmp-server udp-port