Skip to main content

CLI for PRTG Network Monitor

Project description

prtg-cli PyPi version PyPI pyversions

CLI for PRTG Network Monitor

Installation

$ pip3 install --user --upgrade prtg-cli

Setup

For communication with PRTG, use options or set the PRTG_HOST, PRTG_USERNAME, (PRTG_PASSWORD or PRTG_PASSHASH) environment variables

Usage

$ prtg-cli
Usage: prtg-cli [OPTIONS] COMMAND [ARGS]...

Options:
  --host TEXT      Host of the PRTG
  --username TEXT  Username of the PRTG
  --password TEXT  Password of the PRTG
  --passhash TEXT  Passhash of the PRTG
  --help           Show this message and exit.

Commands:
  duplicate
  get
  object
  passhash
  prtg_version
  sensor_types
  status
  version

Suggestions

  • Please use a unique name for probes, groups and devices on PRTG

Examples

Information

### Get all probes
$ prtg-cli get probes
### Get all groups 
$ prtg-cli get groups
### Get specific group
$ prtg-cli get groups <GROUP_NAME>
### Get all devices
$ prtg-cli get devices
### Get specific device
$ prtg-cli get devices <DEVICE_NAME>

Duplication

### Duplicate a group
$ prtg-cli duplicate group --source <Source_Group> --target <Target_Group> --target-name <New_Group_Name>
### Duplicate a device
$ prtg-cli duplicate device --source <Source_Device> --target-group <Target_Group> --target-name <New_Device_Name> --target-host <New_Device_Host>

Object Manipulation

### Scan a object
$ prtg-cli object --state scan --resource devices --item <DEVICE_NAME>
### Resume a object
$ prtg-cli object --state resume --resource devices --item <DEVICE_NAME>
### Stop a object
$ prtg-cli object --state stop --resource devices --item <DEVICE_NAME>
### Delete a object
$ prtg-cli object --state delete --resource devices --item <DEVICE_NAME>

Example of Adding Multiple Devices With Config File

$ cat example.yml
# Device Name
clone: PROD_RABBITMQ_CLUSTER
# Target Group
group: PRTG_CLI

devices:
  - name: CHECKOUT_RMQ_CLUSTER_01
    host: 10.0.20.32

  - name: CHECKOUT_RMQ_CLUSTER_02
    host: 10.0.20.33

$ prtg-cli manager --config-file example.yml
- Create new 'CHECKOUT_RMQ_CLUSTER_01' device
- Create new 'CHECKOUT_RMQ_CLUSTER_02' device

Credits

Thank you for offering fabulous, amazing, incredible rest api at PRTG, it is very nice. :)

https://www.paessler.com/prtg

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

prtg-cli-0.2.1.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

prtg_cli-0.2.1-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file prtg-cli-0.2.1.tar.gz.

File metadata

  • Download URL: prtg-cli-0.2.1.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.4 Darwin/19.0.0

File hashes

Hashes for prtg-cli-0.2.1.tar.gz
Algorithm Hash digest
SHA256 9fcbf1e78127305fd4f1a697a89d6c923b4a03fdcbb52bfe418402209461f398
MD5 c2413b272b7e004a84170ad299aaf3b3
BLAKE2b-256 9689ac88142cea3df27d57387f25192fcf8c6363dd3a51f500ca6dac69498d4c

See more details on using hashes here.

File details

Details for the file prtg_cli-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: prtg_cli-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.4 Darwin/19.0.0

File hashes

Hashes for prtg_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ed850ca889025430ebda2828b32ed90dc876415db9d0929620db4ff6e6b3b78c
MD5 c3be25aab685edf4c50335a3699ef02d
BLAKE2b-256 d3033ff947d63ac25397517983c6f59e303d8950437a05fcbf997f290be36574

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