X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famanda-client.conf.5;h=b040bd35cb33fa933f97857a24dbd021bb0da2e5;hb=949b8910a5e23c4285d0b1aedacfc82a14dc97a5;hp=90d23f2ba03ffda530d4cdbd4c34c91456909291;hpb=12179dea039515c06168c0037d048566a3f623de;p=debian%2Famanda diff --git a/man/amanda-client.conf.5 b/man/amanda-client.conf.5 index 90d23f2..b040bd3 100644 --- a/man/amanda-client.conf.5 +++ b/man/amanda-client.conf.5 @@ -1,175 +1,466 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "AMANDA-CLIENT.CONF" 5 "" "" "" +'\" t +.\" Title: amanda-client.conf +.\" Author: James da Silva +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 07/25/2012 +.\" Manual: File formats and conventions +.\" Source: Amanda 3.3.2 +.\" Language: English +.\" +.TH "AMANDA\-CLIENT\&.CON" "5" "07/25/2012" "Amanda 3\&.3\&.2" "File formats and conventions" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -amanda-client.conf - Client configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver +amanda-client.conf \- Client configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver .SH "DESCRIPTION" .PP -\fIamanda-client.conf\fR -is the client configuration file for -\fBAmanda\fR. This manpage lists the relevant sections and parameters of this file for quick reference. +\fBamanda-client.conf\fR(5) +is the client configuration file for Amanda\&. This manpage lists the relevant sections and parameters of this file for quick reference\&. .PP The files -\fB/amanda-client.conf\fR +\fB/amanda\-client\&.conf\fR and -\fB//amanda-client.conf\fR -are loaded. -.SH "PARAMETERS" +\fB//amanda\-client\&.conf\fR +are loaded\&. +.SH "SYNTAX" + + +The syntax of \fBamanda-client.conf\fR(5) is identical to that for +\fBamanda.conf\fR(5)\&. +.SH "GLOBAL PARAMETERS" .PP -There are a number of configuration parameters that control the behavior of the -\fBAmanda\fR -programs. All have default values, so you need not specify the parameter in -\fBamanda-client.conf\fR -if the default is suitable. +\fBconf\fR \fIstring\fR +.RS 4 +Default: +\fISet by configure\fR\&. The conf use by amrecover\&. +.RE .PP -Lines starting with # are ignored, as are blank lines. Comments may be placed on a line with a directive by starting the comment with a #. The remainder of the line is ignored. +\fBclient\-username\fR \fIstring\fR +.RS 4 +Default: +\fICLIENT_LOGIN\fR\&. Similar to the parameter of the same name in +\fBamanda.conf\fR(5), this specifies the username that +\fBamrecover\fR +should send when connecting to the server\&. It should match the username specified in +\&.amandahosts +on the server\&. +.RE .PP -Keywords are case insensitive, i.e. -\fBauth\fR -and -\fBAuth\fR -are treated the same. -.PP -Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect: -.SS "POSSIBLE SUFFIXES" -.TP -\fBb byte bytes\fR -Some number of bytes. -.TP -\fBbps\fR -Some number of bytes per second. -.TP -\fBk kb kbyte kbytes kilobyte kilobytes\fR -Some number of kilobytes (bytes*1024). -.TP -\fBkps kbps\fR -Some number of kilobytes per second (bytes*1024). -.TP -\fBm mb meg mbyte mbytes megabyte megabytes\fR -Some number of megabytes (bytes*1024*1024). -.TP -\fBmps mbps\fR -Some number of megabytes per second (bytes*1024*1024). -.TP -\fBg gb gbyte gbytes gigabyte gigabytes\fR -Some number of gigabytes (bytes*1024*1024*1024). -.TP -\fBtape tapes\fR -Some number of tapes. -.TP -\fBday days\fR -Some number of days. -.TP -\fBweek weeks\fR -Some number of weeks (days*7). -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -\fBNote\fR -The value -\fBinf\fR -may be used in most places where an integer is expected -to mean an infinite amount. - -Boolean arguments may have any of the values -\fBy\fR, -\fByes\fR, -\fBt\fR, -\fBtrue\fR -or -\fBon\fR -to indicate a true state, or -\fBn\fR, -\fBno\fR, -\fBf\fR, -\fBfalse\fR -or -\fBoff\fR -to indicate a false state. If no argument is given, -\fBtrue\fR -is assumed. -.SS "PARAMETERS" -.TP -\fBconf\fR \fB string\fR -Default: -\fBSet by configure\fR. The conf use by amrecover. -.TP -\fBindex_server\fR \fB string\fR -Default: -\fBSet by configure\fR. The amindexd server amrecover will connect to. -.TP -\fBtape_server\fR \fB string\fR -Default: -\fBSet by configure\fR. The amidxtaped server amrecover will connect to. -.TP -\fBtapedev\fR \fB string\fR -Default: -\fBSet by configure\fR. The tapedev amrecover will use. -.TP -\fBauth\fR \fB string\fR -Default: -\fBbsd\fR. Type of authorization to perform between tape server and backup client hosts. +\fBclient\-port\fR [ \fIint\fR | \fIstring\fR ] +.RS 4 +Default: +\fI"amanda"\fR\&. Similar to the parameter of the same name in +\fBamanda.conf\fR(5), this specifies the port to connect on the server\&. It can be a service name or a numeric port number\&. +.RE +.PP +\fBamdump\-server\fR \fIstring\fR +.RS 4 +No default: +\fISet by configure\fR\&. The amanda server to connect with the amdump_client program\&. +.RE +.PP +\fBindex\-server\fR \fIstring\fR +.RS 4 +Default: +\fISet by configure\fR\&. The amindexd server amrecover will connect to\&. +.RE +.PP +\fBtape\-server\fR \fIstring\fR +.RS 4 +Default: +\fISet by configure\fR\&. The amidxtaped server amrecover will connect to\&. +.RE +.PP +\fBtapedev\fR \fIstring\fR +.RS 4 +Default: +\fISet by configure\fR\&. The tapedev amrecover will use\&. +.RE +.PP +\fBauth\fR \fIstring\fR +.RS 4 +Default: +\fB"bsdtcp"\fR\&. Type of authorization to perform between tape server and backup client hosts\&. .sp -\fBbsd\fR, bsd authorization with udp initial connection and one tcp connection by data stream. +\fB"bsd"\fR, bsd authorization with udp initial connection and one tcp connection by data stream\&. .sp -\fBbsdtcp\fR, bsd authorization but use only one tcp connection. +\fB"bsdtcp"\fR, bsd authorization but use only one tcp connection\&. .sp -\fBbsdudp\fR, like bsd, but will use only one tcp connection for all data stream. +\fB"bsdudp"\fR, like bsd, but will use only one tcp connection for all data stream\&. .sp -\fBkrb4\fR -to use Kerberos-IV authorization. +\fB"krb5"\fR +to use Kerberos\-V authorization\&. .sp -\fBkrb5\fR -to use Kerberos-V authorization. +\fB"local"\fR, if the client is the server, it doesn\*(Aqt require authencation setup\&. .sp -\fBrsh\fR -to use rsh authorization. +\fB"rsh"\fR +to use rsh authorization\&. .sp -\fBssh\fR -to use OpenSSH authorization. -.TP -\fBssh_keys\fR \fB string\fR -Default: -\fBNo default\fR. The key file the ssh auth will use, it must be the private key. If this parameter is not specified, then the deafult ssh key will be used. -.TP -\fBgnutar_list_dir\fR \fB string\fR +\fB"ssh"\fR +to use OpenSSH authorization\&. +.RE +.PP +\fBssh\-keys\fR \fIstring\fR +.RS 4 +Default: +\fINo default\fR\&. The key file the ssh auth will use, it must be the private key\&. If this parameter is not specified, then the default ssh key will be used\&. +.RE +.PP +\fBgnutar\-list\-dir\fR \fIstring\fR +.RS 4 Default from configure -\fB--with-gnutar-listdir=DIR\fR. The directory where gnutar keep its state file. -.TP -\fBamandates\fR \fB string\fR +\fI\-\-with\-gnutar\-listdir=DIR\fR\&. The directory where gnutar keep its state file\&. +.RE +.PP +\fBmailer\fR \fIstring\fR +.RS 4 +Default found by configure\&. A mail program that can send mail with \*(Aq\fIMAILER \-s "subject" user < message_file\fR\*(Aq\&. +.RE +.PP +\fBamandates\fR \fIstring\fR +.RS 4 +Default: +\fI/etc/amandates\fR\&. The file where amanda keep the last date of each dumplevel\&. +.RE +.PP +\fBconnect\-tries\fR \fIint\fR +.RS 4 +Default: +\fI3\fR\&. How many times the server will try a connection\&. +.RE +.PP +\fBrep\-tries\fR \fIint\fR +.RS 4 +Default: +\fI5\fR\&. How many times amandad will resend a REP packet if it doesn\*(Aqt get the ACK packet\&. +.RE +.PP +\fBdebug\-days\fR \fIint\fR +.RS 4 +Default: +\fI3\fR\&. The number of days the debug files are kept\&. +.RE +.PP +\fBdebug\-amandad\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the amandad process +.RE +.PP +\fBdebug\-amidxtaped\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the amidxtaped process +.RE +.PP +\fBdebug\-amindexd\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the amindexd process +.RE +.PP +\fBdebug\-amrecover\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the amrecover process +.RE +.PP +\fBdebug\-auth\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the auth module +.RE +.PP +\fBdebug\-event\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the event module +.RE +.PP +\fBdebug\-holding\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the holdingdisk module +.RE +.PP +\fBdebug\-protocol\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the protocol module +.RE +.PP +\fBdebug\-selfcheck\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the selfcheck process +.RE +.PP +\fBdebug\-sendsize\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the sendsize process +.RE +.PP +\fBdebug\-sendbackup\fR \fIint\fR +.RS 4 +Default: +\fI0\fR\&. Debug level of the sendbackup process +.RE +.PP +\fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR +.RS 4 +Default: \-\-with\-udpportrange or +\fI512,1023\fR\&. Reserved udp port that will be used (amrecover with bsd or bsdudp) +.RE +.PP +\fBreserved\-tcp\-port\fR \fIint\fR,\fIint\fR +.RS 4 +Default: \-\-with\-low\-tcpportrange or +\fI512,1023\fR\&. Reserved tcp port that will be used (amrecover with bsdtcp) +.RE +.PP +\fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR +.RS 4 +Default: \-\-with\-tcpportrange or +\fI1025,65536\fR\&. Unreserved tcp port that will be used (bsd, bsdudp) +.RE +.PP +\fBproperty\fR \fIstring\fR \fIstring\fR+ +.RS 4 +Adds a global property for this client host, useful for e\&.g\&., Application API plugins\&. The first string is the property name, the following strings are the property values +.RE +.SH "APPLICATION SECTION" +.PP +The +\fBamanda\-client\&.conf\fR +file may define multiple types of application\&. The information is entered in a +\fBapplication\fR +section, which looks like this: +.nf +define application "\fIname\fR" { + \fIapplication\-option\fR \fIapplication\-value\fR + \&.\&.\&. +} +.fi +.PP +\fIname\fR +is the name of this type of application\&. +.PP +The setting from an application is merged with the dle setting if the +\fIname\fR +is the same as the +\fBclient\-application\-name\fR +from the dle or if the +\fBclient\-application\-name\fR +from the dle is not set and the +\fIname\fR +is the same as the +\fBplugin\fR +from the dle\&. +.PP +The application options and values are: +.PP +\fBclient\-application\-name\fR \fIstring\fR +.RS 4 +Default: +\fInone\fR\&. Not use on the client\&. +.RE +.PP +\fBcomment\fR \fIstring\fR +.RS 4 +Default: +\fInone\fR\&. A comment string describing this application\&. +.RE +.PP +\fBplugin\fR \fIstring\fR +.RS 4 +No default\&. Must be set to the name of the program\&. This program must be in the +\fI$libexecdir/amanda/application\fR +directory on the client\&. If set, it must be the same as the dle +\fBplugin\fR\&. +.RE +.PP +\fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+ +.RS 4 +No default\&. You can set property for the application, each application have a different set of property\&. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values\&. +\fBappend\fR +keyword append the values to the list of values for that property\&. +\fBpriority\fR +keyword disallow the setting of that property on the server\&. +.RE +.SH "SCRIPT SECTION" +.PP +The +\fBamanda\-client\&.conf\fR +file may define multiple types of script\&. The information is entered in a +\fBscript\fR +section, which looks like this: +.nf +define script "\fIname\fR" { + \fIscript\-option\fR \fIscript\-value\fR + \&.\&.\&. +} +.fi +.PP +\fIname\fR +is the name of this type of script\&. +.PP +The setting from a script is merged with the dle setting if the +\fIname\fR +is the same as the +\fBclient\-script\-name\fR +from the dle or if the +\fBclient\-script\-name\fR +from the dle is not set and the +\fIname\fR +is the same as the +\fBplugin\fR +from the dle\&. +.PP +The script options and values are: +.PP +\fBclient\-script\-name\fR \fIstring\fR +.RS 4 Default: -\fB/etc/amandates\fR. The file where amanda keep the last date of each dumplevel. -.SH "AUTHOR" +\fInone\fR\&. Not used on the client\&. +.RE .PP -James da Silva, -: Original text +\fBcomment\fR \fIstring\fR +.RS 4 +Default: +\fInone\fR\&. A comment string describing this script\&. +.RE .PP -Stefan G. Weichinger, -, maintainer of the -\fBAmanda\fR-documentation: XML-conversion, major update, splitting +\fBplugin\fR \fIstring\fR +.RS 4 +No default\&. Must be set to the name of the program\&. This program must be in the +\fI$libdir/amanda/application\fR +directory on the client\&. If set, it must be the same as the dle +\fBplugin\fR\&. +.RE +.PP +\fBexecute\-where\fR \fBclient\fR +.RS 4 +Default: +\fBclient\fR\&. Value can\*(Aqt be changed\&. +.RE +.PP +\fBexecute\-on\fR \fIexecute_on\fR[,\fIexecute_on\fR]* +.RS 4 +No default\&. When the script must be executed, you can specify many of them: +.PP +\fBpre\-dle\-amcheck\fR +.RS 4 +Execute before the amcheck command for the dle\&. +.RE +.PP +\fBpre\-host\-amcheck\fR +.RS 4 +Execute before the amcheck command for all dle for the client\&. +.RE +.PP +\fBpost\-dle\-amcheck\fR +.RS 4 +Execute after the amcheck command for the dle\&. +.RE +.PP +\fBpost\-host\-amcheck\fR +.RS 4 +Execute after the amcheck command for all dle for the client\&. +.RE +.PP +\fBpre\-dle\-estimate\fR +.RS 4 +Execute before the estimate command for the dle\&. +.RE +.PP +\fBpre\-host\-estimate\fR +.RS 4 +Execute before the estimate command for all dle for the client\&. +.RE +.PP +\fBpost\-dle\-estimate\fR +.RS 4 +Execute after the estimate command for the dle\&. +.RE +.PP +\fBpost\-host\-estimate\fR +.RS 4 +Execute after the estimate command for all dle for the client\&. +.RE +.PP +\fBpre\-dle\-backup\fR +.RS 4 +Execute before the backup command for the dle\&. +.RE +.PP +\fBpost\-dle\-backup\fR +.RS 4 +Execute after the backup command for the dle\&. +.RE +.PP +\fBpre\-recover\fR +.RS 4 +Execute before any level is recovered\&. +.RE +.PP +\fBpost\-recover\fR +.RS 4 +Execute after all levels are recovered\&. +.RE +.PP +\fBpre\-level\-recover\fR +.RS 4 +Execute before each level recovery\&. +.RE +.PP +\fBpost\-level\-recover\fR +.RS 4 +Execute after each level recovery\&. +.RE +.PP +\fBinter\-level\-recover\fR +.RS 4 +Execute between two levels of recovery\&. +.RE +.RE +.PP +\fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+ +.RS 4 +No default\&. You can set property for the script, each script have a different set of property\&. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values\&. +\fBappend\fR +keyword append the values to the list of values for that property\&. +\fBpriority\fR +keyword disallow the setting of that property on the server\&. +.RE .SH "SEE ALSO" .PP \fBamanda\fR(8), \fBamanda.conf\fR(5), \fBamcrypt\fR(8), -\fBaespipe\fR(1), - +\fBaespipe\fR(1) +.PP +The Amanda Wiki: +: http://wiki.zmanda.com/ +.SH "AUTHORS" +.PP +\fBJames da Silva\fR <\&jds@amanda\&.org\&> +.PP +\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>