1AMGETCONF(8) System Administration Commands AMGETCONF(8)
2
6 amgetconf - look up configuration parameters and manipulate debug logs
7
9 amgetconf [-l|--list] [-o configoption]... [--client]
10 [--execute-where client|server] [config] parameter
11
13 Amgetconf has three main jobs: to fetch configuration information from
14 the Amanda configuration; to fetch build-time configuration values; and
15 to open and close debug logs for shell scripts. Each is treated in its
16 own subsection, below.
17 If config is not specified, amgetconf assumes it is being run from the
19 configuration directory and that amanda.conf is present. The order of
20 options and arguments does not matter. parameter is always
21 case-insensitive, and ´-´ and ´_´ are treated as identical, just as in
22 amanda.conf(5).
23 See the "CONFIGURATION OVERRIDE" section in amanda(8) for information
25 on the -o option.
26 AMANDA CONFIGURATION
28 If parameter is a configuration keyword (from amanda.conf(5)), then
29 amgetconf will return the corresponding value. For keywords which can
30 take multiple values, amgetconf will return all values, one on each
31 line.
32 Values in configuration subsections are specified with parameters of
34 the form TYPE:NAME:PARAMETER, where TYPE is the subsection type (one of
35 dumptype, tapetype, interface, holdingdisk, application-tool, or
36 script-tool; NAME is the name of the subsection (e.g., user-tar), and
37 PARAMETER is the name of the disired parameter within that subsection.
38 The --list option lists the subsections of a certain type, where the
40 type is givein as the parameter.
41 The --client option is equivalent to --execute-where server (below).
43 The --execute-where option tells amgetconf whether to operate on the
45 client or the server; the server is the default.
46 BUILD CONFIGURATION
48 If parameter begins with build., then the following name is a build
49 environment variable. Variables without a value (e.g. XFSDUMP on a
50 system that does not support that type of file system) will not report
51 an error and will return an empty string as the value. Some boolean
52 variables (e.g. USE_AMANDAHOSTS) will return 1 if the flag is set or
53 an empty string if it is not, while others return yes or no, as
54 indicated below (the difference is historical).
55 Combining the --list option with the parameter build will enumerate all
57 available build parameters.
58 Build Parameters
60 bindir, sbindir, libexecdir, mandir
62 Install directories
63 AMANDA_TMPDIR, CONFIG_DIR, AMANDA_DBGDIR, GNUTAR_LISTED_INCREMENTAL_DIR
65 Runtime directories
66 listed_inc_dir
68 Same as GNUTAR_LISTED_INCREMENTAL_DIR
69 CC, VERSION, ASSERTIONS, LOCKING, USE_VERSION_SUFFIXES
71 Build information. ASSERTIONS is 1 or empty, while
72 USE_VERSION_SUFFIXES is yes/no.
73 DUMP, RESTORE, VDUMP, VRESTORE, XFSDUMP, XFSRESTORE, VXDUMP, VXRESTORE,
75 SAMBA_CLIENT, GNUTAR, STAR, COMPRESS_PATH, UNCOMPRESS_PATH
76 Paths to various utility progarms (empty if they are not found or
77 not used)
78 AIX_BACKUP
80 Is DUMP the AIX backup program? (empty or 1)
81 DUMP_RETURNS_1
83 Does DUMP return 1 on success? (empty or 1)
84 BSD_SECURITY, BSDUDP_SECURITY, BSDTCP_SECURITY, KRB4_SECURITY,
86 KRB5_SECURITY, SSH_SECURITY, RSH_SECURITY
87 Indicate which authentication mechanisms are available (yes or no).
88 USE_AMANDAHOSTS
90 Should the "bsd" authentication mechanism use amandahosts? (yes or
91 no).
92 AMANDA_DEBUG_DAYS
94 Number of days after which debug logs are deleted.
95 DEFAULT_SERVER, DEFAULT_CONFIG, DEFAULT_TAPE_SERVER,
97 DEFAULT_TAPE_DEVICE
98 Default values for configuration parameters
99 CLIENT_LOGIN
101 Userid under which the client runs (from --with-user).
102 USE_RUNDUMP
104 Should Amanda use the rundump wrapper? (empty or 1)
105 CHECK_USERID
107 Does Amanda check that userids are correct? (empty or 1)
108 COMPRESS_SUFFIX, COMPRESS_FAST_OPT, COMPRESS_BEST_OPT, UNCOMPRESS_OPT
110 Command-line options for the compression program.
111 TICKET_LIFETIME, SERVER_HOST_PRINCIPAL, SERVER_HOST_INSTANCE,
113 SERVER_HOST_KEY_FILE, CLIENT_HOST_PRINCIPAL, CLIENT_HOST_INSTANCE,
114 CLIENT_HOST_KEY_FILE
115 Kerberos parameters.
116 DEBUG LOG MANAGEMENT
118 Note
119 That this application is responsible for debug logs is a historical
120 quirk, but the functionality is widely used..sp .5v
121 If parameter begins with dbopen., the string following the period is a
123 program name and an Amanda debug file will be created for the caller.
124 The name of the logfile is returned.
125 If parameter begins with dbclose., the string following the period is a
127 program name previously used with dbopen., followed by a colon (:) and
128 the previously opened file name. The name of the logfile is returned.
129
131 Find out the path to the log file directory:
132 % amgetconf daily logdir
133 /usr/local/etc/amanda/daily/logs
134 Find out the current tape type:
136 % amgetconf daily tapetype
137 DLT4000-IV
138 Find out that tape type´s length:
140 % amgetconf daily tapetype:DLT4000-IV:length
141 1024000
142 List the other available tapetype:
144 % amgetconf daily --list tapetype
145 DISK
146 QIC-60
147 DEC-DLT2000
148 ...
149 Find out the configuration directory:
151 % amgetconf build.CONFIG_DIR
152 /usr/local/etc/amanda/
153 List all build-time parameters
155 % amgetconf --list build
156 AIX_BACKUP
157 AMANDA_DBGDIR
158 AMANDA_DEBUG_DAYS
159 ...
160 Create, use and close a debug file in a script:
162 % debug_file=`amgetconf daily dbopen.myscript`
163 % echo debug information >> $debug_file
164 % amgetconf daily dbclose.myscript:$debug_file
165
167 amgetconf: no such parameter param
168 Parameter param is not a known keyword (e.g. not a valid
169 amanda.conf keyword).
170
172 amanda(8), : http://wiki.zmanda.com
173
175 Jean-Louis Martineau <martineau@zmanda.com>
176 Zmanda, Inc. (http://www.zmanda.com)
177Amanda 2.6.1p2 11/05/2009 AMGETCONF(8)