SPPMon Command line Overview

Overview

Monitoring and long-term reporting for IBM Spectrum Protect Plus. Provides a data bridge from SPP to InfluxDB and provides visualization dashboards via Grafana. This program provides functions to query IBM Spectrum Protect Plus Servers, VSNAP, VADP and other servers via REST API and ssh. This data is stored in an InfluxDB database.

Main arguments

• -h, --help: show this help message and exit
• -v, --version: show program's version number and exit
• --cfg CONFIGFILE: REQUIRED: specify the JSON configuration file
• --verbose: print to stdout
• --debug: save debug messages
• --test: tests connection to all components

Regular execution arguments

• --constant: execute recommended constant functions: (ssh, cpu, sppCatalog)
• --hourly: execute recommended hourly functions: (constant + jobs, vadps, storages)
• --daily: execute recommended daily functions: (hourly + joblogs, vms, slaStats, vmStats)
• --all: execute all functions: (daily + sites)

Specific arguments

Only use for a specific execution, not to be used in regular execution via crontab.

• --jobs: store job history
• --jobLogs: retrieve detailed information per job (job-sessions)
• --loadedSystem: Special settings for loaded systems, increasing API-request timings.
• --fullLogs: Requesting any kind of Joblogs instead of the default SUMMARY-Logs.
• --ssh: execute monitoring commands via ssh
• --vms: store vm statistics (hyperV, vmWare)
• --vmStats: calculate vm statistic from catalog data
• --slaStats: calculate vm's and applications per SLA
• --vadps: store VADPs statistics
• --storages: store storages (vsnap) statistics
• --sites: store site settings
• --cpu: capture SPP server CPU and RAM utilization
• --sppcatalog: capture Spp-Catalog Storage usage

Special features

• --copy_database COPY_DATABASE: Copy all data from .cfg database into a new database, specified by copy_database=newName. Delete old database with caution.

Deprecated arguments:

• --minimumLogs: DEPRECATED, use '--loadedSystem' instead. To be removed in v1.1
• --processStats: DEPRECATED, use '--ssh' instead
• --create_dashboard: DEPRECATED: Just import the regular dashboard instead, choose datasource within Grafana. To be removed in v1.1
• --dashboard_folder_path DASHBOARD_FOLDER_PATH: DEPRECATED: Just import the regular dashboard instead, choose datasource within Grafana. To be removed in v1.1

For feature requests or bug reports please visit https://github.com/IBM/spectrum-protect-sppmon/issues