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 3.2.1
10 .TH "AMGETCONF" "8" "12/14/2010" "Amanda 3\&.2\&.1" "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] [\fI\-\-client\fR] [\fI\-\-execute\-where\ client|server\fR] [\fB\-o\fR\ \fIconfigoption\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
130 DUMP, RESTORE, VDUMP, VRESTORE, XFSDUMP, XFSRESTORE, VXDUMP, VXRESTORE, SAMBA_CLIENT, GNUTAR, STAR, COMPRESS_PATH, UNCOMPRESS_PATH
132 Paths to various utility progarms (empty if they are not found or not used)
139 the AIX backup program? (empty or 1)
146 return 1 on success? (empty or 1)
149 BSD_SECURITY, BSDUDP_SECURITY, BSDTCP_SECURITY, KRB5_SECURITY, SSH_SECURITY, RSH_SECURITY
151 Indicate which authentication mechanisms are available (yes or no)\&.
156 Should the "bsd" authentication mechanism use
157 amandahosts? (yes or no)\&.
162 Number of days after which debug logs are deleted\&.
165 DEFAULT_SERVER, DEFAULT_CONFIG, DEFAULT_TAPE_SERVER, DEFAULT_TAPE_DEVICE
167 Default values for configuration parameters
172 Userid under which the client runs (from
178 Should Amanda use the
180 wrapper? (empty or 1)
185 Does Amanda check that userids are correct? (empty or 1)
188 COMPRESS_SUFFIX, COMPRESS_FAST_OPT, COMPRESS_BEST_OPT, UNCOMPRESS_OPT
190 Command\-line options for the compression program\&.
193 TICKET_LIFETIME, SERVER_HOST_PRINCIPAL, SERVER_HOST_INSTANCE, SERVER_HOST_KEY_FILE, CLIENT_HOST_PRINCIPAL, CLIENT_HOST_INSTANCE, CLIENT_HOST_KEY_FILE
195 Kerberos parameters\&.
197 .SS "DEBUG LOG MANAGEMENT"
203 .nr an-no-space-flag 1
210 That this application is responsible for debug logs is a
211 historical quirk, but the functionality is widely used\&.
218 \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\&.
223 \fIdbclose\&.\fR, the string following the period is a program name previously used with
224 \fIdbopen\&.\fR, followed by a colon (:) and the previously opened file name\&. The name of the logfile is returned\&.
227 Find out the path to the log file directory:
229 % amgetconf daily logdir
230 /usr/local/etc/amanda/daily/logs
233 Find out the current tape type:
235 % amgetconf daily tapetype
239 Find out that tape type\'s length:
241 % amgetconf daily tapetype:DLT4000\-IV:length
245 List the other available tapetype:
247 % amgetconf daily \-\-list tapetype
254 Find out the configuration directory:
256 % amgetconf build\&.CONFIG_DIR
257 /usr/local/etc/amanda/
260 List all build\-time parameters
262 % amgetconf \-\-list build
269 Create, use and close a debug file in a script:
271 % debug_file=`amgetconf daily dbopen\&.myscript`
272 % echo debug information >> $debug_file
273 % amgetconf daily dbclose\&.myscript:$debug_file
277 amgetconf: no such parameter \fIparam\fR
281 is not a known keyword (e\&.g\&. not a valid
288 \fBamanda.conf\fR(5),
289 \fBamanda-client.conf\fR(5)
292 : http://wiki.zmanda.com/
295 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
297 Zmanda, Inc\&. (http://www\&.zmanda\&.com)