Veritas NetBackup™ Administrator's Guide, Volume II

Last Published:
Product(s): NetBackup (9.1)
  1. NetBackup licensing models and usage reporting
    1.  
      About NetBackup licensing models
    2.  
      Tools for creating and viewing licensing reports
    3.  
      Setting the licensing type for scheduled reports
    4. How capacity licensing works
      1.  
        How capacity licensing detects overlap when multiple policies protect data
      2.  
        Backup policies and agents that support accurate licensing
      3.  
        Requirements before gathering data for multiple master servers in capacity licensing
    5.  
      How NEVC licensing works
    6.  
      Scheduling reports for capacity licensing
    7.  
      Scheduling reports for traditional licensing
    8.  
      Scheduling reports for NetBackup Enterprise Virtual Client (NEVC) licensing
    9.  
      Other configuration for incremental reporting
    10.  
      Troubleshooting failures for usage reporting and incremental reporting
    11.  
      Manually generating licensing reports
    12. Creating and viewing the licensing report
      1.  
        Report tab descriptions
    13. Reviewing a capacity licensing report
      1.  
        Summary tab
      2.  
        Client aliases and multiple IP addresses
      3.  
        Itemization tab
      4.  
        Clients backed up with multiple streams
      5.  
        Data backed up by multiple policies
      6.  
        BigData plug-ins for NetBackup
      7.  
        NetBackup for Exchange agent
      8.  
        NetBackup for NDMP agent
      9.  
        NetBackup for Oracle server agent
      10.  
        NetBackup for SQL Server agent
      11.  
        NetBackup for VMware agent
      12.  
        NetBackup for Hyper-V agent
      13.  
        NetBackup for RHV agent
      14.  
        NetBackup for Nutanix-AHV agent
      15.  
        NAS-Data-Protection policy
      16.  
        Cloud policy
      17.  
        NetBackup for Kubernetes
      18.  
        Windows file system backups
      19.  
        UNIX file system backups
    14. Reconciling the capacity licensing report results
      1.  
        Locate full backups for clients
      2.  
        Review compressed image information
      3.  
        Eliminate redundant counting of clients
      4.  
        Determine the effect of multistreamed backups
      5.  
        Confirm the accuracy of any database backups
      6.  
        Locate full backups for snapshot images
    15. Reviewing a traditional licensing report
      1.  
        Summary tab
      2.  
        Complete the Hosts tab
      3.  
        Resolve the NDMP tab
      4.  
        Update the Virtual Servers tab
      5.  
        Confirm the Drives tab
      6.  
        Final steps
    16. Reviewing an NEVC licensing report
      1.  
        Summary tab
      2.  
        Hosts tab
    17.  
      Using the NetBackup Storage API to get the total backup size information
  2. Additional configuration
    1.  
      About multiple NetBackup master servers
    2.  
      About multiple media servers with one master server
    3.  
      About direct I/O for backups on Windows
    4. About dynamic host name and IP addressing
      1.  
        About setting up dynamic IP addresses and host names
      2.  
        Configuring the NetBackup master server
      3.  
        bpclient commands that control client entries
      4.  
        Configuring dynamic NetBackup clients
    5. About busy file processing on UNIX clients
      1.  
        Configuring busy file processing on UNIX
      2.  
        Modifying bp.conf to configure busy file processing on UNIX
      3.  
        bp.conf file entries on UNIX
      4.  
        How NetBackup creates and uses action files on UNIX
      5.  
        About the logs directory on UNIX
      6.  
        Recommended changes for modifying bpend_notify_busy on UNIX
    6.  
      About specifying the locale of the NetBackup installation
    7. About the Shared Storage Option
      1.  
        About Shared Storage Option components
      2.  
        DELETE About reserving or releasing shared devices
      3.  
        How to share robotic libraries without using the Shared Storage Option
      4.  
        Shared Storage Option terms and concepts
      5.  
        DELETE About the Shared Storage Option license
      6.  
        About Shared Storage Option prerequisites
      7.  
        About hardware configuration guidelines
      8.  
        About installing and configuring drivers
      9.  
        Verifying the connectivity
      10. DELETE About configuring the Shared Storage Option in NetBackup
        1.  
          About configuring SSO in NetBackup
        2.  
          Configuring Shared Storage Option devices in NetBackup
        3.  
          About adding Shared Storage Option configuration options
        4.  
          About configuring NetBackup storage units and backup policies
      11.  
        Verifying your Shared Storage Option configuration
      12.  
        Device Monitor and Shared Storage Option
      13. Viewing SSO summary reports
        1.  
          Shared Storage Option summary reports
      14.  
        Operating system assistance
      15.  
        Common configuration issues with Shared Storage Option
      16.  
        Frequently asked questions about Shared Storage Option
    8. About the vm.conf configuration file
      1.  
        ACS_mediatype entry in vm.conf
      2.  
        ACS_SEL_SOCKET entry in vm.conf
      3.  
        ACS_CSI_HOSTPORT entry in vm.conf (on UNIX)
      4.  
        ACS_SSI_HOSTNAME entry in vm.conf
      5.  
        ACS_SSI_INET_PORT entry in vm.conf (on UNIX)
      6.  
        ACS_SSI_SOCKET entry in vm.conf
      7.  
        ACS_TCP_RPCSERVICE / ACS_UDP_RPCSERVICE entry in vm.conf (on UNIX)
      8.  
        ADJ_LSM entry in vm.conf
      9.  
        API_BARCODE_RULES entry in vm.conf
      10.  
        AUTHORIZATION_REQUIRED entry in vm.conf in NetBackup versions 8.0 and earlier
      11.  
        AUTO_PATH_CORRECTION entry in vm.conf
      12.  
        AUTO_UPDATE_ROBOT entry in vm.conf
      13.  
        AVRD_PEND_DELAY entry in vm.conf
      14.  
        AVRD_SCAN_DELAY entry in vm.conf
      15.  
        CLEAN_REQUEST_TIMEOUT entry in vm.conf
      16.  
        CLIENT_PORT_WINDOW entry in vm.conf
      17.  
        CLUSTER_NAME entry in vm.conf
      18.  
        DAYS_TO_KEEP_LOGS entry in vm.conf
      19.  
        EMM_RETRY_COUNT entry in vm.conf
      20.  
        EMM_CONNECT_TIMOUT entry in vm.conf
      21.  
        EMM_REQUEST_TIMOUT entry in vm.conf
      22.  
        ENABLE_ROBOT_AUTH entry in vm.conf
      23.  
        INVENTORY_FILTER entry in vm.conf
      24.  
        MAP_ID entry in vm.conf
      25.  
        MAP_CONTINUE_TIMEOUT entry in vm.conf
      26.  
        MEDIA_ID_BARCODE_CHARS entry in vm.conf
      27.  
        MEDIA_ID_PREFIX entry in vm.conf
      28.  
        MM_SERVER_NAME entry in vm.conf
      29.  
        PREFERRED_GROUP entry in vm.conf
      30.  
        RANDOM_PORTS entry in vm.conf
      31.  
        REQUIRED_INTERFACE entry in vm.conf
      32.  
        SERVER entry in vm.conf in NetBackup versions 8.0 and earlier
      33.  
        SSO_DA_REREGISTER_INTERVAL entry in vm.conf
      34.  
        SSO_DA_RETRY_TIMEOUT entry in vm.conf
      35.  
        SSO_HOST_NAME entry in vm.conf
      36.  
        VERBOSE entry in vm.conf
      37.  
        Example vm.conf file
      38.  
        How to access media and devices on other hosts
      39.  
        Host name precedence in the vm.conf file
  3. Holds Management
    1.  
      About Holds Management
    2.  
      Creating a hold
    3.  
      Viewing hold details
    4.  
      Adding a backup image to an existing hold
    5.  
      Releasing a hold
  4. Menu user interfaces on UNIX
    1.  
      About menu user interfaces
    2. About the tpconfig device configuration utility
      1.  
        About the tpconfig utility menu
      2.  
        Starting the tpconfig device configuration utility
      3.  
        Adding robots
      4.  
        Adding drives
      5.  
        Updating a robot configuration
      6.  
        Updating a drive configuration
      7.  
        Deleting a robot
      8.  
        Deleting a drive
      9.  
        Configuring drive paths
      10.  
        Configuring host credentials
      11.  
        Displaying and writing the device configuration
    3. About the NetBackup Disk Configuration Utility
      1.  
        Managing OpenStorage servers and disk pools
      2.  
        Managing global disk attributes
  5. Reference topics
    1. Host name rules
      1.  
        How NetBackup uses host names
      2.  
        Updating NetBackup after changing the host name
      3.  
        Special considerations for Domain Name Service (DNS)
    2. About reading backup images with nbtar or tar32.exe
      1.  
        Restoring files with non-NetBackup restore utilities (on UNIX)
      2.  
        Considerations for file restoration with non-NetBackup restore utilities (on UNIX)
      3.  
        About the files that restores generate
    3. Factors that affect backup time
      1.  
        Total amount of data to back up
      2.  
        Transfer rate
    4.  
      Methods for determining the NetBackup transfer rate
    5. NetBackup notify scripts
      1.  
        backup_notify script
      2.  
        backup_exit_notify script
      3.  
        bpstart_notify script (UNIX clients)
      4.  
        bpstart_notify.bat script (Windows clients)
      5.  
        bpend_notify script (UNIX clients)
      6.  
        bpend_notify.bat script (Windows clients)
      7.  
        bpend_notify_busy script (UNIX clients)
      8.  
        child_end_deployment_notify
      9.  
        child_start_deployment_notify
      10.  
        diskfull_notify script
      11.  
        drive_mount_notify script (on UNIX)
      12.  
        drive_unmount_notify script (on UNIX)
      13.  
        mail_dr_info script
      14.  
        media_deassign_notify script
      15.  
        nbmail.cmd script (on Windows)
      16.  
        parent_end_deployment_notify
      17.  
        parent_end_notify script
      18.  
        parent_start_deployment_notify
      19.  
        parent_start_notify script
      20.  
        pending_request_notify script
      21.  
        restore_notify script
      22.  
        session_notify script
      23.  
        session_start_notify script
      24.  
        shared_drive_notify script
      25.  
        userreq_notify script
    6. Media and device management best practices
      1.  
        Media management best practices
      2.  
        Device management best practices
      3.  
        Media and device performance and troubleshooting
    7. About TapeAlert
      1.  
        About TapeAlert cleaning (reactive cleaning)
      2.  
        About TapeAlert and frequency-based cleaning
      3.  
        About TapeAlert requirements
      4.  
        TapeAlert logs and codes
    8. About tape drive cleaning
      1.  
        About library-based cleaning
      2.  
        About frequency-based cleaning
      3.  
        About operator-initiated cleaning
      4.  
        About using a cleaning tape
    9.  
      How NetBackup selects drives
    10. How NetBackup reserves drives
      1. About SCSI persistent reserve
        1.  
          About SCSI persistent reserve commands
        2.  
          About SCSI persistent reserve conflicts
      2. About the SPC-2 SCSI reserve process
        1.  
          About SPC-2 SCSI reserve commands
        2.  
          About SCSI reservation conflicts
        3.  
          About forcing a release of an unavailable HBA's SPC-2 reservation
        4.  
          Breaking a reservation
      3.  
        About SCSI reserve requirements
      4.  
        About SCSI reserve limitations
      5.  
        About SCSI reservation logging
      6.  
        About SCSI reserve operating system limitations on Windows
      7. About checking for data loss
        1.  
          About possible data loss causes
      8. About checking for tape and driver configuration errors
        1.  
          About common configuration problems
      9.  
        About configuring SCSI reserve
    11. How NetBackup selects media
      1. About selecting media in robots
        1.  
          About spanning media with automatic media selection
      2. About selecting media in standalone drives
        1.  
          About selecting media by using standalone drive extensions
        2.  
          About disabling standalone drive extensions
        3.  
          About spanning media
        4.  
          About leaving standalone drives in the ready state
    12.  
      Volume pool and volume group examples
    13.  
      Media formats
    14.  
      Media and device management processes
    15. About Tape I/O commands on UNIX
      1.  
        About requesting tapes
      2.  
        About reading and writing tape files
      3.  
        About removing tape files
  6.  
    Index

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.

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:

  1. Open the nbdeployutilconfig.txt file from the following location:

    • Windows:

      install_path\netbackup\var\global\

    • UNIX:

      /usr/openv/var/global/

  2. 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

  1. Go to the following URL:

    https://sort.veritas.com/documents

  2. From the product list, select NetBackup.

  3. Find NetBackup 9.1 in the list of NetBackup product versions and click Documentation.

  4. Locate API Reference and click on the document icon.