ImmyBot

Overview

The node executes a maintenance task on specified targets such as computers, tenants, or persons. It allows scheduling and configuring various aspects of the maintenance run, including deployment details, email notifications, execution preferences, and UI options. This node is useful for automating software maintenance workflows like updates, repairs, audits, or monitoring across multiple devices or user groups.

Practical examples:

• Scheduling a software update deployment to a group of computers at a specific time zone and time.
• Running a repair maintenance task with automatic reboot consent and follow-up email notifications.
• Auditing software compliance without enforcing changes, while skipping background jobs.

Properties

Name	Meaning
Deployment Options	Configuration related to deployment: - Deployment ID (number) - Deployment Type (number) - Offline Behavior: Skip or Apply on Connect - Use Winning Deployment (boolean)
Email Options	Email notification settings: - Send Detection Email (boolean) - Send Detection Email When All Actions Are Compliant (boolean) - Send Follow-up Email (boolean) - Send Follow-up Only If Action Needed (boolean)
Execution Options	Execution behavior controls: - Auto Consent to Reboots (boolean) - Cache Only (boolean) - Prompt Timeout Action: Reboot, Suppress, Fail Session - Prompt Timeout Minutes (1-60) - Reboot Preference: If Necessary, Force, Suppress, Prompt - Skip Background Job (boolean) - Time Zone (string, e.g., "America/Detroit") - Update Time (string, 24-hour format e.g., "02:00")
Maintenance Parameters	Details about the maintenance task: - Maintenance Identifier (string) - Maintenance Type (number) - Repair (boolean) - Session Group ID (string) - Desired Software State: Installed - Latest Version, Installed - Any Version, Update if Found, Uninstalled, Ignored - Task Mode: Enforce, Audit, Monitor, Ignore - Task Parameter Values (JSON object)
Targets	Specifies the targets for the maintenance: - Computer IDs (JSON array of objects with computerId property) - Tenant IDs (JSON array) - Person IDs (JSON array)
UI Options	User interface display options: - Show Run Now Button (boolean) - Show Postpone Button (boolean) - Show Maintenance Actions (boolean)

Output

The node outputs JSON data representing the result of the maintenance run operation. This typically includes status information, success or failure indicators, and any relevant response details from the maintenance system. The output does not explicitly mention binary data, so it is assumed to be purely JSON structured.

Dependencies

• Requires an API key credential for authentication to the external maintenance service.
• The base URL for API requests is dynamically constructed using a subdomain credential value.
• The node depends on the external maintenance platform's API to perform the maintenance tasks.

Troubleshooting

• Common issues:

  • Invalid or missing target IDs (computers, tenants, persons) may cause the maintenance run to fail or affect no devices.
  • Incorrect time zone or update time formats can lead to scheduling errors.
  • Insufficient permissions or invalid API credentials will prevent successful API calls.
  • Misconfiguration of reboot preferences or prompt timeout actions might cause unexpected device reboots or session failures.

• Error messages:

  • Authentication errors indicate problems with the provided API key or OAuth token; verify credentials.
  • Validation errors on input properties suggest incorrect types or missing required fields; check property values carefully.
  • Network or connectivity errors imply issues reaching the external API endpoint; ensure network access and correct base URL.

Links and References

• Refer to the external maintenance platform’s API documentation for detailed descriptions of deployment types, maintenance types, and other enumerations.
• Time zone identifiers should conform to the IANA time zone database (e.g., "America/Detroit").
• JSON formatting for complex properties like taskParameterValues and target arrays must follow standard JSON syntax.