Actions24
- Tag Actions
- Provider Link Actions
- Computer Actions
- Maintenance Actions
- Person Actions
- Tenant Actions
- User Actions
Overview
The "Maintenance - Run" operation in this node triggers a maintenance task on specified targets such as computers, tenants, or persons. It allows users to configure detailed parameters for the maintenance task, including session grouping, task identification, mode, type, and software state preferences. Additionally, it supports execution scheduling, deployment behavior, email notifications, and UI options.
This node is beneficial in IT management scenarios where automated maintenance tasks need to be run across multiple devices or user groups. For example, an IT administrator can use it to enforce software updates, audit system health, or monitor compliance status on a fleet of computers, with options to repair software or schedule reboots as needed.
Properties
| Name | Meaning |
|---|---|
| Maintenance Parameters | Collection of settings defining the maintenance task: - Session Group ID: Identifier grouping related sessions. - Maintenance Identifier: Unique ID for the maintenance task. - Task Mode: Enforce, Audit, Monitor, Ignore. - Maintenance Type: Numeric code representing the maintenance category. - Repair: Whether to attempt software repair. - Software Should Be: Desired software state (Installed latest, Installed any, Update if found, Uninstalled, Ignored). - Task Parameter Values: JSON object with additional parameters for the task. |
| Execution Options | Controls how the maintenance task runs: - Skip Background Job: Whether to skip background processing. - Cache Only: Use cached data only. - Reboot Preference: If necessary, force, suppress, or prompt for reboot. - Prompt Timeout Action: Action if prompt times out (reboot, suppress, fail session). - Auto Consent to Reboots: Automatically consent to reboots. - Prompt Timeout Minutes: Duration before timeout. - Update Time: Scheduled time for execution (24-hour format). - Time Zone: Time zone for scheduling. |
| Deployment Options | Settings related to deployment: - Deployment ID: Numeric identifier for deployment. - Deployment Type: Numeric code for deployment category. - Offline Behavior: Skip or apply when offline. - Use Winning Deployment: Whether to use the winning deployment configuration. |
| Email Options | Email notification preferences: - Send Detection Email: Notify upon detection. - Send Detection Email When All Actions Are Compliant: Notify only if all actions comply. - Send Follow-up Email: Send follow-up notifications. - Send Follow-up Only If Action Needed: Follow-up only if action required. |
| UI Options | User interface controls: - Show Run Now Button: Display immediate run button. - Show Postpone Button: Display postpone option. - Show Maintenance Actions: Show available maintenance actions. |
| Targets | Specifies the targets for the maintenance task: - Computer IDs: JSON array of computer objects with computerId.- Tenant IDs: JSON array of tenant identifiers. - Person IDs: JSON array of person identifiers. |
Output
The node outputs JSON data representing the result of the maintenance run operation. This typically includes status information about the execution, success or failure indicators, and possibly details about affected targets or performed actions.
If binary data is output (not indicated here), it would generally represent logs or reports generated by the maintenance task.
Dependencies
- Requires an API key credential for authentication to the ImmyBot service.
- The base URL for API requests is dynamically constructed using the user's subdomain credential.
- No other external dependencies are explicitly required.
Troubleshooting
Common Issues:
- Incorrect or missing API credentials will cause authentication failures.
- Invalid target IDs (computers, tenants, persons) may result in no action or errors.
- Scheduling conflicts or invalid time zone strings could prevent proper execution timing.
- Improperly formatted JSON in task parameter values or target lists may cause parsing errors.
Error Messages:
- Authentication errors: Verify that the API key credential is correctly configured.
- Validation errors: Check that all required fields are provided and correctly formatted.
- Timeout or network errors: Ensure connectivity to the ImmyBot API endpoint and correct subdomain usage.
Links and References
- ImmyBot API Documentation (hypothetical link)
- n8n documentation on Creating Custom Nodes
- General guidance on Scheduling Tasks