NetBackup™ for

PostgreSQL Administrator's
Guide

Windows and Linux

Release 10.4
NetBackup™ for PostgreSQL Administrator's Guide
Last updated: 2024-03-26

Legal Notice
Copyright © 2024 Veritas Technologies LLC. All rights reserved.

Veritas, the Veritas Logo, Veritas Alta, 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 DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED

CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED
WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH
DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. Veritas Technologies LLC SHALL
NOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN CONNECTION
WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE
INFORMATION CONTAINED IN THIS DOCUMENTATION IS SUBJECT TO CHANGE
WITHOUT NOTICE.

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.

Veritas Technologies LLC

2625 Augustine Drive
Santa Clara, CA 95054

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:

Worldwide (except Japan) [email protected]

Japan [email protected]

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:

[email protected]

You can also see documentation information or ask a question on the Veritas community site:

http://www.veritas.com/community/

Veritas Services and Operations Readiness Tools (SORT)

Veritas Services and Operations Readiness Tools (SORT) is a website that provides information
and tools to automate and simplify certain time-consuming administrative tasks. Depending
on the product, SORT helps you prepare for installations and upgrades, identify risks in your
datacenters, and improve operational efficiency. To see what services and tools SORT provides
for your product, see the data sheet:

https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
 Contents

Chapter 1 Introduction to NetBackup for PostgreSQL ................ 6

Features supported by NetBackup for PostgreSQL ............................... 6

Prerequisites for NetBackup for PostgreSQL ....................................... 6
Post-installation requirements for NetBackup ................................. 7
Authenticating the PostgreSQL environment password ......................... 7

Chapter 2 Configuring NetBackup for PostgreSQL ...................... 9

Configuring PostgreSQL backups with DataStore policies ...................... 9

Chapter 3 NetBackup for PostgreSQL backup and restore

........................................................................................... 11

About PostgreSQL backups ............................................................ 11

The postgresql.conf configuration file .......................................... 14
Performing PostgreSQL backups ..................................................... 14
Validating the PostgreSQL backups ................................................. 16
Querying the PostgreSQL backups .................................................. 16
Deleting backup information from the NetBackup catalog files ............... 16
About PostgreSQL restore ............................................................. 17
Performing the PostgreSQL restores ................................................ 18
Redirected restores ...................................................................... 19
Recovering the restores ................................................................. 20
Disaster recovery ......................................................................... 22

Chapter 4 Troubleshooting for PostgreSQL .................................. 23

Troubleshooting errors when using NetBackup for PostgreSQL ............. 23

Appendix A NetBackup for PostgreSQL commands and

conventions ................................................................... 29
About NetBackup for PostgreSQL commands .................................... 29
NetBackup for PostgreSQL Agent command conventions ..................... 30

Appendix B NetBackup for PostgreSQL commands ...................... 32

 Contents 5

nbpgsql -o backup ........................................................................ 33

nbpgsql -o restore ........................................................................ 35
nbpgsql -o query .......................................................................... 36
nbpgsql -o delete ......................................................................... 37

Index .................................................................................................................... 38
 Chapter 1
Introduction to NetBackup
for PostgreSQL
This chapter includes the following topics:

■ Features supported by NetBackup for PostgreSQL

■ Prerequisites for NetBackup for PostgreSQL

■ Authenticating the PostgreSQL environment password

Features supported by NetBackup for PostgreSQL

Table 1-1 lists the features that are supported by the agent.

Table 1-1 Features of NetBackup for PostgreSQL

Features Description

Backup The agent supports full instance backups of the PostgreSQL database.

Restore The agent supports full instance restores of PostgreSQL backups.

Redirected restore The agent supports restoring PostgreSQL backups to alternate

NetBackup clients.

Prerequisites for NetBackup for PostgreSQL

Ensure that you meet the following prerequisites:
■ NetBackup is installed and operational on the primary server, media server, and
the client.
■ The PostgreSQL database is installed and operational on the client.
 Introduction to NetBackup for PostgreSQL 7
Authenticating the PostgreSQL environment password

Post-installation requirements for NetBackup

After you install
■ (Windows) Ensure that the user who is performing backups and restores has
administrative privileges.
■ (Linux) Symbolic link: If a symbolic link does not exists, create libpq.so that
points to libpq.so.<n>, where <n> is the PostgreSQL library version. You can
create the symbolic link at your chosen directory.
For example, if the PostgreSQL library version is 5, then the symbolic link
libpq.so points to libpq.so.5.
#ln -s /<pgsql_lib_install_path>/libpq.so.5 libpq.so

