11 SNMP Utilities

This chapter describes the syntax and parameters for the AGENT++ SNMP utilities that are installed with Oracle Communications Billing and Revenue Management (BRM).

Note:

The snmpTrap and snmpInform utilities are not supported.

Important:

Because the AGENT++ SNMP implementation uses dynamic OIDs, you cannot use symbolic SNMP names in SNMP commands. For example, instead of using this command:
snmpWalk <hostname> 10.196.129.31
portal.components.mtf.connectionConfigurations.dmoTable.dmoEntry –P20761 -S

You must use this:

snmpWalk <hostname> 10.196.129.31 1.3.6.1.4.1.3512.1.5.2.2.1 –P20761 -S

For more information about SNMP commands and options, see the SNMP documentation provided by your OS vendor.

snmpBulk

Retrieves a subtree of OIDs. Uses the SNMPv2 GETBULK request to retrieve information from an SNMPv2C agent. If the node is an SNMPv1-only agent, this utility automatically turns the GETBULK request into an SNMPv1-supported GETNEXT request.

Syntax

snmpBulk IP_address | DNS_name [OID1 [OID2...]] [option1 [option2...]]

Parameters

IP_Address | DNS_Name

The location of the SNMP process.

OID

Specifies which part of the MIB is searched. All objects in the subtree below the given OID are queried.

The default is sysDescr (description of the host on which the SNMP agent is running).

options

Can be any of the following, separated by a space:

  • -vN

    Use SNMP version 1, 2, or 3. The default is 1.

  • -Pport

    Remote port to use.

  • -Ccommunity_name

    Specifies the community. The default is public.

  • -rN

    Specifies the number of retries to be used in the requests. The default is 1.

  • -tN

    Specifies the timeout in hundredths of a second between retries. The default is 100.

  • -nN

    Specifies nonrepeaters (number of object instances that should be retrieved no more than once from the beginning of the request. The default is 0.

  • -mN

    The maximum number of times that other variables beyond those specified by the nonrepeaters field should be retrieved). The default is 1.

snmpDiscover

Broadcasts a network discovery request to find out if the SNMP master agent is running.

Syntax

snmpDiscover Broadcast_IP_address [option1 [option2...]]

Parameters

Broadcast_IP_address

IP address of the network.

options

Can be any of the following, separated by a space:

  • -vN

    Use SNMP version 1, 2, or 3. The default is 1.

  • -Pport

    Remote port to use.

  • -Ccommunity_name

    Specifies the community. The default is public.

  • -rN

    Specifies the number of retries to be used in the requests. The default is 1.

snmpGet

Uses the SNMP GET request to query for information on a network entity.

Syntax

snmpGet IP_address | DNS_name [OID] [option1 [option2...]]

Parameters

IP_Address | DNS_Name

The location of the SNMP process.

OID

Specifies which part of the MIB is searched. All objects in the subtree below the given OID are queried.

The default is sysDescr (description of the host on which the SNMP agent is running).

options

Can be any of the following, separated by a space:

  • -vN

    Use SNMP version 1, 2, or 3. The default is 1.

  • -Pport

    Remote port to use.

  • -Ccommunity_name

    Specifies the community. The default is public.

  • -rN

    Specifies the number of retries to be used in the requests. The default is 1.

  • -tN

    Specifies the timeout in hundredths of a second between retries. The default is 100.

snmpNext

Gets data about the next object in the MIB. This utility sends an SNMP GETNEXT request to the master agent and waits for a response back before it proceeds.

Syntax

snmpNext IP_address | DNS_name [OID] [option1 [option2...]]

Parameters

IP_address | DNS_name

The location of the SNMP process.

OID

Specifies which part of the MIB is searched. All objects in the subtree below the given OID are queried.

The default is sysDescr (description of the host on which the SNMP agent is running).

options

Can be any of the following, separated by a space:

  • -vN

    Use SNMP version 1, 2, or 3. The default is 1.

  • -Pport

    Remote port to use.

  • -Ccommunity_name

    Specifies the community. The default is public.

  • -rN

    Specifies the number of retries to be used in the requests. The default is 1.

  • -tN

    Specifies the timeout in hundredths of a second between retries. The default is 100.

