Name

nnmsnmpset.sh — issue an SNMP set request

SYNOPSIS

nnmsnmpset.sh -u user_name -p passwd [options] node object-id asnType value [object-id asnType value]...

options: [-d] [-v version] [-c write community] [-port port(default:161)] [-t timeout(default:5000)] [-r retries(default:1)] [-T] [-pp Proxy Port] [-pa Proxy Address] [-a Authentication Protocol] [-A Authentication Pass phrase] [-x Privacy Protocol] [-X Privacy Passphrase] [-N Context Name] [-v3u SNMPv3 user name] [-jndiHost hostname] [-jndiPort port Default is 1099]

DESCRIPTION

The nnmsnmpset.sh script sends an SNMP set request to alter MIB objects on the remote node.

node can be an IP-addressable system that supports SNMP, or a target name for which an SNMP proxy configuration is defined. You can identify IP nodes by an Internet address or by a hostname.

The nnmsnmpset.sh script passes data to the remote node as a triple of object-id,asnType,value. Supply one or more triples to the nnmsnmpset.sh script as command-line arguments.

Each object-id is an object instance identifier in dotted decimal format (for example, .1.3.6.1.4.1.11.2.17.2.1.0 or mnemonic string format (for example, openViewSourceId.0).

Each asnType must be one of the following asnTypes:

integer

integer32

unsigned32

octetstring

octetstringhex

octetstringoctal

octetstringascii

objectidentifier

null

ipaddress

counter

counter32

counter64 (for SNMPv2c or v3 capable remote nodes)

gauge

gauge32

timeticks

opaque

opaquehex

opaqueoctal

opaqueascii

For a complete description of each asnType, refer to RFC 1155 and RFC 1902.

The value parameter must be valid for the asnType specified. When using a asnType that requires a hexadecimal or octal value, you must fully define each byte of the value. For example, if you specify fff (or 17377), it is missing a byte, and will not work. Use 0fff (or 017377) instead. The nnmsnmpset.sh script ignores the null asnType. You must specify a value on the command line. If you try to use a null type, the nnmsnmpset.sh script ignores the null type when it creates the request. value must not be larger than 512 bytes.

Only users who belong to System, Administrator or Web Service Client roles can run the nnmsnmpset.sh script. Users who are in Level1, Level2 or Guest roles cannot run the nnmsnmpset.sh script.

Parameters

-d

Dumps all SNMP packets to standard output in a hexadecimal and decoded ASN.1 format.

-vversion

Requests the nnmsnmpset.sh script to use a specific version of SNMP to communicate with the remote node. Valid choices for version are 1, 2c, or 3.

If you do not specify the version, the nnmsnmpset.sh script uses 2c as the default for nodes not in the topology.

-cwrite community

Specifies the write community string to use for authentication on the remote node.

Note: If the community string contains characters the shell interferes with, use one or more escape symbols or quotation marks as required.

-portport

Specifies the port to use in communication with the remote node.

-ttimeout

Specifies a timeout period, in milliseconds, for communication with the remote node.

-rretries

Specifies the number of retries to use for communication with the remote node.

-T

Prints the OID in dotted decimal format and the MIB variable value with no textual conventions applied.

-ppProxy Port

Specifies the Proxy Port to use in communication with the node

-paProxy Address

Specifies the Proxy IP Address to use in communication with the node

-aAuthentication Protocol

SNMPv3 Authentication Protocol (MD5|SHA)

-AAuthentication Passphrase

SNMPv3 Authentication Passphrase

-xPrivacy Protocol

SNMPv3 Privacy Protocol (DES|3DES|AES|AES192|AES256)

-XPrivacy Passphrase

SNMPv3 Privacy Passphrase

-Ncontext

SNMPv3 Context Name (for example, vlan1)

-v3uSNMPv3 user name

SNMPv3 security name (for example, testV3user)

-u <username>

Supply the NNMi administrator username to run the script.

-p <password>

Supply the NNMi administrator password to run the script.

-jndiHost<jndiHost> (optional)

The hostname of the server running the jboss application server. If you do not specify a hostname, the nnmcommload.sh script uses localhost as the default value.

-jndiPort<jndiPort> (optional)

The jboss application server port. If you do not specify this port, the nnmcommload.sh script uses 1099 as the default value.

If the nnmsnmpset.sh script does not receive a response, it uses a linear backoff algorithm based on the timeout and retries arguments to resend the SNMP request. For example, if the timeout argument is 2000 (two seconds) and the retries argument is 3, the initial request would time out after two seconds, the first retry would time out after four seconds, the second retry would time out after six seconds, and the last retry would time out after eight seconds. The nnmsnmpset.sh script requires additional time to resolve the configuration.

EXAMPLES

The following command sets the system contact to Bob Jones for the node testnode:

nnmsnmpset.sh -c writeCommunitytestnodesystem.sysContact.0 octetstring "Bob Jones"

The output for this command is as follows:

system.sysContact.0 OCTET STRING-(ascii): Bob Jones

AUTHOR

nnmsnmpset.sh was developed by Hewlett Packard Enterprise.

FILES

install_dir\bin\nnmsnmpset.sh

install_dir\doc\rfc*.txt

SEE ALSO

nnmsnmpwalk.sh(1M), nnmsnmpbulk.sh(1M).

RFC 1155, 1157, 1212: SNMP Version 1.

RFC 1901 - 1908, 2576, 2578, 3416 - 3418: SNMP Version 2.

RFC 3411 - 3415: SNMP Version 3.

EXTERNAL INFLUENCES

Environmental Variables

$LANG determines the language in which messages appear. If $LANG is not specified or is set to an empty string, a default of C is used instead of $LANG. If any internationalization variable contains an invalid setting, nnmsnmpset.sh behaves as if all internationalization variables are set to C.

International Code Set Support

Supports single-byte and multiple-byte character code sets.

NOTE: SNMP MIB values of the asnType octetstringascii are restricted to NVT-ASCII.

Return to Reference Pages Index

Send Help Center feedback