■ (Linux) Ensure that the user who is performing backups and restores is a super
user or has superuser privileges.
■ Set the following database user privileges:

Table 1-2 User and the privileges

User Privileges

Backup LOCK TABLES, SELECT FILE, RELOAD, SUPER, UPDATE,

TRIGGER, SHOW, VIEW, EXECUTE, and EVENT.

Restore CREATE, DROP, INDEX, SHUTDOWN, INSERT, ALTER, DELETE,

UPDATE, TRIGGER, SUPER, and CREATE VIEW.

To set the database user privileges, run the following PostgreSQL command:
ALTER USER<db_user> with SUPERUSER

For more information, see PostgreSQL Administrator's Guide.

Authenticating the PostgreSQL environment

password
Authenticating the PostgreSQL environment password keeps you from specifying
the password every time you run a backup. The password file stores the password
and the application picks the password every time you run a backup.

The password file

The password file for Windows is pgpass.conf and for Linux it is .pgpass file.
The password file must contain the lines of the following format:
hostname:port:database:username:password
 Introduction to NetBackup for PostgreSQL 8
Authenticating the PostgreSQL environment password

In Linux, after you edit the .pgpass file, change the .pgpass file permissions.

Authenticating the password on Windows

To authenticate the password
1 Run the following command:
>echo%AppData%

O/P: C:\Users\Administrator\AppData\Roaming

2 Create postgresql directory in C:\Users\Administrator\AppData\Roaming

path.
3 Create pgpass.conf in the postgresql directory.
4 In the pgpass.conf file update the following and then save the file.
hostname:port:database:username:password

For example, localhost:5432:*:postgres:test_123

5 Restart the postgres services.

Authenticating the password on Linux

To authenticate the password
1 Create .pgpass file in the user's home directory.
2 Edit the .pgpass file as:
hostname:port:database_name:username:password

3 To change the .pgpass file permissions, run the following command:

$ chmod 0600 ~/.pgpass
 Chapter 2
Configuring NetBackup for
PostgreSQL
This chapter includes the following topics:

■ Configuring PostgreSQL backups with DataStore policies

Configuring PostgreSQL backups with DataStore

policies
The agent uses the DataStore policies to define the attributes, schedules, clients
list, and backup selections.
To configure the PostgreSQL database backups with DataStore policies,
complete the following steps:
1 Log on to the primary server as an administrator (Windows) or root (Linux).
2 In the NetBackup Administration Console, expand NetBackup Management,
and then click Policies.
3 In All Policies pane, right-click Summary of All Policies, and then click New
Policy.
4 In Add a New Policy dialog box, enter the unique policy name.
5 In the Change Policy dialog box, select DataStore Policy from the Policy
Type drop-down list.
6 From the Policy Storage list, select a disk-based storage unit for storage.
 Configuring NetBackup for PostgreSQL 10
Configuring PostgreSQL backups with DataStore policies

7 To select the schedule type, under the Schedules tab, click OK to select the
Application Backup schedule type.

Note: The XBSA framework supports the Application backup schedule type
only.

8 In the Clients tab, click New and then add the NetBackup client that has the
NetBackup for PostgreSQL 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 Before performing the backup, review the settings in the nbpgsql.conf file.
For more information, see

Note: Ensure that the PostgreSQL agent and NetBackup are of the same version
for successful backup and restore operations.
 Chapter 3
NetBackup for
PostgreSQL backup and
restore
This chapter includes the following topics:

■ About PostgreSQL backups

■ Performing PostgreSQL backups

■ Validating the PostgreSQL backups

■ Querying the PostgreSQL backups

■ Deleting backup information from the NetBackup catalog files

■ About PostgreSQL restore

■ Performing the PostgreSQL restores

■ Redirected restores

■ Recovering the restores

■ Disaster recovery

About PostgreSQL backups

The nbpgsql -o backup command for backup initiates the backup operation using
the -S, -P, and -s as the required parameters. The parameters -l and -z are the
required parameters for Linux operating systems.
 NetBackup for PostgreSQL backup and restore 12
About PostgreSQL backups

After you set the parameters for the backup, the agent reads the parameters and
starts the backup according to the specified parameters. The agent writes the data
that you want to protect into the WAL files.
These WAL files are then archived in the archive directory that you can create at
your chosen location.
When you create the archive or WAL directory, Veritas recommends that you create
outside the data directory.
Ensure that before you run a backup, set the parameters in the postgresql.conf
file to enable WAL archiving.
For more information, see See “The postgresql.conf configuration file” on page 14.
The agent protects the following files:
■ Schema files that are associated with all database tables.
■ Files that are associated with the database tables.
■ Data and index files.

