NetXMS icon

NetXMS

Interact with the NetXMS network monitoring and management system

Object → Set Maintenance

AI-generated

Summary

Enable or disable maintenance mode on a NetXMS object by ID, optionally attaching a comment.

Inputs

  • Object ID (required) — Numeric ID of the NetXMS object to change.
  • Maintenance Mode (required) — True enters maintenance mode, false leaves it. Defaults to true.
  • Comments — Optional maintenance comment. It is sent only when non-empty.

Output shape

One item per input item: {success: true, objectId, maintenance}. It echoes the inputs and does not contain the server's response.

It sends a POST to /v1/objects/{objectId}/set-maintenance with body {maintenance, comments?}. The node logs in to NetXMS with the credentials for each execution. If the request fails, the node throws an error. With Continue On Fail enabled, it returns {error: message} for that item instead.

Examples

Example 1: Suppress alerts on a node before a planned patch window.

Object ID = 123, Maintenance Mode = true, Comments = 'Monthly patching'.

Example 2: Take the node out of maintenance once the job finishes.

Object ID = 123, Maintenance Mode = false, Comments left empty.

Links

Discussion