Chat now with support
Chat with Support

NetVault Plug-in for PostgreSQL 11.4.5 - User Guide

Verifying installation of libpq library

The libpq library included in PostgreSQL contains a set of library functions that lets client programs submit queries to the PostgreSQL Server and receive the query results. Because the plug-in acts as a client and uses the libpq library, ensure that your PostgreSQL installation contains the libpq library, whether it installed on Linux, UNIX, or Windows. If the library is not installed, you might encounter a “Required Library Not Found” message while using the plug-in. For more information, see your PostgreSQL documentation.

Adding a database cluster

To begin using Plug‑in for PostgreSQL, first add the target database cluster to the plug-in. If you are running more than one database cluster, follow this procedure for each database cluster to be protected using the plug-in.

 
1
In the Navigation pane of the NetVault Backup WebUI on the NetVault Backup Server, click Create Backup Job, and click Create New next to the Selections list.
2
In the selection tree, open the applicable client node, and select Plug‑in for PostgreSQL.
3
From the Actions list, select Add Database Cluster.
4
In the Add Database Cluster dialog box, set the following parameters:
•
Database Cluster Name: Enter a name for the database cluster; by default, the local host name is used. This value is used in the NetVault Backup WebUI. Quest strongly recommends that you use a generic name for the PostgreSQL cluster instead of using a name associated with the machine on which the cluster resides. This generic name improves portability and policy management across all affected clients. When adding more than one cluster, ensure that a unique name is used for identification.
For example, if the machine name is test_postgresql_01_machine, and the suggested name for the PostgreSQL cluster is the same, change the name for the instance to something such as local_postgresql_database_cluster. You can then use the same name, local_postgresql_database_cluster, when you configure the other PostgreSQL clients. Therefore, the cluster name on all clients is local_postgresql_database_cluster.
•
Port: This field is preconfigured to port 5432, which is the default listener port for PostgreSQL. Enter the correct port number in this field, if PostgreSQL is configured to listen on any other port. When adding multiple database clusters, ensure that a different listener port is configured for each cluster.
•
Database SuperUser: This field defaults to the superuser postgres. If applicable, enter a different user with superuser privileges for the plug-in’s use.
•
Password: Enter the password associated with the user specified in the preceding field. Ensure that the password is correct. If the cluster is configured to use TRUST authentication for the HOST connection while using PASSWORD authentication for the LOCAL connection, the backups fail if the password is incorrect or blank. To avoid this issue, either use TRUST authentication for both the HOST and LOCAL connections, in which case no password is required, or use PASSWORD authentication for both items in the “pg_hba.conf” file, and provide the password here.
 
* 
NOTE: If the “pg_hba.conf” file contains entries for both IPv4 and IPv6, configure the same authentication for each. For example, use TRUST authentication for both IPv4 and IPv6 connections.

You can use MD5 hash passwords.
•
PostgreSQL Bin Directory: Enter the complete path to the PostgreSQL bin directory. For example, this path is “C:\Program Files\PostgreSQL\8.2\bin” for a default installation of PostgreSQL version 8.2 on the Windows platform.
•
PostgreSQL Library Directory or Path (Linux/UNIX-based systems only): Enter the complete path to the directory that contains the “libpq.so” file or to the file itself, for example, “/usr/lib/libpq.so.5.0”.
•
PostgreSQL Data Directory: Specify the complete path to the directory that contains the configuration files “postgresql.conf,” “pg_hba.conf,” and “pg_ident.conf.” By default, PostgreSQL stores the configuration files in the data directory. For example, this path is “C:\Program Files\PostgreSQL\8.2\data” for a default installation of PostgreSQL version 8.2 on the Windows platform.
•
Database Used for Initial Connection: For the plug-in's initial connection, the postgres database is used by default. To use a different database for connecting to the server, specify the database name in this field.
•
Template Database Used During CREATE Database: The template specified in this field is used for creating an empty database during the restore process. Quest recommends that you use the default template0. Backups are performed relative to template0, which means that any languages and procedures added to template1 are included in the backup. As a result, if you are using customized template1, you must create the database from an empty template such as template0. Otherwise, errors due to duplicate definitions might occur during the restore process.
•
Default Character Set: From the list, select the Character Set Encoding that the plug-in uses to display the names of databases and tables in the set locale. The following table lists the supported encodings. If an incompatible encoding is configured, you cannot browse the tree, or perform backups or restores.
 
Character set encoding
Language

BIG5

Traditional Chinese

EUC_CN

Simplified Chinese

EUC_JP

Japanese

EUC_KR

Korean

EUC_TW

Traditional Chinese

GB18030

Simplified Chinese

LATIN1
•
English
•
French
•
German

SQL_ASCII

Any

SJIS

Japanese

UTF8

Any

 
* 
IMPORTANT: The UTF8 and SQL_ASCII encodings can be used with any language, however, the support is limited to ASCII character set. If the database or table names contain non-ASCII characters, set a locale-specific encoding, for example, EUC_JP for Japanese. For more information, see http://www.postgresql.org/docs/9.2/static/multibyte.html.
5
To save the settings, click OK.
The plug-in verifies the values specified and adds the database cluster if all parameters are properly configured.
An error message is displayed if an invalid entry is found. You can choose to ignore this message and click Save to add the database. The database cluster is added, however, note the following:
•
If the superuser name or password cannot be validated, further access is denied.
•
If the PostgreSQL Data Directory is invalid, while all other parameters are correctly configured, the backups of databases are completed but the backups of configuration files fail.
•
If the PostgreSQL Bin Directory is invalid, while all other parameters are correctly configured, you are able to submit a job but the job fails.
If an error occurs while adding a database cluster and you must reconfigure the parameters, see Correcting invalid parameters.

Correcting invalid parameters

If a parameter is not correctly configured, an error message is displayed. You can ignore this message and save the information. However, further access is denied or backup jobs might not complete successfully until you correct the error.

1
In the error message that is displayed, click Re-configure.
2
In the Add Database Cluster dialog box, enter the correct values for the parameters reported as invalid.
 
* 
IMPORTANT: The password field appears blank. If the previously configured password is correct, you do not have to re-enter the password; the plug-in uses the cached (old) password for authentication when this field is blank. Otherwise, enter the correct password in this field.
3
To reconfigure the parameters, click OK.

Reconfiguring an added database cluster

1
In the Navigation Pane, click Create Backup Job, and click Create New next to the Selections list.
2
In the selection tree, open the applicable client node.
3
Open the Plug‑in for PostgreSQL node, and select the applicable database-cluster node.
4
From the Actions list, select Configure.
The Configure dialog box is displayed with all previous settings revealed, allowing you to make any necessary modifications.
5
On the Configure Database Cluster dialog box that is displayed, update the parameters as required.
For more information, see Adding a database cluster.
Note the following:
•
You cannot change the Database Cluster Name.
•
The password field appears blank. If the previously configured password is still valid, you do not have to re-enter the password; the plug-in uses the cached (old) password for authentication when this field is blank. Otherwise, enter the correct password in this field.
6
To save the settings, click OK.
 
* 
IMPORTANT: If the password for the configured superuser is changed in the PostgreSQL database, update the password in the plug-in.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating