Overview

This node interacts with the NetBox API to update a Front Port resource within the DCIM domain. It allows users to modify various attributes of a front port, such as its name, device association, module, type, rear port linkage, label, color, connection status, description, tags, and custom fields. This is useful in network infrastructure management scenarios where front port details need to be kept current, for example, updating port labels or changing the physical type of the port connector.

Use Case Examples

1. Updating the name and label of a front port to reflect new hardware changes.
2. Changing the physical type of a front port connector to match updated cabling standards.
3. Linking a front port to a different rear port after reconfiguration of device modules.

Properties

Output

JSON

• id - The unique identifier of the updated front port record.
• name - The name of the front port after update.
• device - The device ID associated with the front port.
• module - The module ID associated with the front port.
• type - The physical type of the port connector.
• rear_port - The ID of the associated rear port.
• rear_port_position - The position of the port on the rear port.
• label - The physical label of the port.
• color - The color of the port as a hex string.
• mark_connected - Indicates if the port is treated as connected.
• description - Description of the front port.
• tags - Tags associated with the front port.
• custom_fields - Custom metadata fields in JSON format.

Dependencies

• NetBox API
• An API key credential for authentication

Troubleshooting

• Ensure the Front Port ID is correct and exists in the NetBox instance to avoid 'not found' errors.
• Verify that the API key credential has sufficient permissions to update front port resources.
• Check that the update fields are valid and conform to expected data types and constraints to prevent validation errors.
• If the node returns an error, enabling 'Continue on Fail' allows the workflow to proceed and outputs the error message for debugging.

Links

• NetBox API Documentation for Front Ports - Official documentation for the Front Ports resource in the NetBox API, detailing available fields and update operations.