2 .\" Author: Jean-Louis Martineau <martineau@zmanda.com>
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
5 .\" Manual: System Administration Commands
6 .\" Source: Amanda 2.6.1
9 .TH "AMGETCONF" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 .\" put an extra blank line of space above the head in non-TTY output
43 .nr an-prevailing-indent \\n[IN]
47 .HTML-TAG ".NH \\n[an-level]"
49 .nr an-no-space-flag 1
51 \." make the size of the head bigger
56 .\" if n (TTY output), use uppercase
61 .\" if not n (not TTY), use normal case (not uppercase)
65 .\" if not n (not TTY), put a border/line under subheading
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77 .nr an-prevailing-indent \\n[IN]
82 .nr an-no-space-flag 1
85 \." make the size of the head bigger
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 .if "\\$2"adjust-for-leading-newline" \{\
114 .nr BW \\n(.lu-\\n(.i
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
164 .\" disable justification (adjust text to left margin only)
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
170 amgetconf \- look up configuration parameters and manipulate debug logs
173 .HP \w'\fBamgetconf\fR\ 'u
174 \fBamgetconf\fR [\fI\-l|\-\-list\fR] [\-o\ \fIconfigoption\fR]... [\fI\-\-client\fR] [\fI\-\-execute\-where\ client|server\fR] [\fIconfig\fR] \fIparameter\fR
180 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\&.
186 assumes it is being run from the configuration directory and that
188 is present\&. The order of options and arguments does not matter\&.
190 is always case\-insensitive, and \'\-\' and \'_\' are treated as identical, just as in
191 \fBamanda.conf\fR(5)\&.
193 See the "\fBCONFIGURATION OVERRIDE\fR" section in
195 for information on the
198 .SS "AMANDA CONFIGURATION"
202 is a configuration keyword (from
203 \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\&.
205 Values in configuration subsections are specified with parameters of the form
206 \FCTYPE:NAME:PARAMETER\F[], where
208 is the subsection type (one of
213 \FCapplication\-tool\F[], or
216 is the name of the subsection (e\&.g\&.,
217 \FCuser\-tar\F[]), and
219 is the name of the disired parameter within that subsection\&.
223 option lists the subsections of a certain type, where the type is givein as the parameter\&.
227 option is equivalent to
228 \FC\-\-execute\-where server\F[]
232 \FC\-\-execute\-where\F[]
233 option tells amgetconf whether to operate on the client or the server; the server is the default\&.
234 .SS "BUILD CONFIGURATION"
239 \FCbuild\&.\F[], then the following name is a build environment variable\&. Variables without a value (e\&.g\&.
241 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\&.
242 \fIUSE_AMANDAHOSTS\fR) will return
244 if the flag is set or an empty string if it is not, while others return
247 \FCno\F[], as indicated below (the difference is historical)\&.
251 option with the parameter
253 will enumerate all available build parameters\&.
255 \fBBuild Parameters\fR
257 \FCbindir\F[], \FCsbindir\F[], \FClibexecdir\F[], \FCmandir\F[]
262 \FCAMANDA_TMPDIR\F[], \FCCONFIG_DIR\F[], \FCAMANDA_DBGDIR\F[], \FCGNUTAR_LISTED_INCREMENTAL_DIR\F[]
267 \FClisted_inc_dir\F[]
270 \FCGNUTAR_LISTED_INCREMENTAL_DIR\F[]
273 \FCCC\F[], \FCVERSION\F[], \FCASSERTIONS\F[], \FCLOCKING\F[], \FCUSE_VERSION_SUFFIXES\F[]
278 \FCUSE_VERSION_SUFFIXES\F[]
282 \FCDUMP\F[], \FCRESTORE\F[], \FCVDUMP\F[], \FCVRESTORE\F[], \FCXFSDUMP\F[], \FCXFSRESTORE\F[], \FCVXDUMP\F[], \FCVXRESTORE\F[], \FCSAMBA_CLIENT\F[], \FCGNUTAR\F[], \FCSTAR\F[], \FCCOMPRESS_PATH\F[], \FCUNCOMPRESS_PATH\F[]
284 Paths to various utility progarms (empty if they are not found or not used)
291 the AIX backup program? (empty or 1)
294 \FCDUMP_RETURNS_1\F[]
298 return 1 on success? (empty or 1)
301 \FCBSD_SECURITY\F[], \FCBSDUDP_SECURITY\F[], \FCBSDTCP_SECURITY\F[], \FCKRB4_SECURITY\F[], \FCKRB5_SECURITY\F[], \FCSSH_SECURITY\F[], \FCRSH_SECURITY\F[]
303 Indicate which authentication mechanisms are available (yes or no)\&.
306 \FCUSE_AMANDAHOSTS\F[]
308 Should the "bsd" authentication mechanism use
309 \FCamandahosts\F[]? (yes or no)\&.
312 \FCAMANDA_DEBUG_DAYS\F[]
314 Number of days after which debug logs are deleted\&.
317 \FCDEFAULT_SERVER\F[], \FCDEFAULT_CONFIG\F[], \FCDEFAULT_TAPE_SERVER\F[], \FCDEFAULT_TAPE_DEVICE\F[]
319 Default values for configuration parameters
324 Userid under which the client runs (from
325 \FC\-\-with\-user\F[])\&.
330 Should Amanda use the
332 wrapper? (empty or 1)
337 Does Amanda check that userids are correct? (empty or 1)
340 \FCCOMPRESS_SUFFIX\F[], \FCCOMPRESS_FAST_OPT\F[], \FCCOMPRESS_BEST_OPT\F[], \FCUNCOMPRESS_OPT\F[]
342 Command\-line options for the compression program\&.
345 \FCTICKET_LIFETIME\F[], \FCSERVER_HOST_PRINCIPAL\F[], \FCSERVER_HOST_INSTANCE\F[], \FCSERVER_HOST_KEY_FILE\F[], \FCCLIENT_HOST_PRINCIPAL\F[], \FCCLIENT_HOST_INSTANCE\F[], \FCCLIENT_HOST_KEY_FILE\F[]
347 Kerberos parameters\&.
349 .SS "DEBUG LOG MANAGEMENT"
356 .nr an-no-space-flag 1
363 That this application is responsible for debug logs is a
364 historical quirk, but the functionality is widely used\&..sp .5v
371 \fIdbopen\&.\fR, the string following the period is a program name and an
373 debug file will be created for the caller\&. The name of the logfile is returned\&.
378 \fIdbclose\&.\fR, the string following the period is a program name previously used with
379 \fIdbopen\&.\fR, followed by a colon (:) and the previously opened file name\&. The name of the logfile is returned\&.
382 Find out the path to the log file directory:
384 % amgetconf daily logdir
385 /usr/local/etc/amanda/daily/logs
388 Find out the current tape type:
390 % amgetconf daily tapetype
394 Find out that tape type\'s length:
396 % amgetconf daily tapetype:DLT4000\-IV:length
400 List the other available tapetype:
402 % amgetconf daily \-\-list tapetype
409 Find out the configuration directory:
411 % amgetconf build\&.CONFIG_DIR
412 /usr/local/etc/amanda/
415 List all build\-time parameters
417 % amgetconf \-\-list build
424 Create, use and close a debug file in a script:
426 % debug_file=`amgetconf daily dbopen\&.myscript`
427 % echo debug information >> $debug_file
428 % amgetconf daily dbclose\&.myscript:$debug_file
432 amgetconf: no such parameter \fIparam\fR
436 is not a known keyword (e\&.g\&. not a valid
444 : http://wiki.zmanda.com
447 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
449 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])