2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 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 two of the GNU General Public
10 License as published by the Free Software Foundation plus additions
11 that are listed in the file LICENSE.
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 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 John Walker.
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
36 /* NOTE: #includes at the end of this file */
39 * Resource codes -- they must be sequential for indexing
56 R_LAST = R_DEVICE /* keep this updated */
61 * Some resource attributes
72 /* Used for certain KeyWord tables */
78 /* Job Level keyword structure */
80 const char *level_name; /* level keyword */
81 int level; /* level */
82 int job_type; /* JobType permitting this level */
85 /* Job Type keyword structure */
87 const char *type_name;
91 /* Definition of the contents of each Resource */
92 /* Needed for forward references */
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 char *pid_directory; /* PidDirectory */
114 char *subsys_directory; /* SubsysDirectory */
115 MSGS *messages; /* Daemon message handler */
116 uint32_t MaxConcurrentJobs; /* Max concurrent jobs for whole director */
117 utime_t FDConnectTimeout; /* timeout for connect in seconds */
118 utime_t SDConnectTimeout; /* timeout in seconds */
119 utime_t heartbeat_interval; /* Interval to send heartbeats */
120 char *tls_ca_certfile; /* TLS CA Certificate File */
121 char *tls_ca_certdir; /* TLS CA Certificate Directory */
122 char *tls_certfile; /* TLS Server Certificate File */
123 char *tls_keyfile; /* TLS Server Key File */
124 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
125 alist *tls_allowed_cns; /* TLS Allowed Clients */
126 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
127 bool tls_enable; /* Enable TLS */
128 bool tls_require; /* Require TLS */
129 bool tls_verify_peer; /* TLS Verify Client Certificate */
135 inline char *DIRRES::name() const { return hdr.name; }
139 * This resource is a bit different from the other resources
140 * because it is not defined in the Director
141 * by DEVICE { ... }, but rather by a "reference" such as
142 * DEVICE = xxx; Then when the Director connects to the
143 * SD, it requests the information about the device.
149 bool found; /* found with SD */
150 int num_writers; /* number of writers */
151 int max_writers; /* = 1 for files */
152 int reserved; /* number of reserves */
153 int num_drives; /* for autochanger */
154 bool autochanger; /* set if device is autochanger */
155 bool open; /* drive open */
156 bool append; /* in append mode */
157 bool read; /* in read mode */
158 bool labeled; /* Volume name valid */
159 bool offline; /* not available */
160 bool autoselect; /* can be selected via autochanger */
162 char ChangerName[MAX_NAME_LENGTH];
163 char VolumeName[MAX_NAME_LENGTH];
164 char MediaType[MAX_NAME_LENGTH];
170 inline char *DEVICE::name() const { return hdr.name; }
173 * Console ACL positions
186 Num_ACL /* keep last */
195 char *password; /* UA server password */
196 alist *ACL_lists[Num_ACL]; /* pointers to ACLs */
197 char *tls_ca_certfile; /* TLS CA Certificate File */
198 char *tls_ca_certdir; /* TLS CA Certificate Directory */
199 char *tls_certfile; /* TLS Server Certificate File */
200 char *tls_keyfile; /* TLS Server Key File */
201 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
202 alist *tls_allowed_cns; /* TLS Allowed Clients */
203 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
204 bool tls_enable; /* Enable TLS */
205 bool tls_require; /* Require TLS */
206 bool tls_verify_peer; /* TLS Verify Client Certificate */
212 inline char *CONRES::name() const { return hdr.name; }
223 int db_port; /* Port */
224 char *db_address; /* host name for remote access */
225 char *db_socket; /* Socket for local access */
229 int mult_db_connections; /* set if multiple connections wanted */
235 inline char *CAT::name() const { return hdr.name; }
246 int FDport; /* Where File daemon listens */
247 utime_t FileRetention; /* file retention period in seconds */
248 utime_t JobRetention; /* job retention period in seconds */
249 utime_t heartbeat_interval; /* Interval to send heartbeats */
252 CAT *catalog; /* Catalog resource */
253 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
254 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
255 char *tls_ca_certfile; /* TLS CA Certificate File */
256 char *tls_ca_certdir; /* TLS CA Certificate Directory */
257 char *tls_certfile; /* TLS Client Certificate File */
258 char *tls_keyfile; /* TLS Client Key File */
259 alist *tls_allowed_cns; /* TLS Allowed Clients */
260 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
261 bool tls_enable; /* Enable TLS */
262 bool tls_require; /* Require TLS */
263 bool AutoPrune; /* Do automatic pruning? */
269 inline char *CLIENT::name() const { return hdr.name; }
280 int SDport; /* port where Directors connect */
281 int SDDport; /* data port for File daemon */
285 alist *device; /* Alternate devices for this Storage */
286 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
287 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
288 char *tls_ca_certfile; /* TLS CA Certificate File */
289 char *tls_ca_certdir; /* TLS CA Certificate Directory */
290 char *tls_certfile; /* TLS Client Certificate File */
291 char *tls_keyfile; /* TLS Client Key File */
292 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
293 bool tls_enable; /* Enable TLS */
294 bool tls_require; /* Require TLS */
295 bool enabled; /* Set if device is enabled */
296 bool autochanger; /* set if autochanger */
297 int64_t StorageId; /* Set from Storage DB record */
298 utime_t heartbeat_interval; /* Interval to send heartbeats */
299 int drives; /* number of drives in autochanger */
302 char *dev_name() const;
306 inline char *STORE::dev_name() const
308 DEVICE *dev = (DEVICE *)device->first();
309 return dev->hdr.name;
312 inline char *STORE::name() const { return hdr.name; }
315 * This is a sort of "unified" store that has both the
316 * storage pointer and the text of where the pointer was
322 POOLMEM *store_source;
325 USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
326 *store_source = 0; };
327 ~USTORE() { destroy(); }
328 void set_source(const char *where);
332 inline void USTORE::destroy()
335 free_pool_memory(store_source);
341 inline void USTORE::set_source(const char *where)
344 store_source = get_pool_memory(PM_MESSAGE);
346 pm_strcpy(store_source, where);
357 int JobType; /* job type (backup, verify, restore */
358 int JobLevel; /* default backup/verify level */
359 int Priority; /* Job priority */
360 int RestoreJobId; /* What -- JobId to restore */
361 char *RestoreWhere; /* Where on disk to restore -- directory */
362 char *strip_prefix; /* remove prefix from filename */
363 char *add_prefix; /* add prefix to filename */
364 char *add_suffix; /* add suffix to filename -- .old */
365 bool where_use_regexp; /* true if RestoreWhere is a BREGEXP */
366 char *RestoreBootstrap; /* Bootstrap file */
367 alist *RunScripts; /* Run {client} program {after|before} Job */
369 char *WriteBootstrap; /* Where to write bootstrap Job updates */
370 char *WriteVerifyList; /* List of changed files */
372 int replace; /* How (overwrite, ..) */
373 utime_t MaxRunTime; /* max run time in seconds */
374 utime_t MaxWaitTime; /* max blocking time in seconds */
375 utime_t FullMaxWaitTime; /* Max Full job wait time */
376 utime_t DiffMaxWaitTime; /* Max Differential job wait time */
377 utime_t IncMaxWaitTime; /* Max Incremental job wait time */
378 utime_t MaxStartDelay; /* max start delay in seconds */
379 utime_t RescheduleInterval; /* Reschedule interval */
380 utime_t JobRetention; /* job retention period in seconds */
381 uint32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
382 int RescheduleTimes; /* Number of times to reschedule job */
383 bool RescheduleOnError; /* Set to reschedule on error */
384 bool PrefixLinks; /* prefix soft links with Where path */
385 bool PruneJobs; /* Force pruning of Jobs */
386 bool PruneFiles; /* Force pruning of Files */
387 bool PruneVolumes; /* Force pruning of Volumes */
388 bool SpoolAttributes; /* Set to spool attributes in SD */
389 bool spool_data; /* Set to spool data in SD */
390 bool rerun_failed_levels; /* Upgrade to rerun failed levels */
391 bool PreferMountedVolumes; /* Prefer vols mounted rather than new one */
392 bool write_part_after_job; /* Set to write part after job in SD */
393 bool enabled; /* Set if job enabled */
395 MSGS *messages; /* How and where to send messages */
396 SCHED *schedule; /* When -- Automatic schedule */
397 CLIENT *client; /* Who to backup */
398 FILESET *fileset; /* What to backup -- Fileset */
399 alist *storage; /* Where is device -- list of Storage to be used */
400 POOL *pool; /* Where is media -- Media Pool */
401 POOL *full_pool; /* Pool for Full backups */
402 POOL *inc_pool; /* Pool for Incremental backups */
403 POOL *diff_pool; /* Pool for Differental backups */
404 char *selection_pattern;
407 JOB *verify_job; /* Job name to verify */
409 JOB *jobdefs; /* Job defaults */
410 alist *run_cmds; /* Run commands */
411 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
417 inline char *JOB::name() const { return hdr.name; }
422 /* File options structure */
424 char opts[MAX_FOPTS]; /* options string */
425 alist regex; /* regex string(s) */
426 alist regexdir; /* regex string(s) for directories */
427 alist regexfile; /* regex string(s) for files */
428 alist wild; /* wild card strings */
429 alist wilddir; /* wild card strings for directories */
430 alist wildfile; /* wild card strings for files */
431 alist wildbase; /* wild card strings for files without '/' */
432 alist base; /* list of base names */
433 alist fstype; /* file system type limitation */
434 alist drivetype; /* drive type limitation */
435 char *reader; /* reader program */
436 char *writer; /* writer program */
440 /* This is either an include item or an exclude item */
442 FOPTS *current_opts; /* points to current options structure */
443 FOPTS **opts_list; /* options list */
444 int num_opts; /* number of options items */
445 alist name_list; /* filename list -- holds char * */
456 bool new_include; /* Set if new include used */
457 INCEXE **include_items; /* array of incexe structures */
458 int num_includes; /* number in array */
459 INCEXE **exclude_items;
461 bool have_MD5; /* set if MD5 initialized */
462 struct MD5Context md5c; /* MD5 of include/exclude */
463 char MD5[30]; /* base 64 representation of MD5 */
464 bool ignore_fs_changes; /* Don't force Full if FS changed */
465 bool enable_vss; /* Enable Volume Shadow Copy */
471 inline char *FILESET::name() const { return hdr.name; }
491 int32_t MinValue; /* Minimum value */
492 int32_t MaxValue; /* Maximum value */
493 int32_t CurrentValue; /* Current value */
494 COUNTER *WrapCounter; /* Wrap counter name */
495 CAT *Catalog; /* Where to store */
496 bool created; /* Created in DB */
501 inline char *COUNTER::name() const { return hdr.name; }
511 char *pool_type; /* Pool type */
512 char *label_format; /* Label format string */
513 char *cleaning_prefix; /* Cleaning label prefix */
514 int32_t LabelType; /* Bacula/ANSI/IBM label type */
515 uint32_t max_volumes; /* max number of volumes */
516 utime_t VolRetention; /* volume retention period in seconds */
517 utime_t VolUseDuration; /* duration volume can be used */
518 uint32_t MaxVolJobs; /* Maximum jobs on the Volume */
519 uint32_t MaxVolFiles; /* Maximum files on the Volume */
520 uint64_t MaxVolBytes; /* Maximum bytes on the Volume */
521 utime_t MigrationTime; /* Time to migrate to next pool */
522 uint64_t MigrationHighBytes; /* When migration starts */
523 uint64_t MigrationLowBytes; /* When migration stops */
524 POOL *NextPool; /* Next pool for migration */
525 alist *storage; /* Where is device -- list of Storage to be used */
526 bool use_catalog; /* maintain catalog for media */
527 bool catalog_files; /* maintain file entries in catalog */
528 bool use_volume_once; /* write on volume only once */
529 bool purge_oldest_volume; /* purge oldest volume */
530 bool recycle_oldest_volume; /* attempt to recycle oldest volume */
531 bool recycle_current_volume; /* attempt recycle of current volume */
532 bool AutoPrune; /* default for pool auto prune */
533 bool Recycle; /* default for media recycle yes/no */
534 POOL *RecyclePool; /* RecyclePool destination when media is purged */
539 inline char *POOL::name() const { return hdr.name; }
544 /* Define the Union of all the above
545 * resource structure definitions.
561 RUNSCRIPT res_runscript;
566 /* Run structure contained in Schedule Resource */
569 RUN *next; /* points to next run record */
570 int level; /* level override */
571 int Priority; /* priority override */
573 bool spool_data; /* Data spooling override */
574 bool spool_data_set; /* Data spooling override given */
575 bool write_part_after_job; /* Write part after job override */
576 bool write_part_after_job_set; /* Write part after job override given */
578 POOL *pool; /* Pool override */
579 POOL *full_pool; /* Pool override */
580 POOL *inc_pool; /* Pool override */
581 POOL *diff_pool; /* Pool override */
582 STORE *storage; /* Storage override */
583 MSGS *msgs; /* Messages override */
586 int minute; /* minute to run job */
587 time_t last_run; /* last time run */
588 time_t next_run; /* next time to run */
589 char hour[nbytes_for_bits(24)]; /* bit set for each hour */
590 char mday[nbytes_for_bits(31)]; /* bit set for each day of month */
591 char month[nbytes_for_bits(12)]; /* bit set for each month */
592 char wday[nbytes_for_bits(7)]; /* bit set for each day of the week */
593 char wom[nbytes_for_bits(5)]; /* week of month */
594 char woy[nbytes_for_bits(54)]; /* week of year */