Custom Drivers (Beta)

What is a Custom Driver?

The Custom Driver feature allows you to create scripts that can be used on IP-connected devices to retrieve additional data and execute actions on them.

Supported network protocols:

  • HTTP
  • SNMP

Note: We are continuously developing support for additional protocols, which will be enabled soon including: SSH, telnet, winRM TCP, etc.

Current limitations:

  • missing protocols:
    • Telnet
    • SSH
    • Winrm
    • TCP
  • missing credential support for HTTP/SNMP
  • missing example drivers
  • missing action functions support

How to create a Custom Driver?

Step 1 Go to Account Settings >  Services & Drivers >  Custom Drivers:

Custom Driver screenshot 1

Step 2 Click on Create a New Driver:

Custom Driver screenshot 2

Note: Be aware that the chosen driver name must be unique.

Step 3 Enter driver properties and code:

Custom Driver screenshot 3

How to test a Custom Driver?


You can validate the code of a custom driver by executing it against a device of your choice.

Step 1 Open to the Custom Driver Details section:

Custom Driver screenshot 4

Step 2 Select a Device for the Driver:

Custom Driver screenshot  5

Step 3 Select a function to execute. You have two choices:

  1. Validate is designed to verify if the device that you apply a driver to can support the custom driver’s functionality. The function will be executed and depending on the result it will allow or prevent the custom driver to device association:
  • The D.success() callback indicates the device is a valid candidate for the driver.
  • The D.failure(“add a sensible error message”) callback indicates that this driver’s functionality is not supported on the selected device.
Custom Driver screenshot 6

2. Get_status and Run Code:

Custom Driver screenshot 7

Step 5 Checking the result:

A pop-up will appear with the code run execution result for the specified function. You have two choices:

  1. Get_status is the function name that was executed
  2. Variables is the section that contains a list of variable name – value pairs
  • “left” and “right” are the names we’ve given the two variables
  • “value 1” and “value 2” are their values respectively
Custom Driver screenshot 8

How to use a Custom Driver?

Step 1 Go to a device of your choice and select Apply custom driver to this device:

Custom Driver screenshot 9

Step 2 Select the custom driver that you want to apply to this device:

Note:
Only one custom driver can be applied to a single device.
Be aware that the chosen driver must have a valid code.

Step 3 Custom Driver configuration:

Go to the Driver tab and find your custom driver configuration (sample period) and results:

Custom Driver screenshot 11
Updated on October 14, 2021

Was this article helpful?