Veritas NetBackup™ for

PostgreSQL Administrator's
Guide

Windows and Linux

Release 8.1.1
Documentation version: 8.1.1

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

Veritas and the Veritas Logo 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. Please see the Third Party Legal Notice Appendix to this Documentation
or TPIP ReadMe File accompanying this product for more information on the Third Party
Programs.

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
500 E Middlefield Road
Mountain View, CA 94043

http://www.veritas.com
Technical Support
Technical Support maintains support centers globally. Technical Support’s primary
role is to respond to specific queries about product features and functionality. The
Technical Support group also creates content for our online Knowledge Base. The
Technical Support group works collaboratively with the other functional areas within
the company to answer your questions in a timely fashion.
Our support offerings include the following:
■ A range of support options that give you the flexibility to select the right amount
of service for any size organization
■ Telephone and/or Web-based support that provides rapid response and
up-to-the-minute information
■ Upgrade assurance that delivers software upgrades
■ Global support purchased on a regional business hours or 24 hours a day, 7
days a week basis
■ Premium service offerings that include Account Management Services
For information about our support offerings, you can visit our website at the following
URL:
www.veritas.com/support
All support services will be delivered in accordance with your support agreement
and the then-current enterprise technical support policy.

Contacting Technical Support

Customers with a current support agreement may access Technical Support
information at the following URL:
www.veritas.com/support
Before contacting Technical Support, make sure you have satisfied the system
requirements that are listed in your product documentation. Also, you should be at
the computer on which the problem occurred, in case it is necessary to replicate
the problem.
When you contact Technical Support, please have the following information
available:
■ Product release level
■ Hardware information
■ Available memory, disk space, and NIC information
 ■ Operating system
■ Version and patch level
■ Network topology
■ Router, gateway, and IP address information
■ Problem description:
■ Error messages and log files
■ Troubleshooting that was performed before contacting Technical Support
■ Recent software configuration changes and network changes

Licensing and registration

If your product requires registration or a license key, access our technical support
Web page at the following URL:
www.veritas.com/support

Customer service
Customer service information is available at the following URL:
www.veritas.com/support
Customer Service is available to assist with non-technical questions, such as the
following types of issues:
■ Questions regarding product licensing or serialization
■ Product registration updates, such as address or name changes
■ General product information (features, language availability, local dealers)
■ Latest information about product updates and upgrades
■ Information about upgrade assurance and support contracts
■ Advice about technical support options
■ Nontechnical presales questions
■ Issues that are related to CD-ROMs, DVDs, or manuals
Support agreement resources
If you want to contact us regarding an existing support agreement, please contact
the support agreement administration team for your region as follows:

Worldwide (except Japan) [email protected]

 Contents

Technical Support ............................................................................................. 4

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

About NetBackup for PostgreSQL Agent ............................................. 9

Features supported by NetBackup for PostgreSQL Agent .................... 11
The NetBackup for PostgreSQL Agent package .................................. 11
About the License for NetBackup for PostgreSQL Agent ....................... 11
NetBackup for PostgreSQL Agent Documentation ............................... 12

Chapter 2 Installing the NetBackup for PostgreSQL Agent

........................................................................................... 13

Planning the installation of NetBackup for PostgreSQL Agent ................ 13

Verifying the operating systems and platforms .................................... 14
Installing prerequisites for NetBackup for PostgreSQL Agent ................. 14
Post-installation requirements for NetBackup for PostgreSQL Agent
........................................................................................... 15
Describing the NetBackup for PostgreSQL Agent package ................... 15
Installing the NetBackup for PostgreSQL Agent .................................. 16
Authenticating the password .......................................................... 17
Uninstalling the NetBackup for PostgreSQL Agent .............................. 18

Chapter 3 Configuring NetBackup for PostgreSQL ..................... 19

The nbpgsql.conf configuration file ................................................... 19
Configuring PostgreSQL backups with DataStore policies ..................... 21

Chapter 4 The NetBackup for PostgreSQL backups and

restores .......................................................................... 23

