NetBox icon

NetBox

Consume NetBox API

Actions243

Platform → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new platform within the DCIM domain. It is useful for automating the addition of platform entries in NetBox, which can represent device platforms or operating systems used in network infrastructure management.

Use Case Examples

  1. Automatically add a new platform to NetBox when onboarding new hardware.
  2. Create platforms with specific manufacturer and driver details for network automation workflows.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
Name The name of the platform to create.
Additional Fields Optional additional fields for the platform such as slug, manufacturer ID, NAPALM driver and arguments, description, tags, and custom fields.

Output

JSON

  • id - Unique identifier of the created platform.
  • name - Name of the created platform.
  • slug - URL-friendly slug of the platform.
  • manufacturer - Manufacturer ID associated with the platform.
  • napalm_driver - NAPALM driver name used for the platform.
  • napalm_args - Additional arguments passed to the NAPALM driver.
  • description - Description of the platform.
  • tags - Tags associated with the platform.
  • custom_fields - Custom fields defined for the platform.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has permissions to create platforms in the NetBox instance.
  • Verify that the domain is set to 'dcim' since platforms belong to this domain.
  • Check that required fields like 'Name' are provided when creating a platform.
  • Common errors include authentication failures, missing required fields, or invalid field values. Review error messages for specific details and adjust input accordingly.

Links

Discussion