.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PMDAVMWARE 1"
.TH PMDAVMWARE 1 "Performance Co-Pilot" "4.3.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"
pmdavmware \- VMware performance metrics domain agent (PMDA)
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBpmdavmware\fR is a Performance Metrics Domain Agent (\s-1PMDA\s0) which exports
metric values from a (possibly remote) VMware virtualisation host.
.PP
This implementation uses the VMare Perl \s-1API\s0 (refer to the online
docs at http://www.vmware.com/support/developer/viperltoolkit).
VIPerl is a prerequisite for this \s-1PMDA,\s0 it needs to be installed
and configured before attempting to use this agent.  It is highly
recommended that you test your VIPerl installation using the
demo programs that are shipped with VIPerl, before attempting to
use this \s-1PMDA.\s0
.SH "INSTALLATION"
.IX Header "INSTALLATION"
In order to access performance data using the VIPerl \s-1API,\s0 it is
necessary to be able to login to the metrics source.  Hence, a
valid VMware server name, user name and pass word are needed by
the \s-1PMDA.\s0  These can be passed in on the command line (via the
pmcd.conf file) or via a vmware.conf file in the \s-1PMDA\s0 directory.
.PP
.Vb 2
\&        # cd $PCP_PMDAS_DIR/vmware
\&        # [ edit vmware.conf ]
.Ve
.PP
This file should contain connection information, such as:
.PP
.Vb 4
\&        $host = \*(Aqvm.host.net\*(Aq;
\&        $server = \*(Aqvm.server.net\*(Aq;
\&        $username = \*(AqXXXX\*(Aq;
\&        $password  = \*(AqYYYY\*(Aq;
.Ve
.PP
Once this is setup, you can access the names and values for the
vmware performance metrics by doing the following as root:
.PP
.Vb 2
\&        # cd $PCP_PMDAS_DIR/vmware
\&        # ./Install
.Ve
.PP
If you want to undo the installation, do the following as root:
.PP
.Vb 2
\&        # cd $PCP_PMDAS_DIR/vmware
\&        # ./Remove
.Ve
.PP
\&\fBpmdavmware\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 "FILES"
.IX Header "FILES"
.ie n .IP "$PCP_PMDAS_DIR/vmware/vmware.conf" 4
.el .IP "\f(CW$PCP_PMDAS_DIR\fR/vmware/vmware.conf" 4
.IX Item "$PCP_PMDAS_DIR/vmware/vmware.conf"
configuration file for the \fBpmdavmware\fR agent
.ie n .IP "$PCP_PMDAS_DIR/vmware/Install" 4
.el .IP "\f(CW$PCP_PMDAS_DIR\fR/vmware/Install" 4
.IX Item "$PCP_PMDAS_DIR/vmware/Install"
installation script for the \fBpmdavmware\fR agent
.ie n .IP "$PCP_PMDAS_DIR/vmware/Remove" 4
.el .IP "\f(CW$PCP_PMDAS_DIR\fR/vmware/Remove" 4
.IX Item "$PCP_PMDAS_DIR/vmware/Remove"
undo installation script for the \fBpmdavmware\fR agent
.ie n .IP "$PCP_LOG_DIR/pmcd/vmware.log" 4
.el .IP "\f(CW$PCP_LOG_DIR\fR/pmcd/vmware.log" 4
.IX Item "$PCP_LOG_DIR/pmcd/vmware.log"
default log file for error messages from \fBpmdavmware\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBpmcd\fR\|(1).