1AMGETCONF(8)            System Administration Commands            AMGETCONF(8)
2
3
4

NAME

6       amgetconf - look up configuration parameters and manipulate debug logs
7

SYNOPSIS

9       amgetconf [-l|--list] [--platform] [--distro] [--client]
10                 [--execute-where client|server] [-o configoption...] [config]
11                 parameter
12

DESCRIPTION

14       Amgetconf has three main jobs: to fetch configuration information from
15       the Amanda configuration; to fetch build-time configuration values; and
16       to open and close debug logs for shell scripts. Each is treated in its
17       own subsection, below.
18
19       If config is not specified, amgetconf assumes it is being run from the
20       configuration directory and that amanda.conf is present. The order of
21       options and arguments does not matter.  parameter is always
22       case-insensitive, and '-' and '_' are treated as identical, just as in
23       amanda.conf(5).
24
25       See the "CONFIGURATION OVERRIDE" section in amanda(8) for information
26       on the -o option.
27
28   AMANDA CONFIGURATION
29       If parameter is a configuration keyword (from amanda.conf(5)), then
30       amgetconf will return the corresponding value. For keywords which can
31       take multiple values, amgetconf will return all values, one on each
32       line.
33
34       Values in configuration subsections are specified with parameters of
35       the form TYPE:NAME:PARAMETER, where TYPE is the subsection type (one of
36       dumptype, tapetype, interface, holdingdisk, application-tool, or
37       script-tool; NAME is the name of the subsection (e.g., user-tar), and
38       PARAMETER is the name of the disired parameter within that subsection.
39
40       The --list option lists the subsections of a certain type, where the
41       type is givein as the parameter.
42
43       The --client option is equivalent to --execute-where client (below).
44
45       The --execute-where option tells amgetconf whether to operate on the
46       client or the server; the server is the default.
47
48   BUILD CONFIGURATION
49       If parameter begins with build., then the following name is a build
50       environment variable. Variables without a value (e.g.  XFSDUMP on a
51       system that does not support that type of file system) will not report
52       an error and will return an empty string as the value. Some boolean
53       variables (e.g.  USE_AMANDAHOSTS) will return 1 if the flag is set or
54       an empty string if it is not, while others return yes or no, as
55       indicated below (the difference is historical).
56
57       Combining the --list option with the parameter build will enumerate all
58       available build parameters.
59
60       Build Parameters
61
62       bindir, sbindir, libexecdir, mandir
63           Install directories
64
65       AMANDA_TMPDIR, CONFIG_DIR, AMANDA_DBGDIR, GNUTAR_LISTED_INCREMENTAL_DIR
66           Runtime directories
67
68       listed_inc_dir
69           Same as GNUTAR_LISTED_INCREMENTAL_DIR
70
71       CC, VERSION, ASSERTIONS, LOCKING
72           Build information.  ASSERTIONS is 1 or empty.
73
74       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
79       AIX_BACKUP
80           Is DUMP the AIX backup program? (empty or 1)
81
82       DUMP_RETURNS_1
83           Does DUMP return 1 on success? (empty or 1)
84
85       BSD_SECURITY, BSDUDP_SECURITY, BSDTCP_SECURITY, KRB5_SECURITY,
86       SSH_SECURITY, RSH_SECURITY
87           Indicate which authentication mechanisms are available (yes or no).
88
89       USE_AMANDAHOSTS
90           Should the "bsd" authentication mechanism use amandahosts? (yes or
91           no).
92
93       AMANDA_DEBUG_DAYS
94           Number of days after which debug logs are deleted.
95
96       DEFAULT_SERVER, DEFAULT_CONFIG, DEFAULT_TAPE_SERVER,
97       DEFAULT_TAPE_DEVICE
98           Default values for configuration parameters
99
100       CLIENT_LOGIN
101           Userid under which the client runs (from --with-user).
102
103       USE_RUNDUMP
104           Should Amanda use the rundump wrapper? (empty or 1)
105
106       CHECK_USERID
107           Does Amanda check that userids are correct? (empty or 1)
108
109       COMPRESS_SUFFIX, COMPRESS_FAST_OPT, COMPRESS_BEST_OPT, UNCOMPRESS_OPT
110           Command-line options for the compression program.
111
112   DEBUG LOG MANAGEMENT
113           Note
114           That this application is responsible for debug logs is a historical
115           quirk, but the functionality is widely used.
116
117       If parameter begins with dbopen., the string following the period is a
118       program name and an Amanda debug file will be created for the caller.
119       The name of the logfile is returned.
120
121       If parameter begins with dbclose., the string following the period is a
122       program name previously used with dbopen., followed by a colon (:) and
123       the previously opened file name. The name of the logfile is returned.
124

EXAMPLES

126       Find out the path to the log file directory:
127       % amgetconf daily logdir
128       /usr/local/etc/amanda/daily/logs
129
130       Find out the current tape type:
131       % amgetconf daily tapetype
132       DLT4000-IV
133
134       Find out that tape type's length:
135       % amgetconf daily tapetype:DLT4000-IV:length
136       1024000
137
138       List the other available tapetype:
139       % amgetconf daily --list tapetype
140       DISK
141       QIC-60
142       DEC-DLT2000
143       ...
144
145       Find out the configuration directory:
146       % amgetconf build.CONFIG_DIR
147       /usr/local/etc/amanda/
148
149       List all build-time parameters
150       % amgetconf --list build
151       AIX_BACKUP
152       AMANDA_DBGDIR
153       AMANDA_DEBUG_DAYS
154       ...
155
156       On which platform we are running
157       % amgetconf --platform
158       Fedora release 22 (Twenty Two)
159
160       On which distro we are running
161       % amgetconf --distro
162       Fedora
163
164       Create, use and close a debug file in a script:
165       % debug_file=`amgetconf daily dbopen.myscript`
166       % echo debug information >> $debug_file
167       % amgetconf daily dbclose.myscript:$debug_file
168

MESSAGES

170       amgetconf: no such parameter param
171           Parameter param is not a known keyword (e.g. not a valid
172           amanda.conf keyword).
173

SEE ALSO

175       amanda(8), amanda.conf(5), amanda-client.conf(5), amadmin(8)
176
177       The Amanda Wiki: : http://wiki.zmanda.com/
178

AUTHOR

180       Jean-Louis Martineau <martineau@zmanda.com>
181           Zmanda, Inc. (http://www.zmanda.com)
182
183
184
185Amanda 3.5.4                      07/27/2023                      AMGETCONF(8)
Impressum