Veritas NetBackup™ for MariaDB Administrator's Guide

Last Published:
Product(s): NetBackup (8.2)

The nbmariadb.conf configuration file

The NetBackup for MariaDB (nbmariadb.conf) configuration file contains the parameters for the respective operations. It contains predefined settings and is located on the client. You can configure the parameters in the nbmariadb.conf file or provide them on the command line, where the command line parameters take precedence.

The nbmariadb.conf file keeps you from providing the parameters every time you run operations. When parameters are not configured in the nbmariadb.conf file, then the default parameter value takes precedence.

The nbmariadb.conf file is located in the following locations:

  • (Windows)

    C:\Program Files\Veritas\NBMariaDBAgent\nbmariadb.conf .

  • (Linux RHEL and SUSE) /usr/NBMariaDBAgent\nbmariadb.conf

Creating the nbmariadb configuration file

Starting from NetBackup 8.2, the nbmariadb.conf file is not created by default when you install the agent on RHEL or SUSE. The existing configuration file is prevented from getting overwritten as the RPM installer simply overwrites any existing files in the destination directory /usr/NBMariaDBAgent/.

If the nbmariadb.conf file does not exist, you can create the file by running the backup utility command without any options. For example, run the ./nbmariadb command. This command creates the default nbmariadb.conf file.

Table: The nbmariadb.conf file parameters lists the nbmariadb.conf file parameters:

Table: The nbmariadb.conf file parameters

Parameters

Description

Required parameter for

Default value

DB_PORT

Configures the MariaDB database server port number on which the backup or the restore should be performed. The port number verifies the MariaDB service status.

Backups and restores

When you do not specify the port number, the default is 3306.

DB_USER

Configures the MariaDB database user name.

Backups

When you do not specify the username, the default is root.

MARIADB_LIB_INSTALL_PATH

(Linux) Configures the libmariadb.so binary path.

Backups

No default value.

MASTER_SERVER_NAME

Specifies the NetBackup master server to run backups, restores query and delete the backups and restores.

Backups, restores, query, and delete.

No default value.

POLICY_NAME

Specifies the DataStore policy name.

Backups

No default value.

SCHEDULE_NAME

Identifies the backup schedule that you configured while creating the DataStore policy.

Backups

No default value.

CLIENT_NAME

Defines the NetBackup MariaDB client name.

Redirected restores and query

When you do not specify the client name, the default is NetBackup master server.

SNAPSHOT_SIZE

(Linux) Specifies the snapshot size for LVM snapshots. Specify the snapshot size in kilobytes, megabytes, or gigabytes as KB, MB, or GB respectively.

LVM backups

When you do not specify the snapshot size, the default is MB.

DB_BACKUP_ID

DB_BACKUP_ID is the backup image name. This parameter configures the backup file that you specify using the backup id.

To delete a backup by specifying its backup image name.

No default value.

MARIADB_TARGET_DIRECTORY

Specifies the destination directory where you want to restore the backups.

Restores

No default value.

NBMARIADB_LOG_LEVEL

The NBMARIADB_LOG_LEVEL parameter lets you set the logging level for the nbmariadb logs. For a particular logging level, all details at that level or lower are logged.

The nbmariadb debug logs includes the following verbose levels:

  • 1 - ERROR: Conditions that should be corrected, such as configuration errors.

  • 2 - WARN: Conditions that are not errors, but that might require special handling.

  • 3 - INFO: Informational messages

  • 4 - DEBUG: Debugging the messages that is used for troubleshooting.

The log levels help to control the amount of information that you want to access for troubleshooting errors.

When you do not specify the nbmariadb log level, the default is log level 1.

NBMARIADB_LOG_SIZE

Specifies the nbmariadb log size in MB. The default size is 10MB. When the log reaches the specified size, it overwrites the existing log information.

You can specify the value according to the events that you want to write into the logs.

When you do not specify the nbmariadb log size, the default is 10MB.