NetBox icon

NetBox

Consume NetBox API

Actions243

Virtual Device Context → Update

AI-generated

Overview

This node updates a Virtual Device Context resource in the NetBox API under the DCIM domain. It is useful for modifying existing virtual device context records by changing fields such as name, device ID, status, identifier, tenant ID, primary IP addresses, description, comments, tags, and custom fields. For example, it can be used to update the status of a virtual device context from 'planned' to 'active' or to assign a new primary IP address.

Use Case Examples

  1. Updating the name and status of a virtual device context to reflect new operational changes.
  2. Assigning a new tenant ID and adding descriptive comments to a virtual device context record.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is 'dcim' for Data Center Infrastructure Management.
Virtual Device Context ID The unique identifier of the virtual device context to update.
Update Fields Collection of fields to update on the virtual device context, including name, device ID, status, identifier, tenant ID, primary IP addresses, description, comments, tags, and custom fields.

Output

JSON

  • id - ID of the updated virtual device context record.
  • name - Name of the updated virtual device context.
  • status - Status of the updated virtual device context.
  • device - Device ID associated with the updated virtual device context.
  • identifier - Numeric identifier of the updated virtual device context.
  • tenant - Tenant ID associated with the updated virtual device context.
  • primary_ip4 - Primary IPv4 address ID of the updated virtual device context.
  • primary_ip6 - Primary IPv6 address ID of the updated virtual device context.
  • description - Description of the updated virtual device context.
  • comments - Comments about the updated virtual device context.
  • tags - Tags associated with the updated virtual device context.
  • custom_fields - Custom fields of the updated virtual device context.

Dependencies

  • NetBox API
  • API authentication token or API key credential

Troubleshooting

  • Ensure the Virtual Device Context ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API credentials are valid and have sufficient permissions to update virtual device contexts.
  • Check that the fields provided in 'Update Fields' conform to expected data types and constraints (e.g., numeric ranges for identifier).
  • If the node throws an error, enabling 'Continue on Fail' will output the error message as JSON instead of stopping execution.

Links

Discussion