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

   1
   2                              amgetconf
   3 Prev  Chapter 36. The Amanda Manual Pages.  Next
   4
   5 -------------------------------------------------------------------------------
   6
   7 Name
   8
   9 amgetconf \14 look up amanda.conf variables
  10
  11 Synopsis
  12
  13 amgetconf [config] [--list] parameter [ -o configoption]...
  14
  15 DESCRIPTION
  16
  17 Amgetconf looks up parameters in amanda.conf, the Amanda configuration file, or
  18 from the build and runtime environment, and returns their corresponding value.
  19 If config is not specified, amgetconf assumes it is being run from the
  20 configuration directory and that amanda.conf is present.
  21 If parameter begins with build., the (case insensitive) string following the
  22 period is a build environment variable. Variables without a value (e.g. XFSDUMP
  23 on a system that does not support that type of file system) will not report an
  24 error and will return an empty string as the value. Flag variables (e.g.
  25 USE_AMANDAHOSTS) will return 1 if the flag is set or an empty string if it is
  26 not.
  27 If parameter begins with dbopen., the string following the period is a program
  28 name and an Amanda debug file will be created for the caller. The name of the
  29 file is returned.
  30 If parameter begins with dbclose., the string following the period is a program
  31 name previously used with dbopen., followed by a colon (:) and the previously
  32 opened file name.
  33 See the amanda(8) man page for more details about Amanda.
  34
  35 OPTIONS
  36
  37
  38
  39   --list
  40       The parameter must be 'tapetype', 'dumptype, 'holdingdisk' or
  41       'interface'. It will output, one by line, the list of identifier for the
  42       parameter.
  43
  44
  45         --list tapetype
  46             Output the list of tapetype, one by line.
  47
  48         --list dumptype
  49             Output the list of dumptype, one by line.
  50
  51         --list holdingdisk
  52             Output the list of holdingdisk, one by line.
  53
  54         --list interface
  55             Output the list of interface, one by line.
  56
  57
  58   parameter
  59       It could be one of the below format:
  60
  61
  62         runtapes
  63
  64         DUMPTYPE:no-compress:compress
  65
  66         TAPETYPE:HP-DAT:length
  67
  68         INTERFACE:local:use
  69
  70         HOLDINGDISK:hd1:use
  71
  72
  73   -o configoption
  74       See the "CONFIGURATION OVERRIDE" section in amanda(8).
  75
  76
  77 EXAMPLE
  78
  79 Find out the path to the log file directory:
  80
  81 % amgetconf daily logdir
  82 /usr/local/etc/amanda//daily
  83 Find out the current tape type:
  84
  85 % amgetconf daily tapetype
  86 DLT4000-IV
  87 Find out the default configuration directory:
  88
  89 % amgetconf daily build.CONFIG_DIR
  90 /usr/local/etc/amanda/
  91 Create, use and close a debug file in a script:
  92
  93 % set debug_file = `amgetconf daily dbopen.myscript`
  94 % echo debug information >> $debug_file
  95 % amgetconf daily dbclose.myscript:$debug_file
  96
  97 MESSAGES
  98
  99
 100
 101   amgetconf: no such parameter param
 102       Parameter param is not a known keyword (e.g. not a valid amanda.conf
 103       keyword).
 104
 105
 106 SEE ALSO
 107
 108 amanda(8)
 109 -------------------------------------------------------------------------------
 110
 111 Prev      Up      Next
 112 amflush  Home  amlabel
 113