NetBox icon

NetBox

Consume NetBox API

Actions243

Front Port Template → Update

AI-generated

Overview

This node updates a Front Port Template resource in the NetBox API within the DCIM domain. It is useful for modifying existing front port templates by changing properties such as name, device type ID, module type ID, port type, rear port ID, rear port position, label, color, and description. For example, a user can update the physical label or color of a front port template to reflect changes in hardware or documentation.

Use Case Examples

  1. Updating the name and description of a front port template to keep documentation accurate.
  2. Changing the port type or associated rear port ID to reflect hardware changes in a device.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is 'dcim' for device and component management.
Front Port Template ID The unique identifier of the front port template to update.
Update Fields Collection of fields to update on the front port template, including name, device type ID, module type ID, port type, rear port ID, rear port position, label, color, and description.

Output

JSON

  • id - ID of the updated front port template record.
  • name - Name of the updated front port template.
  • device_type - Device type ID associated with the front port template.
  • module_type - Module type ID associated with the front port template.
  • type - Physical type of the port connector.
  • rear_port - ID of the associated rear port template.
  • rear_port_position - Position of the port on the rear port.
  • label - Physical label of the port.
  • color - Color of the port as a hex string.
  • description - Description of the front port template.

Dependencies

  • NetBox API
  • API authentication token or API key credential

Troubleshooting

  • Ensure the Front Port Template ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API authentication credentials are valid and have sufficient permissions to update front port templates.
  • Check that the update fields are correctly formatted and valid according to NetBox API specifications.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

Discussion