Search <book_title>...

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

Last Published: 2021-01-01

Product(s): NetBackup (9.0.0.1, 9.0)

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

Variable Name	Description	Format
BSA_API_VERSION	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.
BSA_DELIMITER	Optional. The delimiter that is used in hierarchical character strings (default "/").	A single ASCII character.
BSA_SERVICE_PROVIDER	Optional. Identifies the XBSA implementation. BSAQueryServiceProvider() can retrieve this value.	A hierarchical character string with 3 fields.
BSA_SERVICE_HOST	Optional. Identifies a specific host system for the NetBackup server.	A string containing a host name.

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

Variable Name	Description	Format
NBBSA_CLIENT_HOST	Optional. Identifies a specific host system for the NetBackup client.	A string containing a host name.
NBBSA_DB_TYPE	Optional. Specifies a specific policy type.	A string containing the policy type.
NBBSA_FEATURE_ID	Optional. Specifies a specific NetBackup licensed feature within the DataStore policy type.	An integer value.
NBBSA_KEYWORD	Optional. Specifies the NetBackup Keyword field for this image.	A string containing a keyword value <= 100 characters.
NBBSA_LOG_DIRECTORY	Optional. Identifies the name of directory that contains the log files of the XBSA application.	A string containing a single directory name.
NBBSA_OBJECT_GROUP	Optional. This variable is used to define the object group owner of an object being created.	A string containing the group.
NBBSA_OBJECT_OWNER	Optional. This variable is used to define the object owner of an object being created.	A string containing the owner.
NBBSA_OBJINFO_LEN	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.
NBBSA_POLICY	Optional. Identifies a specific NetBackup policy to be used.	A string containing a NetBackup policy name.
NBBSA_SCHEDULE	Optional. Identifies a specific NetBackup XBSA schedule to be used.	A string containing a NetBackup schedule name.
NBBSA_USE_OBJECT_GROUP	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.
NBBSA_USE_OBJECT_OWNER	Optional. This variable can be set to cause the owner of an object to be something other than the logon user creating the object.	An integer value between 0 and 4.

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

Variable Name	Description	Format
NBBSA_VERBOSE_LEVEL	The verbose level of the database logs.	An integer value between 0 and 9.
NBBSA_MULTIPLEXING	The NetBackup multiplexing value.	An integer value.
NBBSA_SERVER_BUFFSIZE	The NetBackup server buffer size value.	An integer value in bytes.
NBBSA_MEDIA_MOUNT_TIMEOUT	The NetBackup MEDIA_MOUNT_TIMEOUT value.	An integer value in seconds.
NBBSA_CLIENT_READ_TIMEOUT	The NetBackup CLIENT_READ_TIMEOUT value. This value can be modified by the XBSA application.	An integer value in seconds.