Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI). Specifically, the 'Unload Module' operation allows users to unload a specified module from the Asterisk system. This is useful for managing system resources, updating modules without restarting the entire system, or troubleshooting module-related issues. For example, an administrator can unload a voicemail module to apply updates or disable it temporarily.

Use Case Examples

1. Unload the 'app_voicemail.so' module to disable voicemail functionality temporarily.
2. Unload a custom module to apply updates without restarting the Asterisk server.

Properties

Output

JSON

• response - The JSON response from the Asterisk REST Interface after attempting to unload the module, indicating success or failure and any relevant details.

Dependencies

• Requires an API key credential for authenticating with the Asterisk REST Interface (ARI).
• Needs the base URL of the Asterisk ARI endpoint configured in credentials.

Troubleshooting

• Ensure the module name is correct and matches the exact module filename in the Asterisk system.
• Verify that the API credentials have sufficient permissions to unload modules.
• Check network connectivity to the Asterisk ARI endpoint.
• Common error: 'Module not found' indicates the specified module does not exist or is already unloaded.
• Common error: 'Unauthorized' indicates invalid or insufficient API credentials.

Links

• Asterisk ARI Modules API - Official documentation for managing modules via the Asterisk REST Interface.