NetBox icon

NetBox

Consume NetBox API

Actions243

Rear Port Template → Get Many

AI-generated

Overview

This node interacts with the NetBox API to retrieve multiple Rear Port Template records within the DCIM domain. It is useful for users who want to fetch a list of rear port templates with optional filtering, limiting, and pagination controls. For example, a network administrator can use this node to get all rear port templates or a subset based on specific criteria such as device type ID or name.

Use Case Examples

  1. Retrieve all rear port templates without limit.
  2. Retrieve up to 50 rear port templates filtered by device type ID.
  3. Fetch rear port templates with a search query to find specific templates by name.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, 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 results to return when 'Return All' is false.
Filters Collection of optional filters to narrow down the list of rear port templates, such as device type ID, module type ID, name, type, positions, search query, ID, and ordering.

Output

JSON

  • id - Unique identifier of the rear port template.
  • name - Name of the rear port template.
  • type - Type of the rear port template.
  • positions - Number of positions in the rear port template.
  • device_type_id - Identifier of the device type associated with the rear port template.
  • module_type_id - Identifier of the module type associated with the rear port template.
  • additional_properties - Other properties returned by the NetBox API for each rear port template.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has sufficient permissions to access the DCIM domain and rear port templates resource.
  • If the node returns an error, check the network connectivity to the NetBox API endpoint.
  • Verify that the filter parameters are correctly formatted and valid according to the NetBox API documentation.
  • Common error messages may include authentication failures, resource not found, or invalid query parameters. Resolving these typically involves checking credentials, resource names, and filter values.

Links

Discussion