Bconsole
Bconsole Command
A single bconsole command can be written as:
:bcommand:`help configure`
The output should look like this:
help configure
Bconsole session
If you want to show complete Bareos console session, then it needs to be put in a code block.
.. code-block:: bconsole
:caption: Example: adding a client and a job resource during runtime
*<input>configure add client name=client2-fd address=192.168.0.2 password=secret</input>
Created resource config file "/etc/bareos/bareos-dir.d/client/client2-fd.conf":
Client {
Name = client2-fd
Address = 192.168.0.2
Password = <strong>secret</strong>
}
*<input>configure add job name=client2-job client=client2-fd jobdefs=DefaultJob</input>
Created resource config file "/etc/bareos/bareos-dir.d/job/client2-job.conf":
Job {
Name = client2-job
Client = client2-fd
JobDefs = DefaultJob
}
The output will look like this:
*configure add client name=client2-fd address=192.168.0.2 password=secret
Created resource config file "/etc/bareos/bareos-dir.d/client/client2-fd.conf":
Client {
Name = client2-fd
Address = 192.168.0.2
Password = secret
}
*configure add job name=client2-job client=client2-fd jobdefs=DefaultJob
Created resource config file "/etc/bareos/bareos-dir.d/job/client2-job.conf":
Job {
Name = client2-job
Client = client2-fd
JobDefs = DefaultJob
}
A prompt is indicated by ‘’*’’.
To indicate user input, use the <input> decoration:
<input>some user input here</input>
It will be highlighted in the output.
It is only possible, to use the <strong> decoration, to highlight something, that is not a user input. In our example, the password is highlighted.