X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famanda-client.conf.5.xml;h=7a93b12431e8e9672d59041bf4a8ddaa6c1aa46c;hb=96f35b20267e8b1a1c846d476f27fcd330e0b018;hp=1433e20b9151f0c38c56e44bb11012158a1b4aba;hpb=12179dea039515c06168c0037d048566a3f623de;p=debian%2Famanda
diff --git a/man/xml-source/amanda-client.conf.5.xml b/man/xml-source/amanda-client.conf.5.xml
index 1433e20..7a93b12 100644
--- a/man/xml-source/amanda-client.conf.5.xml
+++ b/man/xml-source/amanda-client.conf.5.xml
@@ -12,11 +12,18 @@
amanda-client.conf
5
+&rmi.source;
+&rmi.version;
+&rmi.manual.5;
amanda-client.conf
Client configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver
+
+&author.jds;
+&author.sgw.xml;
+
DESCRIPTION
@@ -25,219 +32,490 @@ relevant sections and parameters of this file for quick reference.
The files <CONFIG_DIR>/amanda-client.conf and <CONFIG_DIR>/<config>/amanda-client.conf are loaded.
-PARAMETERS
+SYNTAX
-There are a number of configuration parameters that control the
-behavior of the &A; programs.
-All have default values,
-so you need not specify the parameter in
-amanda-client.conf
-if the default is suitable.
+The syntax of &amclientconf; is identical to that for
+amanda.conf5.
-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.
+
-Keywords are case insensitive, i.e.
-auth
-and
-Auth
-are treated the same.
+
+GLOBAL PARAMETERS
-Integer arguments may have one of the following (case insensitive) suffixes,
-some of which have a multiplier effect:
+
+
+ conf string
+
+Default:
+Set by configure.
+The conf use by amrecover.
+
+
-POSSIBLE SUFFIXES
+
+ client_username string
+
+Default:
+CLIENT_LOGIN.
+Similar to the parameter of the same name in &amconf;, this specifies the username that
+&amrecover; should send when connecting to the server. It should match the username
+specified in &amandahosts; on the server.
+
+
-
- b byte bytes
+ index_server string
-Some number of bytes.
+Default:
+Set by configure.
+The amindexd server amrecover will connect to.
+
- bps
+ tape_server string
-Some number of bytes per second.
+Default:
+Set by configure.
+The amidxtaped server amrecover will connect to.
+
- k kb kbyte kbytes kilobyte kilobytes
+ tapedev string
-Some number of kilobytes (bytes*1024).
+Default:
+Set by configure.
+The tapedev amrecover will use.
+
- kps kbps
+ auth string
-Some number of kilobytes per second (bytes*1024).
+Default:
+bsd.
+Type of authorization to perform between tape server and backup client hosts.
+bsd, bsd authorization with udp initial
+connection and one tcp connection by data stream.
+bsdtcp, bsd authorization but use only
+one tcp connection.
+bsdudp, like bsd, but will use only one
+tcp connection for all data stream.
+krb4 to use Kerberos-IV
+authorization.
+krb5 to use Kerberos-V
+authorization.
+local, if the client is the server, it
+doesn't require authencation setup.
+rsh to use rsh
+authorization.
+ssh to use OpenSSH
+authorization.
+
+
- m mb meg mbyte mbytes megabyte megabytes
+ ssh_keys string
-Some number of megabytes (bytes*1024*1024).
+Default:
+No default.
+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.
+
- mps mbps
+ gnutar_list_dir string
-Some number of megabytes per second (bytes*1024*1024).
+Default from configure
+--with-gnutar-listdir=DIR.
+The directory where gnutar keep its state file.
+
- g gb gbyte gbytes gigabyte gigabytes
+ mailer string
-Some number of gigabytes (bytes*1024*1024*1024).
+Default found by configure. A mail program that can send mail with 'MAILER -s "subject" user < message_file'.
+
- tape tapes
+ amandates string
-Some number of tapes.
+Default:
+/etc/amandates.
+The file where amanda keep the last date of each dumplevel.
+
- day days
+ connect_tries int
-Some number of days.
+Default:
+3.
+How many times the server will try a connection.
+
- week weeks
+ rep_tries int
-Some number of weeks (days*7).
+Default:
+5.
+How many times amandad will resend a REP packet if it doesn't get the ACK packet.
+
+
-The value
-inf
-may be used in most places where an integer is expected
-to mean an infinite amount.
+
+ debug_amandad int
+
+Default:
+0.
+Debug level of the amandad process
+
+
-Boolean arguments may have any of the values
-y,
-yes,
-t,
-true
-or
-on
-to indicate a true state, or
-n,
-no,
-f,
-false
-or
-off
-to indicate a false state.
-If no argument is given,
-true
-is assumed.
-
-
+
+ debug_amidxtaped int
+
+Default:
+0.
+Debug level of the amidxtaped process
-
-
-
-PARAMETERS
+
+ debug_amindexd int
+
+Default:
+0.
+Debug level of the amindexd process
+
+
-
- conf string
+ debug_amrecover int
Default:
-Set by configure.
-The conf use by amrecover.
+0.
+Debug level of the amrecover process
- index_server string
+ debug_auth int
Default:
-Set by configure.
-The amindexd server amrecover will connect to.
+0.
+Debug level of the auth module
- tape_server string
+ debug_event int
Default:
-Set by configure.
-The amidxtaped server amrecover will connect to.
+0.
+Debug level of the event module
- tapedev string
+ debug_holding int
Default:
-Set by configure.
-The tapedev amrecover will use.
+0.
+Debug level of the holdingdisk module
- auth string
+ debug_protocol int
Default:
-bsd.
-Type of authorization to perform between tape server and backup client hosts.
-bsd, bsd authorization with udp initial
-connection and one tcp connection by data stream.
-bsdtcp, bsd authorization but use only
-one tcp connection.
-bsdudp, like bsd, but will use only one
-tcp connection for all data stream.
-krb4 to use Kerberos-IV
-authorization.
-krb5 to use Kerberos-V
-authorization.
-rsh to use rsh
-authorization.
-ssh to use OpenSSH
-authorization.
+0.
+Debug level of the protocol module
+
+
+
+ debug_selfcheck int
+
+Default:
+0.
+Debug level of the selfcheck process
- ssh_keys string
+ debug_sendsize int
Default:
-No default.
-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.
+0.
+Debug level of the sendsize process
- gnutar_list_dir string
+ debug_sendbackup int
-Default from configure
---with-gnutar-listdir=DIR.
-The directory where gnutar keep its state file.
+Default:
+0.
+Debug level of the sendbackup process
- amandates string
+ reserved-udp-port int,int
-Default:
-/etc/amandates.
-The file where amanda keep the last date of each dumplevel.
+Default: --with-udpportrange or
+512,1023.
+Reserved udp port that will be used (amrecover with bsd or bsdudp)
+
+
+
+
+ reserved-tcp-port int,int
+
+Default: --with-low-tcpportrange or
+512,1023.
+Reserved tcp port that will be used (amrecover with bsdtcp)
+
+
+
+
+ unreserved-tcp-port int,int
+
+Default: --with-tcpportrange or
+1025,65536.
+Unreserved tcp port that will be used (bsd, bsdudp)
+
+
+
+
+ property "name" "value"
+
+Adds a global property for this client host, useful for e.g., Application API plugins.
-
-AUTHOR
-James da Silva, &email.jds;: Original text
-&maintainer.sgw;: XML-conversion, major update, splitting
+APPLICATION SECTION
+The
+amanda.conf
+file may define multiple types of application.
+The information is entered in a application-tool
+section, which looks like this:
+
+
+define application-tool "name" {
+ application-option appli
+cation-value
+ ...
+}
+
+
+name
+is the name of this type of application. It is referenced from the
+dumptype
+
+The application-tool options and values are:
+
+
+ comment string
+
+Default:
+none.
+A comment string describing this application.
+
+
+
+ plugin string
+
+No default. Must be set to the name of the program. This program must be
+in the $libexecdir/amanda/application directory
+on the client.
+
+
+
+ property [append] [priority] string string+
+
+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.
+append keyword append the values to the list of values for that property.
+priority keyword disallow the setting of that property on the server.
+
+
+
+
+
+
+SCRIPT SECTION
+The
+amanda.conf
+file may define multiple types of script.
+The information is entered in a script-tool
+section, which looks like this:
+
+
+define script-tool "name" {
+ script-option script-value
+ ...
+}
+
+
+name
+is the name of this type of script. It is referenced from the
+dumptype
+
+The script-tool options and values are:
+
+
+ comment string
+
+Default:
+none.
+A comment string describing this script.
+
+
+
+ plugin string
+
+No default. Must be set to the name of the program. This program must be in the $libdir/amanda/application directory on the client and/or server.
+
+
+
+ execute_where [client|server]
+
+Default: client. Where the script must be executed, on the client or server. Only client is valid.
+
+
+
+ execute_on execute_on[,execute_on]*
+
+No default. When the script must be executed, you can specify many of them:
+
+
+
+ pre-dle-amcheck
+
+Execute before the amcheck command for the dle.
+
+
+
+ pre-host-amcheck
+
+Execute before the amcheck command for all dle for the client.
+
+
+
+ post-dle-amcheck
+
+Execute after the amcheck command for the dle.
+
+
+
+ post-host-amcheck
+
+Execute after the amcheck command for all dle for the client.
+
+
+
+ pre-dle-estimate
+
+Execute before the estimate command for the dle.
+
+
+
+ pre-host-estimate
+
+Execute before the estimate command for all dle for the client.
+
+
+
+ post-dle-estimate
+
+Execute after the estimate command for the dle.
+
+
+
+ post-host-estimate
+
+Execute after the estimate command for all dle for the client.
+
+
+
+ pre-dle-backup
+
+Execute before the backup command for the dle.
+
+
+
+ pre-host-backup
+
+Execute before the backup command for all dle for the client.
+
+
+
+ post-dle-backup
+
+Execute after the backup command for the dle.
+
+
+
+ post-host-backup
+
+Execute after the backup command for all dle for the client.
+
+
+
+ pre-recover
+
+Execute before any level is recovered.
+
+
+
+ post-recover
+
+Execute after all levels are recovered.
+
+
+
+ pre-level-recover
+
+Execute before each level recovery.
+
+
+
+ post-level-recover
+
+Execute after each level recovery.
+
+
+
+ inter-level-recover
+
+Execute between two levels of recovery.
+
+
+
+
+
+
+ property [append] [priority] string string+
+
+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.
+append keyword append the values to the list of values for that property.
+priority keyword disallow the setting of that property on the server.
+
+
+
+
SEE ALSO
@@ -246,6 +524,7 @@ The file where amanda keep the last date of each dumplevel.
amanda.conf5,
amcrypt8,
aespipe1,
+