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

   1 .\"     Title: amgetconf
   2 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 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[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amgetconf \- look up configuration parameters and manipulate debug logs
 171 .SH "Synopsis"
 172 .fam C
 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
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 \fBAmgetconf\fR
 179 has three main jobs:
 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\&.
 181 .PP
 182 If
 183 \fIconfig\fR
 184 is not specified,
 185 \fBamgetconf\fR
 186 assumes it is being run from the configuration directory and that
 187 \fIamanda\&.conf\fR
 188 is present\&. The order of options and arguments does not matter\&.
 189 \fIparameter\fR
 190 is always case\-insensitive, and \'\-\' and \'_\' are treated as identical, just as in
 191 \fBamanda.conf\fR(5)\&.
 192 .PP
 193 See the "\fBCONFIGURATION OVERRIDE\fR" section in
 194 \fBamanda\fR(8)
 195 for information on the
 196 \FC\-o\F[]
 197 option\&.
 198 .SS "AMANDA CONFIGURATION"
 199 .PP
 200 If
 201 \fIparameter\fR
 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\&.
 204 .PP
 205 Values in configuration subsections are specified with parameters of the form
 206 \FCTYPE:NAME:PARAMETER\F[], where
 207 \FCTYPE\F[]
 208 is the subsection type (one of
 209 \FCdumptype\F[],
 210 \FCtapetype\F[],
 211 \FCinterface\F[],
 212 \FCholdingdisk\F[],
 213 \FCapplication\-tool\F[], or
 214 \FCscript\-tool\F[];
 215 \FCNAME\F[]
 216 is the name of the subsection (e\&.g\&.,
 217 \FCuser\-tar\F[]), and
 218 \FCPARAMETER\F[]
 219 is the name of the disired parameter within that subsection\&.
 220 .PP
 221 The
 222 \FC\-\-list\F[]
 223 option lists the subsections of a certain type, where the type is givein as the parameter\&.
 224 .PP
 225 The
 226 \FC\-\-client\F[]
 227 option is equivalent to
 228 \FC\-\-execute\-where server\F[]
 229 (below)\&.
 230 .PP
 231 The
 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"
 235 .PP
 236 If
 237 \fIparameter\fR
 238 begins with
 239 \FCbuild\&.\F[], then the following name is a build environment variable\&. Variables without a value (e\&.g\&.
 240 \FCXFSDUMP\F[]
 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
 243 \FC1\F[]
 244 if the flag is set or an empty string if it is not, while others return
 245 \FCyes\F[]
 246 or
 247 \FCno\F[], as indicated below (the difference is historical)\&.
 248 .PP
 249 Combining the
 250 \FC\-\-list\F[]
 251 option with the parameter
 252 \FCbuild\F[]
 253 will enumerate all available build parameters\&.
 254 .PP
 255 \fBBuild Parameters\fR
 256 .PP
 257 \FCbindir\F[], \FCsbindir\F[], \FClibexecdir\F[], \FCmandir\F[]
 258 .RS 4
 259 Install directories
 260 .RE
 261 .PP
 262 \FCAMANDA_TMPDIR\F[], \FCCONFIG_DIR\F[], \FCAMANDA_DBGDIR\F[], \FCGNUTAR_LISTED_INCREMENTAL_DIR\F[]
 263 .RS 4
 264 Runtime directories
 265 .RE
 266 .PP
 267 \FClisted_inc_dir\F[]
 268 .RS 4
 269 Same as
 270 \FCGNUTAR_LISTED_INCREMENTAL_DIR\F[]
 271 .RE
 272 .PP
 273 \FCCC\F[], \FCVERSION\F[], \FCASSERTIONS\F[], \FCLOCKING\F[], \FCUSE_VERSION_SUFFIXES\F[]
 274 .RS 4
 275 Build information\&.
 276 \FCASSERTIONS\F[]
 277 is 1 or empty, while
 278 \FCUSE_VERSION_SUFFIXES\F[]
 279 is yes/no\&.
 280 .RE
 281 .PP
 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[]
 283 .RS 4
 284 Paths to various utility progarms (empty if they are not found or not used)
 285 .RE
 286 .PP
 287 \FCAIX_BACKUP\F[]
 288 .RS 4
 289 Is
 290 \FCDUMP\F[]
 291 the AIX backup program? (empty or 1)
 292 .RE
 293 .PP
 294 \FCDUMP_RETURNS_1\F[]
 295 .RS 4
 296 Does
 297 \FCDUMP\F[]
 298 return 1 on success? (empty or 1)
 299 .RE
 300 .PP
 301 \FCBSD_SECURITY\F[], \FCBSDUDP_SECURITY\F[], \FCBSDTCP_SECURITY\F[], \FCKRB4_SECURITY\F[], \FCKRB5_SECURITY\F[], \FCSSH_SECURITY\F[], \FCRSH_SECURITY\F[]
 302 .RS 4
 303 Indicate which authentication mechanisms are available (yes or no)\&.
 304 .RE
 305 .PP
 306 \FCUSE_AMANDAHOSTS\F[]
 307 .RS 4
 308 Should the "bsd" authentication mechanism use
 309 \FCamandahosts\F[]? (yes or no)\&.
 310 .RE
 311 .PP
 312 \FCAMANDA_DEBUG_DAYS\F[]
 313 .RS 4
 314 Number of days after which debug logs are deleted\&.
 315 .RE
 316 .PP
 317 \FCDEFAULT_SERVER\F[], \FCDEFAULT_CONFIG\F[], \FCDEFAULT_TAPE_SERVER\F[], \FCDEFAULT_TAPE_DEVICE\F[]
 318 .RS 4
 319 Default values for configuration parameters
 320 .RE
 321 .PP
 322 \FCCLIENT_LOGIN\F[]
 323 .RS 4
 324 Userid under which the client runs (from
 325 \FC\-\-with\-user\F[])\&.
 326 .RE
 327 .PP
 328 \FCUSE_RUNDUMP\F[]
 329 .RS 4
 330 Should Amanda use the
 331 \FCrundump\F[]
 332 wrapper? (empty or 1)
 333 .RE
 334 .PP
 335 \FCCHECK_USERID\F[]
 336 .RS 4
 337 Does Amanda check that userids are correct? (empty or 1)
 338 .RE
 339 .PP
 340 \FCCOMPRESS_SUFFIX\F[], \FCCOMPRESS_FAST_OPT\F[], \FCCOMPRESS_BEST_OPT\F[], \FCUNCOMPRESS_OPT\F[]
 341 .RS 4
 342 Command\-line options for the compression program\&.
 343 .RE
 344 .PP
 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[]
 346 .RS 4
 347 Kerberos parameters\&.
 348 .RE
 349 .SS "DEBUG LOG MANAGEMENT"
 350 .if n \{\
 351 .sp
 352 .\}
 353 .RS 4
 354 .BM yellow
 355 .it 1 an-trap
 356 .nr an-no-space-flag 1
 357 .nr an-break-flag 1
 358 .br
 359 .ps +1
 360 \fBNote\fR
 361 .ps -1
 362 .br
 363 That this application is responsible for debug logs is a
 364 historical quirk, but the functionality is widely used\&..sp .5v
 365 .EM yellow
 366 .RE
 367 .PP
 368 If
 369 \fIparameter\fR
 370 begins with
 371 \fIdbopen\&.\fR, the string following the period is a program name and an
 372 \fIAmanda\fR
 373 debug file will be created for the caller\&. The name of the logfile is returned\&.
 374 .PP
 375 If
 376 \fIparameter\fR
 377 begins with
 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\&.
 380 .SH "EXAMPLES"
 381 .PP
 382 Find out the path to the log file directory:
 383 .nf
 384 % amgetconf daily logdir
 385 /usr/local/etc/amanda/daily/logs
 386 .fi
 387 .PP
 388 Find out the current tape type:
 389 .nf
 390 % amgetconf daily tapetype
 391 DLT4000\-IV
 392 .fi
 393 .PP
 394 Find out that tape type\'s length:
 395 .nf
 396 % amgetconf daily tapetype:DLT4000\-IV:length
 397 1024000
 398 .fi
 399 .PP
 400 List the other available tapetype:
 401 .nf
 402 % amgetconf daily \-\-list tapetype
 403 DISK
 404 QIC\-60
 405 DEC\-DLT2000
 406 \&.\&.\&.
 407 .fi
 408 .PP
 409 Find out the configuration directory:
 410 .nf
 411 % amgetconf build\&.CONFIG_DIR
 412 /usr/local/etc/amanda/
 413 .fi
 414 .PP
 415 List all build\-time parameters
 416 .nf
 417 % amgetconf \-\-list build
 418 AIX_BACKUP
 419 AMANDA_DBGDIR
 420 AMANDA_DEBUG_DAYS
 421 \&.\&.\&.
 422 .fi
 423 .PP
 424 Create, use and close a debug file in a script:
 425 .nf
 426 % debug_file=`amgetconf daily dbopen\&.myscript`
 427 % echo debug information >> $debug_file
 428 % amgetconf daily dbclose\&.myscript:$debug_file
 429 .fi
 430 .SH "MESSAGES"
 431 .PP
 432 amgetconf: no such parameter \fIparam\fR
 433 .RS 4
 434 Parameter
 435 \fIparam\fR
 436 is not a known keyword (e\&.g\&. not a valid
 437 \fIamanda\&.conf\fR
 438 keyword)\&.
 439 .RE
 440 .SH "SEE ALSO"
 441 .PP
 442
 443 \fBamanda\fR(8),
 444 : http://wiki.zmanda.com
 445 .SH "Author"
 446 .PP
 447 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 448 .RS 4
 449 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 450 .RE