Veritas NetBackup™ DataStore SDK Programmer's Guide for XBSA 1.1.0

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  1. Introduction to NetBackup XBSA
    1.  
      About Introduction to NetBackup XBSA
    2.  
      What is NetBackup XBSA?
    3.  
      What does NetBackup XBSA do?
    4.  
      Terminology
    5.  
      Important concepts
    6.  
      Resources
  2. How to set up the SDK
    1.  
      System requirements
    2. Installing the SDK
      1.  
        Installation requirements
      2.  
        Installation instructions for UNIX platforms
      3.  
        Installation instructions for Windows platforms
    3.  
      Uninstalling the SDK
    4.  
      Configuration
    5.  
      Description of the XBSA SDK package
    6.  
      Library files
    7.  
      Header files
  3. Using the NetBackup XBSA interface
    1.  
      Getting help with the API
    2. NetBackup XBSA data structures
      1.  
        Object data
      2.  
        Object descriptors
      3.  
        Query descriptors
      4. Buffers
        1.  
          Buffer size
        2.  
          Private buffer space
        3.  
          Use of BSA_DataBlock32 in BSASendData()
        4.  
          Use of BSA_DataBlock32 in BSAGetData()
        5.  
          Shared memory
    3. NetBackup XBSA environment
      1.  
        Environment variable definitions
      2.  
        Extended environment variable definitions
    4. XBSA sessions and transactions
      1. Sessions
        1.  
          Initialization and termination
        2.  
          Authentication
      2. Transactions
        1.  
          Backup transaction
        2.  
          Restore transaction
        3.  
          Delete transaction
        4.  
          Query transaction
        5.  
          Media IDs transaction
    5. Creating a NetBackup XBSA application
      1. Initiating a session
        1.  
          Modifying the XBSA environment within a session
        2.  
          Session example
      2. Backup - creating an object
        1.  
          Creating an object
        2.  
          NetBackup object ownership
        3.  
          Creating an empty object
        4.  
          Backup example
      3. Query - finding an object descriptor
        1.  
          Querying for an object
        2.  
          Query example
      4. Restore - retrieving an object's data
        1.  
          Restoring an object
        2.  
          Redirected restore to a different client
        3.  
          Restore example
        4.  
          Multiple object restore
        5.  
          Multiple object restore example
      5. Delete - deleting an object or image
        1.  
          Delete example
      6. Media IDs - obtaining media IDs
        1.  
          Media ID example
      7.  
        Logging and NetBackup
      8.  
        Client in a cluster
      9.  
        Performance considerations
  4. How to build an XBSA application
    1.  
      Getting help
    2.  
      Flags and defines
    3.  
      How to build in debug mode
    4.  
      How to debug the application
    5.  
      Static libraries
    6.  
      Dynamic libraries
    7.  
      End-user configuration
  5. How to run a NetBackup XBSA application
    1. About How to run a NetBackup XBSA application
      1. Creating a NetBackup policy
        1.  
          Selecting a storage unit
        2.  
          Adding new schedules
        3.  
          Adding script files to the files list
        4.  
          Adding new clients
      2.  
        Running a NetBackup XBSA application
      3.  
        Backups and restores initiated by NetBackup (through a script)
      4.  
        Backups and restores from the command line
  6. API reference
    1.  
      Error messages
    2. Function calls
      1.  
        Conventions
    3. Function specifications
      1.  
        BSABeginTxn
      2.  
        BSACreateObject
      3.  
        BSADeleteObject
      4.  
        BSAEndData
      5.  
        BSAEndTxn
      6.  
        BSAGetData
      7.  
        BSAGetEnvironment
      8.  
        BSAGetLastError
      9.  
        BSAGetNextQueryObject
      10.  
        BSAGetObject
      11.  
        BSAInit
      12.  
        BSAQueryApiVersion
      13.  
        BSAQueryObject
      14.  
        BSAQueryServiceProvider
      15.  
        BSASendData
      16.  
        BSATerminate
      17.  
        NBBSAAddToMultiObjectRestoreList
      18.  
        NBBSADeleteImage
      19.  
        NBBSAEndGetMultipleObjects
      20.  
        NBBSAFreeJobInfo
      21.  
        NBBSAGetEnv
      22.  
        NBBSAGetErrorString
      23.  
        NBBSAGetJobId
      24.  
        NBBSAGetJobInfo
      25.  
        NBBSAGetMediaIds
      26.  
        NBBSAGetMultipleObjects
      27.  
        NBBSAGetServerError
      28.  
        NBBSALogMsg
      29.  
        NBBSASetEnv
      30.  
        NBBSAUpdateEnv
      31.  
        NBBSAValidateFeatureId
    4. Type definitions
      1. Enumerated types
        1.  
          BSA_CopyType
        2.  
          BSA_ObjectStatus
        3.  
          BSA_ObjectType
        4.  
          BSA_Vote
        5.  
          Constant values
      2. Data structures
        1.  
          BSA_ApiVersion
        2.  
          BSA_DataBlock32
        3.  
          BSA_ObjectDescriptor
        4.  
          BSA_ObjectName
        5.  
          BSA_ObjectOwner
        6.  
          BSA_QueryDescriptor
        7.  
          BSA_SecurityToken
  7. Process flow and troubleshooting
    1.  
      About Process flow and troubleshooting
    2. Backup
      1. Stream backup process flow description
        1.  
          Stream backup procedure
    3. Restore
      1. Stream restore process flow description
        1.  
          Stream restore procedure
  8. How to use the sample files
    1. What the sample files do
      1. Sample programs
        1.  
          Backup
        2.  
          Restore
        3.  
          Query
        4.  
          Delete
      2.  
        Sample scripts
    2.  
      Description of sample files
    3.  
      How to build the sample programs
  9. Support and updates
    1.  
      About Support and updates
  10. Appendix A. Register authorized locations
    1.  
      Registering authorized locations used by a NetBackup database script-based policy
  11.  
    Index

