1AMGETCONF(8) System Administration Commands AMGETCONF(8)
2
6 amgetconf - look up configuration parameters and manipulate debug logs
7
9 amgetconf [-l|--list] [--client] [--execute-where client|server]
10 [config] parameter [{-o configoption}...]
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
71 Build information. ASSERTIONS is 1 or empty.
72 DUMP, RESTORE, VDUMP, VRESTORE, XFSDUMP, XFSRESTORE, VXDUMP, VXRESTORE,
74 SAMBA_CLIENT, GNUTAR, STAR, COMPRESS_PATH, UNCOMPRESS_PATH
75 Paths to various utility progarms (empty if they are not found or
76 not used)
77 AIX_BACKUP
79 Is DUMP the AIX backup program? (empty or 1)
80 DUMP_RETURNS_1
82 Does DUMP return 1 on success? (empty or 1)
83 BSD_SECURITY, BSDUDP_SECURITY, BSDTCP_SECURITY, KRB5_SECURITY,
85 SSH_SECURITY, RSH_SECURITY
86 Indicate which authentication mechanisms are available (yes or no).
87 USE_AMANDAHOSTS
89 Should the "bsd" authentication mechanism use amandahosts? (yes or
90 no).
91 AMANDA_DEBUG_DAYS
93 Number of days after which debug logs are deleted.
94 DEFAULT_SERVER, DEFAULT_CONFIG, DEFAULT_TAPE_SERVER,
96 DEFAULT_TAPE_DEVICE
97 Default values for configuration parameters
98 CLIENT_LOGIN
100 Userid under which the client runs (from --with-user).
101 USE_RUNDUMP
103 Should Amanda use the rundump wrapper? (empty or 1)
104 CHECK_USERID
106 Does Amanda check that userids are correct? (empty or 1)
107 COMPRESS_SUFFIX, COMPRESS_FAST_OPT, COMPRESS_BEST_OPT, UNCOMPRESS_OPT
109 Command-line options for the compression program.
110 TICKET_LIFETIME, SERVER_HOST_PRINCIPAL, SERVER_HOST_INSTANCE,
112 SERVER_HOST_KEY_FILE, CLIENT_HOST_PRINCIPAL, CLIENT_HOST_INSTANCE,
113 CLIENT_HOST_KEY_FILE
114 Kerberos parameters.
115 DEBUG LOG MANAGEMENT
117 Note
118 That this application is responsible for debug logs is a historical
119 quirk, but the functionality is widely used.
120 If parameter begins with dbopen., the string following the period is a
122 program name and an Amanda debug file will be created for the caller.
123 The name of the logfile is returned.
124 If parameter begins with dbclose., the string following the period is a
126 program name previously used with dbopen., followed by a colon (:) and
127 the previously opened file name. The name of the logfile is returned.
128
130 Find out the path to the log file directory:
131 % amgetconf daily logdir
132 /usr/local/etc/amanda/daily/logs
133 Find out the current tape type:
135 % amgetconf daily tapetype
136 DLT4000-IV
137 Find out that tape type´s length:
139 % amgetconf daily tapetype:DLT4000-IV:length
140 1024000
141 List the other available tapetype:
143 % amgetconf daily --list tapetype
144 DISK
145 QIC-60
146 DEC-DLT2000
147 ...
148 Find out the configuration directory:
150 % amgetconf build.CONFIG_DIR
151 /usr/local/etc/amanda/
152 List all build-time parameters
154 % amgetconf --list build
155 AIX_BACKUP
156 AMANDA_DBGDIR
157 AMANDA_DEBUG_DAYS
158 ...
159 Create, use and close a debug file in a script:
161 % debug_file=`amgetconf daily dbopen.myscript`
162 % echo debug information >> $debug_file
163 % amgetconf daily dbclose.myscript:$debug_file
164
166 amgetconf: no such parameter param
167 Parameter param is not a known keyword (e.g. not a valid
168 amanda.conf keyword).
169
171 amanda(8), amanda.conf(5), amanda-client.conf(5)
172 The Amanda Wiki: : http://wiki.zmanda.com/
174
176 Jean-Louis Martineau <martineau@zmanda.com>
177 Zmanda, Inc. (http://www.zmanda.com)
178Amanda 3.1.3 10/04/2010 AMGETCONF(8)