Note: Ensure that the PostgreSQL agent and NetBackup are of the same version
for successful backup and restore operations.
 NetBackup for PostgreSQL backup and restore 13
About PostgreSQL backups

Figure 3-1 NetBackup for PostgreSQL backup workflow

Connect to the PostgreSQL database

and prepare to take a snapshot.
1

PostgreSQL
Database server Sends PostgreSQL
data for back up
Requests snapshot, reads and
mounts snapshot, reads the 3 NetBackup
PostgreSQL data primary server
2 5
Snapshot Back up status is
creation returned

NetBackup
media server

NetBackup XBSA
NetBackup client PostgreSQL data
VSS/LVM Snapshot 4 is backed up

Storage unit

The NetBackup for PostgreSQL workflow

When you run the backup, the NetBackup client (nbpostgresql) connects to the
PostgreSQL database to execute a flush and read only lock on all tables. The
NetBackup client then reads the associated PostgreSQL database files from the
mounted directory and initiates the backup.
The LVM or VSS, creates a snapshot, and mounts the snapshot. The associated
files (whole instance) are archived into file. The NetBackup client copies the archived
file into the XBSA data object and sends to the NetBackup XBSA interface.
The NetBackup XBSA interface writes this data to the mounted media or disk storage
managed by the NetBackup media server.
The command prompt displays the successful completion status of the backup.
The Activity Monitor also displays the status for the backup job.
 NetBackup for PostgreSQL backup and restore 14
Performing PostgreSQL backups

The postgresql.conf configuration file

The postgresql.conf file contains the parameters that you must set to enable
WAL archiving before you run a backup.
Table 3-1 table lists the parameters that you must set to archive the WAL logs.

Table 3-1 The postgres.conf parameters to enable WAL archiving

Parameters Description

wal_level This parameter determines how much information is written to the WAL
files.

archive_mode This parameter enables the archive mode so that the WAL logs get
stored in the archive directory using the archive_command.

archive_timeout This parameter sets the number of seconds after which the log file
segment switches to a new segment.

statement_timeout This parameter aborts any statement that takes more than the set
number of milliseconds.

Performing PostgreSQL backups

This topic lists the prerequisites for the backup, describes the procedure to run a
backup, and the information to schedule the backup from NetBackup.

Prerequisites
Before you run the backup, ensure that you meet the following prerequisites:
■ Ensure that the user has administrator (Windows) or root (Linux) access.
■ (Windows) Set the NetBackup\bin directory in the environment variable.
For example, Path =C:\Program Files\Veritas\Netbackup\bin
■ (Linux) Symbolic link: If a symbolic link does not exists, create the symbolic link
libpq.so and ensure that it points to the valid libpq .so.<n>, where n is the
PostgreSQL library version.
■ Create the archivedir directory and then set the following parameters in the
postgresql.conf file:

■ wal_level = archive

■ archive_mode = on

■ archive_timeout =0
 NetBackup for PostgreSQL backup and restore 15
Performing PostgreSQL backups

■ statement_timeout=0

Note: Ensure that you add the time in milliseconds. The recommended time
is 30000 milliseconds (30 seconds).

■ Mention the following changes for archive_command

■ (Windows)'copy ' "%p" "C:\\archivedir\\%f"'
■ (Linux) test ! -f <archive_path>/%f && cp %p <archive_path>/%f

■ (Linux) After creating the archivedir directory, change the group and ownership
to PostgreSQL user.
■ Restart the PostgreSQL services.
■ Configure PostgreSQL backups with DataStore policies.
For more information, See “Configuring PostgreSQL backups with DataStore
policies” on page 9.
■ Verify the installation prerequisites and the post-installation requirements.
For more information,
For more information, See “Post-installation requirements for NetBackup”
on page 7.
To run the backup
1 Run the following command:
nbpgsql -o backup

-S primary_server

-P policy_name

-s schedule_name

(Linux)-z snapshot_size
(Linux)-l postgresql_library_path
[-portnum db_port]

[-u dbuser]

(Linux)[-b backup_type]
2 (Optional) Type the database password, when the command line prompts for
a password . NetBackup connects to the database and initiates the backup.
 NetBackup for PostgreSQL backup and restore 16
Validating the PostgreSQL backups

Scheduling PostgreSQL backups from NetBackup

