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