X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famanda.conf.5.xml;h=518264d9103a819881b0f56f9043996e6df25ef5;hb=b221e8dc16f345f8c8d7df8df71f4d36daaabb4c;hp=e1a26c9a965677623afaaca8e7190ddec0d84436;hpb=c16b04cb8ba646250049afa94e22e7a800b94e7d;p=debian%2Famanda diff --git a/man/xml-source/amanda.conf.5.xml b/man/xml-source/amanda.conf.5.xml index e1a26c9..518264d 100644 --- a/man/xml-source/amanda.conf.5.xml +++ b/man/xml-source/amanda.conf.5.xml @@ -460,11 +460,22 @@ tape label to most volume she encounters. This option is DANGEROUS because when set, Amanda may erase near-failing tapes or tapes accidentally loaded in the wrong slot. When using this directive, specify the template for new tape -labels. The template should contain some number of contiguous '%' +labels. The template can contains many variables that are substituted by their +values: + + $c : config name + $o : org configuration + $b : barcode of the volume + $m : meta label + +The template should contain some number of contiguous '%' characters, which will be replaced with a generated number. Be sure to specify enough '%' characters that you do not run out of tape labels. Example: -autolabel "DailySet1-%%%" empty +"DailySet1-%%%", +"$c-%%%", +"$m-%%%", +"$m-$b" Note that many devices cannot distinguish an empty tape from an error condition, so it may is often necessary to include @@ -504,6 +515,31 @@ Danger: this may erase arbitrary volumes due to transient errors. + + meta-autolabel + string + +Default: not set. When set and if the changer support meta-label, this directive will cause Amanda to automatically add a meta-label to a meta-volume. +A meta-volume is a containers that contains many volumes, eg. a removable +hard-disk for use with chg-disk, each hard disk have many slots (volume). +The meta-label is the label to put on the meta-volume. +When using this directive, specify the template for new meta +labels. The template can contains many variables that are substituted by their +values: + + $c : config name + $o : org configuration + +The template should contain some number of contiguous '%' +characters, which will be replaced with a generated number. Be sure to +specify enough '%' characters that you do not run out of meta labels. +Example: +"DailySet1-%%%", +"$o-%%%", + + + + dumpuser string @@ -580,6 +616,24 @@ configuring changers. + + interactivity string + +Default: not set. The interactivity module Amanda should use to interact with +the user. See for a list of +modules. + + + + + taperscan string + +Default: traditional. The taperscan module amanda should use to find a tape +to write to. See for a list of +modules. + + + changerdev string @@ -1040,11 +1094,13 @@ the amount of holding disk space reserved for incrementals should be lowered.

