amgetconf

Langue: en

Version: 10/04/2010 (fedora - 01/12/10)

Section: 8 (Commandes administrateur)

amgetconf - look up configuration parameters and manipulate debug logs

Synopsis

amgetconf [-l|--list] [--client] [--execute-where client|server] [config] parameter [{-o configoption}...]

DESCRIPTION

Amgetconf

has three main jobs: to fetch configuration information from the Amanda configuration; to fetch build-time configuration values; and to open and close debug logs for shell scripts. Each is treated in its own subsection, below.

If config is not specified, amgetconf assumes it is being run from the configuration directory and that amanda.conf is present. The order of options and arguments does not matter. parameter is always case-insensitive, and '-' and '_' are treated as identical, just as in amanda.conf(5).

See the "CONFIGURATION OVERRIDE" section in amanda(8) for information on the FC-oF[] option.

AMANDA CONFIGURATION

If parameter is a configuration keyword (from amanda.conf(5)), then amgetconf will return the corresponding value. For keywords which can take multiple values, amgetconf will return all values, one on each line.

Values in configuration subsections are specified with parameters of the form FCTYPE:NAME:PARAMETERF[], where FCTYPEF[] is the subsection type (one of FCdumptypeF[], FCtapetypeF[], FCinterfaceF[], FCholdingdiskF[], FCapplication-toolF[], or FCscript-toolF[]; FCNAMEF[] is the name of the subsection (e.g., FCuser-tarF[]), and FCPARAMETERF[] is the name of the disired parameter within that subsection.

The FC--listF[] option lists the subsections of a certain type, where the type is givein as the parameter.

The FC--clientF[] option is equivalent to FC--execute-where serverF[] (below).

The FC--execute-whereF[] option tells amgetconf whether to operate on the client or the server; the server is the default.

BUILD CONFIGURATION

If parameter begins with FCbuild.F[], then the following name is a build environment variable. Variables without a value (e.g. FCXFSDUMPF[] on a system that does not support that type of file system) will not report an error and will return an empty string as the value. Some boolean variables (e.g. USE_AMANDAHOSTS) will return FC1F[] if the flag is set or an empty string if it is not, while others return FCyesF[] or FCnoF[], as indicated below (the difference is historical).

Combining the FC--listF[] option with the parameter FCbuildF[] will enumerate all available build parameters.

Build Parameters

FCbindirF[], FCsbindirF[], FClibexecdirF[], FCmandirF[]

Install directories

FCAMANDA_TMPDIRF[], FCCONFIG_DIRF[], FCAMANDA_DBGDIRF[], FCGNUTAR_LISTED_INCREMENTAL_DIRF[]

Runtime directories

FClisted_inc_dirF[]

Same as FCGNUTAR_LISTED_INCREMENTAL_DIRF[]

FCCCF[], FCVERSIONF[], FCASSERTIONSF[], FCLOCKINGF[]

Build information. FCASSERTIONSF[] is 1 or empty.

FCDUMPF[], FCRESTOREF[], FCVDUMPF[], FCVRESTOREF[], FCXFSDUMPF[], FCXFSRESTOREF[], FCVXDUMPF[], FCVXRESTOREF[], FCSAMBA_CLIENTF[], FCGNUTARF[], FCSTARF[], FCCOMPRESS_PATHF[], FCUNCOMPRESS_PATHF[]

Paths to various utility progarms (empty if they are not found or not used)

FCAIX_BACKUPF[]

Is FCDUMPF[] the AIX backup program? (empty or 1)

FCDUMP_RETURNS_1F[]

Does FCDUMPF[] return 1 on success? (empty or 1)

FCBSD_SECURITYF[], FCBSDUDP_SECURITYF[], FCBSDTCP_SECURITYF[], FCKRB5_SECURITYF[], FCSSH_SECURITYF[], FCRSH_SECURITYF[]

Indicate which authentication mechanisms are available (yes or no).

FCUSE_AMANDAHOSTSF[]

Should the "bsd" authentication mechanism use FCamandahostsF[]? (yes or no).

FCAMANDA_DEBUG_DAYSF[]

Number of days after which debug logs are deleted.

FCDEFAULT_SERVERF[], FCDEFAULT_CONFIGF[], FCDEFAULT_TAPE_SERVERF[], FCDEFAULT_TAPE_DEVICEF[]

Default values for configuration parameters

FCCLIENT_LOGINF[]

Userid under which the client runs (from FC--with-userF[]).

FCUSE_RUNDUMPF[]

Should Amanda use the FCrundumpF[] wrapper? (empty or 1)

FCCHECK_USERIDF[]

Does Amanda check that userids are correct? (empty or 1)

FCCOMPRESS_SUFFIXF[], FCCOMPRESS_FAST_OPTF[], FCCOMPRESS_BEST_OPTF[], FCUNCOMPRESS_OPTF[]

Command-line options for the compression program.

FCTICKET_LIFETIMEF[], FCSERVER_HOST_PRINCIPALF[], FCSERVER_HOST_INSTANCEF[], FCSERVER_HOST_KEY_FILEF[], FCCLIENT_HOST_PRINCIPALF[], FCCLIENT_HOST_INSTANCEF[], FCCLIENT_HOST_KEY_FILEF[]

Kerberos parameters.

DEBUG LOG MANAGEMENT


Note
That this application is responsible for debug logs is a historical quirk, but the functionality is widely used.

If parameter begins with dbopen., the string following the period is a program name and an Amanda debug file will be created for the caller. The name of the logfile is returned.

If parameter begins with dbclose., the string following the period is a program name previously used with dbopen., followed by a colon (:) and the previously opened file name. The name of the logfile is returned.

EXAMPLES

Find out the path to the log file directory:

 % amgetconf daily logdir
 /usr/local/etc/amanda/daily/logs
 

Find out the current tape type:

 % amgetconf daily tapetype
 DLT4000-IV
 

Find out that tape type's length:

 % amgetconf daily tapetype:DLT4000-IV:length
 1024000
 

List the other available tapetype:

 % amgetconf daily --list tapetype
 DISK
 QIC-60
 DEC-DLT2000
 ...
 

Find out the configuration directory:

 % amgetconf build.CONFIG_DIR
 /usr/local/etc/amanda/
 

List all build-time parameters

 % amgetconf --list build
 AIX_BACKUP
 AMANDA_DBGDIR
 AMANDA_DEBUG_DAYS
 ...
 

Create, use and close a debug file in a script:

 % debug_file=`amgetconf daily dbopen.myscript`
 % echo debug information >> $debug_file
 % amgetconf daily dbclose.myscript:$debug_file
 

MESSAGES

amgetconf: no such parameter param

Parameter param is not a known keyword (e.g. not a valid amanda.conf keyword).

SEE ALSO

amanda(8), amanda.conf(5), amanda-client.conf(5)

The Amanda Wiki: : http://wiki.zmanda.com/

Author

Jean-Louis Martineau <martineau@zmanda.com>

Zmanda, Inc. (FChttp://www.zmanda.comF[])