patrickeasters.prtg.prtg (1.0.0) — module

Install collection

Install with ansible-galaxy collection install patrickeasters.prtg:==1.0.0

Add to requirements.yml

  collections:
    - name: patrickeasters.prtg
      version: 1.0.0

Description

Manage Paessler PRTG devices using its REST API (see http://kb.paessler.com/en/topic/593-how-can-i-use-the-prtg-application-programming-interface-api)

Requirements

• PRTG installation must be accessible from ansible client

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- prtg:  prtg_url="https://prtg.example.com/" 
         api_user=ansible_api
         api_passhash=1234567890
         device_name=myhost.example.com
         clone_from=1234
         dest_group=5678
         state=present
         enabled=yes

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the device exists in PRTG or not
    required: false

enabled:
    default: true
    description:
    - Enabling a device unpauses it
    - Disabling a device pauses it
    required: false

api_user:
    description:
    - PRTG user for making API calls (can be local or domain user)
    required: true

prtg_url:
    description:
    - The base URL of your PRTG installation (e.g. https://prtg.example.com/)
    required: true

device_id:
    description:
    - ID of PRTG device (one of device_name or device_id required)
    required: false

clone_from:
    description:
    - ID of PRTG device to "clone" new device from
    required: false

dest_group:
    description:
    - ID of PRTG group where new device will reside (will use group of cloned device by
      default)
    required: false

device_name:
    description:
    - Name/host of device (one of device_name or device_id required)
    required: false

api_passhash:
    description:
    - Passhash of API user (see https://www.paessler.com/manuals/prtg/my_account_settings)
    required: true