NetBackup™ Web UI MySQL Administrator's Guide

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

Using APIs to manage, protect or restore MySQL

This topic lists the APIs to manage, protect or restore the MySQL 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 MySQL instance

Table: Add a MySQL instance

API

Important variables and options

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

  • clientName is the name of the MySQL instance.

  • sqlHostName is hostname of a NetBackup client.

  • credentialName are credentials associated with MySQL instance.

    Note:

    The credential must exist with credentialName mentioned.

  • port is port number of MySQL instance.

MySQL Discovery API

Table: Discover the MySQL asset for given client

API

Important variables and options

POST
/netbackup/admin/discovery
/workloads/mysql/start

POST 
/netbackup/admin/discovery/workloads
/mysql/stop

GET
/netbackup/admin/discovery/workloads
/mysql/status

POST 
/netbackup/admin/discovery/workloads
/mysql/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 master.

Create a MySQL Protection Plan

Table: Create a MySQL 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 MySQL instance.

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

    • mysqldump

    • Snapshot

  • 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.

MySQL Recovery point Service API

Table: MySQL asset backup instances available for recovery

API

Important variables and options

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

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


GET
/netbackup/wui/workloads/mysql
/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 MySQL instance and database at the original location

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

API

Important variables and options

POST
/netbackup/recovery/workloads/mysql/
scenarios/instance-complete-recovery  
/recover
POST 
/netbackup/recovery/workloads/mysql   
/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 MySQL recovery host to perform this recovery. Set the following value:

    renameAllFilesToSameLocation
Restore the MySQL instance and database to an alternate location

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

API

Important variables and options

POST
/netbackup/recovery/workloads/mysql/
scenarios/instance-complete-recovery
/recover
POST 
/netbackup/recovery/workloads/mysql
/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 MySQL recovery host to perform this recovery. Set the following value:

    renameEachFileToDifferentLocation