Veritas Netbackup™ For Sqlite Administrator'S Guide: Windows and Linux
Veritas Netbackup™ For Sqlite Administrator'S Guide: Windows and Linux
Veritas Netbackup™ For Sqlite Administrator'S Guide: Windows and Linux
SQLite Administrator's
Guide
Release 9.0
Veritas NetBackup™ for SQLite Administrator's Guide
Last updated: 2020-12-14
Legal Notice
Copyright © 2020 Veritas Technologies LLC. All rights reserved.
Veritas, the Veritas Logo, and NetBackup are trademarks or registered trademarks of Veritas
Technologies LLC or its affiliates in the U.S. and other countries. Other names may be
trademarks of their respective owners.
This product may contain third-party software for which Veritas is required to provide attribution
to the third party (“Third-party Programs”). Some of the Third-party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the Third-party Legal Notices document accompanying this
Veritas product or available at:
https://www.veritas.com/about/legal/license-agreements
The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.
http://www.veritas.com
Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:
https://www.veritas.com/support
You can manage your Veritas account information at the following URL:
https://my.veritas.com
If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:
Japan CustomerCare_Japan@veritas.com
Documentation
Make sure that you have the current version of the documentation. Each document displays
the date of the last update on page 2. The latest documentation is available on the Veritas
website:
https://sort.veritas.com/documents
Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:
NB.docs@veritas.com
You can also see documentation information or ask a question on the Veritas community site:
http://www.veritas.com/community/
https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
Contents
Index .................................................................................................................... 38
Chapter 1
Introduction to NetBackup
for SQLite Agent
This chapter includes the following topics:
Note: Ensure that the SQLite agent and NetBackup are of same version for
successful backup and restore operations.
Feature Description
Backup The agent supports single file based backups of the SQLite database.
Redirected The agent supports to restore the SQLite backup files to alternate
Restores NetBackup clients.
Step Action
For more information, See “Verifying the operating systems and platforms ”
on page 10.
Installing the NetBackup for SQLite Agent 10
Verifying the operating systems and platforms
Step Action
For more information, See “Installing prerequisites for NetBackup for SQLite
Agent” on page 10.
For more information, See “Installing the NetBackup for SQLite Agent”
on page 12.
Note: Users without root-access, must have read, write, and execute permissions
for the NBSQLiteAgent directory.
■ NBSQLiteAgent_8.2_AMD64/cab1.cab
■ NBSQLiteAgent_8.2_AMD64/Setup.exe
■ NBSQLiteAgent_8.2_AMD64/NBSQLiteAgent.msi
■ VRTSnbsqliteagent.rpm
When you install the agent, accept the VERITAS LICENSE AGREEMENT to proceed
with installing the agent successfully.
The agent by default gets installed at the following locations:
■ (Windows) C:\Program Files\VERITAS\NBSQLiteAgent
■ (Linux RHEL & SUSE) /usr/NBSQLiteAgent/
If the nbsqlite.conf file does not exist, you can create the file by running the
backup utility command without any options. For example, run the ./nbsqlite
command. This command creates the default nbsqlite.conf file.
Table 3-1 lists the parameters for the operations.
MASTER_SERVER_NAME Specifies the NetBackup Backups, restores, No default value for this
master server to the nbsqlite query, and delete. parameter.
operations.
POLICY_NAME Specifies the DataStore policy Backups No default value for this
name. parameter.
SCHEDULE_NAME Identifies the backup schedule Backups No default value for this
that you configured when parameter.
creating the DataStore policy.
CLIENT_NAME Defines the NetBackupclient Redirected restores When you do not set this
that has the agent. and query parameter, it defaults to the
NetBackup master server.
SNAPSHOT_SIZE (Linux) Specifies the snapshot LVM backups When you do not set this
size for LVM snapshots in parameter, it defaults to MB.
kilobytes, megabytes, or
gigabytes in KB, MB, or GB
respectively.
DB_BACKUP_ID Represents the backup image To delete and restore No default value for this
name. This parameter a backup file by parameter.
configures the backup file that specifying the backup
you specify using the backup image name.
image name.
NBSQLITE_LOG_LEVEL The NBSQLITE_LOG_LEVEL The log levels help to When you do not set this
parameter lets you set the control the amount of value, it defaults to log level
logging level for the nbsqlite information that you 1.
logs. For a particular logging want to access for
level, all details at that level or troubleshooting errors.
lower are logged.
The nbsqlite 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 are used for
troubleshooting.
NBSQLITE_LOG_SIZE Specifies the nbsqlite log You can specify the When you do not set this
size in MB. When the log value according to the parameter, it defaults to
reaches the specified size, it events that you want 10MB.
overwrites the existing log to write into the logs.
information.
Note: The XBSA framework supports the Application Backup schedule type
only.
8 Under the Clients tab, click New and then add the NetBackup client that has
the NetBackup for SQLite Agent.
9 In the Add Client screen, click New, and then in the Client Name field, type
the name of the client.
10 In the NetBackup Administration Console, click NetBackup Management
> Policies to view the policy in the existing policies list.
11 Verify the settings in the nbsqlite.conf file before you run the backup.
12 For more information, See “The nbsqlite.conf configuration file” on page 14.
Note: Ensure that the SQLite agent and NetBackup are of same version for
successful backup and restore operations.
Chapter 4
NetBackup for SQLite
backup and restore
This chapter includes the following topics:
■ Redirected restores
■ Disaster recovery
Note: Ensure that the SQLite agent and NetBackup are of same version for
successful backup and restore operations.
SQLite Database
server Sends SQLite data for
back up
Requests snapshot, reads and
mounts snapshot, reads the NetBackup SQLite 3 NetBackup
SQLite data agent master server
2 5
Snapshot Back up status is
creation returned
NetBackup
media server
NetBackup client
NetBackup XBSA
SQLite data is
VSS/LVM Snapshot 4 backed up
Storage unit
Note: Ensure that the snapshot size is 110% of the file size that you want to
backup.
To run backup
1 Configure the parameters in the nbsqlite.conf file or on the nbsqlite
command line.
2 Run the following command:
nbsqlite -o backup
-S master_server_name
-P policy_name
-s schedule_name
(Linux) -z snapshot_size
-d sqlitedb_db_path
NetBackup for SQLite backup and restore 21
Validating the backup information
Note: Ensure that the SQLite agent and NetBackup are of same version for
successful backup and restore operations.
Before you run a query, set the following parameters in the nbsqlite.conf file or
provide on the command line:
■ CLIENT_NAME
■ POLICY_NAME
■ MASTER_SERVER_NAME
To query backup
1 Configure the parameters in the nbsqlite.conf file or on the nbsqlite
command line.
2 Run the following command:
nbsqlite -o query -S master_server_name [-C ClientA] [-P
policy_name]
For example, to query a backup from the client ClientA, run the following command:
NetBackup for SQLite backup and restore 22
Deleting backup information from the NetBackup catalog files
For example, to list backup files with the policy name policy_name, run the following
command:
nbsqlite -o query -S master_server_name [-P policy_name]
For example, to query a backup from the client ClientA with policy name
policy_name, run the following command:
Prerequisites
Before you delete the backups, set the following parameter in the nbsqlite.conf
file or provide them on the command line:
■ DB_BACKUP_ID
■ MASTER_SERVER_NAME
To delete backup
1 Configure the parameters, in the nbsqlite.conf file or provide on the command
line.
2 Run the following command:
nbsqlite -o delete -S master_server_name -id db_backup_image_name
Note: Ensure that the SQLite agent and NetBackup are of same version for
successful backup and restore operations.
Read progress
file
2
Progress file
NetBackup
media server
NetBackup client
NetBackup XBSA
Storage unit
■ DB_BACKUP_ID
■ TARGET_DIRECTORY
■ MASTER_SERVER_NAME
To restore backup
1 Configure the parameters in the nbsqlite.conf file, or provide them on the
command line.
2 Run the following command:
nbsqlite -o restore -S master_server_name -t target_directory
[-id db_backup_image_name][-C client_name]
Redirected restores
Redirected restores lets you restore backup files to a client different from the client
that originally performed the backup. The new location can be a different host or a
different file path using a different name for the redirected restore. To redirect a
restore to a different host, include the destination client name in the
install_path\NetBackup\db\altnames directory.
Note: Ensure that the SQLite agent and NetBackup are of same version for
successful backup and restore operations.
NetBackup for SQLite backup and restore 25
Disaster recovery
3 In the altnames directory, add the names of the client(s) whose files the
requesting client wants to restore. For example, if you want Host B to have
permissions to redirect restores from Host A, add Host A to the Host B file.
4 Run the following command:
nbsqlite -o restore -S master_server_name -t target_directory -id
db_backup_image_name] [-C client_name]
5 After a successful redirected restore, undo the changes that you made on the
master server and the client.
Disaster recovery
Disaster recovery is a plan to recover the data that can get lost in a disaster event.
The agent supports redirected restore as a disaster recovery strategy.
For more information, See “Redirected restores” on page 24.
Chapter 5
Troubleshooting for
NetBackup for SQLite
This chapter includes the following topics:
Step1 Remember the error message. Error messages are usually the vehicles for telling you
something went wrong. If you do not see an error on the
command line, but still suspect a problem, check the logs
and the reports. These can provide an error message that
directly points to the problem. The logs and reports are
essential troubleshooting tools.
Troubleshooting for NetBackup for SQLite 27
Troubleshooting errors when using NetBackup for SQLite Agent
Step2 Identify what you were doing Ask the following questions:
when the problem occurred.
■ What operation was tried?
■ What method did you use?
■ What type of server platform and operating system was
involved?
■ If your site uses both master server and media server,
was it a master server or a media server?
■ If a client was involved, what type of client was it?
■ Have you performed the operation successfully in the
past? If so, what is different now?
■ What is the service pack level?
■ Do you use operating system software with the latest
fixes supplied, especially those required for use with
NetBackup?
■ Is your device firmware at a level, or higher than the
level, at which it has been tested according to the posted
device compatibility lists?
Step4 Correct the problem. After you define the problem, use the information to correct
it.
Step5 Contact Technical Support If you cannot solve the error, contact the Technical support.
■ install_path\NetBackup\logs\bpcd
■ install_path\NetBackup\logs\user_ops\dbext\logs
You must enable the bprd and the bpcd log files. For more information, see the
NetBackup Troubleshooting Guide
Troubleshooting for NetBackup for SQLite 28
Troubleshooting errors when using NetBackup for SQLite Agent
The logs that are specific to the NetBackup for SQLite Agent are located at:
■ install_path\nbsqlite.log
The logs that are specific to NetBackup XBSA are located at:
■ <NetBackup_install_path>/netbackup/logs/exten_client
The nbsqlite backup fails with The nbsqlite backup fails if the To run a nbsqlite backup successfully:
the following error: user environment variable path
■ Update the user environment variable path
is not updated with NetBackup
Unable to load xbsa.dll with NetBackup_install_path/bin.
bin directory.
The nbsqlite backup fails with The backup may fail when the Verify that you configure the valid master server
status code:7648 host validation fails for secure name and the host name.
connection.
The nbsqlite backup fails with The nbsqlite backup fails if the To run the backup successfully
the following error: nbsqlite.conf file is not
■ Configure the valid master server name,
updated with the required
XBSA initiation failed policy name, schedule type in the
parameters.
nbsqlite.conf file or from the command
line.
■ Verify for communication errors between the
nbsqlite agent and the NetBackup master
server. For more information see the
NetBackup Administration guide.
(Windows)VSS snapshot creation The nbsqlite backup may fail Run cmd.exe in Administrator mode.
failed when the user does not have the
privileges to run the nbsqlite
operations.
Troubleshooting for NetBackup for SQLite 29
Troubleshooting errors when using NetBackup for SQLite Agent
The nbsqlite restore operation The nbsqlite restore fails if the For a successful restore
does not restore any data from the nbsqlite.conf file is not
■ Initiate the restore from the NetBackup
target NetBackup client. updated with the NetBackup
source client.
client name and the target
■ Set the NetBackup client name and target
directory.
directory parameters in the nbsqlite.conf
file.
The nbsqlite backup fails with The nbsqlite backup may fail To verify the space in the volume group,
the following error: when the volume group does not use the following command:
have sufficient space for the
(Linux) Error creating LVM 1 $vgs
snapshot.
snapshot
The command displays the volume group
details.
Error messages after a successful The nbsqlite backup gives To remove the snapshots
backup: these errors when the volume
1 To list the existing snapshot, run the
group contains the snapshots.
<volume_group>/<snapshot_name> following command:
You can list the snapshots and
Read failure after 0 of 4096 at
then remove them before you run $lvs
29393616896: input or output
the backup again.
error. The command displays the snapshot
details.
OR
2 To remove the snapshots, run the following
<volume_group>/<snapshot_name>:
command:
read failure after 0 of 4096 at
4096: input or output error. $ lvremove -f
<volume_group>/<snapshot_name>
Troubleshooting for NetBackup for SQLite 30
Troubleshooting errors when using NetBackup for SQLite Agent
The nbsqlite backup on Linux The nbsqlite backup fails To unmount the snapshot
(LVM), fails with the following during an attempt to unmount the
1 List all mounted file systems using the
error: snapshot, the device, or when
following command:
you remove the existing
Error unmounting the
snapshots. $ mount-l
snapshot-Device or resource busy
2 If the snapshot still exists, run the following
OR
command:
Error removing the
$unmount<mount_directory>
snapshot-sqlitesnap_<timestamp>
Note: This directory is created in
/mnt/<snapshot_name>. The prefix
names for snapshot is sqlitesnap.
1vremove -f
<volume_group>/<snapshot_name>
The nbsqlite.conf file is Starting from NetBackup 8.2, the If the nbsqlite.conf file does not exist, you
missing after installing the agent nbsqlite.conf file is not can create the file by running the backup utility
on RHEL or SUSE created by default when you command without any options. For example,
install the agent on RHEL or run the ./nbsqlite command. This command
SUSE. The existing configuration creates the default nbsqlite.conf file.
file is prevented from getting
overwritten as the RPM installer
simply overwrites any existing
files in the destination directory
/usr/NBSQLiteAgent/.
Appendix A
NetBackup for SQLite
commands and
conventions
This appendix includes the following topics:
■ Brackets [ ] indicate that the enclosed component of the command line is optional.
Other parameters are required.
■ Italics indicate that the information is user supplied. For example, you may
provide the policy name and the schedule name for a backup operation.
nbsqlite -o backup -S master_server_name -P policy_name -s
schedule_name
Option Description
-h Displays the Help usage, when it is the only option on the nbsqlite
command line.
-id Configures the specified backup using the backup image name.
■ nbsqlite -o backup
■ nbsqlite -o restore
■ nbsqlite -o query
■ nbsqlite -o delete
NetBackup for SQLite commands 34
nbsqlite -o backup
nbsqlite -o backup
nbsqlite -o backup – runs the backup operation from the NetBackup client.
SYNOPSIS
nbsqlite -o backup
-S master_server_name
-P policy_name
-s schedule_name
(LVM) -z snapshot_size
[-d sqlite_db_path]
Description
This command invokes the backup operation from the NetBackup client using the
NetBackup DataStore policy name and the schedule type. The parameter -S, -d,
and -P are required parameters for Windows. The parameter -z is required
parameters for LVM users.
On Windows, the directory path is install_path\NBSQLiteAgent\
On Linux systems, the directory path is /usr/NBSQLiteAgent/
Options
-d Configures the path to connect to the SQLite database.
-P Configures the NetBackup DataStore policy name.
-S Configures the NetBackup server name.
-s Specifies the schedule name that you have configure for the DataStore policy.
-z (LVM backups) Specifies the LVM snapshot size.
NetBackup for SQLite commands 35
nbsqlite -o restore
nbsqlite -o restore
nbsqlite -o restore – restores the backup files from the NetBackup server.
SYNOPSIS
nbsqlite -o restore
-S master_server_name
-t target_directory
[-id db_backup_id]
[-C NetBackup_client_name]
Description
The nbsqlite command restores the backup file using -t and -S as the required
parameters. The -id and -C are optional parameters.
On Windows systems, the directory path to this command is
install_path\NBSQLiteAgent\
Options
-C Specifies the client name.
-id
Specifies the backup image name.
-S Configures the NetBackup server name.
-t Specifies the target directory.
NetBackup for SQLite commands 36
nbsqlite -o query
nbsqlite -o query
nbsqlite -o query – queries the backups performed for SQLite database.
SYNOPSIS
nbsqlite - o query
-S master_server_name
[-P policy_name]
[-C client_name]
Description
The nbsqlite -o query command gets the backup using -S as the required
parameter and -C and -P as optional parameters.
On Windows systems, the directory path to this command is
install_path\NBSQLiteAgent\
Options
-C Retrieves and lists all the backups of the specified client.
-P Retrieves and lists all backups with the specified policy name.
-S Configures the NetBackup master server.
NetBackup for SQLite commands 37
nbsqlite -o delete
nbsqlite -o delete
nbsqlite -o delete – deletes the backup information from the NetBackup catalog
files.
SYNOPSIS
nbsqlite - o delete
-S master_server_name
-id db_backup-id
Description
The nbsqlite -o delete command deletes the backup information from the
NetBackup catalog files, but retains the backups in the storage media.
The parameter -S and -id are the required parameters.
Options
-id
Specifies the backup using the backup image name.
-S Configures the NetBackup master server.
Index
B O
backup operations 14
backup image 19 optional parameters 14
backup information 19
delete 19 P
LVM configured systems 19
package 11
parameter 19
platform files 11
validate 19
platforms 10
backup schedule 14
POLICY_NAME 14
precedence 14
C prerequisites 10
CLIENT_NAME 14
S
D SCHEDULE_NAME 14
DataStore policy 16 single file 7
DB_BACKUP_ID 14 snapshot 7
Default Application Backup 16 SNAPSHOT_SIZE 14
default location 12 SQLITE_TARGET_DIRECTORY 14
I
installing 9
L
license 8
LOG _LEVEL 14
LOG_SIZE 14
N
nbsqlite.conf 7
nbsqlite.conf file
client 14
command line 14
configure 14
default 14
locations 14
parameters 14
pre-defined settings 14
required parameters 14