Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Contents


Table of Contents
excludeContents
stylecircle


Account Notifications


LORIOT implements the below notification mechanisms to send out the alerts that are generated while monitoring your assets.


Alerts are generated per gateway based on event type, you can customize them in the Alerts page of each gateway. Notifications can be enabled/disabled globally in the account and multiple notification mechanisms can be set at the same time.



Email Notifications


Notifications Address

This option allows the user to receive e-mail notifications about events generated by our system.

UI Steps
sizesmall


UI Step
To set up a different notification email address, go to Account → Notifications, and click on the Edit button next to "Email Notifications"


UI Step

When a different address is set up, a verification email will be sent to the new address.


UI Step

Within the email, please click the link to Change Notifications Email. 


UI Step
Notification emails won't be sent to the new account until this verification is done.



SNMP Notifications


SNMP Traps are a way to communicate events that are triggered by the gateways using the SNMP protocol. The gateways will send the so-called traps to the Network Server and in turn it will forward the trap to SNMP Server of your choosing.


In order to set up SNMP Trap Notifications the following two parameters are required:

  • Host: the address that shall receive the SNMP Traps

  • Community: the community string used to access the information from the SNMP Traps, similar to a password


The SNMP Traps will be sent through port 162/UDP using SNMP V2.

SNMP Trap configuration via WebUI

UI Steps
sizesmall


UI Step

To set up SNMP Trap Notifications go to Account → Notifications, and click on the Edit button next to "SNMP notifications".


UI Step

Enter the host address and the community string in the corresponding fields.

Image Modified


UI Step

Users must click on blue check button to confirm.


UI Step

The configured host address will be shown below the section title:

Image Modified


SNMP Trap configuration via API

UI Steps
sizesmall


UI Step

Look in our User API documentation for the following API calls:

Image Modified


UI Step

Add the host address and the community string to the API call as described in the documentation.

Example using CURL:

Code Block
languagejs
curl 'https://testserver.loriot.io/1/nwk/user/snmp-notification' \ -H 'Accept: application/json, text/plain, */*' \ -H 'Authorization: Session d3000z34-1045-42b2e-944x-abd2fd0ft331' \ -H 'Content-Type: application/json' \ --data-binary '{"host": "SNMP-Server.example.com","community": "examplestring"}' \ --compressed



SNMP Trap OIDs

SNMP Traps notify the information based on the so-called OIDs, object identifiers used to uniquely and unambiguously name an object.
The following is a list of the SNMP Trap OIDs registered to LORIOT.

Code Block
languagejs
1.3.6.1.4.1.56122.2.1.1.1.1.1 alertMessage 
1.3.6.1.4.1.56122.2.1.1.1.1.2 alertSubject 
1.3.6.1.4.1.56122.2.1.1.1.1.3 name 
1.3.6.1.4.1.56122.2.1.1.1.1.4 template 
1.3.6.1.4.1.56122.2.1.1.1.1.5 component 
1.3.6.1.4.1.56122.2.1.1.1.1.6 gweui 
1.3.6.1.4.1.56122.2.1.1.1.1.7 date 
1.3.6.1.4.1.56122.2.1.1.1.1.8.1 gateway.base 
1.3.6.1.4.1.56122.2.1.1.1.1.8.2 gateway.MAC 
1.3.6.1.4.1.56122.2.1.1.1.1.8.3 gateway.model 
1.3.6.1.4.1.56122.2.1.1.1.1.8.4 gateway.title 
1.3.6.1.4.1.56122.2.1.1.1.1.8.5.1 gateway.location.address 
1.3.6.1.4.1.56122.2.1.1.1.1.8.5.2 gateway.location.city 
1.3.6.1.4.1.56122.2.1.1.1.1.8.5.3 gateway.location.country 
1.3.6.1.4.1.56122.2.1.1.1.1.8.5.4 gateway.location.zip 
1.3.6.1.4.1.56122.2.1.1.1.1.9 networkid 
1.3.6.1.4.1.56122.2.1.1.1.1.10 server


Click on the link below to download the MIB file that contains the definitions for each OID.

LORIOT SNMP TRAP MIB




Webhook URLURL not specified


To use webhook, a URL must be set up in: http://target domain/IP:port number

Under the webhook URL a proper webserver should be running.


The POST request’s body is a JSON structure which has the following fields:


Code Block
languagejs
{
    component         : "gateway";  // identifies device which have status change
    gweui             : string;     // gateway EUI, 16 hex digits (without dashes)
    alertSubject      : string;     // short description of the alert
    alertMessage      : string;     // long description of the alert
    alertType         : string;     // type of the alert. Types are `gateway-online`, `gateway-offline`, `gateway-latency-too-high`
    server            : string;     // Network Server address which generates the alert
    date              : Date;       // string representation of the date the alert was generated
    gateway: {
      title           : string;     // name of the gateway
      MAC             : string;     // gateway MAC address, 12 hex digits (with colons)
      base            : string;     // base platform of the gateway
      model           : string;     // model of the gateway
      location: {
        address       : string;     // address of the gateway
        city          : string;     // city of the gateway
        zip           : string;     // zip code of the gateway
        country       : string;     // country of the gateway
        lat           : number;     // latitude of the gateway
        lon           : number;     // longitude of the gateway
        latProtected  : number;     // protected latitude of the gateway
        lonProtected  : number;     // protected longitude of the gateway
      }
    }
  }