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
- NetBackup XBSA data structures
- NetBackup XBSA environment
- XBSA sessions and transactions
- Creating a NetBackup XBSA application
- Initiating a session
- Backup - creating an object
- Query - finding an object descriptor
- Restore - retrieving an object's data
- Delete - deleting an object or image
- Media IDs - obtaining media IDs
- How to build an XBSA application
- How to run a NetBackup XBSA application
- About How to run a NetBackup XBSA application
- API reference
- Function calls
- Function specifications
- Type definitions
- Process flow and troubleshooting
- How to use the sample files
- Support and updates
- Appendix A. Register authorized locations
Initiating a session
A session is initiated with a call to BSAInit(). One of the parameters of BSAInit() is the list of environment variables that is used to set up the XBSA environment between the XBSA application and the NetBackup XBSA interface. The only variable that is required by the NetBackup XBSA interface is BSA_API_VERSION. BSAInit() validates that the XBSA application uses a supported version. Other environmental variables can be included to increase flexibility of the application or to override values from the NetBackup configuration. But if these variables are not set, there are defaults from the configuration that are used.
Using these environment variables does not allow the XBSA application to bypass the NetBackup configuration, only to change from the default. All hosts, policies, schedules, and so on that are used must still be defined in the NetBackup configuration in order for the transactions to work. See the NetBackup System Administrator's Guide, Volume I, for more information on how to configure NetBackup.
The XBSA application should allow the XBSA environment variables to be set from run time values. These values can be obtained from parameters or from system environment variables. This allows the maximum flexibility for the application.
Some of the XBSA environment variables must be specified in the call to BSAInit() and cannot be changed within the session. Others can be set or modified within the session which gives the XBSA application maximum flexibility.
More information is available for the individual variables.