X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famanda-client.conf.5.xml;h=2a1dcddea26dff73cb97f79b1a5c68dcd037d9d6;hb=b221e8dc16f345f8c8d7df8df71f4d36daaabb4c;hp=5ec5de6a75c862b615ff377f5ed730fa99b14c75;hpb=94a044f90357edefa6f4ae9f0b1d5885b0e34aee;p=debian%2Famanda
diff --git a/man/xml-source/amanda-client.conf.5.xml b/man/xml-source/amanda-client.conf.5.xml
index 5ec5de6..2a1dcdd 100644
--- a/man/xml-source/amanda-client.conf.5.xml
+++ b/man/xml-source/amanda-client.conf.5.xml
@@ -3,7 +3,7 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
-
+
%global_entities;
]>
@@ -12,247 +12,180 @@
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
+Client configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
+
+&author.jds;
+&author.sgw.xml;
+
DESCRIPTION
-&amclientconf; is the client configuration file for &A;. This manpage lists the
+&amclientconf; is the client configuration file for Amanda. This manpage lists the
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.
-
-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.
+The syntax of &amclientconf; is identical to that for
+.
-Keywords are case insensitive, i.e.
-auth
-and
-Auth
-are treated the same.
-
-Integer arguments may have one of the following (case insensitive) suffixes,
-some of which have a multiplier effect:
+
-POSSIBLE SUFFIXES
+
+GLOBAL PARAMETERS
- b byte bytes
-
-Some number of bytes.
-
-
-
- bps
+ conf string
-Some number of bytes per second.
-
-
-
- k kb kbyte kbytes kilobyte kilobytes
-
-Some number of kilobytes (bytes*1024).
-
-
-
- kps kbps
-
-Some number of kilobytes per second (bytes*1024).
-
-
-
- m mb meg mbyte mbytes megabyte megabytes
-
-Some number of megabytes (bytes*1024*1024).
-
-
-
- mps mbps
-
-Some number of megabytes per second (bytes*1024*1024).
-
-
-
- g gb gbyte gbytes gigabyte gigabytes
-
-Some number of gigabytes (bytes*1024*1024*1024).
-
-
-
- tape tapes
-
-Some number of tapes.
-
-
-
- day days
-
-Some number of days.
+Default:
+Set by configure.
+The conf use by amrecover.
+
- week weeks
+ client-username string
-Some number of weeks (days*7).
-
-The value
-inf
-may be used in most places where an integer is expected
-to mean an infinite amount.
-
-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.
-
-
+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.
-
-
-
-
-PARAMETERS
-
- conf string
+ client-port [ int | string ]
Default:
-Set by configure.
-The conf use by amrecover.
+"amanda".
+Similar to the parameter of the same name in &amconf;, this specifies the port to connect on the server. It can be a service name or a numeric port number.
- index_server string
+ index-server string
Default:
-Set by configure.
+Set by configure.
The amindexd server amrecover will connect to.
- tape_server string
+ tape-server string
Default:
-Set by configure.
+Set by configure.
The amidxtaped server amrecover will connect to.
- tapedev string
+ tapedev string
Default:
-Set by configure.
+Set by configure.
The tapedev amrecover will use.
- auth string
+ auth string
Default:
-bsd.
+"bsdtcp".
Type of authorization to perform between tape server and backup client hosts.
-bsd, bsd authorization with udp initial
+"bsd", bsd authorization with udp initial
connection and one tcp connection by data stream.
-bsdtcp, bsd authorization but use only
+"bsdtcp", bsd authorization but use only
one tcp connection.
-bsdudp, like bsd, but will use only one
+"bsdudp", like bsd, but will use only one
tcp connection for all data stream.
-krb4 to use Kerberos-IV
+"krb5" to use Kerberos-V
authorization.
-krb5 to use Kerberos-V
-authorization.
-local, if the client is the server, it
+"local", if the client is the server, it
doesn't require authencation setup.
-rsh to use rsh
+"rsh" to use rsh
authorization.
-ssh to use OpenSSH
+"ssh" to use OpenSSH
authorization.
- ssh_keys string
+ ssh-keys string
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.
+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.
- gnutar_list_dir string
+ gnutar-list-dir string
Default from configure
---with-gnutar-listdir=DIR.
+--with-gnutar-listdir=DIR.
The directory where gnutar keep its state file.
- amandates string
+ mailer string
+
+Default found by configure. A mail program that can send mail with 'MAILER -s "subject" user < message_file'.
+
+
+
+
+ amandates string
Default:
-/etc/amandates.
+/etc/amandates.
The file where amanda keep the last date of each dumplevel.
- connect_tries int
+ connect-tries int
Default:
-3.
+3.
How many times the server will try a connection.
- rep_tries int
+ rep-tries int
Default:
-5.
+5.
How many times amandad will resend a REP packet if it doesn't get the ACK packet.
- debug_amandad int
+ debug-days int
+
+Default:
+3.
+The number of days the debug files are kept.
+
+
+
+
+ debug-amandad int
Default:
0.
@@ -261,139 +194,361 @@ Debug level of the amandad process
- debug_amidxtaped int
+ debug-amidxtaped int
Default:
-0.
+0.
Debug level of the amidxtaped process
- debug_amindexd int
+ debug-amindexd int
Default:
-0.
+0.
Debug level of the amindexd process
- debug_amrecover int
+ debug-amrecover int
Default:
-0.
+0.
Debug level of the amrecover process
- debug_auth int
+ debug-auth int
Default:
-0.
+0.
Debug level of the auth module
- debug_event int
+ debug-event int
Default:
-0.
+0.
Debug level of the event module
- debug_holding int
+ debug-holding int
Default:
-0.
+0.
Debug level of the holdingdisk module
- debug_protocol int
+ debug-protocol int
Default:
-0.
+0.
Debug level of the protocol module
- debug_selfcheck int
+ debug-selfcheck int
Default:
-0.
+0.
Debug level of the selfcheck process
- debug_sendsize int
+ debug-sendsize int
Default:
-0.
+0.
Debug level of the sendsize process
- debug_sendbackup int
+ debug-sendbackup int
Default:
-0.
+0.
Debug level of the sendbackup process
- reserved-udp-port int,int
+ reserved-udp-port int,int
Default: --with-udpportrange or
-512,1023.
+512,1023.
Reserved udp port that will be used (amrecover with bsd or bsdudp)
- reserved-tcp-port int,int
+ reserved-tcp-port int,int
Default: --with-low-tcpportrange or
-512,1023.
+512,1023.
Reserved tcp port that will be used (amrecover with bsdtcp)
- unreserved-tcp-port int,int
+ unreserved-tcp-port int,int
Default: --with-tcpportrange or
-1025,65536.
+1025,65536.
Unreserved tcp port that will be used (bsd, bsdudp)
+
+ property string string+
+
+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
+
+
+
-
-AUTHOR
-James da Silva, &email.jds;: Original text
-&maintainer.sgw;: XML-conversion, major update, splitting
+APPLICATION SECTION
+The
+amanda-client.conf
+file may define multiple types of application.
+The information is entered in a application
+section, which looks like this:
+
+
+define application "name" {
+ application-option application-value
+ ...
+}
+
+
+name
+is the name of this type of application.
+
+The setting from an application is merged with the dle setting
+ if the name is the same as the client-application-name from the dle
+ or if the client-application-name from the dle is not set and the name is the same as the plugin from the dle.
+
+The application options and values are:
+
+
+ client-application-name string
+
+Default:
+none.
+Not use on the client.
+
+
+
+ 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. If set, it must be the same as the dle plugin.
+
+
+
+ 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.
+
+
+
+
-SEE ALSO
+SCRIPT SECTION
+The
+amanda-client.conf
+file may define multiple types of script.
+The information is entered in a script
+section, which looks like this:
+
+
+define script "name" {
+ script-option script-value
+ ...
+}
+
+
+name
+is the name of this type of script.
-amanda8,
-amanda.conf5,
-amcrypt8,
-aespipe1,
-http://wiki.zmanda.com
+The setting from a script is merged with the dle setting
+ if the name is the same as the client-script-name from the dle
+ or if the client-script-name from the dle is not set and the name is the same as the plugin from the dle.
+
+The script options and values are:
+
+
+ client-script-name string
+
+Default:
+none.
+Not used on the client.
+
+
+
+ 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. If set, it must be the same as the dle plugin.
+
+
+
+ execute-where client
+
+Default: client.
+Value can't be changed.
+
+
+
+ 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.
+
+
+
+ post-dle-backup
+
+Execute after the backup command for the dle.
+
+
+
+ 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.
+
+
+
+
+
+,
+,
+,
+
+