NetBox icon

NetBox

Consume NetBox API

Actions243

Rear Port Template → Update

AI-generated

Overview

This node updates a Rear Port Template resource in the NetBox API under the DCIM domain. It is useful for modifying existing rear port templates by specifying the template ID and the fields to update, such as device type ID, module type ID, name, type, positions, label, color, and description. This operation is beneficial in network infrastructure management where rear port templates need to be maintained or adjusted programmatically.

Use Case Examples

  1. Updating the name and description of a specific rear port template by providing its ID and new values.
  2. Changing the type and color of a rear port template to reflect hardware changes.

Properties

Name Meaning
Domain The domain of the NetBox API to interact with, here it is 'dcim' for data center infrastructure management.
ID The unique identifier of the rear port template to update.
Update Fields The fields of the rear port template to update, including device type ID, module type ID, name, type, positions, label, color, and description.

Output

JSON

  • id - ID of the updated rear port template record.
  • name - Name of the updated rear port template.
  • type - Type of the updated rear port template.
  • description - Description of the updated rear port template.
  • device_type - Device type ID associated with the updated rear port template.
  • module_type - Module type ID associated with the updated rear port template.
  • positions - Number of positions in the updated rear port template.
  • label - Label of the updated rear port template.
  • color - Color of the updated rear port template in hexadecimal format.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Common issues include providing an invalid or non-existent rear port template ID, which will result in an error from the NetBox API indicating the resource was not found.
  • Incorrect or missing API credentials can cause authentication errors.
  • Invalid field values, such as unsupported types or incorrect data formats, may cause the update operation to fail with validation errors.

Links

Discussion