AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

This node operation updates an existing IP address record in a system that manages IP addresses and related metadata. It allows users to modify various attributes of an IP address such as its actual address, status, associated domain name, description, comments, and links to assets, networks, or companies.

Common scenarios for this node include:

  • Correcting or updating the status of an IP address (e.g., marking it as assigned or deprecated).
  • Adding or changing descriptive information or comments about an IP address.
  • Associating an IP address with different assets, networks, or companies as organizational changes occur.
  • Updating the Fully Qualified Domain Name (FQDN) linked to an IP address.

Practical example:

  • A network administrator wants to update the status of an IP address from "unassigned" to "assigned" and add a description indicating which device it is now allocated to.
  • An IT asset manager needs to link an IP address to a newly added asset ID after hardware deployment.

Properties

Name Meaning
Id The unique identifier of the IP address to update.
Additional Body Fields Optional fields to update on the IP address record:
- Address The IP address string itself (e.g., "192.168.1.10").
- Status The status of the IP address. Allowed values: unassigned, assigned, reserved, deprecated, dhcp, slaac.
- Fqdn The Fully Qualified Domain Name associated with the IP address.
- Description A brief textual description of the IP address.
- Comments Additional comments or notes about the IP address.
- Asset Id Numeric identifier of the asset linked to this IP address.
- Network Id Numeric identifier of the network to which this IP address belongs.
- Company Id Numeric identifier of the company owning this IP address.

Output

The node outputs JSON data representing the updated IP address object as returned by the API or service it interacts with. This typically includes all the updated fields along with any additional metadata provided by the backend system.

If the node supports binary data output (not indicated here), it would represent associated files or attachments related to the IP address, but this is not applicable based on the provided code and properties.

Dependencies

  • Requires an API key or authentication token configured in n8n credentials to authorize requests to the IP address management backend.
  • Depends on a REST API endpoint capable of handling IP address update requests.
  • The base URL and headers for the API are expected to be set up in the node's credential configuration.

Troubleshooting

  • Missing or invalid Id: The update operation requires a valid IP address ID. Ensure the "Id" property is provided and corresponds to an existing IP address.
  • Invalid status value: The "Status" field must be one of the allowed values (unassigned, assigned, reserved, deprecated, dhcp, slaac). Providing an unsupported status will likely cause an error.
  • API authentication errors: If the API key or token is missing or incorrect, the node will fail to authenticate. Verify credentials in n8n settings.
  • Network or connectivity issues: Failures to reach the API endpoint may result in timeout or connection errors.
  • Validation errors: Some fields like IP address format or numeric IDs might be validated by the API; ensure correct formats and types.

Links and References

  • No direct external links were found in the source code.
  • For more details on IP address statuses and management best practices, consult your IPAM (IP Address Management) system documentation or relevant RFCs for IP addressing standards.

Discussion