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
Querying for an object
When querying for an object, the object attributes that the XBSA application is querying for are contained in a query descriptor. This query descriptor is made up of strings and enumerations. They are evaluated against the objects stored in the NetBackup catalog for objects that match all fields. Each field of the query descriptor must be populated. If a string field is populated with an empty string or NULL, it only matches objects that also have an empty string for that field. Wildcards and 'ANY' enumerations allow the XBSA application to search for objects that have some fields that are unknown.
There are two fields that are not part of the XBSA specifications but can be very useful. The createTime_from and createTime_to fields limit the search to the time period between these dates. These are optional fields, the default is to search all objects, but can greatly speed up the search when the NetBackup catalog is very large.
When doing the query, the XBSA application only returns objects that are owned by the logon user running the query, unless that user is a root admin. NetBackup XBSA Version 1.1.0 uses the logon user as the object owner. The objectOwner field is considered an attribute and is not used for security.
The query, by default, also only returns objects that were created on the hostname from which the query is being run. If the XBSA application needs to find an object that was created from a different host, the NBBSA_CLIENT_HOST environment variable must be set to the hostname from which the object was created. This variable can only be set before a transaction begins. If the application is looking for objects from multiple hosts, the application needs to do queries in separate transactions.