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