Overview

This node interacts with the NetBox API to update platform records within the DCIM domain. It allows users to modify details of a specific platform by providing the platform's ID and the fields to update, such as name, slug, manufacturer ID, NAPALM driver details, description, tags, and custom fields. This is useful for automating updates to platform information in network infrastructure management workflows.

Use Case Examples

1. Updating the name and description of a platform by specifying its ID and new values.
2. Modifying the NAPALM driver and arguments for a platform to change how devices are managed.
3. Adding or updating tags and custom fields for better categorization and metadata management of platforms.

Properties

Output

JSON

• id - The unique identifier of the updated platform.
• name - The updated name of the platform.
• slug - The updated URL-friendly slug of the platform.
• manufacturer - The updated manufacturer ID associated with the platform.
• napalm_driver - The updated NAPALM driver name.
• napalm_args - The updated additional arguments for the NAPALM driver in JSON format.
• description - The updated description of the platform.
• tags - The updated tags associated with the platform.
• custom_fields - The updated custom fields in JSON format.

Dependencies

• NetBox API
• An API key credential for authentication

Troubleshooting

• Ensure the Platform ID provided is correct and exists in the NetBox instance to avoid 'not found' errors.
• Verify that the API key credential is valid and has sufficient permissions to update platform records.
• Check the JSON format of NAPALM arguments and custom fields to avoid parsing errors.
• If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

• NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and data structures.