About PostgreSQL backups ............................................................ 23

The postgresql.conf configuration file .......................................... 26
Performing PostgreSQL backups ..................................................... 26
Validating the PostgreSQL backups ................................................. 28
Querying the PostgreSQL backups .................................................. 28
Deleting backup information from the NetBackup catalog files ............... 29
 Contents 8

About PostgreSQL restore ............................................................. 29

Performing the PostgreSQLrestores ................................................. 31
Redirected restores ...................................................................... 31
Recovering the restores ................................................................. 32
Disaster recovery ......................................................................... 34

Chapter 5 Troubleshooting for PostgreSQL .................................. 35

Troubleshooting errors when using NetBackup for PostgreSQL Agent

........................................................................................... 35

Appendix A NetBackup for PostgreSQL commands and

conventions ................................................................... 41
About NetBackup for PostgreSQL Agent commands ............................ 41
NetBackup for PostgreSQL Agent command conventions ..................... 42

Appendix B NetBackup for PostgreSQL commands ...................... 44

nbpgsql -o backup ........................................................................ 45
nbpgsql -o restore ........................................................................ 47
nbpgsql -o query .......................................................................... 48
nbpgsql -o delete ......................................................................... 49

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

■ About NetBackup for PostgreSQL Agent

■ Features supported by NetBackup for PostgreSQL Agent

■ The NetBackup for PostgreSQL Agent package

■ About the License for NetBackup for PostgreSQL Agent

■ NetBackup for PostgreSQL Agent Documentation

About NetBackup for PostgreSQL Agent

NetBackup for PostgreSQL Agent extends the capabilities of NetBackup to include
backup and restore of the PostgreSQL databases. The NetBackup for PostgreSQL
Agent is located on the NetBackup client and supports the operations on standalone
setups. The agent supports the PostgreSQL version 9 and later.
The agent also supports to:
■ Validate the backup.
■ Query a backup and restore.
■ Delete the backup information from the catalog files.
■ Redirect restores.
 Introduction to NetBackup for PostgreSQL 10
About NetBackup for PostgreSQL Agent

The NetBackup for PostgreSQL workflow

The NetBackup for PostgreSQL Agent reads the parameters from the nbpgsql.conf
file and initiates the operation. The nbpgsql.conf file contains the parameters that
you must set for the nbpgsql command to run the respective operations.
The agent communicates with the PostgreSQL database to create a snapshot. The
Volume Shadow Copy Services (VSS) for Windows or Logical Volume Manager
(LVM) for Linux, takes a snapshot of the PostgreSQL database.
The agent then interacts with the NetBackup XBSA interface to update the server
name, policy, and schedule type information. The NetBackup master server connects
to the NetBackup client to backup or retrieve the data that you want to protect.
The agent mounts the snapshot, copies the file, and sends it to the NetBackup
XBSA interface. The NetBackup XBSA interface writes this data to the mounted
media or disk storage that is managed by the NetBackup media server.
Table 1-1 lists the configuration files. These files contain the parameters that you
must specify for the respective operations.

Table 1-1 NetBackup for PostgreSQL configuration files

Component Description

nbpgsql.conf file The nbpgsql.conf file contains the parameters that you must specify before you run the
nbpgsql operations.

For more information, See “The nbpgsql.conf configuration file” on page 19.

recovery.conf file The recovery.conf file contains the parameters that you must set for PostgreSQL to
perform an archive recovery. You must set the parameters again for the subsequent recovery
that you must perform.

For more information, See “Recovering the restores” on page 32.

postgresql.conf file The postgresql.conf file contains the parameters that you must set to archive the
Write-Ahead Logs.

For more information,See “About PostgreSQL backups” on page 23.

pgpass.conf file The pgpass.conf file contains the password to connect to the database for Windows.

For more information, See “Authenticating the password ” on page 17.

.pgpass file The .pgpass file contains the password to connect to the PostgreSQL database for Linux
operating systems.

For more information, See “Authenticating the password ” on page 17.

 Introduction to NetBackup for PostgreSQL 11
