NetBox icon

NetBox

Consume NetBox API

Actions243

Front Port → List

AI-generated

Overview

This node interacts with the NetBox API to list front ports within the DCIM domain. It allows users to retrieve a list of front ports with optional filtering and pagination controls. This is useful for network administrators or IT professionals who want to query and manage front port data from their NetBox instance programmatically.

Use Case Examples

  1. Retrieve all front ports from the NetBox DCIM domain.
  2. List front ports filtered by device ID or port type.
  3. Limit the number of front ports returned to a specific count for pagination.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
Return All Boolean flag to determine whether to return all results or limit the number of results.
Limit Maximum number of front port results to return when 'Return All' is false.
Filters Collection of optional filters to narrow down the list of front ports based on various attributes such as ID, device ID, name, type, color, creation date, and more.

Output

JSON

  • id - Unique identifier of the front port
  • name - Name of the front port
  • label - Label of the front port
  • type - Type of the front port (e.g., 8P8C, LC, MPO)
  • device_id - Identifier of the device associated with the front port
  • module_id - Identifier of the module associated with the front port
  • color - Color code of the front port
  • rear_port_id - Identifier of the rear port connected to this front port
  • rear_port_position - Position of the rear port
  • mark_connected - Boolean flag indicating if the port is marked as connected
  • created - Timestamp when the front port was created
  • last_updated - Timestamp when the front port was last updated

Dependencies

  • NetBox API
  • API authentication token or key

Troubleshooting

  • Common issues include incorrect API credentials, network connectivity problems, or invalid filter parameters.
  • Error messages may indicate authentication failures, permission issues, or invalid query parameters. Verify API credentials and filter values.
  • If 'Return All' is set to false and the limit is too low, the user might not see all expected results. Adjust the limit or enable 'Return All'.

Links

Discussion