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