snmpd_uea_files(4M) TCP/IP R4.11 snmpd_uea_files(4M)
NAME
snmpduea.conf - SNMP User Extensible Agent (UEA) configuration file
DESCRIPTION
Use this file to define user defined MIB objects for the SNMP UEA.
This object data can be retrieved, modified, added, or deleted by
sending an SNMP request to the appropriate node object. Requests can
also be sent directly to a user defined MIB object to invoke a
command and obtain the data generated by the command.
Users can define objects in the snmpduea.conf file by either
directly adding the object data in the correct format to the file,
stepping through a series of panels (sysadm interface), using the
admsnmpuea administration command file, or sending an SNMP SetRequest
(to define data in the snmpduea.conf file via SNMP, the
dguxUEAAllowConfigSets object in the snmpd.conf file must be set to
TRUE).
Object Records
Each object definition must appear on its own line with its different
fields separated by spaces and/or tabs. The object's fields must
appear in the order specified. Comment lines contain a "#" as the
first character in the line.
The read-cmd and write-cmd fields may either be shell scripts, DG/UX
commands, or executable programs. These fields must be surrounded by
double quotation marks ("myscript $o $i $s" or "who -a"). Preceed
any double quotation mark that is part of the command with a "\"
("echo \"hello $v\"").
UEA Object records have the following format:
object-name object-id user-id|user-name "read-cmd" "write-cmd"
object-syntax cachetimeout object-status
where:
object-name is an ASCII string of up to 64 characters specifying a
user defined MIB object name. This object name must
be unique within the snmpduea.conf file and should be
unique from all managed MIB objects. This field is
referenced as object dguxUEAEntryObjName.
object-id is an OID in dot notation format which specifies the
location of where object-name resides in the MIB tree.
This field is referenced as object dguxUEAEntryObjID.
user-id|user-name
specifies the user ID or login user name used while
executing the read-cmd and write-cmd. user-id must be
a non-negative decimal integer less than or equal to
MAXUID, as defined in <sys/param.h>. user-name must
be a valid user login name in the passwd database.
This field is referenced as object dguxUEAEntryUserID.
read-cmd is an ASCII string, delineated by double quotation
marks, of up to 256 characters specifying the command
that is executed when the agent receives an SNMP
GetRequest or GetNextRequest. If the object does not
support SNMP GetRequest and GetNextRequest, this field
should be set to "". The output of this command is
returned in the SNMP reply. This field is referenced
as object dguxUEAEntryReadCmd.
write-cmd is an ASCII string, delineated by double quotation
marks, of up to 256 characters specifying the command
that is executed when the agent receives an SNMP
SetRequest. If the object does not support SNMP
SetRequest or if the object-syntax field of the object
is set to LIST, this field should be set to "". This
field is referenced as object dguxUEAEntryWriteCmd.
object-syntax is one of: INTEGER, for object data of numeric value,
STRING, for single lines of ASCII object data (only
one line of data will be returned), LIST, for multiple
lines of ASCII object data (use for displaying
multiple lines of output data), TIMETICKS, for object
data in time format (hrs:mins:secs.millisecs), or
IPADDRESS, for object data in dot notation format
(128.222.1.2). If LIST is specified as the object-
syntax of an object, the object will not support SNMP
SetRequests. This field is referenced as object
dguxUEAEntryObjSyntax.
cachetimeout is a numeric value (0 - 43200) that represents the
maximum number of seconds since the last time the
agent received a request for objectname before the
readcommand for that object can be executed again.
If 0 seconds is specified, the readcommand is
executed every time an SNMP GetRequest or
GetNextRequest is received for objectname. This
field is referenced as object
dguxUEAEntryCacheTimeout.
object-status is one of: VALID, for valid objects that are to be
managed via SNMP, or INVALID, for invalid objects that
are not to be managed via SNMP. Objects that are
marked as INVALID will be removed from the
snmpduea.conf file the next time the UEA objects are
exported. This field is referenced as object
dguxUEAEntryStatus.
Command Arguments
The commands specified by the read-cmd and write-cmd fields may be
passed the following arguments:
$o is the OBJECT IDENTIFIER used in the request (in dot
notation).
$r is the SNMP request type (GET_REQUEST |
GET_NEXT_REQUEST | SET_REQUEST).
$i is the instance used in the request.
$s is the syntax of the object data (INTEGER | STRING |
LIST | TIMETICKS | IPADDRESS).
$v is the value of the data being set in a SetRequest.
SEE ALSO
admsnmpuea(1M), snmpd(1M), sysadm(1M), snmpdfiles(4M).
Licensed material--property of copyright holder(s)