You can schedule the PostgreSQL backups from the NetBackup Administration
Console using the DataStore policy to call a backup script.
For more information, see https://www.veritas.com/support/en_US/article.100041371

Validating the PostgreSQL backups

After a successful backup, you can view and verify the backup information using
the following command:
nbpgsql -o query

Querying the PostgreSQL backups

The nbpgsql -o query command lists previously backed up files according to the
options that you specify.
The parameter -S is the required parameter. You can use the -C and -P options to
define a different client and policy.
To query a backup
1 Configure the parameters on the command line.
2 Run the following command:
nbpgsql -o query -S primary_server [-C client_name] [-P
policy_name]

For example, to query a backup from client ClientA, run the following command:
nbpgsql -o query -S primary_server [-C ClientA]

For example, to list backup files with the policy name policy_name, run the following
command:
nbpgsql -o query -S primary_server [-P policy_name]

Deleting backup information from the NetBackup

catalog files
The nbpgsql -o delete command, removes the backup information from the
catalog files but retains the backup files on the NetBackup media server. The
parameter -S is required parameter. You can use the -id option to delete a backup
by specifying its backup image name.
 NetBackup for PostgreSQL backup and restore 17
About PostgreSQL restore

To delete the backup information

1 Configure the parameters on the command line.
2 Run the following command:
nbpgsql -o delete -S primary_server [-id db_backup_id].

About PostgreSQL restore

The nbpgsql -o restore command for restore initiates the restore operation using
-S and -t as the required parameters. The parameters -id and -C are optional
parameters.
The parameter -id restores the backup using the specified backup image name.
The parameter -C lists all the backups that exist on the specified client. When you
do not specify -C, it defaults to NetBackup primary server.

Figure 3-2 NetBackup for PostgreSQL restore workflow

Read progress
file
2

Progress file

Restore Initiate restore

PostgreSQL data NetBackup
1 primary server
4
3
PostgreSQL
Database server Retrieve data
to restore

NetBackup
media server

NetBackup XBSA
NetBackup client

Storage unit
 NetBackup for PostgreSQL backup and restore 18
Performing the PostgreSQL restores

The NetBackup for PostgreSQL restore workflow

After you specify the parameters, the agent reads the command line arguments.
The agent then interacts with the NetBackup XBSA interface to retrieve the backup.
using the specified parameters.
The NetBackup XBSA interface reads the progress files to receive the PostgreSQL
backup files to restore them to the target directory.
The command prompt indicates the successful completion status of the restore.
The Activity Monitor displays the status for the restore job.
In Linux operating systems, after a successful restore, the owner and group of the
restored data defaults to postgres. You must change the ownership to PostgreSQL
user and modify the settings according to your environment.
In Linux operating system, if the data directory contains symbolic link, the backup
does not retain the link information. The symbolic link gets backed up as a normal
data directory and is restored as a normal directory. To restore the link, you must
reconfigure the symbolic link.

Note: Ensure that the target directory is valid and empty.

Prerequisites
Before you run a restore, ensure that you meet the following prerequisites:
■ Ensure that the user has administrator (Windows) or root (Linux) access.
■ (LVM users) Ensure that data logs and the logs directory reside on the logical
volume.

Performing the PostgreSQL restores

To restore the backup
1 Configure the parameters on the command line.
2 Run the following command:
nbpgsql -o restore -S primary_server -t target_directory [-id
db_backup_id] [-C client_name]

Note: Ensure that the PostgreSQL agent and NetBackup are of the same version
for successful backup and restore operations.
 NetBackup for PostgreSQL backup and restore 19
Redirected restores

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.

Performing redirected restores

To redirect a restore to a different host
1 Update the NetBackup client name as the host and the PostgreSQL target
directory as the directory where you want to redirect the restore.
2 On the NetBackup primary server, create an altnames directory for the host
that you want to have permission to perform the redirected restore. For example,
to give Host B permissions to restore from another host, create the following
file:
■ (Windows) install_path\NetBackup\db\altnames\HostB
■ (Linux RHEL and SLES) /usr/openv/netbackup/db/altnames/HostB

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.

Note: (Linux only) The NetBackup service user account must have ownership
of the altnames directory and host files.

4 Run the following command:

nbpgsql -o restore -S primary_server_name -t target_directory
-portnum db_port [-id db_backup_id] [-C client_name]

Note: For redirected restore, provide the source client name (client from which
backup was taken) to the -C option.

5 After a successful redirected restore, undo the changes that you made on the
primary server and the client.
 NetBackup for PostgreSQL backup and restore 20
Recovering the restores

To redirect a restore to a different file path

