Backup

Veritas NetBackup monitoring will be supported since XorMon NG v1.8.0 coming in Feb 2025, however it is ready to be tested
Anyone willing to test it? Contact us at support@xorux.com.

XorMon NG uses Veritas NetBackup REST API inteface provided by the Veritas NetBackup Master server to get all necessary data.

Supported Veritas NetBackup versions: 8.2+, 9.0+ and 10.+

Storage connectivity

    Allow access from the XorMon NG host to the Veritas NetBackup Master server port 1556 TCP.
    Veritas NetBackup accepts HTTP/HTTPS requests on port 1556 by default.

Create Verias NetBackup user

There are more ways to configure user for XorMon NG depending on Veritas NetBackup server deployment type (standalone server, virtual appliance), OS (Windows, Linux), version (8.x, 9.0) and authentication authority (Active Directory, local user, Veritas user).
Please consult user creation steps with Veritas NetBackup support if in doubt.

Here we describe two ways to create a NetBackup user:
  • NetBackup 9.0 with RBAC, Windows server
  • NetBackup REST API user without RBAC

NetBackup 9.0, RBAC, Windows server
Veritas NetBackup 9.0, Role Based Access, Windows standalone server with local user, Web Management Console:

  1. Log into Veritas NetBackup Master server and create a new local user for XorMon NG (screenshots show user "stor2rrd" but use "xormon" preferably
  2. Log into Veritas NetBackup Web Managemet Console as administrator
  3. Security ➡ RBAC ➡ Roles ➡ +Add (Custom role)
    Veritas NetBackup monitoring user add 1

  4. Assign Role name and description and go to Permissions categories
    Veritas NetBackup monitoring user add 2

  5. Assign 'View' permission for the following Global categories and objects
    Veritas NetBackup Management:
    • Event logs
      • Event log messages
      • Event log notifications
    • NetBackup hosts
      • Host properties
    • NetBackup backup images
    • Jobs
    • Media server
    • Resource limits
    • Servers
      • Trusted master servers
    Protection:
    • Policies
    • Storage lifecycle policies
    Storage:
    • Cloud storge
    • Disk pools
    • Storage servers
      • Disk Volumes
    • Storage units
    • Tape devices
    • Tape media
      • Tape media server groups
      • Tape media volume pools
    • Replication-capable target storage servers

  6. Assign the user created in the first step to the new role
    Veritas NetBackup monitoring user add 3
    Veritas NetBackup monitoring user add 4

  7. Recommended optional step: Create Access Key
    • Security ➡ Access keys ➡ +Add
    • Fill in the name of the user created in the previous steps
    • Set key validity
    • Click Add
    • Copy and save the access key
    • Use this access key later when adding NetBackup to XorMon NG

NetBackup REST API user without RBAC
Use only on older NetBackup versions without RBAC support.
Original KB: 100042908 How to add users for making queries against Veritas NetBackup REST API

  1. Add VxSS user to the Veritas NetBackup master server in order to perform user/password authentication when using the Veritas NetBackup API
    bpnbat command:
    bpnbat -AddUser <user> <password> <domain>
    The user, password and domain can be any value and do not have any relation to GUI or other login credentials. Make note of the values as they will be needed later.
    (VxSS user name and domain name must not confict with other user or domain names used in the environment!)

    Example:
    bpnbat -AddUser xormon Secret1234 xormon
  2. Enable enhanced auditing with the following command:
    bpnbaz -SetupExAudit
  3. Give the new VxSS user administrator privileges
    bpnbaz -AddUser <domain type>:<domain name>:<user>
    Example:
    bpnbaz -AddUser vx:xormon:xormon
  4. It may be necessary to restart NetBackup services.

XorMon NG storage configuration

  • Add storage into configuration from the UI:
    XorMon NG UI: Settings icon ➡ Device ➡Backup ➡ New ➡ Vendor:device ➡ Veritas NetBackup
    Veritas NetBackup Storage monitoring

  • Run "Test" for configured storage device, it must show "OK"

  • Wait about 1 hour, then reload the web browser, you should see it in XorMon NG UI

Data is collected from the IBM Storage Protect (formerly IBM Spectrum Protect, Tivoli Storage Manager (TSM)) database on the TSM server via Operator role.
There must be enabled ssh access somewhere where is running the TSM server/client to execute TSM commands.
List of monitored metrics

IBM Storage Protect TSM monitoring schema

TSM prerequisites

  • Install TSM client and configure it
    Open network from the XorMon NG server to the TSM server port 22 TCP (ssh)
    Stanza/servername can be configured in dsm.sys www.ibm.com/docs/en/tsmferp/7.1.3.0?topic=files-client-system-options-file-sample-dsmsys

    Example dsm.sys:
    SErvername  TSM-server01
      COMMmethod         TCPip
      TCPPort            1500
      TCPServeraddress   192.168.1.1
    
  • Create user xormon with "operator" role
    login as administrator into dsmadmc
    dsmadmc -se=TSM-server01 -id=admin -pass=<password>
    
    TSM-server01 > REGister Admin <admin_name> <password> PASSExp=9999 CONtact=“XorMon user“
    TSM-server01 > Grant AUTHority <admin_name> CLasses=Operator
    

XorMon NG storage configuration

  • Add storage into configuration from the UI:
    Settings icon ➡ Device ➡ Backup ➡ New ➡ Vendor:device ➡ IBM ➡ Spectrum Protect (TSM)
    IBM Spectrum Protect TSM monitoring

  • Run "Test" for configured storage device, it must show "OK"

  • Wait about 1 hour, then reload the web browser, you should see it in XorMon NG UI