Hudu icon

Hudu

Interact with Hudu REST API

Overview

This node interacts with a network management API to create new network entries. It is designed to facilitate the automation of network inventory and configuration tasks by allowing users to define networks programmatically within their workflows.

Typical use cases include:

  • Automatically adding new network segments when provisioning infrastructure.
  • Integrating network creation into broader IT asset management or documentation processes.
  • Synchronizing network data from external systems into a centralized platform.

For example, a user could configure this node to create a new network with a specific name and CIDR address whenever a new office location is onboarded, ensuring consistent network documentation.

Properties

Name Meaning
Name The name of the network to be created.
Address The network address in CIDR notation (e.g., "192.168.1.0/24").
Network Type The type of network, represented as a number (specific types depend on the API's enumeration).
Additional Fields Optional extra properties for the network:
- Address Alternative or additional network address (CIDR notation).
- Company Name or ID Associates the network with a specific company, selectable from a list or via expression.
- Description A brief textual description of the network.
- Location ID Numeric identifier for the location associated with the network.
- Name An alternative or additional name field for the network.
- Network Type An alternative or additional numeric type designation for the network.
- Slug A URL-friendly identifier string for the network.

Output

The node outputs JSON data representing the newly created network object(s) as returned by the API. Each output item corresponds to an input item processed and includes all relevant details of the created network.

If the API supports binary data related to networks (not indicated here), it would be included accordingly, but based on the provided code and properties, the output is purely JSON.

Dependencies

  • Requires an API key credential for authentication with the target network management REST API.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on internal helper methods to handle the network creation operation.
  • Option loading for fields like "Company Name or ID" relies on auxiliary methods fetching available companies.

Troubleshooting

  • Common Issues:

    • Invalid or missing required fields such as "Name" or "Address" will cause errors.
    • Incorrect network address format (non-CIDR) may lead to API rejection.
    • Network type values outside the expected range might cause failures.
    • Failure to authenticate due to incorrect or missing API key.
  • Error Messages:

    • "The resource "networks" is not known!" indicates a misconfiguration of the resource parameter.
    • API errors returned from the server will be propagated; check the message for details like invalid parameters or permission issues.
  • Resolutions:

    • Ensure all required fields are correctly filled and formatted.
    • Verify API credentials and endpoint configuration.
    • Use the option loaders to select valid company IDs to avoid invalid references.
    • Enable "Continue On Fail" in the node settings to handle partial failures gracefully.

Links and References

Discussion