1 Run the following command:
nbpgsql -o restore -S primary_server_name -t target_directory
-portnum database_server_port [-id db_backup_id] [-C client_name]

2 Copy the restore data to the data directory.

3 After a successful restore, change the ownership of data directory to
PostgreSQL user and modify the settings according to your environment.

Recovering the restores

Select a recovery workflow based on the version of PostgreSQL you are using. If
you are using PostgreSQL version 12 or later, go directly to the section Recovering
for PostgreSQL version 12 or later .

Recovering for PostgreSQL version 11 or earlier

After a successful restore, to recover the restore, copy the recovery.conf.sample
file to the PostgreSQLdata directory. The recovery.conf.sample is available at
the PostgreSQL install path. Ensure that after you copy the recovery file, remove
the .sample extension.
When you set the parameters and restart the PostgreSQL services, the server goes
into the recovery mode and reads the archived WAL files. If the recovery gets
terminated, you can restart the server to continue the recovery process.
After successful completion, the server renames the recovery.conf file to
recovery.done to prevent re-entering into the recovery mode.

In Linux operating system, the owner and the group defaults to postgres after a
successful restore. You must change the ownership to PostgreSQL owner and
modify the settings according to your environment.

The recovery.conf configuration file

The recovery.conf file contains the parameters that you must set to enable archive
recovery or act as a replication standby. The parameters must be set again for the
subsequent recovery that you must perform.
Table 3-2 lists the parameters that you must set to enable archive recovery.
 NetBackup for PostgreSQL backup and restore 21
Recovering the restores

Table 3-2 The recovery.conf file parameters

Parameters Description

restore_command This parameter specifies the shell command that is run to copy log
files back from archival storage. This parameter is required for archival
storage but is optional for streaming replication. The command string
may contain %f that is replaced by the name of the desired log file and
%p is replaced by the absolute path to copy the log file to.

recovery_target This parameter stops the roll-forward at a specific point. By default,

the recovery rolls forward to the end of the WAL log.

Performing the restore recovery

To recover the restore
1 Stop the PostgreSQL services.
2 Copy the restore data into the PostgreSQL data directory.
3 (Linux) Change the ownership to PostgreSQL user.
4 Copy the recovery.conf file to the PostgreSQL data directory and remove
the .sample extension.
5 (Linux) Change the ownership to the PostgreSQL user and modify the settings
according to your environment.
6 Edit the recovery.conf file to set the following:
■ (Windows) Mention the restore_command parameter as cp
"<PostgreSQL-data-directory>\\pgarchive\\%f" "%p"

■ (Linux) Mention the restore_command as cp

<PostgreSQL-data-directory>/pgarchive/%f %p

■ Remove the pause_recovery_target parameter.

7 Start the PostgreSQL services.

8 After successful recovery, delete the pgarchive directory and the
recovery.done file.

Recovering for PostgreSQL version 12 or later

If you are using PostgreSQL version 12 or a higher version, perform the following
steps.
 NetBackup for PostgreSQL backup and restore 22
Disaster recovery

To recover the restore

1 Stop the PostgreSQL services.
2 Copy the restore data into the PostgreSQL data directory.
3 (Linux) Change the ownership to PostgreSQL user.
4 (Windows) Mention the restore_command parameter as cp
"<PostgreSQL-data-directory>\\pgarchive\\%f" "%p"

5 (Linux) Mention the restore_command as cp

<PostgreSQL-data-directory>/pgarchive/%f %p

6 Create an empty file named recovery.signal in the PostgreSQL data directory.

For example, # touch /<target_restored_directory>/recovery.signal
7 (Linux) Change ownership of the recovery.signal file to the PostgreSQL user.
For example: chown postgres:postgres
/<PostgreSQL-data-directory>/recovery.signal

8 Start the PostgreSQL services.

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 19.
 Chapter 4
Troubleshooting for
PostgreSQL
This chapter includes the following topics:

■ Troubleshooting errors when using NetBackup for PostgreSQL

Troubleshooting errors when using NetBackup

for PostgreSQL
General guidelines to resolve problems
The following table includes the steps that help you resolve problems you may
encounter while using NetBackup for PostgreSQL Agent.

Table 4-1 General steps to resolve problems

Steps Action Description

Step1 Remember the error Error messages are usually the vehicles for telling you something went wrong.
message. 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 PostgreSQL 24
Troubleshooting errors when using NetBackup for PostgreSQL

Table 4-1 General steps to resolve problems (continued)

Steps Action Description

Step 2 Identify what you were Ask the following questions:

