NetBox icon

NetBox

Consume NetBox API

Actions243

Rear Port → Update

AI-generated

Overview

This node interacts with the NetBox API to update a Rear Port resource within the DCIM domain. It allows users to modify various attributes of a Rear Port, such as device ID, name, type, positions, module ID, label, color, connection status, description, tags, and custom fields. This is useful in network infrastructure management scenarios where maintaining accurate and up-to-date port information is critical, for example, when reconfiguring hardware or documenting changes in a data center.

Use Case Examples

  1. Updating the name and type of a Rear Port on a specific device to reflect hardware changes.
  2. Changing the color and label of a Rear Port for better visual identification in the NetBox interface.
  3. Adding custom fields or tags to a Rear Port to include additional metadata for asset management.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
ID (rearPortId) The unique identifier of the Rear Port to update.
Update Fields A collection of fields that can be updated on the Rear Port, including device ID, name, type, positions, module ID, label, color, mark connected status, description, tags, and custom fields.

Output

JSON

  • id - The unique identifier of the updated Rear Port record.
  • device - The device ID associated with the Rear Port.
  • name - The name of the Rear Port.
  • type - The type of the Rear Port connector.
  • positions - The number of positions on the Rear Port.
  • module - The module ID associated with the Rear Port.
  • label - The label of the Rear Port.
  • color - The color code of the Rear Port in hexadecimal.
  • mark_connected - Indicates if the Rear Port is marked as connected.
  • description - Description of the Rear Port.
  • tags - Tags associated with the Rear Port.
  • custom_fields - Custom fields containing additional metadata in JSON format.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Rear Port ID provided is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential has sufficient permissions to update Rear Port resources.
  • Check the format of custom fields JSON to avoid parsing errors.
  • If the update fails, review the error message returned by the NetBox API for specific validation issues.

Links

Discussion