Skip to main content

Some useful multi-tenant pdf reports for OpsRamp

Project description

Multi-Client Reporting Utility for OpsRamp

Purpose

This is a utility intended for use by OpsRamp customers needing to batch-generate some useful reports across all tenants in their partner instance.

First time execution

The first time it is run, it will look to see if the default environment config directory exists, and if it's not there it will create it.

After that, you can either update the environments.yml file in the environment config directory with your partner-level OpsRamp API credentials, or you can specify API credentials on the command line.

Available Reports

The following reports are currently available. Each report generates a separate report file for each tenant unless ptherwise specified:

Server Utilization Comparison

This report contains a page for each Windows or Linux server in the environment, with time-series graphs for the speficied period for CPU Utilization, File System Utilization, and Memory Utilization. A table at the bottom of each page shows min, max, and average for the current period and increase/decrease trend from the baseline period.

Network Utilization

This is a fairly standard Top N report for Cisco device CPU Utilization, Memory Utilization, and Interface Utilization, Errors, etc. It shows a time series only for the Top N items, followed by a detail report of all items sorted from highest to lowest.

Patch Management

Summary of patches installed in the reporting period in pdf format

Remote Control Usage

Histogram and detailed list of remote control console sessions that occurred in the reporting period.

Hardware Inventory

This provides a list of resources in either excel (default) or pdf format

Software Inventory

This provides a list of installed applications and services for each device in pdf format

Command line help:

usage: opreport [-h] [--env ENV] [--envfile ENVFILE] [--api_url API_URL] [--key KEY] [--secret SECRET] [--tenant TENANT] [--start START] [--end END]
                [--outdir OUTDIR] [--logo LOGO] [--secure SECURE] [--tenant_criteria TENANT_CRITERIA]
                {uc,nu,pm,rcu,hi,si} ...

Multi-Client Reporting Utility for OpsRamp

positional arguments:
{uc,nu,pm,rcu,hi}     Available commands
    uc                  Generate Server Utilization Comparison Reports
    nu                  Generate Network Utilization Reports
    pm                  Generate Patch Management Reports
    rcu                 Generate Remote Control Usage Reports
    hi                  Generate Hardware Inventory Reports
    si                  Generate Software Inventory Reports

optional arguments:
-h, --help            show this help message and exit
--start START         Start date of reporting period in YYYY-MM-DD format (default=1st of prior month)
--end END             End date of reporting period in YYYY-MM-DD format (default=Last day of prior month)
--outdir OUTDIR       Directory where report output will be written (Default: ./output)
--logo LOGO           Logo image file for report headers (Default: /Users/michael.friedhoff/Library/Application Support/OpsRamp/logo.jpeg)
--secure SECURE       Whether or not to verify SSL cert (Default: True)
--tenant_criteria TENANT_CRITERIA
                        Search criteria for which tenants to include as per https://develop.opsramp.com/tenancy-access-controls/tenants-orgid-
                        clients-search (Default: "activeStatus:true", which will include all active tenants)

Use yaml environment file credentials:
--env ENV             Name of environment to use, referencing a named set of API credentials in environments.yml
--envfile ENVFILE     Location of environments YAML file to be used (Default: /Users/michael.friedhoff/Library/Application
                        Support/OpsRamp/environments.yml)

Use command line credentials:
--api_url API_URL     Customer-specific API URL such as https://mycompany.api.opsramp.com
--key KEY             Authentication key
--secret SECRET       Authentication secret
--tenant TENANT       Authentication MSP or Tenant ID

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

opreport-0.3.8.tar.gz (5.5 MB view details)

Uploaded Source

Built Distribution

opreport-0.3.8-py3-none-any.whl (5.5 MB view details)

Uploaded Python 3

File details

Details for the file opreport-0.3.8.tar.gz.

File metadata

  • Download URL: opreport-0.3.8.tar.gz
  • Upload date:
  • Size: 5.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.8.9 Darwin/20.6.0

File hashes

Hashes for opreport-0.3.8.tar.gz
Algorithm Hash digest
SHA256 59fec1dda4b4d728d0fad63a0a6039ce42e15d3f6b9dbdc2d615f79c3fb28c2b
MD5 b365ded0b0c0a7cb0cf95ad5adead7c9
BLAKE2b-256 4a9bef8159894ecdaf302749ccc17b35e41325758353e42cf1c41eff50e209c3

See more details on using hashes here.

File details

Details for the file opreport-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: opreport-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 5.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.8.9 Darwin/20.6.0

File hashes

Hashes for opreport-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7361b9638f6e8e6a3bf393cb41269165b697611ea88f927d4e46b6642d0e7026
MD5 f50669a9bff55a0aa2b4572c1b1d66f6
BLAKE2b-256 8d1b90a3bb6ea81b15d49d48af01da6499260a00c0b06a7a2b6b15b55a6780a0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page