doing when the
■ What operation was tried?
problem occurred.
■ What method did you use?
■ What type of server platform and operating system was involved?
■ If your site uses both primary server and media server, was it a primary
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?

Step 3 Record all information. Capture potentially valuable information.

■ The NetBackup logs.

■ The logs specific to NetBackup for PostgreSQL Agent logs.
■ The logs specific to NetBackup XBSA.

Step 4 Correct the problem. After you define the problem, use the information to correct it.

Step 5 Contact Technical If you cannot solve the troubleshooting, contact the Technical support.
Support.

Troubleshooting errors using logs and reports

To troubleshoot the errors, you can refer to the NetBackup logs. These logs are
located at the following locations:
The NetBackup primary server logs are located at:
■ install_path\NetBackup\logs\bprd

■ 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.
The logs that are specific to NetBackup client are located at:
■ install_path\netbackup\logs\nbpgsql.log
 Troubleshooting for PostgreSQL 25
Troubleshooting errors when using NetBackup for PostgreSQL

The logs that are specific to NetBackup XBSA are located at:
■ <NetBackup_install_path>/netbackup/logs/exten_client

Troubleshooting NetBackup errors

For troubleshooting NetBackup errors, see NetBackup Troubleshooting Guide and
the NetBackup Commands Reference Guide.

Troubleshooting NetBackup for PostgreSQL errors

Table 4-2 lists and describes the errors and the solutions to troubleshoot the
problems while running the operations.

Table 4-2 Troubleshooting NetBackup for PostgreSQL errors

Problems Description Solution

The nbpgsql backup fails with You may encounter this problem Verify the following and then run the backup again:
the following error: when the library path is not
■ Ensure that you provide the correct postgresql
provided in the nbpgsql
Unable to load postgresql library library path, which contains the libpq.so
command using the "-l"
(Linux) or libpq.dll (Windows) file.
switch or the library path is
■ (Linux) If libpq.so is not available, create a
provided but it does not contain
symbolic link named libpq.so that points to
libpq.so (Linux) or
libpq.so.<n>.
libpq.dll (Windows).
■ (Windows) If libpq.dll is not available under
bin directory of the PostgreSQL installation
location, it may be available under lib directory.

The nbpgsql backup fails with The PostgreSQL backup fails To add the appropriate database user name and
the following error: when the nbpgsql command port number:
is run with invalid database user
Unable to connect to the ■ Provide the database user name using the
name, port number, or
database "-u" switch of the nbpgsql command.
password.
■ Provide the database port number using the
"-portnum" switch of nbpgsql command.
■ Provide the database password using the
my.cnf (Linux) or my.ini (Windows) file.

See “Authenticating the PostgreSQL environment

password ” on page 7.

The nbpgsql backup fails with The nbpgsql backup fails if the To run a nbpgsql backup successfully:
the following error: environment variable path is not
■ Update the environment variable path with
updated with NetBackup bin
Unable to load xbsa.dll NetBackup_install_path/bin.
directory.
 Troubleshooting for PostgreSQL 26
Troubleshooting errors when using NetBackup for PostgreSQL

Table 4-2 Troubleshooting NetBackup for PostgreSQL errors (continued)

Problems Description Solution

The nbpgsql backup fails with The nbpgsql backup fails if the To run the nbpgsql backup successfully:
the following error: nbpgsql.conf file is not
■ Configure the valid primary server name, policy
updated with the required
XBSA initiation failed name, schedule type in the nbpgsql.conf
parameters.
file or from the command line.
■ Verify if there are communication errors
between the nbpgsql agent and the
NetBackup primary server. For more
information see the NetBackup Administrator's
Guide Volume I.

(Windows)VSS snapshot The nbpgsql backup may fail Run cmd.exe in Administrator mode.
creation failed when the user does not have
the privileges to run the
nbpgsql operations.

The nbpgsql restore operation The nbpgsql restore fails if the For a successful restore:
does not restore any data from nbpgsql.conf file is not
■ Verify that the target directory is valid and
the target NetBackup client. updated with the NetBackup
empty.
client name and the target
■ Initiate the restore from the NetBackup source
directory.
client.
■ Set the NetBackup client name and target
directory parameters in the nbpgsql.conf
file.

The nbpgsql backup fails with The nbpgsql backup may fail To verify the space in the volume group:
the following error: when the volume group does
1 Run the following command:
not have sufficient space for the
(Linux)Error creating LVM
snapshot. $vgs
snapshot
The command displays the volume group
details.

2 Update the nbpgsql.conf file with the

