NetBox icon

NetBox

Consume NetBox API

Actions243

Rear Port Template → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Rear Port Template within the DCIM domain. It is useful for network administrators or engineers who want to automate the creation of rear port templates for device types in their network infrastructure management system. For example, it can be used to define the physical rear port characteristics of a device type, such as the port type, number of positions, and additional descriptive fields.

Use Case Examples

  1. Creating a rear port template for a new device type with specific port type and positions.
  2. Automating the addition of rear port templates to multiple device types in bulk.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
Device Type ID The identifier of the device type to which the rear port template will be associated.
Name The name of the rear port template to be created.
Type The physical type of the rear port, such as 8P8C, LC, MPO, etc.
Positions Number of physical front ports mapped to this rear port, ranging from 1 to 1024.
Additional Fields Optional additional fields such as Module Type ID, Label, Color (Hex), and Description to provide more details about the rear port template.

Output

JSON

  • id - Unique identifier of the created rear port template.
  • name - Name of the created rear port template.
  • type - Type of the rear port template.
  • positions - Number of positions defined in the rear port template.
  • module_type - Module type ID associated with the rear port template, if provided.
  • label - Label of the rear port template, if provided.
  • color - Color code of the rear port template, if provided.
  • description - Description of the rear port template, if provided.

Dependencies

  • NetBox API
  • API key credential for authentication

Troubleshooting

  • Ensure the Device Type ID is valid and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential is correctly configured and has permissions to create rear port templates.
  • Check that the 'Positions' value is within the allowed range (1-1024).
  • If the node throws an error about missing required fields, verify that all mandatory properties (Name, Type, Device Type ID) are provided.

Links

Discussion