amanda-applications(7) [debian man page]

AMANDA-APPLICATIONS(7)						    Miscellanea 					    AMANDA-APPLICATIONS(7)

NAME

       amanda-applications - Application-api for amanda

DESCRIPTION

       Describe how to use application with Amanda

APPLICATIONS

       This section lists the applications included with Amanda. See the individual man pages for instructions on using them. For complete How-To
       information, consult the Amanda wiki at http://wiki.zmanda.com.

       o   amgtar(8), - use GNU Tar to backup and restore data.

       o   ampgsql(8), - use PostgreSQL's continuous WAL archiving.

       o   amraw(8), - use open and read to read the data.

       o   amsamba(8), - use smbclient to backup and restore data.

       o   amstar(8), - use star to backup and restore data.

       o   amsuntar(8), - use native tar on Solaris to backup and restore data.

       o   amzfs-sendrecv(8), - use zfs to create a snapshot and use 'zfs send' to generate the backup.

       o   amzfs-snapshot(8), - use zfs to create a snapshot and for use with other applications (e.g. amgtar)

DEFINING APPLICATIONS

       An application is defined in amanda.conf(5) as follows:

       define application-tool $appconfigname {
	  plugin "$pluginname"
	  property "$PROPERTY_NAME" "$PROPERTY_VALUE"
	  ...
       }
       and then referenced in a dumptype as

       define dumptype $dumptypename {
	  ...
	  program "APPLICATION"
	  application "$appconfigname"
       }

       Application properties, like Amanda configuration parameters, are insensitive to case, and - (dash) and _ (underscore) may be used
       interchangeably.

       See the individual plugin documentation for properties applicable to each plugin.

SEE ALSO

       amanda(8), amanda.conf(5)

       The Amanda Wiki: : http://wiki.zmanda.com/

AUTHORS

       Jean-Louis Martineau <martineau@zmanda.com>
	   Zmanda, Inc. (http://www.zmanda.com)

       Dustin J. Mitchell <dustin@zmanda.com>
	   Zmanda, Inc. (http://www.zmanda.com)

Amanda 3.3.1							    02/21/2012						    AMANDA-APPLICATIONS(7)

AMZFS-SENDRECV(8)					  System Administration Commands					 AMZFS-SENDRECV(8)

NAME

       amzfs-sendrecv - Amanda script to create zfs sendrecv

DESCRIPTION

       amzfs-sendrecv is an Amanda application implementing the Application API. It should not be run by users directly. It create a zfs snapshot
       of the filesystem and backup the snapshot with 'zfs send'. Snapshot are kept after the backup is done, this increase the disk space use on
       the client but it is neccesary to be able do to incremental backup. If you want only full backup, you can disable this feature by setting
       the KEEP-SNAPSHOT property to 'NO'. Only the restoration of the complete backup is allowed, it is impossible to restore a single file.

       The application is run as the amanda user, it must have many zfs priviledge:

	   zfs allow -ldu AMANDA_USER mount,create,rename,snapshot,destroy,send,receive FILESYSTEM

       Some system doesn't have "zfs allow", but you can give the Amanda backup user the rights to manipulate ZFS filesystems by using the
       following command:

       usermod -P "ZFS File System Management,ZFS Storage Management" AMANDA_USER
       This will require that your run zfs under pfexec, set the PFEXEC property to YES.

       The format of the diskdevice in the disklist (DLE) must be one of:

       Desciption	       Example
       ----------	       -------
       Mountpoint	       /data
       ZFS pool name	       datapool
       ZFS filesystem	       datapool/database
       ZFS logical volume      datapool/dbvol

       The filesystem doesn't need to be mounted.

PROPERTIES

       This section lists the properties that control amzfs-sendrecv's functionality. See amanda-applications(7) for information on the
       Application API, application configuration.

       DF-PATH

	   Path to the 'df' binary, search in $PATH by default.

       KEEP-SNAPSHOT

	   If "YES" (the default), snapshot are kept after the backup, if set to "NO" then snapshot are no kept and incremental backup will fail.

       ZFS-PATH

	   Path to the 'zfs' binary, search in $PATH by default.

       PFEXEC-PATH

	   Path to the 'pfexec' binary, search in $PATH by default.

       PFEXEC

	   If "NO" (the default), pfexec is not used, if set to "YES" then pfexec is used.

EXAMPLE

       In this example, a dumptype is defined to use amzfs-sendrecv application to backup a zfs filesystem.
	define application-tool amzfs_sendrecv {
	  comment "amzfs-sendrecv"
	  plugin "amzfs-sendrecv"
	  #property "DF-PATH"  "/usr/sbin/df"
	  #property "KEEP-SNAPSHOT" "YES"
	  #property "ZFS-PATH" "/usr/sbin/zfs"
	  #property "PFEXEC-PATH" "/usr/sbin/pfexec"
	  #property "PFEXEC" "NO"
	}

	define dumptype user-zfs-sendrecv {
	  program "APPLICATAION"
	  application "amzfs_sendrecv"
	}

SEE ALSO

       amanda(8), amanda.conf(5), amanda-client.conf(5), amanda-applications(7)

       The Amanda Wiki: : http://wiki.zmanda.com/

AUTHOR

       Jean-Louis Martineau <martineau@zmanda.com>
	   Zmanda, Inc. (http://www.zmanda.com)

Amanda 3.3.1							    02/21/2012							 AMZFS-SENDRECV(8)