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 char *tls_ca_certfile; /* TLS CA Certificate File */
120 char *tls_ca_certdir; /* TLS CA Certificate Directory */
121 char *tls_certfile; /* TLS Server Certificate File */
122 char *tls_keyfile; /* TLS Server Key File */
123 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
124 alist *tls_allowed_cns; /* TLS Allowed Clients */
125 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
126 bool tls_enable; /* Enable TLS */
127 bool tls_require; /* Require TLS */
128 bool tls_verify_peer; /* TLS Verify Client Certificate */
134 inline char *DIRRES::name() const { return hdr.name; }
138 * This resource is a bit different from the other resources
139 * because it is not defined in the Director
140 * by DEVICE { ... }, but rather by a "reference" such as
141 * DEVICE = xxx; Then when the Director connects to the
142 * SD, it requests the information about the device.
148 bool found; /* found with SD */
149 int num_writers; /* number of writers */
150 int max_writers; /* = 1 for files */
151 int reserved; /* number of reserves */
152 int num_drives; /* for autochanger */
153 bool autochanger; /* set if device is autochanger */
154 bool open; /* drive open */
155 bool append; /* in append mode */
156 bool read; /* in read mode */
157 bool labeled; /* Volume name valid */
158 bool offline; /* not available */
159 bool autoselect; /* can be selected via autochanger */
161 char ChangerName[MAX_NAME_LENGTH];
162 char VolumeName[MAX_NAME_LENGTH];
163 char MediaType[MAX_NAME_LENGTH];
169 inline char *DEVICE::name() const { return hdr.name; }
172 * Console ACL positions
185 Num_ACL /* keep last */
194 char *password; /* UA server password */
195 alist *ACL_lists[Num_ACL]; /* pointers to ACLs */
196 char *tls_ca_certfile; /* TLS CA Certificate File */
197 char *tls_ca_certdir; /* TLS CA Certificate Directory */
198 char *tls_certfile; /* TLS Server Certificate File */
199 char *tls_keyfile; /* TLS Server Key File */
200 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
201 alist *tls_allowed_cns; /* TLS Allowed Clients */
202 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
203 bool tls_enable; /* Enable TLS */
204 bool tls_require; /* Require TLS */
205 bool tls_verify_peer; /* TLS Verify Client Certificate */
211 inline char *CONRES::name() const { return hdr.name; }
222 int db_port; /* Port */
223 char *db_address; /* host name for remote access */
224 char *db_socket; /* Socket for local access */
228 int mult_db_connections; /* set if multiple connections wanted */
234 inline char *CAT::name() const { return hdr.name; }
245 int FDport; /* Where File daemon listens */
246 utime_t FileRetention; /* file retention period in seconds */
247 utime_t JobRetention; /* job retention period in seconds */
250 CAT *catalog; /* Catalog resource */
251 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
252 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
253 char *tls_ca_certfile; /* TLS CA Certificate File */
254 char *tls_ca_certdir; /* TLS CA Certificate Directory */
255 char *tls_certfile; /* TLS Client Certificate File */
256 char *tls_keyfile; /* TLS Client Key File */
257 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
258 bool tls_enable; /* Enable TLS */
259 bool tls_require; /* Require TLS */
260 bool AutoPrune; /* Do automatic pruning? */
266 inline char *CLIENT::name() const { return hdr.name; }
277 int SDport; /* port where Directors connect */
278 int SDDport; /* data port for File daemon */
282 alist *device; /* Alternate devices for this Storage */
283 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
284 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
285 char *tls_ca_certfile; /* TLS CA Certificate File */
286 char *tls_ca_certdir; /* TLS CA Certificate Directory */
287 char *tls_certfile; /* TLS Client Certificate File */
288 char *tls_keyfile; /* TLS Client Key File */
289 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
290 bool tls_enable; /* Enable TLS */
291 bool tls_require; /* Require TLS */
292 bool enabled; /* Set if device is enabled */
293 bool autochanger; /* set if autochanger */
294 int64_t StorageId; /* Set from Storage DB record */
295 int drives; /* number of drives in autochanger */
298 char *dev_name() const;
302 inline char *STORE::dev_name() const
304 DEVICE *dev = (DEVICE *)device->first();
305 return dev->hdr.name;
308 inline char *STORE::name() const { return hdr.name; }
311 * This is a sort of "unified" store that has both the
312 * storage pointer and the text of where the pointer was
318 POOLMEM *store_source;
321 USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
322 *store_source = 0; };
323 ~USTORE() { destroy(); }
324 void set_source(const char *where);
328 inline void USTORE::destroy()
331 free_pool_memory(store_source);
337 inline void USTORE::set_source(const char *where)
340 store_source = get_pool_memory(PM_MESSAGE);
342 pm_strcpy(store_source, where);
353 int JobType; /* job type (backup, verify, restore */
354 int JobLevel; /* default backup/verify level */
355 int Priority; /* Job priority */
356 int RestoreJobId; /* What -- JobId to restore */
357 char *RestoreWhere; /* Where on disk to restore -- directory */
358 char *RestoreBootstrap; /* Bootstrap file */
359 alist *RunScripts; /* Run {client} program {after|before} Job */
361 char *WriteBootstrap; /* Where to write bootstrap Job updates */
362 char *WriteVerifyList; /* List of changed files */
364 int replace; /* How (overwrite, ..) */
365 utime_t MaxRunTime; /* max run time in seconds */
366 utime_t MaxWaitTime; /* max blocking time in seconds */
367 utime_t FullMaxWaitTime; /* Max Full job wait time */
368 utime_t DiffMaxWaitTime; /* Max Differential job wait time */
369 utime_t IncMaxWaitTime; /* Max Incremental job wait time */
370 utime_t MaxStartDelay; /* max start delay in seconds */
371 utime_t RescheduleInterval; /* Reschedule interval */
372 utime_t JobRetention; /* job retention period in seconds */
373 uint32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
374 int RescheduleTimes; /* Number of times to reschedule job */
375 bool RescheduleOnError; /* Set to reschedule on error */
376 bool PrefixLinks; /* prefix soft links with Where path */
377 bool PruneJobs; /* Force pruning of Jobs */
378 bool PruneFiles; /* Force pruning of Files */
379 bool PruneVolumes; /* Force pruning of Volumes */
380 bool SpoolAttributes; /* Set to spool attributes in SD */
381 bool spool_data; /* Set to spool data in SD */
382 bool rerun_failed_levels; /* Upgrade to rerun failed levels */
383 bool PreferMountedVolumes; /* Prefer vols mounted rather than new one */
384 bool write_part_after_job; /* Set to write part after job in SD */
385 bool enabled; /* Set if job enabled */
387 MSGS *messages; /* How and where to send messages */
388 SCHED *schedule; /* When -- Automatic schedule */
389 CLIENT *client; /* Who to backup */
390 FILESET *fileset; /* What to backup -- Fileset */
391 alist *storage; /* Where is device -- list of Storage to be used */
392 POOL *pool; /* Where is media -- Media Pool */
393 POOL *full_pool; /* Pool for Full backups */
394 POOL *inc_pool; /* Pool for Incremental backups */
395 POOL *diff_pool; /* Pool for Differental backups */
396 char *selection_pattern;
399 JOB *verify_job; /* Job name to verify */
401 JOB *jobdefs; /* Job defaults */
402 alist *run_cmds; /* Run commands */
403 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
409 inline char *JOB::name() const { return hdr.name; }
414 /* File options structure */
416 char opts[MAX_FOPTS]; /* options string */
417 alist regex; /* regex string(s) */
418 alist regexdir; /* regex string(s) for directories */
419 alist regexfile; /* regex string(s) for files */
420 alist wild; /* wild card strings */
421 alist wilddir; /* wild card strings for directories */
422 alist wildfile; /* wild card strings for files */
423 alist wildbase; /* wild card strings for files without '/' */
424 alist base; /* list of base names */
425 alist fstype; /* file system type limitation */
426 alist drivetype; /* drive type limitation */
427 char *reader; /* reader program */
428 char *writer; /* writer program */
432 /* This is either an include item or an exclude item */
434 FOPTS *current_opts; /* points to current options structure */
435 FOPTS **opts_list; /* options list */
436 int num_opts; /* number of options items */
437 alist name_list; /* filename list -- holds char * */
448 bool new_include; /* Set if new include used */
449 INCEXE **include_items; /* array of incexe structures */
450 int num_includes; /* number in array */
451 INCEXE **exclude_items;
453 bool have_MD5; /* set if MD5 initialized */
454 struct MD5Context md5c; /* MD5 of include/exclude */
455 char MD5[30]; /* base 64 representation of MD5 */
456 bool ignore_fs_changes; /* Don't force Full if FS changed */
457 bool enable_vss; /* Enable Volume Shadow Copy */
463 inline char *FILESET::name() const { return hdr.name; }
483 int32_t MinValue; /* Minimum value */
484 int32_t MaxValue; /* Maximum value */
485 int32_t CurrentValue; /* Current value */
486 COUNTER *WrapCounter; /* Wrap counter name */
487 CAT *Catalog; /* Where to store */
488 bool created; /* Created in DB */
493 inline char *COUNTER::name() const { return hdr.name; }
503 char *pool_type; /* Pool type */
504 char *label_format; /* Label format string */
505 char *cleaning_prefix; /* Cleaning label prefix */
506 int32_t LabelType; /* Bacula/ANSI/IBM label type */
507 uint32_t max_volumes; /* max number of volumes */
508 utime_t VolRetention; /* volume retention period in seconds */
509 utime_t VolUseDuration; /* duration volume can be used */
510 uint32_t MaxVolJobs; /* Maximum jobs on the Volume */
511 uint32_t MaxVolFiles; /* Maximum files on the Volume */
512 uint64_t MaxVolBytes; /* Maximum bytes on the Volume */
513 utime_t MigrationTime; /* Time to migrate to next pool */
514 uint64_t MigrationHighBytes; /* When migration starts */
515 uint64_t MigrationLowBytes; /* When migration stops */
516 POOL *NextPool; /* Next pool for migration */
517 alist *storage; /* Where is device -- list of Storage to be used */
518 bool use_catalog; /* maintain catalog for media */
519 bool catalog_files; /* maintain file entries in catalog */
520 bool use_volume_once; /* write on volume only once */
521 bool purge_oldest_volume; /* purge oldest volume */
522 bool recycle_oldest_volume; /* attempt to recycle oldest volume */
523 bool recycle_current_volume; /* attempt recycle of current volume */
524 bool AutoPrune; /* default for pool auto prune */
525 bool Recycle; /* default for media recycle yes/no */
526 POOL *RecyclePool; /* RecyclePool destination when media is purged */
531 inline char *POOL::name() const { return hdr.name; }
536 /* Define the Union of all the above
537 * resource structure definitions.
553 RUNSCRIPT res_runscript;
558 /* Run structure contained in Schedule Resource */
561 RUN *next; /* points to next run record */
562 int level; /* level override */
563 int Priority; /* priority override */
565 bool spool_data; /* Data spooling override */
566 bool spool_data_set; /* Data spooling override given */
567 bool write_part_after_job; /* Write part after job override */
568 bool write_part_after_job_set; /* Write part after job override given */
570 POOL *pool; /* Pool override */
571 POOL *full_pool; /* Pool override */
572 POOL *inc_pool; /* Pool override */
573 POOL *diff_pool; /* Pool override */
574 STORE *storage; /* Storage override */
575 MSGS *msgs; /* Messages override */
578 int minute; /* minute to run job */
579 time_t last_run; /* last time run */
580 time_t next_run; /* next time to run */
581 char hour[nbytes_for_bits(24)]; /* bit set for each hour */
582 char mday[nbytes_for_bits(31)]; /* bit set for each day of month */
583 char month[nbytes_for_bits(12)]; /* bit set for each month */
584 char wday[nbytes_for_bits(7)]; /* bit set for each day of the week */
585 char wom[nbytes_for_bits(5)]; /* week of month */
586 char woy[nbytes_for_bits(54)]; /* week of year */