summaryrefslogtreecommitdiffstats
path: root/tools/manpagegen/bcfg2-reports.8.ronn
blob: 1cb999dc717830d6d7ef61f26d8c4987993cc2c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
bcfg2-reports(8) -- Query reporting system for client status
============================================================

## SYNOPSIS

`bcfg2-reports` [-a] [-b <NAME>] [-c] [-d] [-e <NAME>] [-h] [-m <NAME>]
[-s <NAME>] [-x <NAME>] [--badentry=<KIND,NAME>]
[--extraentry=<KIND,NAME>] [--fields=<ARG1,ARG2,...>]
[--modifiedentry=<KIND,NAME>] [--sort=<ARG1,ARG2,...>] [--stale] [-v]

## DESCRIPTION

`bcfg2-reports` 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
`/src/lib/Server/Reports/reports/models.py`.

## OPTIONS

  * `-a`:
    Specify alternate bcfg2.conf location

  * `-b` <hostname>:
    Single host mode - shows bad entries from the current interaction of
    *hostname*.

  * `-c`:
    Shows only clean hosts.

  * `-d`:
    Shows only dirty hosts.

  * `-e` <hostname>:
    Single host mode - shows extra entries from the current interaction
    of *hostname*.

  * `-h`:
    Shows help and usage info about `bcfg2-reports`.

  * `-m` <hostname>:
    Single host mode - shows modified entries from the current
    interaction of *hostname*.

  * `-s` <hostname>:
    Single host mode - shows bad, modified, and extra entries from the
    current interaction of *hostname*.

  * `-x` <hostname>:
    Toggles expired/unexpired state of *hostname*.

  * `--badentry=`<entry type, entry name>:
    Shows only hosts whose current interaction has bad entries of type
    *entry type* and name *entry name*. If a single argument ARG1 is
    given, then *entry type*,*entry name* pairs will be read from a file
    of name ARG1.

  * `--extraentry=`<entry type, entry name>:
    Shows only hosts whose current interaction has extra entries of type
    *entry type* and name *entry name*. If a single argument ARG1 is
    given, then *entry type*,*entry name* pairs will be read from a file
    of name ARG1.

  * `--fields=`<ARG1,ARG2,...>:
    Only displays the fields *ARG1,ARG2,...* (name, time, state, total,
    good, bad).

  * `--modifiedentry=`<entry type, entry name>:
    Shows only hosts whose current interaction has modified entries of
    type *entry type* and name *entry name*. If a single argument ARG1
    is given, then *entry type*,*entry name* pairs will be read from a
    file of name ARG1.

  * `--sort=`<ARG1,ARG2,...>:
    Sorts output on ARG1,ARG2,... (name, time, state, total, good, bad).

  * `--stale`:
    Shows hosts which haven’t run in the last 24 hours.

## SEE ALSO

bcfg2(1), bcfg2-server(8)