'\" t .\" Title: amgetconf .\" Author: Jean-Louis Martineau .\" Generator: DocBook XSL Stylesheets v1.78.1 .\" Date: 12/01/2017 .\" Manual: System Administration Commands .\" Source: Amanda 3.5.1 .\" Language: English .\" .TH "AMGETCONF" "8" "12/01/2017" "Amanda 3\&.5\&.1" "System Administration Commands" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" amgetconf \- look up configuration parameters and manipulate debug logs .SH "SYNOPSIS" .HP \w'\fBamgetconf\fR\ 'u \fBamgetconf\fR [\fI\-l|\-\-list\fR] [\fI\-\-platform\fR] [\fI\-\-distro\fR] [\fI\-\-client\fR] [\fI\-\-execute\-where\ client|server\fR] [\fB\-o\fR\ \fIconfigoption\fR...] [\fIconfig\fR] \fIparameter\fR .SH "DESCRIPTION" .PP \fBAmgetconf\fR 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\&. .PP If \fIconfig\fR is not specified, \fBamgetconf\fR assumes it is being run from the configuration directory and that \fIamanda\&.conf\fR is present\&. The order of options and arguments does not matter\&. \fIparameter\fR is always case\-insensitive, and \*(Aq\-\*(Aq and \*(Aq_\*(Aq are treated as identical, just as in \fBamanda.conf\fR(5)\&. .PP See the "\fBCONFIGURATION OVERRIDE\fR" section in \fBamanda\fR(8) for information on the \-o option\&. .SS "AMANDA CONFIGURATION" .PP If \fIparameter\fR is a configuration keyword (from \fBamanda.conf\fR(5)), then amgetconf will return the corresponding value\&. For keywords which can take multiple values, amgetconf will return all values, one on each line\&. .PP Values in configuration subsections are specified with parameters of the form TYPE:NAME:PARAMETER, where TYPE is the subsection type (one of dumptype, tapetype, interface, holdingdisk, application\-tool, or script\-tool; NAME is the name of the subsection (e\&.g\&., user\-tar), and PARAMETER is the name of the disired parameter within that subsection\&. .PP The \-\-list option lists the subsections of a certain type, where the type is givein as the parameter\&. .PP The \-\-client option is equivalent to \-\-execute\-where client (below)\&. .PP The \-\-execute\-where option tells amgetconf whether to operate on the client or the server; the server is the default\&. .SS "BUILD CONFIGURATION" .PP If \fIparameter\fR begins with build\&., then the following name is a build environment variable\&. Variables without a value (e\&.g\&. XFSDUMP 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\&. \fIUSE_AMANDAHOSTS\fR) will return 1 if the flag is set or an empty string if it is not, while others return yes or no, as indicated below (the difference is historical)\&. .PP Combining the \-\-list option with the parameter build will enumerate all available build parameters\&. .PP \fBBuild Parameters\fR .PP bindir, sbindir, libexecdir, mandir .RS 4 Install directories .RE .PP AMANDA_TMPDIR, CONFIG_DIR, AMANDA_DBGDIR, GNUTAR_LISTED_INCREMENTAL_DIR .RS 4 Runtime directories .RE .PP listed_inc_dir .RS 4 Same as GNUTAR_LISTED_INCREMENTAL_DIR .RE .PP CC, VERSION, ASSERTIONS, LOCKING .RS 4 Build information\&. ASSERTIONS is 1 or empty\&. .RE .PP DUMP, RESTORE, VDUMP, VRESTORE, XFSDUMP, XFSRESTORE, VXDUMP, VXRESTORE, SAMBA_CLIENT, GNUTAR, STAR, COMPRESS_PATH, UNCOMPRESS_PATH .RS 4 Paths to various utility progarms (empty if they are not found or not used) .RE .PP AIX_BACKUP .RS 4 Is DUMP the AIX backup program? (empty or 1) .RE .PP DUMP_RETURNS_1 .RS 4 Does DUMP return 1 on success? (empty or 1) .RE .PP BSD_SECURITY, BSDUDP_SECURITY, BSDTCP_SECURITY, KRB5_SECURITY, SSH_SECURITY, RSH_SECURITY .RS 4 Indicate which authentication mechanisms are available (yes or no)\&. .RE .PP USE_AMANDAHOSTS .RS 4 Should the "bsd" authentication mechanism use amandahosts? (yes or no)\&. .RE .PP AMANDA_DEBUG_DAYS .RS 4 Number of days after which debug logs are deleted\&. .RE .PP DEFAULT_SERVER, DEFAULT_CONFIG, DEFAULT_TAPE_SERVER, DEFAULT_TAPE_DEVICE .RS 4 Default values for configuration parameters .RE .PP CLIENT_LOGIN .RS 4 Userid under which the client runs (from \-\-with\-user)\&. .RE .PP USE_RUNDUMP .RS 4 Should Amanda use the rundump wrapper? (empty or 1) .RE .PP CHECK_USERID .RS 4 Does Amanda check that userids are correct? (empty or 1) .RE .PP COMPRESS_SUFFIX, COMPRESS_FAST_OPT, COMPRESS_BEST_OPT, UNCOMPRESS_OPT .RS 4 Command\-line options for the compression program\&. .RE .SS "DEBUG LOG MANAGEMENT" .if n \{\ .sp .\} .RS 4 .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBNote\fR .ps -1 .br That this application is responsible for debug logs is a historical quirk, but the functionality is widely used\&. .sp .5v .RE .PP If \fIparameter\fR begins with \fIdbopen\&.\fR, 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\&. .PP If \fIparameter\fR begins with \fIdbclose\&.\fR, the string following the period is a program name previously used with \fIdbopen\&.\fR, followed by a colon (:) and the previously opened file name\&. The name of the logfile is returned\&. .SH "EXAMPLES" .PP Find out the path to the log file directory: .nf % amgetconf daily logdir /usr/local/etc/amanda/daily/logs .fi .PP Find out the current tape type: .nf % amgetconf daily tapetype DLT4000\-IV .fi .PP Find out that tape type\*(Aqs length: .nf % amgetconf daily tapetype:DLT4000\-IV:length 1024000 .fi .PP List the other available tapetype: .nf % amgetconf daily \-\-list tapetype DISK QIC\-60 DEC\-DLT2000 \&.\&.\&. .fi .PP Find out the configuration directory: .nf % amgetconf build\&.CONFIG_DIR /usr/local/etc/amanda/ .fi .PP List all build\-time parameters .nf % amgetconf \-\-list build AIX_BACKUP AMANDA_DBGDIR AMANDA_DEBUG_DAYS \&.\&.\&. .fi .PP On which platform we are running .nf % amgetconf \-\-platform Fedora release 22 (Twenty Two) .fi .PP On which distro we are running .nf % amgetconf \-\-distro Fedora .fi .PP Create, use and close a debug file in a script: .nf % debug_file=`amgetconf daily dbopen\&.myscript` % echo debug information >> $debug_file % amgetconf daily dbclose\&.myscript:$debug_file .fi .SH "MESSAGES" .PP amgetconf: no such parameter \fIparam\fR .RS 4 Parameter \fIparam\fR is not a known keyword (e\&.g\&. not a valid \fIamanda\&.conf\fR keyword)\&. .RE .SH "SEE ALSO" .PP \fBamanda\fR(8), \fBamanda.conf\fR(5), \fBamanda-client.conf\fR(5), \fBamadmin\fR(8) .PP The Amanda Wiki: : http://wiki.zmanda.com/ .SH "AUTHOR" .PP \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&> .RS 4 Zmanda, Inc\&. (http://www\&.zmanda\&.com) .RE