Skip to main content

Veritas Backup Exec NSCP Rest API

Pack Assets​

Templates​

The Centreon Pack Backup Exec brings a host template:

  • App-Backupexec-Nscp-Restapi-custom

It brings the following service templates:

Service AliasService TemplateDefaultDiscovery
AlertsApp-Backupexec-Alerts-Nscp-RestapiX
DisksApp-Backupexec-Disks-Nscp-RestapiXX
JobsApp-Backupexec-Jobs-Nscp-RestapiX

Discovery rules​

Rule nameDescription
App-Backupexec-Nscp-Restapi-Disk-NameDiscover disks and monitor utilization

Collected metrics & status​

Metric nameDescriptionUnit
alerts.severity.none.countNumber of alerts with none severity
alerts.severity.question.countNumber of alerts with question severity
alerts.severity.error.countNumber of alerts with error severity
alerts.severity.warning.countNumber of alerts with warning severity
alerts.severity.information.countNumber of alerts with informational severity
alert statusCurrent alert status

Prerequisites​

NSClient Configuration​

To monitor Backup Exec through NRPE, install the Centreon packaged version of the NSClient++ agent. Please follow our official documentation.

Please download and install the last release of Centreon-NSClient-xxx.exe: https://github.com/centreon/centreon-nsclient-build/releases.

By default, the username/password is centreon/centreon.

Network flow​

The target equipment must be reachable from the Centreon poller on the TCP/8443 port.

Setup​

  1. Install the Centreon package on every Centreon poller expected to monitor Veritas Backup Exec NSCP API resources:
yum install centreon-plugin-Applications-Protocol-Nrpe
  1. On the Centreon web interface, install the Veritas Backup Exec NSCP API Centreon Pack on the Configuration > Connectors > Monitoring Connectors page.

Configuration​

Host​

  • Log into Centreon and add a new Host through Configuration > Hosts.
  • Fill the Name, Alias & IP Address / DNS fields according to your Veritas Backup Exec server settings.
  • Apply the App-Backupexec-Nscp-Restapi-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryNameDescription
NSCPRESTAPIPORTPort used (Default: 8443)
NSCPRESTAPIPROTOProtocol used (Default: https)
NSCPRESTAPIUSERNAMENSClient API username
NSCPRESTAPIPASSWORDNSClient API password
NSCPRESTAPILEGACYPASSWORDNSClient API legacy authentication password
NSCPRESTAPIEXTRAOPTIONSAny extra option you may want to add to the command (eg. a --insecure)
BEMCLIFILEPowershell module file (Default: C:/Program Files/Veritas/Backup Exec/Modules/BEMCLI/bemcli)

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller CLI using the centreon-engine user account and test the Plugin by running the following command to check NSClient configuration:

/usr/lib/centreon/plugins/centreon_protocol_nrpe.pl \
    --plugin=apps::protocols::nrpe::plugin \
    --mode=query \
    --custommode=nsclient \
    --hostname='10.0.0.1' \
    --username=centreon \
    --password=centreon \
    --insecure \
    --http-backend=curl \
    --command=check_version

The expected command output is shown below:

0.5.2.41 2018-04-26

Check the Backup Exec plugin by running the following command:

/usr/lib/centreon/plugins/centreon_protocol_nrpe.pl \
    --plugin=apps::protocols::nrpe::plugin \
    --mode=query \
    --custommode=nsclient \
    --hostname='10.0.0.1' \
    --username=centreon \
    --password=centreon \
    --insecure \
    --http-backend=curl \
    --command=check_centreon_plugins \
    --arg='apps::backup::backupexec::local::plugin' \
    --arg='disks' \
    --arg='--filter-name="" --verbose' \
    --verbose

The expected command output is shown below:

OK: All disks are ok | 'disk 1#disk.space.usage.bytes'=1000000B;;;0;100000000 'disk 1#disk.space.free.bytes'=99000000B;;;0;100000000 'disk 1#disk.space.usage.percentage'=1.00%;;;0;100 'disk 2#disk.space.usage.bytes'=1000000B;;;0;250000000 'disk 2#disk.space.free.bytes'=249000000B;;;0;250000000 'disk 2#disk.space.usage.percentage'=0.40%;;;0;100
checking disk 'disk 1' [type: tapeDriveDevice]
    status: enabled
    space usage total: 95.37 MB used: 976.56 KB (1.00%) free: 94.41 MB (99.00%)
checking disk 'disk 2' [type: deduplicationDiskStorageDevice]
    status: enabled
    space usage total: 238.42 MB used: 976.56 KB (0.40%) free: 237.46 MB (99.60%)

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_protocol_nrpe.pl \
    --plugin=apps::protocols::nrpe::plugin \
    --mode=query \
    --custommode=nsclient \
    --hostname='10.0.0.1' \
    --username=centreon \
    --password=centreon \
    --insecure \
    --http-backend=curl \
    --command=check_centreon_plugins \
    --arg='apps::backup::backupexec::local::plugin' \
    --arg='disks' \
    --arg='--help'

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_protocol_nrpe.pl \
    --plugin=apps::protocols::nrpe::plugin \
    --mode=query \
    --custommode=nsclient \
    --hostname='10.0.0.1' \
    --username=centreon \
    --password=centreon \
    --insecure \
    --http-backend=curl \
    --command=check_centreon_plugins \
    --arg='apps::backup::backupexec::local::plugin' \
    --arg='xxx' \
    --arg='--list-mode'

Troubleshooting​

Please find the troubleshooting documentation for the API-based plugins in this chapter