git.gag.com Git - debian/amanda/blob - man/amgetconf.8

   1 '\" t
   2 .\"     Title: amgetconf
   3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 10/18/2010
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.2.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AMGETCONF" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 amgetconf \- look up configuration parameters and manipulate debug logs
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBamgetconf\fR\ 'u
  25 \fBamgetconf\fR [\fI\-l|\-\-list\fR] [\fI\-\-client\fR] [\fI\-\-execute\-where\ client|server\fR] [\fIconfig\fR] \fIparameter\fR [\fB\-o\fR\ \fIconfigoption\fR...]
  26 .SH "DESCRIPTION"
  27 .PP
  28 \fBAmgetconf\fR
  29 has three main jobs:
  30 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\&.
  31 .PP
  32 If
  33 \fIconfig\fR
  34 is not specified,
  35 \fBamgetconf\fR
  36 assumes it is being run from the configuration directory and that
  37 \fIamanda\&.conf\fR
  38 is present\&. The order of options and arguments does not matter\&.
  39 \fIparameter\fR
  40 is always case\-insensitive, and \'\-\' and \'_\' are treated as identical, just as in
  41 \fBamanda.conf\fR(5)\&.
  42 .PP
  43 See the "\fBCONFIGURATION OVERRIDE\fR" section in
  44 \fBamanda\fR(8)
  45 for information on the
  46 \-o
  47 option\&.
  48 .SS "AMANDA CONFIGURATION"
  49 .PP
  50 If
  51 \fIparameter\fR
  52 is a configuration keyword (from
  53 \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\&.
  54 .PP
  55 Values in configuration subsections are specified with parameters of the form
  56 TYPE:NAME:PARAMETER, where
  57 TYPE
  58 is the subsection type (one of
  59 dumptype,
  60 tapetype,
  61 interface,
  62 holdingdisk,
  63 application\-tool, or
  64 script\-tool;
  65 NAME
  66 is the name of the subsection (e\&.g\&.,
  67 user\-tar), and
  68 PARAMETER
  69 is the name of the disired parameter within that subsection\&.
  70 .PP
  71 The
  72 \-\-list
  73 option lists the subsections of a certain type, where the type is givein as the parameter\&.
  74 .PP
  75 The
  76 \-\-client
  77 option is equivalent to
  78 \-\-execute\-where server
  79 (below)\&.
  80 .PP
  81 The
  82 \-\-execute\-where
  83 option tells amgetconf whether to operate on the client or the server; the server is the default\&.
  84 .SS "BUILD CONFIGURATION"
  85 .PP
  86 If
  87 \fIparameter\fR
  88 begins with
  89 build\&., then the following name is a build environment variable\&. Variables without a value (e\&.g\&.
  90 XFSDUMP
  91 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\&.
  92 \fIUSE_AMANDAHOSTS\fR) will return
  93 1
  94 if the flag is set or an empty string if it is not, while others return
  95 yes
  96 or
  97 no, as indicated below (the difference is historical)\&.
  98 .PP
  99 Combining the
 100 \-\-list
 101 option with the parameter
 102 build
 103 will enumerate all available build parameters\&.
 104 .PP
 105 \fBBuild Parameters\fR
 106 .PP
 107 bindir, sbindir, libexecdir, mandir
 108 .RS 4
 109 Install directories
 110 .RE
 111 .PP
 112 AMANDA_TMPDIR, CONFIG_DIR, AMANDA_DBGDIR, GNUTAR_LISTED_INCREMENTAL_DIR
 113 .RS 4
 114 Runtime directories
 115 .RE
 116 .PP
 117 listed_inc_dir
 118 .RS 4
 119 Same as
 120 GNUTAR_LISTED_INCREMENTAL_DIR
 121 .RE
 122 .PP
 123 CC, VERSION, ASSERTIONS, LOCKING
 124 .RS 4
 125 Build information\&.
 126 ASSERTIONS
 127 is 1 or empty\&.
 128 .RE
 129 .PP
 130 DUMP, RESTORE, VDUMP, VRESTORE, XFSDUMP, XFSRESTORE, VXDUMP, VXRESTORE, SAMBA_CLIENT, GNUTAR, STAR, COMPRESS_PATH, UNCOMPRESS_PATH
 131 .RS 4
 132 Paths to various utility progarms (empty if they are not found or not used)
 133 .RE
 134 .PP
 135 AIX_BACKUP
 136 .RS 4
 137 Is
 138 DUMP
 139 the AIX backup program? (empty or 1)
 140 .RE
 141 .PP
 142 DUMP_RETURNS_1
 143 .RS 4
 144 Does
 145 DUMP
 146 return 1 on success? (empty or 1)
 147 .RE
 148 .PP
 149 BSD_SECURITY, BSDUDP_SECURITY, BSDTCP_SECURITY, KRB5_SECURITY, SSH_SECURITY, RSH_SECURITY
 150 .RS 4
 151 Indicate which authentication mechanisms are available (yes or no)\&.
 152 .RE
 153 .PP
 154 USE_AMANDAHOSTS
 155 .RS 4
 156 Should the "bsd" authentication mechanism use
 157 amandahosts? (yes or no)\&.
 158 .RE
 159 .PP
 160 AMANDA_DEBUG_DAYS
 161 .RS 4
 162 Number of days after which debug logs are deleted\&.
 163 .RE
 164 .PP
 165 DEFAULT_SERVER, DEFAULT_CONFIG, DEFAULT_TAPE_SERVER, DEFAULT_TAPE_DEVICE
 166 .RS 4
 167 Default values for configuration parameters
 168 .RE
 169 .PP
 170 CLIENT_LOGIN
 171 .RS 4
 172 Userid under which the client runs (from
 173 \-\-with\-user)\&.
 174 .RE
 175 .PP
 176 USE_RUNDUMP
 177 .RS 4
 178 Should Amanda use the
 179 rundump
 180 wrapper? (empty or 1)
 181 .RE
 182 .PP
 183 CHECK_USERID
 184 .RS 4
 185 Does Amanda check that userids are correct? (empty or 1)
 186 .RE
 187 .PP
 188 COMPRESS_SUFFIX, COMPRESS_FAST_OPT, COMPRESS_BEST_OPT, UNCOMPRESS_OPT
 189 .RS 4
 190 Command\-line options for the compression program\&.
 191 .RE
 192 .PP
 193 TICKET_LIFETIME, SERVER_HOST_PRINCIPAL, SERVER_HOST_INSTANCE, SERVER_HOST_KEY_FILE, CLIENT_HOST_PRINCIPAL, CLIENT_HOST_INSTANCE, CLIENT_HOST_KEY_FILE
 194 .RS 4
 195 Kerberos parameters\&.
 196 .RE
 197 .SS "DEBUG LOG MANAGEMENT"
 198 .if n \{\
 199 .sp
 200 .\}
 201 .RS 4
 202 .it 1 an-trap
 203 .nr an-no-space-flag 1
 204 .nr an-break-flag 1
 205 .br
 206 .ps +1
 207 \fBNote\fR
 208 .ps -1
 209 .br
 210 That this application is responsible for debug logs is a
 211 historical quirk, but the functionality is widely used\&.
 212 .sp .5v
 213 .RE
 214 .PP
 215 If
 216 \fIparameter\fR
 217 begins with
 218 \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\&.
 219 .PP
 220 If
 221 \fIparameter\fR
 222 begins with
 223 \fIdbclose\&.\fR, the string following the period is a program name previously used with
 224 \fIdbopen\&.\fR, followed by a colon (:) and the previously opened file name\&. The name of the logfile is returned\&.
 225 .SH "EXAMPLES"
 226 .PP
 227 Find out the path to the log file directory:
 228 .nf
 229 % amgetconf daily logdir
 230 /usr/local/etc/amanda/daily/logs
 231 .fi
 232 .PP
 233 Find out the current tape type:
 234 .nf
 235 % amgetconf daily tapetype
 236 DLT4000\-IV
 237 .fi
 238 .PP
 239 Find out that tape type\'s length:
 240 .nf
 241 % amgetconf daily tapetype:DLT4000\-IV:length
 242 1024000
 243 .fi
 244 .PP
 245 List the other available tapetype:
 246 .nf
 247 % amgetconf daily \-\-list tapetype
 248 DISK
 249 QIC\-60
 250 DEC\-DLT2000
 251 \&.\&.\&.
 252 .fi
 253 .PP
 254 Find out the configuration directory:
 255 .nf
 256 % amgetconf build\&.CONFIG_DIR
 257 /usr/local/etc/amanda/
 258 .fi
 259 .PP
 260 List all build\-time parameters
 261 .nf
 262 % amgetconf \-\-list build
 263 AIX_BACKUP
 264 AMANDA_DBGDIR
 265 AMANDA_DEBUG_DAYS
 266 \&.\&.\&.
 267 .fi
 268 .PP
 269 Create, use and close a debug file in a script:
 270 .nf
 271 % debug_file=`amgetconf daily dbopen\&.myscript`
 272 % echo debug information >> $debug_file
 273 % amgetconf daily dbclose\&.myscript:$debug_file
 274 .fi
 275 .SH "MESSAGES"
 276 .PP
 277 amgetconf: no such parameter \fIparam\fR
 278 .RS 4
 279 Parameter
 280 \fIparam\fR
 281 is not a known keyword (e\&.g\&. not a valid
 282 \fIamanda\&.conf\fR
 283 keyword)\&.
 284 .RE
 285 .SH "SEE ALSO"
 286 .PP
 287 \fBamanda\fR(8),
 288 \fBamanda.conf\fR(5),
 289 \fBamanda-client.conf\fR(5)
 290 .PP
 291 The Amanda Wiki:
 292 : http://wiki.zmanda.com/
 293 .SH "AUTHOR"
 294 .PP
 295 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 296 .RS 4
 297 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 298 .RE