Features supported by NetBackup for PostgreSQL Agent

Note: You must set the parameters in the nbpgsql.conf file before you run the
operations or provide them on the nbpgsql command line, where command line
parameters take precedence.

Features supported by NetBackup for PostgreSQL

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

Table 1-2 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 .

The NetBackup for PostgreSQL Agent package

The PostgreSQL agent is packaged in NBPostgreSQLAgent_8.1.zip file and is
available on my.veritas.com site.
The package file contains the following platform files:
■ (Windows) NBPostgreSQLAgent_8.1_AMD64/
■ (Linux RHEL) NBPostgreSQLAgent_8.1_linuxR_x86/
■ (Linux SLES) NBPostgreSQLAgent_8.1_linuxS_x86/

About the License for NetBackup for PostgreSQL

Agent
The NetBackup for PostgreSQL Agent is installed on the NetBackup client software
and is not a separately licensed option of NetBackup. The NetBackup for
PostgreSQL Agent is available to customers who are entitled with a valid license
of the Application and Database License Pack. In general, licensing of the NetBackup
for PostgreSQL Agent follows the existing capacity licensing models for supported
database agents.
 Introduction to NetBackup for PostgreSQL 12
NetBackup for PostgreSQL Agent Documentation

NetBackup for PostgreSQL Agent Documentation

The NetBackup for PostgreSQL Agent documentation is available at the following
URL:
www.veritas.com/support/en_US/article.000127661
 Chapter 2
Installing the NetBackup
for PostgreSQL Agent
This chapter includes the following topics:

■ Planning the installation of NetBackup for PostgreSQL Agent

■ Verifying the operating systems and platforms

■ Installing prerequisites for NetBackup for PostgreSQL Agent

■ Post-installation requirements for NetBackup for PostgreSQL Agent

■ Describing the NetBackup for PostgreSQL Agent package

■ Installing the NetBackup for PostgreSQL Agent

■ Authenticating the password

■ Uninstalling the NetBackup for PostgreSQL Agent

Planning the installation of NetBackup for

PostgreSQL Agent
Table 2-1 lists the planning steps that are mandatory for installing the agent.

Table 2-1 General steps for installing the agent

Step Action

Step 1 Verify the operating systems.

For more information, See “Verifying the operating systems and platforms”
on page 14.
 Installing the NetBackup for PostgreSQL Agent 14
Verifying the operating systems and platforms

Table 2-1 General steps for installing the agent (continued)

Step Action

Step 2 Verify the prerequisites before you install the NetBackup for PostgreSQL
Agent.

For more information, See “Installing prerequisites for NetBackup for

PostgreSQL Agent” on page 14.

Step 3 Install the NetBackup for PostgreSQL Agent on your operating system.

For more information, See “Installing the NetBackup for PostgreSQL Agent”
on page 16.

Step 4 Authenticate the database password for PostgreSQL backups.

For more information, See “Authenticating the password ” on page 17.

Verifying the operating systems and platforms

Verify that the NetBackup for PostgreSQL Agent is supported on your operating
system or platforms.
The agent supports the operations on following platforms:
■ Red Hat Enterprise Linux (RHEL) 6.8 and later
■ SUSE Enterprise Linux Server 11 SP3 and later
■ Microsoft Windows Server 2008 R2 and later
■ Microsoft Windows 8.1 and later

Installing prerequisites for NetBackup for

PostgreSQL Agent
Before you install, ensure that you meet the following prerequisites:
■ NetBackup 8.1 is installed and operational on the master server, media server,
and the client.
■ The PostgreSQL database is installed and operational on the client.
 Installing the NetBackup for PostgreSQL Agent 15
Post-installation requirements for NetBackup for PostgreSQL Agent

Post-installation requirements for NetBackup for

