Overview

This node operation creates a new Console Server Port in the NetBox system under the DCIM domain. It is useful for network administrators or IT professionals who need to programmatically add console server ports to devices managed in NetBox, facilitating automated infrastructure management and inventory tracking.

Use Case Examples

1. Creating a console server port for a specific device by specifying its device ID and port name.
2. Adding additional details such as module ID, port label, type, speed, and description to the console server port during creation.

Properties

Output

JSON

• id - The unique identifier of the created console server port.
• name - The name of the created console server port.
• device_id - The ID of the device the port belongs to.
• module - The module ID if specified.
• label - The physical label of the port if specified.
• type - The physical type of the port connector.
• speed - The speed (baud rate) of the port.
• mark_connected - Indicates if the port is marked as connected.
• description - Description of the console server port.
• tags - Tags associated with the port.
• custom_fields - Custom fields metadata as JSON.

Dependencies

• NetBox API with appropriate credentials for authentication

Troubleshooting

• Ensure the device ID provided exists in NetBox; otherwise, the creation will fail.
• Verify that the API credentials have sufficient permissions to create console server ports.
• Check that required fields like 'Name' and 'Device ID' are provided and valid.
• If the node throws an error, enabling 'Continue on Fail' will output the error message as JSON instead of stopping execution.

Links

• NetBox API Documentation - Console Server Ports - Official NetBox API documentation for managing console server ports.