NetBox icon

NetBox

Consume NetBox API

Actions243

Power Outlet Template → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Power Outlet Template within the DCIM domain. It is useful for network and data center administrators who want to automate the creation of power outlet templates for device types in their infrastructure management system. For example, it can be used to define power outlet templates with specific types, labels, and associations to device types or module types in NetBox.

Use Case Examples

  1. Creating a power outlet template for a new device type with a specific outlet type and label.
  2. Automating the addition of power outlet templates to device types during device provisioning 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.
Device Type ID ID of the device type to which the power outlet template will be associated. Required if not using module type.
Name Name of the power outlet template to be created.
Additional Fields Optional additional fields for the power outlet template such as module type ID, label, outlet type, feed leg, and associated power port ID.

Output

JSON

  • id - Unique identifier of the created power outlet template.
  • name - Name of the created power outlet template.
  • device_type_id - ID of the device type associated with the power outlet template.
  • module_type - ID of the module type if used instead of device type.
  • label - Physical label of the power outlet template.
  • type - Type of the power outlet.
  • feed_leg - Feed leg designation for three-phase power.
  • power_port - ID of the associated power port template.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Device Type ID or Module Type ID is provided as required; missing these will cause errors.
  • Verify that the API credentials are correct and have permissions to create power outlet templates.
  • Check that the 'Domain' is set to 'dcim' since power outlet templates belong to this domain.
  • Common error messages may include authentication failures, missing required fields, or invalid field values. Resolving these involves verifying credentials, input data, and API endpoint configurations.

Links

Discussion