PostgreSQL Agent
After you install
■ (Windows) Configure the NetBackup for PostgreSQL Agent to run with
administrative privileges.
■ (Windows) Add the NetBackup bin directory to the PATH user environment
variable.
(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.

Note: Ensure that you update the PGSQL_LIB_INSTALL_PATH parameter in the

nbpgsql.conf with the absolute path of the symbolic link.

■ (Linux) The user of the agent is a superuser or has superuser privileges.

■ Set the following database user privileges:

Table 2-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.

Describing the NetBackup for PostgreSQL Agent

package
The agent is packaged in the NBPostgreSQLAgent_8.1.zip file and is available on
my.veritas.com site.
 Installing the NetBackup for PostgreSQL Agent 16
Installing the NetBackup for PostgreSQL Agent

The package file contains the following platform files:

■ (Windows) NBPostgreSQLAgent_8.1_AMD64/
■ (Linux RHEL) NBPostgreSQLAgent_8.1_linuxR_x86/
■ (Linux SUSE) NBPostgreSQLAgent_8.1_linuxS_x86/
(Windows) NBPostgreSQLAgent_8.1_AMD64/ includes the following files:
■ NBPostgreSQLAgent_8.1_AMD64/README.txt

■ NBPostgreSQLAgent_8.1_AMD64/cab1.cab

■ NBPostgreSQLAgent_8.1_AMD64/Setup.exe

■ NBPostgreSQLAgent_8.1_AMD64/NBPgSQLAgent.msi

(Linux RHEL) NBPostgreSQLAgent_8.1_linuxR_x86/ includes the following files:

■ NBPostgreSQLAgent_8.1_linuxR_x86/README

■ NBPostgreSQLAgent_8.1_linuxR_x86/install

■ NBPostgreSQLAgent_8.1_linuxR_x86/LICENSE

■ NBPostgreSQLAgent_8.1_linuxR_x86/pkg.tar

(Linux SUSE) NBPostgreSQLAgent_8.1_linuxS_x86/ includes the following files:

■ NBPostgreSQLAgent_8.1_linuxS_x86/README

■ NBPostgreSQLAgent_8.1_linuxS_x86/install

■ NBPostgreSQLAgent_8.1_linuxS_x86/LICENSE

■ NBPostgreSQLAgent_8.1_linuxS_x86/pkg.tar

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\NBPostgreSQLAgent
■ (Linux RHEL & SUSE) /usr/NBPostgreSQLAgent/

Installing the NetBackup for PostgreSQL Agent

When you install the agent on Windows, Veritas recommends that you run the
NBPostgreSQLAgent_8.1_AMD64/Setup.exe file.
 Installing the NetBackup for PostgreSQL Agent 17
Authenticating the password

To install the agent

1 Download the NBPostgreSQLAgent_8.1.zip file.
2 Extract the file that applies to your operating system:
(Windows) NBPostgreSQLAgent_8.1_AMD64/
(Linux RHEL) NBPostgreSQLAgent_8.1_linuxR_x86/
(Linux SUSE) NBPostgreSQLAgent_8.1_linuxS_x86/
3 Run the file that applies to your operating system:
(Windows) NBPostgreSQLAgent_8.1_AMD64/Setup.exe
(Linux RHEL) NBPostgreSQLAgent_8.1_linuxR_x86/install
(Linux SUSE) NBPostgreSQLAgent_8.1_linuxS_x86/install
4 Type y to accept the VERITAS LICENSE AGREEMENT.
The agent gets installed at the default location.

Authenticating the password

Authenticating the 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

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.
 Installing the NetBackup for PostgreSQL Agent 18
Uninstalling the NetBackup for PostgreSQL Agent

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

Uninstalling the NetBackup for PostgreSQL Agent

To uninstall the agent
1 (Windows) From the Control Panel, right-click the
NBPostgreSQLAgent_8.1_AMD64/ file and Uninstall the agent.

2 (Linux RHEL) To uninstall, delete the NBPostgreSQLAgent_8.1_linuxR_x86/

directory from the installed location.
3 (Linux SUSE) To uninstall, delete the NBPostgreSQLAgent_8.1_linuxS_x86/
directory from the installed location.
 Chapter 3
Configuring NetBackup for
PostgreSQL
This chapter includes the following topics:

■ The nbpgsql.conf configuration file

■ Configuring PostgreSQL backups with DataStore policies

The nbpgsql.conf configuration file

The NetBackup for PostgreSQL configuration (nbpgsql.conf) file is contains the
parameters that you must specify for the respective operations. It contains predefined
settings and is located on the client. When parameters are not configured in the
nbpgsql.conf file, then the default parameter value takes precedence. You can
configure the parameters in the nbpgsql.conf file or set them on the command
line, where the command line parameters take precedence. The nbpgsql.conf
file keeps you from providing the parameters every time you run operations.
The nbpgsql.conf file is located in the following locations:
■ (Windows)
install_path\NBPostgreSQLAgent_8.1_AMD64\nbpgsql.conf .

■ (Linux RHEL)
install_path/NBPostgreSQLAgent_8.1_linuxR_x86/nbpgsql.conf

■ (Linux SUSE)
install_path/NBPostgreSQLAgent_8.1_linuxS_x86/nbpgsql.conf

Table 3-1 lists the nbpgsql.conf file parameters:

 Configuring NetBackup for PostgreSQL 20
The nbpgsql.conf configuration file

Table 3-1 The nbpgsql.conf parameters

Parameters Description Required Default value

parameter
for

DB_PORT Configures the PostgreSQL database Backups When you do not specify the
server port number on which the port number, the default is
backup or the restore should be 5432.
performed. The port number verifies
the PostgreSQL service status.

DB_USER Configures the PostgreSQL database Backups When you do not specify the
user name. user name, the default is
postgres.

PGSQL_LIB_INSTALL_PATH (Linux) Configures the libpq.so Backups No default value.

binary path.

MASTER_SERVER_NAME Specifies the NetBackup master Backups and No default value.

server for backups and restores. restores

POLICY_NAME Specifies the DataStore policy name. Backups No default value.

SCHEDULE_NAME Identifies the backup schedule that Backups When you do not specify the
you configured while creating the policy name, the defaults is
DataStore policy. Default-Application-Backup.

CLIENT_NAME Defines the NetBackupclient that has Redirected When you do not specify the
the NetBackup for PostgreSQL Agent. restores and client name, the default is the
query current host.

SNAPSHOT_SIZE (Linux) Specifies the snapshot size LVM backups When you do not specify the
for LVM snapshots. Specify the snapshot size, the default is MB.
snapshot size in kilobytes,
megabytes, or gigabytes as KB, MB,
or GB respectively.

DB_BACKUP_ID DB_BACKUP_ID represents the Restoring No default value.

backup image name. This parameter backups using
configures the backup file when you the backup
want to restore or delete a specific image name.
backup.

PGSQL_TARGET_DIRECTORY Specifies the destination directory Restores No default value.

where you want to restore the
backups.
 Configuring NetBackup for PostgreSQL 21
Configuring PostgreSQL backups with DataStore policies

Table 3-1 The nbpgsql.conf parameters (continued)

Parameters Description Required Default value

parameter
for

NBPGSQL_LOG_LEVEL The NBPGSQL_LOG_LEVEL The log levels When you do not specify the
parameter lets you set the logging help to control log level, the default is level 1.
level for the nbpgsql logs. For a the amount of
information that
particular logging level, all details at
that level or lower are logged. you want to
access for
The nbpgsql debug logs includes the
troubleshooting
following verbose levels:
errors.
■ 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.

NBPGSQL_LOG_SIZE Configures the nbpgsql log size in You can specify When you do not specify the
MB. The maximum size is 10MB. the value log size, the default is 10MB.
When the log size reaches the according to
NBPGSQL_LOG_SIZE, it creates a the events that
new log with timestamp. you want to
write into the
logs.

Configuring PostgreSQL backups with DataStore

policies
The agent uses the DataStore policies to define the attributes, schedules, clients
list, and backup selections.
 Configuring NetBackup for PostgreSQL 22
Configuring PostgreSQL backups with DataStore policies

To configure the PostgreSQL database backups with DataStore policies,

complete the following steps:
1 Log on to the master 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.
7 To select the schedule type, under the Schedules tab, click OK to select the
Default Application Backup schedule type.

Note: The XBSA framework supports the Default 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 See “The nbpgsql.conf configuration file” on page 19.
 Chapter 4
The NetBackup for
PostgreSQL backups and
restores
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 PostgreSQLrestores

■ 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.
 The NetBackup for PostgreSQL backups and restores 24
About PostgreSQL backups

The parameters portnum and -u are optional parameters. You can configure these
parameters in the nbpgsql.conf file or specify on the nbpgsql command line.
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 26.
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.
 The NetBackup for PostgreSQL backups and restores 25
About PostgreSQL backups

Figure 4-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 NetBackup 3 NetBackup
PostgreSQL data PostgreSQL agent master server
2 5
Snapshot Back up status is
creation returned

NetBackup
media server
NetBackup client

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

Storage unit

The NetBackup for PostgreSQL workflow

When you run the backup, the agent connects to the PostgreSQL database to
execute a flush and read only lock on all tables. The agent 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 agent 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.
 The NetBackup for PostgreSQL backups and restores 26
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 4-1 table lists the parameters that you must set to archive the WAL logs.

Table 4-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 will switch 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:
■ (Windows) Set the NetBackup\bin directory in the environment variable.
For example, Path =C:\Program Files\Veritas\Netbackup\bin
■ (Windows) Set the PostgreSQL\bin directory in user environment variable.
For example, Path=C:\Program Files\PostgreSQL\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.
For more information, See “Post-installation requirements for NetBackup for
PostgreSQL Agent” on page 15.
■ Set the following parameters in the nbpgsql.conf file:
■ DB_USER

■ DB_PORT
 The NetBackup for PostgreSQL backups and restores 27
Performing PostgreSQL backups

■ MASTER_SERVER_NAME

■ POLICY_NAME

■ SCHEDULE_NAME

■ (Linux) PGSQL_LIB_INSTALL_PATH
■ (Linux) SNAPSHOT_SIZE

■ Create the archivedir directory and then set the following parameters in the
postgresql.conf file:

■ wal_level = archive

■ archive_mode = on

■ archive_timeout =0

■ 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 21.
■ Verify the installation prerequisites and the post-installation requirements.
For more information, See “Installing prerequisites for NetBackup for PostgreSQL
Agent” on page 14.
For more information, See “Post-installation requirements for NetBackup for
PostgreSQL Agent” on page 15.
 The NetBackup for PostgreSQL backups and restores 28
Validating the PostgreSQL backups

To run the backup

1 Run the following command:
nbpgsql -o backup

-S master_server

-P policy_name

-s schedule_name

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

[-u dbuser]

2 (Optional) Type the database password, when the command line prompts for
a password . NetBackup connects to the database and initiates the backup.

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. You can configure these parameters from the nbpgsql.conf
file or set the parameters using the nbpgsql command.
The parameter -S is the required parameter. You can use the -Cand -P options to
define a different client and policy.
By default, NetBackup uses the values that you have configured in the nbpgsql.conf
file.
Before you run a query, you must set the following parameter in the nbpgsql.conf
file or provide on the command line:
 The NetBackup for PostgreSQL backups and restores 29
Deleting backup information from the NetBackup catalog files

■ CLIENT_NAME

■ POLICY_NAME

To query a backup
1 Configure the parameters, in the postgresql.conf file or provide on the
command line.
2 Run the following command:
nbpgsql -o query -S master_server [-C client_name] [-P
policy_name]

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

For example, to list backup files with the policy name policy_name, run the following
command:
nbpgsql -o query -S master_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.
Specify the following parameter in the nbpgsql.conf file or on the command line:
■ DB_BACKUP_ID

To delete the backup information

1 Configure the parameters, in the postgresql.conf file or provide on the
command line.
2 Run the following command:
nbpgsql -o delete -S master_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 NetBackup for PostgreSQL backups and restores 30
About PostgreSQL restore

The parameter -id restores the backup using the specified backup image name.
The parameter -C lists all the backups that exists on the specified client. When you
do not specify -C, it defaults to NetBackup master server.

Figure 4-2 NetBackup for PostgreSQL restore workflow

Read progress
file
2

Progress file

Restore Initiate restore

PostgreSQL data NetBackup
NetBackup
PostgreSQL agent 1
4 master server
3
PostgreSQL
Database server Retrieve data
to restore

NetBackup
media server
NetBackup client
NetBackup XBSA

Storage unit

The NetBackup for PostgreSQL restore workflow

After you specify the parameters, the agent reads the command line arguments
and parses the nbpgsql.conf configuration file. 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.
 The NetBackup for PostgreSQL backups and restores 31
Performing the PostgreSQLrestores

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:
■ (LVM users) Ensure that data logs and the logs directory reside on logical
volumes.
■ Set the following parameters in the nbpgsql.conf file:
■ PGSQL_TARGET_DIRECTORY

■ MASTER_SERVER_NAME

■ DB_PORT

■ CLIENT_NAME

■ DB_BACKUP_ID

Performing the PostgreSQLrestores

To restore the backup
1 Configure the parameters in the nbpgsql.conf file, or provide them on the
command line.
2 Run the following command:
nbpgsql -o restore -S master_server -t target_directory [-id
db_backup_id] [-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.
 The NetBackup for PostgreSQL backups and restores 32
Recovering the restores

Performing redirected restores

To redirect a restore to a different host
1 Update the nbpgsql.conf file with 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 master 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.
4 Run the following command:
nbpgsql -o restore -S master_server_name -t target_directory
-portnum db_port [-id db_backup_id] [-C client_name]

5 After a successful redirected restore, undo the changes that you made on the
master server and the client.
To redirect a restore to a different file path
1 Run the following command:
nbpgsql -o restore -S master_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

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.
 The NetBackup for PostgreSQL backups and restores 33
Recovering the restores

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 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 4-2 lists the parameters that you must set to enable archive recovery.

Table 4-2 The recovery.conf file parameters

Parameters Description

restore_command This parameter specifies the shell command that is executed 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:
 The NetBackup for PostgreSQL backups and restores 34
Disaster recovery

■ (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.

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

■ Troubleshooting errors when using NetBackup for PostgreSQL Agent

Troubleshooting errors when using NetBackup

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

Table 5-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 36
Troubleshooting errors when using NetBackup for PostgreSQL Agent

Table 5-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 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?

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, NetBackup for
PostgreSQL Agent logs, and the NetBackup XBSA logs. These logs are located at
the following locations:
The NetBackup 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 for PostgreSQL Agent are located at:
■ install_path\nbpgsql.log
 Troubleshooting for PostgreSQL 37
Troubleshooting errors when using NetBackup for PostgreSQL Agent

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 Veritas NetBackup Troubleshooting
Guide and the Veritas NetBackup Commands Reference Guide

Troubleshooting NetBackup for PostgreSQL Agent errors

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

Table 5-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 nbpgsql.conf file is
■ Add or update the PostgreSQL library file
not updated with the following
Unable to load postgresql library location in the nbpgsql.conf file.
■ postgresql library file ■ Ensure that the
location PostgreSQL_LIB_INSTALL_PATH is set to
■ PGSQL_LIB_INSTALL_PATH the correct path. It should point to libpq.so
does not point to library version.
correctlibpq.so library ■ Create a symbolic link libpq.so that points
version. to the libpq.so.<n> where n is the
PostgreSQL library version.
For more information, See “Post-installation
requirements for NetBackup for PostgreSQL
Agent” on page 15.

The nbpgsql backup fails with The nbpgsql backup fails To add the appropriate database user name and
the following error: when the nbpgsql.conf file is port number
updated with invalid username
Unable to connect to the ■ Configure the appropriate database user name
or port number.
database and port number in the nbpgsql.conf file or
provide the appropriate options with the
nbpgsqlcommand.
For more information, See “The nbpgsql.conf
configuration file” on page 19.

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 38
Troubleshooting errors when using NetBackup for PostgreSQL Agent

Table 5-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 master 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 master server. For more information
see the NetBackup Administration guide.

(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 39
Troubleshooting errors when using NetBackup for PostgreSQL Agent

Table 5-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 fails with You may encounter this problem Verify the following and then run the backup again:
the following error: when the nbpgsql.conf file is
■ Add or update the PostgreSQL library file
not updated with the following:
"Failed to load PostgreSQL location in the nbpgsql.conf file.
Library" ■ PostgreSQLlibrary file For more information, See “The nbpgsql.conf
location. configuration file” on page 19.
■ The ■ Ensure that the PGSQL_LIB_INSTALL_PATHis
PGSQL_LIB_INSTALL_PATH set to the correct path. It should point to
does not point to libpq.so. libpg.so.<n>, where n is the PostgreSQL
library version.
■ Create a symbolic link libpq.so that points
to the libpq.so.<n>, where <n> is the
PostgreSQL library version.
 Troubleshooting for PostgreSQL 40
Troubleshooting errors when using NetBackup for PostgreSQL Agent

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

Problems Description Solution

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 :

1vremove -f
<volume_group>/<snapshot_name>
 Appendix A
NetBackup for
PostgreSQL commands
and conventions
This appendix includes the following topics:

■ About NetBackup for PostgreSQL Agent commands

■ NetBackup for PostgreSQL Agent command conventions

About NetBackup for PostgreSQL Agent

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 in the nbpgsql.conf file or provide them on the command
line.
■ The parameter on the command line take precedence over the nbpgsql.conf
file.
■ Specify the operation type -o on the nbmysql command line.
■ Specify the parameters and options for the respective operations in the
nbpgsql.conf file or on the command line.
 NetBackup for PostgreSQL commands and conventions 42
NetBackup for PostgreSQL Agent command conventions

The NetBackup for PostgreSQL Agent 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 master server.

-t Configures the target directory to restore the data.

-u Configures the database user name.

-z Configures the LVM snapshot size.

NetBackup for PostgreSQL Agent command

conventions
This document uses the following conventions when describing 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 43
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 master_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 45
nbpgsql -o backup

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

SYNOPSIS
nbpgsql -o backup

-S master_server

-P policy_name

-s schedule_name

(Linux) -l postgresql_library_path

(Linux) -z snapshot_size

[-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 -l and -z are required
parameters for Linux. The -portnum and -u are the optional parameters.
On Linux systems, the directory path is /usr/NBPostgreSQLAgent/.
On Windows, the directory path is install_path\NBPostgreSQLAgent\.

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.
-S
Configures the NetBackup server name.
 NetBackup for PostgreSQL commands 46
nbpgsql -o backup

-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.
 NetBackup for PostgreSQL commands 47
nbpgsql -o restore

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

SYNOPSIS
nbpgsql -o restore -S master_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/NBPostgreSQLAgent/
On Windows systems, the directory path to this command is
install_path/NBPostgreSQLAgent/

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

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

SYNOPSIS
nbpgsql -o query -S master_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/PostgreSQLAgent/
On Windows systems, the directory path to this command is
install_path/NBPostgreSQLAgent/

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 PostgreSQL commands 49
nbpgsql -o delete

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

SYNOPSIS
nbpgsql -o delete -S master_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 master server.
 Index

A restores
authenticating password 13 recovery 31
redirected restore 31
B
backups U
archive directory 24 uninstall 13
delete 24
query 24
schema files 24
symbolic link 24
Write-Ahead logs level 24

I
installation
privileges 13
symbolic link 13

N
nbpgsql file
configuration file 19
configuration parameters 19
database server port 19
log level 19
log size 19

P
PostgreSQL Agent
components 9
features 9
license 9
package 9

R
redirected restore
altnames 31
different file path 31
different host 31
restore
target directory 31