NetBox icon

NetBox

Consume NetBox API

Actions243

Front Port Template → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Front Port Template within the DCIM domain. It is useful for network administrators and engineers who want to automate the creation of front port templates in their network infrastructure management system. For example, it can be used to define physical port connectors for devices, specifying details such as the port type, associated rear port template, and additional metadata like device type or color.

Use Case Examples

  1. Creating a front port template for a new device type with specific connector type and rear port association.
  2. Automating the setup of front port templates during device provisioning workflows.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
Name The name of the front port template to create.
Type The physical type of the port connector, such as LC, SC, or 8P8C.
Rear Port ID The ID of the associated rear port template to link with this front port template.
Additional Fields Optional additional metadata fields such as device type ID, module type ID, rear port position, label, color, and description.

Output

JSON

  • id - The unique identifier of the created front port template.
  • name - The name of the created front port template.
  • type - The physical connector type of the created front port template.
  • rear_port_id - The ID of the associated rear port template linked to the created front port template.
  • device_type - Optional device type ID associated with the front port template.
  • module_type - Optional module type ID associated with the front port template.
  • rear_port_position - The position of the port on the rear port.
  • label - Physical label of the port.
  • color - Port color as a hex string.
  • description - Description of the front port template.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Rear Port ID provided exists and is valid in NetBox to avoid reference errors.
  • Verify that either Device Type ID or Module Type ID is provided if required by your NetBox configuration.
  • Check API credentials and network connectivity to NetBox to prevent authentication or connection errors.
  • If the node throws validation errors, confirm that all required fields are correctly filled and conform to expected formats.

Links

Discussion