Function calls
This section contains the C language definitions for the NetBackup XBSA API functions. The NetBackup XBSA interface includes functions defined by the XBSA specifications and some NetBackup extended functions. Both of these function sets use the type definitions and data structures defined in the next chapter.
The following table lists the XBSA function specifications defined in this topic.
Table: XBSA Function Specifications
Function Call | Operation |
|---|---|
BSAInit | Initialize the environment and set up a session |
BSATerminate | Terminate a session |
BSABeginTxn | Begin a transaction |
BSAEndTxn | End a transaction |
BSACreateObject | Create an XBSA object |
BSASendData | Send a byte stream of data in a buffer |
BSAGetObject | Get an XBSA object |
BSAGetData | Get a byte stream of data using buffers |
BSAEndData | End a BSAGetData() or BSASendData() sequence |
BSADeleteObject | Delete an XBSA object |
BSAQueryObject | Query about XBSA object copies |
BSAGetNextQueryObject | Get the next XBSA object relating to a previous query |
BSAGetEnvironment | Retrieve the current environment for the session |
BSAGetLastError | Retrieve the error code for the last system error |
BSAQueryApiVersion | Query for the current version of the API |
BSAQueryServiceProvider |
The following table lists the NetBackup XBSA function extensions defined later in this topic. These functions are provided by the NetBackup XBSA interface to enhance the usability and performance of an XBSA application used with NetBackup. The use of these functions is not required. An application using strictly XBSA functions is supported.
Table: NetBackup XBSA Function Extensions
Function Call | Operation |
|---|---|
NBBSAAddToMultiObjectRestoreList | Add objects to a list of objects to be restored in one job |
NBBSADeleteImage | Delete a NetBackup image |
NBBSAEndGetMultipleObjects | End the restore of multiple objects |
NBBSAFreeJobInfo | Free job information |
NBBSAGetEnv | Get the value of a single XBSA environment value |
NBBSAGetErrorString | |
NBBSAGetJobId | Get the job ID for a backup or restore transaction |
NBBSAGetJobInfo | Get the job information |
NBBSAGetMedialds | Get the media IDs for a NetBackup image |
NBBSAGetMultipleObjects | Initiate a restore of a list of objects |
NBBSAGetServerError | Get the NetBackup error code and text from the NetBackup server |
NBBSALogMsg | Log a message to the XBSA logs |
NBBSASetEnv | Set the value of a single XBSA environment value |
NBBSAUpdateEnv | Update the current environment for the session |
NBBSAValidateFeatureId | Validate the license key for the specified feature ID |