git.gag.com Git - debian/amanda/blob - man/disklist.5

   1 '\" t
   2 .\"     Title: disklist
   3 .\"    Author: James da Silva <jds@amanda.org>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 07/25/2012
   6 .\"    Manual: File formats and conventions
   7 .\"    Source: Amanda 3.3.2
   8 .\"  Language: English
   9 .\"
  10 .TH "DISKLIST" "5" "07/25/2012" "Amanda 3\&.3\&.2" "File formats and conventions"
  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 disklist \- List of partitions to back up for Amanda
  32 .SH "DESCRIPTION"
  33 .PP
  34 The
  35 \fIdisklist\fR
  36 file determines which disks will be backed up by Amanda\&. The file contains
  37 \fBincludefile\fR
  38 directive or disklist entry (\fBDLE\fR)\&.
  39 .PP
  40 \fBincludefile\fR \fIstring\fR
  41 .RS 4
  42 Default:
  43 \fIno default\fR\&. The name of a disklist file to include within the current file\&. Useful for sharing disklist among several configurations\&. Relative pathnames are relative to the configuration directory\&.
  44 .RE
  45 .PP
  46 A
  47 \fBDLE\fR
  48 usually contains one line per disk:
  49 .nf
  50 \fIhostname diskname\fR [\fIdiskdevice\fR] \fIdumptype\fR [\fIspindle\fR [\fIinterface\fR] ]
  51 .fi
  52 .PP
  53 All pairs [
  54 \fIhostname diskname\fR
  55 ] must be unique\&.
  56 .PP
  57 Lines starting with # are ignored, as are blank lines\&. The fields have the following meanings:
  58 .PP
  59 \fIhostname\fR
  60 .RS 4
  61 The name of the host to be backed up\&. If
  62 \fBdiskdevice\fR
  63 refers to a PC share, this is the host Amanda will run the Samba
  64 \fBsmbclient\fR
  65 program on to back up the share\&.
  66 .RE
  67 .PP
  68 \fIdiskname\fR
  69 .RS 4
  70 The name of the disk (a label)\&. In most case, you set your
  71 \fBdiskname\fR
  72 to the
  73 \fBdiskdevice\fR
  74 and you don\*(Aqt set the
  75 \fBdiskdevice\&.\fR
  76 If you want multiple entries with the same
  77 \fBdiskdevice\fR, you must set a different
  78 \fBdiskname\fR
  79 for each entry\&. It\*(Aqs the
  80 \fBdiskname\fR
  81 that you use on the commandline for any Amanda command\&. Look at the example/disklist file for example\&.
  82 .RE
  83 .PP
  84 \fIdiskdevice\fR
  85 .RS 4
  86 Default: same as diskname\&. The name of the disk device to be backed up\&. It may be a full device name, a device name without the
  87 /dev/
  88 prefix, e\&.g\&.
  89 \fIsd0a\fR, or a mount point such as
  90 /usr\&.
  91 .sp
  92 It may also refer to a PC share by starting the name with two (forward) slashes, e\&.g\&.
  93 //some\-pc/home\&. In this case, the
  94 \fBprogram\fR
  95 option in the associated
  96 \fBdumptype\fR
  97 must be entered as
  98 \fBGNUTAR\fR\&. It is the combination of the double slash disk name and
  99 \fBprogram GNUTAR\fR
 100 in the
 101 \fBdumptype\fR
 102 that triggers the use of Samba\&.
 103 .RE
 104 .PP
 105 \fIdumptype\fR
 106 .RS 4
 107 Refers to a
 108 \fBdumptype\fR
 109 defined in the
 110 \fBamanda\&.conf\fR
 111 file\&.
 112 \fIDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in
 113 /etc/dumpdates, the disk\*(Aqs relative priority, etc\&.
 114 .RE
 115 .PP
 116 \fIspindle\fR
 117 .RS 4
 118 Default:
 119 \fB\-1\fR\&. A number used to balance backup load on a host\&. Amanda will not run multiple backups at the same time on the same spindle, unless the spindle number is \-1, which means there is no spindle restriction\&.
 120 .RE
 121 .PP
 122 \fIinterface\fR
 123 .RS 4
 124 Default:
 125 \fIlocal\fR\&. The name of a network interface definition in the
 126 \fBamanda\&.conf\fR
 127 file, used to balance network load\&.
 128 .RE
 129 .PP
 130 Instead of naming a
 131 \fBdumptype\fR, it is possible to define one in\-line, enclosing
 132 \fBdumptype\fR
 133 options within curly braces, one per line, just like a
 134 \fBdumptype\fR
 135 definition in
 136 \fBamanda\&.conf\fR\&. Since pre\-existing
 137 \fBdumptype\fRs are valid option names, this syntax may be used to customize
 138 \fBdumptype\fRs for particular disks\&.
 139 .PP
 140 A line break
 141 \fBmust\fR
 142 follow the left curly bracket\&.
 143 .PP
 144 For instance, if a
 145 \fBdumptype\fR
 146 named
 147 \fInormal\fR
 148 is used for most disks, but use of the holding disk needs to be disabled for the file system that holds it, this would work instead of defining a new dumptype:
 149 .nf
 150 \fIhostname diskname\fR [ \fIdiskdevice\fR ] {
 151   normal
 152   holdingdisk never
 153 } [ \fIspindle\fR [ \fIinterface\fR ] ]
 154 .fi
 155 .PP
 156 The { must appear at the end of a line, and the } on its own line possibly followed by the spindle and interface\&.
 157 .SH "SEE ALSO"
 158 .PP
 159 \fBamanda\fR(8),
 160 \fBamanda.conf\fR(5)
 161 .PP
 162 The Amanda Wiki:
 163 : http://wiki.zmanda.com/
 164 .SH "AUTHORS"
 165 .PP
 166 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 167 .PP
 168 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
 169 .PP
 170 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 171 .RS 4
 172 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 173 .RE