Console Configuration
Keywords: main

Subsections

- General
- The Director Resource
- The ConsoleFont Resource
- The Console Resource
- Console Commands
- Sample Console Configuration File

#
Console Configuration

# General

The Console configuration file is the simplest of all the configuration files, and in general, you should not need to change it except for the password. It simply contains the information necessary to contact the Director or Directors.

For a general discussion of the syntax of configuration files and their resources including the data types recognized by Bacula, please see the ConfigurationConfigureChapter chapter of this manual.

The following Console Resource definition must be defined:

#
The Director Resource

The Director resource defines the attributes of the Director running on the network. You may have multiple Director resource specifications in a single Console configuration file. If you have more than one, you will be prompted to choose one when you start the Console program.

Director
  Start of the Director directives.

Name = name
  The director name used to select among different Directors, otherwise, this name is not used.

DIRPort = port-number
  Specify the port to use to connect to the Director. This value will most likely already be set to the value you specified on the `--`with-baseport option of the ./configure command. This port must be identical to the DIRport specified in the Director resource of the Director's configurationDirectorChapter file. The default is 9101 so this directive is not normally specified.

Address = address
  Where the address is a host name, a fully qualified domain name, or a network address used to connect to the Director.

Password = password
  Where the password is the password needed for the Director to accept the Console connection. This password must be identical to the Password specified in the Director resource of the Director's configurationDirectorChapter file. This directive is required.

An actual example might be:

    Director {
      Name = HeadMan
      address = rufus.cats.com
      password = xyz1erploit
    }

# The ConsoleFont Resource

The ConsoleFont resource is available only in the GNOME version of the console. It permits you to define the font that you want used to display in the main listing window.

ConsoleFont
  Start of the ConsoleFont directives.

Name = name
  The name of the font.

Font = Pango Font Name
  The string value given here defines the desired font. It is specified in the Pango format. For example, the default specification is:

      Font = "LucidaTypewriter 9"

Thanks to Phil Stracchino for providing the code for this feature.

An different example might be:

    ConsoleFont {
      Name = Default
      Font = "Monospace 10"
    }

#
The Console Resource

There are three different kinds of consoles, which the administrator or user can use to interact with the Director. These three kinds of consoles comprise three different security levels.

- The first console type is an anonymous or default console, which has full privileges. There is no console resource necessary for this type since the password is specified in the Director resource. Typically you would use this anonymous console only for administrators.

- The second type of console is a "named" or "restricted" console defined within a Console resource in both the Director's configuration file and in the Console's configuration file. Both the names and the passwords in these two entries must match much as is the case for Client programs.

  This second type of console begins with absolutely no privileges except those explicitly specified in the Director's Console resource. Note, the definition of what these restricted consoles can do is determined by the Director's conf file.

  Thus you may define within the Director's conf file multiple Consoles with different names and passwords, sort of like multiple users, each with different privileges. As a default, these consoles can do absolutely nothing - no commands what so ever. You give them privileges or rather access to commands and resources by specifying access control lists in the Director's Console resource. This gives the administrator fine grained control over what particular consoles (or users) can do.

- The third type of console is similar to the above mentioned restricted console in that it requires a Console resource definition in both the Director and the Console. In addition, if the console name, provided on the Name = directive, is the same as a Client name, the user of that console is permitted to use the SetIP command to change the Address directive in the Director's client resource to the IP address of the Console. This permits portables or other machines using DHCP (non-fixed IP addresses) to "notify" the Director of their current IP address.

The Console resource is optional and need not be specified. However, if it is specified, you can use ACLs (Access Control Lists) in the Director's configuration file to restrict the particular console (or user) to see only information pertaining to his jobs or client machine.

You may specify as many Console resources in the console's conf file. If you do so, generally the first Console resource will be used. However, if you have multiple Director resources (i.e. you want to connect to different directors), you can bind one of your Console resources to a particular Director resource, and thus when you choose a particular Director, the appropriate Console configuration resource will be used. See the "Director" directive in the Console resource described below for more information.

Note, the Console resource is optional, but can be useful for restricted consoles as noted above.

Console
  Start of the Console resource.

Name = name
  The Console name used to allow a restricted console to change its IP address using the SetIP command. The SetIP command must also be defined in the Director's conf CommandACL list.

Password = password
  If this password is supplied, then the password specified in the Director resource of you Console conf will be ignored. See below for more details.

Director = director-resource-name
  If this directive is specified, this Console resource will be used by bconsole when that particular director is selected when first starting bconsole. I.e. it binds a particular console resource with its name and password to a particular director.

Heartbeat Interval = time-interval
  This directive is optional and if specified will cause the Console to set a keepalive interval (heartbeat) in seconds on each of the sockets to communicate with the Director. It is implemented only on systems (Linux, ...) that provide the setsockopt TCP_KEEPIDLE function. The default value is zero, which means no change is made to the socket.

The following configuration files were supplied by Phil Stracchino. For example, if we define the following in the user's bconsole.conf file (or perhaps the bwx-console.conf file):

    Director {
       Name = MyDirector
       DIRport = 9101
       Address = myserver
       Password = "XXXXXXXXXXX"    # no, really.  this is not obfuscation.
    }

    Console {
       Name = restricted-user
       Password = "UntrustedUser"
    }

Where the Password in the Director section is deliberately incorrect, and the Console resource is given a name, in this case restricted-user. Then in the Director's bacula-dir.conf file (not directly accessible by the user), we define:

    Console {
      Name = restricted-user
      Password = "UntrustedUser"
      JobACL = "Restricted Client Save"
      ClientACL = restricted-client
      StorageACL = main-storage
      ScheduleACL = *all*
      PoolACL = *all*
      FileSetACL = "Restricted Client's FileSet"
      CatalogACL = DefaultCatalog
      CommandACL = run
    }

the user logging into the Director from his Console will get logged in as restricted-user, and he will only be able to see or access a Job with the name Restricted Client Save a Client with the name restricted-client, a Storage device main-storage, any Schedule or Pool, a FileSet named Restricted Client's FileSet, a Catalog named DefaultCatalog, and the only command he can use in the Console is the run command. In other words, this user is rather limited in what he can see and do with Bacula.

The following is an example of a bconsole conf file that can access several Directors and has different Consoles depending on the director:

    Director {
       Name = MyDirector
       DIRport = 9101
       Address = myserver
       Password = "XXXXXXXXXXX"    # no, really.  this is not obfuscation.
    }

    Director {
       Name = SecondDirector
       DIRport = 9101
       Address = secondserver
       Password = "XXXXXXXXXXX"    # no, really.  this is not obfuscation.
    }

    Console {
       Name = restricted-user
       Password = "UntrustedUser"
       Director = MyDirector
    }

    Console {
       Name = restricted-user
       Password = "A different UntrustedUser"
       Director = SecondDirector
    }

The second Director referenced at "secondserver" might look like the following:

    Console {
      Name = restricted-user
      Password = "A different UntrustedUser"
      JobACL = "Restricted Client Save"
      ClientACL = restricted-client
      StorageACL = second-storage
      ScheduleACL = *all*
      PoolACL = *all*
      FileSetACL = "Restricted Client's FileSet"
      CatalogACL = RestrictedCatalog
      CommandACL = run, restore
      WhereACL = "/"
    }

# Console Commands

For more details on running the console and its commands, please see the Bacula Console_ConsoleChapter chapter of this manual.

#
Sample Console Configuration File

An example Console configuration file might be the following:

    #
    # Bacula Console Configuration File
    #
    Director {
      Name = HeadMan
      address = "my_machine.my_domain.com"
      Password = Console_password
    }