cb6d161bc47eabea97b82c2f591f438ead0dcda5
[debian/amanda] / man / amsuntar.8
1 '\" t
2 .\"     Title: amsuntar
3 .\"    Author: Satya Ganga <gast@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\"      Date: 02/21/2012
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.3.1
8 .\"  Language: English
9 .\"
10 .TH "AMSUNTAR" "8" "02/21/2012" "Amanda 3\&.3\&.1" "System Administration Commands"
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 amsuntar \- Amanda Application to interface with native tar utility available on solaris platforms
32 .SH "DESCRIPTION"
33 .PP
34 Amsuntar is an Amanda Application API script\&. It should not be run by users directly\&. It uses Solaris bundled tar utility to backup and restore data\&. Currenty ACLs from ZFS file system can only be backed up using the solaris supplied tar utility\&.
35 .PP
36 The
37 \fBdiskdevice\fR
38 in the disklist (DLE) must be the directory to backup\&.
39 .PP
40 Solaris 10 supports Role Based Access Control(RBAC) which is enabled by default\&. To run backup operations using sun tar utility by under privileged user like amandabackup, amandabackup user need to have proper roles and profiles, specially "Media Backup" profile/role\&. This can be done using \*(Aqusermod \-P "Media Backup" amandabackup\*(Aq command\&.
41 .SH "PROPERTIES"
42 .PP
43 This section lists the properties that control amsuntar\*(Aqs functionality\&. See
44 \fBamanda-applications\fR(7)
45 for information on application properties and how they are configured\&.
46 .PP
47 BLOCK\-SIZE
48 .RS 4
49
50 Optional tar read or write block size\&.  The default is 256\&.
51 .RE
52 .PP
53 DIRECTORY
54 .RS 4
55
56 If set, suntar will backup from that directory instead of the \fIdiskdevice\fR set by the DLE\&. On restore, the data is restore in that directory instead of the current working directory\&.
57 .RE
58 .PP
59 EXTENDED\-ATTRIBUTES
60 .RS 4
61
62 Include extended attributes in archive\&.  The default is YES\&.
63 .RE
64 .PP
65 EXTENDED\-HEADERS
66 .RS 4
67
68 Write tar file with extended headers\&. With this optiion the modification time
69 is maintained with a  granularity of microseconds,Long file names and file 
70 sizes greater than 8GB can be archived\&. The default is YES\&.
71 .RE
72 .PP
73 SUNTAR\-PATH
74 .RS 4
75
76 The path to the suntar binary\&. The default is set when Amanda is built\&.
77 .RE
78 .PP
79 LANG
80 .RS 4
81
82 Default LANG is "C"\&. suntar require an UTF\-8 LANG if you have UTF\-8 filename and it is configured for extended headers\&. A good value can be "en_US\&.UTF\-8" if that locale is installed on your machine\&.
83 .RE
84 .PP
85 NORMAL
86 .RS 4
87 List all regex (Perl Regular Expression syntax) that are normal output from sun tar\&. These output are in the "FAILED DUMP DETAILS" section of the email report if the dump result is STRANGE or FAILED\&. Default values:
88 .sp
89 .nf
90 is not a file\&. Not dumped\e$
91 same as archive file\e$
92 .fi
93 .sp
94 To treat one of these default patterns differently, specify it explicitly in a different property\&.
95 .RE
96 .PP
97 IGNORE
98 .RS 4
99 List all regex (Perl Regular Expression syntax) that amanda ignore\&. These output are never in the email report\&.
100 .RE
101 .PP
102 STRANGE
103 .RS 4
104 List all regex (Perl Regular Expression syntax) that are strange output from sun tar\&. The result of the dump is STRANGE if sun tar produce a strange output\&. These output are in the "FAILED DUMP DETAILS" section of the email report\&. Default values:
105 .sp
106 .nf
107 : invalid character in UTF\-8 conversion of 
108 : UTF\-8 conversion failed\&.\e$
109 .fi
110 .sp
111 To treat one of these default patterns differently, specify it explicitly in a different property\&.
112 .RE
113 .PP
114 ERROR
115 .RS 4
116 List all regex (perl Regular Expression syntax) that are error output from sun tar\&. All sun tar output that doesn\*(Aqt match a normal, ignore or strange regex are error by default\&. The result of the dump is FAILED if sun tar produce an error output\&. These output are in the "FAILED DUMP DETAILS" section of the email report\&. Default values:
117 .sp
118 .nf
119 : Permission denied\e$
120 .fi
121 .sp
122 To treat one of these default patterns differently, specify it explicitly in a different property\&.
123 .RE
124 .SH "SEE ALSO"
125 .PP
126 \fBamanda\fR(8),
127 \fBamanda.conf\fR(5),
128 \fBamanda-applications\fR(7)
129 .PP
130 The Amanda Wiki:
131 : http://wiki.zmanda.com/
132 .SH "AUTHORS"
133 .PP
134 \fBSatya Ganga\fR <\&gast@zmanda\&.com\&>
135 .RS 4
136 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
137 .RE
138 .PP
139 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
140 .RS 4
141 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
142 .RE
143 .PP
144 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
145 .RS 4
146 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
147 .RE