NetBox icon

NetBox

Consume NetBox API

Actions243

Console Server Port Template → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Console Server Port Template within the DCIM domain. It is useful for network administrators who want to automate the creation of console server port templates in their NetBox instance, facilitating standardized device management and configuration.

Use Case Examples

  1. Creating a console server port template named 'Template A' with a specific device type ID and label to standardize console port configurations across devices.
  2. Automating the addition of console server port templates with different physical port types (e.g., DE-9, RJ-45) to streamline network device setup.

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 console server port template to be created.
Additional Fields Optional additional fields to specify details about the console server port template such as device type ID, module type ID, physical label, port connector type, and description.

Output

JSON

  • id - Unique identifier of the created console server port template.
  • name - Name of the created console server port template.
  • device_type - Device type ID associated with the template, if specified.
  • module_type - Module type ID associated with the template, if specified.
  • label - Physical label of the port, if provided.
  • type - Physical type of the port connector.
  • description - Description of the console server port template.

Dependencies

  • NetBox API with appropriate credentials for authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have permissions to create console server port templates in the NetBox instance.
  • Verify that either device type ID or module type ID is provided as required; missing these may cause the API to reject the request.
  • Check that the domain is set to 'dcim' since console server port templates belong to this domain.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

Discussion