summaryrefslogtreecommitdiffstats
path: root/doc/server/admin/index.txt
blob: 64461b27821ef29285a7300eceb6d07c444fdf5c (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
.. -*- 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.

backup
======

Create an archive of the whole Bcfg2 repository. The archive is stored
directly in your Bcfg2 repository (e.g. /var/lib/bcfg2)::

    bcfg2-admin backup

client
======

Create, delete, or modify client entries.::

    bcfg2-admin client add 

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.

The default result format is suitable for consumption by `pdsh`_.
This example queries the server for all clients in the *ubuntu* group::

    bcfg2-admin query g=ubuntu

.. _pdsh: http://sourceforge.net/projects/pdsh/

snapshots
=========

Interact with the Snapshots system.

tidy
====

Clean up useless files in the repo.

viz
===

Produce graphviz diagrams of metadata structures.

The following command will produce a graphviz image which includes hosts,
bundles, and a key::

    bcfg2-admin viz -H -b -k -o ~/bcfg2.png

.. note:: The graphviz package available via DAG/RPMforge has been known
          to have dependency issues. We recommend installing the package
          from EPEL.

xcmd
====

XML-RPC Command Interface.