Introduction
The Automation & Drivers feature allows you to create drivers that can be used on IP-connected devices to retrieve additional data and execute actions on them.
Supported network protocols:
- HTTP/S
- SSH
- WinRM/S
- Telnet
- SNMP
- TCP
- UDP
- TFTP
How to use a Driver and apply it to a specific device
Step 1 – Go to Integrations > Drivers & Automation
Navigating to the Drivers Catalog in Domotz.
1. In the left sidebar, find and click on "Integrations" to open the integration options.
2. Ensure the "Drivers Catalog" tab is selected. This section displays various drivers available for configuration.
3. Explore the listed drivers under "Drivers Catalog" to monitor different configurations. Use the "Use Driver" button next to each driver to implement it. Additional options can be found by clicking the three dots next to "Use Driver."
Step 2 – Search for in our Catalog:
This will filter for example drivers that we have already developed which they work as it is and that can be customized to fit your needs:
Searching for a Driver in Domotz Integrations
1. Ensure you are in the "Drivers Catalog" tab under the "Integrations" section.
2. In the search bar at the top, type "windows" to find related drivers.
3. View the list of available software integrations such as "Hyper-V VM Snapshot" and "Microsoft Exchange Server" variations.
4. For each integration, you can see a description and associated tags.
5. To the right of each integration, there is a "Use Driver" button to select the desired driver.
Step 3 – Select one Driver example and “Use Driver” for it or click directly in Use Driver button:
Windows Services Monitoring Configuration in Domotz
1. Navigate to the "Drivers Catalog" under the "Drivers and Automation" tab in the Domotz interface.
2. Locate "Windows Services Monitoring" among the listed options. Options are identifiable by their descriptions, such as monitoring Windows services.
3. Click on "Windows Services Monitoring" to view its details.
4. The details panel highlights configuration requirements:
- Powershell version 5.1.19041.2364 is needed.
- Local Administrator privileges are required.
- WinRM must be enabled to run scripts using WinRM.
- SSH must be enabled to run scripts using SSH.
5. Confirm communication protocols are set to "WINRM, SSH".
6. Set the sample period to "1 hr".
7. Ensure the execution timeout is "30 seconds".
8. The driver is compatible with Microsoft Windows Server 2019 and Windows 10.
9. Use the "Use Driver" button to apply the configuration.
Step 4 – Select the devices you would like to apply it to and add the driver to them:
Windows Services Monitoring Pre-Configured Script Interface
1. Search for a service by entering "dc0" in the search bar to filter the list of services.
2. Next to the search bar, select "Advanced" if you need to access more detailed options.
3. Review the displayed list of services. Each entry shows the service name, such as "AdDomainTest" or "Hyper-v-agent-Linux-snap," and details like the company name and IP address (192.168.0.63).
4. To perform further actions, click on the circle icon near the desired service entry.
Step 5 – Customize the driver for your needs:
Managing Drivers in Domotz Integrations
1. Navigate to the "Drivers and Automation" section in the Domotz Integrations menu.
2. Select the "My Drivers" tab to view your list of drivers.
3. Find and select the "Windows Services Monitoring" driver from the list.
4. A details panel on the right will display information such as required credentials, communication protocols (WINRM, SSH), sample period (1 hr), and execution timeout (30 seconds).
5. To edit the driver, click on the "Edit Driver" button located at the bottom of the details panel.
How to create a Driver from scratch?
Search in the Click on Create a New Driver:
Manage and Add Drivers for Integration
1. Access the "Drivers and Automation" tab within the Integrations section to view your drivers.
2. To add new drivers, click on the "+ Add Drivers" link at the top left.
3. Explore the list of existing drivers under "My Drivers." Each driver entry includes details like Driver Name, Type, Source, Protocol, Status, Devices, and Creation Time.
4. To view more details about a specific driver, select "View Details" next to the desired driver name.
5. Check the driver’s status, which may indicate if the code is valid.
6. For device association, use the "Add Devices" link in the Devices column.
7. Use the search bar to find specific drivers within your list.
Creating a New Driver in a Software Interface
1. Locate and click the "Add Drivers" button on the My Drivers page.
2. In the "New Driver" form, enter the driver's name in the "Driver name" field, marked as required.
3. Optionally, add a description in the "Driver description" field.
4. Select a type from the "Type" dropdown menu; the default is "Generic."
5. Click "Create" to finalize and add the new driver. Use "Cancel" to discard changes.
Note: Be aware that the chosen driver name must be unique.
Step 3 Enter driver properties and code
Automation and Script Editing in Domotz
1. Navigate to the "Integrations" section and select "Automation & Scripts Detail."
2. Use the "Options" panel to set the minimum sample period to "5 Minutes" and the timeout to "30 Seconds."
3. Check "Credentials Required" if password protection is needed.
4. Under "Settings," choose a device from the "Test on a device" dropdown menu.
5. In the "Functions" section, there are two functions available: "Validate Association" and "Get Device Variables." Click "Test" next to these functions to validate script associations or retrieve device metrics, respectively.
6. To add new functionalities, use "Custom Actions" or "Parameters" by clicking "Add Custom Action" or "Add Parameter."
7. Enter or edit your script in the "Code Preview" window. Example functions include `function_validate()` for validation and `function_get_status()` for retrieving device status.
8. If the code is incorrect, you will see a notification: "The code is not valid." Adjust the code as necessary.
Note: Please visit the official Domotz Drivers API Documentation to learn how to write Domotz drivers code.
Step 4 Add Parameters
If needed (most drivers won’t require parameters), by using the “Add Parameters” + button, it is possible to add parameters:
Automation and Script Details Interface
1. Navigate to the "Integrations" section and select "Automation & Scripts Detail."
2. Under "Options," set the "Min. Sample period" to 5 minutes and "Timeout" to 30 seconds.
3. If needed, check "Credentials Required" to secure data access with a password.
4. In "Settings," choose a device to test using the "Test on a Device" dropdown.
5. Explore available "Functions":
- "Validate Association" checks if the script can be associated with a device.
- "Get Device Variables" retrieves device metrics.
6. Create new actions or parameters using "Add Custom Action" and "Add Parameter" under their respective sections.
7. The "Code Preview" section allows script editing. Functions shown include "function_validate" and "function_get_status."
8. Note the code status indicator showing "The code is not valid" for error monitoring.
Add a Parameter in the Script Configuration
1. Enter a name for the parameter in the "Identifier" field. Example: Hosts.
2. Provide a brief explanation in the "Description" field. Example: Hosts to check.
3. Select the data type from the "Type" dropdown menu. For instance, choose "List."
4. Enter default values or items for the parameter under "Default Value." Example entries include "www.amazon.com." Use the "+ Add" option to enter additional items, such as "www.facebook.com" and "www.google.it."
5. To finalize, click the "Add" button. To cancel, click the "Cancel" button.
We support three parameter types: List, Text, and Number.
Once defined you will be able to see it here:
Creating a Script to Control Network Devices
1. The main panel displays a scripting area with JavaScript functions for network device control. It includes functions like `validate()` for validating associations and `get_status()` for retrieving device variables. Each function is annotated with metadata that describes its purpose and usage.
2. On the left, there are sections for "Functions," "Parameters," and "Actions." Under "Functions," the current script displays `validate` and `get_status`.
3. Under "Parameters," there's a parameter named "Hosts," which you can interact with by using the pencil icon to edit or the trash can icon to delete it. Use the "+ Add Parameter" button to include additional parameters.
4. Use the "Add Actions" button to incorporate actions into the script as required.
5. At the bottom, there is an option to "Test Script Code" where you can select a device and a function to test and run the code.
And you will be able to access it in the code by using the D.getParameter() function:
JavaScript Function for Retrieving Hosts Parameter
1. The interface is designed for creating scripts to manage network devices using JavaScript.
2. In the editor, two functions are defined: `validate` and `get_status`.
3. The `get_status` function includes a line where the parameter 'Hosts' is assigned to the variable `hosts` using `D.getParameter('Hosts');`.
4. The purpose of the `get_status` function, as described, is to retrieve device variables.
5. There's a successful validation indicated next to the `get_status` function on the left under "Functions".
6. A parameter named 'Hosts' is listed under "Parameters" and can be modified or deleted.
Change Parameters on an already applied driver
Please note that once the driver has been applied, you will be able to change its parameters directly in the Drivers tab (here there are other drivers shown with different parameters, just an example):
Automation and Drivers Interface Overview
1. At the top, the header shows a device is online with its IP address and other identifiers.
2. In the "Automation & Drivers" section, you can add a new driver by selecting "Add Driver."
3. The "Variable Tables sample script" section indicates the script status as "RUNNING" with a sample period link to "5 Minutes." The last update timestamp and time zone (EEST) are shown with a "Refresh Data" option.
4. Use the "Parameters" link on the right to modify script parameters.
5. Two actions, "Test Action 1" and "Test action 2," are available for testing.
6. The "Sample Data Table" displays data with columns for "Id," "ID," "Name," and "Status," showing devices named Device A to Device E with corresponding statuses like "online," "offline," and "warning."
7. Import or export data using the "Download CSV" link.
Driver Setup Form Configuration
1. Set the "create_table" parameter to "yes" to enable table creation.
2. Set the "create_variable" parameter to "yes" to enable variable creation.
3. In the "list" section, select or enter items. The current selection is "all." Use the "Add" button to include more items.
4. Enter the "number_param" value as "111."
5. Input a password or sensitive data in the "secret" field, which is masked for security.
6. Choose "Apply" to save the settings or "Cancel" to discard changes.
Step 5 Add additional Custom Actions
By using the “Add Actions” button, it is possible to create user defined “actions/functions”:
Creating and Managing Scripts in the Automation Interface
1. Navigate to the "Automation & Scripts" section in the platform.
2. Locate "Script Properties" on the left panel—provide a script name and description if needed.
3. Under "Script Options," select whether credentials are required, set the minimum sample period, and define the timeout duration.
4. To add parameters or actions to your script, find "Parameters" and "Actions" under "Code." Click "+ Add Parameter" or "+ Add Actions" to include new entries.
5. Review the default functions displayed—"validate" and "get_status"—and ensure they meet your automation needs.
6. Use the "Test Script Code" section at the bottom by selecting a device and function to execute scripts and see results.
And these can be tested by assigning the driver to the device and selecting the proper Custom function:
Windows Pending Reboot Script Setup
1. The left panel displays "Script Properties," including "Name" as "Windows Pending Reboot (1)" and "Description" for monitoring the Pending Reboot status.
2. Under "Script Options," there is a checkbox labeled "Credential required" for securing data access, "Minimum Sample period" set to 5 minutes, and "Timeout" set to 30 seconds. There is also an option to "Delete script."
3. The main panel contains a script written in JavaScript. The code defines a function labeled "Reboot Now" with a warning indicating that pressing the button does not guarantee a confirmation.
4. At the bottom right, there is a dropdown labeled "Test Script Code" with an option selected as "custom_1" and a "Run code" button to execute the script.
In the above example, the custom_1 action is a button with the label “Reboot Now” that if pressed will run the command contained in the rebootCommand variable.
If you select the device you would like to test the driver on and you select the custom_1 function and then press the “Run code” button, you will be able to test that specific action on the device.
After assigning the custom_1 action to the device (please see here how to assign it: https://help.domotz.com/monitoring-management/custom-driver/#htoc-how-to-apply-drivers-to-device) , you can see it in the “Drivers” tab of your device and execute the function by clicking on the “Execute Action” bottom:
Manage Windows Updates on a Server
1. Check the status of updates under "Windows Updates List and Count" where the current status is "RUNNING."
2. Note the details like "Sample period: 5 Minutes" and "Variables consumed: 22."
3. Review the "Variables" section which lists update categories and their severity, including values such as "Severity - Unspecified: 2" and "Category - Security: 2."
4. To install the updates, click on the "Install Updates" button.
5. You can download the list of updates by clicking on "Download CSV."
Expandable descriptions are also available for your Custom action under “Drivers” tab of your device.
Running Test Interface
1. The header indicates a "New Test" with a status of "RUNNING." The test's sample period is set for "5 Minutes," and no variables have been consumed, as shown by "Variables consumed: 0."
2. Two paragraphs of placeholder text are present, each with buttons next to them. The first button is labeled "Really Long Text Button Add...," suggesting an action to add or modify content related to the descriptive text. The second button is labeled "Short btn," presumably for a concise action.
3. A note prompts, "Please add a description for the custom_3 act..." with an option to "Execute action," indicating a requirement to provide additional details or perform a specific task.
4. A section titled "[Mock] Example Driver 1" indicates it "Creates 3 Variables" with "No Calls," suggesting functionality or operations related to the mock driver setup or configuration.
How to test a Driver?
You can validate the code of a driver by executing it against a device of your choice.
Step 0 Open the Driver Coding IDE
Navigating the "My Drivers" Section in Domotz Software
1. On the left sidebar, select "Integrations" and then click on "Software Integrations" to access the appropriate tab.
2. Within the "Drivers and Automation" section, navigate to the "My Drivers" tab to view your customized drivers.
3. In the list of drivers, locate "Dell IDRAC PSU Monitoring" and select the "View Details" button to access more information about this driver.
Editing a Driver in Domotz
1. Navigate to the "Drivers and Automation" section under "Integrations."
2. In the "My Drivers" tab, locate the driver list.
3. Click on "Dell iDRAC PSU Monitoring" to view details.
4. The details panel on the right shows relevant information, including communication protocols (SSH), sample period (1 hr), and execution timeout (60 seconds).
5. To make changes, select "Edit Driver" at the bottom of the details panel.
Step 1 Open the Driver Details section
Creating a Custom Driver for Network Devices
1. In the "Driver Code" section, use the provided JavaScript template to control and inspect network devices. Two primary functions are illustrated: `validate` and `get_status`.
2. The `validate` function checks if a device is a valid candidate for this driver. It includes a callback function that invokes `D.success()` upon successful validation.
3. The `get_status` function retrieves device variables. It defines several variables, such as `myVariableUID`, `myVariableLabel`, `myVariableValue`, and `myVariableUnit`.
4. These variables are used to create `myExampleVariable`, which represents the device's parameter. The function finishes by calling `D.success([myExampleVariable])` to successfully return the device variables.
5. Use the interface below the code section to test your driver by selecting a device and a function, then clicking "Run code" to validate the input.
6. A confirmation message "The Code is valid" ensures successful execution and validation of your code.
Step 2 Select a Device for the Driver
Select a Device for Automation Script
1. Navigate to the "Test on a device" section in the left sidebar of the automation and scripts detail page.
2. Click on the dropdown labeled "Select a Device."
3. Choose the device you want to test the automation script on from the list.
4. The code preview on the right displays a script to check for backup directory mounts on a Linux system. It uses SSH configuration with placeholders for username and password.
5. Follow the interface to validate the script by clicking "validate" under Functions.
Selecting a Device for the Driver
1. At the top, search for devices using the "Search for devices" field.
2. A list titled "300 Devices Found" displays available devices. Each entry shows a device identifier, review status, and associated network details.
3. Information includes how long ago the device was updated, shown on the left.
4. Device identifiers include names like "NASE30B79" and "home-controller-hc250-000FFF1707A7."
5. Manufacturer names (e.g., Polycom, QNAP) and IP addresses (e.g., 192.168.5.96) appear to the right of each device.
6. Select a device by choosing the corresponding radio button on the right.
7. Once a device is selected, click "Done" at the bottom to confirm your selection.
Step 3 Add your credentials and validate/test run the driver
Check Backup Directory Mounts Interface
1. The interface is titled "Check Backup Directory Mounts" and is associated with 1 device.
2. On the left side, under "Test Credentials," enter your Username and Password to access the data protected by a password.
3. Select a device to test on from the "Test on a device" dropdown menu.
4. Click "Test" next to "validate" or "get_status" under the "Functions" section to perform these actions.
5. The right side displays a code preview where you can see commands to check for backup directories using shell commands integrated with SSH configuration.
6. Pay attention to the commands that check for "/backups" and "/periodic_backup" to ensure these directories are present.
And select a function to execute:
Run a Script to Check Backup Directory Mounts
1. Access the Integrations section and go to the 'Automation & Scripts Detail' page for checking backup directory mounts.
2. Under 'Options', set the 'Min. Sample period' to 5 Minutes and 'Timeout' to 30 Seconds.
3. In 'Credentials Required', ensure the access is protected by a password.
4. In 'Settings', under 'Test on a device', select 'Mia For Tests' from the dropdown.
5. In the 'Functions' section, locate the 'validate' function and click the 'Test' button beside it.
6. Similarly, find the 'get_status' function and press the 'Test' button to verify the status.
7. The 'Code Preview' section provides a script setup, including SSH command options and custom driver table creation to check the backup directory presence on a Linux system.
- Validate is designed to verify if the device that you apply a driver to can support the driver’s functionality. To clarify, the function will be executed and depending on the result it will allow or prevent the driver to device association:
- The D.success() callback indicates the device is a valid candidate for the driver.
- The D.failure(D.errorType.DEVICE_NOT_SUPPORTED) callback indicates that this driver’s functionality is not supported on the selected device.
2. Get_status is the the fuction to get your real variables.
Step 5 Checking the result
A pop-up will appear with the code run execution result for the specified function:
Execution Result Interface Overview
1. The interface is titled "Execution Result" and displays the status of a script execution.
2. At the top, it shows the operation "get_status" and a "Success" label with a green checkmark indicating successful execution.
3. Below, the "Mount Point Status" section contains columns for Id, StorageBox, and SoloNAS, with filter options, showing backup statuses: "false" for StorageBox and "true" for SoloNAS.
4. The "Console Log" section is highlighted to review any errors. It displays logs with details like device creation for script execution, including ID, IP address, and credentials.
5. There are additional log entries showing command execution, connection establishment, and termination details.
6. At the bottom, a "Close" button is available to exit the execution results.
Running Code Interface
1. At the top, there is a dark header with "Run code" as the title.
2. Below the header, there are two tabs: "Output" and "Log". Click these to switch between views.
3. On the left side, a section displays "get_status" indicating it's a function.
4. Below that, there's a "Variables" section with an example label.
5. To the right, the example label's value is noted as "this is an example value changed".
6. Use this interface to execute code and review variable outputs or function logs.
You can also add logging to your driver:
JavaScript Function Code Example
1. A function named `get_status` is defined. The purpose of this function is documented above it.
2. Within the function, a console message outputs 'Executing get_status' to inform that the function is running.
3. Several variables are declared:
- `myVariableUID` set to 'a'.
- `myVariableLabel` set to 'this is an example label'.
- `myVariableValue` set to 'this is an example value'.
- `myVariableUnit` set to 'text'.
4. A variable `myExampleVariable` is assigned to a function `D.device.createVariable` with parameters `myVariableUID`, `myVariableLabel`, `myVariableValue`, and `myVariableUnit`.
And after running the code you will be able to access it under the Console Log section.
Drivers table variables
Now, you can also create table variables where each record is a demonstration of various key/value pairs. You can basically insert records and insert the unique identifier of the row, which in this case is the Docker container ID, then you just insert for each column your defined value.
Execution Result Overview
1. The execution result screen displays a status message labeled as "Success."
2. Under "Variables," there is a table with three columns: "Id," "Name," and "CPU."
3. The table lists two entries. The first entry has the Id "d01f4d3c10a2," Name "Home-Assistant," and CPU usage "0.16." The second entry has the Id "ef82b9f75cb9," Name "pihole," and CPU usage "0.09."
4. On the right side, the "Console Log" contains details of the script execution, including device information, command executed, and the options used.
5. The script created a new device with specified IP, protocol, hardware address, and credentials.
6. The command executed is a Docker stats command, formatted to display container, name, CPU percentage, and memory percentage.
7. Execution concluded with exit code 0, indicating successful termination.
Execution Result Overview
1. The operation executed is called "get_status."
2. A status message indicates "Success" with a green checkmark.
3. Under "Variables," two columns are displayed:
- "CPU" with values 0.16 and 0.09.
- "MEM" with values 22.38 and 2.74.
4. On the right, the Console Log reports a new device creation with detailed device settings, including:
- IP address: 192.168.77.94
- Protocol: IP
- Hardware address: 10:BF:48:8D:84:14
- User credentials, SNMP authentication details, and encryption settings.
How to define Drivers Table, you can follow the link: https://portal.domotz.com/custom-driver/driverTable.html
To see an example of driver table variables: https://github.com/domotz/custom-driver/blob/master/examples/ssh/docker_stats.js
How to apply a Driver from the Device Page
Step 1 – If no drivers where assigned to the device
Go on the page of the device you would like to apply the driver to and click on “Apply Driversto Device”:
Device Management Interface Overview
1. The interface displays details for an HP Elite Slice G2 Windows device, currently online. Device identification information such as the location and IP address is shown at the top.
2. Key actions are available on the right:
- Click "Manage Automation & Drivers" to configure automation settings and update drivers.
- Other options include applying or creating profiles, exporting or importing device settings, stopping management, and deleting the device.
3. In the main section, "Network Connectivity Status" shows the current status marked as "ONLINE," along with the last status change time and frequency of status changes in the last 24 hours.
4. Below, under "Network Connectivity Performance," you can view the last day’s heartbeat loss, latest ping round-trip delay (RTD), packet loss statistics, and historical ping range.
5. The "Latest Events" section indicates an IP change occurred on March 10, 2026, at 07:49 AM (MDT).
6. Additional connections can be initiated in the "Latest Connections" section by selecting "Create a Connection."
Step 1 – If you have already assigned a driver to a specific device
Go on the page of the device you would like to apply the driver to and click on select “Manage Automation & Drivers” or click on the “Drivers” tab button:
Accessing the Drivers Tab in a Device Management Interface
1. At the top of the interface, confirm the device name "HP_Elite_Slice_G2 Windows" and its online status, shown in green text.
2. Below the device name, several tab options are available. Click on the "Drivers" tab to view information related to device drivers.
3. The interface indicates that all services are unlocked, with a lock icon for easy identification.
4. The "Network Connectivity Status" section shows the current status as "ONLINE" with the last status change noted as 10 months ago.
5. "Status Changes 24h" provides information on status changes, currently listed as zero.
Use this walkthrough to navigate and access driver-related information within the device management interface.
Step 2 – Search and Apply the custom driver
Select the driver that you want to apply to this device. To filter your Driver list, check the boxes ” Already associated to a device” or ” Valid Code”, or both.
Device Scripts Manager: Selecting and Applying Scripts
1. Review available scripts listed for application to a device, including options for various Windows Update counts and lists, as well as a Linux df command.
2. Optional: Use the checkbox at the top to filter scripts that are already associated with a device or require a valid code.
3. Click the plus sign next to any desired script to select it for application.
4. Confirm selection by clicking the "Done" button at the bottom of the window.
Note:
You can apply more than one driver to a single device.
Be aware that the chosen driver must have a valid code.
Unlocking a Device
1. A pop-up window prompts you to unlock a device by providing credentials.
2. Enter your username in the designated field, shown here as "test_team@domotz.com."
3. Input your password in the password field, which is masked for security.
4. To proceed, click the "Unlock" button.
5. If you need to cancel the action, click the "Cancel" button.
Note: When associating a driver to a device that requires credentials, please provide the correct credentials for this device.
The ‘Driver’ tab will appeare after assigning a driver to a single device:
Automation and Scripts Management Overview
1. The device is online, displaying its IP address and relevant identifiers.
2. Under "Automation & Scripts," you can add new scripts using the "Add Script" button.
3. The "Linux Services" section shows the current status as "RUNNING." It's updated every 5 minutes, and 12 variables are consumed.
4. The "Services List" displays details with columns for Id, Service Name, and Status.
5. Services include:
- apparmor: exited
- pm2: running
- mysql: running
- nfs-config: dead
- nfs-utils: dead
- ssh: running
6. You can download the service data as a CSV file using the "Download CSV" link.
When multiple drivers are associated to a single device, the Drivers tab will display them one after the other (you just need to scroll down in the Drivers section):
Server Monitoring Dashboard Overview
1. The top section identifies the server with its name, online status, IP address, and backup information.
2. The "Services List" displays a table with columns for ID, Service Name, and Status. Example entries include:
- "apparmor" with status "exited"
- "pm2" with status "running"
- "mysql" with status "running"
- "nfs-config" with status "dead"
- "ssh" with status "running"
3. The lower section is labeled "MAP Mysql - port 22". It shows the service status as "RUNNING," with a sample period link set to "5 Minutes" and mentions "Variables consumed: 3".
4. The "Variables" table lists:
- "Errors" with "No admin information" and last change "2 mo ago"
- "Status" as "active (running)" with last change "2 mo ago"
- "Used Ram" with "2479556 KB" and last change "10 days ago"
5. An option to "Download CSV" is available next to both tables.
Agent Variable Consumption
The Agent’s Automation & Drivers variable consumption box shown on the ‘Devices list’ screen indicates the number of driver variables consumed by the particular Agent:
Managing Devices and Monitoring Settings Overview
1. At the top left, the current server, "Acme-Proxmox-backup," is displayed with its online status and IP address.
2. Below, a list of devices is shown with details such as status, name, age, and specific information like IP address and response time. Each device has an icon indicating the type and current status.
3. The right panel contains various configurable options:
- "Devices External Services" allows managing external connections.
- "Add External Hostname/IP" and "Configure Routed Networks Scan" for network configurations.
- "Configure VLAN" for VLAN settings.
4. Under "Monitoring Settings":
- "Device Blacklist" allows adding devices to a blacklist.
- "Device Auto Discovery" is active, indicating automatic detection of new devices.
- "Device RTD" shows real-time data settings, which are currently active.
5. In the "Automation & Scripts Variables" section:
- Displays the total number of variables used, shown as "69/200."
- Includes an option to upgrade variable capacity.
By clicking on the highlighted above section, you will be able to access the Manage Automation & Drivers section where you can see which devices are consuming variables:
Manage Automation & Scripts Dashboard
1. The top section indicates the purpose of managing automation and scripts: to monitor variable consumption for devices associated with these functionalities.
2. The "Devices with Automation & Scripts" section lists devices currently linked with automation and scripts. It features a device identified by an icon and modified name "M" from 10 months ago, displaying a consumption of 69 variables.
3. On the right, the "Automation & Scripts Variables" panel shows a progress bar representing the total number of consumed variables against a limit. It currently shows 69 out of 200 variables used. An "Upgrade" button is available for increasing the limit.
Step 3 Driver configuration
Go to the Drivers tab and find your driver configuration (sample period) and results:
Accessing and Managing Linux Scripts in Device Details
1. In the Device Details section, select the "Scripts" tab to view automation and script options.
2. Under "Linux Services," verify the service status is "RUNNING" and note the sample period, which is linked as "5 Minutes."
3. In the "Services List," locate the row for "apparmor" and click the action icon in its row for additional options.
A historical view of the variable value changes is available by clicking under its value cell:
How to Download a CSV file of your Driver variables tables
After selecting your device, please enter the Drivers tab of your device with custom integrations and click the “Download CSV” link to download a CSV of your chosen variables tables.
How to access and download Linux service status data.
1. Navigate to the "Scripts" tab in the interface, which is part of the Automation & Scripts section. This tab provides access to scripts and variables.
2. Locate the "Linux Services" section. Here, view details such as status, sample period, and variables consumed. To extract the data, click on "Download CSV" to download a CSV file containing the services list information, including service IDs, names, and statuses.
Failed Drivers
If one or more drivers are in the “Failed” status, you will see an informative banner in the “Automation and Drivers variables” section stating “One or more Drivers have stopped working”.
Script Error Notification and Variable Usage Overview.
1. A pink alert box indicates that one or more scripts have stopped working. A link labeled "Review here" is provided for troubleshooting.
2. Below the alert, the section labeled "Total number of Automation & Scripts Variables" displays a progress bar. It shows "Variables Consumed" with a current usage of 56 out of 200.
3. To the right of the progress bar, there's a "+" button for adding more variables, and an "Upgrade" link to increase the variable limit.
By clicking on the banner, you will be able to access the Manage Automation & Drivers section, where you can see a list of devices for which the driver has been stopped.
Automation and Scripts Management Dashboard
1. The dashboard shows a section titled "Manage Automation & Scripts," which monitors variable consumption for devices using automation and scripts.
2. A warning message indicates, "One or more Scripts have stopped working," specifically highlighting the device "DC01."
3. Under "Devices with Automation & Scripts," two devices are listed:
- "DC01," with a note from "2 months ago" and 46 variables associated.
- "Server01," with a note from "5 months ago" and 10 variables associated.
This dashboard helps identify script issues and monitor device variable usage.
Note: The failed drivers are easily visible under the “Drivers” tab of your selected device.