Overview

This node interacts with the NetBox API to update a Console Server Port resource within the DCIM domain. It allows users to modify various attributes of a console server port, such as its name, device ID, module ID, label, type, speed, connection status, description, tags, and custom fields. This is useful in scenarios where network infrastructure details need to be programmatically updated or maintained, for example, updating port configurations after hardware changes or documenting physical port details.

Use Case Examples

1. Updating the label and speed of a console server port after a hardware upgrade.
2. Changing the device association of a console server port when it is moved to a different device.
3. Adding tags or custom fields to a console server port for better categorization and management.

Properties

Output

JSON

• id - ID of the updated console server port
• name - Name of the console server port
• device - Device ID associated with the port
• module - Module ID associated with the port
• label - Physical label of the port
• type - Type of the port connector
• speed - Port speed (baud rate)
• 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 associated with the port

Dependencies

• NetBox API
• API authentication token or API key credential

Troubleshooting

• Common issues include invalid Console Server Port ID, insufficient permissions, or incorrect API credentials.
• Error messages may indicate network connectivity problems, invalid input data, or API rate limits.
• Ensure the Console Server Port ID exists and the API credentials have the necessary permissions to update the resource.
• Verify that the update fields are correctly formatted and valid according to NetBox API specifications.

Links

• NetBox API Documentation - Console Server Ports - Official documentation for the Console Server Ports resource in the NetBox API.