naaagt(1M) naaagt(1M)
NAME [Toc] [Back]
naaagt - Native Agent Adapter (NAA)
SYNOPSIS [Toc] [Back]
export HP_NAA_CNF=naaCnf
export HP_NAA_PORT=snmpPort
export HP_NAA_GET_COMMUNITY=community
/usr/sbin/naaagt [-K] [-n] [-E priority] [-m logMask] ...
/usr/sbin/naaagt { -h | -help }
DESCRIPTION [Toc] [Back]
The Native Agent Adapter (naaagt) allows third-party SNMP agents to
work with the HP SNMP Master Agent (snmpdm).
The Native Agent Adapter runs as a subagent to the HP SNMP Master
Agent. naaagt reads the naaCnf file (see the HP_NAA_CNF environment
variable, described below), and it registers each object identifier
(OID) with snmpdm. See the naaCnf File Format section.
After registration is complete, naaagt receives SNMP requests from
snmpdm and forwards them to a non-standard UDP port on the same system
(see the HP_NAA_PORT environment variable, described below). naaagt
also receives SNMP responses from the third-party SNMP agent, which is
listening to the non-standard UDP port, and naaagt forwards the
responses to snmpdm.
The third-party SNMP agent must listen to the same non-standard UDP
port that naaagt sends to (HP_NAA_PORT), not the standard SNMP port
number (161). Refer to third-party documentation for instructions on
how to accomplish this. The third-party SNMP agent can be started
before or after starting naaagt.
Parameters [Toc] [Back]
-E priority Sets the registration priority. If two subagents
register the same OIDs, requests are sent to the
subagent with the highest priority or to the subagent
with the same priority that was the last to register.
The priority range is zero (high) to 255 (low).
Default: zero.
-K Causes the Native Agent Adapter (naaagt) to continue to
run, even if the HP SNMP Master Agent (snmpdm)
terminates. When snmpdm subsequently restarts, naaagt
will re-establish communication with snmpdm and reregister
its OIDs. This option is recommended if the
IndependentStart-up procedure is used, described below.
By default, naaagt terminates automatically when snmpdm
Hewlett-Packard Company - 1 - HP-UX 11i Version 2: August 2003
naaagt(1M) naaagt(1M)
terminates.
Troubleshooting Parameters [Toc] [Back]
-h
-help Displays usage information.
-m logMask Sets the logging mask. logMask may be one of the
following names: APWARN, APERROR, APTRACE, APALL, or
APNONE. Multiple logging options can be specified by
repeating the -m option. Logging data is written to
the SNMP log file, /var/adm/snmpd.log. Default:
APNONE.
-n Causes naaagt to run in foreground. By default, naaagt
runs in the background.
Native Agent Adapter Start-up [Toc] [Back]
The Native Agent Adapter start-up procedure may be provided by the
vendor of the third-party SNMP agent. Refer to third-party
documentation for instructions.
Automatic Start-up [Toc] [Back]
The third-party SNMP agent and its Native Agent Adapter can be started
and stopped automatically during system start-up and shutdown. This
is accomplished by providing a start-up/shutdown script under the
/sbin/init.d directory, with symbolic links to it under an appropriate
/sbin/rcN.d directory. See the rc(1M) man page for details. See the
IndependentStart-up section for procedures for starting naaagt.
Manual Start-up [Toc] [Back]
The third-party SNMP agent and its Native Agent Adapter can be started
using the /usr/sbin/snmpd command by providing start-up and shutdown
scripts under /sbin/SnmpAgtStart.d. Normally, those scripts are
merely symbolic links to the automatic start-up/shutdown script under
/sbin/init.d, following the same naming conventions documented in the
rc(1M) manual page. These scripts are executed by the /usr/sbin/snmpd
command. See the IndependentStart-up section for procedures for
starting naaagt.
Independent Start-up [Toc] [Back]
The third-party SNMP agent and its Native Agent Adapter can be started
by entering commands directly or by executing an arbitrary script.
When this approach is used, the naaagt-K option should probably be
used because the third-party agent and adapter will not be restarted
by the /usr/sbin/snmpd command.
The following procedure should be used to start naaagt for each
third-party agent.
Hewlett-Packard Company - 2 - HP-UX 11i Version 2: August 2003
naaagt(1M) naaagt(1M)
+ Export HP_NAA_PORT, which must be set to a unique port number.
+ Export HP_NAA_CNF, which must be set to an absolute path name
for a third-party-specific naaCnf file. Create the naaCnf
file; refer to third-party documentation for a list of the
OIDs that are instrumented by the third-party SNMP agent.
+ Export HP_NAA_GET_COMMUNITY, which must be set to the
community name to be used in SNMP requests forwarded from
naaagt to the third-party SNMP agent. This environment
variable is required only if the third-party agent is
configured to use a community name other than the default
("public").
+ Create a unique symbolic link to /usr/sbin/naaagt. This makes
it convenient to distinguish each Native Agent Adapter in
output from the ps -ef command. Execute the symbolic link to
start naaagt.
+ Start the third-party SNMP agent, following procedures in the
third-party documentation. This can be done before or after
starting naaagt.
naaCnf File Format
The naaCnf file consists of a list of numeric object identifiers
(OIDs), one OID per line. Each OID is a subtree of MIB variables that
are instrumented by the third-party SNMP agent. Refer to third-party
documentation for the list of OIDs. Blank lines and lines beginning
with "#" are treated as comments. Leading and trailing spaces on a
line are ignored. The OID can start with an optional period.
Example [Toc] [Back]
# RDBMS MIB (with leading period)
.1.3.6.1.2.1.39
# Third-party Private MIB (without leading period)
1.3.6.1.4.1.111
# application/applTable MIB
1.3.6.1.2.1.27.1.1
EXTERNAL INFLUENCES [Toc] [Back]
Environment Variables
HP_NAA_CNF The absolute path name for the naaCnf file
from which the Native Agent Adapter reads the
OIDs to be registered for its third-party SNMP
agent. Default (not recommended):
/etc/SnmpAgent.d/naa.cnf.
HP_NAA_GET_COMMUNITY The community name that the Native Agent
Adapter uses in SNMP requests forwarded to the
third-party SNMP agent. Note that this does
Hewlett-Packard Company - 3 - HP-UX 11i Version 2: August 2003
naaagt(1M) naaagt(1M)
not have to match any community names accepted
by the SNMP Master Agent, which are defined in
/etc/SnmpAgent.d/snmpd.conf. This environment
variable is required only if the standard
community name ("public") is not accepted by
the third-party SNMP agent. Refer to thirdparty
documentation for instructions regarding
SNMP community names. Default: public.
HP_NAA_PORT The non-standard UDP port number to which the
Native Agent Adapter forwards SNMP requests to
the third-party SNMP agent. This must match
the port number that the third-party agent
listens to instead of the standard SNMP port
(161). Each third-party SNMP agent must
listen to a different non-standard UDP port
number. Default: 8161.
International Code Set Support [Toc] [Back]
Supports single-byte character code sets except where the SNMP
protocol supports only 7-bit characters encoded in ASCII.
WARNINGS [Toc] [Back]
The Native Agent Adapter only supports SNMP read requests (for
example, SNMP Get). SNMP Set requests must be sent directly to the
third-party SNMP agent's non-standard UDP port (HP_NAA_PORT).
If the HP_NAA_PORT value is not a valid port number, naaagt terminates
without writing any error message either to the display or to
/var/adm/snmpd.log.
If there are no valid OIDs in the naaCnf file, naaagt terminates. It
does not register a default OID.
There may be unexpected results if the -E priority is outside the
valid range.
AUTHOR [Toc] [Back]
naaagt was developed by SNMP Research and Hewlett-Packard Company.
FILES [Toc] [Back]
/etc/SnmpAgent.d/naa.cnf Default naaCnf file. Not recommended.
/sbin/SnmpAgtStart.d Directory for SNMP start-up and shutdown
scripts.
/usr/sbin/naaagt Native Agent Adapter command.
/usr/sbin/snmpdm HP SNMP Master Agent command.
Hewlett-Packard Company - 4 - HP-UX 11i Version 2: August 2003
naaagt(1M) naaagt(1M)
/var/adm/snmpd.log HP SNMP log file.
SEE ALSO [Toc] [Back]
rc(1M), snmpd(1M), snmpd.conf(4).
Hewlett-Packard Company - 5 - HP-UX 11i Version 2: August 2003 [ Back ] |