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 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
188 Num_ACL /* keep last */
197 char *password; /* UA server password */
198 alist *ACL_lists[Num_ACL]; /* pointers to ACLs */
199 char *tls_ca_certfile; /* TLS CA Certificate File */
200 char *tls_ca_certdir; /* TLS CA Certificate Directory */
201 char *tls_certfile; /* TLS Server Certificate File */
202 char *tls_keyfile; /* TLS Server Key File */
203 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
204 alist *tls_allowed_cns; /* TLS Allowed Clients */
205 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
206 bool tls_authenticate; /* Authenticated with TLS */
207 bool tls_enable; /* Enable TLS */
208 bool tls_require; /* Require TLS */
209 bool tls_verify_peer; /* TLS Verify Client Certificate */
215 inline char *CONRES::name() const { return hdr.name; }
226 int db_port; /* Port */
227 char *db_address; /* host name for remote access */
228 char *db_socket; /* Socket for local access */
232 int mult_db_connections; /* set if multiple connections wanted */
238 inline char *CAT::name() const { return hdr.name; }
249 int FDport; /* Where File daemon listens */
250 utime_t FileRetention; /* file retention period in seconds */
251 utime_t JobRetention; /* job retention period in seconds */
252 utime_t heartbeat_interval; /* Interval to send heartbeats */
255 CAT *catalog; /* Catalog resource */
256 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
257 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
258 char *tls_ca_certfile; /* TLS CA Certificate File */
259 char *tls_ca_certdir; /* TLS CA Certificate Directory */
260 char *tls_certfile; /* TLS Client Certificate File */
261 char *tls_keyfile; /* TLS Client Key File */
262 alist *tls_allowed_cns; /* TLS Allowed Clients */
263 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
264 bool tls_authenticate; /* Authenticated with TLS */
265 bool tls_enable; /* Enable TLS */
266 bool tls_require; /* Require TLS */
267 bool AutoPrune; /* Do automatic pruning? */
273 inline char *CLIENT::name() const { return hdr.name; }
284 int SDport; /* port where Directors connect */
285 int SDDport; /* data port for File daemon */
289 alist *device; /* Alternate devices for this Storage */
290 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
291 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
292 char *tls_ca_certfile; /* TLS CA Certificate File */
293 char *tls_ca_certdir; /* TLS CA Certificate Directory */
294 char *tls_certfile; /* TLS Client Certificate File */
295 char *tls_keyfile; /* TLS Client Key File */
296 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
297 bool tls_authenticate; /* Authenticated with TLS */
298 bool tls_enable; /* Enable TLS */
299 bool tls_require; /* Require TLS */
300 bool enabled; /* Set if device is enabled */
301 bool autochanger; /* set if autochanger */
302 int64_t StorageId; /* Set from Storage DB record */
303 utime_t heartbeat_interval; /* Interval to send heartbeats */
304 int drives; /* number of drives in autochanger */
307 char *dev_name() const;
311 inline char *STORE::dev_name() const
313 DEVICE *dev = (DEVICE *)device->first();
314 return dev->hdr.name;
317 inline char *STORE::name() const { return hdr.name; }
320 * This is a sort of "unified" store that has both the
321 * storage pointer and the text of where the pointer was
327 POOLMEM *store_source;
330 USTORE() { store = NULL; store_source = get_pool_memory(PM_MESSAGE);
331 *store_source = 0; };
332 ~USTORE() { destroy(); }
333 void set_source(const char *where);
337 inline void USTORE::destroy()
340 free_pool_memory(store_source);
346 inline void USTORE::set_source(const char *where)
349 store_source = get_pool_memory(PM_MESSAGE);
351 pm_strcpy(store_source, where);
362 int JobType; /* job type (backup, verify, restore */
363 int JobLevel; /* default backup/verify level */
364 int Priority; /* Job priority */
365 int RestoreJobId; /* What -- JobId to restore */
366 char *RestoreWhere; /* Where on disk to restore -- directory */
367 char *RegexWhere; /* RegexWhere option */
368 char *strip_prefix; /* remove prefix from filename */
369 char *add_prefix; /* add prefix to filename */
370 char *add_suffix; /* add suffix to filename -- .old */
371 bool where_use_regexp; /* true if RestoreWhere is a BREGEXP */
372 char *RestoreBootstrap; /* Bootstrap file */
373 alist *RunScripts; /* Run {client} program {after|before} Job */
375 char *WriteBootstrap; /* Where to write bootstrap Job updates */
376 char *WriteVerifyList; /* List of changed files */
378 int replace; /* How (overwrite, ..) */
379 utime_t MaxRunTime; /* max run time in seconds */
380 utime_t MaxWaitTime; /* max blocking time in seconds */
381 utime_t FullMaxWaitTime; /* Max Full job wait time */
382 utime_t DiffMaxWaitTime; /* Max Differential job wait time */
383 utime_t IncMaxWaitTime; /* Max Incremental job wait time */
384 utime_t MaxStartDelay; /* max start delay in seconds */
385 utime_t RescheduleInterval; /* Reschedule interval */
386 utime_t JobRetention; /* job retention period in seconds */
387 uint32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
388 int64_t spool_size; /* Size of spool file for this job */
389 int RescheduleTimes; /* Number of times to reschedule job */
390 bool RescheduleOnError; /* Set to reschedule on error */
391 bool PrefixLinks; /* prefix soft links with Where path */
392 bool PruneJobs; /* Force pruning of Jobs */
393 bool PruneFiles; /* Force pruning of Files */
394 bool PruneVolumes; /* Force pruning of Volumes */
395 bool SpoolAttributes; /* Set to spool attributes in SD */
396 bool spool_data; /* Set to spool data in SD */
397 bool rerun_failed_levels; /* Upgrade to rerun failed levels */
398 bool PreferMountedVolumes; /* Prefer vols mounted rather than new one */
399 bool write_part_after_job; /* Set to write part after job in SD */
400 bool enabled; /* Set if job enabled */
401 bool OptimizeJobScheduling; /* Set if we should optimize Job scheduling */
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;
415 JOB *verify_job; /* Job name to verify */
417 JOB *jobdefs; /* Job defaults */
418 alist *run_cmds; /* Run commands */
419 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
425 inline char *JOB::name() const { return hdr.name; }
430 /* File options structure */
432 char opts[MAX_FOPTS]; /* options string */
433 alist regex; /* regex string(s) */
434 alist regexdir; /* regex string(s) for directories */
435 alist regexfile; /* regex string(s) for files */
436 alist wild; /* wild card strings */
437 alist wilddir; /* wild card strings for directories */
438 alist wildfile; /* wild card strings for files */
439 alist wildbase; /* wild card strings for files without '/' */
440 alist base; /* list of base names */
441 alist fstype; /* file system type limitation */
442 alist drivetype; /* drive type limitation */
443 char *reader; /* reader program */
444 char *writer; /* writer program */
448 /* This is either an include item or an exclude item */
450 FOPTS *current_opts; /* points to current options structure */
451 FOPTS **opts_list; /* options list */
452 int num_opts; /* number of options items */
453 alist name_list; /* filename list -- holds char * */
464 bool new_include; /* Set if new include used */
465 INCEXE **include_items; /* array of incexe structures */
466 int num_includes; /* number in array */
467 INCEXE **exclude_items;
469 bool have_MD5; /* set if MD5 initialized */
470 struct MD5Context md5c; /* MD5 of include/exclude */
471 char MD5[30]; /* base 64 representation of MD5 */
472 bool ignore_fs_changes; /* Don't force Full if FS changed */
473 bool enable_vss; /* Enable Volume Shadow Copy */
479 inline char *FILESET::name() const { return hdr.name; }
499 int32_t MinValue; /* Minimum value */
500 int32_t MaxValue; /* Maximum value */
501 int32_t CurrentValue; /* Current value */
502 COUNTER *WrapCounter; /* Wrap counter name */
503 CAT *Catalog; /* Where to store */
504 bool created; /* Created in DB */
509 inline char *COUNTER::name() const { return hdr.name; }
519 char *pool_type; /* Pool type */
520 char *label_format; /* Label format string */
521 char *cleaning_prefix; /* Cleaning label prefix */
522 int32_t LabelType; /* Bacula/ANSI/IBM label type */
523 uint32_t max_volumes; /* max number of volumes */
524 utime_t VolRetention; /* volume retention period in seconds */
525 utime_t VolUseDuration; /* duration volume can be used */
526 uint32_t MaxVolJobs; /* Maximum jobs on the Volume */
527 uint32_t MaxVolFiles; /* Maximum files on the Volume */
528 uint64_t MaxVolBytes; /* Maximum bytes on the Volume */
529 utime_t MigrationTime; /* Time to migrate to next pool */
530 uint64_t MigrationHighBytes; /* When migration starts */
531 uint64_t MigrationLowBytes; /* When migration stops */
532 POOL *NextPool; /* Next pool for migration */
533 alist *storage; /* Where is device -- list of Storage to be used */
534 bool use_catalog; /* maintain catalog for media */
535 bool catalog_files; /* maintain file entries in catalog */
536 bool use_volume_once; /* write on volume only once */
537 bool purge_oldest_volume; /* purge oldest volume */
538 bool recycle_oldest_volume; /* attempt to recycle oldest volume */
539 bool recycle_current_volume; /* attempt recycle of current volume */
540 bool AutoPrune; /* default for pool auto prune */
541 bool Recycle; /* default for media recycle yes/no */
542 POOL *RecyclePool; /* RecyclePool destination when media is purged */
543 alist *CopyPool; /* List of copy pools */
544 CAT *Catalog; /* Catalog to be used */
549 inline char *POOL::name() const { return hdr.name; }
554 /* Define the Union of all the above
555 * resource structure definitions.
571 RUNSCRIPT res_runscript;
576 /* Run structure contained in Schedule Resource */
579 RUN *next; /* points to next run record */
580 int level; /* level override */
581 int Priority; /* priority override */
583 bool spool_data; /* Data spooling override */
584 bool spool_data_set; /* Data spooling override given */
585 bool write_part_after_job; /* Write part after job override */
586 bool write_part_after_job_set; /* Write part after job override given */
588 POOL *pool; /* Pool override */
589 POOL *full_pool; /* Pool override */
590 POOL *inc_pool; /* Pool override */
591 POOL *diff_pool; /* Pool override */
592 STORE *storage; /* Storage override */
593 MSGS *msgs; /* Messages override */
596 int minute; /* minute to run job */
597 time_t last_run; /* last time run */
598 time_t next_run; /* next time to run */
599 char hour[nbytes_for_bits(24)]; /* bit set for each hour */
600 char mday[nbytes_for_bits(31)]; /* bit set for each day of month */
601 char month[nbytes_for_bits(12)]; /* bit set for each month */
602 char wday[nbytes_for_bits(7)]; /* bit set for each day of the week */
603 char wom[nbytes_for_bits(5)]; /* week of month */
604 char woy[nbytes_for_bits(54)]; /* week of year */
607 #define GetPoolResWithName(x) ((POOL *)GetResWithName(R_POOL, (x)))
608 #define GetStoreResWithName(x) ((STORE *)GetResWithName(R_STORAGE, (x)))
609 #define GetClientResWithName(x) ((CLIENT *)GetResWithName(R_CLIENT, (x)))
610 #define GetJobResWithName(x) ((JOB *)GetResWithName(R_JOB, (x)))
611 #define GetFileSetResWithName(x) ((FILESET *)GetResWithName(R_FILESET, (x)))
612 #define GetCatalogResWithName(x) ((CAT *)GetResWithName(R_CATALOG, (x)))