1AMGTAR(8) System Administration Commands AMGTAR(8)
2
6 amgtar - Amanda Application to interface with GNU Tar
7
9 Amgtar is an Amanda Application API script. It should not be run by
10 users directly. It uses GNU Tar to backup and restore data.
11 The diskdevice in the disklist (DLE) must be the directory to backup.
13
15 This section lists the properties that control amgtar's functionality.
16 See amanda-applications(7) for information on application properties
17 and how they are configured.
18 ATIME-PRESERVE
20 If "YES" (the default), amgtar use the --atime-preserve=system
22 option of gnutar to not update the atime of all files accessed; if
23 "NO", gnutar will updates the atime for all files accessed. This
24 property works only if you have gnutar 1.15.90 or newer, if not,
25 you must set ATIME_PRESERVE to "NO".
26 CHECK-DEVICE
28 If "YES" (the default), amgtar checks that the device number
30 doesn't change for each file. If "NO", changes in device number are
31 ignored. To ignore device numbers, tar must support the
32 --no-check-device option (gnutar 1.19.90 and newer). This option is
33 needed for some filesystems and devices on which device numbers
34 change frequently, such as LVM or FiberChannel.
35 COMMAND-OPTIONS
37 If set, theses options are passed asis to gtar. Each option must be
38 a different value of the property. Some option can break how amanda
39 do backup, use it with care.
40 Use:
42 property "COMMAND-OPTIONS" "--foo" "bar"
43 Do not use:
45 property "COMMAND-OPTIONS" "--foo bar"
46 DIRECTORY
48 If set, gnutar will backup from that directory instead of the
50 diskdevice set by the DLE. On restore, the data is restore in that
51 directory instead of the current working directory.
52 GNUTAR-LISTDIR
54 The directory where gnutar stores the database it uses to generate
56 incremental dumps. The default is set when Amanda is built.
57 GNUTAR-PATH
59 The path to the gnutar binary. The default is set when Amanda is
61 built.
62 IGNORE-ZEROS
64 If "YES" (the default), use the --ignore-zeros argument of gtar on
66 recovery, set it to "NO" if you do not want that argument.
67 INCLUDE-LIST-GLOB
69 A filename containing include glob expression for the restore
71 command.
72 EXCLUDE-LIST-GLOB
74 A filename containing exclude glob expression for the restore
76 command.
77 ONE-FILE-SYSTEM
79 If "YES" (the default), do not allow gnutar to cross filesystem
81 boundaries. If "NO", gnutar will cross filesystem boundaries. This
82 corresponds to the --one-filesystem option of gnutar.
83 TAR-BLOCKSIZE
85 Block size of Nx512 bytes (default N=20). This corresponds to the
87 --blocking-factor option of gnutar.
88 SPARSE
90 If "YES" (the default), gnutar will store sparse files efficiently.
92 If "NO", then the --sparse option is not given to gnutar, and it
93 will not try to detect sparse files.
94 NO-UNQUOTE
96 If "NO" (the default), gnutar doesn't get the --no-unquote option
98 and the diskname can't have some characters, eg. '\'. If "YES",
99 then the --no-unquote option is given to gnutar and the diskname
100 can have any characters. This option is available only if you are
101 using tar-1.16 or newer.
102 ACLS
104 Default "NO". If "YES", gnutar will preserve ACL extended
106 attributes. This corresponds to the --acls gnutar option. Requires
107 a GNU Tar with nonstandard extended attribute patches from the
108 Fedora Project.
109 SELINUX
111 Default "NO". If "YES", gnutar will preserve SELinux extended
113 attributes on Linux. This corresponds to the --selinux gnutar
114 option. Requires a GNU Tar with nonstandard extended attribute
115 patches from the Fedora Project.
116 XATTRS
118 Default "NO". If "YES", gnutar will preserve all extended
120 attributes. This corresponds to the --xattrs gnutar option. If
121 enabled, this option also implies the ACLS and SELINUX properties,
122 regardless of their settings, as they are implemented as extended
123 attributes. Requires a GNU Tar with nonstandard extended attribute
124 patches from the Fedora Project.
125 EXIT-HANDLING
127 List which exit status of gtar are good or bad. eg. "1=GOOD 2=BAD",
129 exit status of 1 will produce a good backup, exit status of 2 will
130 give an error.
131 NORMAL
133 List all regex (POSIX Extended Regular Expression syntax) that are
135 normal output from gtar. These output are in the "FAILED DUMP
136 DETAILS" section of the email report if the dump result is STRANGE
137 or FAILED. Default values:
138 "^could not open conf file"
139 "^Elapsed time:"
140 "^Throughput"
141 ": socket ignored$"
142 ": File .* shrunk by [0-9][0-9]* bytes, padding with zeros"
143 ": Cannot add file .*: No such file or directory$"
144 ": Error exit delayed from previous errors"
145 To treat one of these default patterns differently, specify it
146 explicitly in a different property.
147 IGNORE
149 List all regex (POSIX Extended Regular Expression syntax) that
151 amanda ignore. These output are never in the email report. Default
152 values:
153 ": Directory is new$"
154 ": Directory has been renamed"
155 To treat one of these default patterns differently, specify it
156 explicitly in a different property.
157 STRANGE
159 List all regex (POSIX Extended Regular Expression syntax) that are
161 strange output from gtar. All gtar output that doesn't match a
162 normal or ignore regex are strange by default. The result of the
163 dump is STRANGE if gtar produce a strange output. These output are
164 in the "FAILED DUMP DETAILS" section of the email report.
165 VERBOSE
167 Default: "NO". If "YES", amgtar print more verbose debugging
169 message and can leave temporary files in AMANDA_TMPDIR.
170
172 This application supplies exclude lists via the GNU-tar --exclude-from
173 option. This option accepts normal shell-style wildcard expressions,
174 using * to match any number of characters and ? to match a single
175 character. Character classes are represented with [..], which will
176 match any of the characters in the brackets. Expressions can be
177 "anchored" to the base directory of the DLE by prefixing them with
178 "./". Without this prefix, they will match at any directory level.
179 Expressions that begin or end with a "/" will not match anything: to
180 completely exclude a directory, do not include the trailing slash.
181 Example expressions:
182 ./temp-files # exclude top-level directory entirely
184 ./temp-files/ # BAD: does nothing
185 /temp-files # BAD: does nothing
186 ./temp-files/* # exclude directory contents; include directory
187 temp-files # exclude anything named "temp-files"
188 generated-* # exclude anything beginning with "generated-"
189 *.iso # exclude ISO files
190 proxy/local/cache # exclude "cache" in dir "local" in "proxy"
191 Similarly, include expressions are supplied to GNU-tar's --files-from
193 option. This option ordinarily does not accept any sort of wildcards,
194 but amgtar "manually" applies glob pattern matching to include
195 expressions with only one slash. The expressions must still begin with
196 "./", so this effectively only allows expressions like "./[abc]*" or
197 "./*.txt".
198
200 define application-tool app_amgtar {
201 plugin "amgtar"
202 property "ATIME-PRESERVE" "NO"
204 property "CHECK-DEVICE" "YES"
205 property "GNUTAR-LISTDIR" "/path/to/listdir"
206 property "GNUTAR-PATH" "/bin/tar"
207 property "ONE-FILE-SYSTEM" "YES"
208 property "TAR-BLOCKSIZE" "20"
209 property "SPARSE" "YES"
210 property "ACLS" "NO"
211 property "SELINUX" "NO"
212 property "XATTRS" "NO"
213 property "EXIT-HANDLING" "1=GOOD 2=BAD"
214 # change a default NORMAL regex to a STRANGE regex.
215 property "STRANGE" ": socket ignored$"
216 # add three new IGNORE regex
217 property "IGNORE" ": Directory is new$"
218 property append "IGNORE" ": Directory has been renamed"
219 property append "IGNORE" "file changed as we read it$"
220 }
221 A dumptype using this application might look like:
222 define dumptype amgtar_app_dtyp {
224 global
225 program "APPLICATION"
226 application "app_amgtar"
227 }
228 Note that the program parameter must be set to "APPLICATION" to use the
229 application parameter.
230
232 amanda(8), tar(1), amanda.conf(5), amanda-applications(7)
233 The Amanda Wiki: : http://wiki.zmanda.com/
235
237 Jean-Louis Martineau <martineau@zmanda.com>
238 Zmanda, Inc. (http://www.zmanda.com)
239 Dustin J. Mitchell <dustin@zmanda.com>
241 Zmanda, Inc. (http://www.zmanda.com)
242Amanda 3.3.3 01/10/2013 AMGTAR(8)