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