2 * Director specific configuration and defines
9 Copyright (C) 2000-2006 Kern Sibbald
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License
13 version 2 as amended with additional clauses defined in the
14 file LICENSE in the main source directory.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 the file LICENSE for additional details.
23 /* NOTE: #includes at the end of this file */
26 * Resource codes -- they must be sequential for indexing
43 R_LAST = R_DEVICE /* keep this updated */
48 * Some resource attributes
59 /* Used for certain KeyWord tables */
65 /* Job Level keyword structure */
67 const char *level_name; /* level keyword */
68 int level; /* level */
69 int job_type; /* JobType permitting this level */
72 /* Job Type keyword structure */
74 const char *type_name;
78 /* Definition of the contents of each Resource */
79 /* Needed for forward references */
96 char *password; /* Password for UA access */
97 char *query_file; /* SQL query file */
98 char *working_directory; /* WorkingDirectory */
99 const char *scripts_directory; /* ScriptsDirectory */
100 char *pid_directory; /* PidDirectory */
101 char *subsys_directory; /* SubsysDirectory */
102 MSGS *messages; /* Daemon message handler */
103 uint32_t MaxConcurrentJobs; /* Max concurrent jobs for whole director */
104 utime_t FDConnectTimeout; /* timeout for connect in seconds */
105 utime_t SDConnectTimeout; /* timeout in seconds */
106 char *tls_ca_certfile; /* TLS CA Certificate File */
107 char *tls_ca_certdir; /* TLS CA Certificate Directory */
108 char *tls_certfile; /* TLS Server Certificate File */
109 char *tls_keyfile; /* TLS Server Key File */
110 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
111 alist *tls_allowed_cns; /* TLS Allowed Clients */
112 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
113 bool tls_enable; /* Enable TLS */
114 bool tls_require; /* Require TLS */
115 bool tls_verify_peer; /* TLS Verify Client Certificate */
121 inline char *DIRRES::name() const { return hdr.name; }
125 * This resource is a bit different from the other resources
126 * because it is not defined in the Director
127 * by DEVICE { ... }, but rather by a "reference" such as
128 * DEVICE = xxx; Then when the Director connects to the
129 * SD, it requests the information about the device.
135 bool found; /* found with SD */
136 int num_writers; /* number of writers */
137 int max_writers; /* = 1 for files */
138 int reserved; /* number of reserves */
139 int num_drives; /* for autochanger */
140 bool autochanger; /* set if device is autochanger */
141 bool open; /* drive open */
142 bool append; /* in append mode */
143 bool read; /* in read mode */
144 bool labeled; /* Volume name valid */
145 bool offline; /* not available */
146 bool autoselect; /* can be selected via autochanger */
148 char ChangerName[MAX_NAME_LENGTH];
149 char VolumeName[MAX_NAME_LENGTH];
150 char MediaType[MAX_NAME_LENGTH];
156 inline char *DEVICE::name() const { return hdr.name; }
159 * Console ACL positions
172 Num_ACL /* keep last */
181 char *password; /* UA server password */
182 alist *ACL_lists[Num_ACL]; /* pointers to ACLs */
183 char *tls_ca_certfile; /* TLS CA Certificate File */
184 char *tls_ca_certdir; /* TLS CA Certificate Directory */
185 char *tls_certfile; /* TLS Server Certificate File */
186 char *tls_keyfile; /* TLS Server Key File */
187 char *tls_dhfile; /* TLS Diffie-Hellman Parameters */
188 alist *tls_allowed_cns; /* TLS Allowed Clients */
189 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
190 bool tls_enable; /* Enable TLS */
191 bool tls_require; /* Require TLS */
192 bool tls_verify_peer; /* TLS Verify Client Certificate */
198 inline char *CONRES::name() const { return hdr.name; }
209 int db_port; /* Port */
210 char *db_address; /* host name for remote access */
211 char *db_socket; /* Socket for local access */
215 int mult_db_connections; /* set if multiple connections wanted */
221 inline char *CAT::name() const { return hdr.name; }
232 int FDport; /* Where File daemon listens */
233 utime_t FileRetention; /* file retention period in seconds */
234 utime_t JobRetention; /* job retention period in seconds */
237 CAT *catalog; /* Catalog resource */
238 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
239 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
240 char *tls_ca_certfile; /* TLS CA Certificate File */
241 char *tls_ca_certdir; /* TLS CA Certificate Directory */
242 char *tls_certfile; /* TLS Client Certificate File */
243 char *tls_keyfile; /* TLS Client Key File */
244 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
245 bool tls_enable; /* Enable TLS */
246 bool tls_require; /* Require TLS */
247 bool AutoPrune; /* Do automatic pruning? */
253 inline char *CLIENT::name() const { return hdr.name; }
264 int SDport; /* port where Directors connect */
265 int SDDport; /* data port for File daemon */
269 alist *device; /* Alternate devices for this Storage */
270 uint32_t MaxConcurrentJobs; /* Maximume concurrent jobs */
271 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
272 char *tls_ca_certfile; /* TLS CA Certificate File */
273 char *tls_ca_certdir; /* TLS CA Certificate Directory */
274 char *tls_certfile; /* TLS Client Certificate File */
275 char *tls_keyfile; /* TLS Client Key File */
276 TLS_CONTEXT *tls_ctx; /* Shared TLS Context */
277 bool tls_enable; /* Enable TLS */
278 bool tls_require; /* Require TLS */
279 bool enabled; /* Set if device is enabled */
280 bool autochanger; /* set if autochanger */
281 int64_t StorageId; /* Set from Storage DB record */
282 int drives; /* number of drives in autochanger */
285 char *dev_name() const;
289 inline char *STORE::dev_name() const
291 DEVICE *dev = (DEVICE *)device->first();
292 return dev->hdr.name;
295 inline char *STORE::name() const { return hdr.name; }
305 int JobType; /* job type (backup, verify, restore */
306 int JobLevel; /* default backup/verify level */
307 int Priority; /* Job priority */
308 int RestoreJobId; /* What -- JobId to restore */
309 char *RestoreWhere; /* Where on disk to restore -- directory */
310 char *RestoreBootstrap; /* Bootstrap file */
311 alist *RunScripts; /* Run {client} program {after|before} Job */
313 char *WriteBootstrap; /* Where to write bootstrap Job updates */
314 char *WriteVerifyList; /* List of changed files */
316 int replace; /* How (overwrite, ..) */
317 utime_t MaxRunTime; /* max run time in seconds */
318 utime_t MaxWaitTime; /* max blocking time in seconds */
319 utime_t FullMaxWaitTime; /* Max Full job wait time */
320 utime_t DiffMaxWaitTime; /* Max Differential job wait time */
321 utime_t IncMaxWaitTime; /* Max Incremental job wait time */
322 utime_t MaxStartDelay; /* max start delay in seconds */
323 utime_t RescheduleInterval; /* Reschedule interval */
324 utime_t JobRetention; /* job retention period in seconds */
325 uint32_t MaxConcurrentJobs; /* Maximum concurrent jobs */
326 int RescheduleTimes; /* Number of times to reschedule job */
327 bool RescheduleOnError; /* Set to reschedule on error */
328 bool PrefixLinks; /* prefix soft links with Where path */
329 bool PruneJobs; /* Force pruning of Jobs */
330 bool PruneFiles; /* Force pruning of Files */
331 bool PruneVolumes; /* Force pruning of Volumes */
332 bool SpoolAttributes; /* Set to spool attributes in SD */
333 bool spool_data; /* Set to spool data in SD */
334 bool rerun_failed_levels; /* Upgrade to rerun failed levels */
335 bool PreferMountedVolumes; /* Prefer vols mounted rather than new one */
336 bool write_part_after_job; /* Set to write part after job in SD */
337 bool enabled; /* Set if job enabled */
339 MSGS *messages; /* How and where to send messages */
340 SCHED *schedule; /* When -- Automatic schedule */
341 CLIENT *client; /* Who to backup */
342 FILESET *fileset; /* What to backup -- Fileset */
343 alist *storage; /* Where is device -- list of Storage to be used */
344 POOL *pool; /* Where is media -- Media Pool */
345 POOL *full_pool; /* Pool for Full backups */
346 POOL *inc_pool; /* Pool for Incremental backups */
347 POOL *diff_pool; /* Pool for Differental backups */
348 POOL *next_pool; /* Next Pool for Migration */
349 char *selection_pattern;
352 JOB *verify_job; /* Job name to verify */
354 JOB *jobdefs; /* Job defaults */
355 alist *run_cmds; /* Run commands */
356 uint32_t NumConcurrentJobs; /* number of concurrent jobs running */
362 inline char *JOB::name() const { return hdr.name; }
367 /* File options structure */
369 char opts[MAX_FOPTS]; /* options string */
370 alist regex; /* regex string(s) */
371 alist regexdir; /* regex string(s) for directories */
372 alist regexfile; /* regex string(s) for files */
373 alist wild; /* wild card strings */
374 alist wilddir; /* wild card strings for directories */
375 alist wildfile; /* wild card strings for files */
376 alist wildbase; /* wild card strings for files without '/' */
377 alist base; /* list of base names */
378 alist fstype; /* file system type limitation */
379 alist drivetype; /* drive type limitation */
380 char *reader; /* reader program */
381 char *writer; /* writer program */
385 /* This is either an include item or an exclude item */
387 FOPTS *current_opts; /* points to current options structure */
388 FOPTS **opts_list; /* options list */
389 int num_opts; /* number of options items */
390 alist name_list; /* filename list -- holds char * */
401 bool new_include; /* Set if new include used */
402 INCEXE **include_items; /* array of incexe structures */
403 int num_includes; /* number in array */
404 INCEXE **exclude_items;
406 bool have_MD5; /* set if MD5 initialized */
407 struct MD5Context md5c; /* MD5 of include/exclude */
408 char MD5[30]; /* base 64 representation of MD5 */
409 bool ignore_fs_changes; /* Don't force Full if FS changed */
410 bool enable_vss; /* Enable Volume Shadow Copy */
416 inline char *FILESET::name() const { return hdr.name; }
436 int32_t MinValue; /* Minimum value */
437 int32_t MaxValue; /* Maximum value */
438 int32_t CurrentValue; /* Current value */
439 COUNTER *WrapCounter; /* Wrap counter name */
440 CAT *Catalog; /* Where to store */
441 bool created; /* Created in DB */
446 inline char *COUNTER::name() const { return hdr.name; }
456 char *pool_type; /* Pool type */
457 char *label_format; /* Label format string */
458 char *cleaning_prefix; /* Cleaning label prefix */
459 int32_t LabelType; /* Bacula/ANSI/IBM label type */
460 uint32_t max_volumes; /* max number of volumes */
461 utime_t VolRetention; /* volume retention period in seconds */
462 utime_t VolUseDuration; /* duration volume can be used */
463 uint32_t MaxVolJobs; /* Maximum jobs on the Volume */
464 uint32_t MaxVolFiles; /* Maximum files on the Volume */
465 uint64_t MaxVolBytes; /* Maximum bytes on the Volume */
466 utime_t MigrationTime; /* Time to migrate to next pool */
467 uint64_t MigrationHighBytes; /* When migration starts */
468 uint64_t MigrationLowBytes; /* When migration stops */
469 POOL *NextPool; /* Next pool for migration */
470 alist *storage; /* Where is device -- list of Storage to be used */
471 bool use_catalog; /* maintain catalog for media */
472 bool catalog_files; /* maintain file entries in catalog */
473 bool use_volume_once; /* write on volume only once */
474 bool purge_oldest_volume; /* purge oldest volume */
475 bool recycle_oldest_volume; /* attempt to recycle oldest volume */
476 bool recycle_current_volume; /* attempt recycle of current volume */
477 bool AutoPrune; /* default for pool auto prune */
478 bool Recycle; /* default for media recycle yes/no */
484 inline char *POOL::name() const { return hdr.name; }
489 /* Define the Union of all the above
490 * resource structure definitions.
506 RUNSCRIPT res_runscript;
511 /* Run structure contained in Schedule Resource */
514 RUN *next; /* points to next run record */
515 int level; /* level override */
516 int Priority; /* priority override */
518 bool spool_data; /* Data spooling override */
519 bool spool_data_set; /* Data spooling override given */
520 bool write_part_after_job; /* Write part after job override */
521 bool write_part_after_job_set; /* Write part after job override given */
523 POOL *pool; /* Pool override */
524 POOL *full_pool; /* Pool override */
525 POOL *inc_pool; /* Pool override */
526 POOL *diff_pool; /* Pool override */
527 STORE *storage; /* Storage override */
528 MSGS *msgs; /* Messages override */
531 int minute; /* minute to run job */
532 time_t last_run; /* last time run */
533 time_t next_run; /* next time to run */
534 char hour[nbytes_for_bits(24)]; /* bit set for each hour */
535 char mday[nbytes_for_bits(31)]; /* bit set for each day of month */
536 char month[nbytes_for_bits(12)]; /* bit set for each month */
537 char wday[nbytes_for_bits(7)]; /* bit set for each day of the week */
538 char wom[nbytes_for_bits(5)]; /* week of month */
539 char woy[nbytes_for_bits(54)]; /* week of year */