appropriate snapshot size. The snapshot
should be equivalent to or more than the
instance size.
 Troubleshooting for PostgreSQL 27
Troubleshooting errors when using NetBackup for PostgreSQL

Table 4-2 Troubleshooting NetBackup for PostgreSQL errors (continued)

Problems Description Solution

Error messages after a The nbpgsql backup gives To remove the snapshots:
successful backup: these errors when the volume
1 Run the following command to list the existing
group contains the snapshots.
<volume_group>/<snapshot_name> snapshot:
You can list the snapshots and
Read failure after 0 of 4096 at
then remove them before you $lvs
29393616896: input or output
run the backup again.
error. The command displays the snapshot details.
Note: nbpgsql created LVM
OR 2 To remove the snapshots, run the following
snapshot names are prefixed
command:
<volume_group>/<snapshot_name>: with pgsqlsnap
read failure after 0 of 4096 at $ lvremove -f
4096: input or output error. <volume_group>/<snapshot_name>

The nbpgsql backup on Linux The nbpgsql backup fails To unmount the snapshot
(LVM), fails with the following during an attempt to unmount
1 Run the following command to list all mounted
error: the snapshot, the device, or
file systems:
when you remove the existing
Error unmounting the
snapshots. $ mount-l
snapshot-Device or resource
busy 2 If the snapshot still exists, create a mount
directory using the following command:
OR
$mount<mount_directory>
Error removing the
snapshot-pgsqlsnap_<timestamp> Note: This directory is created in
/mnt/<snapshot_name>. The prefix names
Note: <timestamp> is the LVM
for snapshot are pgsqlsnap.
snapshot time.
3 Run the following command to remove the
mount directory:

$rm -rf <mount_directory>

4 Run the following command to remove the

snapshot manually:

lvremove -f
<volume_group>/<snapshot_name>
 Troubleshooting for PostgreSQL 28
Troubleshooting errors when using NetBackup for PostgreSQL

Table 4-2 Troubleshooting NetBackup for PostgreSQL errors (continued)

Problems Description Solution

Even after a successful restore, The restore operation is ■ Verify that the PostgreSQL version from the
the PostgreSQL services, failed successful, only when you backed up data is same as the PostgreSQL
to start. restore the backup on a version on the computer where you want to
machine that has the same restore the data.
minor version of PostgreSQL.

For example, if you back up a

file from PostgreSQL version
9.6.x, then you must restore the
file to a computer with
PostgreSQL version 9.6.x.

The nbpgsql.conf file is Starting from NetBackup 8.2, If the nbpgsql.conf file does not exist, you can
missing after installing the agent the nbpgsql.conf file is not 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 ./nbpgsql. This command creates the default
SUSE. The existing nbpgsql.conf file.
configuration file is prevented
from getting overwritten as the
RPM installer overwrites any
existing files in the destination
directory
/usr/NBPostgreSQLAgent/.

Restore or restore and recovery Restore or restore and recovery Ensure that the client version and media server
from pre-upgrade images fail from pre-upgrade images fail version are the same for restore or restore and
with the following error message: with an error when media server recovery operation.
and client versions mismatch.
2816 DataStore policy
restore
 Appendix A
NetBackup for
PostgreSQL commands
and conventions
This appendix includes the following topics:

■ About NetBackup for PostgreSQL commands

■ NetBackup for PostgreSQL Agent command conventions

About NetBackup for PostgreSQL commands

This section describes the commands, options, and parameters that are available
to run the nbpgsql operations. Each command contains a brief description, required
parameters, and optional parameters for the respective operations. The NetBackup
for PostgreSQL Agent supports only those commands, options, and parameters
that are mentioned in this document.
Observe for the following:
■ Specify the parameters on the command line.
■ Specify the operation type -o on the nbpgsql command line.
■ Specify the parameters and options for the respective operations on the
command line.
 NetBackup for PostgreSQL commands and conventions 30
NetBackup for PostgreSQL Agent command conventions

The NetBackup for PostgreSQL command options

Table A-1 The nbpgsql command options

Options Description

-C Configures the NetBackup client name for redirected restores.

-h Displays the Help usage, when it is the only option on the nbpgsql
command line.

-id Configures the specified backup.

-l (Linux) Configures the PostgreSQL library path.

-o Configures the operation type (backup, restore, query, and delete).

-P Configures the DataStore policy.

-portnum Configures the database server port number that identifies the PostgreSQL
instance on which the backup or restore is performed.

-s Configures the NetBackup schedule.

-S Configures the NetBackup primary server.

