git.gag.com Git - debian/amanda/blob - man/xml-source/amsuntar.8.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM 'global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amsuntar.8'>
  11
  12 <refmeta>
  13 <refentrytitle>amsuntar</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amsuntar</refname>
  21 <refpurpose>Amanda Application to interface with native tar utility available on solaris platforms</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.gsat;
  25 &author.jlm;
  26 &author.dustin;
  27 </refentryinfo>
  28 <!-- body begins here -->
  29
  30 <refsect1><title>DESCRIPTION</title>
  31
  32 <para>Amsuntar is an Amanda Application API script.  It should not be run
  33 by users directly. It uses Solaris bundled tar utility to backup and
  34 restore data. Currenty ACLs from ZFS file system can only be backed up
  35 using the solaris supplied tar utility.</para>
  36
  37 <para>Solaris 10 supports Role Based Access Control(RBAC) which is enabled
  38 by default. To run backup operations using  sun tar utility by under
  39 privileged user like amandabackup, amandabackup user need to have proper
  40 roles and profiles, specially "Media Backup" profile/role. This can be done
  41 using 'usermod -P "Media Backup" amandabackup' command.</para>
  42
  43
  44 </refsect1>
  45
  46 <refsect1><title>PROPERTIES</title>
  47
  48 <para>This section lists the properties that control amsuntar's functionality.
  49 See <manref name="amanda-applications" vol="7"/>
  50 for information on application properties and how they are configured.</para>
  51
  52 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
  53 <variablelist>
  54  <!-- ==== -->
  55  <varlistentry><term>BLOCK-SIZE</term><listitem>
  56 Optional tar read or write block size.  The default is 256.
  57 </listitem></varlistentry>
  58
  59  <!-- ==== -->
  60  <varlistentry><term>DIRECTORY</term><listitem>
  61 If set, suntar will backup from that directory instead of the <emphasis>diskdevice</emphasis> set by the DLE. On restore, the data is restore in that directory instead of the current working directory.
  62 </listitem></varlistentry>
  63
  64  <!-- ==== -->
  65  <varlistentry><term>EXTENDED-ATTRIBUTES</term><listitem>
  66 Include extended attributes in archive.  The default is YES.
  67 </listitem></varlistentry>
  68
  69  <!-- ==== -->
  70  <varlistentry><term>EXTENDED-HEADERS</term><listitem>
  71 Write tar file with extended headers. With this optiion the modification time
  72 is maintained with a  granularity of microseconds,Long file names and file
  73 sizes greater than 8GB can be archived. The default is YES.
  74 </listitem></varlistentry>
  75
  76  <!-- ==== -->
  77  <varlistentry><term>SUNTAR-PATH</term><listitem>
  78 The path to the suntar binary. The default is set when Amanda is built.
  79 </listitem></varlistentry>
  80
  81  <!-- ==== -->
  82  <varlistentry><term>LANG</term><listitem>
  83 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.
  84 </listitem></varlistentry>
  85
  86  <!-- ==== -->
  87  <varlistentry><term>NORMAL</term><listitem>
  88 <para>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:
  89 <programlisting>
  90 is not a file. Not dumped\$
  91 same as archive file\$
  92 </programlisting></para>
  93 <para>To treat one of these default patterns differently, specify it explicitly in a different property.</para>
  94 </listitem></varlistentry>
  95
  96  <!-- ==== -->
  97  <varlistentry><term>IGNORE</term><listitem>
  98 <para>List all regex (Perl Regular Expression syntax) that amanda ignore. These output are never in the email report.</para>
  99 </listitem></varlistentry>
 100
 101  <!-- ==== -->
 102  <varlistentry><term>STRANGE</term><listitem>
 103 <para>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:
 104 <programlisting>
 105 : invalid character in UTF-8 conversion of
 106 : UTF-8 conversion failed.\$
 107 </programlisting></para>
 108 <para>To treat one of these default patterns differently, specify it explicitly in a different property.</para>
 109 </listitem></varlistentry>
 110
 111  <!-- ==== -->
 112  <varlistentry><term>ERROR</term><listitem>
 113 <para>
 114 List all regex (perl Regular Expression syntax) that are error output from sun tar. All sun tar output that doesn't 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:
 115 <programlisting>
 116 : Permission denied\$
 117 </programlisting></para>
 118 <para>To treat one of these default patterns differently, specify it explicitly in a different property.</para>
 119 </listitem></varlistentry>
 120 </variablelist>
 121
 122 </refsect1>
 123
 124 <seealso>
 125 <manref name="amanda.conf" vol="5"/>,
 126 <manref name="amanda-applications" vol="7"/>
 127 </seealso>
 128
 129 </refentry>