Overview

This node updates an existing Interface Template in the NetBox API under the DCIM domain. It is useful for network administrators who need to modify interface template details such as name, device type, module type, interface type, label, management status, and description. For example, updating the interface type or adding a description to an interface template for better documentation and management.

Use Case Examples

1. Update the name and description of an interface template to reflect new hardware changes.
2. Change the interface type of a template to match updated network standards.

Properties

Output

JSON

• id - ID of the updated interface template record.
• name - Name of the updated interface template.
• device_type - Device type ID associated with the interface template.
• module_type - Module type ID associated with the interface template.
• type - Interface type after update.
• label - Physical label of the interface.
• mgmt_only - Indicates if the interface is for management only.
• description - Description of the interface template.

Dependencies

• NetBox API
• API key credential for authentication

Troubleshooting

• Ensure the Interface Template ID is correct and exists in the NetBox instance.
• Verify that the API key credential has sufficient permissions to update interface templates.
• Check that the domain is set to 'dcim' as interface templates belong to this domain.
• If the update fields are empty or invalid, the API may reject the request.

Links

• NetBox API Documentation for Interface Templates - Official documentation for managing interface templates via the NetBox API.