1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getPowerPortTemplate
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger

netbox.getPowerPortTemplate

netbox
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger

    A power port template of a device type or module type (dcim.powerporttemplate).

    From the official documentation:

    A template for a power port that will be created on all instantiations of the parent device type. See the power port documentation for more detail.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getPowerPortTemplate({
        name: "test-power_port_template",
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_power_port_template(name="test-power_port_template")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v6/netbox"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := netbox.LookupPowerPortTemplate(ctx, &netbox.LookupPowerPortTemplateArgs{
    			Name: pulumi.StringRef("test-power_port_template"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Netbox = Pulumi.Netbox;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Netbox.GetPowerPortTemplate.Invoke(new()
        {
            Name = "test-power_port_template",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.netbox.NetboxFunctions;
    import com.pulumi.netbox.inputs.GetPowerPortTemplateArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = NetboxFunctions.getPowerPortTemplate(GetPowerPortTemplateArgs.builder()
                .name("test-power_port_template")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getPowerPortTemplate
          arguments:
            name: test-power_port_template
    
    Example coming soon!
    

    Using getPowerPortTemplate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPowerPortTemplate(args: GetPowerPortTemplateArgs, opts?: InvokeOptions): Promise<GetPowerPortTemplateResult>
    function getPowerPortTemplateOutput(args: GetPowerPortTemplateOutputArgs, opts?: InvokeOutputOptions): Output<GetPowerPortTemplateResult>
    def get_power_port_template(id: Optional[float] = None,
                                module_type_id: Optional[float] = None,
                                name: Optional[str] = None,
                                type: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetPowerPortTemplateResult
    def get_power_port_template_output(id: pulumi.Input[Optional[float]] = None,
                                module_type_id: pulumi.Input[Optional[float]] = None,
                                name: pulumi.Input[Optional[str]] = None,
                                type: pulumi.Input[Optional[str]] = None,
                                opts: Optional[InvokeOutputOptions] = None) -> Output[GetPowerPortTemplateResult]
    func LookupPowerPortTemplate(ctx *Context, args *LookupPowerPortTemplateArgs, opts ...InvokeOption) (*LookupPowerPortTemplateResult, error)
    func LookupPowerPortTemplateOutput(ctx *Context, args *LookupPowerPortTemplateOutputArgs, opts ...InvokeOption) LookupPowerPortTemplateResultOutput

    > Note: This function is named LookupPowerPortTemplate in the Go SDK.

    public static class GetPowerPortTemplate 
    {
        public static Task<GetPowerPortTemplateResult> InvokeAsync(GetPowerPortTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetPowerPortTemplateResult> Invoke(GetPowerPortTemplateInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetPowerPortTemplateResult> Invoke(GetPowerPortTemplateInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetPowerPortTemplateResult> getPowerPortTemplate(GetPowerPortTemplateArgs args, InvokeOptions options)
    public static Output<GetPowerPortTemplateResult> getPowerPortTemplate(GetPowerPortTemplateArgs args, InvokeOptions options)
    public static Output<GetPowerPortTemplateResult> getPowerPortTemplate(GetPowerPortTemplateArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getPowerPortTemplate:getPowerPortTemplate
      arguments:
        # arguments dictionary
    data "netbox_get_power_port_template" "name" {
        # arguments
    }

    The following arguments are supported:

    Id double
    NetBox id.
    ModuleTypeId double
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    Name string
    Type string
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    Id float64
    NetBox id.
    ModuleTypeId float64
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    Name string
    Type string
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    id number
    NetBox id.
    module_type_id number
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name string
    type string
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    id Double
    NetBox id.
    moduleTypeId Double
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name String
    type String
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    id number
    NetBox id.
    moduleTypeId number
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name string
    type string
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    id float
    NetBox id.
    module_type_id float
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name str
    type str
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    id Number
    NetBox id.
    moduleTypeId Number
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name String
    type String
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).

    getPowerPortTemplate Result

    The following output properties are available:

    AllocatedDraw double
    Allocated power draw in watts. Must be a whole number.
    Created string
    Description string
    DeviceTypeId double
    Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    Id double
    NetBox id.
    Label string
    Physical label.
    LastUpdated string
    MaximumDraw double
    Maximum power draw in watts. Must be a whole number.
    ModuleTypeId double
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    Name string
    Type string
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    Url string
    AllocatedDraw float64
    Allocated power draw in watts. Must be a whole number.
    Created string
    Description string
    DeviceTypeId float64
    Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    Id float64
    NetBox id.
    Label string
    Physical label.
    LastUpdated string
    MaximumDraw float64
    Maximum power draw in watts. Must be a whole number.
    ModuleTypeId float64
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    Name string
    Type string
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    Url string
    allocated_draw number
    Allocated power draw in watts. Must be a whole number.
    created string
    description string
    device_type_id number
    Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    id number
    NetBox id.
    label string
    Physical label.
    last_updated string
    maximum_draw number
    Maximum power draw in watts. Must be a whole number.
    module_type_id number
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name string
    type string
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    url string
    allocatedDraw Double
    Allocated power draw in watts. Must be a whole number.
    created String
    description String
    deviceTypeId Double
    Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    id Double
    NetBox id.
    label String
    Physical label.
    lastUpdated String
    maximumDraw Double
    Maximum power draw in watts. Must be a whole number.
    moduleTypeId Double
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name String
    type String
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    url String
    allocatedDraw number
    Allocated power draw in watts. Must be a whole number.
    created string
    description string
    deviceTypeId number
    Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    id number
    NetBox id.
    label string
    Physical label.
    lastUpdated string
    maximumDraw number
    Maximum power draw in watts. Must be a whole number.
    moduleTypeId number
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name string
    type string
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    url string
    allocated_draw float
    Allocated power draw in watts. Must be a whole number.
    created str
    description str
    device_type_id float
    Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    id float
    NetBox id.
    label str
    Physical label.
    last_updated str
    maximum_draw float
    Maximum power draw in watts. Must be a whole number.
    module_type_id float
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name str
    type str
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    url str
    allocatedDraw Number
    Allocated power draw in watts. Must be a whole number.
    created String
    description String
    deviceTypeId Number
    Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    id Number
    NetBox id.
    label String
    Physical label.
    lastUpdated String
    maximumDraw Number
    Maximum power draw in watts. Must be a whole number.
    moduleTypeId Number
    Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
    name String
    type String
    Port type as its NetBox slug, e.g. iec-60320-c14, nema-5-15p, cs8365c (any of NetBox's power port type choices).
    url String

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox
    Viewing docs for netbox 6.0.0
    published on Wednesday, Nov 4, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial