AjaxInstall

Overview

This node, named "Ajax," is designed to interact with an Ajax API (version indicated in the code). Specifically for the Device resource and the Execute Scan Fibra Devices Command operation, it sends commands to control scanning of Fibra devices connected to a specified hub within a company. Typical use cases include remotely starting or stopping the scan process on Fibra devices for network management, diagnostics, or maintenance purposes.

For example, a user might:

• Start scanning Fibra devices on a particular hub to detect new devices or check connectivity.
• Stop an ongoing scan once sufficient data has been collected or if the scan needs to be aborted.

Properties

Output

The node outputs JSON data representing the result of the executed command on the Fibra devices scan process. This typically includes status information confirming whether the scan was successfully started or stopped, any error messages, or relevant metadata returned by the Ajax API.

If the node supports binary data output, it would relate to any raw response or files returned by the API, but this is not explicitly indicated in the provided code snippet.

Dependencies

• Requires an API key credential for authenticating with the Ajax API.
• Depends on the external Ajax API service to send commands and receive responses.
• Uses internal helper classes for HTTP communication, state management, and operation resolution.
• No additional environment variables or configurations are explicitly required beyond the API credential.

Troubleshooting

• Common issues:

  • Invalid or missing Company Id or Hub Id will likely cause the API call to fail.
  • Incorrect or expired API credentials will prevent successful authentication.
  • Network connectivity problems can block communication with the Ajax API.
  • Using an unsupported command value (other than START or STOP) will cause errors.

• Error messages:

  • Authentication errors indicating invalid API keys require updating or reconfiguring credentials.
  • Validation errors about missing required parameters mean that Company Id, Hub Id, or Command were not properly set.
  • API response errors should be checked for detailed messages from the Ajax backend to guide corrective actions.

Links and References

• Ajax API Documentation (general reference for Ajax API usage)
• n8n documentation on creating custom nodes for further customization guidance