1AMBSDTAR(8)             System Administration Commands             AMBSDTAR(8)
2
3
4

NAME

6       ambsdtar - Amanda Application to interface with BSD Tar
7

DESCRIPTION

9       Ambsdtar is an Amanda Application API script. It should not be run by
10       users directly. It uses BSD Tar to backup and restore data.
11
12       The diskdevice in the disklist (DLE) must be the directory to backup.
13
14       Extracting backup never remove files. If a file where present in the
15       level 0 backup, you removed it, made a level 1 backup, then after
16       extracting both levels, the file will be present.
17

PROPERTIES

19       This section lists the properties that control ambsdtar's
20       functionality. See amanda-applications(7) for information on
21       application properties and how they are configured.
22
23       COMMAND-OPTIONS
24           If set, theses options are passed asis to gtar. Each option must be
25           a different value of the property. Some option can break how amanda
26           do backup, use it with care.
27
28           Use:
29             property "COMMAND-OPTIONS" "--foo" "bar"
30
31           Do not use:
32             property "COMMAND-OPTIONS" "--foo bar"
33
34       DIRECTORY
35
36           If set, bsdtar will backup from that directory instead of the
37           diskdevice set by the DLE. On restore, the data is restore in that
38           directory instead of the current working directory.
39
40       SPARSE
41
42           If "YES", the default, it use the -S option of bsdtar when
43           restoring to create sparse files.
44
45       STATE-DIR
46
47           The directory where ambsdtar stores the database it uses to
48           generate incremental dumps.  The default is set when Amanda is
49           built.
50
51       BSDTAR-PATH
52
53           The path to the bsdtar binary.  The default is set when Amanda is
54           built.
55
56       ONE-FILE-SYSTEM
57
58           If "YES" (the default), do not allow bsdtar to cross filesystem
59           boundaries. If "NO", bsdtar will cross filesystem boundaries.  This
60           corresponds to the --one-filesystem option of bsdtar.
61
62       TAR-BLOCKSIZE
63
64           Block size of Nx512 bytes (default N=20).  This corresponds to the
65           --blocking-factor option of bsdtar.
66
67       EXIT-HANDLING
68
69           List which exit status of gtar are good or bad. eg. "1=GOOD 2=BAD",
70           exit status of 1 will produce a good backup, exit status of 2 will
71           give an error.
72
73       NORMAL
74
75           List all regex (POSIX Extended Regular Expression syntax) that are
76           normal output from gtar. These output are in the "FAILED DUMP
77           DETAILS" section of the email report if the dump result is STRANGE
78           or FAILED. Default values:
79             "^could not open conf file"
80             "^Elapsed time:"
81             "^Throughput"
82             ": socket ignored$"
83             ": File .* shrunk by [0-9][0-9]* bytes, padding with zeros"
84             ": Cannot add file .*: No such file or directory$"
85             ": Error exit delayed from previous errors"
86           To treat one of these default patterns differently, specify it
87           explicitly in a different property.
88
89       IGNORE
90
91           List all regex (POSIX Extended Regular Expression syntax) that
92           amanda ignore. These output are never in the email report. Default
93           values:
94             ": Directory is new$"
95             ": Directory has been renamed"
96           To treat one of these default patterns differently, specify it
97           explicitly in a different property.
98
99       STRANGE
100
101           List all regex (POSIX Extended Regular Expression syntax) that are
102           strange output from gtar. All gtar output that doesn't match a
103           normal or ignore regex are strange by default. The result of the
104           dump is STRANGE if gtar produce a strange output. These output are
105           in the "FAILED DUMP DETAILS" section of the email report.
106
107       VERBOSE
108
109           Default: "NO". If "YES", ambsdtar print more verbose debugging
110           message and can leave temporary files in AMANDA_TMPDIR.
111

INCLUDE AND EXCLUDE LISTS

113       This application supplies exclude lists via the GNU-tar --exclude-from
114       option. This option accepts normal shell-style wildcard expressions,
115       using * to match any number of characters and ?  to match a single
116       character. Character classes are represented with [..], which will
117       match any of the characters in the brackets. Expressions can be
118       "anchored" to the base directory of the DLE by prefixing them with
119       "./". Without this prefix, they will match at any directory level.
120       Expressions that begin or end with a "/" will not match anything: to
121       completely exclude a directory, do not include the trailing slash.
122       Example expressions:
123
124         ./temp-files           # exclude top-level directory entirely
125         ./temp-files/          # BAD: does nothing
126         /temp-files            # BAD: does nothing
127         ./temp-files/*         # exclude directory contents; include directory
128         temp-files             # exclude anything named "temp-files"
129         generated-*            # exclude anything beginning with "generated-"
130         *.iso                  # exclude ISO files
131         proxy/local/cache      # exclude "cache" in dir "local" in "proxy"
132
133       Similarly, include expressions are supplied to GNU-tar's --files-from
134       option. This option ordinarily does not accept any sort of wildcards,
135       but ambsdtar "manually" applies glob pattern matching to include
136       expressions with only one slash. The expressions must still begin with
137       "./", so this effectively only allows expressions like "./[abc]*" or
138       "./*.txt".
139

EXAMPLE

141         define application-tool app_ambsdtar {
142           plugin "ambsdtar"
143
144           property "BSDTAR-PATH" "/bin/bsdtar"
145           property "STATE-DIR" "/xxx/yyy"
146           property "ONE-FILE-SYSTEM" "YES"
147           property "TAR-BLOCKSIZE" "20"
148           property "EXIT-HANDLING" "1=GOOD 2=BAD"
149           # change a default NORMAL regex to a STRANGE regex.
150           property "STRANGE" ": socket ignored$"
151           # add three new IGNORE regex
152           property "IGNORE" ": Directory is new$"
153           property append "IGNORE" ": Directory has been renamed"
154           property append "IGNORE" "file changed as we read it$"
155         }
156       A dumptype using this application might look like:
157
158         define dumptype ambsdtar_app_dtyp {
159           global
160           program "APPLICATION"
161           application "app_ambsdtar"
162         }
163       Note that the program parameter must be set to "APPLICATION" to use the
164       application parameter.
165

SEE ALSO

167       amanda(8), tar(1), amanda.conf(5), amanda-applications(7)
168
169       The Amanda Wiki: : http://wiki.zmanda.com/
170

AUTHORS

172       Jean-Louis Martineau <martineau@zmanda.com>
173           Zmanda, Inc. (http://www.zmanda.com)
174
175       Dustin J. Mitchell <dustin@zmanda.com>
176           Zmanda, Inc. (http://www.zmanda.com)
177
178
179
180Amanda 3.5.4                      07/27/2023                       AMBSDTAR(8)
Impressum