LibreNMSInstall

Overview

The "Set Maintenance" operation for the Device Groups resource in this node allows users to schedule a maintenance window for a specified device group within LibreNMS, a network monitoring system. This operation is useful for temporarily suppressing alerts or notifications related to devices in that group during planned maintenance activities, such as upgrades, hardware replacements, or troubleshooting.

Typical use cases include:

• Scheduling downtime for a group of network devices before performing firmware updates.
• Notifying the monitoring system about maintenance periods to avoid false alarms.
• Adding descriptive notes and specifying exact start times for maintenance windows.

For example, a network administrator can set a 2-hour maintenance window on the "Core Switches" device group starting at a specific time with a title and notes describing the purpose of the maintenance.

Properties

Output

The node outputs JSON data representing the result of setting the maintenance window on the specified device group. This typically includes confirmation details such as the group name, maintenance duration, start time, and any metadata returned by the LibreNMS API confirming the update.

If the node supports binary output (not indicated here), it would generally relate to raw response data or logs, but this operation primarily deals with JSON responses.

Dependencies

• Requires an active connection to a LibreNMS instance via its REST API.
• Needs an API authentication token or key configured in the node credentials to authorize requests.
• The base URL of the LibreNMS API must be correctly set in the node credentials.
• Proper permissions on the LibreNMS server to modify device group maintenance settings.

Troubleshooting

• Invalid Group Name: If the specified device group does not exist, the API will likely return an error. Verify the group name spelling and existence in LibreNMS.
• Incorrect Duration Format: The duration must be in H:i format (e.g., "2:00"). Providing an invalid format may cause request failure.
• Start Time Format Errors: The start time must follow the Y-m-d H:i:s format. Incorrect formatting can lead to errors or unexpected scheduling.
• Authentication Failures: Ensure the API key/token is valid and has sufficient privileges.
• API Connectivity Issues: Network problems or incorrect API base URL configuration can prevent successful requests.
• Maintenance Overlaps: Setting overlapping maintenance windows might cause conflicts; check existing schedules if issues arise.

Links and References

• LibreNMS API Documentation
• LibreNMS Device Groups Overview
• Date and Time Formatting in PHP (similar to expected formats)