NetBackup™ for PostgreSQL Administrator's Guide

Last Published:
Product(s): NetBackup (11.0)
  1. Overview
    1.  
      Overview of configuring and protecting PostgreSQL assets in the NetBackup web UI
  2. Managing PostgreSQL instances and databases
    1.  
      Quick configuration checklist to protect PostgreSQL instances and databases
    2.  
      Configure PostgreSQL instance
    3.  
      Add a PostgreSQL instance
    4.  
      Manage credentials for an instance
    5.  
      Discover PostgreSQL databases
    6.  
      Remove PostgreSQL instances
    7.  
      Change the autodiscovery frequency of PostgreSQL assets
  3. Managing PostgreSQL environment credentials
    1.  
      Add new PostgreSQL credentials
    2.  
      Default PostgreSQL Administrator
    3.  
      Validate credentials of PostgreSQL instance
    4.  
      View the credential name that is applied to an asset
    5.  
      Edit or delete a named credential
  4. Protecting PostgreSQL instances and databases
    1.  
      Things to know before you protect PostgreSQL instances and databases
    2.  
      Protect PostgreSQL instances and databases
    3.  
      Customize protection settings for the PostgreSQL assets
    4.  
      Remove protection from PostgreSQL instances
    5.  
      View the protection status of PostgreSQL instance
  5. Restoring PostgreSQL Instances and Databases
    1.  
      Things to know before you restore the PostgreSQL instances and databases
    2.  
      About the pre-restore check
    3.  
      Restore PostgreSQL instance and database
    4.  
      Restore target options
    5.  
      Pre-restore checks for PostgreSQL
    6.  
      Steps to perform recovery after restore operation
    7.  
      Steps to perform after Restore and Recovery for PostgreSQL cluster deployment
    8.  
      Limitations
  6. Troubleshooting PostgreSQL operations
    1.  
      Troubleshooting tips for NetBackup for PostgreSQL
    2.  
      Error during PostgreSQL credential addition
    3.  
      Error during the PostgreSQL instances and databases discovery phase
    4.  
      Error during the PostgreSQL Protection Plan Creation
    5.  
      Error while subscribing protection plan to PostgreSQL asset
    6.  
      Error while removing PostgreSQL asset
    7.  
      Error while backup of PostgreSQL asset
    8.  
      Error while restoring PostgreSQL asset image
  7. API for PostgreSQL instances and databases
    1.  
      Using APIs to manage, protect or restore PostgreSQL
  8.  
    Index

Using APIs to manage, protect or restore PostgreSQL

This topic lists the APIs to manage, protect or restore the PostgreSQL instances and databases. Only the important variables and options are mentioned in this topic.

Following sections are part of this topic:

For detailed information on the APIs, use these references:

Add a PostgreSQL instance

Table: Add a PostgreSQL instance

API

Important variables and options

POST
/netbackup/asset-service/queries
GET
/netbackup/asset-service/queries/{aqcId}
GET
/netbackup/asset-service/workloads 
/postgresql/assets

  • clientName is the name of the PostgreSQL instance.

  • sqlHostName is hostname of a NetBackup client.

  • credentialName are credentials associated with PostgreSQL instance.

    Note:

    The credential must exist with credentialName mentioned.

  • port is port number of PostgreSQL instance.

PostgreSQL Discovery API

Table: Discover the PostgreSQL asset for given client

API

Important variables and options

POST
/netbackup/admin/discovery
/workloads/postgresql/start

POST 
/netbackup/admin/discovery/workloads
/postgresql/stop

GET
/netbackup/admin/discovery/workloads
/postgresql/status

POST 
/netbackup/admin/discovery/workloads
/postgresql/allclientsdiscovery

  • serverName is used to identify instance or database

  • discoveryHost is hostname where discovery needs to be triggered

  • allclientsdiscovery triggers discovery for all the clients host associated with the primary.

Create a PostgreSQL Protection Plan

Table: Create a PostgreSQL Protection Plan

API

Important variables and options

POST 
/netbackup/servicecatalog/slos

POST
/netbackup/servicecatalog/slos/{sloId}
/subscriptions

POST
/netbackup/servicecatalog/slos/{sloId}
/backup-now

  • policyType is DataStore.

  • Add scheduleName can have values like FULL_AUTO or INCR_AUTO for adding PostgreSQL instance.

  • keyword can have the following values to back up an instance or database using different backup options:

    • pg_dump

    • pg_basebackup

    • Snapshot

    • pg_dumpall

  • sloId is the identifier to protection plan

  • selectionId is the AssetId which needs to be subscribed with given sloId

After you create a protection plan, other processes like creating the schedule for the policy or triggering the policy backup remain the same.

PostgreSQL Recovery point Service API

Table: PostgreSQL asset backup instances available for recovery

API

Important variables and options

GET
/netbackup/recovery-point-service
/workloads/postgresql/recovery-points 

GET
/netbackup/recovery-point-service
/workloads/postgresql/recovery-points
/{backupId}


GET
/netbackup/wui/workloads/postgresql
/recovery-point-calendar-summary

  • backupId is identifier that was used at the time of backup.

  • assetId is identifier that was used to identify instance or database.

  • client hostname is name of backup client.

Restore the PostgreSQL instance and database at the original location

Table: Restore the PostgreSQL instance and database at the original location

API

Important variables and options

POST
/netbackup/recovery/workloads/postgresql/
scenarios/instance-complete-recovery  
/recover
POST 
/netbackup/recovery/workloads/postgresql   
/scenarios/database-complete-recovery
/recover

  • backupId is identifier that was used at the time of backup.

  • assetId is identifier that was used to identify instance or database.

  • Client is server that is to be used as the PostgreSQL recovery host to perform this recovery. Set the following value:

    renameAllFilesToSameLocation
Restore the PostgreSQL instance and database to an alternate location

Table: Restore the PostgreSQL instance and database to an alternate location

API

Important variables and options

POST
/netbackup/recovery/workloads/postgresql/
scenarios/instance-complete-recovery
/recover
POST 
/netbackup/recovery/workloads/postgresql
/scenarios/database-complete-recovery
/recover

  • backupId is identifier that was used at the time of backup.

  • assetId is identifier that was used to identify instance or database.

  • Client is server that is to be used as the PostgreSQL recovery host to perform this recovery. Set the following value:

    renameEachFileToDifferentLocation