- autoflush bool + autoflush no|yes|all Default: -off. -Whether an amdump run will flush the dumps from holding disk to tape. +no. +Whether an amdump run will flush the dumps from holding disk to tape. +With yes, only dump matching the command line argument are flushed. +With all, all dump are flushed. @@ -1349,16 +1405,20 @@ Range is inclusive. - recovery-limit [ string | same-host ] + recovery-limit [ string | same-host | server] Default: none (no limitations). This parameter limits the hosts - that may do remote recoveries. Hosts are identified by their authenticated + that may do recoveries. Hosts are identified by their authenticated peer name, as described in ; if this is not available and the recovery-limit parameter is present, recovery will be denied. The arguments to the parameter are strings giving host match expressions (see ) or the special - keyword same-host, which requires an exact match to the hostname of the - DLE being recovered. Specifying no arguments at all will disable all + keywords same-host or server. + The same-host keyword requires an exact + match to the hostname of the DLE being recovered. + The server keyword require the connection come from + the fqdn of the server. + Specifying no arguments at all will disable all recoveries from any host. Note that match expressions can be constructed to be @@ -1505,7 +1565,7 @@ are defined. auth string Default: -"bsd". +"bsdtcp". Type of authorization to perform between tape server and backup client hosts. See for more detail. @@ -1540,6 +1600,7 @@ Specifies the port to connect to on the client. It can be a service name or a n + @@ -2223,7 +2284,7 @@ The default unit is Kbytes if it is not specified. recovery-limit - [ same-host | string ]* + [ server | same-host | string ]* Default: global value. This parameter overrides the global @@ -2232,6 +2293,20 @@ The default unit is Kbytes if it is not specified. + + + dump-limit + [ server | same-host ]* + + +Default: server. Specify which host can initiate + a backup of the dle. With server, the server + can initiate a backup with the amdump command. + With same-host, the client can initiate a backup with + the amdump_client command. + + + The following dumptype entries are predefined by Amanda: @@ -2250,7 +2325,10 @@ define dumptype "srvcompress" { compress server fast } define dumptype "bsd-auth" { - auth bsd + auth "bsd" +} +define dumptype "bsdtcp-auth" { + auth "bsdtcp" } define dumptype "no-record" { record no @@ -2558,6 +2636,21 @@ is the name of this type of application. It is referenced from the The application options and values are: + + client-name string + +No default, +specifies an application name that is in the amanda-client.conf on the client. +The setting from that application will be merged with the current application. +If client-name is set then it is an error +if that application is not defined on the client. +If client-name is not set then the +merge is done with the application that have the name equal to the plugin. +eg. if the plugin is 'amgtar', then the setting from the application 'amgtar' +is used if it is defined. + + + comment string @@ -2605,6 +2698,20 @@ is the name of this type of script. It is referenced from the The script options and values are: + + client-name string + +No default, +specifies a script name that is in the amanda-client.conf on the client. +The setting from that script will be merged with the currect script. +If client-name is set then it is an error if that script is not defined on the client. +If client-name is not set then the +merge is done with the script that have the name equal to the plugin. +eg. if the plugin is 'amlog-script', then the setting from the script +'amlog-script' is used. + + + comment string @@ -2622,6 +2729,12 @@ A comment string describing this script. order int Default: 5000. Scripts are executed in that order, it is useful if you have many scripts and they must be executed in a spefific order. + + + + single-execution boolean + +Default: no. The script is executed for each dle. If yes, the script is executed one time only. @@ -2636,6 +2749,12 @@ A comment string describing this script. No default. When the script must be executed, you can specify many of them: + + pre-amcheck + +Execute before the amcheck command for all dle. Can only be run on server. + + pre-dle-amcheck @@ -2646,6 +2765,12 @@ A comment string describing this script. pre-host-amcheck Execute before the amcheck command for all dle for the client. + + + + post-amcheck + +Execute after the amcheck command for all dle. Can only be run on server. @@ -2658,6 +2783,12 @@ A comment string describing this script. post-host-amcheck Execute after the amcheck command for all dle for the client. + + + + pre-estimate + +Execute before the estimate command for all dle. Can only be run on server. @@ -2670,6 +2801,12 @@ A comment string describing this script. pre-host-estimate Execute before the estimate command for all dle for the client. + + + + post-estimate + +Execute after the estimate command for all dle. Can only be run on server. @@ -2682,6 +2819,12 @@ A comment string describing this script. post-host-estimate Execute after the estimate command for all dle for the client. + + + + pre-backup + +Execute before the backup command for all dle. Can only be run on server. @@ -2694,6 +2837,12 @@ A comment string describing this script. pre-host-backup Execute before the backup command for all dle for the client. It can't be run on client, it must be run on server + + + + post-backup + +Execute after the backup command for all dle. Can only be run on server. @@ -2821,6 +2970,105 @@ device. The remaining parameters are specific to the changer type selected. +INTERACTIVITY SECTION +The +amanda.conf +file may define multiple interactivyt methods, although only one will be used - that specified +by the interactivity parameter. +The information is entered in a interactivity +section, which looks like this: + + +define interactivity name { + interactivity-option interactivity-value + ... +} + + +The { must appear at the end of a line, and the } on its own line. +name is the user-specified name of this +interactivity. The remaining parameters are specific to the interactivity type +selected. + + +The interactivity options and values are: + + + comment string + +Default: not set. +A comment string describing this interactivity. + + + + plugin string + +No default. Must be set to the name of the interactivity module, as described in . + + + + property [append] string string+ + +No default. You can set arbitrary properties for the interactivity. Each interactivity module has a different set of properties. The first string contains the name of +the property to set, and the others contains its values. All strings should be quoted. +The append keyword appends the given values to an existing list of values for that property. + + + + + +See for more information on configuring interactivity methods. + + + +TAPERSCAN SECTION +The +amanda.conf +file may define multiple taperscan methods, although only one will be used - that specified +by the taperscan parameter. +The information is entered in a taperscan +section, which looks like this: + + +define taperscan name { + taperscan-option taperscan-value + ... +} + + +The { must appear at the end of a line, and the } on its own line. +name is the user-specified name of this +taperscan. The remaining parameters are specific to the taperscan type +selected. + + +The taperscan options and values are: + + + comment string + +Default: not set. +A comment string describing this taperscan. + + + + plugin string + +No default. Must be set to the name of the taperscan module. See for a list of defined taperscan modules. + + + + property [append] string string+ + +No default. Operates just like properties for interactivity methods, above. + + + + +See for more information on configuring taperscan. + + + Dump Splitting Configuration Amanda can "split" dumps into parts while writing them to storage @@ -2881,7 +3129,9 @@ device. The remaining parameters are specific to the changer type selected. , , , +, +