Overview

This node interacts with the NetBox API to create a new Rear Port resource within the DCIM domain. It is useful for network administrators and engineers who want to automate the management and configuration of rear ports on network devices in their infrastructure. For example, it can be used to add a rear port to a device with specific attributes such as name, type, number of positions, and additional optional fields like module ID, label, color, and description.

Use Case Examples

1. Creating a rear port named 'Port1' of type '8P8C' on a device with ID 123, specifying the number of positions and optionally adding a label and description.
2. Automating the addition of rear ports to multiple devices in a data center using workflow automation.

Properties

Output

JSON

• id - Unique identifier of the created rear port.
• name - Name of the created rear port.
• type - Type of the created rear port.
• positions - Number of positions of the created rear port.
• device_id - Identifier of the device to which the rear port belongs.
• module - Module ID associated with the rear port, if provided.
• label - Label of the rear port, if provided.
• color - Color of the rear port in hex, if provided.
• mark_connected - Boolean indicating if the rear port is marked as connected.
• description - Description of the rear port, if provided.
• tags - Tags associated with the rear port.
• custom_fields - Custom fields in JSON format associated with the rear port.

Dependencies

• NetBox API
• API key credential for authentication

Troubleshooting

• Ensure the Device ID provided exists in the NetBox instance to avoid 'not found' errors.
• Validate that the rear port type is one of the supported types to prevent validation errors.
• Check that the number of positions is within the allowed range (1-1024).
• If using custom fields, ensure the JSON format is correct to avoid parsing errors.
• Common error messages include authentication failures due to invalid API keys, resource not found errors if the device ID is incorrect, and validation errors for missing or incorrect required fields.

Links

• NetBox API Documentation - Rear Ports - Official NetBox API documentation for managing rear ports.