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 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
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 int32_t level; /* level */
82 int32_t 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 utime_t stats_retention; /* Stats retention period in seconds */
129 bool tls_authenticate; /* Authenticated with TLS */
130 bool tls_enable; /* Enable TLS */
131 bool tls_require; /* Require TLS */
132 bool tls_verify_peer; /* TLS Verify Client Certificate */
133 char *verid; /* Custom Id to print in version command */
138 inline char *DIRRES::name() const { return hdr.name; }
142 * This resource is a bit different from the other resources
143 * because it is not defined in the Director
144 * by DEVICE { ... }, but rather by a "reference" such as
145 * DEVICE = xxx; Then when the Director connects to the
146 * SD, it requests the information about the device.
152 bool found; /* found with SD */
153 int32_t num_writers; /* number of writers */
154 int32_t max_writers; /* = 1 for files */
155 int32_t reserved; /* number of reserves */
156 int32_t num_drives; /* for autochanger */
157 bool autochanger; /* set if device is autochanger */
158 bool open; /* drive open */
159 bool append; /* in append mode */
160 bool read; /* in read mode */
161 bool labeled; /* Volume name valid */
162 bool offline; /* not available */
163 bool autoselect; /* can be selected via autochanger */
165 char ChangerName[MAX_NAME_LENGTH];
166 char VolumeName[MAX_NAME_LENGTH];
167 char MediaType[MAX_NAME_LENGTH];
173 inline char *DEVICE::name() const { return hdr.name; }
176 * Console ACL positions
190 Num_ACL /* keep last */
199 char *password; /* UA server password */
200 alist *ACL_lists[Num_ACL]; /* pointers to ACLs */
201 char *tls_ca_certfile; /* TLS CA Certificate File */
202 char *tls_ca_certdir; /* TLS CA Certificate Directory */
203 char *tls_certfile; /* TLS Server Certificate File */
204 char *tls_keyfile; /* TLS Server Key File */
205 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
206 alist *tls_allowed_cns; /* TLS Allowed Clients */
207 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
208 bool tls_authenticate; /* Authenticated with TLS */
209 bool tls_enable; /* Enable TLS */
210 bool tls_require; /* Require TLS */
211 bool tls_verify_peer; /* TLS Verify Client Certificate */
217 inline char *CONRES::name() const { return hdr.name; }
228 uint32_t db_port; /* Port */
229 char *db_address; /* host name for remote access */
230 char *db_socket; /* Socket for local access */
234 char *db_driver; /* Select appropriate driver */
235 uint32_t mult_db_connections; /* set if multiple connections wanted */
239 char *display(POOLMEM *dst); /* Get catalog information */
242 inline char *CAT::name() const { return hdr.name; }
253 uint32_t FDport; /* Where File daemon listens */
254 utime_t FileRetention; /* file retention period in seconds */
255 utime_t JobRetention; /* job retention period in seconds */
256 utime_t heartbeat_interval; /* Interval to send heartbeats */
259 CAT *catalog; /* Catalog resource */
260 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
261 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
262 char *tls_ca_certfile; /* TLS CA Certificate File */
263 char *tls_ca_certdir; /* TLS CA Certificate Directory */
264 char *tls_certfile; /* TLS Client Certificate File */
265 char *tls_keyfile; /* TLS Client Key File */
266 alist *tls_allowed_cns; /* TLS Allowed Clients */
267 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
268 bool tls_authenticate; /* Authenticated with TLS */
269 bool tls_enable; /* Enable TLS */
270 bool tls_require; /* Require TLS */
271 bool AutoPrune; /* Do automatic pruning? */
277 inline char *CLIENT::name() const { return hdr.name; }
288 uint32_t SDport; /* port where Directors connect */
289 uint32_t SDDport; /* data port for File daemon */
293 alist *device; /* Alternate devices for this Storage */
294 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
295 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
296 uint32_t NumConcurrentReadJobs; /* number of jobs reading */
297 char *tls_ca_certfile; /* TLS CA Certificate File */
298 char *tls_ca_certdir; /* TLS CA Certificate Directory */
299 char *tls_certfile; /* TLS Client Certificate File */
300 char *tls_keyfile; /* TLS Client Key File */
301 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
302 bool tls_authenticate; /* Authenticated with TLS */
303 bool tls_enable; /* Enable TLS */
304 bool tls_require; /* Require TLS */
305 bool enabled; /* Set if device is enabled */
306 bool autochanger; /* set if autochanger */
307 int64_t StorageId; /* Set from Storage DB record */
308 utime_t heartbeat_interval; /* Interval to send heartbeats */
309 uint32_t drives; /* number of drives in autochanger */
312 char *dev_name() const;
316 inline char *STORE::dev_name() const
318 DEVICE *dev = (DEVICE *)device->first();
319 return dev->hdr.name;
322 inline char *STORE::name() const { return hdr.name; }
325 * This is a sort of "unified" store that has both the
326 * storage pointer and the text of where the pointer was
332 POOLMEM *store_source;
335 USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
336 *store_source = 0; };
337 ~USTORE() { destroy(); }
338 void set_source(const char *where);
342 inline void USTORE::destroy()
345 free_pool_memory(store_source);
351 inline void USTORE::set_source(const char *where)
354 store_source = get_pool_memory(PM_MESSAGE);
356 pm_strcpy(store_source, where);
367 uint32_t JobType; /* job type (backup, verify, restore */
368 uint32_t JobLevel; /* default backup/verify level */
369 int32_t Priority; /* Job priority */
370 uint32_t RestoreJobId; /* What -- JobId to restore */
371 int32_t RescheduleTimes; /* Number of times to reschedule job */
372 uint32_t replace; /* How (overwrite, ..) */
373 uint32_t selection_type;
375 char *RestoreWhere; /* Where on disk to restore -- directory */
376 char *RegexWhere; /* RegexWhere option */
377 char *strip_prefix; /* remove prefix from filename */
378 char *add_prefix; /* add prefix to filename */
379 char *add_suffix; /* add suffix to filename -- .old */
380 char *RestoreBootstrap; /* Bootstrap file */
381 char *PluginOptions; /* Options to pass to plugin */
383 char *WriteBootstrap; /* Where to write bootstrap Job updates */
384 char *WriteVerifyList; /* List of changed files */
386 utime_t MaxRunTime; /* max run time in seconds */
387 utime_t MaxWaitTime; /* max blocking time in seconds */
388 utime_t FullMaxRunTime; /* Max Full job run time */
389 utime_t DiffMaxRunTime; /* Max Differential job run time */
390 utime_t IncMaxRunTime; /* Max Incremental job run time */
391 utime_t MaxStartDelay; /* max start delay in seconds */
392 utime_t MaxRunSchedTime; /* max run time in seconds from Scheduled time*/
393 utime_t RescheduleInterval; /* Reschedule interval */
394 utime_t JobRetention; /* job retention period in seconds */
395 utime_t MaxFullInterval; /* Maximum time interval between Fulls */
396 utime_t MaxDiffInterval; /* Maximum time interval between Diffs */
397 utime_t DuplicateJobProximity; /* Permitted time between duplicicates */
398 int64_t spool_size; /* Size of spool file for this job */
399 uint32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
400 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
401 bool allow_mixed_priority; /* Allow jobs with higher priority concurrently with this */
403 MSGS *messages; /* How and where to send messages */
404 SCHED *schedule; /* When -- Automatic schedule */
405 CLIENT *client; /* Who to backup */
406 FILESET *fileset; /* What to backup -- Fileset */
407 alist *storage; /* Where is device -- list of Storage to be used */
408 POOL *pool; /* Where is media -- Media Pool */
409 POOL *full_pool; /* Pool for Full backups */
410 POOL *inc_pool; /* Pool for Incremental backups */
411 POOL *diff_pool; /* Pool for Differental backups */
412 char *selection_pattern;
414 JOB *verify_job; /* Job name to verify */
416 JOB *jobdefs; /* Job defaults */
417 alist *run_cmds; /* Run commands */
418 alist *RunScripts; /* Run {client} program {after|before} Job */
420 bool where_use_regexp; /* true if RestoreWhere is a BREGEXP */
421 bool RescheduleOnError; /* Set to reschedule on error */
422 bool PrefixLinks; /* prefix soft links with Where path */
423 bool PruneJobs; /* Force pruning of Jobs */
424 bool PruneFiles; /* Force pruning of Files */
425 bool PruneVolumes; /* Force pruning of Volumes */
426 bool SpoolAttributes; /* Set to spool attributes in SD */
427 bool spool_data; /* Set to spool data in SD */
428 bool rerun_failed_levels; /* Upgrade to rerun failed levels */
429 bool PreferMountedVolumes; /* Prefer vols mounted rather than new one */
430 bool write_part_after_job; /* Set to write part after job in SD */
431 bool enabled; /* Set if job enabled */
432 bool accurate; /* Set if it is an accurate backup job */
433 bool AllowDuplicateJobs; /* Allow duplicate jobs */
434 bool AllowHigherDuplicates; /* Permit Higher Level */
435 bool CancelQueuedDuplicates; /* Cancel queued jobs */
436 bool CancelRunningDuplicates; /* Cancel Running jobs */
443 inline char *JOB::name() const { return hdr.name; }
448 /* File options structure */
450 char opts[MAX_FOPTS]; /* options string */
451 alist regex; /* regex string(s) */
452 alist regexdir; /* regex string(s) for directories */
453 alist regexfile; /* regex string(s) for files */
454 alist wild; /* wild card strings */
455 alist wilddir; /* wild card strings for directories */
456 alist wildfile; /* wild card strings for files */
457 alist wildbase; /* wild card strings for files without '/' */
458 alist base; /* list of base names */
459 alist fstype; /* file system type limitation */
460 alist drivetype; /* drive type limitation */
461 char *reader; /* reader program */
462 char *writer; /* writer program */
463 char *ignoredir; /* ignoredir string */
464 char *plugin; /* plugin program */
468 /* This is either an include item or an exclude item */
470 FOPTS *current_opts; /* points to current options structure */
471 FOPTS **opts_list; /* options list */
472 int32_t num_opts; /* number of options items */
473 alist name_list; /* filename list -- holds char * */
474 alist plugin_list; /* filename list for plugins */
485 bool new_include; /* Set if new include used */
486 INCEXE **include_items; /* array of incexe structures */
487 int32_t num_includes; /* number in array */
488 INCEXE **exclude_items;
489 int32_t num_excludes;
490 bool have_MD5; /* set if MD5 initialized */
491 struct MD5Context md5c; /* MD5 of include/exclude */
492 char MD5[30]; /* base 64 representation of MD5 */
493 bool ignore_fs_changes; /* Don't force Full if FS changed */
494 bool enable_vss; /* Enable Volume Shadow Copy */
500 inline char *FILESET::name() const { return hdr.name; }
520 int32_t MinValue; /* Minimum value */
521 int32_t MaxValue; /* Maximum value */
522 int32_t CurrentValue; /* Current value */
523 COUNTER *WrapCounter; /* Wrap counter name */
524 CAT *Catalog; /* Where to store */
525 bool created; /* Created in DB */
530 inline char *COUNTER::name() const { return hdr.name; }
540 char *pool_type; /* Pool type */
541 char *label_format; /* Label format string */
542 char *cleaning_prefix; /* Cleaning label prefix */
543 int32_t LabelType; /* Bacula/ANSI/IBM label type */
544 uint32_t max_volumes; /* max number of volumes */
545 utime_t VolRetention; /* volume retention period in seconds */
546 utime_t VolUseDuration; /* duration volume can be used */
547 uint32_t MaxVolJobs; /* Maximum jobs on the Volume */
548 uint32_t MaxVolFiles; /* Maximum files on the Volume */
549 uint64_t MaxVolBytes; /* Maximum bytes on the Volume */
550 utime_t MigrationTime; /* Time to migrate to next pool */
551 uint64_t MigrationHighBytes; /* When migration starts */
552 uint64_t MigrationLowBytes; /* When migration stops */
553 POOL *NextPool; /* Next pool for migration */
554 alist *storage; /* Where is device -- list of Storage to be used */
555 bool use_catalog; /* maintain catalog for media */
556 bool catalog_files; /* maintain file entries in catalog */
557 bool use_volume_once; /* write on volume only once */
558 bool purge_oldest_volume; /* purge oldest volume */
559 bool recycle_oldest_volume; /* attempt to recycle oldest volume */
560 bool recycle_current_volume; /* attempt recycle of current volume */
561 bool AutoPrune; /* default for pool auto prune */
562 bool Recycle; /* default for media recycle yes/no */
563 POOL *RecyclePool; /* RecyclePool destination when media is purged */
564 alist *CopyPool; /* List of copy pools */
565 CAT *catalog; /* Catalog to be used */
570 inline char *POOL::name() const { return hdr.name; }
575 /* Define the Union of all the above
576 * resource structure definitions.
592 RUNSCRIPT res_runscript;
597 /* Run structure contained in Schedule Resource */
600 RUN *next; /* points to next run record */
601 uint32_t level; /* level override */
602 int32_t Priority; /* priority override */
604 bool spool_data; /* Data spooling override */
605 bool spool_data_set; /* Data spooling override given */
606 bool write_part_after_job; /* Write part after job override */
607 bool write_part_after_job_set; /* Write part after job override given */
609 POOL *pool; /* Pool override */
610 POOL *full_pool; /* Pool override */
611 POOL *inc_pool; /* Pool override */
612 POOL *diff_pool; /* Pool override */
613 STORE *storage; /* Storage override */
614 MSGS *msgs; /* Messages override */
617 uint32_t minute; /* minute to run job */
618 time_t last_run; /* last time run */
619 time_t next_run; /* next time to run */
620 char hour[nbytes_for_bits(24)]; /* bit set for each hour */
621 char mday[nbytes_for_bits(31)]; /* bit set for each day of month */
622 char month[nbytes_for_bits(12)]; /* bit set for each month */
623 char wday[nbytes_for_bits(7)]; /* bit set for each day of the week */
624 char wom[nbytes_for_bits(5)]; /* week of month */
625 char woy[nbytes_for_bits(54)]; /* week of year */
628 #define GetPoolResWithName(x) ((POOL *)GetResWithName(R_POOL, (x)))
629 #define GetStoreResWithName(x) ((STORE *)GetResWithName(R_STORAGE, (x)))
630 #define GetClientResWithName(x) ((CLIENT *)GetResWithName(R_CLIENT, (x)))
631 #define GetJobResWithName(x) ((JOB *)GetResWithName(R_JOB, (x)))
632 #define GetFileSetResWithName(x) ((FILESET *)GetResWithName(R_FILESET, (x)))
633 #define GetCatalogResWithName(x) ((CAT *)GetResWithName(R_CATALOG, (x)))