3 .\" Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 2.6.1p1
10 .TH "AMGETCONF" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 amgetconf \- look up configuration parameters and manipulate debug logs
24 .HP \w'\fBamgetconf\fR\ 'u
25 \fBamgetconf\fR [\fI\-l|\-\-list\fR] [\-o\ \fIconfigoption\fR]... [\fI\-\-client\fR] [\fI\-\-execute\-where\ client|server\fR] [\fIconfig\fR] \fIparameter\fR
30 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\&.
36 assumes it is being run from the configuration directory and that
38 is present\&. The order of options and arguments does not matter\&.
40 is always case\-insensitive, and \'\-\' and \'_\' are treated as identical, just as in
41 \fBamanda.conf\fR(5)\&.
43 See the "\fBCONFIGURATION OVERRIDE\fR" section in
45 for information on the
48 .SS "AMANDA CONFIGURATION"
52 is a configuration keyword (from
53 \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\&.
55 Values in configuration subsections are specified with parameters of the form
56 TYPE:NAME:PARAMETER, where
58 is the subsection type (one of
66 is the name of the subsection (e\&.g\&.,
69 is the name of the disired parameter within that subsection\&.
73 option lists the subsections of a certain type, where the type is givein as the parameter\&.
77 option is equivalent to
78 \-\-execute\-where server
83 option tells amgetconf whether to operate on the client or the server; the server is the default\&.
84 .SS "BUILD CONFIGURATION"
89 build\&., then the following name is a build environment variable\&. Variables without a value (e\&.g\&.
91 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\&.
92 \fIUSE_AMANDAHOSTS\fR) will return
94 if the flag is set or an empty string if it is not, while others return
97 no, as indicated below (the difference is historical)\&.
101 option with the parameter
103 will enumerate all available build parameters\&.
105 \fBBuild Parameters\fR
107 bindir, sbindir, libexecdir, mandir
112 AMANDA_TMPDIR, CONFIG_DIR, AMANDA_DBGDIR, GNUTAR_LISTED_INCREMENTAL_DIR
120 GNUTAR_LISTED_INCREMENTAL_DIR
123 CC, VERSION, ASSERTIONS, LOCKING, USE_VERSION_SUFFIXES
132 DUMP, RESTORE, VDUMP, VRESTORE, XFSDUMP, XFSRESTORE, VXDUMP, VXRESTORE, SAMBA_CLIENT, GNUTAR, STAR, COMPRESS_PATH, UNCOMPRESS_PATH
134 Paths to various utility progarms (empty if they are not found or not used)
141 the AIX backup program? (empty or 1)
148 return 1 on success? (empty or 1)
151 BSD_SECURITY, BSDUDP_SECURITY, BSDTCP_SECURITY, KRB4_SECURITY, KRB5_SECURITY, SSH_SECURITY, RSH_SECURITY
153 Indicate which authentication mechanisms are available (yes or no)\&.
158 Should the "bsd" authentication mechanism use
159 amandahosts? (yes or no)\&.
164 Number of days after which debug logs are deleted\&.
167 DEFAULT_SERVER, DEFAULT_CONFIG, DEFAULT_TAPE_SERVER, DEFAULT_TAPE_DEVICE
169 Default values for configuration parameters
174 Userid under which the client runs (from
180 Should Amanda use the
182 wrapper? (empty or 1)
187 Does Amanda check that userids are correct? (empty or 1)
190 COMPRESS_SUFFIX, COMPRESS_FAST_OPT, COMPRESS_BEST_OPT, UNCOMPRESS_OPT
192 Command\-line options for the compression program\&.
195 TICKET_LIFETIME, SERVER_HOST_PRINCIPAL, SERVER_HOST_INSTANCE, SERVER_HOST_KEY_FILE, CLIENT_HOST_PRINCIPAL, CLIENT_HOST_INSTANCE, CLIENT_HOST_KEY_FILE
197 Kerberos parameters\&.
199 .SS "DEBUG LOG MANAGEMENT"
205 .nr an-no-space-flag 1
212 That this application is responsible for debug logs is a
213 historical quirk, but the functionality is widely used\&..sp .5v
219 \fIdbopen\&.\fR, the string following the period is a program name and an
221 debug file will be created for the caller\&. The name of the logfile is returned\&.
226 \fIdbclose\&.\fR, the string following the period is a program name previously used with
227 \fIdbopen\&.\fR, followed by a colon (:) and the previously opened file name\&. The name of the logfile is returned\&.
230 Find out the path to the log file directory:
232 % amgetconf daily logdir
233 /usr/local/etc/amanda/daily/logs
236 Find out the current tape type:
238 % amgetconf daily tapetype
242 Find out that tape type\'s length:
244 % amgetconf daily tapetype:DLT4000\-IV:length
248 List the other available tapetype:
250 % amgetconf daily \-\-list tapetype
257 Find out the configuration directory:
259 % amgetconf build\&.CONFIG_DIR
260 /usr/local/etc/amanda/
263 List all build\-time parameters
265 % amgetconf \-\-list build
272 Create, use and close a debug file in a script:
274 % debug_file=`amgetconf daily dbopen\&.myscript`
275 % echo debug information >> $debug_file
276 % amgetconf daily dbclose\&.myscript:$debug_file
280 amgetconf: no such parameter \fIparam\fR
284 is not a known keyword (e\&.g\&. not a valid
292 : http://wiki.zmanda.com
295 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
297 Zmanda, Inc\&. (http://www\&.zmanda\&.com)