snmpNextAsync

Gets data about the next object in the MIB. This utility sends an SNMP GETNEXT request to the master agent and receives the response from a callback function. The main process does not have to wait for the response before it proceeds.

Syntax

snmpNextAsync IP_address | DNS_name [OID] [option1 [option2...]]

Parameters

IP_address | DNS_name

The location of the SNMP process.

OID

Specifies which part of the MIB is searched. All variables in the subtree below the given OID are queried.

The default is sysDescr (description of the host on which the SNMP agent is running).

options

Can be any of the following, separated by a space:

  • -vN

    Use SNMP version 1, 2, or 3. The default is 1.

  • -Pport

    Remote port to use.

  • -Ccommunity_name

    Specifies the community. The default is public.

  • -rN

    Specifies the number of retries to be used in the requests. The default is 1.

  • -tN

    Specifies the timeout in hundredths of a second between retries. The default is 100.

snmpPasswd

Sets a password.

Syntax

snmpPasswd IP_address | DNS_name user new_password [option1 [option2...]]

Parameters

IP_address | DNS_name

The location of the SNMP process.

user

The user name.

new_password

The new password.

options

Can be any of the following, separated by a space:

  • -vN

    Use SNMP version 1, 2 or 3. The default is 1.

  • -Pport

    Remote port to use.

  • -Ccommunity_name

    Specifies the community. The default is public.

  • -rN

    Specifies the number of retries to be used in the requests. The default is 1.

  • -tN

    Specifies the timeout in hundredths of a second between retries. The default is 100.

snmpSet

Sets a value in an object.

Syntax

snmpSet IP_address | DNS_name [OID] [option1 [option2...]]

Parameters

IP_address | DNS_name

The location of the SNMP process.

OID

Specifies which part of the MIB is searched. All objects in the subtree below the given OID are queried.

The default is sysDescr (description of the host on which the SNMP agent is running).

options

Can be any of the following, separated by a space:

  • -vN

    Use SNMP version 1, 2, or 3. The default is 1.

  • -Pport

    Remote port to use.

  • -Ccommunity_name

    Specifies the community. The default is public.

  • -Gcommunity_name

    Specifies the GET community. The default is the SET community value.

  • -rN

    Specifies the number of retries to be used in the requests. The default is 1.

  • -tN

    Specifies the timeout in hundredths of a second between retries. The default is 100.

snmpWalk

Retrieves a subtree of OIDs.

Syntax

snmpWalk IP_address | DNS_name [OID] [option1 [option2...]]

Parameters

IP_address | DNS_name

The location of the SNMP process.

OID

Specifies which part of the MIB is searched. All objects in the subtree below the given OID are queried.

The default is sysDescr (description of the host on which the SNMP agent is running).

options

Can be any of the following, separated by a space:

  • -vN

    Use SNMP version 1, 2, or 3. The default is 1.

  • -Pport

    Remote port to use.

  • -S

    Walk only within the subtree.

  • -Ccommunity_name

    Specifies the community. The default is public.

  • -rN

    Specifies the number of retries to be used in the requests. The default is 1.

  • -tN

    Specifies the timeout in hundredths of a second between retries. The default is 100.

snmpWalkThreads

Retrieves a subtree of OIDs. The start OID is 1.

This utility gets all OID values from one or multiple SNMP master agents (one master agent per thread when processing the SNMP WALK request). snmpWalk gets the values on a subtree of OIDs from one SNMP master agent.

Syntax

snmpWalkThreads host/port [host/port ...] [option1 [option2...]]

Parameters

host/port

Host name and port of the system you are getting information about.

options

Can be any of the following, separated by a space:

  • -vN

    Use SNMP version 1, 2, or 3. The default is 1.

  • -Pport

    Remote port to use.

  • -Ccommunity_name

    Specifies the community. The default is public.

  • -rN

    Specifies the number of retries to be used in the requests. The default is 1.

  • -tN

    Specifies the timeout in hundredths of a second between retries. The default is 100.