3 .\" Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 3.3.2
10 .TH "AMGETCONF" "8" "07/25/2012" "Amanda 3\&.3\&.2" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 amgetconf \- look up configuration parameters and manipulate debug logs
33 .HP \w'\fBamgetconf\fR\ 'u
34 \fBamgetconf\fR [\fI\-l|\-\-list\fR] [\fI\-\-client\fR] [\fI\-\-execute\-where\ client|server\fR] [\fB\-o\fR\ \fIconfigoption\fR...] [\fIconfig\fR] \fIparameter\fR
39 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\&.
45 assumes it is being run from the configuration directory and that
47 is present\&. The order of options and arguments does not matter\&.
49 is always case\-insensitive, and \*(Aq\-\*(Aq and \*(Aq_\*(Aq are treated as identical, just as in
50 \fBamanda.conf\fR(5)\&.
52 See the "\fBCONFIGURATION OVERRIDE\fR" section in
54 for information on the
57 .SS "AMANDA CONFIGURATION"
61 is a configuration keyword (from
62 \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\&.
64 Values in configuration subsections are specified with parameters of the form
65 TYPE:NAME:PARAMETER, where
67 is the subsection type (one of
75 is the name of the subsection (e\&.g\&.,
78 is the name of the disired parameter within that subsection\&.
82 option lists the subsections of a certain type, where the type is givein as the parameter\&.
86 option is equivalent to
87 \-\-execute\-where server
92 option tells amgetconf whether to operate on the client or the server; the server is the default\&.
93 .SS "BUILD CONFIGURATION"
98 build\&., then the following name is a build environment variable\&. Variables without a value (e\&.g\&.
100 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\&.
101 \fIUSE_AMANDAHOSTS\fR) will return
103 if the flag is set or an empty string if it is not, while others return
106 no, as indicated below (the difference is historical)\&.
110 option with the parameter
112 will enumerate all available build parameters\&.
114 \fBBuild Parameters\fR
116 bindir, sbindir, libexecdir, mandir
121 AMANDA_TMPDIR, CONFIG_DIR, AMANDA_DBGDIR, GNUTAR_LISTED_INCREMENTAL_DIR
129 GNUTAR_LISTED_INCREMENTAL_DIR
132 CC, VERSION, ASSERTIONS, LOCKING
139 DUMP, RESTORE, VDUMP, VRESTORE, XFSDUMP, XFSRESTORE, VXDUMP, VXRESTORE, SAMBA_CLIENT, GNUTAR, STAR, COMPRESS_PATH, UNCOMPRESS_PATH
141 Paths to various utility progarms (empty if they are not found or not used)
148 the AIX backup program? (empty or 1)
155 return 1 on success? (empty or 1)
158 BSD_SECURITY, BSDUDP_SECURITY, BSDTCP_SECURITY, KRB5_SECURITY, SSH_SECURITY, RSH_SECURITY
160 Indicate which authentication mechanisms are available (yes or no)\&.
165 Should the "bsd" authentication mechanism use
166 amandahosts? (yes or no)\&.
171 Number of days after which debug logs are deleted\&.
174 DEFAULT_SERVER, DEFAULT_CONFIG, DEFAULT_TAPE_SERVER, DEFAULT_TAPE_DEVICE
176 Default values for configuration parameters
181 Userid under which the client runs (from
187 Should Amanda use the
189 wrapper? (empty or 1)
194 Does Amanda check that userids are correct? (empty or 1)
197 COMPRESS_SUFFIX, COMPRESS_FAST_OPT, COMPRESS_BEST_OPT, UNCOMPRESS_OPT
199 Command\-line options for the compression program\&.
202 TICKET_LIFETIME, SERVER_HOST_PRINCIPAL, SERVER_HOST_INSTANCE, SERVER_HOST_KEY_FILE, CLIENT_HOST_PRINCIPAL, CLIENT_HOST_INSTANCE, CLIENT_HOST_KEY_FILE
204 Kerberos parameters\&.
206 .SS "DEBUG LOG MANAGEMENT"
212 .nr an-no-space-flag 1
219 That this application is responsible for debug logs is a
220 historical quirk, but the functionality is widely used\&.
227 \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\&.
232 \fIdbclose\&.\fR, the string following the period is a program name previously used with
233 \fIdbopen\&.\fR, followed by a colon (:) and the previously opened file name\&. The name of the logfile is returned\&.
236 Find out the path to the log file directory:
238 % amgetconf daily logdir
239 /usr/local/etc/amanda/daily/logs
242 Find out the current tape type:
244 % amgetconf daily tapetype
248 Find out that tape type\*(Aqs length:
250 % amgetconf daily tapetype:DLT4000\-IV:length
254 List the other available tapetype:
256 % amgetconf daily \-\-list tapetype
263 Find out the configuration directory:
265 % amgetconf build\&.CONFIG_DIR
266 /usr/local/etc/amanda/
269 List all build\-time parameters
271 % amgetconf \-\-list build
278 Create, use and close a debug file in a script:
280 % debug_file=`amgetconf daily dbopen\&.myscript`
281 % echo debug information >> $debug_file
282 % amgetconf daily dbclose\&.myscript:$debug_file
286 amgetconf: no such parameter \fIparam\fR
290 is not a known keyword (e\&.g\&. not a valid
297 \fBamanda.conf\fR(5),
298 \fBamanda-client.conf\fR(5)
301 : http://wiki.zmanda.com/
304 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
306 Zmanda, Inc\&. (http://www\&.zmanda\&.com)