Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI). Specifically, the 'List Modules' operation under the 'Asterisk' resource retrieves system information related to the modules loaded in the Asterisk PBX. This node is useful for administrators or developers who need to monitor or manage the modules of their Asterisk PBX system programmatically. For example, it can be used to list all active modules to verify system configuration or troubleshoot module-related issues.

Use Case Examples

1. Listing all loaded modules in an Asterisk PBX to audit system components.
2. Automating monitoring of module status to trigger alerts if critical modules are unloaded.

Output

JSON

• modules - List of modules loaded in the Asterisk PBX system, including details about each module

Dependencies

• Requires an API key credential for Asterisk REST Interface (ARI) authentication, including the base URL for the ARI endpoint.

Troubleshooting

• Common issues include authentication failures due to incorrect or missing API credentials. Ensure the Asterisk API key credential is correctly configured with the base URL and access token.
• Network connectivity problems to the ARI endpoint can cause request failures. Verify network access and correct base URL configuration.
• If the node returns empty or incomplete module lists, verify that the ARI user has sufficient permissions to query system information.

Links

• Asterisk ARI Modules API Documentation - Official documentation for the Asterisk REST Interface modules endpoint, detailing available operations and data structures.