NAME¶
bcfg2-admin - Perform repository administration tasks
SYNOPSIS¶
bcfg2-admin [-C
configfile]
mode [
mode args]
[
mode options]
DESCRIPTION¶
bcfg2-admin is used to perform Bcfg2 repository administration.
OPTIONS¶
- -C configfile
- Specify alternate bcfg2.conf location.
- -E encoding
- Specify the encoding of config files.
- -Q path
- Specify the path to the server repository.
- -S server
- Manually specify the server location (as opposed to using the value in
bcfg2.conf). This should be in the format "
https://server:port"
- -d
- Enable debugging output.
- -h
- Print usage information.
- -o logfile
- Writes a log to the specified path.
- --ssl-key=key
- Specify the path to the SSL key.
- -v
- Enable verbose output.
- -x password
- Use 'password' for client communication.
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).
- 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).
- init
- Initialize a new repository (interactive).
- minestruct client [-f xml-file] [-g groups]
- Build structure entries based on client statistics extra entries (See
MINESTRUCT OPTIONS below).
- perf
- Query server for performance data.
- 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).
- syncdb
- Sync the Django ORM with the configured database.
- tidy
- Remove unused files from repository.
- 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¶
- mode
- One of the following.
- add
- Add a client
- del
- Delete a client
- list
- List all client entries
- client
- Specify the client's name.
- attribute=value
- Set attribute values when adding a new client. Allowed attributes are
'profile', 'uuid', 'password', 'location', 'secure, and 'address'.
COMPARE OPTIONS¶
- old
- Specify the location of the old configuration file.
- new
- Specify the location of the new configuration file.
MINESTRUCT OPTIONS¶
- client
- Client whose metadata is to be searched for extra entries.
- -g groups
- Hierarchy of groups in which to place the extra entries in.
- -f outputfile
- Specify the xml file in which to write the extra entries.
PULL OPTIONS¶
- client
- Specify the name of the client to search for.
- entry type
- Specify the type of the entry to pull.
- 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
- Include hosts in diagram.
- -b
- Include bundles in diagram.
- -o <outfile>
- Write to outfile file instead of stdout.
- -k
- Add a shape/color key.
SEE ALSO¶
bcfg2-info(8),
bcfg2-server(8)
