Overview

This node updates a Console Port resource in the NetBox API under the DCIM domain. It is useful for network administrators who need to modify details of console ports on network devices, such as changing the port's name, device association, module, label, type, speed, connection status, description, tags, or custom fields. For example, updating the speed or label of a console port to reflect physical changes or administrative updates.

Use Case Examples

1. Updating the speed of a console port to 115200 bps.
2. Changing the label of a console port to 'Main Console Port'.
3. Marking a console port as connected to indicate an active cable connection.

Properties

Output

JSON

• id - ID of the updated console port record.
• name - Name of the console port after update.
• device - Device ID associated with the console port.
• module - Module ID associated with the console port.
• label - Physical label of the port.
• type - Physical type of the port connector.
• speed - Port speed (baud rate).
• mark_connected - Indicates if the port is treated as connected.
• description - Description of the console port.
• tags - Tags associated with the console port.
• custom_fields - Custom fields data as JSON.

Dependencies

• NetBox API with appropriate credentials

Troubleshooting

• Common issues include providing an invalid Console Port ID, which results in a not found error from the API.
• Incorrect or missing authentication credentials can cause authorization errors.
• Invalid field values in the update collection may cause validation errors from the API.
• Network connectivity issues to the NetBox API endpoint can cause request failures.

Links

• NetBox API Documentation for Console Ports - Official documentation for managing console ports via the NetBox API.