Chapter 7 SNMP Agent Commands

Table Of Contents

SNMP Agent Commands

Commands

snmp-server community string [ro|rw]

no snmp-server community string

snmp-server host

no snmp-server host

snmp-server reload

snmp-server start

snmp-server stop

snmp-server contact

no snmp-server contact

snmp-server location

no snmp-server location

snmp-server inform

no snmp-server inform

snmp-server udp-port

no snmp-server udp-port

SNMP Agent Commands

This chapter contains detailed information about the command line interface (CLI) commands that you can use to manage and monitor the SNMP agent found in the Broadband Access Center for Cable (BACC) device provisioning engine (DPE).

Commands

This section describes the commands that affect the DPE SNMP agent, including:

• snmp-server community string [ro|rw]

• no snmp-server community string

• snmp-server host

• no snmp-server host

• snmp-server reload

• snmp-server start

• snmp-server stop

• snmp-server contact

• no snmp-server contact

• snmp-server location

• no snmp-server location

• snmp-server inform

• no snmp-server inform

• snmp-server udp-port

• no snmp-server udp-port

snmp-server community string [ro|rw]

Usage Guidelines

This command sets up the community access string to allow access for external SNMP managers to the DPE SNMP agent.

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When entering the snmp-server community command, you must use this syntax:

snmp-server community string [ro | rw]

Where:

•<string>—Identifies the SNMP community.

•<ro>—Assigns a read only (ro) community string. Only Get requests (queries) can be performed. The NMS and the managed device must reference the same community string.

•<rw>—Assigns a read write (rw) community string. SNMP applications require rw access for Set operations. The rw community string enables write access to OID values.

When this command is used, you must follow it by running the snmp-server reload command to restart the SNMP agent. See the "snmp-server reload" section for additional information.

Examples

This is an example of how to use the snmp-server community command:

dpe# snmp-server community test_community ro
%OK (Requires SNMP restart "> snmp-server reload")

no snmp-server community string

Usage Guidelines

This command deletes the specified community string.

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When entering the no snmp-server community string command, you must use this syntax:

no snmp-server community string

Where:

•<string>—Identifies the SNMP community.

Examples

This is an example of how to use the no snmp-server community command:

dpe# no snmp-server community test_community
%OK (Requires SNMP restart "> snmp-server reload")

snmp-server host

Usage Guidelines

This command specifies the recipient of all SNMP notifications and is used to configure the SNMP agent to send either traps or informs to multiple hosts. It is possible to use multiple instances of this command to specify more than one notification recipient.

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When entering the snmp-server host command, you must use this syntax:

snmp-server host <host-addr> notification [community <community>] [udp-port <port>]

Where:

•<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 UDP port number is 162.

When this command is used, you must follow it by running the snmp-server reload command to restart the SNMP agent. See the "snmp-server reload" section for additional information.

Examples

This is an example of how to use the snmp-server host command:

dpe# snmp-server host 10.10.10.5 notification community public udp-port 162
%OK (Requires SNMP server restart "> snmp-server reload")

no snmp-server host

Usage Guidelines

This command is used to remove the specified notification recipient..

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When using this command, you must use this syntax:

no snmp-server host <host-add> notification

Where:

•<host-add>—identifies the hosts IP address

When this command is used, you must follow it by running the snmp-server reload command to restart the SNMP agent. See the "snmp-server reload" section for additional information.

Examples

This is an example of how to use this command:

dpe# no snmp-server host 10.10.10.5 notification
%OK (Requires SNMP server restart "> snmp-server reload")

snmp-server reload

Usage Guidelines

This command reloads the SNMP agent process on the DPE.

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When entering this command, you must use this syntax:

snmp-server reload

Once this command is entered the SNMP agent processes that are reload are displayed.

Examples

This is an example of how to use the snmp-server reload command on a hardware DPE:

dpe# snmp-server reload
nativeSnmpAgent has been restarted
%OK
This is an example of how to use the snmp-server reload command on a Solaris DPE:

dpe# snmp-server reload
nativeSnmpAgent has been restarted
dpeSnmpAgent has been restarted
%OK

snmp-server start

Usage Guidelines

This command starts the SNMP agent process on the DPE.

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When entering this command, you must use this syntax:

snmp-server start
Examples

This is an example of how to use the snmp-server start command on a hardware DPE:

dpe# snmp-server start
nativeSnmpAgent has been started
%OK

This is an example of how to use the snmp-server start command on a Solaris DPE:

dpe# snmp-server start
nativeSnmpAgent has been started
dpeSnmpAgent has been started
%OK

