2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 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 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 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 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 utime_t FDConnectTimeout; /* timeout for connect in seconds */
119 utime_t SDConnectTimeout; /* timeout in seconds */
120 utime_t heartbeat_interval; /* Interval to send heartbeats */
121 char *tls_ca_certfile; /* TLS CA Certificate File */
122 char *tls_ca_certdir; /* TLS CA Certificate Directory */
123 char *tls_certfile; /* TLS Server Certificate File */
124 char *tls_keyfile; /* TLS Server Key File */
125 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
126 alist *tls_allowed_cns; /* TLS Allowed Clients */
127 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
128 bool tls_authenticate; /* Authenticated with TLS */
129 bool tls_enable; /* Enable TLS */
130 bool tls_require; /* Require TLS */
131 bool tls_verify_peer; /* TLS Verify Client Certificate */
137 inline char *DIRRES::name() const { return hdr.name; }
141 * This resource is a bit different from the other resources
142 * because it is not defined in the Director
143 * by DEVICE { ... }, but rather by a "reference" such as
144 * DEVICE = xxx; Then when the Director connects to the
145 * SD, it requests the information about the device.
151 bool found; /* found with SD */
152 int num_writers; /* number of writers */
153 int max_writers; /* = 1 for files */
154 int reserved; /* number of reserves */
155 int num_drives; /* for autochanger */
156 bool autochanger; /* set if device is autochanger */
157 bool open; /* drive open */
158 bool append; /* in append mode */
159 bool read; /* in read mode */
160 bool labeled; /* Volume name valid */
161 bool offline; /* not available */
162 bool autoselect; /* can be selected via autochanger */
164 char ChangerName[MAX_NAME_LENGTH];
165 char VolumeName[MAX_NAME_LENGTH];
166 char MediaType[MAX_NAME_LENGTH];
172 inline char *DEVICE::name() const { return hdr.name; }
175 * Console ACL positions
189 Num_ACL /* keep last */
198 char *password; /* UA server password */
199 alist *ACL_lists[Num_ACL]; /* pointers to ACLs */
200 char *tls_ca_certfile; /* TLS CA Certificate File */
201 char *tls_ca_certdir; /* TLS CA Certificate Directory */
202 char *tls_certfile; /* TLS Server Certificate File */
203 char *tls_keyfile; /* TLS Server Key File */
204 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
205 alist *tls_allowed_cns; /* TLS Allowed Clients */
206 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
207 bool tls_authenticate; /* Authenticated with TLS */
208 bool tls_enable; /* Enable TLS */
209 bool tls_require; /* Require TLS */
210 bool tls_verify_peer; /* TLS Verify Client Certificate */
216 inline char *CONRES::name() const { return hdr.name; }
227 int db_port; /* Port */
228 char *db_address; /* host name for remote access */
229 char *db_socket; /* Socket for local access */
233 char *db_driver; /* Select appropriate driver */
234 int mult_db_connections; /* set if multiple connections wanted */
240 inline char *CAT::name() const { return hdr.name; }
251 int FDport; /* Where File daemon listens */
252 utime_t FileRetention; /* file retention period in seconds */
253 utime_t JobRetention; /* job retention period in seconds */
254 utime_t heartbeat_interval; /* Interval to send heartbeats */
257 CAT *catalog; /* Catalog resource */
258 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
259 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
260 char *tls_ca_certfile; /* TLS CA Certificate File */
261 char *tls_ca_certdir; /* TLS CA Certificate Directory */
262 char *tls_certfile; /* TLS Client Certificate File */
263 char *tls_keyfile; /* TLS Client Key File */
264 alist *tls_allowed_cns; /* TLS Allowed Clients */
265 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
266 bool tls_authenticate; /* Authenticated with TLS */
267 bool tls_enable; /* Enable TLS */
268 bool tls_require; /* Require TLS */
269 bool AutoPrune; /* Do automatic pruning? */
275 inline char *CLIENT::name() const { return hdr.name; }
286 int SDport; /* port where Directors connect */
287 int SDDport; /* data port for File daemon */
291 alist *device; /* Alternate devices for this Storage */
292 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
293 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
294 uint32_t NumConcurrentReadJobs; /* number of jobs reading */
295 char *tls_ca_certfile; /* TLS CA Certificate File */
296 char *tls_ca_certdir; /* TLS CA Certificate Directory */
297 char *tls_certfile; /* TLS Client Certificate File */
298 char *tls_keyfile; /* TLS Client Key File */
299 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
300 bool tls_authenticate; /* Authenticated with TLS */
301 bool tls_enable; /* Enable TLS */
302 bool tls_require; /* Require TLS */
303 bool enabled; /* Set if device is enabled */
304 bool autochanger; /* set if autochanger */
305 int64_t StorageId; /* Set from Storage DB record */
306 utime_t heartbeat_interval; /* Interval to send heartbeats */
307 int drives; /* number of drives in autochanger */
310 char *dev_name() const;
314 inline char *STORE::dev_name() const
316 DEVICE *dev = (DEVICE *)device->first();
317 return dev->hdr.name;
320 inline char *STORE::name() const { return hdr.name; }
323 * This is a sort of "unified" store that has both the
324 * storage pointer and the text of where the pointer was
330 POOLMEM *store_source;
333 USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
334 *store_source = 0; };
335 ~USTORE() { destroy(); }
336 void set_source(const char *where);
340 inline void USTORE::destroy()
343 free_pool_memory(store_source);
349 inline void USTORE::set_source(const char *where)
352 store_source = get_pool_memory(PM_MESSAGE);
354 pm_strcpy(store_source, where);
365 int JobType; /* job type (backup, verify, restore */
366 int JobLevel; /* default backup/verify level */
367 int Priority; /* Job priority */
368 int RestoreJobId; /* What -- JobId to restore */
369 int RescheduleTimes; /* Number of times to reschedule job */
370 int replace; /* How (overwrite, ..) */
373 char *RestoreWhere; /* Where on disk to restore -- directory */
374 char *RegexWhere; /* RegexWhere option */
375 char *strip_prefix; /* remove prefix from filename */
376 char *add_prefix; /* add prefix to filename */
377 char *add_suffix; /* add suffix to filename -- .old */
378 char *RestoreBootstrap; /* Bootstrap file */
379 char *PluginOptions; /* Options to pass to plugin */
381 char *WriteBootstrap; /* Where to write bootstrap Job updates */
382 char *WriteVerifyList; /* List of changed files */
384 utime_t MaxRunTime; /* max run time in seconds */
385 utime_t MaxWaitTime; /* max blocking time in seconds */
386 utime_t FullMaxWaitTime; /* Max Full job wait time */
387 utime_t DiffMaxWaitTime; /* Max Differential job wait time */
388 utime_t IncMaxWaitTime; /* Max Incremental job wait time */
389 utime_t MaxStartDelay; /* max start delay in seconds */
390 utime_t RescheduleInterval; /* Reschedule interval */
391 utime_t JobRetention; /* job retention period in seconds */
392 utime_t MaxFullInterval; /* Maximum time interval between Fulls */
393 utime_t MaxDiffInterval; /* Maximum time interval between Diffs */
394 utime_t DuplicateJobProximity; /* Permitted time between duplicicates */
395 int64_t spool_size; /* Size of spool file for this job */
396 uint32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
397 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
399 MSGS *messages; /* How and where to send messages */
400 SCHED *schedule; /* When -- Automatic schedule */
401 CLIENT *client; /* Who to backup */
402 FILESET *fileset; /* What to backup -- Fileset */
403 alist *storage; /* Where is device -- list of Storage to be used */
404 POOL *pool; /* Where is media -- Media Pool */
405 POOL *full_pool; /* Pool for Full backups */
406 POOL *inc_pool; /* Pool for Incremental backups */
407 POOL *diff_pool; /* Pool for Differental backups */
408 char *selection_pattern;
410 JOB *verify_job; /* Job name to verify */
412 JOB *jobdefs; /* Job defaults */
413 alist *run_cmds; /* Run commands */
414 alist *RunScripts; /* Run {client} program {after|before} Job */
416 bool where_use_regexp; /* true if RestoreWhere is a BREGEXP */
417 bool RescheduleOnError; /* Set to reschedule on error */
418 bool PrefixLinks; /* prefix soft links with Where path */
419 bool PruneJobs; /* Force pruning of Jobs */
420 bool PruneFiles; /* Force pruning of Files */
421 bool PruneVolumes; /* Force pruning of Volumes */
422 bool SpoolAttributes; /* Set to spool attributes in SD */
423 bool spool_data; /* Set to spool data in SD */
424 bool rerun_failed_levels; /* Upgrade to rerun failed levels */
425 bool PreferMountedVolumes; /* Prefer vols mounted rather than new one */
426 bool write_part_after_job; /* Set to write part after job in SD */
427 bool enabled; /* Set if job enabled */
428 bool OptimizeJobScheduling; /* Set if we should optimize Job scheduling */
429 bool accurate; /* Set if it is an accurate backup job */
430 bool AllowDuplicateJobs; /* Allow duplicate jobs */
431 bool AllowHigherDuplicates; /* Permit Higher Level */
432 bool CancelQueuedDuplicates; /* Cancel queued jobs */
433 bool CancelRunningDuplicates; /* Cancel Running jobs */
440 inline char *JOB::name() const { return hdr.name; }
445 /* File options structure */
447 char opts[MAX_FOPTS]; /* options string */
448 alist regex; /* regex string(s) */
449 alist regexdir; /* regex string(s) for directories */
450 alist regexfile; /* regex string(s) for files */
451 alist wild; /* wild card strings */
452 alist wilddir; /* wild card strings for directories */
453 alist wildfile; /* wild card strings for files */
454 alist wildbase; /* wild card strings for files without '/' */
455 alist base; /* list of base names */
456 alist fstype; /* file system type limitation */
457 alist drivetype; /* drive type limitation */
458 char *reader; /* reader program */
459 char *writer; /* writer program */
460 char *plugin; /* plugin program */
464 /* This is either an include item or an exclude item */
466 FOPTS *current_opts; /* points to current options structure */
467 FOPTS **opts_list; /* options list */
468 int num_opts; /* number of options items */
469 alist name_list; /* filename list -- holds char * */
470 alist plugin_list; /* filename list for plugins */
481 bool new_include; /* Set if new include used */
482 INCEXE **include_items; /* array of incexe structures */
483 int num_includes; /* number in array */
484 INCEXE **exclude_items;
486 bool have_MD5; /* set if MD5 initialized */
487 struct MD5Context md5c; /* MD5 of include/exclude */
488 char MD5[30]; /* base 64 representation of MD5 */
489 bool ignore_fs_changes; /* Don't force Full if FS changed */
490 bool enable_vss; /* Enable Volume Shadow Copy */
496 inline char *FILESET::name() const { return hdr.name; }
516 int32_t MinValue; /* Minimum value */
517 int32_t MaxValue; /* Maximum value */
518 int32_t CurrentValue; /* Current value */
519 COUNTER *WrapCounter; /* Wrap counter name */
520 CAT *Catalog; /* Where to store */
521 bool created; /* Created in DB */
526 inline char *COUNTER::name() const { return hdr.name; }
536 char *pool_type; /* Pool type */
537 char *label_format; /* Label format string */
538 char *cleaning_prefix; /* Cleaning label prefix */
539 int32_t LabelType; /* Bacula/ANSI/IBM label type */
540 uint32_t max_volumes; /* max number of volumes */
541 utime_t VolRetention; /* volume retention period in seconds */
542 utime_t VolUseDuration; /* duration volume can be used */
543 uint32_t MaxVolJobs; /* Maximum jobs on the Volume */
544 uint32_t MaxVolFiles; /* Maximum files on the Volume */
545 uint64_t MaxVolBytes; /* Maximum bytes on the Volume */
546 utime_t MigrationTime; /* Time to migrate to next pool */
547 uint64_t MigrationHighBytes; /* When migration starts */
548 uint64_t MigrationLowBytes; /* When migration stops */
549 POOL *NextPool; /* Next pool for migration */
550 alist *storage; /* Where is device -- list of Storage to be used */
551 bool use_catalog; /* maintain catalog for media */
552 bool catalog_files; /* maintain file entries in catalog */
553 bool use_volume_once; /* write on volume only once */
554 bool purge_oldest_volume; /* purge oldest volume */
555 bool recycle_oldest_volume; /* attempt to recycle oldest volume */
556 bool recycle_current_volume; /* attempt recycle of current volume */
557 bool AutoPrune; /* default for pool auto prune */
558 bool Recycle; /* default for media recycle yes/no */
559 POOL *RecyclePool; /* RecyclePool destination when media is purged */
560 alist *CopyPool; /* List of copy pools */
561 CAT *catalog; /* Catalog to be used */
566 inline char *POOL::name() const { return hdr.name; }
571 /* Define the Union of all the above
572 * resource structure definitions.
588 RUNSCRIPT res_runscript;
593 /* Run structure contained in Schedule Resource */
596 RUN *next; /* points to next run record */
597 int level; /* level override */
598 int Priority; /* priority override */
600 bool spool_data; /* Data spooling override */
601 bool spool_data_set; /* Data spooling override given */
602 bool write_part_after_job; /* Write part after job override */
603 bool write_part_after_job_set; /* Write part after job override given */
605 POOL *pool; /* Pool override */
606 POOL *full_pool; /* Pool override */
607 POOL *inc_pool; /* Pool override */
608 POOL *diff_pool; /* Pool override */
609 STORE *storage; /* Storage override */
610 MSGS *msgs; /* Messages override */
613 int minute; /* minute to run job */
614 time_t last_run; /* last time run */
615 time_t next_run; /* next time to run */
616 char hour[nbytes_for_bits(24)]; /* bit set for each hour */
617 char mday[nbytes_for_bits(31)]; /* bit set for each day of month */
618 char month[nbytes_for_bits(12)]; /* bit set for each month */
619 char wday[nbytes_for_bits(7)]; /* bit set for each day of the week */
620 char wom[nbytes_for_bits(5)]; /* week of month */
621 char woy[nbytes_for_bits(54)]; /* week of year */
624 #define GetPoolResWithName(x) ((POOL *)GetResWithName(R_POOL, (x)))
625 #define GetStoreResWithName(x) ((STORE *)GetResWithName(R_STORAGE, (x)))
626 #define GetClientResWithName(x) ((CLIENT *)GetResWithName(R_CLIENT, (x)))
627 #define GetJobResWithName(x) ((JOB *)GetResWithName(R_JOB, (x)))
628 #define GetFileSetResWithName(x) ((FILESET *)GetResWithName(R_FILESET, (x)))
629 #define GetCatalogResWithName(x) ((CAT *)GetResWithName(R_CATALOG, (x)))