From 71fa90c2ad9739848049b49c48e94ae1572b999b Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 7 Apr 2010 14:07:45 -0500 Subject: Fix configfile option for bcfg2-admin (Patch from Duncan Hutty) Also added a document describing various admin modes (needs to be fleshed out). Signed-off-by: Sol Jerome --- doc/server/admin/index.txt | 72 ++++++++++++++++++++++++++++++++++++++++++++++ doc/server/index.txt | 1 + 2 files changed, 73 insertions(+) create mode 100644 doc/server/admin/index.txt (limited to 'doc') diff --git a/doc/server/admin/index.txt b/doc/server/admin/index.txt new file mode 100644 index 000000000..43c71a933 --- /dev/null +++ b/doc/server/admin/index.txt @@ -0,0 +1,72 @@ +.. -*- mode: rst -*- + +.. _server-admin-index: + +===== +Admin +===== + +The ``bcfg2-admin`` command provides you an interface which allows you +to interact with your Bcfg2 repository in an administrative fashion. To +get started, run ``bcfg2-admin help``. You will be presented with a list +of different *modes* which each provide various administrative +functionality. Available modes are listed below. + +FIXME: Need examples for each command listed below. + +client +====== + +Create, delete, or modify client entries. + +compare +======= + +Determine differences between files or directories of client +specification instances. + +init +==== + +Interactively initialize a new repository. + +minestruct +========== + +Extract extra entry lists from statistics. + +perf +==== + +Query server for performance data. + +pull +==== + +Integrate configuration information from clients into the server +repository. + +query +===== + +Query clients. + +snapshots +========= + +Interact with the Snapshots system. + +tidy +==== + +Clean up useless files in the repo. + +viz +=== + +Produce graphviz diagrams of metadata structures. + +xcmd +==== + +XML-RPC Command Interface. diff --git a/doc/server/index.txt b/doc/server/index.txt index b81f9ede4..9c351c652 100644 --- a/doc/server/index.txt +++ b/doc/server/index.txt @@ -10,6 +10,7 @@ Bcfg2 Server :maxdepth: 2 plugins/index + admin/index reports/index configurationentries snapshots/index -- cgit v1.2.3-1-g7c22