snmp-server stop

Usage Guidelines

This command stops the SNMP agent process on the DPE.

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When entering this command, you must use this syntax:

snmp-server stop
Examples

This is an example of how to use the snmp-server stop command on a hardware DPE:

dpe# snmp-server stop
nativeSnmpAgent has been stopped
%OK

This is an example of how to use the snmp-server stop command on a Solaris DPE:

dpe# snmp-server stop
nativeSnmpAgent has been stopped
dpeSnmpAgent has been stopped
%OK

snmp-server contact

Usage Guidelines

This command is used to enter a string of characters that identify the system contact (sysContact) as defined in the MIB II.

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When entering this command, you must use this syntax:

snmp-server contact <text>
Where:

•<text>—identifies the contact name of whomever is responsible for the DPE

Examples

This is an example of how to use the snmp-server contact command:

dpe# snmp-server contact joe
%OK (Requires SNMP server restart "> snmp-server reload")

no snmp-server contact

Usage Guidelines

This command is used to remove the system contact that was responsible for the DPE.

Syntax Description

When entering this command, you must use this syntax:

no snmp-server contact
Examples

This is an example of how to use the no snmp-server contact command:

dpe# no snmp-server contact
%OK (Requires SNMP server restart "> snmp-server reload")

snmp-server location

Usage Guidelines

This command is used to enter a string of characters that identify the system location (sysLocation) as defined in the MIB II.

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When entering this command, you must use this syntax:

snmp-server location <text>
Where:

•<text>—identifies the physical location of the DPE

Examples

This is an example of how to use the snmp-server location command:

dpe# snmp-server location st_louis
%OK

no snmp-server location

Usage Guidelines

This command is used to remove a system location.

Syntax Description

When entering this command, you must use this syntax:

no snmp-server location
Examples

This is an example of how to use the no snmp-server location command:

dpe# no snmp-server location
%OK

snmp-server inform

Usage Guidelines

This command is used to specify the type of SNMP notification sent, from the SNMP agent, to the SNMP manager. This command may be used to send SNMP informs rather than traps, although traps are sent by default.

Note This command is used with both the hardware and Solaris DPEs.

Syntax Description

When entering this command, you must use this syntax:

snmp-server inform [retries <count> timeout <time>]
Where:

•<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 the configured number of retries is reached, the SNMP server will cease sending informs.

•<time>—Identifies the length of time (msec) that the SNMP server will continue sending informs. If the maximum number of retries is reached before the timeout expires, the SNMP server will cease sending informs.

Note Specification of both the retry count and timeout, while configuring SNMP informs, is optional and, if not specified, the default values of 1 retry and 5000 milliseconds are used.

Examples

This is an example of how to use the snmp-server inform command:

dpe# snmp-server inform retries 5 timeout 500
%OK

From this example, an SNMP inform will be sent up to a maximum of 5 times, before the retries stop. If the timeout of 500 msec expires before the 5 retries takes place, the inform is not sent again.

no snmp-server inform

Usage Guidelines

This command is used to switch the SNMP notifications that are sent to the SNMP manager, back to the default setting of traps.

Syntax Description

When entering this command, you must use this syntax:

dpe# no snmp-server inform
Examples

This is an example of how to use the no snmp-server inform command:

dpe# no snmp-server inform
%OK

snmp-server udp-port

Usage Guidelines

This command is used to identify the UDP port number that the SNMP agent listens to.

Note This command is only used in conjunction with a Solaris DPE.

This command is required by the Solaris DPE to prevent potential sharing violations between ports used by other applications. The changing of port numbers is used to resolve potential port conflict.

The SNMP agents default port number, 8001, is different from the standard well known SNMP agent port to eliminate potential port conflicts with other SNMP agents on the Solaris computer.

Note It is recommended that you change the UDP port to the well known port, number 161, for SNMP agents.

Syntax Description

When entering this command, you must use this syntax:

snmp-server udp-port <port>
Examples

This is an example of how to use the snmp-server udp-port command:

dpe# snmp-server udp-port 161
%OK

no snmp-server udp-port

Usage Guidelines

This Solaris DPE only command is used to change the port that the SNMP agent listens to, back to the default UDP port number (8001).

Note Using a port number other than the standard well known SNMP agent port number of 161, may increase the likelihood of potential port conflicts with other SNMP agents running on the same Solaris computer.

Syntax Description

When entering this command, you must use this syntax:

no snmp-server udp-port
Examples

This is an example of how to use the no snmp-server udp-port command:

dpe# no snmp-server udp-port
%OK