Bacula® Console and Operators Guide Kern Sibbald May 29, 2021 This manual documents Bacula Community Edition 11.0.4 (29 May 2021) Copyright © 1999-2021, Kern Sibbald Bacula® is a registered trademark of Kern Sibbald. This Bacula documentation by Kern Sibbald with contributions from many others, a complete list can be found in the License chapter. Creative Commons Attribution-ShareAlike 4.0 International License http://creativecommons.org/licenses/by-sa/4.0/ Console and Operators Guide 2/65 Bacula Community Edition v.11.0.4 (29 May 2021) All trademarks are the property of their respective owners CONTENTS Console and Operators Guide Contents 1 Bacula Enterprise Console1 1.1 Console Configuration..................................1 1.2 Running the Console Program..............................1 1.3 Stopping the Console Program.............................2 1.4 Alphabetic List of Console Keywords..........................2 1.5 Alphabetic List of Console Commands.........................4 1.6 Special dot Commands.................................. 20 1.7 Special At (@) Commands................................ 20 1.8 Running the Console from a Shell Script........................ 21 1.9 Adding Volumes to a Pool................................ 22 2 Baculum API and Web GUI Tools 23 2.1 New Features in 11.0.0.................................. 23 2.1.1 Upgrade to 11.0.0................................ 23 2.1.2 Multi-user interface improvements....................... 23 2.1.3 Add searching jobs by filename in the restore wizard............. 24 2.1.4 Show more detailed job file list......................... 24 2.1.5 Add graphs to job view page.......................... 24 2.1.6 Implement graphical status storage....................... 24 2.1.7 Add Russian translations............................. 24 2.1.8 Global messages log window.......................... 24 2.1.9 Job status weather................................ 24 2.1.10 Restore wizard improvements.......................... 24 2.1.11 New API endpoints................................ 24 2.1.12 New parameters in API endpoints....................... 24 2.2 New Features in 9.6.0................................... 25 Bacula Community Edition v.11.0.4 (29 May 2021) i/65 All trademarks are the property of their respective owners Console and Operators Guide CONTENTS 2.2.1 Upgrade to 9.6.4................................. 25 2.2.2 Support for commands that can take a long time.............. 25 2.2.3 Support for SELinux............................... 25 2.2.4 Graphical client status.............................. 25 2.2.5 Graphical running job status.......................... 26 2.2.6 Capability to start, stop and restart components............... 26 2.2.7 Statistics configuration.............................. 26 2.2.8 New graph types................................. 26 2.2.9 Support for new directives............................ 26 2.2.10 Changes in API endpoints............................ 28 2.2.11 New API functions................................ 28 2.2.12 New Web controls................................ 28 2.2.13 Miscellaneous improvements.......................... 28 2.3 Base Features....................................... 29 2.4 General Requirements................................... 29 2.5 Installation Baculum API from rpm binary packages................. 30 2.5.1 Add the Baculum rpm repository........................ 30 2.5.2 Installation for Apache.............................. 32 2.5.3 Installation for Lighttpd............................. 32 2.5.4 SELinux support................................. 32 2.5.5 Access to bconsole via sudo for Apache and Lighttpd............ 32 2.6 Installation Baculum API from deb binary packages................. 33 2.6.1 Add the Baculum deb repository........................ 33 2.6.2 Installation for Apache.............................. 34 2.6.3 Installation for Lighttpd............................. 35 2.6.4 Access to bconsole via sudo for Apache and Lighttpd............ 35 2.7 Debugging your First Baculum API Login....................... 35 2.8 Installation Baculum Web from rpm binary packages................. 36 2.8.1 Installation for Apache.............................. 36 2.8.2 Installation for Lighttpd............................. 36 2.8.3 SELinux support................................. 36 2.9 Installation Baculum Web from deb binary packages................. 37 2.9.1 Installation for Apache.............................. 37 ii/65 Bacula Community Edition v.11.0.4 (29 May 2021) All trademarks are the property of their respective owners CONTENTS Console and Operators Guide 2.9.2 Installation for Lighttpd............................. 37 2.10 Running Baculum API and Web for the First Time.................. 37 2.10.1 Running Baculum API.............................. 37 2.10.2 Running Baculum Web............................. 37 2.10.3 Installation wizards................................ 38 2.10.4 Configuring Bacula................................ 38 2.11 Baculum API documentation.............................. 39 2.11.1 API version 1................................... 39 2.11.2 API version 2................................... 39 2.12 Installation from the source tar file........................... 40 2.12.1 Manual installation on rpm-based Linux distributions............ 40 2.12.2 Manual installation on deb-based Linux distributions............ 41 2.12.3 Validating manual installation.......................... 42 2.13 OAuth2 authorization................................... 43 2.13.1 Before running OAuth2............................. 43 2.14 Multi-user interface.................................... 44 2.14.1 Multi-user interface setup in steps....................... 47 2.15 Autochanger management................................ 50 2.16 Screenshots........................................ 50 Appendices 59 A Acronyms 61 Index............................................ 63 Bacula Community Edition v.11.0.4 (29 May 2021) iii/65 All trademarks are the property of their respective owners Console and Operators Guide CONTENTS iv/65 Bacula Community Edition v.11.0.4 (29 May 2021) All trademarks are the property of their respective owners Running the Console Program Console and Operators Guide Chapter 1 Bacula Enterprise Console The Console (sometimes called the User Agent) is a program that allows the user or the System Administrator, to interact with the Director daemon while the daemon is running. The current Console comes in two versions: a shell interface (TTY style), and a QT GUI interface (BAT). Both permit the administrator or authorized users to interact with Bacula. You can determine the status of a particular job, examine the contents of the Catalog as well as perform certain tape manipulations with the Console program. Since the Console program interacts with the Bacula Director through the network, your Console and Director programs do not necessarily need to run on the same machine. In fact, a certain minimal knowledge of the Console program is needed in order for Bacula to be able to write on more than one tape, because when Bacula requests a new tape, it waits until the user, via the Console program, indicates that the new tape is mounted. 1.1 Console Configuration When the Console starts, it reads a standard Bacula configuration file named bconsole.conf or bat.conf in the case of the BATQT Console version from the current directory unless you specify the -c command line option (see below). This file allows default configuration of the Console, and at the current time, the only Resource Record defined is the Director resource, which gives the Console the name and address of the Director. For more information on configuration of the Console program, please see the Console Configuration chapter (chapter 26 page 337) of the Bacula Community Edition Main manual. 1.2 Running the Console Program The Bacula Console program can be run with the following options: Usage: bconsole [-s] [-c config_file] [-d debug_level] -c <file> set configuration file to file -dnn set debug level to nn -n no conio -s no signals -u <nn> set command execution timeout to <nn> seconds -t test - read configuration and exit -? print this message. After launching the Console program (bconsole), it will prompt you for the next command Bacula Community Edition v.11.0.4 (29 May 2021) 1/65 All trademarks are the property of their respective owners Console and Operators Guide Alphabetic List of Console Keywords with an asterisk (*). Generally, for all commands, you can simply enter the command name and the Console program will prompt you for the necessary arguments. Alternatively, in most cases, you may enter the command followed by arguments. The general format is: <command> <keyword1>[=<argument1>] <keyword2>[=<argument2>] ... where command is one of the commands listed below; keyword is one of the keywords listed below (usually followed by an argument); and argument is the value. The command may be abbreviated to the shortest unique form. If two commands have the same starting letters, the one that will be selected is the one that appears first in the help listing. If you want the second command, simply spell out the full command. None of the keywords following the command may be abbreviated. For example: list files jobid=23 will list all files saved for JobId 23. Or: show pools will display all the Pool resource records. The maximum command line length is limited to 511.... characters, so if you are scripting the console, you may need to take some care to limit the line length. 1.3 Stopping the Console