#include "amanda.h"
#include "fsusage.h"
- #include "version.h"
#include "getfsent.h"
#include "amandates.h"
#include "clock.h"
int need_gnutar=0;
int need_compress_path=0;
int need_calcsize=0;
+ int need_global_check=0;
int program_is_application_api=0;
static char *amandad_auth = NULL;
dle_t *dle;
int level;
GSList *errlist;
+ level_t *alevel;
/* initialize */
textdomain("amanda");
safe_fd(-1, 0);
+ openbsd_fd_inform();
safe_cd();
set_pname("selfcheck");
/* Don't die when child closes pipe */
signal(SIGPIPE, SIG_IGN);
- erroutput_type = (ERR_INTERACTIVE|ERR_SYSLOG);
+ add_amanda_log_handler(amanda_log_stderr);
+ add_amanda_log_handler(amanda_log_syslog);
dbopen(DBG_SUBDIR_CLIENT);
startclock();
- dbprintf(_("version %s\n"), version());
+ dbprintf(_("version %s\n"), VERSION);
if(argc > 2 && strcmp(argv[1], "amandad") == 0) {
amandad_auth = stralloc(argv[2]);
dle->program = s - 1;
skip_non_whitespace(s, ch);
s[-1] = '\0';
- dle->calcsize = 1;
+ dle->estimatelist = g_slist_append(dle->estimatelist,
+ GINT_TO_POINTER(ES_CALCSIZE));
}
else {
- dle->calcsize = 0;
+ dle->estimatelist = g_slist_append(dle->estimatelist,
+ GINT_TO_POINTER(ES_CLIENT));
}
skip_whitespace(s, ch); /* find disk name */
if (ch == '\0' || sscanf(s - 1, "%d", &level) != 1) {
goto err; /* bad level */
}
- dle->level = g_slist_append(dle->level, GINT_TO_POINTER(level));
+ alevel = g_new0(level_t, 1);
+ alevel->level = level;
+ dle->levellist = g_slist_append(dle->levellist, alevel);
skip_integer(s, ch);
skip_whitespace(s, ch);
need_gnutar=1;
need_compress_path=1;
need_calcsize=1;
+ need_global_check=1;
/*@ignore@*/
check_disk(dle);
/*@end@*/
check_options(
dle_t *dle)
{
- if (dle->calcsize == 1) {
+ if (GPOINTER_TO_INT(dle->estimatelist->data) == ES_CALCSIZE) {
need_calcsize=1;
}
if (strcmp(dle->program,"GNUTAR") == 0) {
need_gnutar=1;
- if(dle->device[0] == '/' && dle->device[1] == '/') {
+ if(dle->device && dle->device[0] == '/' && dle->device[1] == '/') {
if(dle->exclude_file && dle->exclude_file->nb_element > 1) {
g_printf(_("ERROR [samba support only one exclude file]\n"));
}
#ifndef AIX_BACKUP
#ifdef VDUMP
#ifdef DUMP
- if (strcmp(amname_to_fstype(dle->device), "advfs") == 0)
+ if (dle->device && strcmp(amname_to_fstype(dle->device), "advfs") == 0)
#else
if (1)
#endif
#endif /* VDUMP */
#ifdef XFSDUMP
#ifdef DUMP
- if (strcmp(amname_to_fstype(dle->device), "xfs") == 0)
+ if (dle->device && strcmp(amname_to_fstype(dle->device), "xfs") == 0)
#else
if (1)
#endif
#endif /* XFSDUMP */
#ifdef VXDUMP
#ifdef DUMP
- if (strcmp(amname_to_fstype(dle->device), "vxfs") == 0)
+ if (dle->device && strcmp(amname_to_fstype(dle->device), "vxfs") == 0)
#else
if (1)
#endif
check_disk(
dle_t *dle)
{
- char *device = stralloc("nodevice");
+ char *device = NULL;
char *err = NULL;
char *user_and_password = NULL;
char *domain = NULL;
char *share = NULL, *subdir = NULL;
size_t lpass = 0;
- int amode;
+ int amode = R_OK;
int access_result;
char *access_type;
char *extra_info = NULL;
- char *qdisk = quote_string(dle->disk);
- char *qamdevice = quote_string(dle->device);
+ char *qdisk = NULL;
+ char *qamdevice = NULL;
char *qdevice = NULL;
- dbprintf(_("checking disk %s\n"), qdisk);
- if (dle->calcsize == 1) {
- if (dle->device[0] == '/' && dle->device[1] == '/') {
- err = vstrallocf(_("Can't use CALCSIZE for samba estimate, use CLIENT: %s"),
- dle->device);
- goto common_exit;
- }
- }
-
- if (strcmp(dle->program, "GNUTAR")==0) {
- if(dle->device[0] == '/' && dle->device[1] == '/') {
- #ifdef SAMBA_CLIENT
- int nullfd, checkerr;
- int passwdfd;
- char *pwtext;
- size_t pwtext_len;
- pid_t checkpid;
- amwait_t retstat;
- pid_t wpid;
- int rc;
- char *line;
- char *sep;
- FILE *ferr;
- char *pw_fd_env;
- int errdos;
-
- parsesharename(dle->device, &share, &subdir);
- if (!share) {
- err = vstrallocf(_("cannot parse for share/subdir disk entry %s"), dle->device);
+ if (dle->disk) {
+ need_global_check=1;
+ qdisk = quote_string(dle->disk);
+ qamdevice = quote_string(dle->device);
+ device = stralloc("nodevice");
+ dbprintf(_("checking disk %s\n"), qdisk);
+ if (GPOINTER_TO_INT(dle->estimatelist->data) == ES_CALCSIZE) {
+ if (dle->device[0] == '/' && dle->device[1] == '/') {
+ err = vstrallocf(
+ _("Can't use CALCSIZE for samba estimate, use CLIENT: %s"),
+ dle->device);
goto common_exit;
}
- if ((subdir) && (SAMBA_VERSION < 2)) {
- err = vstrallocf(_("subdirectory specified for share '%s' but, samba is not v2 or better"),
+ }
+
+ if (strcmp(dle->program, "GNUTAR")==0) {
+ if(dle->device[0] == '/' && dle->device[1] == '/') {
+ #ifdef SAMBA_CLIENT
+ int nullfd, checkerr;
+ int passwdfd;
+ char *pwtext;
+ size_t pwtext_len;
+ pid_t checkpid;
+ amwait_t retstat;
+ pid_t wpid;
+ int rc;
+ char *line;
+ char *sep;
+ FILE *ferr;
+ char *pw_fd_env;
+ int errdos;
+
+ parsesharename(dle->device, &share, &subdir);
+ if (!share) {
+ err = vstrallocf(
+ _("cannot parse for share/subdir disk entry %s"),
+ dle->device);
+ goto common_exit;
+ }
+ if ((subdir) && (SAMBA_VERSION < 2)) {
+ err = vstrallocf(_("subdirectory specified for share '%s' but, samba is not v2 or better"),
+ dle->device);
+ goto common_exit;
+ }
+ if ((user_and_password = findpass(share, &domain)) == NULL) {
+ err = vstrallocf(_("cannot find password for %s"),
+ dle->device);
+ goto common_exit;
+ }
+ lpass = strlen(user_and_password);
+ if ((pwtext = strchr(user_and_password, '%')) == NULL) {
+ err = vstrallocf(
+ _("password field not \'user%%pass\' for %s"),
dle->device);
- goto common_exit;
- }
- if ((user_and_password = findpass(share, &domain)) == NULL) {
- err = vstrallocf(_("cannot find password for %s"), dle->device);
- goto common_exit;
- }
- lpass = strlen(user_and_password);
- if ((pwtext = strchr(user_and_password, '%')) == NULL) {
- err = vstrallocf(_("password field not \'user%%pass\' for %s"), dle->device);
- goto common_exit;
- }
- *pwtext++ = '\0';
- pwtext_len = (size_t)strlen(pwtext);
- amfree(device);
- if ((device = makesharename(share, 0)) == NULL) {
- err = vstrallocf(_("cannot make share name of %s"), share);
- goto common_exit;
- }
+ goto common_exit;
+ }
+ *pwtext++ = '\0';
+ pwtext_len = (size_t)strlen(pwtext);
+ amfree(device);
+ if ((device = makesharename(share, 0)) == NULL) {
+ err = vstrallocf(_("cannot make share name of %s"), share);
+ goto common_exit;
+ }
- if ((nullfd = open("/dev/null", O_RDWR)) == -1) {
- err = vstrallocf(_("Cannot access /dev/null : %s"), strerror(errno));
- goto common_exit;
- }
+ if ((nullfd = open("/dev/null", O_RDWR)) == -1) {
+ err = vstrallocf(_("Cannot access /dev/null : %s"),
+ strerror(errno));
+ goto common_exit;
+ }
- if (pwtext_len > 0) {
- pw_fd_env = "PASSWD_FD";
- } else {
- pw_fd_env = "dummy_PASSWD_FD";
- }
- checkpid = pipespawn(SAMBA_CLIENT, STDERR_PIPE|PASSWD_PIPE, 0,
- &nullfd, &nullfd, &checkerr,
- pw_fd_env, &passwdfd,
- "smbclient",
- device,
- *user_and_password ? "-U" : skip_argument,
- *user_and_password ? user_and_password : skip_argument,
- "-E",
- domain ? "-W" : skip_argument,
- domain ? domain : skip_argument,
+ if (pwtext_len > 0) {
+ pw_fd_env = "PASSWD_FD";
+ } else {
+ pw_fd_env = "dummy_PASSWD_FD";
+ }
+ checkpid = pipespawn(SAMBA_CLIENT, STDERR_PIPE|PASSWD_PIPE, 0,
+ &nullfd, &nullfd, &checkerr,
+ pw_fd_env, &passwdfd,
+ "smbclient",
+ device,
+ *user_and_password ? "-U" : skip_argument,
+ *user_and_password ? user_and_password
+ : skip_argument,
+ "-E",
+ domain ? "-W" : skip_argument,
+ domain ? domain : skip_argument,
#if SAMBA_VERSION >= 2
- subdir ? "-D" : skip_argument,
- subdir ? subdir : skip_argument,
+ subdir ? "-D" : skip_argument,
+ subdir ? subdir : skip_argument,
#endif
- "-c", "quit",
- NULL);
- amfree(domain);
- aclose(nullfd);
- /*@ignore@*/
- if ((pwtext_len > 0)
- && full_write(passwdfd, pwtext, pwtext_len) < pwtext_len) {
- err = vstrallocf(_("password write failed: %s: %s"),
- dle->device, strerror(errno));
+ "-c", "quit",
+ NULL);
+ amfree(domain);
+ aclose(nullfd);
+ /*@ignore@*/
+ if ((pwtext_len > 0) &&
+ full_write(passwdfd, pwtext, pwtext_len) < pwtext_len) {
+ err = vstrallocf(_("password write failed: %s: %s"),
+ dle->device, strerror(errno));
+ aclose(passwdfd);
+ goto common_exit;
+ }
+ /*@end@*/
+ memset(user_and_password, '\0', (size_t)lpass);
+ amfree(user_and_password);
aclose(passwdfd);
- goto common_exit;
- }
- /*@end@*/
- memset(user_and_password, '\0', (size_t)lpass);
- amfree(user_and_password);
- aclose(passwdfd);
- ferr = fdopen(checkerr, "r");
- if (!ferr) {
- g_printf(_("ERROR [Can't fdopen: %s]\n"), strerror(errno));
- error(_("Can't fdopen: %s"), strerror(errno));
- /*NOTREACHED*/
- }
- sep = "";
- errdos = 0;
- for(sep = ""; (line = agets(ferr)) != NULL; free(line)) {
- if (line[0] == '\0')
- continue;
- strappend(extra_info, sep);
- strappend(extra_info, line);
- sep = ": ";
- if(strstr(line, "ERRDOS") != NULL) {
- errdos = 1;
+ ferr = fdopen(checkerr, "r");
+ if (!ferr) {
+ g_printf(_("ERROR [Can't fdopen: %s]\n"), strerror(errno));
+ error(_("Can't fdopen: %s"), strerror(errno));
+ /*NOTREACHED*/
}
- }
- afclose(ferr);
- checkerr = -1;
- rc = 0;
- sep = "";
- while ((wpid = wait(&retstat)) != -1) {
- if (!WIFEXITED(retstat) || WEXITSTATUS(retstat) != 0) {
- char *exitstr = str_exit_status("smbclient", retstat);
- strappend(err, sep);
- strappend(err, exitstr);
- sep = "\n";
- amfree(exitstr);
-
- rc = 1;
+ sep = "";
+ errdos = 0;
+ for(sep = ""; (line = agets(ferr)) != NULL; free(line)) {
+ if (line[0] == '\0')
+ continue;
+ strappend(extra_info, sep);
+ strappend(extra_info, line);
+ sep = ": ";
+ if(strstr(line, "ERRDOS") != NULL) {
+ errdos = 1;
+ }
}
- }
- if (errdos != 0 || rc != 0) {
- if (extra_info) {
- err = newvstrallocf(err,
- _("samba access error: %s: %s %s"),
- dle->device, extra_info, err);
- amfree(extra_info);
- } else {
- err = newvstrallocf(err, _("samba access error: %s: %s"),
- dle->device, err);
+ afclose(ferr);
+ checkerr = -1;
+ rc = 0;
+ sep = "";
+ while ((wpid = wait(&retstat)) != -1) {
+ if (!WIFEXITED(retstat) || WEXITSTATUS(retstat) != 0) {
+ char *exitstr = str_exit_status("smbclient", retstat);
+ strappend(err, sep);
+ strappend(err, exitstr);
+ sep = "\n";
+ amfree(exitstr);
+
+ rc = 1;
+ }
+ }
+ if (errdos != 0 || rc != 0) {
+ if (extra_info) {
+ err = newvstrallocf(err,
+ _("samba access error: %s: %s %s"),
+ dle->device, extra_info, err);
+ amfree(extra_info);
+ } else {
+ err = newvstrallocf(err,
+ _("samba access error: %s: %s"),
+ dle->device, err);
+ }
}
- }
#else
- err = vstrallocf(_("This client is not configured for samba: %s"),
- qdisk);
+ err = vstrallocf(
+ _("This client is not configured for samba: %s"),
+ qdisk);
#endif
- goto common_exit;
- }
- amode = F_OK;
- amfree(device);
- device = amname_to_dirname(dle->device);
- } else if (strcmp(dle->program, "DUMP") == 0) {
- if(dle->device[0] == '/' && dle->device[1] == '/') {
- err = vstrallocf(
+ goto common_exit;
+ }
+ amode = F_OK;
+ amfree(device);
+ device = amname_to_dirname(dle->device);
+ } else if (strcmp(dle->program, "DUMP") == 0) {
+ if(dle->device[0] == '/' && dle->device[1] == '/') {
+ err = vstrallocf(
_("The DUMP program cannot handle samba shares, use GNUTAR: %s"),
qdisk);
- goto common_exit;
- }
+ goto common_exit;
+ }
#ifdef VDUMP /* { */
#ifdef DUMP /* { */
- if (strcmp(amname_to_fstype(dle->device), "advfs") == 0)
- #else /* }{ */
- if (1)
+ if (strcmp(amname_to_fstype(dle->device), "advfs") == 0)
+ #else /* }{*/
+ if (1)
#endif /* } */
- {
- amfree(device);
- device = amname_to_dirname(dle->device);
- amode = F_OK;
- } else
+ {
+ amfree(device);
+ device = amname_to_dirname(dle->device);
+ amode = F_OK;
+ } else
#endif /* } */
- {
- amfree(device);
- device = amname_to_devname(dle->device);
+ {
+ amfree(device);
+ device = amname_to_devname(dle->device);
#ifdef USE_RUNDUMP
- amode = F_OK;
+ amode = F_OK;
#else
- amode = R_OK;
+ amode = R_OK;
#endif
+ }
}
}
- else { /* program_is_application_api==1 */
+ if (dle->program_is_application_api) {
pid_t application_api_pid;
backup_support_option_t *bsu;
int app_err[2];
goto common_exit;
}
- if (dle->calcsize && !bsu->calcsize) {
+ if (dle->data_path == DATA_PATH_AMANDA &&
+ (bsu->data_path_set & DATA_PATH_AMANDA)==0) {
+ g_printf("ERROR application %s doesn't support amanda data-path\n",
+ dle->program);
+ }
+ if (dle->data_path == DATA_PATH_DIRECTTCP &&
+ (bsu->data_path_set & DATA_PATH_DIRECTTCP)==0) {
+ g_printf("ERROR application %s doesn't support directtcp data-path\n",
+ dle->program);
+ }
+ if (GPOINTER_TO_INT(dle->estimatelist->data) == ES_CALCSIZE &&
+ !bsu->calcsize) {
g_printf("ERROR application %s doesn't support calcsize estimate\n",
dle->program);
}
case 0: /* child */
{
- char **argvchild, **arg;
+ GPtrArray *argv_ptr = g_ptr_array_new();
+ guint i;
char *cmd = vstralloc(APPLICATION_DIR, "/", dle->program, NULL);
GSList *scriptlist;
script_t *script;
+ estimatelist_t el;
char *cmdline;
- int j=0;
- int k;
aclose(app_err[0]);
dup2(app_err[1], 2);
- k = application_property_argv_size(dle);
- for (scriptlist = dle->scriptlist; scriptlist != NULL;
- scriptlist = scriptlist->next) {
- script = (script_t *)scriptlist->data;
- if (script->result && script->result->proplist) {
- k += property_argv_size(script->result->proplist);
- }
- }
- argvchild = g_new0(char *, 18 + k);
- argvchild[j++] = dle->program;
- argvchild[j++] = "selfcheck";
+ g_ptr_array_add(argv_ptr, stralloc(dle->program));
+ g_ptr_array_add(argv_ptr, stralloc("selfcheck"));
if (bsu->message_line == 1) {
- argvchild[j++] = "--message";
- argvchild[j++] = "line";
+ g_ptr_array_add(argv_ptr, stralloc("--message"));
+ g_ptr_array_add(argv_ptr, stralloc("line"));
}
if (g_options->config != NULL && bsu->config == 1) {
- argvchild[j++] = "--config";
- argvchild[j++] = g_options->config;
+ g_ptr_array_add(argv_ptr, stralloc("--config"));
+ g_ptr_array_add(argv_ptr, stralloc(g_options->config));
}
if (g_options->hostname != NULL && bsu->host == 1) {
- argvchild[j++] = "--host";
- argvchild[j++] = g_options->hostname;
+ g_ptr_array_add(argv_ptr, stralloc("--host"));
+ g_ptr_array_add(argv_ptr, stralloc(g_options->hostname));
}
if (dle->disk != NULL && bsu->disk == 1) {
- argvchild[j++] = "--disk";
- argvchild[j++] = dle->disk;
+ g_ptr_array_add(argv_ptr, stralloc("--disk"));
+ g_ptr_array_add(argv_ptr, stralloc(dle->disk));
+ }
+ if (dle->device) {
+ g_ptr_array_add(argv_ptr, stralloc("--device"));
+ g_ptr_array_add(argv_ptr, stralloc(dle->device));
}
- argvchild[j++] = "--device";
- argvchild[j++] = dle->device;
if (dle->create_index && bsu->index_line == 1) {
- argvchild[j++] = "--index";
- argvchild[j++] = "line";
+ g_ptr_array_add(argv_ptr, stralloc("--index"));
+ g_ptr_array_add(argv_ptr, stralloc("line"));
}
if (dle->record && bsu->record == 1) {
- argvchild[j++] = "--record";
+ g_ptr_array_add(argv_ptr, stralloc("--record"));
}
- if (dle->calcsize && bsu->calcsize == 1) {
- argvchild[j++] = "--calcsize";
+
+ for (el = dle->estimatelist; el != NULL; el=el->next) {
+ estimate_t estimate = (estimate_t)GPOINTER_TO_INT(el->data);
+ if (estimate == ES_CALCSIZE && bsu->calcsize == 1) {
+ g_ptr_array_add(argv_ptr, stralloc("--calcsize"));
+ }
}
- j += application_property_add_to_argv(&argvchild[j], dle, bsu);
+ application_property_add_to_argv(argv_ptr, dle, bsu,
+ g_options->features);
for (scriptlist = dle->scriptlist; scriptlist != NULL;
scriptlist = scriptlist->next) {
script = (script_t *)scriptlist->data;
if (script->result && script->result->proplist) {
- j += property_add_to_argv(&argvchild[j],
- script->result->proplist);
+ property_add_to_argv(argv_ptr,
+ script->result->proplist);
}
}
- argvchild[j++] = NULL;
+ g_ptr_array_add(argv_ptr, NULL);
cmdline = stralloc(cmd);
- for(arg = argvchild; *arg != NULL; arg++) {
- char *quoted = quote_string(*arg);
+ for (i = 0; i < argv_ptr->len-1; i++) {
+ char *quoted = quote_string(
+ (char *)g_ptr_array_index(argv_ptr,i));
cmdline = vstrextend(&cmdline, " ", quoted, NULL);
amfree(quoted);
}
amfree(cmdline);
safe_fd(-1, 0);
- execve(cmd, argvchild, safe_env());
+ execve(cmd, (char **)argv_ptr->pdata, safe_env());
g_printf(_("ERROR [Can't execute %s: %s]\n"), cmd, strerror(errno));
exit(127);
}
return;
}
- qdevice = quote_string(device);
- dbprintf(_("device %s\n"), qdevice);
+ if (device) {
+ qdevice = quote_string(device);
+ dbprintf(_("device %s\n"), qdevice);
- /* skip accessability test if this is an AFS entry */
- if(strncmp_const(device, "afs:") != 0) {
+ /* skip accessability test if this is an AFS entry */
+ if(strncmp_const(device, "afs:") != 0) {
#ifdef CHECK_FOR_ACCESS_WITH_OPEN
- access_result = open(device, O_RDONLY);
- access_type = "open";
+ access_result = open(device, O_RDONLY);
+ access_type = "open";
#else
- access_result = access(device, amode);
- access_type = "access";
+ access_result = access(device, amode);
+ access_type = "access";
#endif
- if(access_result == -1) {
- err = vstrallocf(_("Could not access %s (%s): %s"),
- qdevice, qdisk, strerror(errno));
- }
+ if(access_result == -1) {
+ err = vstrallocf(_("Could not access %s (%s): %s"),
+ qdevice, qdisk, strerror(errno));
+ }
#ifdef CHECK_FOR_ACCESS_WITH_OPEN
- aclose(access_result);
+ aclose(access_result);
#endif
+ }
}
common_exit:
dbprintf(_("%s\n"), err);
amfree(err);
} else {
- g_printf("OK %s\n", qdisk);
- dbprintf(_("disk %s OK\n"), qdisk);
- g_printf("OK %s\n", qamdevice);
- dbprintf(_("amdevice %s OK\n"), qamdevice);
- g_printf("OK %s\n", qdevice);
- dbprintf(_("device %s OK\n"), qdevice);
+ if (dle->disk) {
+ g_printf("OK %s\n", qdisk);
+ dbprintf(_("disk %s OK\n"), qdisk);
+ }
+ if (dle->device) {
+ g_printf("OK %s\n", qamdevice);
+ dbprintf(_("amdevice %s OK\n"), qamdevice);
+ }
+ if (device) {
+ g_printf("OK %s\n", qdevice);
+ dbprintf(_("device %s OK\n"), qdevice);
+ }
}
if(extra_info) {
dbprintf(_("extra info: %s\n"), extra_info);
if( need_runtar )
{
- cmd = vstralloc(amlibexecdir, "/", "runtar", versionsuffix(), NULL);
+ cmd = vstralloc(amlibexecdir, "/", "runtar", NULL);
check_file(cmd,X_OK);
check_suid(cmd);
amfree(cmd);
if( need_rundump )
{
- cmd = vstralloc(amlibexecdir, "/", "rundump", versionsuffix(), NULL);
+ cmd = vstralloc(amlibexecdir, "/", "rundump", NULL);
check_file(cmd,X_OK);
check_suid(cmd);
amfree(cmd);
if( need_calcsize ) {
char *cmd;
- cmd = vstralloc(amlibexecdir, "/", "calcsize", versionsuffix(), NULL);
+ cmd = vstralloc(amlibexecdir, "/", "calcsize", NULL);
check_file(cmd, X_OK);
check_file(COMPRESS_PATH, X_OK);
if (need_dump || need_xfsdump ) {
- if (check_file_exist("/etc/dumpdates")) {
- check_file("/etc/dumpdates",
+ if (check_file_exist("/var/lib/dumpdates")) {
+ check_file("/var/lib/dumpdates",
#ifdef USE_RUNDUMP
F_OK
#else
} else {
#ifndef USE_RUNDUMP
if (access("/etc", R_OK|W_OK) == -1) {
- g_printf(_("ERROR [dump will not be able to create the /etc/dumpdates file: %s]\n"), strerror(errno));
+ g_printf(_("ERROR [dump will not be able to create the /var/lib/dumpdates file: %s]\n"), strerror(errno));
}
#endif
}
}
if (need_vdump) {
- if (check_file_exist("/etc/vdumpdates")) {
- check_file("/etc/vdumpdates", F_OK);
+ if (check_file_exist("/var/lib/vdumpdates")) {
+ check_file("/var/lib/vdumpdates", F_OK);
}
}
+ if (need_global_check) {
check_access("/dev/null", R_OK|W_OK);
check_space(AMANDA_TMPDIR, (off_t)64); /* for amandad i/o */
check_space(AMANDA_DBGDIR, (off_t)64); /* for amandad i/o */
#endif
+ check_space("/var/lib", (off_t)64); /* for /var/lib/dumpdates writing */
+ check_space("/etc", (off_t)64); /* for /etc/dumpdates writing */
+ }
}
static void
.\" Title: amanda.conf
.\" Author: James da Silva <jds@amanda.org>
.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
- .\" Date: 11/05/2009
+ .\" Date: 06/01/2010
.\" Manual: File formats and conventions
- .\" Source: Amanda 2.6.1p2
+ .\" Source: Amanda 3.1.0
.\" Language: English
.\"
- .TH "AMANDA\&.CONF" "5" "11/05/2009" "Amanda 2\&.6\&.1p2" "File formats and conventions"
+ .TH "AMANDA\&.CONF" "5" "06/01/2010" "Amanda 3\&.1\&.0" "File formats and conventions"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
- amanda.conf \- Main configuration file for \fIAmanda\fR, the Advanced Maryland Automatic Network Disk Archiver
+ amanda.conf \- Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
.SH "DESCRIPTION"
.PP
\fBamanda.conf\fR(5)
- is the main configuration file for
- \fIAmanda\fR\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
+ is the main configuration file for Amanda\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
.PP
The file
\fB<CONFIG_DIR>/<config>/amanda\&.conf\fR
is loaded\&.
.SH "SYNTAX"
.PP
- There are a number of configuration parameters that control the behavior of the
- \fIAmanda\fR
- programs\&. All have default values, so you need not specify the parameter in
+ There are a number of configuration parameters that control the behavior of the Amanda programs\&. All have default values, so you need not specify the parameter in
\fBamanda\&.conf\fR
if the default is suitable\&.
.SS "COMMENTS"
\fBmailto\fR
and
\fBMailTo\fR
- are treated the same\&. Also, the characters
- \fB\'\-\'\fR
- and
- \fB\'_\'\fR
- are interchangeable in all predefined
- \fIAmanda\fR
- keywords:
+ are treated the same\&. Also, the characters \'\fB\-\fR\' and \'\fB_\fR\' are interchangeable in all predefined Amanda keywords:
\fBdevice_property\fR
and
\fBdevice\-property\fR
have the same meaning\&.
.PP
- Identifiers are names which are defined in the configuration itself, such as dumptypes or interfaces\&. Identifiers are are case\-insensitive, but sensitive to
- \fB\'\-\'\fR
- vs\&.
- \fB\'_\'\fR\&. Identifiers should be quoted in the configuration file, although For historical reasons, the quotes are optional\&.
+ Identifiers are names which are defined in the configuration itself, such as dumptypes or interfaces\&. Identifiers are are case\-insensitive, but sensitive to \'\fB\-\fR\' vs\&. \'\fB_\fR\'\&. Identifiers should be quoted in the configuration file, although For historical reasons, the quotes are optional\&.
.PP
Strings are always quoted with double quotes ("), and any double quotes or backslashes within the string are escaped with a backslash:
.sp
Some number of gigabytes (bytes*1024*1024*1024)\&.
.RE
.PP
+ \fBt tb tbyte tbytes terabyte terabytes\fR
+ .RS 4
+ Some number of terabytes (bytes*1024*1024*1024*1024)\&.
+ .RE
+ .PP
\fBtape tapes\fR
.RS 4
Some number of tapes\&.
may be used in most places where an integer is expected to mean an infinite amount\&.
.sp
Boolean arguments may have any of the values
+ \fB1\fR,
\fBy\fR,
\fByes\fR,
\fBt\fR,
or
\fBon\fR
to indicate a true state, or
+ \fB0\fR,
\fBn\fR,
\fBno\fR,
\fBf\fR,
finserver "/data/finance/XYZ Corp\'s \e"real\e" finances" finance\-high eth0 \-1
property "syspath" "C:\e\eWINDOWS\e\eSYSTEM"
.fi
+ .SS "SUBSECTIONS AND INHERITANCE"
+ .PP
+ Amanda configuration files may include various
+ \fIsubsections\fR, each defining a set of configuration directives\&. Each type of subsection is described below\&. Note that all types of subsections can
+ \fIinherit\fR
+ from other subsections of the same type by naming the "parent" section in the "child" subsection\&. For example:
+ .sp
+ .nf
+ define dumptype global {
+ record yes
+ index yes
+ }
+
+ define dumptype nocomp {
+ global # inherit the parameters in dumptype \'global\'
+ compress none
+ }
+ .fi
+ .PP
+ Note that multiple inheritance is also supported by simply naming multiple parent sections in a child\&. Parents are implicitly expanded in place in a child, and the last occurrence of each parameter takes precedence\&. For example,
+ .sp
+ .nf
+ define tapetype par1 {
+ comment "Parent 1"
+ filemark 8k
+ speed 300bps
+ length 200M
+ }
+ define tapetype par2 {
+ comment "Parent 2"
+ filemark 16k
+ speed 400bps
+ }
+ define tapetype child {
+ par1
+ par2
+ filemark 32k
+ }
+ .fi
+ In this example, \'child\' will have a filemark of 32k, a speed of 400bps, and a length of 200M\&.
.SH "GLOBAL PARAMETERS"
.PP
- \fBorg\fR \fI string\fR
+ \fBorg\fR \fIstring\fR
.RS 4
Default:
- \fIdaily\fR\&. A descriptive name for the configuration\&. This string appears in the Subject line of mail reports\&. Each
- \fIAmanda\fR
- configuration should have a different string to keep mail reports distinct\&.
+ \fI"daily"\fR\&. A descriptive name for the configuration\&. This string appears in the Subject line of mail reports\&. Each Amanda configuration should have a different string to keep mail reports distinct\&.
.RE
.PP
- \fBmailer\fR \fI string\fR
+ \fBmailer\fR \fIstring\fR
.RS 4
Default found by configure\&. A mail program that can send mail with \'\fIMAILER \-s "subject" user < message_file\fR\'\&.
.RE
.PP
- \fBmailto\fR \fI string\fR
+ \fBmailto\fR \fIstring\fR
.RS 4
- Default:
- \fIoperators\fR\&. A space separated list of recipients for mail reports\&.
+ Default: none\&. A space separated list of recipients for mail reports\&. If not specified, amdump will not send any mail\&.
.RE
.PP
- \fBsend\-amreport\-on\fR [all|strange|error|never]
+ \fBsend\-amreport\-on\fR [ \fBall\fR | \fBstrange\fR | \fBerror\fR | \fBnever\fR ]
.RS 4
Default:
\fBall\fR\&. Specify which types of messages will trigger an email from amreport\&. amreport is used by amdump and amflush\&.
.PP
\fBstrange\fR
.RS 4
- Send an email on strange or error message\&. A strange message occurs when the dump succeeded, but returned one or more errors unknown to
- \fIAmanda\fR\&.
+ Send an email on strange or error message\&. A strange message occurs when the dump succeeded, but returned one or more errors unknown to Amanda\&.
.RE
.PP
\fBerror\fR
.RE
.RE
.PP
- \fBdumpcycle\fR \fI int\fR
+ \fBdumpcycle\fR \fIint\fR
.RS 4
Default:
\fI10 days\fR\&. The number of days in the backup cycle\&. Each disk will get a full backup at least this often\&. Setting this to zero tries to do a full backup each run\&.
.RE
.RE
.PP
- \fBrunspercycle\fR \fI int\fR
+ \fBrunspercycle\fR \fIint\fR
.RS 4
Default:
\fIsame as dumpcycle\fR\&. The number of amdump runs in
\fBruntapes\fR\&.
.RE
.PP
- \fBtapecycle\fR \fI int\fR
+ \fBtapecycle\fR \fIint\fR
.RS 4
Default:
- \fI15 tapes\fR\&. Typically tapes are used by
- \fIAmanda\fR
- in an ordered rotation\&. The
+ \fI15 tapes\fR\&. Typically tapes are used by Amanda in an ordered rotation\&. The
\fBtapecycle\fR
- parameter defines the size of that rotation\&. The number of tapes in rotation must be larger than the number of tapes required for a complete dump cycle (see the
- \fBdumpcycle\fR
- parameter)\&.
+ parameter defines the size of that rotation\&. This parameter must be be larger than the number of tapes used in a dumpcycle\&.
.sp
- This is calculated by multiplying the number of
+ The number of tapes per dumpcycle is calculated by multiplying the number of
+ \fBamdump\fR
+ runs per dump cycle
+ \fBrunspercycle\fR
+ (the number of
\fBamdump\fR
- runs per dump cycle (\fBrunspercycle\fR
- parameter) times the number of tapes used per run (\fBruntapes\fR
- parameter)\&. Typically two to four times this calculated number of tapes are in rotation\&. While
- \fIAmanda\fR
- is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least \'\fBtapecycle\fR
+ runs per dump cycle) and
+ \fBruntapes\fR
+ (the number of tapes used per run)\&. Typically
+ \fBtapecycle\fR
+ is set to two or four times the tapes per dumpcycle\&.
+ .if n \{\
+ .sp
+ .\}
+ .RS 4
+ .it 1 an-trap
+ .nr an-no-space-flag 1
+ .nr an-break-flag 1
+ .br
+ .ps +1
+ \fBNote\fR
+ .ps -1
+ .br
+ Amanda is commonly misconfigured with \fBtapecycle\fR
+ equal to the number of tapes per \fBdumpcycle\fR\&. In this
+ misconfiguration, amanda may erase a full dump before a new one is completed,
+ the recovery is then impossible\&. tapecycle must be at least one tape larger
+ than the number of tapes per dumpcycle\&.
+ .sp .5v
+ .RE
+ While Amanda is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least \'\fBtapecycle\fR
\-1\' number of other tapes have been used\&.
.sp
It is considered good administrative practice to set the
parameter slightly lower than the actual number of tapes in rotation\&. This allows the administrator to more easily cope with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order\&.
.RE
.PP
- \fBusetimestamps\fR \fI bool\fR
+ \fBusetimestamps\fR \fIbool\fR
.RS 4
Default:
\fBYes\fR\&. This option allows Amanda to track multiple runs per calendar day\&. The only reason one might disable it is that Amanda versions before 2\&.5\&.1 can\'t read logfiles written when this option was enabled\&.
.RE
.PP
- \fBlabel_new_tapes\fR \fI string\fR
+ \fBlabel_new_tapes\fR \fIstring\fR
.RS 4
- Default: not set\&. When set, this directive will cause
- \fIAmanda\fR
- to automatically write an
- \fIAmanda\fR
- tape label to any blank tape she encounters\&. This option is DANGEROUS because when set,
- \fIAmanda\fR
- will ERASE any non\-\fIAmanda\fR
- tapes you may have, and may also ERASE any near\-failing tapes\&. Use with caution\&.
+ Deprecated, use
+ \fBautolabel\fR
+ option\&.
+ .sp
+ Default: not set\&. When set, this directive will cause Amanda to automatically write an Amanda tape label to any blank tape she encounters\&. This option is DANGEROUS because when set, Amanda will ERASE any non\-Amanda tapes you may have, and may also ERASE any near\-failing tapes\&. Use with caution\&.
.sp
When using this directive, specify the template for new tape labels\&. 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:
\fBlabel_new_tapes "DailySet1\-%%%"\fR
.RE
.PP
- \fBdumpuser\fR \fI string\fR
+ \fBautolabel\fR \fIstring\fR [\fBany\fR] [\fBother_config\fR] [\fBnon_amanda\fR] [\fBvolume_error\fR] [\fBempty\fR]
+ .RS 4
+ Default: not set\&. When set, this directive will cause Amanda to automatically write an Amanda 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\&.
+ .sp
+ When using this directive, specify the template for new tape labels\&. 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:
+ \fBautolabel "DailySet1\-%%%" empty\fR
+ .PP
+ \fBany\fR
+ .RS 4
+ equivalent to \'\fBother_config non_amanda volume_error empty\fR\'
+ .RE
+ .PP
+ \fBother_config\fR
+ .RS 4
+ Label volumes with a valid Amanda label that do not match our
+ \fBlabelstr\fR\&. Danger: this may erase volumes
+ from other Amanda configurations without warning!
+ .RE
+ .PP
+ \fBnon_amanda\fR
+ .RS 4
+ Label volumes which do not start with data that resembles an
+ Amanda header\&. Danger: this may erase volumes from other backup applications
+ without warning!
+ .RE
+ .PP
+ \fBvolume_error\fR
+ .RS 4
+ Label volumes where an error occurs while trying to read the label\&.
+ Danger: this may erase arbitrary volumes due to transient errors\&.
+ .RE
+ .PP
+ \fBempty\fR
+ .RS 4
+ Label volumes where a read returns 0 bytes\&.
+ .RE
+ .RE
+ .PP
+ \fBdumpuser\fR \fIstring\fR
.RS 4
Default:
- \fIamanda\fR\&. The login name
- \fIAmanda\fR
- uses to run the backups\&. The backup client hosts must allow access from the tape server host as this user via
+ \fI"amanda"\fR\&. The login name Amanda uses to run the backups\&. The backup client hosts must allow access from the tape server host as this user via
\fB\&.rhosts\fR
or
- \fB\&.amandahosts\fR, depending on how the
- \fIAmanda\fR
- software was built\&.
+ \fB\&.amandahosts\fR, depending on how the Amanda software was built\&.
.RE
.PP
- \fBprinter\fR string
+ \fBprinter\fR \fIstring\fR
.RS 4
Printer to use when doing tape labels\&. See the
\fBlbl\-templ\fR
option\&.
.RE
.PP
- \fBtapedev\fR string
+ \fBtapedev\fR \fIstring\fR
.RS 4
Default:
- null:\&. The device name, referencing the name of a "device" section in the configuration file\&. See
+ \fI"null:"\fR\&. The device name, referencing the name of a "device" section in the configuration file\&. See
\fBamanda-devices\fR(7)
for more information on device names\&.
.sp
\fIno\fR\&.
.RE
.PP
- \fBdevice_property\fR string string
+ \fBdevice_property\fR \fIstring\fR \fIstring\fR
.RS 4
These options can set various device properties\&. See
\fBamanda-devices\fR(7)
.fi
.RE
.PP
- \fBproperty\fR [append] string string+
+ \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
.RS 4
These options can set various properties, they can be used by third party software to store information in the configuration file\&. 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\&.
.RE
.PP
- \fBtpchanger\fR string
+ \fBtpchanger\fR \fIstring\fR
.RS 4
- Default:
- \fInone\fR\&. The name of the tape changer\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
+ Default: not set\&. The name of the tape changer\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
.sp
If a tape changer is configured, choose one of the changer scripts (e\&.g\&.
\fBchg\-scsi\fR) and enter that here\&.
.RE
.PP
- \fBchangerdev\fR string
+ \fBchangerdev\fR \fIstring\fR
.RS 4
Default:
- /dev/null\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
+ \fI"dev/null"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
\fBtpchanger\fR
option\&.
.RE
.PP
- \fBchangerfile\fR string
+ \fBchangerfile\fR \fIstring\fR
.RS 4
Default:
- /usr/adm/amanda/log/changer\-status\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
+ \fI"usr/adm/amanda/log/changer\-status"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
\fBtpchanger\fR
option\&.
.RE
.PP
- \fBruntapes\fR int
+ \fBruntapes\fR \fIint\fR
.RS 4
Default:
- 1\&. The maximum number of tapes used in a single run\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
+ \fI1\fR\&. The maximum number of tapes used in a single run\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
.sp
- If a tape changer is configured, this may be set larger than one to let
- \fIAmanda\fR
- write to more than one tape\&.
+ If a tape changer is configured, this may be set larger than one to let Amanda write to more than one tape\&.
.sp
- Note that this is an upper bound on the number of tapes, and
- \fIAmanda\fR
- may use less\&.
+ Note that this is an upper bound on the number of tapes, and Amanda may use less\&.
.sp
- Also note that as of this release,
- \fIAmanda\fR
- does not support true tape overflow\&. When it reaches the end of one tape, the backup image
- \fIAmanda\fR
- was processing starts over again on the next tape\&.
+ Also note that as of this release, Amanda does not support true tape overflow\&. When it reaches the end of one tape, the backup image Amanda was processing starts over again on the next tape\&.
.RE
.PP
- \fBmaxdumpsize\fR int
+ \fBmaxdumpsize\fR \fIint\fR
.RS 4
Default:
- \fIruntapes\fR*\fItape_length\fR\&. Maximum number of bytes the planner will schedule for a run\&.
+ \fI\fBruntapes\fR\fR\fI*\fR\fI\fBtape_length\fR\fR\&. Maximum number of bytes the planner will schedule for a run\&.
.sp
The default unit is Kbytes if it is not specified\&.
.RE
.PP
- \fBtaperalgo\fR [first|firstfit|largest|largestfit|smallest|last]
+ \fBtaperalgo\fR [ \fBfirst\fR | \fBfirstfit\fR | \fBlargest\fR | \fBlargestfit\fR | \fBsmallest\fR | \fBlast\fR ]
.RS 4
Default:
- \fIfirst\fR\&. The algorithm used to choose which dump image to send to the taper\&.
+ \fBfirst\fR\&. The algorithm used to choose which dump image to send to the taper\&.
.PP
\fBfirst\fR
.RS 4
.RE
.RE
.PP
- \fBlabelstr\fR \fI string\fR
+ \fBlabelstr\fR \fIstring\fR
.RS 4
Default:
- \fI\&.*\fR\&. The tape label constraint regular expression\&. All tape labels generated (see
+ \fI"\&.*"\fR\&. The tape label constraint regular expression\&. All tape labels generated (see
\fBamlabel\fR(8)) and used by this configuration must match the regular expression\&. If multiple configurations are run from the same tape server host, it is helpful to set their labels to different strings (for example, "DAILY[0\-9][0\-9]*" vs\&. "ARCHIVE[0\-9][0\-9]*") to avoid overwriting each other\'s tapes\&.
.RE
.PP
- \fBtapetype\fR \fI identifier\fR
+ \fBtapetype\fR \fIstring\fR
.RS 4
Default:
- \fI"EXABYTE"\fR\&. The type of tape drive associated with
+ \fIno default\fR\&. The type of tape drive associated with
\fBtapedev\fR
or
\fBtpchanger\fR\&. This refers to one of the defined
of the tape media and device\&.
.RE
.PP
- \fBctimeout\fR int
+ \fBctimeout\fR \fIint\fR
.RS 4
Default:
\fI30 seconds\fR\&. Maximum amount of time that
will wait for each client host\&.
.RE
.PP
- \fBdtimeout\fR int
+ \fBdtimeout\fR \fIint\fR
.RS 4
Default:
\fI1800 seconds\fR\&. Amount of idle time per disk on a given client that a
will wait before it fails with a data timeout error\&.
.RE
.PP
- \fBetimeout\fR int
+ \fBetimeout\fR \fIint\fR
.RS 4
Default:
\fI300 seconds\fR\&. Amount of time per estimate on a given client that the
will wait up to 40 minutes for that machine\&. A negative value will be interpreted as a total amount of time to wait per client instead of per disk\&.
.RE
.PP
- \fBconnect_tries\fR int
+ \fBconnect_tries\fR \fIint\fR
.RS 4
Default:
\fI3\fR\&. How many times the server will try a connection\&.
.RE
.PP
- \fBreq_tries\fR int
+ \fBreq_tries\fR \fIint\fR
.RS 4
Default:
\fI3\fR\&. How many times the server will resend a REQ packet if it doesn\'t get the ACK packet\&.
.RE
.PP
- \fBnetusage\fR int
+ \fBnetusage\fR \fIint\fR
.RS 4
Default:
- \fI8000 Kbps\fR\&. The maximum network bandwidth allocated to
- \fIAmanda\fR, in Kbytes per second\&. See also the
+ \fI8000 Kbps\fR\&. The maximum network bandwidth allocated to Amanda, in Kbytes per second\&. See also the
\fBinterface\fR
section\&.
.RE
.PP
- \fBinparallel\fR int
+ \fBinparallel\fR \fIint\fR
.RS 4
Default:
- 10\&. The maximum number of backups that
- \fIAmanda\fR
- will attempt to run in parallel\&.
- \fIAmanda\fR
- will stay within the constraints of network bandwidth and holding disk space available, so it doesn\'t hurt to set this number a bit high\&. Some contention can occur with larger numbers of backups, but this effect is relatively small on most systems\&.
+ \fI10\fR\&. The maximum number of backups that Amanda will attempt to run in parallel\&. Amanda will stay within the constraints of network bandwidth and holding disk space available, so it doesn\'t hurt to set this number a bit high\&. Some contention can occur with larger numbers of backups, but this effect is relatively small on most systems\&.
.RE
.PP
\fBdisplayunit\fR "k|m|g|t"
.RS 4
Default:
- "k"\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&.
+ \fI"k"\fR\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&.
.RE
.PP
- \fBdumporder\fR string
+ \fBdumporder\fR \fIstring\fR
.RS 4
Default:
- \fItttTTTTTTT\fR\&. The priority order of each dumper:
+ \fI"tttTTTTTTT"\fR\&. The priority order of each dumper:
.sp
.nf
s: smallest size
.fi
.RE
.PP
- \fBmaxdumps\fR int
+ \fBmaxdumps\fR \fIint\fR
.RS 4
Default:
- 1\&. The maximum number of backups from a single host that
- \fIAmanda\fR
- will attempt to run in parallel\&. See also the
+ \fI1\fR\&. The maximum number of backups from a single host that Amanda will attempt to run in parallel\&. See also the
\fBinparallel\fR
option\&.
.sp
\fBdumptype\fRs are defined\&.
.RE
.PP
- \fBbumpsize\fR int
+ \fBbumpsize\fR \fIint\fR
.RS 4
Default:
- \fI10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If
- \fIAmanda\fR
- determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&. The value of this parameter is used only if the parameter
+ \fI10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&. The value of this parameter is used only if the parameter
\fIbumppercent\fR
is set to 0\&.
.sp
\fBbumpdays\fR\&.
.RE
.PP
- \fBbumppercent\fR int
+ \fBbumppercent\fR \fIint\fR
.RS 4
Default:
- \fI0 percent\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If
- \fIAmanda\fR
- determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
+ \fI0\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
.sp
If this parameter is set to 0, the value of the parameter
\fIbumpsize\fR
\fBbumpdays\fR\&.
.RE
.PP
- \fBbumpmult\fR \fI float\fR
+ \fBbumpmult\fR \fIfloat\fR
.RS 4
Default:
- 1\&.5\&. The bump size multiplier\&.
- \fIAmanda\fR
- multiplies
+ \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
\fBbumpsize\fR
by this factor for each level\&. This prevents active filesystems from bumping too much by making it harder to bump to the next level\&. For example, with the default
\fBbumpsize\fR
The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
.RE
.PP
- \fBbumpdays\fR \fI int\fR
+ \fBbumpdays\fR \fIint\fR
.RS 4
Default:
- \fI2 days\fR\&. To insure redundancy in the dumps,
- \fIAmanda\fR
- keeps filesystems at the same incremental level for at least
+ \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
\fBbumpdays\fR
days, even if the other bump threshold criteria are met\&.
.sp
The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
.RE
.PP
- \fBdiskfile\fR \fI string\fR
+ \fBdiskfile\fR \fIstring\fR
.RS 4
Default:
- \fIdisklist\fR\&. The file name for the
+ \fI"disklist"\fR\&. The file name for the
\fIdisklist\fR
file holding client hosts, disks and other client dumping information\&.
.RE
.PP
- \fBinfofile\fR \fI string\fR
+ \fBinfofile\fR \fIstring\fR
.RS 4
Default:
- /usr/adm/amanda/curinfo\&. The file or directory name for the historical information database\&. If
- \fIAmanda\fR
- was configured to use DBM databases, this is the base file name for them\&. If it was configured to use text formated databases (the default), this is the base directory and within here will be a directory per client, then a directory per disk, then a text file of data\&.
+ \fI"/usr/adm/amanda/curinfo"\fR\&. The file or directory name for the historical information database\&. If Amanda was configured to use DBM databases, this is the base file name for them\&. If it was configured to use text formated databases (the default), this is the base directory and within here will be a directory per client, then a directory per disk, then a text file of data\&.
.RE
.PP
- \fBlogdir\fR \fI string\fR
+ \fBlogdir\fR \fIstring\fR
.RS 4
Default:
- /usr/adm/amanda\&. The directory for the
+ \fI"/usr/adm/amanda"\fR\&. The directory for the
\fBamdump\fR
and
\fBlog\fR
files\&.
.RE
.PP
- \fBindexdir\fR \fI string\fR
+ \fBindexdir\fR \fIstring\fR
.RS 4
Default
- /usr/adm/amanda/index\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose
+ \fI"/usr/adm/amanda/index"\fR\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose
\fBdumptype\fR
has the
\fBindex\fR
option enabled\&.
.RE
.PP
- \fBtapelist\fR \fI string\fR
+ \fBtapelist\fR \fIstring\fR
.RS 4
Default:
- \fItapelist\fR\&. The file name for the active
- \fBtapelist\fR(5)\&.
- \fIAmanda\fR
- maintains this file with information about the active set of tapes\&.
+ \fI"tapelist"\fR\&. The file name for the active
+ \fBtapelist\fR(5)\&. Amanda maintains this file with information about the active set of tapes\&.
.RE
.PP
- \fBdevice_output_buffer_size\fR \fI int\fR
+ \fBdevice_output_buffer_size\fR \fIint\fR
.RS 4
Default:
- 1280k\&. Controls the amount of memory used by
- \fIAmanda\fR
- to hold data as it is read from the network or disk before it is written to the output device\&. Higher values may be useful on fast tape drives and optical media\&.
+ \fI1280k\fR\&. Controls the amount of memory used by Amanda to hold data as it is read from the network or disk before it is written to the output device\&. Higher values may be useful on fast tape drives and optical media\&.
.sp
The default unit is bytes if it is not specified\&.
.RE
.PP
- \fBtapebufs\fR \fI int\fR
+ \fBtapebufs\fR \fIint\fR
.RS 4
Default:
- 20\&. This option is deprecated; use the
+ \fI20\fR\&. This option is deprecated; use the
\fBdevice_output_buffer_size\fR
directive instead\&.
\fBtapebufs\fR
works the same way, but the number specified is multiplied by the device blocksize prior to use\&.
.RE
.PP
- \fBreserve\fR \fI number\fR
+ \fBreserve\fR \fIint\fR
.RS 4
Default:
- 100\&. The part of holding\-disk space that should be reserved for incremental backups if no tape is available, expressed as a percentage of the available holding\-disk space (0\-100)\&. By default, when there is no tape to write to, degraded mode (incremental) backups will be performed to the holding disk\&. If full backups should also be allowed in this case, the amount of holding disk space reserved for incrementals should be lowered\&.
+ \fI100\fR\&. The part of holding\-disk space that should be reserved for incremental backups if no tape is available, expressed as a percentage of the available holding\-disk space (0\-100)\&. By default, when there is no tape to write to, degraded mode (incremental) backups will be performed to the holding disk\&. If full backups should also be allowed in this case, the amount of holding disk space reserved for incrementals should be lowered\&.
.RE
.PP
- \fBautoflush\fR \fI bool\fR
+ \fBautoflush\fR \fIbool\fR
.RS 4
Default:
- \fIoff\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&.
+ \fBoff\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&.
.RE
.PP
- \fBamrecover_do_fsf\fR \fI bool\fR
+ \fBamrecover_do_fsf\fR \fIbool\fR
.RS 4
Default:
- \fIon\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
+ \fBon\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
.RE
.PP
- \fBamrecover_check_label\fR \fI bool\fR
+ \fBamrecover_check_label\fR \fIbool\fR
.RS 4
Default:
- \fIon\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
+ \fBon\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
.RE
.PP
- \fBamrecover_changer\fR \fI string\fR
+ \fBamrecover_changer\fR \fIstring\fR
.RS 4
- Default: \'\'\&. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the amrecover_changer setting\&.
+ Default: not set\&. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the amrecover_changer setting\&.
.RE
.PP
- \fBcolumnspec\fR \fI string\fR
+ \fBcolumnspec\fR \fIstring\fR
.RS 4
+ default: "HostName=0:12:12,Disk=1:11:11,Level=1:1:1,OrigKB=1:\-7:0,OutKB=1:\-7:0,Compress=1:\-6:1,DumpTime=1:\-7:7,Dumprate=1:\-6:1,TapeTime=1:\-6:6,TapeRate=1:\-6:1"
+ .sp
Defines the width of columns
\fBamreport\fR
should use\&.
\fIString\fR
- is a comma (\',\') separated list of triples\&. Each triple consists of three parts which are separated by a equal sign (\'=\') and a colon (\':\') (see the example)\&. These three parts specify:
+ is a comma (\',\') separated list of triples\&. Each triple consists of three parts which are separated by a equal sign (\'=\') and a colon (\':\') (see the example)\&. These four parts specify:
.sp
.RS 4
.ie n \{\
.IP " 1." 4.2
.\}
the name of the column, which may be:
+ .sp
.nf
Compress (compression ratio)
Disk (client disk name)
.IP " 2." 4.2
.\}
the amount of space to display before the column (used to get whitespace between columns)\&.
- .sp
.RE
.sp
.RS 4
.\}
the width of the column itself\&. If set to a negative value, the width will be calculated on demand to fit the largest entry in this column\&.
.RE
+ .sp
+ .RS 4
+ .ie n \{\
+ \h'-04' 4.\h'+01'\c
+ .\}
+ .el \{\
+ .sp -1
+ .IP " 4." 4.2
+ .\}
+ the precision of the column, number of digit after the decimal point for number\&.
+ .RE
+ .sp
Here is an example:
.sp
.nf
- columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
+ columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
.fi
.sp
- The above will display the disk information in 18 characters and put one space before it\&. The hostname column will be 10 characters wide with no space to the left\&. The output KBytes column is seven characters wide with one space before it\&.
+ The above will display the disk information in 18 characters and put one space before it\&. The hostname column will be 10 characters wide with no space to the left\&. The Original KBytes print 2 decimal digit\&. The output KBytes column is seven characters wide with one space before it\&.
+ .RE
+ .PP
+ \fBincludefile\fR \fIstring\fR
+ .RS 4
+ Default:
+ \fIno default\fR\&. The name of an Amanda configuration file to include within the current file\&. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations\&. Relative pathnames are relative to the configuration directory\&.
.RE
.PP
- \fBincludefile\fR \fI string\fR
+ \fBdebug_days\fR \fIint\fR
.RS 4
Default:
- \fInone\fR\&. The name of an
- \fIAmanda\fR
- configuration file to include within the current file\&. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations\&. Relative pathnames are relative to the configuration directory\&.
+ \fI3\fR\&. The number of days the debug files are kept\&.
.RE
.PP
- \fBdebug_auth\fR int
+ \fBdebug_auth\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the auth module
.RE
.PP
- \fBdebug_event\fR int
+ \fBdebug_event\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the event module
.RE
.PP
- \fBdebug_holding\fR int
+ \fBdebug_holding\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the holdingdisk module
.RE
.PP
- \fBdebug_protocol\fR int
+ \fBdebug_protocol\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the protocol module
.RE
.PP
- \fBdebug_planner\fR int
+ \fBdebug_planner\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the planner process
.RE
.PP
- \fBdebug_driver\fR int
+ \fBdebug_driver\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the driver process
.RE
.PP
- \fBdebug_dumper\fR int
+ \fBdebug_dumper\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the dumper process
.RE
.PP
- \fBdebug_chunker\fR int
+ \fBdebug_chunker\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the chunker process
.RE
.PP
- \fBdebug_taper\fR int
+ \fBdebug_taper\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the taper process
.RE
.PP
- \fBflush\-threshold\-dumped\fR int
+ \fBflush\-threshold\-dumped\fR \fIint\fR
.RS 4
Default:
- \fI0\fR\&.
- \fIAmanda\fR
- will not begin writing data to a new volume until the amount of data on the holding disk is at least this percentage of the volume size\&. In other words,
- \fIAmanda\fR
- will not begin until the inequality
- h > t \(mu d
- is satisfied, where
- h
- is the amount of data on the holding disk,
- t
- is the capacity of a volume, and
- d
- is this parameter, expressed as a percentage\&. This parameter may be larger than 100%, for example to keep more recent dumps on the holding disk for faster recovery\&.
+ \fI0\fR\&. Amanda will not begin writing data to a new volume until the amount of data on the holding disk is at least this percentage of the volume size\&. In other words, Amanda will not begin until the amount of data on the holding disk is greater than the tape length times this parameter\&. This parameter may be larger than 100%, for example to keep more recent dumps on the holding disk for faster recovery\&.
.sp
- Needless to say, your holding disk must be big enough that this criterion could be satisfied\&. If the holding disk cannot be used for a particular dump (because, for example, there is no remaining holding space) then
- \fIAmanda\fR
- will disregard the constraint specified by this setting and start a new volume anyway\&. Once writing to a volume has begun, this constraint is not applied unless and until a new volume is needed\&.
+ Needless to say, your holding disk must be big enough that this criterion could be satisfied\&. If the holding disk cannot be used for a particular dump (because, for example, there is no remaining holding space) then Amanda will disregard the constraint specified by this setting and start a new volume anyway\&. Once writing to a volume has begun, this constraint is not applied unless and until a new volume is needed\&.
.sp
The value of this parameter may not exceed than that of the
\fBflush\-threshold\-scheduled\fR
parameter\&.
.RE
.PP
- \fBflush\-threshold\-scheduled\fR int
+ \fBflush\-threshold\-scheduled\fR \fIint\fR
.RS 4
Default:
- \fI0\fR\&.
- \fIAmanda\fR
- will not begin writing data to a new volume until the sum of the amount of data on the holding disk and the estimated amount of data remaining to be dumped during this run is at least this percentage of the volume size\&. In other words,
- \fIAmanda\fR
- will not begin until the inequality
+ \fI0\fR\&. Amanda will not begin writing data to a new volume until the sum of the amount of data on the holding disk and the estimated amount of data remaining to be dumped during this run is at least this percentage of the volume size\&. In other words, Amanda will not begin until the inequality
h + s > t \(mu d
is satisfied, where
h
d
is this parameter, expressed as a percentage\&. This parameter may be larger than 100%\&.
.sp
- Needless to say, your holding disk must be big enough that this criterion could be satisfied\&. If the holding disk cannot be used for a particular dump (because, for example, there is no remaining holding space) then
- \fIAmanda\fR
- will disregard the constraint specified by this setting and start a new volume anyway\&. Once writing to a volume has begun, this constraint is not applied unless and until a new volume is needed\&.
+ Needless to say, your holding disk must be big enough that this criterion could be satisfied\&. If the holding disk cannot be used for a particular dump (because, for example, there is no remaining holding space) then Amanda will disregard the constraint specified by this setting and start a new volume anyway\&. Once writing to a volume has begun, this constraint is not applied unless and until a new volume is needed\&.
.sp
The value of this parameter may not be less than that of the
\fBflush\-threshold\-dumped\fR
parameters\&.
.RE
.PP
- \fBtaperflush\fR int
+ \fBtaperflush\fR \fIint\fR
.RS 4
Default:
- \fI0\fR\&. At the end of a run,
- \fIAmanda\fR
- will start a new tape to flush remaining data if there is more data on the holding disk at the end of a run than this setting allows; the amount is specified as a percentage of the capacity of a single volume\&. In other words, at the end of a run,
- \fIAmanda\fR
- will begin a new tape if the inequality
+ \fI0\fR\&. At the end of a run, Amanda will start a new tape to flush remaining data if there is more data on the holding disk at the end of a run than this setting allows; the amount is specified as a percentage of the capacity of a single volume\&. In other words, at the end of a run, Amanda will begin a new tape if the inequality
h > t \(mu f
is satisfied, where
h
is greater than 0\&.
.RE
.PP
- \fBreserved\-udp\-port\fR int,int
+ \fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR
.RS 4
Default: \-\-with\-udpportrange or
\fI512,1023\fR\&. Reserved udp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
.RE
.PP
- \fBreserved\-tcp\-port\fR int,int
+ \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 (bsdtcp)\&. Range is inclusive\&.
.RE
.PP
- \fBunreserved\-tcp\-port\fR int,int
+ \fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
.RS 4
Default: \-\-with\-tcpportrange or
\fI1024,65535\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
\fBamanda\&.conf\fR
file may define one or more holding disks used as buffers to hold backup images before they are written to tape\&. The syntax is:
.nf
- holdingdisk \fIname\fR {
+ define holdingdisk \fIname\fR {
\fIholdingdisk\-option\fR \fIholdingdisk\-value\fR
\&.\&.\&.
}
.fi
.PP
+ The { must appear at the end of a line, and the } on its own line\&.
+ .PP
\fIName\fR
is a logical name for this holding disk\&.
.PP
The options and values are:
.PP
- \fBcomment\fR \fI string\fR
+ \fBcomment\fR \fIstring\fR
.RS 4
- Default:
- \fInone\fR\&. A comment string describing this holding disk\&.
+ Default: not set\&. A comment string describing this holding disk\&.
.RE
.PP
- \fBdirectory\fR \fI disk\fR
+ \fBdirectory\fR \fIstring\fR
.RS 4
Default:
- /dumps/amanda\&. The path to this holding area\&.
+ \fI"/dumps/amanda"\fR\&. The path to this holding area\&.
.RE
.PP
- \fBuse\fR \fI int\fR
+ \fBuse\fR \fIint\fR
.RS 4
Default:
- \fI0 Gb\fR\&. Amount of space that can be used in this holding disk area\&. If the value is zero, all available space on the file system is used\&. If the value is negative,
- \fIAmanda\fR
- will use all available space minus that value\&.
+ \fI0 Gb\fR\&. Amount of space that can be used in this holding disk area\&. If the value is zero, all available space on the file system is used\&. If the value is negative, Amanda will use all available space minus that value\&.
.RE
.PP
- \fBchunksize\fR \fI int\fR
+ \fBchunksize\fR \fIint\fR
.RS 4
Default:
\fI1 Gb\fR\&. Holding disk chunk size\&. Dumps larger than the specified size will be stored in multiple holding disk files\&. The size of each chunk will not exceed the specified value\&. However, even though dump images are split in the holding disk, they are concatenated as they are written to tape, so each dump image still corresponds to a single continuous tape section\&.
.sp
The default unit is Kbytes if it is not specified\&.
.sp
- If 0 is specified,
- \fIAmanda\fR
- will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\&.
+ If 0 is specified, Amanda will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\&.
.sp
Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\&.
.sp
- Operating systems that are limited to a maximum file size of 2 Gbytes actually cannot handle files that large\&. They must be at least one byte less than 2 Gbytes\&. Since
- \fIAmanda\fR
- works with 32 Kbyte blocks, and to handle the final read at the end of the chunk, the chunk size should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum file size, e\&.g\&. 2047 Mbytes\&.
+ Operating systems that are limited to a maximum file size of 2 Gbytes actually cannot handle files that large\&. They must be at least one byte less than 2 Gbytes\&. Since Amanda works with 32 Kbyte blocks, and to handle the final read at the end of the chunk, the chunk size should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum file size, e\&.g\&. 2047 Mbytes\&.
.RE
.SH "DUMPTYPE SECTION"
.PP
}
.fi
.PP
+ The { must appear at the end of a line, and the } on its own line\&.
+ .PP
\fIName\fR
is the name of this set of backup options\&. It is referenced from the
\fBdisklist\fR(5)
.PP
The dumptype options and values are:
.PP
- \fBauth\fR \fI string\fR
+ \fBauth\fR \fIstring\fR
.RS 4
Default:
- \fIbsd\fR\&. Type of authorization to perform between tape server and backup client hosts\&. See
+ \fI"bsd"\fR\&. Type of authorization to perform between tape server and backup client hosts\&. See
\fBamanda-auth\fR(7)
for more detail\&.
.RE
.PP
- \fBamandad_path\fR \fI string\fR
+ \fBamandad_path\fR \fIstring\fR
.RS 4
Default:
- \fI$libexec/amandad\fR\&. Specify the amandad path of the client, only use with rsh/ssh authentification\&.
+ \fI"$libexec/amandad"\fR\&. Specify the amandad path of the client, only use with rsh/ssh authentification\&.
.RE
.PP
- \fBclient_username\fR \fI string\fR
+ \fBclient_username\fR \fIstring\fR
.RS 4
Default:
\fICLIENT_LOGIN\fR\&. Specify the username to connect on the client, only use with rsh/ssh authentification\&.
.RE
.PP
- \fBbumpsize\fR int
+ \fBclient_port\fR [ \fIint\fR | \fIstring\fR ]
+ .RS 4
+ Default:
+ \fI"amanda"\fR\&. Specifies the port to connect to on the client\&. It can be a service name or a numeric port number\&.
+ .RE
+ .PP
+ \fBbumpsize\fR \fIint\fR
.RS 4
Default:
- \fI10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If
- \fIAmanda\fR
- determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&. The value of this parameter is used only if the parameter
+ \fI10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&. The value of this parameter is used only if the parameter
\fIbumppercent\fR
is set to 0\&.
.sp
\fBbumpdays\fR\&.
.RE
.PP
- \fBbumppercent\fR int
+ \fBbumppercent\fR \fIint\fR
.RS 4
Default:
- \fI0 percent\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If
- \fIAmanda\fR
- determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
+ \fI0\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
.sp
If this parameter is set to 0, the value of the parameter
\fIbumpsize\fR
\fBbumpdays\fR\&.
.RE
.PP
- \fBbumpmult\fR \fI float\fR
+ \fBbumpmult\fR \fIfloat\fR
.RS 4
Default:
- 1\&.5\&. The bump size multiplier\&.
- \fIAmanda\fR
- multiplies
+ \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
\fBbumpsize\fR
by this factor for each level\&. This prevents active filesystems from bumping too much by making it harder to bump to the next level\&. For example, with the default
\fBbumpsize\fR
set to 2\&.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on\&.
.RE
.PP
- \fBbumpdays\fR \fI int\fR
+ \fBbumpdays\fR \fIint\fR
.RS 4
Default:
- \fI2 days\fR\&. To insure redundancy in the dumps,
- \fIAmanda\fR
- keeps filesystems at the same incremental level for at least
+ \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
\fBbumpdays\fR
days, even if the other bump threshold criteria are met\&.
.RE
.PP
- \fBcomment\fR \fI string\fR
+ \fBcomment\fR \fIstring\fR
.RS 4
- Default:
- \fInone\fR\&. A comment string describing this set of backup options\&.
+ Default: not set\&. A comment string describing this set of backup options\&.
.RE
.PP
\fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ]
.RS 4
Default:
- 0\&.50,
- 0\&.50\&. The expected full and incremental compression factor for dumps\&. It is only used if
- \fIAmanda\fR
- does not have any history information on compression rates for a filesystem, so should not usually need to be set\&. However, it may be useful for the first time a very large filesystem that compresses very little is backed up\&.
+ \fI0\&.50, 0\&.50\fR\&. The expected full and incremental compression factor for dumps\&. It is only used if Amanda does not have any history information on compression rates for a filesystem, so should not usually need to be set\&. However, it may be useful for the first time a very large filesystem that compresses very little is backed up\&.
.RE
.PP
- \fBcompress [client|server]\fR \fI string\fR
+ \fBcompress\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ] [ \fBbest\fR | \fBfast\fR | \fBcustom\fR ]
.RS 4
Default:
- \fIclient fast\fR\&. If
- \fIAmanda\fR
- does compression of the backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape\&. Which place to do compression (if at all) depends on how well the dump image usually compresses, the speed and load on the client or server, network capacity, holding disk capacity, availability of tape hardware compression, etc\&.
+ \fBclient fast\fR\&. If Amanda does compression of the backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape\&. Which place to do compression (if at all) depends on how well the dump image usually compresses, the speed and load on the client or server, network capacity, holding disk capacity, availability of tape hardware compression, etc\&.
.sp
- For either type of compression,
- \fIAmanda\fR
- also allows the selection of three styles of compression\&.
- \fBBest\fR
+ For either type of compression, Amanda also allows the selection of three styles of compression\&.
+ \fBbest\fR
is the best compression available, often at the expense of CPU overhead\&.
- \fBFast\fR
+ \fBfast\fR
is often not as good a compression as
\fBbest\fR, but usually less CPU overhead\&. Or to specify
- \fBCustom\fR
+ \fBcustom\fR
to use your own compression method\&. (See dumptype custom\-compress in example/amanda\&.conf for reference)
.sp
So the
compress server custom
.RS 4
Specify
- \fIserver_custom_compress\fR
+ \fBserver_custom_compress\fR
"PROG"
.sp
PROG must not contain white space and it must accept \-d for uncompress\&.
.sp
Note that some tape devices do compression and this option has nothing to do with whether that is used\&. If hardware compression is used (usually via a particular tape device name or
\fBmt\fR
- option),
- \fIAmanda\fR
- (software) compression should be disabled\&.
+ option), Amanda (software) compression should be disabled\&.
+ .RE
+ .PP
+ \fBclient_custom_compress\fR \fIstring\fR
+ .RS 4
+ Default: none\&. The program to use to perform compression/decompression on the client; used with "compress client custom"\&. Must not contain whitespace\&. Must accept \-d to uncompress\&.
+ .RE
+ .PP
+ \fBserver_custom_compress\fR \fIstring\fR
+ .RS 4
+ Default: none\&. The program to use to perform compression/decompression on the server; used with "compress server custom"\&. Must not contain whitespace\&. Must accept \-d to uncompress\&.
.RE
.PP
- \fBdumpcycle\fR \fI int\fR
+ \fBdumpcycle\fR \fIint\fR
.RS 4
Default:
\fI10 days\fR\&. The number of days in the backup cycle\&. Each disk using this set of options will get a full backup at least this of ten\&. Setting this to zero tries to do a full backup each run\&.
.RE
.PP
- \fBencrypt [none|client|server]\fR
+ \fBencrypt\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ]
.RS 4
- Default:
- \fInone\fR\&. To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape\&.
+ Default: not set\&. To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape\&.
.sp
So the
\fBencrypt\fR
is provided as a reference symmetric encryption program\&.
.RE
.PP
- \fBestimate\fR \fIclient|calcsize|server\fR
+ \fBclient_encrypt\fR \fIstring\fR
+ .RS 4
+ Default: none\&. The program to use to perform encryption/decryption on the client; used with "encrypt client"\&. Must not contain whitespace\&.
+ .RE
+ .PP
+ \fBclient_decrypt_option\fR \fIstring\fR
+ .RS 4
+ Default: \-d\&. The option that can be passed to client_encrypt to make it decrypt instead\&. Must not contain whitespace\&.
+ .RE
+ .PP
+ \fBserver_encrypt\fR \fIstring\fR
+ .RS 4
+ Default: none\&. The program to use to perform encryption/decryption on the server; used with "encrypt server"\&. Must not contain whitespace\&.
+ .RE
+ .PP
+ \fBserver_decrypt_option\fR \fIstring\fR
+ .RS 4
+ Default: \-d\&. The option that can be passed to server_encrypt to make it decrypt instead\&. Must not contain whitespace\&.
+ .RE
+ .PP
+ \fBestimate\fR [ \fBclient\fR | \fBcalcsize\fR | \fBserver\fR ]+
.RS 4
Default:
- \fIclient\fR\&. Determine the way
- \fIAmanda\fR
- does it\'s estimate\&.
+ \fBclient\fR\&. Determine the way Amanda estimates the size of each DLE before beginning a backup\&. This is a list of acceptable estimate methods, and Amanda applies the first method supported by the application\&. The methods are:
.PP
client
.RS 4
- Use the same program as the dumping program, this is the most accurate way to do estimates, but it can take a long time\&.
+ Use the same program as the dumping program\&. This is the most accurate method to do estimates, but it can take a long time\&.
.RE
.PP
calcsize
.PP
server
.RS 4
- Use only statistics from the previous run to give an estimate, it takes only a few seconds but the result is not accurate if your disk usage changes from day to day\&.
+ Use only statistics from the previous few runs to give an estimate\&. This very quick, but the result is not accurate if your disk usage changes from day to day\&. If this method is specified, but the server does not have enough data to make an estimate, then the option is internally moved to the end of the list, thereby preferring \'client\' or \'calcsize\' in this case\&.
.RE
.RE
.PP
- \fBexclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
+ \fBexclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
.RS 4
Default:
- \fIfile\fR\&. There are two exclude lists,
- \fBexclude file\fR
+ \fBfile\fR\&. Exclude is the opposite of
+ \fBinclude\fR
+ and specifies files that will be excluded from the backup\&. The format of the exclude expressions depends on the application, and some applications do not support excluding files at all\&.
+ .sp
+ There are two exclude parameters,
+ \fBexclude\fR
+ \fBfile\fR
and
- \fBexclude list\&.\fR
+ \fBexclude\fR
+ \fBlist\&.\fR
With
- \fBexclude file\fR
- , the
+ \fBexclude\fR
+ \fBfile\fR, the
\fIstring\fR
- is a
- \fBGNU\-tar\fR
- exclude expression\&. With
- \fBexclude list\fR
+ is an exclude expression\&. With
+ \fBexclude\fR
+ \fBlist\fR
, the
\fIstring\fR
is a file name on the client containing
\fBGNU\-tar\fR
- exclude expressions\&. The path to the specified exclude list file, if present (see description of \'optional\' below), must be readable by the
- \fIAmanda\fR
- user\&.
+ exclude expressions\&. The path to the specified exclude list file, if present (see description of \'optional\' below), must be readable by the Amanda user\&.
.sp
- All exclude expressions are concatenated in one file and passed to
- \fBGNU\-tar\fR
- as an
+ All exclude expressions are concatenated in one file and passed to the application as an
\fB\-\-exclude\-from\fR
argument\&.
.sp
- Exclude expressions must always be specified as relative to the head directory of the DLE\&.
+ For
+ \fBGNU\-tar\fR, exclude expressions must always be specified as relative to the top\-level directory of the DLE, and must start with "\&./"\&. See the manpages for individual applications for more information on supported exclude expressions\&.
.sp
With the
\fBappend\fR
If
\fBoptional\fR
is specified for
- \fBexclude list\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
+ \fBexclude\fR
+ \fBlist\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
.sp
For
- \fBexclude list\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
+ \fBexclude\fR
+ \fBlist\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
.nf
exclude list "\&.amanda\&.excludes"
.fi
/usr/local, and so on\&.
.RE
.PP
- \fBholdingdisk\fR [ never|auto|required ]
+ \fBholdingdisk\fR [ \fBnever\fR | \fBauto\fR | \fBrequired\fR ]
.RS 4
Default:
- \fIauto\fR\&. Whether a holding disk should be used for these backups or whether they should go directly to tape\&. If the holding disk is a portion of another file system that
- \fIAmanda\fR
- is backing up, that file system should refer to a dumptype with
+ \fBauto\fR\&. Whether a holding disk should be used for these backups or whether they should go directly to tape\&. If the holding disk is a portion of another file system that Amanda is backing up, that file system should refer to a dumptype with
\fBholdingdisk\fR
set to
\fInever\fR
.RE
.RE
.PP
- \fBignore\fR \fI boolean\fR
+ \fBignore\fR \fIboolean\fR
.RS 4
Default:
- \fIno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the
+ \fBno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the
\fIdisklist\fR
file is shared among several configurations, some of which should not back up all the listed file systems\&.
.RE
.PP
- \fBinclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
+ \fBinclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
.RS 4
Default:
- \fIfile\fR
+ \fBfile\fR
"\&."\&. There are two include lists,
\fBinclude file\fR
and
\fIstring\fR
is a file name on the client containing glob expressions\&.
.sp
- All include expressions are expanded by
- \fIAmanda\fR, concatenated in one file and passed to
+ All include expressions are expanded by Amanda, concatenated in one file and passed to
\fBGNU\-tar\fR
as a
\fB\-\-files\-from\fR
\fBNote\fR
.ps -1
.br
- For globbing to work at all, even the limited single level, the top level directory of the DLE must be readable by the
- \fIAmanda\fR
- user\&.
+ For globbing to work at all, even the limited single level, the top level directory of the DLE must be readable by the Amanda user\&.
.sp .5v
.RE
With the
If
\fBoptional\fR
is specified for
- \fBinclude list,\fR
- then amcheck will not complain if the file doesn\'t exist or is not readable\&.
+ \fBinclude list\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
.sp
For
\fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\&.
.RE
.PP
- \fBindex\fR \fI boolean\fR
+ \fBindex\fR \fIboolean\fR
.RS 4
Default:
- \fIno\fR\&. Whether an index (catalogue) of the backup should be generated and saved in
+ \fBno\fR\&. Whether an index (catalogue) of the backup should be generated and saved in
\fBindexdir\fR\&. These catalogues are used by the
\fBamrecover\fR
utility\&.
.RE
.PP
- \fBkencrypt\fR \fI boolean\fR
+ \fBkencrypt\fR \fIboolean\fR
.RS 4
Default:
- \fIno\fR\&. Whether the backup image should be encrypted by Kerberos as it is sent across the network from the backup client host to the tape server host\&.
+ \fBno\fR\&. Whether the backup image should be encrypted by Kerberos as it is sent across the network from the backup client host to the tape server host\&.
.RE
.PP
- \fBmaxdumps\fR \fI int\fR
+ \fBmaxdumps\fR \fIint\fR
.RS 4
Default:
- 1\&. The maximum number of backups from a single host that
- \fIAmanda\fR
- will attempt to run in parallel\&. See also the main section parameter
+ \fI1\fR\&. The maximum number of backups from a single host that Amanda will attempt to run in parallel\&. See also the main section parameter
\fBinparallel\fR\&.
.RE
.PP
- \fBmaxpromoteday\fR \fI int\fR
+ \fBmaxpromoteday\fR \fIint\fR
.RS 4
Default:
- 10000\&. The maximum number of day for a promotion, set it 0 if you don\'t want promotion, set it to 1 or 2 if your disks get overpromoted\&.
+ \fI10000\fR\&. The maximum number of day for a promotion, set it 0 if you don\'t want promotion, set it to 1 or 2 if your disks get overpromoted\&.
.RE
.PP
- \fBpriority\fR \fI string\fR
+ \fBpriority\fR [ \fBlow\fR | \fBmedium\fR | \fBhigh\fR ]
.RS 4
Default:
- \fImedium\fR\&. When there is no tape to write to,
- \fIAmanda\fR
- will do incremental backups in priority order to the holding disk\&. The priority may be high (2), medium (1), low (0) or a number of your choice\&.
+ \fBmedium\fR\&. When there is no tape to write to, Amanda will do incremental backups in priority order to the holding disk\&. The priority may be high (2), medium (1), low (0) or a number of your choice\&.
.RE
.PP
- \fBprogram\fR [DUMP|GNUTAR|APPLICATION]
+ \fBprogram\fR [ \fB"DUMP"\fR | \fB"GNUTAR"\fR | \fB"APPLICATION"\fR ]
.RS 4
Default:
- \fIDUMP\fR\&. The type of backup to perform\&. Valid values are:
+ \fI"DUMP"\fR\&. The type of backup to perform\&. Valid values are:
.PP
- \fBDUMP\fR
+ \fB"DUMP"\fR
.RS 4
The native operating system backup program\&.
.RE
.PP
- \fBGNUTAR\fR
+ \fB"GNUTAR"\fR
.RS 4
To use GNU\-tar or to do PC backups using Samba\&.
.RE
.PP
- \fBAPPLICATION\fR
+ \fB"APPLICATION"\fR
.RS 4
- To use an application\-tool, see the
+ To use an application, see the
\fIapplication\fR
option\&.
.RE
.RE
.PP
- \fBapplication\fR \fI string\fR
+ \fBapplication\fR \fIstring\fR
.RS 4
- No default\&. Must be the name of an application\-tool if
+ No default\&. Must be the name of an application if
\fIprogram\fR
is set to
\fIAPPLICATION\fR\&. See APPLICATION SECTION below\&.
.RE
.PP
- \fBscript\fR \fI string\fR
+ \fBscript\fR \fIstring\fR
.RS 4
- No default\&. Must be the name of a script\-tool\&. You can have many script\&. See SCRIPT SECTION below\&.
+ No default\&. Must be the name of a script\&. You can have many script\&. See SCRIPT SECTION below\&.
.RE
.PP
- \fBproperty\fR [append] \fIstring\fR \fIstring\fR+
+ \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
.RS 4
These options can set various properties, they can be used by third party software to store information in the configuration file\&. 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\&.
.RE
.PP
- \fBrecord\fR \fI boolean\fR
+ \fBrecord\fR \fIboolean\fR
.RS 4
Default:
-\fByes\fR\&. Whether to ask the backup program to update its database (e\&.g\&.
-/etc/dumpdates
+\fIyes\fR\&. Whether to ask the backup program to update its database (e\&.g\&.
+/var/lib/dumpdates
for DUMP or
/usr/local/var/amanda/gnutar\-lists
for GNUTAR) of time stamps\&. This is normally enabled for daily backups and turned off for periodic archival runs\&.
.RE
.PP
- \fBskip\-full\fR \fI boolean\fR
+ \fBskip\-full\fR \fIboolean\fR
.RS 4
Default:
- \fIno\fR\&. If
- \fItrue\fR
+ \fBno\fR\&. If
+ \fBtrue\fR
and
\fBplanner\fR
- has scheduled a full backup, these disks will be skipped, and full backups should be run off\-line on these days\&. It was reported that
- \fIAmanda\fR
- only schedules level 1 incrementals in this configuration; this is probably a bug\&.
+ has scheduled a full backup, these disks will be skipped, and full backups should be run off\-line on these days\&. It was reported that Amanda only schedules level 1 incrementals in this configuration; this is probably a bug\&.
.RE
.PP
- \fBskip\-incr\fR \fI boolean\fR
+ \fBskip\-incr\fR \fIboolean\fR
.RS 4
Default:
- \fIno\fR\&. If
- \fItrue\fR
+ \fBno\fR\&. If
+ \fBtrue\fR
and
\fBplanner\fR
has scheduled an incremental backup, these disks will be skipped\&.
.RE
.PP
- \fBssh_keys\fR \fI string\fR
+ \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\&.
+ Default: not set\&. 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
- \fBstarttime\fR \fI int\fR
+ \fBstarttime\fR \fIint\fR
.RS 4
- Default:
- \fInone\fR\&. Backups will not start until after this time of day\&. The value should be hh*100+mm, e\&.g\&. 6:30PM (18:30) would be entered as
+ Default: not set\&. Backup of these disks will not start until after this time of day\&. The value should be hh*100+mm, e\&.g\&. 6:30PM (18:30) would be entered as
1830\&.
.RE
.PP
- \fBstrategy\fR \fI string\fR
+ \fBstrategy\fR [ \fBstandard\fR | \fBnofull\fR | \fBnoinc\fR | \fBskip\fR | \fBincronly\fR ]
.RS 4
Default:
- \fIstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
+ \fBstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
.PP
\fBstandard\fR
.RS 4
- The standard
- \fIAmanda\fR
- schedule\&.
+ The standard Amanda schedule\&.
.RE
.PP
\fBnofull\fR
.PP
\fBskip\fR
.RS 4
- Never do backups (useful when sharing the
+ Treat this DLE as if it doesn\'t exist (useful to disable DLEs when sharing the
\fIdisklist\fR
- file)\&.
+ file between multiple configurations)\&. Skipped DLEs will not be checked or dumped, and will not be matched by disklist expressions\&.
.RE
.PP
\fBincronly\fR
.RS 4
Only do incremental dumps\&.
\fBamadmin force\fR
- should be used to tell
- \fIAmanda\fR
- that a full dump has been performed off\-line, so that it resets to level 1\&.
+ should be used to tell Amanda that a full dump has been performed off\-line, so that it resets to level 1\&.
.RE
.RE
.PP
- \fBtape_splitsize\fR \fI int\fR
+ \fBtape_splitsize\fR \fIint\fR
.RS 4
- Default:
- \fInone\fR\&. Split dump file on tape into pieces of a specified size\&. This allows dumps to be spread across multiple tapes, and can potentially make more efficient use of tape space\&. Note that if this value is too large (more than half the size of the average dump being split), substantial tape space can be wasted\&. If too small, large dumps will be split into innumerable tiny dumpfiles, adding to restoration complexity\&. A good rule of thumb, usually, is 1/10 of the size of your tape\&.
+ Default: not set\&. Split dump file on tape into pieces of a specified size\&. This allows dumps to be spread across multiple tapes, and can potentially make more efficient use of tape space\&. Note that if this value is too large (more than half the size of the average dump being split), substantial tape space can be wasted\&. If too small, large dumps will be split into innumerable tiny dumpfiles, adding to restoration complexity\&. A good rule of thumb, usually, is 1/10 of the size of your tape\&.
.sp
The default unit is Kbytes if it is not specified\&.
.RE
.PP
- \fBsplit_diskbuffer\fR \fI string\fR
+ \fBsplit_diskbuffer\fR \fIstring\fR
.RS 4
- Default:
- \fInone\fR\&. When dumping a split dump in PORT\-WRITE mode (usually meaning "no holding disk"), buffer the split chunks to a file in the directory specified by this option\&.
+ Default: not set\&. When dumping a split dump in PORT\-WRITE mode (usually meaning "no holding disk"), buffer the split chunks to a file in the directory specified by this option\&.
.RE
.PP
- \fBfallback_splitsize\fR \fI int\fR
+ \fBfallback_splitsize\fR \fIint\fR
.RS 4
Default:
\fI10M\fR\&. When dumping a split dump in PORT\-WRITE mode, if no split_diskbuffer is specified (or if we somehow fail to use our split_diskbuffer), we must buffer split chunks in memory\&. This specifies the maximum size split chunks can be in this scenario, and thus the maximum amount of memory consumed for in\-memory splitting\&. The size of this buffer can be changed from its (very conservative) default to a value reflecting the amount of memory that each taper process on the dump server may reasonably consume\&.
.PP
The following
\fBdumptype\fR
- entries are predefined by
- \fIAmanda\fR:
+ entries are predefined by Amanda:
.nf
define dumptype "no\-compress" {
compress none
define dumptype "bsd\-auth" {
auth bsd
}
- define dumptype "krb4\-auth" {
- auth krb4
- }
define dumptype "no\-record" {
record no
}
}
.fi
.PP
- \fIAmanda\fR
- provides a
+ Amanda provides a
\fBdumptype\fR
named
\fIglobal\fR
\fBamanda\&.conf\fR
file that all
\fBdumptype\fRs should reference\&. This provides an easy place to make changes that will affect every
- \fBdumptype\fR\&.
+ \fBdumptype\fR, although you must be careful that every dumptype explicitly inherits from the
+ \fIglobal\fR
+ dumptype \- Amanda does not do so automatically\&.
.SH "TAPETYPE SECTION"
.PP
The
}
.fi
.PP
+ The { must appear at the end of a line, and the } on its own line\&.
+ .PP
\fIName\fR
is the name of this type of tape medium/device\&. It is referenced from the
\fBtapetype\fR
.PP
The tapetype options and values are:
.PP
- \fBcomment\fR \fI string\fR
+ \fBcomment\fR \fIstring\fR
.RS 4
- Default:
- \fInone\fR\&. A comment string describing this set of tape information\&.
+ Default: not set\&. A comment string describing this set of tape information\&.
.RE
.PP
- \fBfilemark\fR \fI int\fR
+ \fBfilemark\fR \fIint\fR
.RS 4
Default:
\fI1 kbytes\fR\&. How large a file mark (tape mark) is, measured in kbytes\&. If the size is only known in some linear measurement (e\&.g\&. inches), convert it to kbytes using the device density\&.
.RE
.PP
- \fBlength\fR \fI int\fR
+ \fBlength\fR \fIint\fR
.RS 4
Default:
\fI2000 kbytes\fR\&. How much data will fit on a tape, expressed in kbytes\&.
.sp
- Note that this value is only used by
- \fIAmanda\fR
- to schedule which backups will be run\&. Once the backups start,
- \fIAmanda\fR
- will continue to write to a tape until it gets an error, regardless of what value is entered for
+ Note that this value is only used by Amanda to schedule which backups will be run\&. Once the backups start, Amanda will continue to write to a tape until it gets an error, regardless of what value is entered for
\fBlength\fR
(but see
\fBamanda-devices\fR(7)
for exceptions)\&.
.RE
.PP
- \fBblocksize\fR \fI int\fR
+ \fBblocksize\fR \fIint\fR
.RS 4
Default:
\fI32 kbytes\fR\&. How much data will be written in each tape record, expressed in kbytes\&. This is similar to the
device property, but if the blocksize is not a multiple of 1024 bytes, then this parameter cannot be used to specify it, and the property must be used instead\&.
.RE
.PP
- \fBreadblocksize\fR \fI int\fR
+ \fBreadblocksize\fR \fIint\fR
.RS 4
Default:
\fI32 kytes\fR
The default unit is Kbytes if it is not specified\&.
.RE
.PP
- \fBspeed\fR \fI int\fR
+ \fBspeed\fR \fIint\fR
.RS 4
Default:
- \fI200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by
- \fIAmanda\fR\&.
+ \fI200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by Amanda\&.
.RE
.PP
- \fBlbl\-templ\fR \fI string\fR
+ \fBlbl\-templ\fR \fIstring\fR
.RS 4
- A PostScript template file used by
+ Default: not set\&. A PostScript template file used by
\fBamreport\fR
- to generate labels\&. Several sample files are provided with the
- \fIAmanda\fR
- sources in the
+ to generate labels\&. Several sample files are provided with the Amanda sources in the
\fIexample\fR
directory\&. See the
\fBamreport\fR(8)
}
.fi
.PP
+ The { must appear at the end of a line, and the } on its own line\&.
+ .PP
\fIname\fR
is the name of this type of network interface\&. It is referenced from the
\fIdisklist\fR
file\&.
.PP
- Note that these sections define network interface characteristics, not the actual interface that will be used\&. Nor do they impose limits on the bandwidth that will actually be taken up by
- \fIAmanda\fR\&.
- \fIAmanda\fR
- computes the estimated bandwidth each file system backup will take based on the estimated size and time, then compares that plus any other running backups with the limit as another of the criteria when deciding whether to start the backup\&. Once a backup starts,
- \fIAmanda\fR
- will use as much of the network as it can leaving throttling up to the operating system and network hardware\&.
+ Note that these sections define network interface characteristics, not the actual interface that will be used\&. Nor do they impose limits on the bandwidth that will actually be taken up by Amanda\&. Amanda computes the estimated bandwidth each file system backup will take based on the estimated size and time, then compares that plus any other running backups with the limit as another of the criteria when deciding whether to start the backup\&. Once a backup starts, Amanda will use as much of the network as it can leaving throttling up to the operating system and network hardware\&.
.PP
The interface options and values are:
.PP
- \fBcomment\fR \fI string\fR
+ \fBcomment\fR \fIstring\fR
.RS 4
- Default:
- \fInone\fR\&. A comment string describing this set of network information\&.
+ Default: not set\&. A comment string describing this set of network information\&.
.RE
.PP
- \fBuse\fR \fI int\fR
+ \fBuse\fR \fIint\fR
.RS 4
Default:
\fI8000 Kbps\fR\&. The speed of the interface in Kbytes per second\&.
The
\fBamanda\&.conf\fR
file may define multiple types of application\&. The information is entered in a
- \fBapplication\-tool\fR
+ \fBapplication\fR
section, which looks like this:
.nf
- define application\-tool "\fIname\fR" {
+ define application "\fIname\fR" {
\fIapplication\-option\fR \fIapplication\-value\fR
\&.\&.\&.
}
.fi
.PP
+ The { must appear at the end of a line, and the } on its own line\&.
+ .PP
\fIname\fR
is the name of this type of application\&. It is referenced from the
\fIdumptype\fR
.PP
- The application\-tool options and values are:
+ The application options and values are:
.PP
\fBcomment\fR \fIstring\fR
.RS 4
- Default:
- \fInone\fR\&. A comment string describing this application\&.
+ Default: not set\&. A comment string describing this application\&.
.RE
.PP
\fBplugin\fR \fIstring\fR
directory on the client\&.
.RE
.PP
- \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
+ \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
The
\fBamanda\&.conf\fR
file may define multiple types of script\&. The information is entered in a
- \fBscript\-tool\fR
+ \fBscript\fR
section, which looks like this:
.nf
- define script\-tool "\fIname\fR" {
+ define script "\fIname\fR" {
\fIscript\-option\fR \fIscript\-value\fR
\&.\&.\&.
}
.fi
.PP
+ The { must appear at the end of a line, and the } on its own line\&.
+ .PP
\fIname\fR
is the name of this type of script\&. It is referenced from the
\fIdumptype\fR
.PP
- The script\-tool options and values are:
+ The script options and values are:
.PP
\fBcomment\fR \fIstring\fR
.RS 4
- Default:
- \fInone\fR\&. A comment string describing this script\&.
+ Default: not set\&. A comment string describing this script\&.
.RE
.PP
\fBplugin\fR \fIstring\fR
directory on the client and/or server\&.
.RE
.PP
- \fBexecute_where\fR [client|server]
+ \fBorder\fR \fIint\fR
.RS 4
Default:
- \fIclient\fR\&. Where the script must be executed, on the client or server\&.
+ \fI5000\fR\&. Scripts are executed in that order, it is useful if you have many scripts and they must be executed in a spefific order\&.
.RE
.PP
- \fBexecute_on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
+ \fBexecute_where\fR [ \fBclient\fR | \fBserver\fR ]
+ .RS 4
+ Default:
+ \fBclient\fR\&. Where the script must be executed, on the client or server\&.
+ .RE
+ .PP
+ \fB>execute_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
.PP
\fBpre\-host\-backup\fR
.RS 4
- Execute before the backup command for all dle for the client\&.
+ Execute before the backup command for all dle for the client\&. It can\'t be run on client, it must be run on server
.RE
.PP
\fBpost\-dle\-backup\fR
.PP
\fBpost\-host\-backup\fR
.RS 4
- Execute after the backup command for all dle for the client\&.
+ Execute after the backup command for all dle for the client\&. It can\'t be run on client, it must be run on server
.RE
.PP
\fBpre\-recover\fR
.fi
.RE
.PP
- \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
+ \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
}
.fi
.PP
+ The { must appear at the end of a line, and the } on its own line\&.
+ .PP
\fIname\fR
is the user\-specified name of this device\&. It is referenced from the global
\fItapedev\fR
.nf
define changer \fIname\fR {
comment "\fIcomment (optional)\fR"
- tapedev "\fItape\-device\fR"
- tpchanger "\fIchanger\-type\fR"
+ tpchanger "\fIchanger\-spec\fR"
changerdev "\fIdevice\-name\fR"
changerfile "\fIstate\-file\fR"
\&.\&.\&.
}
.fi
.PP
+ The { must appear at the end of a line, and the } on its own line\&.
+ .PP
\fIname\fR
is the user\-specified name of this device\&. The remaining parameters are specific to the changer type selected\&.
+ .PP
+ See
+ \fBamanda-changers\fR(7)
+ for more information on configuring changers\&.
.SH "SEE ALSO"
.PP
-
\fBamanda\fR(8),
\fBamanda-client.conf\fR(5),
- \fBamcrypt\fR(8),
- \fBaespipe\fR(1),
- : http://wiki.zmanda.com
+ \fBamanda-applications\fR(7),
+ \fBamanda-auth\fR(7),
+ \fBamanda-changers\fR(7),
+ \fBamanda-devices\fR(7),
+ \fBamanda-scripts\fR(7)
+ .PP
+ The Amanda Wiki:
+ : http://wiki.zmanda.com/
.SH "AUTHORS"
.PP
\fBJames da Silva\fR <\&jds@amanda\&.org\&>
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
<!-- entities files to use -->
- <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+ <!ENTITY % global_entities SYSTEM 'global.entities'>
%global_entities;
]>
</refmeta>
<refnamediv>
<refname>amanda.conf</refname>
- <refpurpose>Main configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
+ <refpurpose>Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
</refnamediv>
<refentryinfo>
&author.jds;
<!-- body begins here -->
<refsect1><title>DESCRIPTION</title>
- <para>&amconf; is the main configuration file for &A;. This manpage lists the
+ <para>&amconf; is the main configuration file for Amanda. This manpage lists the
relevant sections and parameters of this file for quick reference.</para>
<para> The file <emphasis remap='B'><CONFIG_DIR>/<config>/amanda.conf</emphasis> is loaded.</para>
</refsect1>
<refsect1><title>SYNTAX</title>
<para>There are a number of configuration parameters that control the
- behavior of the &A; programs.
+ behavior of the Amanda programs.
All have default values,
so you need not specify the parameter in
<emphasis remap='B'>amanda.conf</emphasis>
<refsect2><title>KEYWORDS AND IDENTIFIERS</title>
<para>Keywords are case insensitive, i.e.
- <emphasis remap='B'>mailto</emphasis>
+ <amkeyword>mailto</amkeyword>
and
- <emphasis remap='B'>MailTo</emphasis>
+ <amkeyword>MailTo</amkeyword>
are treated the same. Also, the characters
- <emphasis remap='B'>'-'</emphasis>
+ '<amkeyword>-</amkeyword>'
and
- <emphasis remap='B'>'_'</emphasis>
- are interchangeable in all predefined &A; keywords:
- <emphasis remap='B'>device_property</emphasis>
+ '<amkeyword>_</amkeyword>'
+ are interchangeable in all predefined Amanda keywords:
+ <amkeyword>device_property</amkeyword>
and
- <emphasis remap='B'>device-property</emphasis>
+ <amkeyword>device-property</amkeyword>
have the same meaning.</para>
<para>Identifiers are names which are defined in the configuration itself, such
as dumptypes or interfaces. Identifiers are are case-insensitive, but
sensitive to
- <emphasis remap='B'>'-'</emphasis>
+ '<amkeyword>-</amkeyword>'
vs.
- <emphasis remap='B'>'_'</emphasis>.
+ '<amkeyword>_</amkeyword>'.
Identifiers should be quoted in the configuration file, although For historical
reasons, the quotes are optional.</para>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>b byte bytes</emphasis></term>
+ <term><amkeyword>b byte bytes</amkeyword></term>
<listitem>
<para>Some number of bytes.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>bps</emphasis></term>
+ <term><amkeyword>bps</amkeyword></term>
<listitem>
<para>Some number of bytes per second.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>k kb kbyte kbytes kilobyte kilobytes</emphasis></term>
+ <term><amkeyword>k kb kbyte kbytes kilobyte kilobytes</amkeyword></term>
<listitem>
<para>Some number of kilobytes (bytes*1024).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>kps kbps</emphasis></term>
+ <term><amkeyword>kps kbps</amkeyword></term>
<listitem>
<para>Some number of kilobytes per second (bytes*1024).</para>
<para>It is the default multiplier for all size options.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>m mb meg mbyte mbytes megabyte megabytes</emphasis></term>
+ <term><amkeyword>m mb meg mbyte mbytes megabyte megabytes</amkeyword></term>
<listitem>
<para>Some number of megabytes (bytes*1024*1024).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>mps mbps</emphasis></term>
+ <term><amkeyword>mps mbps</amkeyword></term>
<listitem>
<para>Some number of megabytes per second (bytes*1024*1024).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>g gb gbyte gbytes gigabyte gigabytes</emphasis></term>
+ <term><amkeyword>g gb gbyte gbytes gigabyte gigabytes</amkeyword></term>
<listitem>
<para>Some number of gigabytes (bytes*1024*1024*1024).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>tape tapes</emphasis></term>
+ <term><amkeyword>t tb tbyte tbytes terabyte terabytes</amkeyword></term>
+ <listitem>
+ <para>Some number of terabytes (bytes*1024*1024*1024*1024).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>tape tapes</amkeyword></term>
<listitem>
<para>Some number of tapes.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>day days</emphasis></term>
+ <term><amkeyword>day days</amkeyword></term>
<listitem>
<para>Some number of days.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>week weeks</emphasis></term>
+ <term><amkeyword>week weeks</amkeyword></term>
<listitem>
<para>Some number of weeks (days*7).</para>
<note><para>The value
- <emphasis remap='B'>inf</emphasis>
+ <amkeyword>inf</amkeyword>
may be used in most places where an integer is expected
to mean an infinite amount.</para>
<para>Boolean arguments may have any of the values
- <emphasis remap='B'>y</emphasis>,
- <emphasis remap='B'>yes</emphasis>,
- <emphasis remap='B'>t</emphasis>,
- <emphasis remap='B'>true</emphasis>
+ <amkeyword>1</amkeyword>,
+ <amkeyword>y</amkeyword>,
+ <amkeyword>yes</amkeyword>,
+ <amkeyword>t</amkeyword>,
+ <amkeyword>true</amkeyword>
or
- <emphasis remap='B'>on</emphasis>
+ <amkeyword>on</amkeyword>
to indicate a true state, or
- <emphasis remap='B'>n</emphasis>,
- <emphasis remap='B'>no</emphasis>,
- <emphasis remap='B'>f</emphasis>,
- <emphasis remap='B'>false</emphasis>
+ <amkeyword>0</amkeyword>,
+ <amkeyword>n</amkeyword>,
+ <amkeyword>no</amkeyword>,
+ <amkeyword>f</amkeyword>,
+ <amkeyword>false</amkeyword>
or
- <emphasis remap='B'>off</emphasis>
+ <amkeyword>off</amkeyword>
to indicate a false state.
If no argument is given,
- <emphasis remap='B'>true</emphasis>
+ <amkeyword>true</amkeyword>
is assumed.
</para>
</note>
</programlisting>
</para>
</refsect2>
+
+ <refsect2><title>SUBSECTIONS AND INHERITANCE</title>
+
+ <para>Amanda configuration files may include various
+ <emphasis>subsections</emphasis>, each defining a set of configuration
+ directives. Each type of subsection is described below. Note that all types
+ of subsections can <emphasis>inherit</emphasis> from other subsections of the
+ same type by naming the "parent" section in the "child" subsection. For
+ example:
+
+ <programlisting>
+ define dumptype global {
+ record yes
+ index yes
+ }
+
+ define dumptype nocomp {
+ global # inherit the parameters in dumptype 'global'
+ compress none
+ }
+ </programlisting></para>
+
+ <para>Note that multiple inheritance is also supported by simply naming
+ multiple parent sections in a child. Parents are implicitly expanded in place
+ in a child, and the last occurrence of each parameter takes precedence. For
+ example,
+ <programlisting>
+ define tapetype par1 {
+ comment "Parent 1"
+ filemark 8k
+ speed 300bps
+ length 200M
+ }
+ define tapetype par2 {
+ comment "Parent 2"
+ filemark 16k
+ speed 400bps
+ }
+ define tapetype child {
+ par1
+ par2
+ filemark 32k
+ }
+ </programlisting>
+ In this example, 'child' will have a filemark of 32k, a speed of 400bps, and a
+ length of 200M.</para>
+ </refsect2>
+
</refsect1>
<refsect1>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>org</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>org</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>daily</emphasis>.
+ <amdefault>"daily"</amdefault>.
A descriptive name for the configuration.
This string appears in the Subject line of mail reports.
- Each &A; configuration should have a different string to keep
+ Each Amanda configuration should have a different string to keep
mail reports distinct.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>mailer</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>mailer</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user < message_file</emphasis>'.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>mailto</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>mailto</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>operators</emphasis>.
- A space separated list of recipients for mail reports.</para>
+ <para>Default: none.
+ A space separated list of recipients for mail reports. If not specified, amdump will not send any mail.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>send-amreport-on</emphasis> [all|strange|error|never]</term>
+ <term><amkeyword>send-amreport-on</amkeyword> [ <amkeyword>all</amkeyword> | <amkeyword>strange</amkeyword> | <amkeyword>error</amkeyword> | <amkeyword>never</amkeyword> ]</term>
<listitem>
<para>Default:
- <emphasis remap='B'>all</emphasis>.
+ <amkeyword>all</amkeyword>.
Specify which types of messages will trigger an email from amreport. amreport is used by amdump and amflush.</para>
<!-- .RS -->
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>all</emphasis></term>
+ <term><amkeyword>all</amkeyword></term>
<listitem>
<para>Send an email on any message.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>strange</emphasis></term>
+ <term><amkeyword>strange</amkeyword></term>
<listitem>
- <para>Send an email on strange or error message. A strange message occurs when the dump succeeded, but returned one or more errors unknown to &A;.</para>
+ <para>Send an email on strange or error message. A strange message occurs when the dump succeeded, but returned one or more errors unknown to Amanda.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>error</emphasis></term>
+ <term><amkeyword>error</amkeyword></term>
<listitem>
<para>Send an email only on error messages.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>never</emphasis></term>
+ <term><amkeyword>never</amkeyword></term>
<listitem>
<para>Never send an email.</para>
</listitem>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>10 days</emphasis>.
+ <amdefault>10 days</amdefault>.
The number of days in the backup cycle.
Each disk will get a full backup at least this often.
Setting this to zero tries to do a full backup each run.</para>
<note><para>This parameter may also be set in a specific
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
(see below).
This value sets the default for all
- <emphasis remap='B'>dumptype</emphasis>s
+ <amkeyword>dumptype</amkeyword>s
so must appear in
<emphasis remap='B'>amanda.conf</emphasis>
before any
- <emphasis remap='B'>dumptype</emphasis>s
+ <amkeyword>dumptype</amkeyword>s
are defined.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>runspercycle</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>runspercycle</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>same as dumpcycle</emphasis>.
+ <amdefault>same as dumpcycle</amdefault>.
The number of amdump runs in
- <emphasis remap='B'>dumpcycle</emphasis>
+ <amkeyword>dumpcycle</amkeyword>
days.
A value of 0 means the same value as
- <emphasis remap='B'>dumpcycle</emphasis>.
+ <amkeyword>dumpcycle</amkeyword>.
A value of -1 means guess the number of runs from the &tapelist; file,
which is the number of tapes used in the last
- <emphasis remap='B'>dumpcycle</emphasis>
+ <amkeyword>dumpcycle</amkeyword>
days /
- <emphasis remap='B'>runtapes</emphasis>.</para>
+ <amkeyword>runtapes</amkeyword>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>tapecycle</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>tapecycle</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>15 tapes</emphasis>.
- Typically tapes are used by &A; in an ordered rotation. The <emphasis remap='B'>tapecycle</emphasis> parameter
- defines the size of that rotation. The number of tapes in rotation must be larger than the number of tapes
- required for a complete dump cycle (see the <emphasis remap='B'>dumpcycle</emphasis> parameter).
- </para>
+ <amdefault>15 tapes</amdefault>.
+ Typically tapes are used by Amanda in an ordered rotation. The <amkeyword>tapecycle</amkeyword> parameter
+ defines the size of that rotation. This parameter must be be larger than the number of tapes
+ used in a dumpcycle.</para>
<para>
- This is calculated by multiplying the number of &amdump; runs per dump cycle
- (<emphasis remap='B'>runspercycle</emphasis> parameter) times the number of tapes used per run
- (<emphasis remap='B'>runtapes</emphasis> parameter). Typically two to four times this calculated number of tapes are in rotation.
- While &A; is always willing to use a new tape in its rotation, it refuses to reuse a tape until at
- least '<emphasis remap='B'>tapecycle</emphasis> -1' number of other tapes have been used.
+ The number of tapes per dumpcycle is calculated by multiplying the number of
+ &amdump; runs per dump cycle <amkeyword>runspercycle</amkeyword> (the
+ number of &amdump; runs per dump cycle) and <emphasis
+ remap='B'>runtapes</emphasis> (the number of tapes used per run). Typically
+ <amkeyword>tapecycle</amkeyword> is set to two or four times the tapes
+ per dumpcycle.</para>
+
+ <note>Amanda is commonly misconfigured with <amkeyword>tapecycle</amkeyword>
+ equal to the number of tapes per <amkeyword>dumpcycle</amkeyword>. In this
+ misconfiguration, amanda may erase a full dump before a new one is completed,
+ the recovery is then impossible. tapecycle must be at least one tape larger
+ than the number of tapes per dumpcycle.
+ </note>
+
+ <para>While Amanda is always willing to use a new tape in its rotation, it refuses to reuse a tape until at
+ least '<amkeyword>tapecycle</amkeyword> -1' number of other tapes have been used.
</para>
<para>
- It is considered good administrative practice to set the <emphasis remap='B'>tapecycle</emphasis> parameter
+ It is considered good administrative practice to set the <amkeyword>tapecycle</amkeyword> parameter
slightly lower than the actual number of tapes in rotation. This allows the administrator to more easily cope
with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order.
</para>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>usetimestamps</emphasis>
- <emphasis remap='I'> bool</emphasis></term>
+ <term><amkeyword>usetimestamps</amkeyword>
+ <amtype>bool</amtype></term>
<listitem>
- <para>Default: <emphasis remap='B'>Yes</emphasis>.
+ <para>Default: <amkeyword>Yes</amkeyword>.
This option allows Amanda to track multiple runs per calendar
day. The only reason one might disable it is that Amanda versions before 2.5.1
can't read logfiles written when this option was enabled.
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>label_new_tapes</emphasis>
- <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>label_new_tapes</amkeyword>
+ <amtype>string</amtype></term>
<listitem>
+ <para>Deprecated, use <amkeyword>autolabel</amkeyword> option.</para>
<para>Default: not set.
- When set, this directive will cause &A; to automatically write an &A;
+ When set, this directive will cause Amanda to automatically write an Amanda
tape label to any blank tape she encounters. This option is DANGEROUS
- because when set, &A; will ERASE any non-&A; tapes you may have, and may
+ because when set, Amanda will ERASE any non-Amanda tapes you may have, and may
also ERASE any near-failing tapes. Use with caution.</para>
<para>When using this directive, specify the template for new tape
labels. The template should contain some number of contiguous '%'
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>dumpuser</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>autolabel</amkeyword>
+ <amtype>string</amtype>
+ [<amkeyword>any</amkeyword>]
+ [<amkeyword>other_config</amkeyword>]
+ [<amkeyword>non_amanda</amkeyword>]
+ [<amkeyword>volume_error</amkeyword>]
+ [<amkeyword>empty</amkeyword>]</term>
+ <listitem>
+ <para>Default: not set.
+ When set, this directive will cause Amanda to automatically write an Amanda
+ 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.</para>
+ <para>When using this directive, specify the template for new tape
+ labels. 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:
+ <markup>autolabel "DailySet1-%%%" empty</markup>
+ </para>
+ <variablelist remap='TP'>
+ <varlistentry>
+ <term><amkeyword>any</amkeyword></term>
+ <listitem>equivalent to '<amkeyword>other_config non_amanda volume_error empty</amkeyword>'
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>other_config</amkeyword></term>
+ <listitem>Label volumes with a valid Amanda label that do not match our
+ <amkeyword>labelstr</amkeyword>. Danger: this may erase volumes
+ from other Amanda configurations without warning!
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>non_amanda</amkeyword></term>
+ <listitem>Label volumes which do not start with data that resembles an
+ Amanda header. Danger: this may erase volumes from other backup applications
+ without warning!
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>volume_error</amkeyword></term>
+ <listitem>Label volumes where an error occurs while trying to read the label.
+ Danger: this may erase arbitrary volumes due to transient errors.
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>empty</amkeyword></term>
+ <listitem>Label volumes where a read returns 0 bytes.
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>dumpuser</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>amanda</emphasis>.
- The login name &A; uses to run the backups.
+ <amdefault>"amanda"</amdefault>.
+ The login name Amanda uses to run the backups.
The backup client hosts must allow access
from the tape server host as this user via
<markup>.rhosts</markup>
or
<markup>.amandahosts</markup>,
- depending on how the &A; software was built.</para>
+ depending on how the Amanda software was built.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>printer</emphasis> string</term>
+ <term><amkeyword>printer</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Printer to use when doing tape labels.
See the
- <emphasis remap='B'>lbl-templ</emphasis>
- <emphasis remap='B'>tapetype</emphasis>
+ <amkeyword>lbl-templ</amkeyword>
+ <amkeyword>tapetype</amkeyword>
option.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>tapedev</emphasis> string</term>
+ <term><amkeyword>tapedev</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <filename>null:</filename>.
- The device name, referencing the name of a "device" section in the configuration file. See
- <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+ <amdefault>"null:"</amdefault>.
+ The device name, referencing the name of a "device" section in the configuration file. See
+ <manref name="amanda-devices" vol="7"/>
for more information on device names.</para>
<para>If a tape changer is configured
(see the
- <emphasis remap='B'>tpchanger</emphasis>
+ <amkeyword>tpchanger</amkeyword>
option), this option might not be used.</para>
- <para>If <emphasis remap='B'>tapedev</emphasis> is
+ <para>If <amkeyword>tapedev</amkeyword> is
<emphasis remap='B'>null:</emphasis>,
programs such as
&amdump;
will run normally but all images will be thrown away.
This should only be used for debugging and testing,
and probably only with the
- <emphasis remap='B'>record</emphasis>
+ <amkeyword>record</amkeyword>
option set to
- <emphasis remap='I'>no</emphasis>.</para>
+ <amdefault>no</amdefault>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>device_property</emphasis> string string</term>
+ <term><amkeyword>device_property</amkeyword> <amtype>string</amtype> <amtype>string</amtype></term>
<listitem>
<para>These options can set various device properties. See
- <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+ <manref name="amanda-devices" vol="7"/>
for more information on device properties and their syntax.
Both strings are always quoted; the first string contains the name of
the property to set, and the second contains its value. For example, to set
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>property</emphasis> [append] string string+</term>
+ <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
<listitem>
<para>These options can set various properties, they can be used by third
party software to store information in the configuration file.
Both strings are quoted; the first string contains the name of
the property to set, and the others contains its values.
- <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
+ <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>tpchanger</emphasis> string</term>
+ <term><amkeyword>tpchanger</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
The name of the tape changer.
If a tape changer is not configured, this option is not used
and should be commented out of the configuration file.</para>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>changerdev</emphasis> string</term>
+ <term><amkeyword>changerdev</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <filename>/dev/null</filename>.
+ <amdefault>"dev/null"</amdefault>.
A tape changer configuration parameter.
Usage depends on the particular changer defined with the
- <emphasis remap='B'>tpchanger</emphasis>
+ <amkeyword>tpchanger</amkeyword>
option.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>changerfile</emphasis> string</term>
+ <term><amkeyword>changerfile</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <filename>/usr/adm/amanda/log/changer-status</filename>.
+ <amdefault>"usr/adm/amanda/log/changer-status"</amdefault>.
A tape changer configuration parameter.
Usage depends on the particular changer defined with the
- <emphasis remap='B'>tpchanger</emphasis>
+ <amkeyword>tpchanger</amkeyword>
option.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>runtapes</emphasis> int</term>
+ <term><amkeyword>runtapes</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <literal>1</literal>.
+ <amdefault>1</amdefault>.
The maximum number of tapes used in a single run.
If a tape changer is not configured, this option is not used
and should be commented out of the configuration file.</para>
<para>If a tape changer is configured, this may be set larger than one to
- let &A; write to more than one tape.</para>
+ let Amanda write to more than one tape.</para>
<para>Note that this is an upper bound on the number of tapes,
- and &A; may use less.</para>
- <para>Also note that as of this release, &A; does not support true tape overflow.
+ and Amanda may use less.</para>
+ <para>Also note that as of this release, Amanda does not support true tape overflow.
When it reaches the end of one tape,
- the backup image &A; was processing starts over again on the next tape.</para>
+ the backup image Amanda was processing starts over again on the next tape.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>maxdumpsize</emphasis> int</term>
+ <term><amkeyword>maxdumpsize</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>runtapes</emphasis>*<emphasis remap='I'>tape_length</emphasis>.
+ <amdefault><amkeyword>runtapes</amkeyword>*<amkeyword>tape_length</amkeyword></amdefault>.
Maximum number of bytes the planner will schedule for a run.</para>
<para>The default unit is Kbytes if it is not specified.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>taperalgo</emphasis> [first|firstfit|largest|largestfit|smallest|last]</term>
+ <term><amkeyword>taperalgo</amkeyword> [ <amkeyword>first</amkeyword> | <amkeyword>firstfit</amkeyword> | <amkeyword>largest</amkeyword> | <amkeyword>largestfit</amkeyword> | <amkeyword>smallest</amkeyword> | <amkeyword>last</amkeyword> ]</term>
<listitem>
<para>Default:
- <emphasis remap='I'>first</emphasis>.
+ <amkeyword>first</amkeyword>.
The algorithm used to choose which dump image to send to the taper.</para>
<!-- .RS -->
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>first</emphasis></term>
+ <term><amkeyword>first</amkeyword></term>
<listitem>
<para>First in, first out.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>firstfit</emphasis></term>
+ <term><amkeyword>firstfit</amkeyword></term>
<listitem>
<para>The first dump image that will fit on the current tape.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>largest</emphasis></term>
+ <term><amkeyword>largest</amkeyword></term>
<listitem>
<para>The largest dump image.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>largestfit</emphasis></term>
+ <term><amkeyword>largestfit</amkeyword></term>
<listitem>
<para>The largest dump image that will fit on the current tape.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>smallest</emphasis></term>
+ <term><amkeyword>smallest</amkeyword></term>
<listitem>
<para>The smallest dump image.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>last</emphasis></term>
+ <term><amkeyword>last</amkeyword></term>
<listitem>
<para>Last in, first out.</para>
</listitem>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>labelstr</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>labelstr</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>.*</emphasis>.
+ <amdefault>".*"</amdefault>.
The tape label constraint regular expression.
All tape labels generated (see
- <citerefentry><refentrytitle>amlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
+ <manref name="amlabel" vol="8"/>)
and used by this configuration must match the regular expression.
If multiple configurations are run from the same tape server host,
it is helpful to set their labels to different strings
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>tapetype</emphasis> <emphasis remap='I'> identifier</emphasis></term>
+ <term><amkeyword>tapetype</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>"EXABYTE"</emphasis>.
+ <amdefault>no default</amdefault>.
The type of tape drive associated with
- <emphasis remap='B'>tapedev</emphasis>
+ <amkeyword>tapedev</amkeyword>
or
- <emphasis remap='B'>tpchanger</emphasis>.
- This refers to one of the defined <emphasis remap='B'>tapetype</emphasis>s
+ <amkeyword>tpchanger</amkeyword>.
+ This refers to one of the defined <amkeyword>tapetype</amkeyword>s
in the config file (see below), which specify various tape parameters,
like the
- <emphasis remap='B'>length</emphasis>,
- <emphasis remap='B'>filemark</emphasis>
+ <amkeyword>length</amkeyword>,
+ <amkeyword>filemark</amkeyword>
size, and
- <emphasis remap='B'>speed</emphasis>
+ <amkeyword>speed</amkeyword>
of the tape media and device.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>ctimeout</emphasis> int</term>
+ <term><amkeyword>ctimeout</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>30 seconds</emphasis>.
+ <amdefault>30 seconds</amdefault>.
Maximum amount of time that
<emphasis remap='B'>amcheck</emphasis>
will wait for each client host.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>dtimeout</emphasis> int</term>
+ <term><amkeyword>dtimeout</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>1800 seconds</emphasis>.
+ <amdefault>1800 seconds</amdefault>.
Amount of idle time per disk on a given client that a
<emphasis remap='B'>dumper</emphasis>
running from within
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>etimeout</emphasis> int</term>
+ <term><amkeyword>etimeout</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>300 seconds</emphasis>.
+ <amdefault>300 seconds</amdefault>.
Amount of time per estimate on a given client that the
<emphasis remap='B'>planner</emphasis> step of
<command>amdump</command> will wait to get the dump size estimates
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>connect_tries</emphasis> int</term>
+ <term><amkeyword>connect_tries</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>3</emphasis>.
+ <amdefault>3</amdefault>.
How many times the server will try a connection.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>req_tries</emphasis> int</term>
+ <term><amkeyword>req_tries</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>3</emphasis>.
+ <amdefault>3</amdefault>.
How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>netusage</emphasis> int</term>
+ <term><amkeyword>netusage</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>8000 Kbps</emphasis>.
- The maximum network bandwidth allocated to &A;, in Kbytes per second.
+ <amdefault>8000 Kbps</amdefault>.
+ The maximum network bandwidth allocated to Amanda, in Kbytes per second.
See also the
<emphasis remap='B'>interface</emphasis>
section.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>inparallel</emphasis> int</term>
+ <term><amkeyword>inparallel</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <literal>10</literal>.
- The maximum number of backups that &A; will attempt to run in parallel.
- &A; will stay within the constraints of network bandwidth and
+ <amdefault>10</amdefault>.
+ The maximum number of backups that Amanda will attempt to run in parallel.
+ Amanda will stay within the constraints of network bandwidth and
holding disk space available, so it doesn't hurt to set
this number a bit high. Some contention can occur with larger numbers
of backups, but this effect is relatively small on most systems.</para>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>displayunit</emphasis> "k|m|g|t"</term>
+ <term><amkeyword>displayunit</amkeyword> "k|m|g|t"</term>
<listitem>
<para>Default:
- <literal>"k"</literal>.
+ <amdefault>"k"</amdefault>.
The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>dumporder</emphasis> string</term>
+ <term><amkeyword>dumporder</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>tttTTTTTTT</emphasis>.
+ <amdefault>"tttTTTTTTT"</amdefault>.
The priority order of each dumper:
<programlisting>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>maxdumps</emphasis> int</term>
+ <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <literal>1</literal>.
- The maximum number of backups from a single host that &A; will
+ <amdefault>1</amdefault>.
+ The maximum number of backups from a single host that Amanda will
attempt to run in parallel. See also the
<emphasis remap='B'>inparallel</emphasis>
option.</para>
<para>Note that this parameter may also be set in a specific
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
(see below).
This value sets the default for all
- <emphasis remap='B'>dumptype</emphasis>s
+ <amkeyword>dumptype</amkeyword>s
so must appear in
<emphasis remap='B'>amanda.conf</emphasis>
before any
- <emphasis remap='B'>dumptype</emphasis>s
+ <amkeyword>dumptype</amkeyword>s
are defined.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>bumpsize</emphasis> int</term>
+ <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>10 Mbytes</emphasis>.
+ <amdefault>10 Mbytes</amdefault>.
The minimum savings required to trigger an automatic
bump from one incremental level to the next, expressed as size.
- If &A; determines that the next higher backup level
+ If Amanda determines that the next higher backup level
will be this much smaller than the current level,
it will do the next level.
The value of this parameter is used only if the parameter
</para>
<para>
See also the options
- <emphasis remap='B'>bumppercent</emphasis>,
- <emphasis remap='B'>bumpmult</emphasis> and
- <emphasis remap='B'>bumpdays</emphasis>.</para>
+ <amkeyword>bumppercent</amkeyword>,
+ <amkeyword>bumpmult</amkeyword> and
+ <amkeyword>bumpdays</amkeyword>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>bumppercent</emphasis> int</term>
+ <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0 percent</emphasis>.
+ <amdefault>0</amdefault>.
The minimum savings required to trigger an automatic
bump from one incremental level to the next, expressed as percentage of the
current size of the DLE (size of current level 0).
- If &A; determines that the next higher backup level
+ If Amanda determines that the next higher backup level
will be this much smaller than the current level,
it will do the next level.
</para>
</para>
<para>
See also the options
- <emphasis remap='B'>bumpsize</emphasis>,
- <emphasis remap='B'>bumpmult</emphasis> and
- <emphasis remap='B'>bumpdays</emphasis>.</para>
+ <amkeyword>bumpsize</amkeyword>,
+ <amkeyword>bumpmult</amkeyword> and
+ <amkeyword>bumpdays</amkeyword>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
+ <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
<listitem>
<para>Default:
- <literal>1.5</literal>.
+ <amdefault>1.5</amdefault>.
The bump size multiplier.
- &A; multiplies
- <emphasis remap='B'>bumpsize</emphasis>
+ Amanda multiplies
+ <amkeyword>bumpsize</amkeyword>
by this factor for each level.
This prevents active filesystems from
bumping too much by making it harder to bump to the next level.
For example, with the default
- <emphasis remap='B'>bumpsize</emphasis>
+ <amkeyword>bumpsize</amkeyword>
and
- <emphasis remap='B'>bumpmult</emphasis>
+ <amkeyword>bumpmult</amkeyword>
set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
Mbytes for level two, 40 Mbytes for level three, and so on.</para>
<para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>2 days</emphasis>.
- To insure redundancy in the dumps, &A; keeps filesystems at the
+ <amdefault>2 days</amdefault>.
+ To insure redundancy in the dumps, Amanda keeps filesystems at the
same incremental level for at least
- <emphasis remap='B'>bumpdays</emphasis>
+ <amkeyword>bumpdays</amkeyword>
days, even if the other bump threshold criteria are met.</para>
<para>
The global setting of this parameter can be overwritten inside of a
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>diskfile</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>diskfile</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>disklist</emphasis>.
+ <amdefault>"disklist"</amdefault>.
The file name for the
<emphasis remap='I'>disklist</emphasis>
file holding client hosts, disks and other client dumping information.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>infofile</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>infofile</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <filename>/usr/adm/amanda/curinfo</filename>.
+ <amdefault>"/usr/adm/amanda/curinfo"</amdefault>.
The file or directory name for the historical information database.
- If &A; was configured to use DBM databases, this is the base file
+ If Amanda was configured to use DBM databases, this is the base file
name for them.
If it was configured to use text formated databases (the default),
this is the base directory and within here will be a directory per
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>logdir</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>logdir</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <filename>/usr/adm/amanda</filename>.
+ <amdefault>"/usr/adm/amanda"</amdefault>.
The directory for the
<command>amdump</command>
and
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>indexdir</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>indexdir</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default
- <filename>/usr/adm/amanda/index</filename>.
+ <amdefault>"/usr/adm/amanda/index"</amdefault>.
The directory where index files (backup image catalogues) are stored.
Index files are
only generated for filesystems whose
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
has the
- <emphasis remap='B'>index</emphasis>
+ <amkeyword>index</amkeyword>
option enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>tapelist</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>tapelist</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>tapelist</emphasis>.
+ <amdefault>"tapelist"</amdefault>.
The file name for the active &tapelist;.
- &A; maintains this file with information about the active set of tapes.</para>
+ Amanda maintains this file with information about the active set of tapes.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>device_output_buffer_size</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>device_output_buffer_size</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <literal>1280k</literal>.
- Controls the amount of memory used by &A;
+ <amdefault>1280k</amdefault>.
+ Controls the amount of memory used by Amanda
to hold data as it is read from the network or disk before it is written to
the output device. Higher values may be
useful on fast tape drives and optical media.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>tapebufs</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>tapebufs</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <literal>20</literal>.
+ <amdefault>20</amdefault>.
This option is deprecated; use
- the <emphasis remap='B'>device_output_buffer_size</emphasis> directive
- instead. <emphasis remap='B'>tapebufs</emphasis> works the same way,
+ the <amkeyword>device_output_buffer_size</amkeyword> directive
+ instead. <amkeyword>tapebufs</amkeyword> works the same way,
but the number specified is multiplied by the device blocksize prior
to use.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>reserve</emphasis> <emphasis remap='I'> number</emphasis></term>
+ <term><amkeyword>reserve</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <literal>100</literal>.
+ <amdefault>100</amdefault>.
The part of holding-disk space that should be reserved for incremental
backups if no tape is available, expressed as a percentage of the
available holding-disk space (0-100).
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>autoflush</emphasis> <emphasis remap='I'> bool</emphasis></term>
+ <term><amkeyword>autoflush</amkeyword> <amtype>bool</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>off</emphasis>.
+ <amkeyword>off</amkeyword>.
Whether an amdump run will flush the dumps from holding disk to tape.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>amrecover_do_fsf</emphasis> <emphasis remap='I'> bool</emphasis></term>
+ <term><amkeyword>amrecover_do_fsf</amkeyword> <amtype>bool</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>on</emphasis>.
+ <amkeyword>on</amkeyword>.
Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>amrecover_check_label</emphasis> <emphasis remap='I'> bool</emphasis></term>
+ <term><amkeyword>amrecover_check_label</amkeyword> <amtype>bool</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>on</emphasis>.
+ <amkeyword>on</amkeyword>.
Amrecover will call amrestore with the -l flag to check the label.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>amrecover_changer</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>amrecover_changer</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default: ''.
+ <para>Default: not set.
Amrecover will use the changer if you use 'settape <string>' and that string
is the same as the amrecover_changer setting.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>columnspec</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>columnspec</amkeyword> <amtype>string</amtype></term>
<listitem>
+ <para> default: "HostName=0:12:12,Disk=1:11:11,Level=1:1:1,OrigKB=1:-7:0,OutKB=1:-7:0,Compress=1:-6:1,DumpTime=1:-7:7,Dumprate=1:-6:1,TapeTime=1:-6:6,TapeRate=1:-6:1"</para>
<para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
should use.
<emphasis remap='I'>String</emphasis>
is a comma (',') separated list of triples. Each triple consists
of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
- These three parts specify:</para>
-
+ These four parts specify:
+
<orderedlist>
<listitem>
- <para>the name of the column, which may be:</para>
+ <para>the name of the column, which may be:
<programlisting>
Compress (compression ratio)
OutKB (output image size in KBytes)
TapeRate (tape writing rate in KBytes/sec)
TapeTime (total tape time in hours:minutes)
- </programlisting>
+ </programlisting></para>
</listitem>
<listitem>
- <para>the amount of space to display before the column (used to get whitespace between columns).</para><para/>
+ <para>the amount of space to display before the column (used to get whitespace between columns).</para>
</listitem>
<listitem>
<para>the width of the column itself.
If set to a negative value, the width will be calculated on demand to fit the largest entry in
this column.</para>
</listitem>
- </orderedlist>
+ <listitem>
+ <para>the precision of the column, number of digit after the decimal point for number.</para>
+ </listitem>
+ </orderedlist></para>
<para>Here is an example:
<programlisting>
- columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
+ columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
</programlisting></para>
<para>
The above will display the disk information in 18 characters
and put one space before it. The hostname column will be 10 characters wide with
- no space to the left. The output KBytes column is seven characters wide
+ no space to the left. The Original KBytes print 2 decimal digit. The output KBytes column is seven characters wide
with one space before it.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>includefile</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>includefile</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>none</emphasis>.
- The name of an &A; configuration file to include within the current file.
+ <amdefault>no default</amdefault>.
+ The name of an Amanda configuration file to include within the current file.
Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
Relative pathnames are relative to the configuration directory.
</para>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>debug_auth</emphasis> int</term>
+ <term><amkeyword>debug_days</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0</emphasis>.
+ <amdefault>3</amdefault>.
+ The number of days the debug files are kept.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>debug_auth</amkeyword> <amtype>int</amtype></term>
+ <listitem>
+ <para>Default:
+ <amdefault>0</amdefault>.
Debug level of the auth module</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>debug_event</emphasis> int</term>
+ <term><amkeyword>debug_event</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0</emphasis>.
+ <amdefault>0</amdefault>.
Debug level of the event module</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>debug_holding</emphasis> int</term>
+ <term><amkeyword>debug_holding</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0</emphasis>.
+ <amdefault>0</amdefault>.
Debug level of the holdingdisk module</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>debug_protocol</emphasis> int</term>
+ <term><amkeyword>debug_protocol</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0</emphasis>.
+ <amdefault>0</amdefault>.
Debug level of the protocol module</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>debug_planner</emphasis> int</term>
+ <term><amkeyword>debug_planner</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0</emphasis>.
+ <amdefault>0</amdefault>.
Debug level of the planner process</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>debug_driver</emphasis> int</term>
+ <term><amkeyword>debug_driver</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0</emphasis>.
+ <amdefault>0</amdefault>.
Debug level of the driver process</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>debug_dumper</emphasis> int</term>
+ <term><amkeyword>debug_dumper</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0</emphasis>.
+ <amdefault>0</amdefault>.
Debug level of the dumper process</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>debug_chunker</emphasis> int</term>
+ <term><amkeyword>debug_chunker</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0</emphasis>.
+ <amdefault>0</amdefault>.
Debug level of the chunker process</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>debug_taper</emphasis> int</term>
+ <term><amkeyword>debug_taper</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0</emphasis>.
+ <amdefault>0</amdefault>.
Debug level of the taper process</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>flush-threshold-dumped</emphasis> int</term>
+ <term><amkeyword>flush-threshold-dumped</amkeyword> <amtype>int</amtype></term>
<listitem>
- <para>Default: <emphasis remap='I'>0</emphasis>.
- &A; will not begin writing data to a new volume until the amount of
+ <para>Default: <amdefault>0</amdefault>.
+ Amanda will not begin writing data to a new volume until the amount of
data on the holding disk is at least this percentage of the volume
- size. In other words, &A; will not begin until the
- inequality <inlineequation><mathphrase>h > t ×
- d</mathphrase></inlineequation> is satisfied,
- where <mathphrase>h</mathphrase> is the amount of data on the
- holding disk, <mathphrase>t</mathphrase> is the capacity of a
- volume, and <mathphrase>d</mathphrase> is this parameter, expressed as a
- percentage. This parameter may be larger than 100%, for example to keep
+ size. In other words, Amanda will not begin until the
+ amount of data on the holding disk is greater than the tape
+ length times this parameter.
+ This parameter may be larger than 100%, for example to keep
more recent dumps on the holding disk for faster recovery.</para>
<para> Needless to say, your holding disk must be big enough
that this criterion could be satisfied. If the holding disk cannot
be used for a particular dump (because, for example, there is no
- remaining holding space) then &A; will disregard the constraint
+ remaining holding space) then Amanda will disregard the constraint
specified by this setting and start a new volume anyway. Once
writing to a volume has begun, this constraint is not applied unless
and until a new volume is needed.</para>
<para> The value of this parameter may not exceed than that of
- the <emphasis remap='B'>flush-threshold-scheduled</emphasis>
+ the <amkeyword>flush-threshold-scheduled</amkeyword>
parameter.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>flush-threshold-scheduled</emphasis> int</term>
+ <term><amkeyword>flush-threshold-scheduled</amkeyword> <amtype>int</amtype></term>
<listitem>
- <para>Default: <emphasis remap='I'>0</emphasis>.
- &A; will not begin writing data to a new volume until the sum of the
+ <para>Default: <amdefault>0</amdefault>.
+ Amanda will not begin writing data to a new volume until the sum of the
amount of data on the holding disk and the estimated amount of data
remaining to be dumped during this run is at least this percentage
- of the volume size. In other words, &A; will not begin until the
+ of the volume size. In other words, Amanda will not begin until the
inequality <inlineequation><mathphrase>h + s > t ×
d</mathphrase></inlineequation> is satisfied,
where <mathphrase>h</mathphrase> is the amount of data on the
<para> Needless to say, your holding disk must be big enough
that this criterion could be satisfied. If the holding disk cannot
be used for a particular dump (because, for example, there is no
- remaining holding space) then &A; will disregard the constraint
+ remaining holding space) then Amanda will disregard the constraint
specified by this setting and start a new volume anyway. Once
writing to a volume has begun, this constraint is not applied unless
and until a new volume is needed.</para>
<para> The value of this parameter may not be less than that of
- the <emphasis remap='B'>flush-threshold-dumped</emphasis>
- or <emphasis remap='B'>taperflush</emphasis> parameters.</para>
+ the <amkeyword>flush-threshold-dumped</amkeyword>
+ or <amkeyword>taperflush</amkeyword> parameters.</para>
</listitem>
</varlistentry>
<!-- the entity '#215' below is U+00D7 MULTIPLICATION SIGN; the 'times' entity
is not as portable as one might hope. -->
<varlistentry>
- <term><emphasis remap='B'>taperflush</emphasis> int</term>
+ <term><amkeyword>taperflush</amkeyword> <amtype>int</amtype></term>
<listitem>
- <para>Default: <emphasis remap='I'>0</emphasis>.
- At the end of a run, &A; will start a new tape to flush remaining
+ <para>Default: <amdefault>0</amdefault>.
+ At the end of a run, Amanda will start a new tape to flush remaining
data if there is more data on the holding disk at the end of a run
than this setting allows; the amount is specified as a percentage of
the capacity of a single
- volume. In other words, at the end of a run, &A; will begin
+ volume. In other words, at the end of a run, Amanda will begin
a new tape if the
inequality <inlineequation><mathphrase>h > t ×
f</mathphrase></inlineequation> is satisfied,
and <mathphrase>f</mathphrase> is this parameter, expressed as a
percentage. This parameter may be greater than 100%.</para>
<para> The value of this parameter may not exceed that of
- the <emphasis remap='B'>flush-threshold-scheduled</emphasis>
- parameter.; <emphasis remap='B'>autoflush</emphasis> must be set to 'yes' if
- <emphasis remap='B'>taperflush</emphasis> is greater than 0.</para>
+ the <amkeyword>flush-threshold-scheduled</amkeyword>
+ parameter.; <amkeyword>autoflush</amkeyword> must be set to 'yes' if
+ <amkeyword>taperflush</amkeyword> is greater than 0.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>reserved-udp-port</emphasis> int,int</term>
+ <term><amkeyword>reserved-udp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
<listitem>
<para>Default: --with-udpportrange or
- <emphasis remap='I'>512,1023</emphasis>.
+ <amdefault>512,1023</amdefault>.
Reserved udp port that will be used (bsd, bsdudp).
Range is inclusive.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>reserved-tcp-port</emphasis> int,int</term>
+ <term><amkeyword>reserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
<listitem>
<para>Default: --with-low-tcpportrange or
- <emphasis remap='I'>512,1023</emphasis>.
+ <amdefault>512,1023</amdefault>.
Reserved tcp port that will be used (bsdtcp).
Range is inclusive.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>unreserved-tcp-port</emphasis> int,int</term>
+ <term><amkeyword>unreserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
<listitem>
<para>Default: --with-tcpportrange or
- <emphasis remap='I'>1024,65535</emphasis>.
+ <amdefault>1024,65535</amdefault>.
Unreserved tcp port that will be used (bsd, bsdudp).
Range is inclusive.</para>
</listitem>
The syntax is:</para>
<programlisting>
- holdingdisk <emphasis remap='I'>name</emphasis> {
+ define holdingdisk <emphasis remap='I'>name</emphasis> {
<emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
<literal>...</literal>
}
</programlisting>
+ <para>The { must appear at the end of a line, and the } on its own line.</para>
<para><emphasis remap='I'>Name</emphasis>
is a logical name for this holding disk.</para>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
A comment string describing this holding disk.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>directory</emphasis> <emphasis remap='I'> disk</emphasis></term>
+ <term><amkeyword>directory</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <filename>/dumps/amanda</filename>.
+ <amdefault>"/dumps/amanda"</amdefault>.
The path to this holding area.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0 Gb</emphasis>.
+ <amdefault>0 Gb</amdefault>.
Amount of space that can be used in this holding disk area.
If the value is zero, all available space on the file system is used.
- If the value is negative, &A; will use all available space minus that value.</para>
+ If the value is negative, Amanda will use all available space minus that value.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>chunksize</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>chunksize</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>1 Gb</emphasis>.
+ <amdefault>1 Gb</amdefault>.
Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
holding disk files. The size of each chunk will not exceed the specified value.
However, even though dump images are split in the holding disk, they are concatenated as
tape section.</para>
<para>The default unit is Kbytes if it is not specified.</para>
- <para>If 0 is specified, &A; will create holding disk chunks as large as
+ <para>If 0 is specified, Amanda will create holding disk chunks as large as
((INT_MAX/1024)-64) Kbytes.</para>
<para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
<para>Operating systems that are limited to a maximum file size of 2 Gbytes
actually cannot handle files that large.
They must be at least one byte less than 2 Gbytes.
- Since &A; works with 32 Kbyte blocks, and
+ Since Amanda works with 32 Kbyte blocks, and
to handle the final read at the end of the chunk, the chunk size
should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
file size, e.g. 2047 Mbytes.</para>
another set for file systems that should always get a full backup and so on.</para>
<para>A set of backup options are entered in a
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
section, which looks like this:</para>
<programlisting>
}
</programlisting>
+ <para>The { must appear at the end of a line, and the } on its own line.</para>
<para><emphasis remap='I'>Name</emphasis>
is the name of this set of backup options.
It is referenced from the &disklist; file.</para>
<para>Some of the options in a
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
section are the same as those in the main part of &amconf;.
The main option value is used to set the default for all
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
sections. For instance, setting
- <emphasis remap='B'>dumpcycle</emphasis>
+ <amkeyword>dumpcycle</amkeyword>
to 50 in the main part of the config file causes all following
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
sections to start with that value,
but the value may be changed on a section by section basis.
Changes to variables in the main part of the config file must be
done before (earlier in the file) any
- <emphasis remap='B'>dumptype</emphasis>s
+ <amkeyword>dumptype</amkeyword>s
are defined.</para>
<para>The dumptype options and values are:</para>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>auth</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>bsd</emphasis>.
- Type of authorization to perform between tape server and backup client hosts. See <citerefentry><refentrytitle>amanda-auth</refentrytitle><manvolnum>7</manvolnum></citerefentry> for more detail.</para>
+ <amdefault>"bsd"</amdefault>.
+ Type of authorization to perform between tape server and backup client hosts. See <manref name="amanda-auth" vol="7"/> for more detail.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>amandad_path</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>amandad_path</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>$libexec/amandad</emphasis>.
+ <amdefault>"$libexec/amandad"</amdefault>.
Specify the amandad path of the client, only use with rsh/ssh authentification.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>client_username</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>client_username</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>CLIENT_LOGIN</emphasis>.
+ <amdefault>CLIENT_LOGIN</amdefault>.
Specify the username to connect on the client, only use with rsh/ssh authentification.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>client_port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
+ <listitem>
+ <para>Default:
+ <amdefault>"amanda"</amdefault>.
+ Specifies the port to connect to on the client. It can be a service name or a numeric port number.
</para>
</listitem>
</varlistentry>
<!-- bumping parameters yanked from the global section above -->
<varlistentry>
- <term><emphasis remap='B'>bumpsize</emphasis> int</term>
+ <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>10 Mbytes</emphasis>.
+ <amdefault>10 Mbytes</amdefault>.
The minimum savings required to trigger an automatic
bump from one incremental level to the next, expressed as size.
- If &A; determines that the next higher backup level
+ If Amanda determines that the next higher backup level
will be this much smaller than the current level,
it will do the next level.
The value of this parameter is used only if the parameter
<para>The default unit is Kbytes if it is not specified.</para>
<para>
See also the options
- <emphasis remap='B'>bumppercent</emphasis>,
- <emphasis remap='B'>bumpmult</emphasis> and
- <emphasis remap='B'>bumpdays</emphasis>.</para>
+ <amkeyword>bumppercent</amkeyword>,
+ <amkeyword>bumpmult</amkeyword> and
+ <amkeyword>bumpdays</amkeyword>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>bumppercent</emphasis> int</term>
+ <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>0 percent</emphasis>.
+ <amdefault>0</amdefault>.
The minimum savings required to trigger an automatic
bump from one incremental level to the next, expressed as percentage of the
current size of the DLE (size of current level 0).
- If &A; determines that the next higher backup level
+ If Amanda determines that the next higher backup level
will be this much smaller than the current level,
it will do the next level.
</para>
</para>
<para>
See also the options
- <emphasis remap='B'>bumpsize</emphasis>,
- <emphasis remap='B'>bumpmult</emphasis> and
- <emphasis remap='B'>bumpdays</emphasis>.</para>
+ <amkeyword>bumpsize</amkeyword>,
+ <amkeyword>bumpmult</amkeyword> and
+ <amkeyword>bumpdays</amkeyword>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
+ <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
<listitem>
<para>Default:
- <literal>1.5</literal>.
+ <amdefault>1.5</amdefault>.
The bump size multiplier.
- &A; multiplies
- <emphasis remap='B'>bumpsize</emphasis>
+ Amanda multiplies
+ <amkeyword>bumpsize</amkeyword>
by this factor for each level.
This prevents active filesystems from
bumping too much by making it harder to bump to the next level.
For example, with the default
- <emphasis remap='B'>bumpsize</emphasis>
+ <amkeyword>bumpsize</amkeyword>
and
- <emphasis remap='B'>bumpmult</emphasis>
+ <amkeyword>bumpmult</amkeyword>
set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
Mbytes for level two, 40 Mbytes for level three, and so on.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>2 days</emphasis>.
- To insure redundancy in the dumps, &A; keeps filesystems at the
+ <amdefault>2 days</amdefault>.
+ To insure redundancy in the dumps, Amanda keeps filesystems at the
same incremental level for at least
- <emphasis remap='B'>bumpdays</emphasis>
+ <amkeyword>bumpdays</amkeyword>
days, even if the other bump threshold criteria are met.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
A comment string describing this set of backup options.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>comprate</emphasis> <emphasis remap='I'>float</emphasis> [, <emphasis remap='I'>float</emphasis> ]</term>
+ <term><amkeyword>comprate</amkeyword> <amtype>float</amtype> [, <amtype>float</amtype> ]</term>
<listitem>
<para>Default:
- <literal>0.50</literal>,
- <literal>0.50</literal>.
+ <amdefault>0.50, 0.50</amdefault>.
The expected full and incremental compression factor for dumps.
- It is only used if &A; does not have any history information on
+ It is only used if Amanda does not have any history information on
compression rates for a filesystem, so should not usually need to be set.
However, it may be useful for the first time a very large filesystem that
compresses very little is backed up.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>compress [client|server]</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>compress</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ] [ <amkeyword>best</amkeyword> | <amkeyword>fast</amkeyword> | <amkeyword>custom</amkeyword> ]</term>
<listitem>
<para>Default:
- <emphasis remap='I'>client fast</emphasis>.
- If &A; does compression of the backup images, it can do so either on the backup client
+ <amkeyword>client fast</amkeyword>.
+ If Amanda does compression of the backup images, it can do so either on the backup client
host before it crosses the network or on the tape server host as it goes from the
network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the
dump image usually compresses, the speed and load on the client or server, network capacity,
holding disk capacity, availability of tape hardware compression, etc.</para>
- <para>For either type of compression, &A; also allows the selection
+ <para>For either type of compression, Amanda also allows the selection
of three styles of compression.
- <emphasis remap='B'>Best</emphasis>
+ <amkeyword>best</amkeyword>
is the best compression available, often at the expense of CPU overhead.
- <emphasis remap='B'>Fast</emphasis>
+ <amkeyword>fast</amkeyword>
is often not as good a compression as
- <emphasis remap='B'>best</emphasis>,
- but usually less CPU overhead. Or to specify <emphasis remap='B'>Custom</emphasis>
+ <amkeyword>best</amkeyword>,
+ but usually less CPU overhead. Or to specify <amkeyword>custom</amkeyword>
to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
- <para>So the <emphasis remap='B'>compress</emphasis> options line may be one of:</para>
+ <para>So the <amkeyword>compress</amkeyword> options line may be one of:</para>
<variablelist remap='TP'>
<varlistentry>
<varlistentry>
<term>compress server custom</term>
<listitem>
- <para>Specify <emphasis>server_custom_compress</emphasis> "PROG"</para>
+ <para>Specify <amkeyword>server_custom_compress</amkeyword> "PROG"</para>
<para>PROG must not contain white space and it must accept -d for uncompress.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Note that some tape devices do compression and this option has nothing
to do with whether that is used. If hardware compression is used (usually via a particular tape device name
- or <emphasis remap='B'>mt</emphasis> option), &A; (software) compression should be disabled.</para>
+ or <emphasis remap='B'>mt</emphasis> option), Amanda (software) compression should be disabled.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>client_custom_compress</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+ <para>Default: none.
+ The program to use to perform compression/decompression on the client; used with
+ "compress client custom". Must not contain whitespace. Must accept -d to uncompress.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>server_custom_compress</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+ <para>Default: none.
+ The program to use to perform compression/decompression on the server; used with
+ "compress server custom". Must not contain whitespace. Must accept -d to uncompress.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
<listitem>
- <para>Default: <emphasis remap='I'>10 days</emphasis>.
+ <para>Default: <amdefault>10 days</amdefault>.
The number of days in the backup cycle. Each disk using this set of options will get a full
backup at least this of
ten. Setting this to zero tries to do a full backup each run.</para>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>encrypt [none|client|server]</emphasis></term>
+ <term><amkeyword>encrypt</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
<listitem>
- <para>Default: <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
server host as it goes from the network into the holding disk or to tape.</para>
- <para>So the <emphasis remap='B'>encrypt</emphasis> options line may be one
+ <para>So the <amkeyword>encrypt</amkeyword> options line may be one
of:</para>
<variablelist remap='TP'>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><amkeyword>client_encrypt</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+ <para>Default: none.
+ The program to use to perform encryption/decryption on the client; used with
+ "encrypt client". Must not contain whitespace.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>client_decrypt_option</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+ <para>Default: -d.
+ The option that can be passed to client_encrypt to make it decrypt instead.
+ Must not contain whitespace.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>server_encrypt</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+ <para>Default: none.
+ The program to use to perform encryption/decryption on the server; used with
+ "encrypt server". Must not contain whitespace.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>server_decrypt_option</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+ <para>Default: -d.
+ The option that can be passed to server_encrypt to make it decrypt instead.
+ Must not contain whitespace.</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
- <term><emphasis remap='B'>estimate</emphasis> <emphasis remap='I'>client|calcsize|server</emphasis></term>
+ <term><amkeyword>estimate</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>calcsize</amkeyword> | <amkeyword>server</amkeyword> ]+</term>
<listitem>
- <para>Default: <emphasis remap='I'>client</emphasis>.
- Determine the way &A; does it's estimate.</para>
+ <para>Default: <amkeyword>client</amkeyword>.
+ Determine the way Amanda estimates the size of each DLE before beginning a backup. This is a list of acceptable estimate methods, and Amanda applies the first method supported by the application. The methods are:</para>
<variablelist remap='TP'>
<varlistentry>
<term>client</term>
<listitem>
- <para>Use the same program as the dumping program, this is the most
- accurate way to do estimates, but it can take a long time.</para>
+ <para>Use the same program as the dumping program. This is the most
+ accurate method to do estimates, but it can take a long time.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>calcsize</term>
<listitem>
- <para>Use a faster program to do estimates, but the result is less accurate.</para>
+ <para>Use a faster program to do estimates, but the result is less
+ accurate.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>server</term>
<listitem>
- <para>Use only statistics from the previous run to give an estimate,
- it takes only a few seconds but the result is not accurate if your disk
- usage changes from day to day.</para>
+ <para>Use only statistics from the previous few runs to give an estimate.
+ This very quick, but the result is not accurate if your disk
+ usage changes from day to day. If this method is specified, but the
+ server does not have enough data to make an estimate, then the option
+ is internally moved to the end of the list, thereby preferring 'client'
+ or 'calcsize' in this case.</para>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
- <term><emphasis remap='B'>exclude</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
+ <term><amkeyword>exclude</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
<listitem>
<para>Default:
- <emphasis remap='I'>file</emphasis>.
- There are two exclude lists,
- <emphasis remap='B'>exclude file</emphasis>
+ <amkeyword>file</amkeyword>. Exclude is the opposite of
+ <amkeyword>include</amkeyword> and specifies files that will be excluded from
+ the backup. The format of the exclude expressions depends on the application,
+ and some applications do not support excluding files at all.</para>
+
+ <para>There are two exclude parameters,
+ <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>
and
- <emphasis remap='B'>exclude list.</emphasis>
+ <amkeyword>exclude</amkeyword> <amkeyword>list.</amkeyword>
With
- <emphasis remap='B'>exclude file</emphasis>
- , the
- <emphasis remap='I'>string</emphasis>
- is a &gnutar; exclude expression. With
- <emphasis remap='B'>exclude list</emphasis>
+ <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>, the
+ <amtype>string</amtype>
+ is an exclude expression. With
+ <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>
, the
- <emphasis remap='I'>string</emphasis>
+ <amtype>string</amtype>
is a file name on the client containing &gnutar; exclude expressions.
The path to the specified exclude list file, if present (see description of
- 'optional' below), must be readable by the &A; user.</para>
+ 'optional' below), must be readable by the Amanda user.</para>
- <para>All exclude expressions are concatenated in one file and passed to &gnutar;
- as an <option>--exclude-from</option> argument.</para>
+ <para>All exclude expressions are concatenated in one file and passed to the
+ application as an <option>--exclude-from</option> argument.</para>
- <para>Exclude expressions must always be specified as relative to the
- head directory of the DLE.</para>
+ <para>For &gnutar;, exclude expressions must always be specified as relative to the
+ top-level directory of the DLE, and must start with "./". See the manpages for individual
+ applications for more information on supported exclude expressions.</para>
<para>With the
- <emphasis remap='B'>append</emphasis> keyword, the
- <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
- <emphasis remap='I'>string</emphasis> overwrites the list.</para>
+ <amkeyword>append</amkeyword> keyword, the
+ <amtype>string</amtype> is appended to the current list, without it, the
+ <amtype>string</amtype> overwrites the list.</para>
- <para>If <emphasis remap='B'>optional</emphasis>
- is specified for <emphasis remap='B'>exclude list</emphasis>,
+ <para>If <amkeyword>optional</amkeyword>
+ is specified for <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
then amcheck will not complain if the file doesn't exist or is not readable.</para>
- <para>For <emphasis remap='B'>exclude list</emphasis>,
+ <para>For <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
if the file name is relative, the disk name being backed up is prepended.
So if this is entered:</para>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>holdingdisk</emphasis> [ never|auto|required ]</term>
+ <term><amkeyword>holdingdisk</amkeyword> [ <amkeyword>never</amkeyword> | <amkeyword>auto</amkeyword> | <amkeyword>required</amkeyword> ]</term>
<listitem>
<para>Default:
- <emphasis remap='I'>auto</emphasis>.
+ <amkeyword>auto</amkeyword>.
Whether a holding disk should be used for these backups or whether they should go directly to tape.
- If the holding disk is a portion of another file system that &A;
+ If the holding disk is a portion of another file system that Amanda
is backing up, that file system should refer to a dumptype with
- <emphasis remap='B'>holdingdisk</emphasis>
+ <amkeyword>holdingdisk</amkeyword>
set to
<emphasis remap='I'>never</emphasis>
to avoid backing up the holding disk into itself.</para>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>never</emphasis>|no|false|off</term>
+ <term><amkeyword>never</amkeyword>|no|false|off</term>
<listitem>
<para>Never use a holdingdisk, the dump will always go directly to tape. There will be no dump if you have a tape error.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>auto</emphasis>|yes|true|on</term>
+ <term><amkeyword>auto</amkeyword>|yes|true|on</term>
<listitem>
<para>Use the holding disk, unless there is a problem with the holding disk, the dump won't fit there or the medium doesn't require spooling (e.g., VFS device)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>required</emphasis></term>
+ <term><amkeyword>required</amkeyword></term>
<listitem>
<para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>ignore</emphasis> <emphasis remap='I'> boolean</emphasis></term>
+ <term><amkeyword>ignore</amkeyword> <amtype>boolean</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>no</emphasis>.
+ <amkeyword>no</amkeyword>.
Whether disks associated with this backup type should be backed up or not.
This option is useful when the
<emphasis remap='I'>disklist</emphasis>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>include</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
+ <term><amkeyword>include</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
<listitem>
<para>Default:
- <emphasis remap='I'>file</emphasis>
+ <amkeyword>file</amkeyword>
".".
There are two include lists,
- <emphasis remap='B'>include file</emphasis>
+ <amkeyword>include file</amkeyword>
and
- <emphasis remap='B'>include list.</emphasis>
+ <amkeyword>include list.</amkeyword>
With
- <emphasis remap='B'>include file</emphasis>
+ <amkeyword>include file</amkeyword>
, the
- <emphasis remap='I'>string</emphasis>
+ <amtype>string</amtype>
is a glob expression. With
- <emphasis remap='B'>include list</emphasis>
+ <amkeyword>include list</amkeyword>
, the
- <emphasis remap='I'>string</emphasis>
+ <amtype>string</amtype>
is a file name on the client containing glob expressions.</para>
- <para>All include expressions are expanded by &A;, concatenated in one file and passed to &gnutar; as a
+ <para>All include expressions are expanded by Amanda, concatenated in one file and passed to &gnutar; as a
<option>--files-from</option> argument. They must start with "./" and contain no other "/".</para>
<para>Include expressions must always be specified as relative to the
head directory of the DLE.</para>
<note><para>For globbing to work at all, even the limited single level,
- the top level directory of the DLE must be readable by the &A; user.</para>
+ the top level directory of the DLE must be readable by the Amanda user.</para>
</note>
- <para>With the <emphasis remap='B'>append</emphasis> keyword, the
- <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
- <emphasis remap='I'>string</emphasis> overwrites the list.</para>
+ <para>With the <amkeyword>append</amkeyword> keyword, the
+ <amtype>string</amtype> is appended to the current list, without it, the
+ <amtype>string</amtype> overwrites the list.</para>
<para>If
- <emphasis remap='B'>optional</emphasis> is specified for
- <emphasis remap='B'>include list,</emphasis> then amcheck will not complain if the file
+ <amkeyword>optional</amkeyword> is specified for
+ <amkeyword>include list</amkeyword>, then amcheck will not complain if the file
doesn't exist or is not readable.</para>
- <para>For <emphasis remap='B'>include list</emphasis>,
+ <para>For <amkeyword>include list</amkeyword>,
If the file name is relative, the disk name being backed up is prepended.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>index</emphasis> <emphasis remap='I'> boolean</emphasis></term>
+ <term><amkeyword>index</amkeyword> <amtype>boolean</amtype></term>
<listitem>
- <para>Default: <emphasis remap='I'>no</emphasis>.
+ <para>Default: <amkeyword>no</amkeyword>.
Whether an index (catalogue) of the backup should be generated and saved in
- <emphasis remap='B'>indexdir</emphasis>.
+ <amkeyword>indexdir</amkeyword>.
These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>kencrypt</emphasis> <emphasis remap='I'> boolean</emphasis></term>
+ <term><amkeyword>kencrypt</amkeyword> <amtype>boolean</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>no</emphasis>.
+ <amkeyword>no</amkeyword>.
Whether the backup image should be encrypted by Kerberos as it is sent
across the network from the backup client host to the tape server host.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>maxdumps</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <literal>1</literal>.
- The maximum number of backups from a single host that &A; will attempt to run in parallel.
- See also the main section parameter <emphasis remap='B'>inparallel</emphasis>.</para>
+ <amdefault>1</amdefault>.
+ The maximum number of backups from a single host that Amanda will attempt to run in parallel.
+ See also the main section parameter <amkeyword>inparallel</amkeyword>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>maxpromoteday</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>maxpromoteday</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <literal>10000</literal>.
+ <amdefault>10000</amdefault>.
The maximum number of day for a promotion, set it 0 if you don't want
promotion, set it to 1 or 2 if your disks get overpromoted.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>priority</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>priority</amkeyword> [ <amkeyword>low</amkeyword> | <amkeyword>medium</amkeyword> | <amkeyword>high</amkeyword> ]</term>
<listitem>
- <para>Default: <emphasis remap='I'>medium</emphasis>.
- When there is no tape to write to, &A; will do incremental backups
+ <para>Default: <amkeyword>medium</amkeyword>.
+ When there is no tape to write to, Amanda will do incremental backups
in priority order to the holding disk. The priority may be
high (2), medium (1), low (0) or a number of your choice.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>program</emphasis> [DUMP|GNUTAR|APPLICATION]</term>
+ <term><amkeyword>program</amkeyword> [ <amkeyword>"DUMP"</amkeyword> | <amkeyword>"GNUTAR"</amkeyword> | <amkeyword>"APPLICATION"</amkeyword> ]</term>
<listitem>
<para>Default:
- <emphasis remap='I'>DUMP</emphasis>.
+ <amdefault>"DUMP"</amdefault>.
The type of backup to perform. Valid values are:</para>
<!-- .RS -->
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>DUMP</emphasis></term>
+ <term><amkeyword>"DUMP"</amkeyword></term>
<listitem>
<para>The native operating system backup program.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>GNUTAR</emphasis></term>
+ <term><amkeyword>"GNUTAR"</amkeyword></term>
<listitem>
<para>To use GNU-tar or to do PC backups using Samba.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>APPLICATION</emphasis></term>
+ <term><amkeyword>"APPLICATION"</amkeyword></term>
<listitem>
- <para>To use an application-tool, see the <emphasis>application</emphasis> option.</para>
+ <para>To use an application, see the <emphasis>application</emphasis> option.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>application</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>application</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>No default. Must be the name of an application-tool if <emphasis>program</emphasis> is set to <emphasis remap='I'>APPLICATION</emphasis>. See APPLICATION SECTION below.</para>
+ <para>No default. Must be the name of an application if <emphasis>program</emphasis> is set to <emphasis remap='I'>APPLICATION</emphasis>. See APPLICATION SECTION below.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>script</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>script</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>No default. Must be the name of a script-tool. You can have many script. See SCRIPT SECTION below.</para>
+ <para>No default. Must be the name of a script. You can have many script. See SCRIPT SECTION below.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>property</emphasis> [append] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
+ <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
<listitem>
<para>These options can set various properties, they can be used by third
party software to store information in the configuration file.
Both strings are quoted; the first string contains the name of
the property to set, and the others contains its values.
- <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
+ <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>record</emphasis> <emphasis remap='I'> boolean</emphasis></term>
+ <term><amkeyword>record</amkeyword> <amtype>boolean</amtype></term>
<listitem>
<para>Default:
-<amkeyword>yes</amkeyword>.
-Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
+<emphasis remap='I'>yes</emphasis>.
+Whether to ask the backup program to update its database (e.g. <filename>/var/lib/dumpdates</filename>
for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
This is normally enabled for daily backups and turned off for periodic archival runs.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>skip-full</emphasis> <emphasis remap='I'> boolean</emphasis></term>
+ <term><amkeyword>skip-full</amkeyword> <amtype>boolean</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
+ <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
<emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
- full backups should be run off-line on these days. It was reported that &A; only schedules
+ full backups should be run off-line on these days. It was reported that Amanda only schedules
level 1 incrementals in this configuration; this is probably a bug.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>skip-incr</emphasis> <emphasis remap='I'> boolean</emphasis></term>
+ <term><amkeyword>skip-incr</amkeyword> <amtype>boolean</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
+ <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
<emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>ssh_keys</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>ssh_keys</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>No default</emphasis>.
+ <para>Default: not set.
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.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>starttime</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>starttime</amkeyword> <amtype>int</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
- Backups will not start until after this time of day.
+ <para>Default: not set.
+ Backup of these disks will not start until after this time of day.
The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
<literal>1830</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>strategy</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>strategy</amkeyword> [ <amkeyword>standard</amkeyword> | <amkeyword>nofull</amkeyword> | <amkeyword>noinc</amkeyword> | <amkeyword>skip</amkeyword> | <amkeyword>incronly</amkeyword> ]</term>
<listitem>
- <para>Default: <emphasis remap='I'>standard</emphasis>.
+ <para>Default: <amkeyword>standard</amkeyword>.
Strategy to use when planning what level of backup to run next. Values are:</para>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>standard</emphasis></term>
+ <term><amkeyword>standard</amkeyword></term>
<listitem>
- <para>The standard &A; schedule.</para>
+ <para>The standard Amanda schedule.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>nofull</emphasis></term>
+ <term><amkeyword>nofull</amkeyword></term>
<listitem>
<para>Never do full backups, only level 1 incrementals.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>noinc</emphasis></term>
+ <term><amkeyword>noinc</amkeyword></term>
<listitem>
<para>Never do incremental backups, only full dumps.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>skip</emphasis></term>
+ <term><amkeyword>skip</amkeyword></term>
<listitem>
- <para>Never do backups (useful when sharing the <emphasis remap='I'>disklist</emphasis> file).</para>
+ <para>Treat this DLE as if it doesn't exist (useful to disable DLEs
+ when sharing the <emphasis remap='I'>disklist</emphasis> file between
+ multiple configurations). Skipped DLEs will not be checked or
+ dumped, and will not be matched by disklist expressions.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>incronly</emphasis></term>
+ <term><amkeyword>incronly</amkeyword></term>
<listitem>
<para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
- &A; that a full dump has been performed off-line, so that it resets to level 1.</para>
+ Amanda that a full dump has been performed off-line, so that it resets to level 1.</para>
</listitem>
</varlistentry>
</variablelist>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>tape_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>tape_splitsize</amkeyword> <amtype>int</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
Split dump file on tape into pieces of a specified size.
This allows dumps to be spread across multiple tapes, and can potentially
make more efficient use of tape space.
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>split_diskbuffer</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>split_diskbuffer</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
When dumping a split dump in PORT-WRITE mode (usually meaning "no holding disk"), buffer the split chunks to a file in the directory specified by this option.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>fallback_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>fallback_splitsize</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>10M</emphasis>.
+ <amdefault>10M</amdefault>.
When dumping a split dump in PORT-WRITE mode, if no split_diskbuffer is
specified (or if we somehow fail to use our split_diskbuffer), we must
buffer split chunks in memory.
</varlistentry>
</variablelist>
- <para>The following <emphasis remap='B'>dumptype</emphasis> entries are predefined by &A;:</para>
+ <para>The following <amkeyword>dumptype</amkeyword> entries are predefined by Amanda:</para>
<programlisting remap='.nf'>
define dumptype "no-compress" {
define dumptype "bsd-auth" {
auth bsd
}
- define dumptype "krb4-auth" {
- auth krb4
- }
define dumptype "no-record" {
record no
}
</programlisting>
<para>In addition to options in a
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
section, one or more other
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
names may be supplied as identifiers, which make this
- <emphasis remap='B'>dumptype</emphasis>
+ <amkeyword>dumptype</amkeyword>
inherit options from other previously defined
- <emphasis remap='B'>dumptype</emphasis>s.
+ <amkeyword>dumptype</amkeyword>s.
For instance, two sections might be the same except for the
- <emphasis remap='B'>record</emphasis> option:</para>
+ <amkeyword>record</amkeyword> option:</para>
<programlisting remap='.nf'>
define dumptype "normal" {
}
</programlisting>
- <para>&A; provides a
- <emphasis remap='B'>dumptype</emphasis>
+ <para>Amanda provides a
+ <amkeyword>dumptype</amkeyword>
named
<emphasis remap='I'>global</emphasis>
in the sample
<emphasis remap='B'>amanda.conf</emphasis>
file that all
- <emphasis remap='B'>dumptype</emphasis>s
+ <amkeyword>dumptype</amkeyword>s
should reference.
This provides an easy place to make changes that will affect every
- <emphasis remap='B'>dumptype</emphasis>.</para>
+ <amkeyword>dumptype</amkeyword>, although you must be careful
+ that every dumptype explicitly inherits from the
+ <emphasis remap='I'>global</emphasis>
+ dumptype - Amanda does not do so automatically.</para>
</refsect1>
<refsect1><title>TAPETYPE SECTION</title>
<para>The <emphasis remap='B'>amanda.conf</emphasis>
file may define multiple types of tape media and devices.
The information is entered in a
- <emphasis remap='B'>tapetype</emphasis>
+ <amkeyword>tapetype</amkeyword>
section, which looks like this in the config file:</para>
<programlisting>
- define tapetype "<emphasis remap='I'>name</emphasis>" {
+ define tapetype "<amtype>name</amtype>" {
<emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
<literal>...</literal>
}
</programlisting>
+ <para>The { must appear at the end of a line, and the } on its own line.</para>
<para><emphasis remap='I'>Name</emphasis>
is the name of this type of tape medium/device.
It is referenced from the
- <emphasis remap='B'>tapetype</emphasis>
+ <amkeyword>tapetype</amkeyword>
option in the main part of the config file.</para>
<para>The tapetype options and values are:</para>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
A comment string describing this set of tape information.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>filemark</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>filemark</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>1 kbytes</emphasis>.
+ <amdefault>1 kbytes</amdefault>.
How large a file mark (tape mark) is, measured in kbytes.
If the size is only known in some linear measurement (e.g. inches),
convert it to kbytes using the device density.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>length</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>length</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>2000 kbytes</emphasis>. How much data will fit on a tape, expressed in kbytes.</para>
+ <amdefault>2000 kbytes</amdefault>. How much data will fit on a tape, expressed in kbytes.</para>
- <para>Note that this value is only used by &A; to schedule which backups will be run.
- Once the backups start, &A; will continue to write to a tape until it gets an error,
- regardless of what value is entered for <emphasis remap='B'>length</emphasis>
- (but see <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry> for exceptions).
+ <para>Note that this value is only used by Amanda to schedule which backups will be run.
+ Once the backups start, Amanda will continue to write to a tape until it gets an error,
+ regardless of what value is entered for <amkeyword>length</amkeyword>
+ (but see <manref name="amanda-devices" vol="7" /> for exceptions).
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>blocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>blocksize</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>32 kbytes</emphasis>.
+ <amdefault>32 kbytes</amdefault>.
How much data will be written in each tape record, expressed in kbytes. This is similar to the <emphasis remap="I">BLOCK_SIZE</emphasis> device property, but if the blocksize is not a multiple of 1024 bytes, then this parameter cannot be used to specify it, and the property must be used instead.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>readblocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>readblocksize</amkeyword> <amtype>int</amtype></term>
<listitem>
- <para>Default: <emphasis remap="I">32 kytes</emphasis>
+ <para>Default: <amdefault>32 kytes</amdefault>
How much data will be read in each tape record. This can be used to override a
device's block size for reads only. This may be useful, for example, in
reading a tape written with a 256k block size when Amanda is configured to use
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>speed</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>speed</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>200 bps</emphasis>.
+ <amdefault>200 bps</amdefault>.
How fast the drive will accept data, in bytes per second.
- This parameter is NOT currently used by &A;.</para>
+ This parameter is NOT currently used by Amanda.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>lbl-templ</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>lbl-templ</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>A PostScript template file used by
+ <para>Default: not set.
+ A PostScript template file used by
<emphasis remap='B'>amreport</emphasis>
- to generate labels. Several sample files are provided with the &A; sources in the
+ to generate labels. Several sample files are provided with the Amanda sources in the
<emphasis remap='I'>example</emphasis> directory.
See the
- <citerefentry><refentrytitle>amreport</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ <manref name="amreport" vol="8"/>
man page for more information.</para>
</listitem>
</varlistentry>
</variablelist>
<para>In addition to options, another
- <emphasis remap='B'>tapetype</emphasis>
+ <amkeyword>tapetype</amkeyword>
name may be supplie as an identifier, which makes this
- <emphasis remap='B'>tapetype</emphasis>
+ <amkeyword>tapetype</amkeyword>
inherit options from another
- <emphasis remap='B'>tapetype</emphasis>.
+ <amkeyword>tapetype</amkeyword>.
For instance, the only difference between a DLT4000 tape drive using
Compact-III tapes and one using Compact-IV tapes is the length of the tape.
So they could be entered as:</para>
<para>The
<emphasis remap='B'>amanda.conf</emphasis>
file may define multiple types of network interfaces.
- The information is entered in an <emphasis remap='B'>interface</emphasis>
+ The information is entered in an <amkeyword>interface</amkeyword>
section, which looks like this:</para>
<programlisting>
}
</programlisting>
+ <para>The { must appear at the end of a line, and the } on its own line.</para>
<para><emphasis remap='I'>name</emphasis>
is the name of this type of network interface. It is referenced from the
<emphasis remap='I'>disklist</emphasis> file.</para>
<para>Note that these sections define network interface characteristics,
not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
- actually be taken up by &A;.
- &A; computes the estimated bandwidth each file system backup will take
+ actually be taken up by Amanda.
+ Amanda computes the estimated bandwidth each file system backup will take
based on the estimated size and time, then compares that plus any other running
backups with the limit as another of the criteria when deciding whether
- to start the backup. Once a backup starts, &A; will use as much of the network as it can
+ to start the backup. Once a backup starts, Amanda will use as much of the network as it can
leaving throttling up to the operating system and network hardware.</para>
<para>The interface options and values are:</para>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
A comment string describing this set of network information.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
- <emphasis remap='I'>8000 Kbps</emphasis>.
+ <amdefault>8000 Kbps</amdefault>.
The speed of the interface in Kbytes per second.</para>
</listitem>
</varlistentry>
</variablelist>
<para>In addition to options, another
- <emphasis remap='B'>interface</emphasis>
+ <amkeyword>interface</amkeyword>
name may be supplied as an identifier, which makes this
- <emphasis remap='B'>interface</emphasis>
+ <amkeyword>interface</amkeyword>
inherit options from another
- <emphasis remap='B'>interface</emphasis>.
+ <amkeyword>interface</amkeyword>.
At the moment, this is of little use.</para>
</refsect1>
<para>The
<emphasis remap='B'>amanda.conf</emphasis>
file may define multiple types of application.
- The information is entered in a <emphasis remap='B'>application-tool</emphasis>
+ The information is entered in a <amkeyword>application</amkeyword>
section, which looks like this:</para>
<programlisting>
- define application-tool "<emphasis remap='I'>name</emphasis>" {
+ define application "<emphasis remap='I'>name</emphasis>" {
<emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>application-value</emphasis>
<literal>...</literal>
}
</programlisting>
+ <para>The { must appear at the end of a line, and the } on its own line.</para>
<para><emphasis remap='I'>name</emphasis>
is the name of this type of application. It is referenced from the
<emphasis remap='I'>dumptype</emphasis></para>
- <para>The application-tool options and values are:</para>
+ <para>The application options and values are:</para>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
+ <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
A comment string describing this application.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
+ <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory on the client.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
+ <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
<listitem>
<para>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.
- <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
- <emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the client.
+ <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
+ <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
</para>
</listitem>
</varlistentry>
<para>The
<emphasis remap='B'>amanda.conf</emphasis>
file may define multiple types of script.
- The information is entered in a <emphasis remap='B'>script-tool</emphasis>
+ The information is entered in a <amkeyword>script</amkeyword>
section, which looks like this:</para>
<programlisting>
- define script-tool "<emphasis remap='I'>name</emphasis>" {
+ define script "<emphasis remap='I'>name</emphasis>" {
<emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
<literal>...</literal>
}
</programlisting>
+ <para>The { must appear at the end of a line, and the } on its own line.</para>
<para><emphasis remap='I'>name</emphasis>
is the name of this type of script. It is referenced from the
<emphasis remap='I'>dumptype</emphasis></para>
- <para>The script-tool options and values are:</para>
+ <para>The script options and values are:</para>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
+ <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
<listitem>
- <para>Default:
- <emphasis remap='I'>none</emphasis>.
+ <para>Default: not set.
A comment string describing this script.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
+ <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory on the client and/or server.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>execute_where</emphasis> [client|server]</term>
+ <term><amkeyword>order</amkeyword> <amtype>int</amtype></term>
+ <listitem>
+ <para>Default: <amdefault>5000</amdefault>. Scripts are executed in that order, it is useful if you have many scripts and they must be executed in a spefific order.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>execute_where</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
<listitem>
- <para>Default: <emphasis remap='I'>client</emphasis>. Where the script must be executed, on the client or server.</para>
+ <para>Default: <amkeyword>client</amkeyword>. Where the script must be executed, on the client or server.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>execute_on</emphasis> <emphasis remap='I'>execute_on</emphasis>[,<emphasis remap='I'>execute_on</emphasis>]*</term>
+ <term><amkeyword>>execute_on</amkeyword> <amtype>execute_on</amtype> [,<amtype>execute_on</amtype>]*</term>
<listitem>
<para>No default. When the script must be executed, you can specify many of them:</para>
<!-- .RS -->
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>pre-dle-amcheck</emphasis></term>
+ <term><amkeyword>pre-dle-amcheck</amkeyword></term>
<listitem>
<para>Execute before the amcheck command for the dle.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>pre-host-amcheck</emphasis></term>
+ <term><amkeyword>pre-host-amcheck</amkeyword></term>
<listitem>
<para>Execute before the amcheck command for all dle for the client.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>post-dle-amcheck</emphasis></term>
+ <term><amkeyword>post-dle-amcheck</amkeyword></term>
<listitem>
<para>Execute after the amcheck command for the dle.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>post-host-amcheck</emphasis></term>
+ <term><amkeyword>post-host-amcheck</amkeyword></term>
<listitem>
<para>Execute after the amcheck command for all dle for the client.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>pre-dle-estimate</emphasis></term>
+ <term><amkeyword>pre-dle-estimate</amkeyword></term>
<listitem>
<para>Execute before the estimate command for the dle.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>pre-host-estimate</emphasis></term>
+ <term><amkeyword>pre-host-estimate</amkeyword></term>
<listitem>
<para>Execute before the estimate command for all dle for the client.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>post-dle-estimate</emphasis></term>
+ <term><amkeyword>post-dle-estimate</amkeyword></term>
<listitem>
<para>Execute after the estimate command for the dle.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>post-host-estimate</emphasis></term>
+ <term><amkeyword>post-host-estimate</amkeyword></term>
<listitem>
<para>Execute after the estimate command for all dle for the client.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>pre-dle-backup</emphasis></term>
+ <term><amkeyword>pre-dle-backup</amkeyword></term>
<listitem>
<para>Execute before the backup command for the dle.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>pre-host-backup</emphasis></term>
+ <term><amkeyword>pre-host-backup</amkeyword></term>
<listitem>
- <para>Execute before the backup command for all dle for the client.</para>
+ <para>Execute before the backup command for all dle for the client. It can't be run on client, it must be run on server</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>post-dle-backup</emphasis></term>
+ <term><amkeyword>post-dle-backup</amkeyword></term>
<listitem>
<para>Execute after the backup command for the dle.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>post-host-backup</emphasis></term>
+ <term><amkeyword>post-host-backup</amkeyword></term>
<listitem>
- <para>Execute after the backup command for all dle for the client.</para>
+ <para>Execute after the backup command for all dle for the client. It can't be run on client, it must be run on server</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>pre-recover</emphasis></term>
+ <term><amkeyword>pre-recover</amkeyword></term>
<listitem>
<para>Execute before any level is recovered.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>post-recover</emphasis></term>
+ <term><amkeyword>post-recover</amkeyword></term>
<listitem>
<para>Execute after all levels are recovered.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>pre-level-recover</emphasis></term>
+ <term><amkeyword>pre-level-recover</amkeyword></term>
<listitem>
<para>Execute before each level recovery.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>post-level-recover</emphasis></term>
+ <term><amkeyword>post-level-recover</amkeyword></term>
<listitem>
<para>Execute after each level recovery.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>inter-level-recover</emphasis></term>
+ <term><amkeyword>inter-level-recover</amkeyword></term>
<listitem>
<para>Execute between two levels of recovery.</para>
</listitem>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
+ <term><amkeyword>property</amkeyword>> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
<listitem>
<para>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.
- <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
- <emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the client.
+ <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
+ <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
</para>
</listitem>
</varlistentry>
}
</programlisting>
+ <para>The { must appear at the end of a line, and the } on its own line.</para>
<para><emphasis remap='I'>name</emphasis> is the user-specified name of
this device. It is referenced from the global <emphasis
remap='I'>tapedev</emphasis> parameter. The <emphasis
remap='I'>device-specifier</emphasis> specifies the device name to use;
- see <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
+ see <manref name="amanda-devices" vol="7"/>.
As with most sections, the <emphasis remap='I'>comment</emphasis>
parmeter is optional and only for the user's convenience.</para>
<para>An arbitrary number of <emphasis
remap='I'>device_property</emphasis> parameters can be specified.
Again, see
- <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+ <manref name="amanda-devices" vol="7"/>
for information on device properties.</para>
</refsect1>
<programlisting>
define changer <emphasis remap='I'>name</emphasis> {
comment "<emphasis remap='I'>comment (optional)</emphasis>"
- tapedev "<emphasis remap='I'>tape-device</emphasis>"
- tpchanger "<emphasis remap='I'>changer-type</emphasis>"
+ tpchanger "<emphasis remap='I'>changer-spec</emphasis>"
changerdev "<emphasis remap='I'>device-name</emphasis>"
changerfile "<emphasis remap='I'>state-file</emphasis>"
<literal>...</literal>
}
</programlisting>
+ <para>The { must appear at the end of a line, and the } on its own line.</para>
<para><emphasis remap='I'>name</emphasis> is the user-specified name of this
device. The remaining parameters are specific to the changer type selected.
</para>
+ <para>See <manref name="amanda-changers" vol="7" /> for more information on configuring changers.</para>
+
</refsect1>
- <refsect1><title>SEE ALSO</title>
- <para>
- <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <ulink url="http://wiki.zmanda.com"/>
- </para>
+ <seealso>
+ <manref name="amanda-client.conf" vol="5"/>,
+ <manref name="amanda-applications" vol="7"/>,
+ <manref name="amanda-auth" vol="7"/>,
+ <manref name="amanda-changers" vol="7"/>,
+ <manref name="amanda-devices" vol="7"/>,
+ <manref name="amanda-scripts" vol="7"/>
+ </seealso>
+
- </refsect1>
</refentry>
projects / debian / amanda / commitdiff