summaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2013-08-13 08:15:16 -0400
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2013-08-13 08:33:04 -0400
commit3d56dba8705f738f3384833bf2210c2734911dca (patch)
tree5ff65e9960688a16d3e2136fb22dc2bfafcb2dd8 /doc/man
parentc7c692f468bdb7071f38fa845f010d97a0c27c98 (diff)
downloadbcfg2-3d56dba8705f738f3384833bf2210c2734911dca.tar.gz
bcfg2-3d56dba8705f738f3384833bf2210c2734911dca.tar.bz2
bcfg2-3d56dba8705f738f3384833bf2210c2734911dca.zip
man: updated bcfg2-admin man page
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/bcfg2-admin.txt94
1 files changed, 37 insertions, 57 deletions
diff --git a/doc/man/bcfg2-admin.txt b/doc/man/bcfg2-admin.txt
index 6169ec537..7b19bd366 100644
--- a/doc/man/bcfg2-admin.txt
+++ b/doc/man/bcfg2-admin.txt
@@ -38,9 +38,6 @@ Modes
backup
Create an archive of the entire Bcfg2 repository.
-bundle *action*
- Display details about the available bundles (See BUNDLE OPTIONS
- below).
client *action* *client* [attribute=value]
Add, edit, or remove clients entries in metadata (See CLIENT OPTIONS
below).
@@ -48,8 +45,12 @@ 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 below).
+dbshell
+ Call the Django 'dbshell' command on the configured database.
init
Initialize a new repository (interactive).
+initreports
+ Initialize the Reporting database.
minestruct *client* [-f xml-file] [-g groups]
Build structure entries based on client statistics extra entries
(See MINESTRUCT OPTIONS below).
@@ -58,34 +59,31 @@ perf
pull *client* *entry-type* *entry-name*
Install configuration information into repo based on client bad
entries (See PULL OPTIONS below).
-reports [init|load_stats|purge|scrub|update]
- Interact with the dynamic reporting system (See REPORTS OPTIONS
- below).
-snapshots [init|dump|query|reports]
- Interact with the Snapshots database (See SNAPSHOTS OPTIONS below).
+purgereports
+ Purge historic and expired data from the Reporting database
+reportssqlall
+ Call the Django 'shell' command on the Reporting database.
+reportsstats
+ Print Reporting database statistics.
+scrubreports
+ Scrub the Reporting database for duplicate reasons and orphaned
+ entries.
+shell
+ Call the Django 'shell' command on the configured database.
syncdb
Sync the Django ORM with the configured database.
tidy
Remove unused files from repository.
+updatereports
+ Apply database schema updates to the Reporting database.
+validatedb
+ Call the Django 'validate' command on the configured database.
viz [-H] [-b] [-k] [-o png-file]
Create a graphviz diagram of client, group and bundle information
(See VIZ OPTIONS below).
xcmd
Provides a XML-RPC Command Interface to the bcfg2-server.
-BUNDLE OPTIONS
-++++++++++++++
-
-mode
- One of the following.
-
- *list-xml*
- List all available xml bundles
- *list-genshi*
- List all available genshi bundles
- *show*
- Interactive dialog to get details about the available bundles
-
CLIENT OPTIONS
++++++++++++++
@@ -110,11 +108,20 @@ attribute=value
COMPARE OPTIONS
+++++++++++++++
+-d *N*, --diff-lines *N*
+ Show only N lines of a diff
+
+-c, --color
+ Show colors even if not ryn from a TTY
+
+-q, --quiet
+ Only show that entries differ, not how they differ
+
old
- Specify the location of the old configuration file.
+ Specify the location of the old configuration(s).
new
- Specify the location of the new configuration file.
+ Specify the location of the new configuration(s).
MINESTRUCT OPTIONS
++++++++++++++++++
@@ -140,51 +147,24 @@ entry type
entry name
Specify the name of the entry to pull.
-REPORTS OPTIONS
-+++++++++++++++
-
-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
+-H, --includehosts
Include hosts in diagram.
--b
+-b, --includebundles
Include bundles in diagram.
--o <outfile>
+-o *outfile*, --outfile *outfile*
Write to outfile file instead of stdout.
--k
+-k, --includekey
Add a shape/color key.
+-c *hostname*, --only-client *hostname*
+ Only show groups and bundles for the named client
+
See Also
--------