C-LANG Statements › PARAMETER Statement—Specify Input Parameters (SNMP Jobs)

PARAMETER Statement—Specify Input Parameters (SNMP Jobs)

The PARAMETER statement specifies input parameters in an SNMP job.

Supported Job Types

This statement is required for the SNMP Value Set job type.

This statement is optional for the SNMP Trap Send job type.

Syntax

This statement has the following format:

PARAMETER {TYPE(snmp:type) VALUE(value)}
          {TYPE(snmp:type) ARRAY(value,value,...)}
          {[TYPE(snmp:type)] URI(uri)}

TYPE(snmp:type)

Specifies the SNMP parameter type. Options for the type include the following:

int

Specifies an integer value.

uint

Specifies an unsigned integer value.

ticks

Specifies a time ticks (measured in hundreds of a second) value.

addr

Specifies an IP address value.

Note: SNMP only supports IPv4 addresses. IPv6 addresses are not supported.

oid

Specifies an OID (object identifier) value.

string

Specifies an octet string value.

string.x

Specifies an octet string value represented in hexadecimal format.

counter32

Specifies a counter32 value. A count32 value is a non-negative integer that monotonically increases until it reaches a maximum value of 2

32

- 1 (4294967295). It then wraps around and starts increasing again from zero.

gauge32

Specifies a gauge32 value. A guage32 value is a non-negative integer that can increase or decrease, but cannot exceed a maximum value. The maximum value cannot exceed 2

32

- 1 (4294967295). The value of a Gauge has its maximum value whenever the information being modeled is greater or equal to that maximum value; if the information being modeled then decreases below the maximum value, the Gauge also decreases.

Limits: Up to 1024 characters; case-sensitive

VALUE(value)

Specifies the SNMP parameter value. The value is converted to the corresponding type. In an SNMP Trap Send job, it specifies the value of the parameter that you are passing to the trap. In an SNMP Value Set job, it specifies the new value of the variable that you are changing.

Limits: Up to 1024 characters; case-sensitive

ARRAY(value,value,...)

Specifies a set of string values for the SNMP parameter. The values are converted to the corresponding SNMP parameter type.

Limits: Up to 256 characters per array value; case-sensitive

Note: If you specify the ARRAY operand, the statement value cannot exceed 3588 characters.

URI(uri)

Specifies the location (URI) of the binary output produced by a payload producing job. A payload producing job is a job that produces binary output that is persisted as a serialized Java object. The serialized Java object is stored as a file on the agent computer. The URI can be passed as input to a payload consuming job.

Limits: Up to 255 characters; case-sensitive

Example: 'FS:c:\Program Files\Common Files\System\ADO\input.txt'

Note: For more information about retrieving the URI of a payload producing job, see the documentation for your scheduling manager.

Notes:

• Enclose values that contain delimiters (such as spaces) in double quotation marks.
• To specify multiple SNMP parameters, use multiple PARAMETER statements. Order is important. The agent passes the parameters in the order that you specify them.

Example: Specify Input Parameters in an Trap Send Job

Suppose that you want to send the cybtrapstart trap to a network device using SNMP v3. In this example, five string parameters are passed to the trap. The host name of the network device is localhost and its port is 162. The job uses the AES privacy protocol and the SHA authentication protocol. The name of the MIB file is RFC1213-MIB.mib and the default engine ID is used. The credentials of user1 are used for authorization.

AGENT SNMPAGENT
MIB 'C:\SNMP\MIBs\RFC1213-MIB.mib'
SNMPNODE cybtrapstart HOST(localhost) PORT(162) VERSION(3)
SNMPUSER user1
AUTHPROTOCOL SHA
PRIVPROTOCOL AES
ENGINEID
PARAMETER TYPE(snmp:string) VALUE(p1)
PARAMETER TYPE(snmp:string) VALUE(p2)
PARAMETER TYPE(snmp:string) VALUE(p3)
PARAMETER TYPE(snmp:string) VALUE(p4)
PARAMETER TYPE(snmp:string) VALUE(p5)

Example: Specify Input Parameter in an SNMP Value Set Job

Suppose that you want to set the value of the agentLogLevel variable to its highest level to diagnose a problem. In this example, the host name of the network device is host.example.com and its port is 161. The SNMP version is v2 and the read community is public. The name of the MIB file is RFC1213-MIB.mib, which is located on the agent computer.

AGENT SNMPAGENT
MIB 'C:\SNMP\MIBs\RFC1213-MIB.mib'
SNMPNODE agentLogLevel HOST(host.example.com) PORT(161) VERSION(2)
COMMUNITY public
PARAMETER TYPE(snmp:int) VALUE(8)