.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PMDASNMP 1"
.TH PMDASNMP 1 "Performance Co-Pilot" 6.2.1 "Performance Co-Pilot"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
pmdasnmp \- Gateway from SNMP to PCP (PMDA)
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBpmdasnmp\fR is a Performance Metrics Domain Agent (PMDA) which
provides a generic gateway from PCP queries from a PCP client to SNMP queries
to one or more SNMP agents.
.SH INSTALLATION
.IX Header "INSTALLATION"
If you want access to the SNMP gateway performance
metrics, do the following as root:
.PP
.Vb 2
\&        # cd $PCP_PMDAS_DIR/snmp
\&        # ./Install
.Ve
.PP
If you want to undo the installation, do the following as root:
.PP
.Vb 2
\&        # cd $PCP_PMDAS_DIR/snmp
\&        # ./Remove
.Ve
.PP
\&\fBpmdasnmp\fR is launched by \fBpmcd\fR\|(1) and should never be executed
directly.  The Install and Remove scripts notify \fBpmcd\fR\|(1) when
the agent is installed or removed.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
TODO: define config file format here \- map/set/host/... etc
.SH FILES
.IX Header "FILES"
.ie n .IP $PCP_PMDAS_DIR/snmp/snmp.conf 4
.el .IP \f(CW$PCP_PMDAS_DIR\fR/snmp/snmp.conf 4
.IX Item "$PCP_PMDAS_DIR/snmp/snmp.conf"
optional configuration file for \fBpmdasnmp\fR
.ie n .IP $PCP_PMDAS_DIR/snmp/Install 4
.el .IP \f(CW$PCP_PMDAS_DIR\fR/snmp/Install 4
.IX Item "$PCP_PMDAS_DIR/snmp/Install"
installation script for the \fBpmdasnmp\fR agent
.ie n .IP $PCP_PMDAS_DIR/snmp/Remove 4
.el .IP \f(CW$PCP_PMDAS_DIR\fR/snmp/Remove 4
.IX Item "$PCP_PMDAS_DIR/snmp/Remove"
undo installation script for the \fBpmdasnmp\fR agent
.ie n .IP $PCP_LOG_DIR/pmcd/snmp.log 4
.el .IP \f(CW$PCP_LOG_DIR\fR/pmcd/snmp.log 4
.IX Item "$PCP_LOG_DIR/pmcd/snmp.log"
default log file for error and \fBwarn()\fR messages from \fBpmdasnmp\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBpmcd\fR\|(1) and SNMP