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
BSA_ObjectName
The BSA_ObjectName structure is the name assigned by an XBSA application to a NetBackup XBSA object. It is defined as follows:
typedef struct {
char objectSpaceName[BSA_MAX_OBJECTSPACENAME];
char pathName[BSA_MAX_PATHNAME];
} BSA_ObjectName;The usage of the structure fields is defined as follows:
Table: BSA_ObjectName Structure Fields
Field Name | Definition |
|---|---|
objectSpaceName | Highest-level name qualifier |
pathName | Object name within objectSpaceName |
An objectSpaceName is an optionally defined, fixed-length character string. It identifies a logical space, called an object space, to which the object belongs. For example, an object space may be used to identify a storage volume (for example, a disk partition, or a floppy disk), or a database in the XBSA application's domain.
The NetBackup XBSA interface uses the concept of an object space to provide a primary grouping of NetBackup XBSA objects that can be used for an object search by a user and/or for object management. Additional groupings are provided by object attributes. Examples of an objectSpaceName are C: Drive and VolumeLabel=XYZ.
A pathName is a hierarchical character string that identifies a NetBackup XBSA object within an ObjectSpace. While the pathname does not need to correspond to an actual file path, NetBackup requires that the first character is a '/'. This is true for both UNIX and Windows.
An example of a pathName for the backup copy of a UNIX file can be its original path name and file name, for example, /x/y/z/xyx.c.
The value of the delimiter that is used to separate the name components can be obtained by calling BSAGetEnvironment().