How to build the sample programs

Also included with the samples are a Makefile for UNIX platforms, Makefile.unix, and one for Windows, Makefile.nt. The Makefiles compile the four sample programs using basic compiler options.

The UNIX Makefile needs to be modified to select which library to use. Library paths for all of the supported platforms are in the Makefile but commented out. The library for the required operating system needs to be chosen along with whether to use an archive library or a shared library.

The following lines are from Makefile.unix. One of the CFLAGS and one of the LIBS definitions need to be uncommented. The default is to compile 64 bit using the dynamic shared libraries.

The CFLAGS definitions are compile options. Select a CFLAGS definition for the system that is being compiled on. Note that this is a very minimal set of options and you can add other compile options based on your environment.

# Uncomment the CFLAGS for the environment that is being compiled

# Solaris sparc 64 bit
#CFLAGS = -xarch=v9

# Solaris Opteron 64 bit
#CFLAGS = -xtarget=opteron -xarch=generic64

# HP IA64 bit
#CFLAGS = -Ae +DSitanium2 +DD64

# AIX 64 bit
#CFLAGS = -q64

# Linux x86 64 bit
#CFLAGS = -m64

# Linux on Power PC 64 bit
#CFLAGS = -m64

DEFINES =
INCLUDES= -I$(XBSA_SDK_DIR)/include

The LIBS definitions define to which XBSA library to link. A shared object library is installed in /usr/openv/lib on all NetBackup clients and can be used for dynamic linking. An archive library for each platform is included in the SDK and can be used to statically link the application. Select a LIBS definition for the system that is being compiled.

# Use one of these LIBS to bind dynamically
 
#LIBS    = -L/usr/openv/lib -lxbsa -lnbclientcST -lnbbasecST
#LIBS    = -L/usr/openv/lib -lxbsa64 -lnbclientcST -lnbbasecST

# Or choose the correct LIBS for your system to bind statically 
 
#LIBS    = $(XBSA_SDK_DIR)/lib/HP-UX-IA64/HP-UX11.31/libxbsa.a
#LIBS    = $(XBSA_SDK_DIR)/lib/Linux/Debian2.6.32/libxbsa64.a -lc -ldl
#LIBS    = $(XBSA_SDK_DIR)/lib/Linux/RedHat2.6.32/libxbsa64.a -lc -ldl
#LIBS    = $(XBSA_SDK_DIR)/lib/Linux/SuSE4.4.73/libxbsa64.a -lc -ldl
#LIBS    = $(XBSA_SDK_DIR)/lib/Linux-ppc64le/IBMpSeriesRedHat3.10.0/libxbsa.a -lc -ldl
#LIBS    = $(XBSA_SDK_DIR)/lib/Linux-ppc64le/IBMpSeriesSuSE4.4.21/libxbsa.a -lc -ldl
#LIBS    = $(XBSA_SDK_DIR)/lib/Linux-s390x/IBMzSeriesRedHat2.6.32/libxbsa.a -lc -ldl
#LIBS    = $(XBSA_SDK_DIR)/lib/Linux-s390x/IBMzSeriesSuSE4.4.73/libxbsa.a -lc -ldl
#LIBS    = $(XBSA_SDK_DIR)/lib/RS6000/AIX6/libxbsa64.a -ldl -lc
#LIBS    = $(XBSA_SDK_DIR)/lib/Solaris/Solaris10/libxbsa64.a -lintl -lsocket -lnsl 
-ldl -ladm
#LIBS    = $(XBSA_SDK_DIR)/lib/Solaris/Solaris_x86_10_64/libxbsa.a -lintl -lsocket 
-lnsl -ldl -ladm

The Windows Makefile may need to be modified to select which Windows library to use. The Windows Makefile needs to be modified if SDK was installed into a directory other than the default c:\Program Files.

#LIBS    = $(XBSA_SDK_DIR)\lib\Windows-x64\Windows\xbsa.lib