.\" -*- 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 "PMDASAMBA 1"
.TH PMDASAMBA 1 "Performance Co-Pilot" 6.2.0 "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
pmdasamba \- Samba performance metrics domain agent (PMDA)
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBpmdasamba\fR is a Performance Metrics Domain Agent (PMDA) which exports
metric values from Samba, a Windows SMB/CIFS server for UNIX.
.PP
In order for values to be made available by this PMDA, Samba must have
been built with profiling support (WITH_PROFILE in "smbd \-b" output).
This PMDA dynamically enumerates much of its metric hierarchy, based on
the contents of "smbstatus \-\-profile".
.PP
When the agent is installed (see below), the Install script will attempt
to enable Samba statistics gathering, using "smbcontrol \-\-profile".
.SH INSTALLATION
.IX Header "INSTALLATION"
If you want access to the names and values for the samba performance
metrics, do the following as root:
.PP
.Vb 2
\&        # cd $PCP_PMDAS_DIR/samba
\&        # ./Install
.Ve
.PP
If you want to undo the installation, do the following as root:
.PP
.Vb 2
\&        # cd $PCP_PMDAS_DIR/samba
\&        # ./Remove
.Ve
.PP
\&\fBpmdasamba\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/samba/Install 4
.el .IP \f(CW$PCP_PMDAS_DIR\fR/samba/Install 4
.IX Item "$PCP_PMDAS_DIR/samba/Install"
installation script for the \fBpmdasamba\fR agent
.ie n .IP $PCP_PMDAS_DIR/samba/Remove 4
.el .IP \f(CW$PCP_PMDAS_DIR\fR/samba/Remove 4
.IX Item "$PCP_PMDAS_DIR/samba/Remove"
undo installation script for the \fBpmdasamba\fR agent
.ie n .IP $PCP_LOG_DIR/pmcd/samba.log 4
.el .IP \f(CW$PCP_LOG_DIR\fR/pmcd/samba.log 4
.IX Item "$PCP_LOG_DIR/pmcd/samba.log"
default log file for error messages from \fBpmdasamba\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBpmcd\fR\|(1), \fBsamba\fR\|(7) and \fBsmbd\fR\|(8).