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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
bcfg2-admin(8) -- Perform repository administration tasks
=========================================================
## SYNOPSIS
`bcfg2-admin` [-C <configfile>] <mode> [<mode args>] [<mode options>]
## DESCRIPTION
`bcfg2-admin` is used to perform Bcfg2 repository administration
## OPTIONS
* `-C` <configfile>:
Specify alternate bcfg2.conf location.
* `-E` <encoding>:
Specify the encoding of Cfg files.
* `-Q` <repository path>:
Specify the path to the server repository.
* `-S` <https://server:port>:
Manually specify the server location (as opposed to using the value
in bcfg2.conf).
* `-d`:
Enable debugging output.
* `-h`:
Print Usage information.
* `-o` <logfile path>:
Writes a log to the specified path.
* `-v`:
Enable verbose output.
* `-x` <password>:
Use ’password’ for client communication.
* `--ssl-key=`<ssl key>:
Specifiy the path to the SSL key.
## MODES
* `backup`:
Create an archive of the entire Bcfg2 repository.
* `bundle` <action>:
Display details about the available bundles (See [`BUNDLE
OPTIONS`](###BUNDLE OPTIONS) below).
* `client` <action> <client> [attribute=value]:
Add, edit, or remove clients entries in metadata (See [`CLIENT
OPTIONS`](###CLIENT OPTIONS) below).
* `compare` <old> <new>:
Compare two client configurations. Can be used to verify consistent
behavior between releases. Determine differences between files or
directories (See [`COMPARE OPTIONS`](###COMPARE OPTIONS) below).
* `init`:
Initialize a new repository (interactive).
* `minestruct` <client> [-f xml-file] [-g groups]:
Build structure entries based on client statistics extra entries
(See [`MINESTRUCT OPTIONS`](###MINESTRUCT OPTIONS) below).
* `perf`:
Query server for performance data.
* `pull` <client> <entry-type> <entry-name>:
Install configuration information into repo based on client bad
entries (See [`PULL OPTIONS`](###PULL OPTIONS) below).
* `query` [g=group] [p=profile] [-f output-file] [-n] [-c]:
Search for clients based on group or profile (See [`QUERY
OPTIONS`](###QUERY OPTIONS) below).
* `reports` [init|load_stats|purge|scrub|update]:
Interact with the dynamic reporting system (See [`REPORTS
OPTIONS`](###REPORTS OPTIONS) below).
* `snapshots` [init|dump|query|reports]:
Interact with the Snapshots database (See [`SNAPSHOTS
OPTIONS`](###SNAPSHOTS OPTIONS) below).
* `syncdb`:
Sync the Django ORM with the configured database.
* `tidy`:
Remove unused files from repository.
* `viz` [-H] [-b] [-k] [-o png-file]:
Create a graphviz diagram of client, group and bundle information
(See [`VIZ OPTIONS`](###VIZ OPTIONS) below).
* `xcmd`:
Provides a XML-RPC Command Interface to the bcfg2-server.
### BUNDLE OPTIONS
* `mode`:
List all available xml bundles ’list-xml’ or for all available
genshi bundles ’list-genshi’. ’show’ provides an interactive
dialog to get details about the available bundles.
### CLIENT OPTIONS
* `mode`:
Add a client ’add’, delete a client ’del’, or ’list’
all client entries.
* `client`:
Specify the client’s name.
* `attribute=value`:
Set attribute values when adding a new client. Allowed attributes
are ’profile’, ’uuid’, ’password’, ’location’,
’secure’, and ’address’.
### QUERY OPTIONS
* `b=bundle`:
Specify a bundle to search for within client metadata.
* `g=group`:
Specify a group to search within.
* `p=profile`:
Specify a profile to search within.
* `-f` <output file>:
Write the results of the query to a file.
* `-n`:
Print the results, one on each line.
* `-c`:
Print the results, separated by commas.
### COMPARE OPTIONS
* `old`:
Specify the location of the old configuration file.
* `new`:
Specify the location of the new configuration file.
### MINESTRUCT OPTIONS
* `client`:
Client whose metadata is to be searched for extra entries.
* `-g` <groups>:
Hierarchy of groups in which to place the extra entries in.
* `-f` <xml output file>:
Specify the xml file in which to write the extra entries.
### PULL OPTIONS
* `client`:
Specify the name of the client to search for.
* `entry type`:
Specify the type of the entry to pull.
* `entry name`:
Specify the name of the entry to pull.
### REPORTS OPTIONS
* `init`:
Initialize the database.
* `load_stats` [-s] [-c] [-03]:
Load statistics data.
* `purge` [--client [n]] [--days [n]] [--expired]:
Purge historic and expired data.
* `scrub`:
Scrub the database for duplicate reasons and orphaned entries.
* `update`:
Apply any updates to the reporting database.
### SNAPSHOTS OPTIONS
* `init`:
Initialize the snapshots database.
* `query`:
Query the snapshots database.
* `dump`:
Dump some of the contents of the snapshots database.
* `reports` [-a] [-b] [-e] [--date=<MM-DD-YYYY>]:
Generate reports for clients in the snapshots database.
### VIZ OPTIONS
* `-H`:
Include hosts in diagram.
* `-b`:
Include bundles in diagram.
* `-o` <output file>:
Write to outfile file instead of stdout.
* `-k`:
Add a shape/color key.
## SEE ALSO
bcfg2-info(8), bcfg2-server(8)
|
