node-prtg v0.4.1

node-prtg

A Node.js module for interacting with the PRTG API.

Requirements

• PRTG 14.x+, earlier versions may work but have not been tested.
• Node.js v6+

Usage

    const PRTG = require('node-prtg');
    
    const api = new PRTG({
            url: 'http://your.prtg.install.com',
            username: 'username',
            passhash: '123456789'
    });
    
    api.getSensor(1234)
      .then(sensor => { /*do something with result*/ }).catch(error => { /* handle errors */ });

Classes

Typedefs

PRTG

Kind: global class

• PRTG
  • new PRTG(options)
  • .getDefaults() ⇒ Object | *
  • .getStatus(str) ⇒ string | number
  • .api(path, query, [resultPath], [parse], [enableSanitize]) ⇒ Promise | object
  • .getSensor(objid) ⇒ Promise.<Sensor>
  • .getDeviceSensors(objid, [columns]) ⇒ Promise.<Array.<Sensor>>
  • .getObjectProperty(objid, property) ⇒ Promise.<Object>
  • .getSensorStatusId(objid) ⇒ Promise.<String>
  • .getDeviceStatusId(objid) ⇒ Promise.<String>
  • .getSensors([columns], [filter], [objid]) ⇒ Promise.<Array.<Sensor>>
  • .getDownOrAckSensors() ⇒ Promise.<Array.<Sensor>>
  • .getSensorTree() ⇒ Promise.<Object>
  • .pauseSensor(objectId, message) ⇒ Promise | Object
  • .resumeSensor(objectId) ⇒ Promise | Object
  • .pauseSensorDuration(objectId, message, minutes) ⇒ Promise | Object
  • .acknowledgeSensor(objectId, message) ⇒ Promise | Object
  • .acknowledgeSensorDuration(objectId, message, minutes) ⇒ Promise | Object

new PRTG(options)

prtG.getDefaults() ⇒ Object | *

Kind: instance method of PRTG

prtG.getStatus(str) ⇒ string | number

Return opposite mapping for status to status id

Kind: instance method of PRTG

prtG.api(path, query, resultPath, parse, enableSanitize) ⇒ Promise | object

Kind: instance method of PRTG

prtG.getSensor(objid) ⇒ Promise.<Sensor>

Kind: instance method of PRTG

prtG.getDeviceSensors(objid, columns) ⇒ Promise.<Array.<Sensor>>

Kind: instance method of PRTG

prtG.getObjectProperty(objid, property) ⇒ Promise.<Object>

Kind: instance method of PRTG

prtG.getSensorStatusId(objid) ⇒ Promise.<String>

Kind: instance method of PRTG

prtG.getDeviceStatusId(objid) ⇒ Promise.<String>

Kind: instance method of PRTG

prtG.getSensors(columns, filter, objid) ⇒ Promise.<Array.<Sensor>>

Kind: instance method of PRTG

prtG.getDownOrAckSensors() ⇒ Promise.<Array.<Sensor>>

Kind: instance method of PRTG

prtG.getSensorTree() ⇒ Promise.<Object>

Kind: instance method of PRTG

prtG.pauseSensor(objectId, message) ⇒ Promise | Object

Kind: instance method of PRTG

prtG.resumeSensor(objectId) ⇒ Promise | Object

Kind: instance method of PRTG

prtG.pauseSensorDuration(objectId, message, minutes) ⇒ Promise | Object

Kind: instance method of PRTG

prtG.acknowledgeSensor(objectId, message) ⇒ Promise | Object

Kind: instance method of PRTG

prtG.acknowledgeSensorDuration(objectId, message, minutes) ⇒ Promise | Object

Kind: instance method of PRTG

PRTGFilter : object

Kind: global typedef
Properties

Sensor : object

Kind: global typedef
Properties

SensorColumns : object

Kind: global typedef
Properties