.TH "BCFG2-REPORTS" "8" "March 18, 2013" "1.3" "Bcfg2"
.SH NAME
bcfg2-reports \- Query reporting system for client status
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.sp
\fBbcfg2\-reports\fP [\-a] [\-b \fINAME\fP] [\-c] [\-d] [\-e \fINAME\fP] [\-h]
[\-m \fINAME\fP] [\-s \fINAME\fP] [\-x \fINAME\fP] [\-\-badentry=\fIKIND,NAME\fP]
[\-\-extraentry=\fIKIND,NAME\fP] [\-\-fields=\fIARG1,ARG2,...\fP]
[\-\-modifiedentry=\fIKIND,NAME\fP] [\-\-sort=\fIARG1,ARG2,...\fP] [\-\-stale] [\-v]
.SH DESCRIPTION
.sp
\fBbcfg2\-reports\fP allows you to retrieve data from the database
about clients, and the states of their current interactions. It also
allows you to change the expired/unexpired states. The utility runs as a
standalone application. It does, however, use the models from
\fBsrc/lib/Bcfg2/Reporting/models.py\fP.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-h
Print usage information.
.UNINDENT
.SH MODES
.sp
The following are various modes available for \fBbcfg2\-reports\fP.
.SS Single\-Host Modes
.INDENT 0.0
.TP
.BI \-b,  \-\-bad \ hostname
Shows bad entries from the current
interaction of \fIhostname\fP.
.TP
.BI \-e,  \-\-extra \ hostname
Shows extra entries from the current
interaction of \fIhostname\fP.
.TP
.BI \-m,  \-\-modified \ hostname
Shows modified entries from the current
interaction of \fIhostname\fP.
.TP
.BI \-s,  \-\-show \ hostname
Shows bad, modified, and extra entries from
the current interaction of \fIhostname\fP.
.TP
.BI \-t,  \-\-total \ hostname
Shows total number of managed and good
entries from the current interaction of
\fIhostname\fP.
.TP
.BI \-x,  \-\-expire \ hostname
Toggles expired/unexpired state of
\fIhostname\fP.
.TP
.B \-a,  \-\-all
Show all hosts, including expired hosts.
.UNINDENT
.SS Host Selection Modes
.INDENT 0.0
.TP
.B \-a,  \-\-all
Show all hosts, including expired hosts.
.TP
.B \-c,  \-\-clean
Show only clean hosts.
.TP
.B \-d,  \-\-dirty
Show only dirty hosts.
.TP
.B \-\-stale
Show hosts that haven\(aqt run in the last 24 hours.
.UNINDENT
.SS Entry Modes
.sp
The following mode flags require either a comma\-delimited list of any
number of \fI<entry type>:<entry name>\fP arguments describing entries, or
the \fI\-\-file\fP option.
.INDENT 0.0
.TP
.BI \-\-badentry\fB= entrylist
Shows only hosts whose current interaction
has bad entries matching the given entry or
entries.
.TP
.BI \-\-extraentry\fB= entrylist
Shows only hosts whose current interaction
has extra entries matching the given entry
or entries.
.TP
.BI \-\-entrystatus\fB= entry
Shows the status of the single entry (given
by \fI<entry type>:<entry name>\fP) on all
hosts.
.TP
.BI \-\-modifiedentry\fB= entrylist
Shows only hosts whose current interaction
has modified entries matching the given
entry or entries.
.UNINDENT
.SS Entry Options
.sp
The following options can be used with the above Entry Modes.
.INDENT 0.0
.TP
.BI \-\-fields\fB= fields
Only display the listed fields.  Takes a
comma\-delimited list of field names
.TP
.BI \-\-file\fB= file
Read \fI<entry type>:<entry name>\fP pairs from the
specified file instead of the command line.
.UNINDENT
.SH SEE ALSO
.sp
\fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
.\" Generated by docutils manpage writer.
.