git.gag.com Git - debian/amanda/blob - man/amzfs-snapshot.8

   1 .\"     Title: amzfs-snapshot
   2 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMZFS\-SNAPSHOT" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amzfs-snapshot \- Amanda script to create zfs snapshot
 171 .SH "DESCRIPTION"
 172 .PP
 173 amzfs\-snapshot is an
 174 \fIAmanda\fR
 175 script implementing the Script API\&. It should not be run by users directly\&. It create a zfs snapshot of the filesystem where the path specified is mounted\&.
 176 .PP
 177 PRE\-DLE\-* create a snapshot and the POST_DLE_* destroy the snapshot, *\-DLE\-AMCHECK, *\-DLE\-ESTIMATE and *\-DLE\-BACKUP must be set to be executed on the client:
 178 .sp
 179 .nf
 180     execute\-on  pre\-dle\-amcheck, post\-dle\-amcheck, pre\-dle\-estimate, post\-dle\-estimate, pre\-dle\-backup, post\-dle\-backup
 181     execute\-where client
 182 .fi
 183 .PP
 184 The PRE_DLE_* script output a DIRECTORY property telling where the directory is located in the snapshot\&. The application must be able to use the DIRECTORY property, amgtar can do it\&.
 185 .PP
 186 The script is run as the amanda user, it must have the priviledge to create and destroy snapshot:
 187 .sp
 188 .nf
 189     zfs allow \-ldu AMANDA_USER mount,snapshot,destroy FILESYSTEM
 190 .fi
 191 .PP
 192 Some system doesn\'t have "zfs allow", but you can give the Amanda backup user the rights to manipulate ZFS filesystems by using the following command:
 193 .sp
 194 .nf
 195 usermod \-P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
 196 .fi
 197 This will require that your run zfs under pfexec, set the PFEXEC property to YES\&.
 198 .PP
 199 The format of the DLE must be one of:
 200 .sp
 201 .nf
 202 Desciption              Example
 203 \-\-\-\-\-\-\-\-\-\-              \-\-\-\-\-\-\-
 204 Mountpoint              /data
 205 Arbitrary mounted dir   /data/interesting_dir
 206 ZFS pool name           datapool
 207 ZFS filesystem          datapool/database
 208 ZFS logical volume      datapool/dbvol
 209 .fi
 210 .PP
 211 The filesystem must be mounted\&.
 212 .SH "PROPERTIES"
 213 .PP
 214 This section lists the properties that control amzfs\-snapshot\'s functionality\&. See
 215 \fBamanda-scripts\fR(7)
 216 for information on the Script API, script configuration\&.
 217 .PP
 218 DF\-PATH
 219 .RS 4
 220
 221 Path to the \'df\' binary, search in $PATH by default\&.
 222 .RE
 223 .PP
 224 ZFS\-PATH
 225 .RS 4
 226
 227 Path to the \'zfs\' binary, search in $PATH by default\&.
 228 .RE
 229 .PP
 230 PFEXEC\-PATH
 231 .RS 4
 232
 233 Path to the \'pfexec\' binary, search in $PATH by default\&.
 234 .RE
 235 .PP
 236 PFEXEC
 237 .RS 4
 238
 239 If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used\&.
 240 .RE
 241 .SH "EXAMPLE"
 242
 243
 244 In this example, a dumptype is defined to use amzfs\-snapshot script to create a snapshot and use amgtar to backup the snapshot\&.
 245 .nf
 246  define script\-tool amzfs_snapshot {
 247    comment "backup of zfs snapshot"
 248    plugin  "amzfs\-snapshot"
 249    execute\-on  pre\-dle\-amcheck, post\-dle\-amcheck, pre\-dle\-estimate, post\-dle\-estimate, pre\-dle\-backup, post\-dle\-backup
 250    execute\-where client
 251    #property "DF\-PATH" "/usr/sbin/df"
 252    #property "ZFS\-PATH" "/usr/sbin/zfs"
 253    #property "PFEXEC\-PATH" "/usr/sbin/pfexec"
 254    #property "PFEXEC" "NO"
 255  }
 256
 257  define dumptype user\-zfs\-amgtar {
 258    dt_amgtar
 259    script "amzfs_snapshot"
 260  }
 261 .fi
 262 .SH "SEE ALSO"
 263 .PP
 264
 265 \fBamanda.conf\fR(5),
 266 \fBamanda-client.conf\fR(5),
 267 \fBamanda-scripts\fR(7)
 268 .SH "Authors"
 269 .PP
 270 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 271 .RS 4
 272 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 273 .RE
 274 .PP
 275 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 276 .RS 4
 277 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 278 .RE