Actions24
- Tag Actions
- Provider Link Actions
- Computer Actions
- Maintenance Actions
- Person Actions
- Tenant Actions
- User Actions
Overview
The node interacts with the "Provider Link" resource to retrieve a provisioning package for a specified provider link and target external client. This provisioning package is typically used in IT environments to automate device setup, configuration, and onboarding processes. It supports options such as encryption, wireless network setup, admin account configuration, and onboarding preferences.
Practical scenarios include:
- Automatically generating a customized provisioning package for new devices linked to a specific provider.
- Configuring wireless settings and local administrator accounts on devices during deployment.
- Automating onboarding workflows with reboot preferences and follow-up notifications.
Properties
| Name | Meaning |
|---|---|
| Provider Link ID | The unique identifier of the provider link for which the provisioning package is requested. |
| Target External Client ID | The external client ID that the provisioning package targets. |
| Package Options | Collection of options to customize the provisioning package: - Encrypt Package (boolean): Whether to encrypt the package. - Package Password (string): Password for encryption if enabled. - Download ISO (boolean): Whether to download an ISO image. - Setup Wireless (boolean): Enable wireless setup. - Wireless Open (boolean): Use open wireless network. - Wireless SSID (string): SSID of the wireless network. - Wireless Key (string): Wireless network key if not open. - Setup Admin (boolean): Configure local admin account. - Local Admin Username (string): Username for local admin. - Local Admin Password (string): Password for local admin. - Hide Admin Account (boolean): Whether to hide the admin account. - Enable Clean PC (boolean): Enable clean PC option. - Disable Hibernation (boolean): Disable hibernation on the device. |
| Onboarding Options | Collection of options related to onboarding: - Automatically Onboard (boolean): Whether to onboard automatically. - Onboarding Correlation ID (hidden string): Internal correlation ID. - Reboot Preference (options): How to handle reboots (If Necessary, Force, Suppress, Prompt). - Prompt Timeout Action (options): Action on prompt timeout (Reboot, Suppress, Fail Session). - Auto Consent to Reboots (boolean): Automatically consent to reboots when prompted. - Prompt Timeout Minutes (number): Timeout duration for prompts in minutes. - Send Follow-up Email (boolean): Whether to send a follow-up email after onboarding. - Primary Person ID (number): ID of the primary person associated. - Additional Person IDs (string): Comma-separated list of additional person IDs. - Tag IDs (string): Comma-separated list of tag IDs. - Is Dev Lab (boolean): Flag indicating if this is a development lab environment. |
Output
The node outputs JSON data representing the provisioning package details retrieved from the API. This may include metadata about the package, download links (such as ISO images if requested), and status information. If the package is encrypted or includes binary data like an ISO file, the output will reflect these accordingly, but no direct binary output is exposed by the node itself.
Dependencies
- Requires an API key credential for authentication with the ImmyBot service.
- The base URL for API requests is dynamically constructed using a subdomain provided in credentials.
- The node depends on the ImmyBot API v1 endpoint to fetch provisioning packages.
Troubleshooting
- Invalid Provider Link ID or Target External Client ID: Ensure that the IDs provided are correct and exist in the system; otherwise, the API call will fail.
- Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Encryption Issues: If encryption is enabled but the password is missing or incorrect, the provisioning package retrieval may fail.
- Network or API Availability: Check network connectivity and ImmyBot API status if requests time out or return errors.
- Incorrect Option Combinations: For example, enabling wireless setup but not providing SSID or key (when required) may cause errors.