Veritas NetBackup™ DataStore SDK Programmer's Guide for XBSA 1.1.0
- Introduction to NetBackup XBSA
- How to set up the SDK
- Using the NetBackup XBSA interface
- Getting help with the API
- NetBackup XBSA data structures
- NetBackup XBSA environment
- XBSA sessions and transactions
- Creating a NetBackup XBSA application
- How to build an XBSA application
- How to run a NetBackup XBSA application
- API reference
- Error messages
- Function calls
- Function specifications
- BSABeginTxn
- BSACreateObject
- BSADeleteObject
- BSAEndData
- BSAEndTxn
- BSAGetData
- BSAGetEnvironment
- BSAGetLastError
- BSAGetNextQueryObject
- BSAGetObject
- BSAInit
- BSAQueryApiVersion
- BSAQueryObject
- BSAQueryServiceProvider
- BSASendData
- BSATerminate
- NBBSAAddToMultiObjectRestoreList
- NBBSADeleteImage
- NBBSAEndGetMultipleObjects
- NBBSAFreeJobInfo
- NBBSAGetEnv
- NBBSAGetErrorString
- NBBSAGetJobId
- NBBSAGetJobInfo
- NBBSAGetMediaIds
- NBBSAGetMultipleObjects
- NBBSAGetServerError
- NBBSALogMsg
- NBBSASetEnv
- NBBSAUpdateEnv
- NBBSAValidateFeatureId
- Type definitions
- Process flow and troubleshooting
- How to use the sample files
- Support and updates
- Appendix A. Register authorized locations
- Index
Backups and restores initiated by NetBackup (through a script)
The XBSA application can be initiated through NetBackup. This lets the XBSA application be treated like the rest of the system environment when creating and scheduling backup windows and other resource considerations. Backup and restore operations through NetBackup are done through scripts. When a DataStore policy is configured, the Files list is a script that is to be executed when the backup or restore is initiated. That script is executed as a user-directed backup. These scripts should contain any commands that are required to prepare the application for a backup or restore, including setting up an environment, halting processes, and so on, along with calling the XBSA application with the parameters that are required to execute the backup or restore operations.
Note:
All scripts must be stored and run locally. One recommendation is that scripts should not be world-writable. Scripts are not allowed to be run from network or remote locations. Any script that is created and saved in the NetBackup db_ext (UNIX) or dbext (Windows) location needs to be protected during a NetBackup uninstall.
For more information about registering authorized locations and scripts, review the knowledge base article:
There is no ability to browse for backups. The Files list is a script to be executed, not a list of objects that can be restored. It is up to these scripts to determine what needs to be backed up or conversely what XBSA objects need to be restored. In this regard, the XBSA application needs to be fairly intelligent or allow options that can be specified to give the script the ability to be intelligent.