2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version three of the GNU Affero General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU Affero General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Director specific configuration and defines
31 * Kern Sibbald, Feb MM
35 /* NOTE: #includes at the end of this file */
38 * Resource codes -- they must be sequential for indexing
55 R_LAST = R_DEVICE /* keep this updated */
60 * Some resource attributes
71 /* Used for certain KeyWord tables */
77 /* Job Level keyword structure */
79 const char *level_name; /* level keyword */
80 int32_t level; /* level */
81 int32_t job_type; /* JobType permitting this level */
84 /* Job Type keyword structure */
86 const char *type_name;
90 /* Definition of the contents of each Resource */
91 /* Needed for forward references */
108 dlist *DIRsrc_addr; /* address to source connections from */
109 char *password; /* Password for UA access */
110 char *query_file; /* SQL query file */
111 char *working_directory; /* WorkingDirectory */
112 const char *scripts_directory; /* ScriptsDirectory */
113 const char *plugin_directory; /* Plugin Directory */
114 char *pid_directory; /* PidDirectory */
115 char *subsys_directory; /* SubsysDirectory */
116 MSGS *messages; /* Daemon message handler */
117 uint32_t MaxConcurrentJobs; /* Max concurrent jobs for whole director */
118 uint32_t MaxConsoleConnect; /* Max concurrent console session */
119 utime_t FDConnectTimeout; /* timeout for connect in seconds */
120 utime_t SDConnectTimeout; /* timeout in seconds */
121 utime_t heartbeat_interval; /* Interval to send heartbeats */
122 char *tls_ca_certfile; /* TLS CA Certificate File */
123 char *tls_ca_certdir; /* TLS CA Certificate Directory */
124 char *tls_certfile; /* TLS Server Certificate File */
125 char *tls_keyfile; /* TLS Server Key File */
126 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
127 alist *tls_allowed_cns; /* TLS Allowed Clients */
128 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
129 utime_t stats_retention; /* Stats retention period in seconds */
130 bool tls_authenticate; /* Authenticated with TLS */
131 bool tls_enable; /* Enable TLS */
132 bool tls_require; /* Require TLS */
133 bool tls_verify_peer; /* TLS Verify Client Certificate */
134 char *verid; /* Custom Id to print in version command */
139 inline char *DIRRES::name() const { return hdr.name; }
143 * This resource is a bit different from the other resources
144 * because it is not defined in the Director
145 * by DEVICE { ... }, but rather by a "reference" such as
146 * DEVICE = xxx; Then when the Director connects to the
147 * SD, it requests the information about the device.
153 bool found; /* found with SD */
154 int32_t num_writers; /* number of writers */
155 int32_t max_writers; /* = 1 for files */
156 int32_t reserved; /* number of reserves */
157 int32_t num_drives; /* for autochanger */
158 bool autochanger; /* set if device is autochanger */
159 bool open; /* drive open */
160 bool append; /* in append mode */
161 bool read; /* in read mode */
162 bool labeled; /* Volume name valid */
163 bool offline; /* not available */
164 bool autoselect; /* can be selected via autochanger */
166 char ChangerName[MAX_NAME_LENGTH];
167 char VolumeName[MAX_NAME_LENGTH];
168 char MediaType[MAX_NAME_LENGTH];
174 inline char *DEVICE::name() const { return hdr.name; }
177 * Console ACL positions
191 Num_ACL /* keep last */
200 char *password; /* UA server password */
201 alist *ACL_lists[Num_ACL]; /* pointers to ACLs */
202 char *tls_ca_certfile; /* TLS CA Certificate File */
203 char *tls_ca_certdir; /* TLS CA Certificate Directory */
204 char *tls_certfile; /* TLS Server Certificate File */
205 char *tls_keyfile; /* TLS Server Key File */
206 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
207 alist *tls_allowed_cns; /* TLS Allowed Clients */
208 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
209 bool tls_authenticate; /* Authenticated with TLS */
210 bool tls_enable; /* Enable TLS */
211 bool tls_require; /* Require TLS */
212 bool tls_verify_peer; /* TLS Verify Client Certificate */
218 inline char *CONRES::name() const { return hdr.name; }
229 uint32_t db_port; /* Port */
230 char *db_address; /* host name for remote access */
231 char *db_socket; /* Socket for local access */
235 char *db_driver; /* Select appropriate driver */
236 uint32_t mult_db_connections; /* set if multiple connections wanted */
240 char *display(POOLMEM *dst); /* Get catalog information */
243 inline char *CAT::name() const { return hdr.name; }
254 uint32_t FDport; /* Where File daemon listens */
255 utime_t FileRetention; /* file retention period in seconds */
256 utime_t JobRetention; /* job retention period in seconds */
257 utime_t heartbeat_interval; /* Interval to send heartbeats */
260 CAT *catalog; /* Catalog resource */
261 int32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
262 int32_t NumConcurrentJobs; /* number of concurrent jobs running */
263 char *tls_ca_certfile; /* TLS CA Certificate File */
264 char *tls_ca_certdir; /* TLS CA Certificate Directory */
265 char *tls_certfile; /* TLS Client Certificate File */
266 char *tls_keyfile; /* TLS Client Key File */
267 alist *tls_allowed_cns; /* TLS Allowed Clients */
268 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
269 bool tls_authenticate; /* Authenticated with TLS */
270 bool tls_enable; /* Enable TLS */
271 bool tls_require; /* Require TLS */
272 bool AutoPrune; /* Do automatic pruning? */
273 int64_t max_bandwidth; /* Limit speed on this client */
279 inline char *CLIENT::name() const { return hdr.name; }
290 uint32_t SDport; /* port where Directors connect */
291 uint32_t SDDport; /* data port for File daemon */
295 alist *device; /* Alternate devices for this Storage */
296 int32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
297 int32_t NumConcurrentJobs; /* number of concurrent jobs running */
298 int32_t NumConcurrentReadJobs; /* number of jobs reading */
299 char *tls_ca_certfile; /* TLS CA Certificate File */
300 char *tls_ca_certdir; /* TLS CA Certificate Directory */
301 char *tls_certfile; /* TLS Client Certificate File */
302 char *tls_keyfile; /* TLS Client Key File */
303 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
304 bool tls_authenticate; /* Authenticated with TLS */
305 bool tls_enable; /* Enable TLS */
306 bool tls_require; /* Require TLS */
307 bool enabled; /* Set if device is enabled */
308 bool autochanger; /* set if autochanger */
309 bool AllowCompress; /* set if this Storage should allow jobs to enable compression */
310 int64_t StorageId; /* Set from Storage DB record */
311 utime_t heartbeat_interval; /* Interval to send heartbeats */
312 uint32_t drives; /* number of drives in autochanger */
315 char *dev_name() const;
319 inline char *STORE::dev_name() const
321 DEVICE *dev = (DEVICE *)device->first();
322 return dev->hdr.name;
325 inline char *STORE::name() const { return hdr.name; }
328 * This is a sort of "unified" store that has both the
329 * storage pointer and the text of where the pointer was
335 POOLMEM *store_source;
338 USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
339 *store_source = 0; };
340 ~USTORE() { destroy(); }
341 void set_source(const char *where);
345 inline void USTORE::destroy()
348 free_pool_memory(store_source);
354 inline void USTORE::set_source(const char *where)
357 store_source = get_pool_memory(PM_MESSAGE);
359 pm_strcpy(store_source, where);
370 uint32_t JobType; /* job type (backup, verify, restore */
371 uint32_t JobLevel; /* default backup/verify level */
372 int32_t Priority; /* Job priority */
373 uint32_t RestoreJobId; /* What -- JobId to restore */
374 int32_t RescheduleTimes; /* Number of times to reschedule job */
375 uint32_t replace; /* How (overwrite, ..) */
376 uint32_t selection_type;
378 char *RestoreWhere; /* Where on disk to restore -- directory */
379 char *RegexWhere; /* RegexWhere option */
380 char *strip_prefix; /* remove prefix from filename */
381 char *add_prefix; /* add prefix to filename */
382 char *add_suffix; /* add suffix to filename -- .old */
383 char *RestoreBootstrap; /* Bootstrap file */
384 char *PluginOptions; /* Options to pass to plugin */
386 char *WriteBootstrap; /* Where to write bootstrap Job updates */
387 char *WriteVerifyList; /* List of changed files */
389 utime_t MaxRunTime; /* max run time in seconds */
390 utime_t MaxWaitTime; /* max blocking time in seconds */
391 utime_t FullMaxRunTime; /* Max Full job run time */
392 utime_t DiffMaxRunTime; /* Max Differential job run time */
393 utime_t IncMaxRunTime; /* Max Incremental job run time */
394 utime_t MaxStartDelay; /* max start delay in seconds */
395 utime_t MaxRunSchedTime; /* max run time in seconds from Scheduled time*/
396 utime_t RescheduleInterval; /* Reschedule interval */
397 utime_t MaxFullInterval; /* Maximum time interval between Fulls */
398 utime_t MaxDiffInterval; /* Maximum time interval between Diffs */
399 utime_t DuplicateJobProximity; /* Permitted time between duplicicates */
400 int64_t spool_size; /* Size of spool file for this job */
401 int32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
402 int32_t NumConcurrentJobs; /* number of concurrent jobs running */
403 bool allow_mixed_priority; /* Allow jobs with higher priority concurrently with this */
405 MSGS *messages; /* How and where to send messages */
406 SCHED *schedule; /* When -- Automatic schedule */
407 CLIENT *client; /* Who to backup */
408 FILESET *fileset; /* What to backup -- Fileset */
409 alist *storage; /* Where is device -- list of Storage to be used */
410 POOL *pool; /* Where is media -- Media Pool */
411 POOL *full_pool; /* Pool for Full backups */
412 POOL *inc_pool; /* Pool for Incremental backups */
413 POOL *diff_pool; /* Pool for Differental backups */
414 char *selection_pattern;
416 JOB *verify_job; /* Job name to verify */
418 JOB *jobdefs; /* Job defaults */
419 alist *run_cmds; /* Run commands */
420 alist *RunScripts; /* Run {client} program {after|before} Job */
422 bool where_use_regexp; /* true if RestoreWhere is a BREGEXP */
423 bool RescheduleOnError; /* Set to reschedule on error */
424 bool PrefixLinks; /* prefix soft links with Where path */
425 bool PruneJobs; /* Force pruning of Jobs */
426 bool PruneFiles; /* Force pruning of Files */
427 bool PruneVolumes; /* Force pruning of Volumes */
428 bool SpoolAttributes; /* Set to spool attributes in SD */
429 bool spool_data; /* Set to spool data in SD */
430 bool rerun_failed_levels; /* Upgrade to rerun failed levels */
431 bool PreferMountedVolumes; /* Prefer vols mounted rather than new one */
432 bool write_part_after_job; /* Set to write part after job in SD */
433 bool enabled; /* Set if job enabled */
434 bool accurate; /* Set if it is an accurate backup job */
435 bool AllowDuplicateJobs; /* Allow duplicate jobs */
436 bool AllowHigherDuplicates; /* Permit Higher Level */
437 bool CancelLowerLevelDuplicates; /* Cancel lower level backup jobs */
438 bool CancelQueuedDuplicates; /* Cancel queued jobs */
439 bool CancelRunningDuplicates; /* Cancel Running jobs */
440 alist *base; /* Base jobs */
441 int64_t max_bandwidth; /* Speed limit on this job */
447 inline char *JOB::name() const { return hdr.name; }
452 /* File options structure */
454 char opts[MAX_FOPTS]; /* options string */
455 alist regex; /* regex string(s) */
456 alist regexdir; /* regex string(s) for directories */
457 alist regexfile; /* regex string(s) for files */
458 alist wild; /* wild card strings */
459 alist wilddir; /* wild card strings for directories */
460 alist wildfile; /* wild card strings for files */
461 alist wildbase; /* wild card strings for files without '/' */
462 alist base; /* list of base names */
463 alist fstype; /* file system type limitation */
464 alist drivetype; /* drive type limitation */
465 char *reader; /* reader program */
466 char *writer; /* writer program */
467 char *plugin; /* plugin program */
471 /* This is either an include item or an exclude item */
473 FOPTS *current_opts; /* points to current options structure */
474 FOPTS **opts_list; /* options list */
475 int32_t num_opts; /* number of options items */
476 alist name_list; /* filename list -- holds char * */
477 alist plugin_list; /* filename list for plugins */
478 char *ignoredir; /* ignoredir string */
489 bool new_include; /* Set if new include used */
490 INCEXE **include_items; /* array of incexe structures */
491 int32_t num_includes; /* number in array */
492 INCEXE **exclude_items;
493 int32_t num_excludes;
494 bool have_MD5; /* set if MD5 initialized */
495 struct MD5Context md5c; /* MD5 of include/exclude */
496 char MD5[30]; /* base 64 representation of MD5 */
497 bool ignore_fs_changes; /* Don't force Full if FS changed */
498 bool enable_vss; /* Enable Volume Shadow Copy */
504 inline char *FILESET::name() const { return hdr.name; }
524 int32_t MinValue; /* Minimum value */
525 int32_t MaxValue; /* Maximum value */
526 int32_t CurrentValue; /* Current value */
527 COUNTER *WrapCounter; /* Wrap counter name */
528 CAT *Catalog; /* Where to store */
529 bool created; /* Created in DB */
534 inline char *COUNTER::name() const { return hdr.name; }
544 char *pool_type; /* Pool type */
545 char *label_format; /* Label format string */
546 char *cleaning_prefix; /* Cleaning label prefix */
547 int32_t LabelType; /* Bacula/ANSI/IBM label type */
548 uint32_t max_volumes; /* max number of volumes */
549 utime_t VolRetention; /* volume retention period in seconds */
550 utime_t VolUseDuration; /* duration volume can be used */
551 uint32_t MaxVolJobs; /* Maximum jobs on the Volume */
552 uint32_t MaxVolFiles; /* Maximum files on the Volume */
553 uint64_t MaxVolBytes; /* Maximum bytes on the Volume */
554 utime_t MigrationTime; /* Time to migrate to next pool */
555 uint64_t MigrationHighBytes; /* When migration starts */
556 uint64_t MigrationLowBytes; /* When migration stops */
557 POOL *NextPool; /* Next pool for migration */
558 alist *storage; /* Where is device -- list of Storage to be used */
559 bool use_catalog; /* maintain catalog for media */
560 bool catalog_files; /* maintain file entries in catalog */
561 bool use_volume_once; /* write on volume only once */
562 bool purge_oldest_volume; /* purge oldest volume */
563 bool recycle_oldest_volume; /* attempt to recycle oldest volume */
564 bool recycle_current_volume; /* attempt recycle of current volume */
565 bool AutoPrune; /* default for pool auto prune */
566 bool Recycle; /* default for media recycle yes/no */
567 uint32_t action_on_purge; /* action on purge, e.g. truncate the disk volume */
568 POOL *RecyclePool; /* RecyclePool destination when media is purged */
569 POOL *ScratchPool; /* ScratchPool source when requesting media */
570 alist *CopyPool; /* List of copy pools */
571 CAT *catalog; /* Catalog to be used */
572 utime_t FileRetention; /* file retention period in seconds */
573 utime_t JobRetention; /* job retention period in seconds */
579 inline char *POOL::name() const { return hdr.name; }
584 /* Define the Union of all the above
585 * resource structure definitions.
601 RUNSCRIPT res_runscript;
606 /* Run structure contained in Schedule Resource */
609 RUN *next; /* points to next run record */
610 uint32_t level; /* level override */
611 int32_t Priority; /* priority override */
613 bool spool_data; /* Data spooling override */
614 bool spool_data_set; /* Data spooling override given */
615 bool write_part_after_job; /* Write part after job override */
616 bool write_part_after_job_set; /* Write part after job override given */
618 POOL *pool; /* Pool override */
619 POOL *full_pool; /* Pool override */
620 POOL *inc_pool; /* Pool override */
621 POOL *diff_pool; /* Pool override */
622 STORE *storage; /* Storage override */
623 MSGS *msgs; /* Messages override */
626 uint32_t minute; /* minute to run job */
627 time_t last_run; /* last time run */
628 time_t next_run; /* next time to run */
629 char hour[nbytes_for_bits(24)]; /* bit set for each hour */
630 char mday[nbytes_for_bits(31)]; /* bit set for each day of month */
631 char month[nbytes_for_bits(12)]; /* bit set for each month */
632 char wday[nbytes_for_bits(7)]; /* bit set for each day of the week */
633 char wom[nbytes_for_bits(5)]; /* week of month */
634 char woy[nbytes_for_bits(54)]; /* week of year */
637 #define GetPoolResWithName(x) ((POOL *)GetResWithName(R_POOL, (x)))
638 #define GetStoreResWithName(x) ((STORE *)GetResWithName(R_STORAGE, (x)))
639 #define GetClientResWithName(x) ((CLIENT *)GetResWithName(R_CLIENT, (x)))
640 #define GetJobResWithName(x) ((JOB *)GetResWithName(R_JOB, (x)))
641 #define GetFileSetResWithName(x) ((FILESET *)GetResWithName(R_FILESET, (x)))
642 #define GetCatalogResWithName(x) ((CAT *)GetResWithName(R_CATALOG, (x)))