Search <book_title>...

Veritas NetBackup™ Administrator's Guide, Volume II

Last Published: 2021-06-07

Product(s): NetBackup (9.1)

Using the NetBackup Storage API to get the total backup size information

By default, the total backup size information gather is disabled to reduce the load on the system resources. Beginning with NetBackup 8.1.2, you can use the NetBackup Storage API to get the total backup size.

The following table briefly explains the process to use the NetBackup Storage API to gather total backup size information.

Table: Process to use the NetBackup Storage API to gather total backup size information

Step	Procedure	Reference topics
1	Enable the total backup size information gather.	See Enabling the total backup size information gather.
2	Use the default values for backup size information gather or configure custom values.	See Configuring the parameter values for backup size information gather. See Sample nbdeployutilconfig.txt file.
3	Use the NetBackup Storage API to gather total backup size information	See About the NetBackup Storage API.

Step

Procedure

Reference topics

Enable the total backup size information gather.

See Enabling the total backup size information gather.

Use the default values for backup size information gather or configure custom values.

See Configuring the parameter values for backup size information gather.

See Sample nbdeployutilconfig.txt file.

Use the NetBackup Storage API to gather total backup size information

See About the NetBackup Storage API.

Enabling the total backup size information gather

By default a scheduled run of the nbdeployutil utility does not gather the total backup size information.

To enable the total backup size information gather

In the nbdeployutilconfig.txt file, add the BETB_ENABLE parameter:

[NBDEPLOYUTIL_BETB]
BETB_ENABLE=1

If the option is not enabled, the NetBackup Storage API displays the 404 Not Found error and records the following response:

{
    "errorCode": 227,
    "errorMessage": "no entity was found",
    "details": {}
}

Configuring the parameter values for backup size information gather

Use the following information to update the backup size information gather parameters in the nbdeployutilconfig.txt file:

Open the nbdeployutilconfig.txt file from the following location:
- Windows:
  install_path\netbackup\var\global\
- UNIX:
  /usr/openv/var/global/

Update the data gather parameters as described in the following table:

Parameter	Description
MASTER_SERVERS=<server names>	Use this option to gather backup size information from other master servers. You can add multiple master servers as comma-separated values. By default, the local server is selected as the master server.
BETB_ENABLE	Enable or disables the total backup size information gather. The default value is 0. Set the value to 1 to enable the total backup size information gather.
BETB_PARENTDIR	Location where the backup size information is gathered and analyzed. A gather directory is created for every master server. You can specify a custom directory or location for data gather. The default gather location is: Windows: install_path\netbackup\var\global\ UNIX: /usr/openv/var/global/ The location of the gather directory is: Windows: *<gather_location>\storage\staging\<timestamp_master_server_name>* UNIX: */gather_location/storage/staging/<timestamp_master_server_name>*
BETB_FREQUENCY_IN_DAYS	The frequency in days to gather the backup size information. The default value is 1, which means that the gather runs daily. If you want a weekly report, set the value to 7.
BETB_KEEP_CMD_OUT_FILE	Option to keep or remove the bpimagelist.out and bpstulist.out files. The default value is 0, which means the files are deleted after nbdeployutil runs. If you want to keep the file, set the value to 1. The sample file shows where to put the option.
BETB_LOG_KEEP	Duration in days to keep the gather folder or folders. Logs are located in the gather directory. The default value is 7, which means that the gathered data from the last seven runs is kept in the default folder or in the directory that you set in the BETB_PARENTDIR parameter.

Sample nbdeployutilconfig.txt file

Here is a sample nbdeployutilconfig.txt file that you can refer to:

[NBDEPLOYUTIL_INCREMENTAL]
MASTER_SERVERS=nbu.masterserverone.com,nbu.masterservertwo.com
[NBDEPLOYUTIL_BETB]
BETB_ENABLE=1
BETB_PARENTDIR=install_path\netbackup\var\global\>
BETB_FREQUENCY_IN_DAYS=1
BETB_KEEP_CMD_OUT_FILE=0
BETB_LOG_KEEP=7

About the NetBackup Storage API

The NetBackup Storage API provides access to the backup storage information of the NetBackup master servers.

To view the NetBackup API Reference document

Go to the following URL:
https://sort.veritas.com/documents
From the product list, select NetBackup.
Find NetBackup 9.1 in the list of NetBackup product versions and click Documentation.
Locate API Reference and click on the document icon.