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
Environment variable definitions
The following XBSA environment variables are defined as part of the XBSA specification and are accepted by the NetBackup XBSA interface.
Table: XBSA Environment Variables
Mandatory. Specifies the version of the specification that the calling XBSA application requires. BSAQueryApiVersion() can retrieve the value of the current NetBackup XBSA interface.
A string containing 3 numeric elements, (version, issue, level) separated by periods.
Optional. The delimiter that is used in hierarchical character strings (default "/").
A single ASCII character.
Optional. Identifies the XBSA implementation. BSAQueryServiceProvider() can retrieve this value.
A hierarchical character string with 3 fields.
Optional. Identifies a specific host system for the NetBackup server.
In addition to the environment variables that are defined in the XBSA specification, the following NetBackup XBSA environment variables are defined as part of this specification. These are specific to NetBackup and are not relevant to other XBSA implementations. See the NetBackup System Administrator's Guide, Volume I, for a more complete definition of the NetBackup policy, schedule, and logging. The NetBackup environment variables all are prefaced with "NB."
Table: NetBackup Environment Variables
Optional. Identifies a specific host system for the NetBackup client.
A string containing a host name.
Optional. Specifies a specific policy type.
A string containing the policy type.
Optional. Specifies a specific NetBackup licensed feature within the DataStore policy type.
An integer value.
Optional. Specifies the NetBackup Keyword field for this image.
A string containing a keyword value <= 100 characters.
Optional. Identifies the name of directory that contains the log files of the XBSA application.
A string containing a single directory name.
Optional. This variable is used to define the object group owner of an object being created.
A string containing the group.
Optional. This variable is used to define the object owner of an object being created.
A string containing the owner.
Optional. If this variable is set before an XBSA object is created, the objectInfo field is considered to be this length and the object is considered binary.
An integer value <= 256.
Optional. Identifies a specific NetBackup policy to be used.
A string containing a NetBackup policy name.
Optional. Identifies a specific NetBackup XBSA schedule to be used.
A string containing a NetBackup schedule name.
Optional. This variable can be set to cause the group of an object to be something other than the logon user creating the object.
An integer value between 0 and 4.
Optional. This variable can be set to cause the owner of an object to be something other than the logon user creating the object.
The following XBSA environment variables are set by the NetBackup XBSA interface from values in the NetBackup configuration files. These environment variables are used to pass required information from NetBackup to the XBSA application. Descriptions of these NetBackup configuration values can be found in the NetBackup System Administrator's Guide, Volume I.
Table: XBSA Environment Variables for NetBackup Configuration Values
The verbose level of the database logs.
An integer value between 0 and 9.
The NetBackup multiplexing value.
An integer value.
The NetBackup server buffer size value.
An integer value in bytes.
The NetBackup MEDIA_MOUNT_TIMEOUT value.
An integer value in seconds.
The NetBackup CLIENT_READ_TIMEOUT value. This value can be modified by the XBSA application.