summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/bcfg2-admin.866
-rw-r--r--man/bcfg2-crypt.883
-rw-r--r--man/bcfg2-ping-sweep.814
-rw-r--r--man/bcfg2.116
4 files changed, 152 insertions, 27 deletions
diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8
index 075aad13d..bed51ff9a 100644
--- a/man/bcfg2-admin.8
+++ b/man/bcfg2-admin.8
@@ -1,5 +1,5 @@
.
-.TH "BCFG2\-ADMIN" "8" "July 2012" "" ""
+.TH "BCFG2\-ADMIN" "8" "August 2012" "" ""
.
.SH "NAME"
\fBbcfg2\-admin\fR \- Perform repository administration tasks
@@ -14,13 +14,45 @@
.
.TP
\fB\-C\fR \fIconfigfile\fR
-Specify alternate bcfg2\.conf location
+Specify alternate bcfg2\.conf location\.
.
-.SH "MODES"
+.TP
+\fB\-E\fR \fIencoding\fR
+Specify the encoding of Cfg files\.
.
.TP
-\fBinit\fR
-Initialize a new repository (interactive)\.
+\fB\-Q\fR \fIrepository path\fR
+Specify the path to the server repository\.
+.
+.TP
+\fB\-S\fR \fIhttps://server:port\fR
+Manually specify the server location (as opposed to using the value in bcfg2\.conf)\.
+.
+.TP
+\fB\-d\fR
+Enable debugging output\.
+.
+.TP
+\fB\-h\fR
+Print Usage information\.
+.
+.TP
+\fB\-o\fR \fIlogfile path\fR
+Writes a log to the specified path\.
+.
+.TP
+\fB\-v\fR
+Enable verbose output\.
+.
+.TP
+\fB\-x\fR \fIpassword\fR
+Use ’password’ for client communication\.
+.
+.TP
+\fB\-\-ssl\-key=\fR\fIssl key\fR
+Specifiy the path to the SSL key\.
+.
+.SH "MODES"
.
.TP
\fBbackup\fR
@@ -35,22 +67,30 @@ Display details about the available bundles (See \fI\fBBUNDLE OPTIONS\fR\fR belo
Add, edit, or remove clients entries in metadata (See \fI\fBCLIENT OPTIONS\fR\fR below)\.
.
.TP
-\fBquery\fR [g=group] [p=profile] [\-f output\-file] [\-n] [\-c]
-Search for clients based on group or profile (See \fI\fBQUERY OPTIONS\fR\fR below)\.
-.
-.TP
\fBcompare\fR \fIold\fR \fInew\fR
Compare two client configurations\. Can be used to verify consistent behavior between releases\. Determine differences between files or directories (See \fI\fBCOMPARE OPTIONS\fR\fR below)\.
.
.TP
+\fBinit\fR
+Initialize a new repository (interactive)\.
+.
+.TP
\fBminestruct\fR \fIclient\fR [\-f xml\-file] [\-g groups]
Build structure entries based on client statistics extra entries (See \fI\fBMINESTRUCT OPTIONS\fR\fR below)\.
.
.TP
+\fBperf\fR
+Query server for performance data\.
+.
+.TP
\fBpull\fR \fIclient\fR \fIentry\-type\fR \fIentry\-name\fR
Install configuration information into repo based on client bad entries (See \fI\fBPULL OPTIONS\fR\fR below)\.
.
.TP
+\fBquery\fR [g=group] [p=profile] [\-f output\-file] [\-n] [\-c]
+Search for clients based on group or profile (See \fI\fBQUERY OPTIONS\fR\fR below)\.
+.
+.TP
\fBreports\fR [init|load_stats|purge|scrub|update]
Interact with the dynamic reporting system (See \fI\fBREPORTS OPTIONS\fR\fR below)\.
.
@@ -59,6 +99,10 @@ Interact with the dynamic reporting system (See \fI\fBREPORTS OPTIONS\fR\fR belo
Interact with the Snapshots database (See \fI\fBSNAPSHOTS OPTIONS\fR\fR below)\.
.
.TP
+\fBsyncdb\fR
+Sync the Django ORM with the configured database\.
+.
+.TP
\fBtidy\fR
Remove unused files from repository\.
.
@@ -66,6 +110,10 @@ Remove unused files from repository\.
\fBviz\fR [\-H] [\-b] [\-k] [\-o png\-file]
Create a graphviz diagram of client, group and bundle information (See \fI\fBVIZ OPTIONS\fR\fR below)\.
.
+.TP
+\fBxcmd\fR
+Provides a XML\-RPC Command Interface to the bcfg2\-server\.
+.
.SS "BUNDLE OPTIONS"
.
.TP
diff --git a/man/bcfg2-crypt.8 b/man/bcfg2-crypt.8
new file mode 100644
index 000000000..a73f3e066
--- /dev/null
+++ b/man/bcfg2-crypt.8
@@ -0,0 +1,83 @@
+.
+.TH "BCFG2\-CRYPT" "8" "August 2012" "" ""
+.
+.SH "NAME"
+\fBbcfg2\-crypt\fR \- Bcfg2 encryption and decryption utility
+.
+.SH "SYNOPSIS"
+\fBbcfg2\-crypt\fR [\fI\-C configfile\fR] [\-\-decrypt|\-\-encrypt] [\-\-cfg|\-\-properties] [\-\-remove] [\-\-xpath \fIxpath\fR] [\-p \fIpassphrase\-or\-name\fR] [\-v] \fIfilename\fR [\fIfilename\fR\.\.\.]
+.
+.SH "DESCRIPTION"
+\fBbcfg2\-crypt\fR performs encryption and decryption of Cfg and Properties files\. It\'s often sufficient to run \fBbcfg2\-crypt\fR with only the name of the file you wish to encrypt or decrypt; it can usually figure out what to do\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-C\fR \fIconfigfile\fR
+Specify alternate bcfg2\.conf location
+.
+.TP
+\fB\-\-decrypt\fR, \fB\-\-encrypt\fR
+Specify which operation you\'d like to perform\. \fBbcfg2\-crypt\fR can usually determine which is necessary based on the contents of each file\.
+.
+.TP
+\fB\-\-cfg\fR
+Tell \fBbcfg2\-crypt\fR that an XML file should be encrypted in its entirety rather than element\-by\-element\. This is only necessary if the file is an XML file whose name ends with \fB\.xml\fR and whose top\-level tag is \fB<Properties>\fR\. See \fIMODES\fR below for details\.
+.
+.TP
+\fB\-\-properties\fR
+Tell \fBbcfg2\-crypt\fR to process a file as an XML Properties file, and encrypt the text of each element separately\. This is necessary if, for example, you\'ve used a different top\-level tag than \fB<Properties>\fR in your Properties files\. See \fIMODES\fR below for details\.
+.
+.TP
+\fB\-\-remove\fR
+Remove the plaintext file after it has been encrypted\. Only meaningful for Cfg files\.
+.
+.TP
+\fB\-\-xpath <xpath>\fR
+Encrypt the character content of all elements that match the specified XPath expression\. The default is \fB*[@encrypted]\fR or \fB*\fR; see \fIMODES\fR below for more details\. Only meaningful for Properties files\.
+.
+.TP
+\fB\-p <passphrase>\fR
+Specify the name of a passphrase specified in the \fB[encryption]\fR section of \fBbcfg2\.conf\fR\. See \fISELECTING PASSPHRASE\fR below for more details\.
+.
+.TP
+\fB\-v\fR
+Be verbose\.
+.
+.TP
+\fB\-h\fR
+Display help and exit\.
+.
+.SH "MODES"
+\fBbcfg2\-crypt\fR can encrypt Cfg files or Properties files; they are handled very differently\.
+.
+.TP
+Cfg
+When \fBbcfg2\-crypt\fR is used on a Cfg file, the entire file is encrypted\. This is the default behavior on files that are not XML, or that are XML but whose top\-level tag is not \fB<Properties>\fR\. This can be enforced by use of the \fB\-\-cfg\fR option\.
+.
+.TP
+Properties
+When \fBbcfg2\-crypt\fR is used on a Properties file, it encrypts the character content of elements matching the XPath expression given by \fB\-\-xpath\fR\. By default the expression is \fB*[@encrypted]\fR, which matches all elements with an \fBencrypted\fR attribute\. If you are encrypting a file and that expression doesn\'t match any elements, then the default is \fB*\fR, which matches everything\. When \fBbcfg2\-crypt\fR encrypts the character content of an element, it also adds the \fBencrypted\fR attribute, set to the name of the passphrase used to encrypt that element\. When it decrypts an element it does not remove \fBencrypted\fR, though; this lets you easily and efficiently run \fBbcfg2\-crypt\fR against a single Properties file to encrypt and decrypt it without needing to specify a long list of options\. See the online Bcfg2 docs on Properties files for more information on how this works\.
+.
+.SH "SELECTING PASSPHRASE"
+The passphrase used to encrypt or decrypt a file is discovered in the following order:
+.
+.IP "\(bu" 4
+First, the passphrase given on the command line using \fB\-p\fR is used\.
+.
+.IP "\(bu" 4
+Next, if exactly one passphrase is specified in \fBbcfg2\.conf\fR, it will be used\.
+.
+.IP "\(bu" 4
+Next, if operating in Properties mode, \fBbcfg2\-crypt\fR will attempt to read the name of the passphrase from the encrypted elements\.
+.
+.IP "\(bu" 4
+Next, if decrypting, all passphrases will be tried sequentially\.
+.
+.IP "\(bu" 4
+If no passphrase has been determined at this point, an error is produced and the file being encrypted or decrypted is skipped\.
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+bcfg2\-server(8)
diff --git a/man/bcfg2-ping-sweep.8 b/man/bcfg2-ping-sweep.8
deleted file mode 100644
index 709f0eed6..000000000
--- a/man/bcfg2-ping-sweep.8
+++ /dev/null
@@ -1,14 +0,0 @@
-.
-.TH "BCFG2\-PING\-SWEEP" "8" "June 2012" "" ""
-.
-.SH "NAME"
-\fBbcfg2\-ping\-sweep\fR \- Update pingable and pingtime attributes in clients\.xml
-.
-.SH "SYNOPSIS"
-\fBbcfg2\-ping\-sweep\fR
-.
-.SH "DESCRIPTION"
-\fBbcfg2\-ping\-sweep\fR traverses the list of clients in Metadata/clients\.xml and updates their pingable/pingtime attributes\. The pingtime value is set to the last time the client was pinged (not the RTT value)\.
-.
-.SH "SEE ALSO"
-bcfg2(1), bcfg2\-server(8)
diff --git a/man/bcfg2.1 b/man/bcfg2.1
index d0f0e0062..2aa219756 100644
--- a/man/bcfg2.1
+++ b/man/bcfg2.1
@@ -1,5 +1,5 @@
.
-.TH "BCFG2" "1" "June 2012" "" ""
+.TH "BCFG2" "1" "August 2012" "" ""
.
.SH "NAME"
\fBbcfg2\fR \- Bcfg2 client tool
@@ -33,8 +33,12 @@ Upload statistics about the Bcfg2 execution and client state
.SH "OPTIONS"
.
.TP
+\fB\-B\fR
+Configure everything except the given bundle(s)\.
+.
+.TP
\fB\-C\fR \fIconfigfile\fR
-Specify alternate bcfg2\.conf location
+Specify alternate bcfg2\.conf location\.
.
.TP
\fB\-D\fR [\fIdriver1\fR,\fIdriver2\fR]
@@ -53,7 +57,7 @@ Run bcfg2 in interactive mode\. The user will be prompted before each change\.
.
.TP
\fB\-O\fR
-Omit lock check
+Omit lock check\.
.
.TP
\fB\-P\fR
@@ -68,6 +72,10 @@ Specify the number of times that the client will attempt to retry network commun
Manually specify the server location (as opposed to using the value in bcfg2\.conf)\.
.
.TP
+\fB\-Z\fR
+Do not configure independent entries\.
+.
+.TP
\fB\-b\fR [\fIbundle1:bundle2\fR]
Run bcfg2 against one or multiple bundles in the configuration\.
.
@@ -129,7 +137,7 @@ Cause bcfg2 to remove extra configuration elements it detects\. Mode is one of a
.
.TP
\fB\-s\fR \fIservice mode\fR
-Set bcfg2 interaction level for services\. Default behavior is to modify all services affected by reconfiguration\. build mode attempts to stop all services started\. disabled suppresses all attempts to modify services
+Set bcfg2 interaction level for services\. Default behavior is to modify all services affected by reconfiguration\. build mode attempts to stop all services started\. disabled suppresses all attempts to modify services\.
.
.TP
\fB\-\-ssl\-cert=\fR\fIssl cert\fR