Actions24
- Computer Actions
- Maintenance Actions
- Person Actions
- Provider Link Actions
- Tag Actions
- Tenant Actions
- User Actions
Overview
The node interacts with a service called ImmyBot, specifically focusing on managing "Provider Links" and retrieving provisioning packages. The "Get Provisioning Package" operation fetches a provisioning package for a specified provider link and external client ID, allowing automated onboarding and device setup configurations.
This node is useful in scenarios where automated device provisioning and onboarding are required, such as IT departments deploying new machines or configuring devices remotely. It supports options to customize the onboarding process, including reboot preferences, email notifications, and wireless setup.
Practical examples:
- Automatically onboard a new device with specific user tags and reboot behavior.
- Retrieve a provisioning package that disables hibernation and sets up wireless connectivity.
- Encrypt the provisioning package and configure local admin credentials for secure deployment.
Properties
| Name | Meaning |
|---|---|
| Provider Link ID | The unique identifier of the provider link to target. |
| Target External Client ID | The external client ID representing the target device or client for which the provisioning package is requested. |
Onboarding Options (collection)
| Name | Meaning |
|---|---|
| Automatically Onboard | Boolean flag to enable automatic onboarding of the device. |
| Onboarding Correlation ID | Hidden field used internally to correlate onboarding sessions. |
| Reboot Preference | Options controlling reboot behavior during onboarding: If Necessary, Force, Suppress, Prompt. |
| Prompt Timeout Action | Action to take if a reboot prompt times out: Reboot, Suppress, Fail Session. Only shown if Reboot Preference is "Prompt". |
| Auto Consent to Reboots | Boolean indicating whether to automatically consent to reboots when prompted. Only shown if Reboot Preference is "Prompt". |
| Prompt Timeout Minutes | Number of minutes to wait before timeout on reboot prompt (1-60). Only shown if Reboot Preference is "Prompt". |
| Send Follow-up Email | Boolean to send a follow-up email after onboarding. |
| Primary Person ID | Numeric ID of the primary person associated with the onboarding. |
| Additional Person IDs | Comma-separated list of additional person IDs involved in onboarding. |
| Tag IDs | Comma-separated list of tag IDs to associate with the onboarding session. |
| Is Dev Lab | Boolean flag indicating if the provisioning is for a development lab environment. |
Package Options (collection)
| Name | Meaning |
|---|---|
| Disable Hibernation | Boolean to disable hibernation on the provisioned device. |
| Download ISO | Boolean to download an ISO image as part of the provisioning package. |
| Enable Clean PC | Boolean to enable a clean PC setup during provisioning. |
| Encrypt Package | Boolean to encrypt the provisioning package. |
| Package Password | Password to use for encrypting the package. Only shown if Encrypt Package is true. |
| Setup Admin | Boolean to set up a local administrator account. |
| Hide Admin Account | Boolean to hide the local admin account. Only shown if Setup Admin is true. |
| Local Admin Username | Username for the local admin account. Only shown if Setup Admin is true. |
| Local Admin Password | Password for the local admin account. Only shown if Setup Admin is true. |
| Setup Wireless | Boolean to configure wireless settings. |
| Wireless SSID | SSID of the wireless network to connect to. Only shown if Setup Wireless is true. |
| Wireless Key | Password/key for the wireless network. Only shown if Setup Wireless is true and Wireless Open is false. |
| Wireless Open | Boolean indicating if the wireless network is open (no password). Only shown if Setup Wireless is true. |
Output
The node outputs JSON data containing the provisioning package details retrieved from the ImmyBot API. This typically includes metadata about the package, configuration settings, and possibly encoded or binary data representing the provisioning payload.
If the "Download ISO" option is enabled, the output may include binary data representing the ISO image for download.
Dependencies
- Requires an API key credential for authenticating with the ImmyBot service.
- The base URL for API requests is dynamically constructed using a subdomain from the credentials.
- The node expects the ImmyBot API v1 endpoint to be accessible.
Troubleshooting
- Invalid Provider Link ID or Target External Client ID: Ensure these IDs are correct and exist in the ImmyBot system; otherwise, the API will return errors.
- Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
- Timeouts or Network Issues: Check network connectivity to the ImmyBot API endpoint.
- Incorrect Property Combinations: For example, setting wireless keys while marking the network as open may cause conflicts; ensure property dependencies are respected.
- Encryption Password Missing: If "Encrypt Package" is enabled but no password is provided, the request may fail.
Links and References
- ImmyBot API Documentation (hypothetical link)
- n8n documentation on Creating Custom Nodes