-t Configures the target directory to restore the data.

-u Configures the database user name.

-z Configures the LVM snapshot size.

-b Configures the backup type as LVM or non-LVM

NetBackup for PostgreSQL Agent command

conventions
This document uses the following conventions to describe the commands that are
specific to the agent.
Run the following commands in the command line interface to see the results:
■ The -help command (-h) option prints a command-line usage message when
it is the only option on the command line. For example,

nbpgsql -h

■ Brackets [ ] indicate that the enclosed component of the command line is optional.
Other parameters are required.
 NetBackup for PostgreSQL commands and conventions 31
NetBackup for PostgreSQL Agent command conventions

■ Italics indicate that the information is user supplied. For example, you may
provide the client name and the schedule name for a backup operation.

nbpgsql -o backup -S primary_server -P policy_name -s schedule_name

 Appendix B
NetBackup for
PostgreSQL commands
This appendix includes the following topics:

■ nbpgsql -o backup

■ nbpgsql -o restore

■ nbpgsql -o query

■ nbpgsql -o delete
 NetBackup for PostgreSQL commands 33
nbpgsql -o backup

nbpgsql -o backup
nbpgsql -o backup – runs the backup operation from the NetBackup client.

SYNOPSIS
nbpgsql -o backup

-S primary_server

-P policy_name

-s schedule_name

(Linux) -l postgresql_library_path

(Linux) -z snapshot_size

[(Linux) -b backup_type auto, lvm, and nonlvm]

[-portnum db_port]

[-udatabase_user]

Description
This command invokes the backup operation from the NetBackup client using the
NetBackup DataStore policy name and the schedule type. The parameter -S and
-P are required parameters for Windows. The parameters -b, -l, and -z are required
parameters for Linux. The -portnum and -u are the optional parameters.
On Linux systems, the directory path is /usr/openv/netbackup/bin.
On Windows, the directory path is install_path\NetBackup\bin.

Options
-l
(Linux) Configures the PostgreSQL library directory
-portnum
Configures the database port number that identifies the PostgreSQL instance
on which the backup is performed.
-P
Configures the NetBackup DataStore policy name.
 NetBackup for PostgreSQL commands 34
nbpgsql -o backup

-S
Configures the NetBackup server name.
-s
Specifies the schedule name that you have configure for the DataStore policy.
-u
Configures the database user name.
-z
(Linux) Specifies the LVM snapshot size.
-b Configures the backup type as LVM or non-LVM.
 NetBackup for PostgreSQL commands 35
nbpgsql -o restore

nbpgsql -o restore
nbpgsql -o restore – restores the backup files from the NetBackup server.

SYNOPSIS
nbpgsql -o restore -S primary_server -t target_directory [-id
db_backup_id] [-Cclient_name]

Description
The nbpgsql command restores the backup file using -t and -S as the required
parameters. The -id and -C are optional parameters.
On Linux systems, the directory path to this command is
/usr/openv/netbackup/bin.

On Windows systems, the directory path to this command is

install_path\NetBackup\bin.

Options
-C
Specifies the client name.
-id
Specifies the backup image name.
-S
Configures the NetBackup primary server.
-t
Configures the target directory where the backups are restored.
 NetBackup for PostgreSQL commands 36
nbpgsql -o query

nbpgsql -o query
nbpgsql -o query – query the backup.

SYNOPSIS
nbpgsql -o query -S primary_server [-C NetBackup_client_name] [-P
policy_name]

Description
The nbpgsql -o query command gets the backup using -S as the required
parameter and -C and -P as optional parameters.
On Linux systems, the directory path to this command is
/usr/openv/netbackup/bin/.

On Windows systems, the directory path to this command is

install_path\NetBackup\bin\.

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 primary server.
 NetBackup for PostgreSQL commands 37
nbpgsql -o delete

nbpgsql -o delete
nbpgsql -o delete – deletes the backup information from the NetBackup catalog
files.

SYNOPSIS
nbpgsql -o delete -S primary_server[-id db_backup_id]

Description
The nbpgsql -o delete command deletes the backup information from the
NetBackup catalog files, but retains the backups in the storage media.
The parameter -S is a required parameter and -id is the optional parameter.

Options
-id
Specifies the backup image name to delete the specified backup information.
-S
Configures the NetBackup primary server.
 Index

B
backups
archive directory 12
delete 12
query 12
schema files 12
symbolic link 12
Write-Ahead logs level 12

R
redirected restore
altnames 18
different file path 18
different host 18
restore
target directory 18
restores
recovery 18
redirected restore 18