summaryrefslogtreecommitdiffstats
path: root/man/bcfg2.1
blob: 7fb53fcd6ea145883e88ae3c90dd7b7d781f0522 (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
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
.TH "bcfg2" 1
.SH NAME
bcfg2 \- reconfigure machine based on settings in BCFG2
.SH SYNOPSIS
.B bcfg2
.I [-d] [-v] [-p] [-c cache file] [-e] [-f config file] [-I] [-q] [-b bundle]
[-r removal mode]
.SH DESCRIPTION
.TP
.BR bcfg2
Runs the bcfg2 configuration process on the current host. This process
consists of first fetching and executing probes, uploading probe
results, fetching the client configuration, checking the current
client state, attempting to install the desired configuration, and
finally uploading statistics about the bcfg2 execution and client
state.
.SH OPTIONS
.TP
.BR "\-A" 
Run in agent (continuous) mode, wait for reconfigure command from
server.
.TP
.BR "\-C <configfile>"
Specify alternate bcfg2.conf location
.TP
.BR "\-D <driver1>,<driver2>"
Specify a set of bcfg2 tool drivers. NOTE: only drivers listed will be
loaded. (IE, if you don't include POSIX, you will be unable to
verify/install ConfigFiles, etc)
.TP
.BR "\-E <encoding>"
Specify the encoding of Cfg files.
.TP
.BR "\-F <f1,f2>"
Specify the server fingerprint.
.TP
.BR "\-I"
Run bcfg2 in interactive mode.  The user will be prompted before each 
change.
.TP
.BR "\-K <SSL key file>" 
Specify the path to the SSL key.
.TP 
.BR "\-O" 
Omit lock check.
.TP 
.BR "\-P" 
Run bcfg2 in paranoid mode. Diffs will be logged for
configuration files marked as paranoid by the Bcfg2 server.
.TP
.BR "\-R <retry count>"
Specify the number of times that the client will attempt to retry
network communication.
.TP
.BR "\-s <service mode>"
Set bcfg2 interaction level for services. Default behavior is to modify all services effected by reconfiguration. build mode attempts to stop all services started. disabled suppresses all attempts to modify services. 
.TP
.BR "\-S https://server:port"
Manually specify the server location (as opposed to using the value in
bcfg2.conf).
.TP
.BR "\-b <bundle1>:<bundle2>"
Run bcfg2 against one or multiple bundles in the configuration.
.TP
.BR "\-c <cachefile>"
Cache a copy of the configuration in cachefile
.TP
.BR "\-d" 
Run bcfg2 in debug mode.
.TP 
.BR "\-e" 
When in verbose mode, display extra entry information (temporary until
verbosity rework)
.TP
.BR "\-f <specification path>" 
Configure from a file rather than querying the server.
.TP 
.BR "\-g <agent port>" 
Allows you to specify which port to bind.
.TP 
.BR "\-h" 
Print Usage information.
.TP 
.BR "\-i" 
Daemonize the agent.
.TP 
.BR "\-k" 
Run in bulletproof mode. This currently only effect behavior in the
debian toolset; it calls apt-get update and clean and dpkg --configure --pending.
.TP
.BR "\-l <whitelist|blacklist>"
Run the client in the server decision list mode. This approach is needed
when particular changes are deemed "high risk". It gives the ability to
centrally specify these changes, but only install them on clients when
administrator supervision is available. Because collaborative
configuration is one of the remaining hard issues in configuration
management, these issues typically crop up in environments with several
administrators and much configuration variety.
.TP
.BR "\-n"
Run bcfg2 in dry-run mode. No changes will be made to the
system. 
.TP
.BR "\-o <LogFile Path>"
Writes a log to the specified path.
.TP
.BR "\-p <profile>" 
Assert a profile for the current client.
.TP
.BR "\-q"
Run bcfg2 in quick mode. Package checksum verification won't be
performed. This mode relaxes the constraints of correctness, and thus
should only be used in safe conditions. 
.TP
.BR "\-r <mode>" 
Cause bcfg2 to remove extra configuration elements it detects. Mode is one of all, Services, or Packages. All removes all entries. Likewise, Services and Packages remove only the extra configuration elements of the respective type.
.TP
.BR "\-u <user>" 
Attempt to authenticate as 'user'.
.TP
.BR "\-x <password>" 
Use 'password' for client communication.
.TP
.BR "\-v"
Run bcfg2 in verbose mode.
.RE
.SH "SEE ALSO"
.BR bcfg2-server(8),
.BR bcfg2-info(8)
.SH "BUGS"