Skip to main content

Symantec Netbackup SSH

Pack Assets​

Templates​

The Centreon Plugin Pack Netbackup SSH brings 1 host template:

  • App-Netbackup-SSH-custom

It brings the following Service Templates:

Service AliasService TemplateDefaultDiscovery
Dedup-StatusApp-Netbackup-SSH-Dedup-StatusX
Drive-CleaningApp-Netbackup-SSH-Drive-CleaningX
Drive-StatusApp-Netbackup-SSH-Drive-StatusX
Job-StatusApp-Netbackup-SSH-Job-StatusXX
Tape-UsageApp-Netbackup-SSH-Tape-UsageX

Discovery rules​

Rule nameDescription
App-Netbackup-Job-Per-PolicyDiscovery Netbackup Jobs

Collected metrics & status​

Metric nameUnit
status
disk_pool.deduplication.usage.percentage%

Prerequisites​

SSH configuration​

A user is required to query the server by SSH. There are two possible ways to log in through SSH, either by exchanging the SSH key from centreon-engine user to the target server, or by setting your unique user and password directly in the Host Macros.

The remote user must have enough privileges to execute system commands.

Setup​

  1. Install the Centreon Plugin package on every Centreon Poller expected to monitor Netbackup ressources:
yum install centreon-plugin-Applications-Netbackup-Ssh
  1. On the Centreon Web interface, install the Netbackup SSH Centreon Plugin Pack on the Configuration > Plugin Packs 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 Netbackup server settings
  • Select the applications-netbackup-ssh-custom template to apply to the Host
  • Once the template applied, some Macros marked as 'Mandatory' hereafter have to be configured.

3 SSH backends are available to connect to the remote server: sshcli, plink and libssh which are detailed below.

MandatoryNameDescription
XSSHBACKENDName of the backend: sshcli
XSSHUSERNAMEBy default, it uses the user running process centengine on your Poller
SSHPASSWORDCannot be used with backend. Only ssh key authentication
SSHPORTBy default: 22
SSHEXTRAOPTIONSCustomize it with your own if needed. E.g.: --ssh-priv-key=/user/.ssh/id_rsa

With that backend, you have to validate the target server fingerprint manually (with the SSHUSERNAME used).

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 Poller using the centreon-engine user account and run the following command:

/usr/lib/centreon/plugins/centreon_netbackup_ssh.pl \
--plugin=apps::backup::netbackup::local::plugin \
--mode=job-status \
--hostname=10.30.2.81 \
--ssh-username=centreon \
--ssh-password='centreon-password' \
--ssh-backend=sshcli \
--critical-status='%{status} !~ /up/i' \
--verbose

The above command gets the state of the Symantec Netbackup jobs (--mode=job-status). It uses a SSH username centreon (--ssh-username=centreon), a SSH password centreon-password (--ssh-password='centreon-password'), uses a SSH backend sshcli (--ssh-backend='sshcli') and it connects to the host 10.30.2.81 (--hostname=10.30.2.81).

This command will return a CRITICAL state if one of the jobs isn't in the 'up' status.

All the options that can be used with this plugin can be found using the --help option:

/usr/lib/centreon/plugins/centreon_netbackup_ssh.pl \
--plugin=apps::backup::netbackup::local::plugin \
--mode=job-status \
--help

Troubleshooting​

Please find all the troubleshooting documentation for the Centreon Plugins on the dedicated page