1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getDeviceFrontPort
Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger

    A device front port (dcim.frontport): a pass-through port on the front of a patch panel or cassette, mapped position by position onto rear ports of the same device.

    From the official documentation:

    Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports. Each port is assigned a physical type, and must be mapped to a specific rear port on the same device. A single rear port may be mapped to multiple front ports, using numeric positions to annotate the specific alignment of each.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getDeviceFrontPort({
        name: "test-device_front_port",
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_device_front_port(name="test-device_front_port")
    
    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.LookupDeviceFrontPort(ctx, &netbox.LookupDeviceFrontPortArgs{
    			Name: pulumi.StringRef("test-device_front_port"),
    		}, 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.GetDeviceFrontPort.Invoke(new()
        {
            Name = "test-device_front_port",
        });
    
    });
    
    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.GetDeviceFrontPortArgs;
    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.getDeviceFrontPort(GetDeviceFrontPortArgs.builder()
                .name("test-device_front_port")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getDeviceFrontPort
          arguments:
            name: test-device_front_port
    
    Example coming soon!
    

    Using getDeviceFrontPort

    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 getDeviceFrontPort(args: GetDeviceFrontPortArgs, opts?: InvokeOptions): Promise<GetDeviceFrontPortResult>
    function getDeviceFrontPortOutput(args: GetDeviceFrontPortOutputArgs, opts?: InvokeOutputOptions): Output<GetDeviceFrontPortResult>
    def get_device_front_port(cable_connector: Optional[float] = None,
                              cable_end: Optional[str] = None,
                              cable_id: Optional[float] = None,
                              cabled: Optional[bool] = None,
                              color: Optional[str] = None,
                              created: Optional[str] = None,
                              custom_field_filters: Optional[Mapping[str, str]] = None,
                              description: Optional[str] = None,
                              device_id: Optional[float] = None,
                              device_name: Optional[str] = None,
                              device_role_id: Optional[float] = None,
                              device_role_slug: Optional[str] = None,
                              device_status: Optional[str] = None,
                              device_type_id: Optional[float] = None,
                              device_type_model: Optional[str] = None,
                              id: Optional[float] = None,
                              label: Optional[str] = None,
                              last_updated: Optional[str] = None,
                              location_id: Optional[float] = None,
                              location_slug: Optional[str] = None,
                              mark_connected: Optional[bool] = None,
                              module_id: Optional[float] = None,
                              name: Optional[str] = None,
                              occupied: Optional[bool] = None,
                              owner_group_id: Optional[float] = None,
                              owner_group_name: Optional[str] = None,
                              owner_id: Optional[float] = None,
                              owner_name: Optional[str] = None,
                              positions: Optional[float] = None,
                              q: Optional[str] = None,
                              rack_id: Optional[float] = None,
                              rack_name: Optional[str] = None,
                              rear_port_id: Optional[float] = None,
                              region_id: Optional[str] = None,
                              region_slug: Optional[str] = None,
                              site_group_id: Optional[str] = None,
                              site_group_slug: Optional[str] = None,
                              site_id: Optional[float] = None,
                              site_slug: Optional[str] = None,
                              tag_id: Optional[float] = None,
                              tag_slug: Optional[str] = None,
                              tenant_id: Optional[float] = None,
                              tenant_slug: Optional[str] = None,
                              type: Optional[str] = None,
                              virtual_chassis: Optional[str] = None,
                              virtual_chassis_id: Optional[float] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDeviceFrontPortResult
    def get_device_front_port_output(cable_connector: pulumi.Input[Optional[float]] = None,
                              cable_end: pulumi.Input[Optional[str]] = None,
                              cable_id: pulumi.Input[Optional[float]] = None,
                              cabled: pulumi.Input[Optional[bool]] = None,
                              color: pulumi.Input[Optional[str]] = None,
                              created: pulumi.Input[Optional[str]] = None,
                              custom_field_filters: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                              description: pulumi.Input[Optional[str]] = None,
                              device_id: pulumi.Input[Optional[float]] = None,
                              device_name: pulumi.Input[Optional[str]] = None,
                              device_role_id: pulumi.Input[Optional[float]] = None,
                              device_role_slug: pulumi.Input[Optional[str]] = None,
                              device_status: pulumi.Input[Optional[str]] = None,
                              device_type_id: pulumi.Input[Optional[float]] = None,
                              device_type_model: pulumi.Input[Optional[str]] = None,
                              id: pulumi.Input[Optional[float]] = None,
                              label: pulumi.Input[Optional[str]] = None,
                              last_updated: pulumi.Input[Optional[str]] = None,
                              location_id: pulumi.Input[Optional[float]] = None,
                              location_slug: pulumi.Input[Optional[str]] = None,
                              mark_connected: pulumi.Input[Optional[bool]] = None,
                              module_id: pulumi.Input[Optional[float]] = None,
                              name: pulumi.Input[Optional[str]] = None,
                              occupied: pulumi.Input[Optional[bool]] = None,
                              owner_group_id: pulumi.Input[Optional[float]] = None,
                              owner_group_name: pulumi.Input[Optional[str]] = None,
                              owner_id: pulumi.Input[Optional[float]] = None,
                              owner_name: pulumi.Input[Optional[str]] = None,
                              positions: pulumi.Input[Optional[float]] = None,
                              q: pulumi.Input[Optional[str]] = None,
                              rack_id: pulumi.Input[Optional[float]] = None,
                              rack_name: pulumi.Input[Optional[str]] = None,
                              rear_port_id: pulumi.Input[Optional[float]] = None,
                              region_id: pulumi.Input[Optional[str]] = None,
                              region_slug: pulumi.Input[Optional[str]] = None,
                              site_group_id: pulumi.Input[Optional[str]] = None,
                              site_group_slug: pulumi.Input[Optional[str]] = None,
                              site_id: pulumi.Input[Optional[float]] = None,
                              site_slug: pulumi.Input[Optional[str]] = None,
                              tag_id: pulumi.Input[Optional[float]] = None,
                              tag_slug: pulumi.Input[Optional[str]] = None,
                              tenant_id: pulumi.Input[Optional[float]] = None,
                              tenant_slug: pulumi.Input[Optional[str]] = None,
                              type: pulumi.Input[Optional[str]] = None,
                              virtual_chassis: pulumi.Input[Optional[str]] = None,
                              virtual_chassis_id: pulumi.Input[Optional[float]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetDeviceFrontPortResult]
    func LookupDeviceFrontPort(ctx *Context, args *LookupDeviceFrontPortArgs, opts ...InvokeOption) (*LookupDeviceFrontPortResult, error)
    func LookupDeviceFrontPortOutput(ctx *Context, args *LookupDeviceFrontPortOutputArgs, opts ...InvokeOption) LookupDeviceFrontPortResultOutput

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

    public static class GetDeviceFrontPort 
    {
        public static Task<GetDeviceFrontPortResult> InvokeAsync(GetDeviceFrontPortArgs args, InvokeOptions? opts = null)
        public static Output<GetDeviceFrontPortResult> Invoke(GetDeviceFrontPortInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetDeviceFrontPortResult> Invoke(GetDeviceFrontPortInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetDeviceFrontPortResult> getDeviceFrontPort(GetDeviceFrontPortArgs args, InvokeOptions options)
    public static Output<GetDeviceFrontPortResult> getDeviceFrontPort(GetDeviceFrontPortArgs args, InvokeOptions options)
    public static Output<GetDeviceFrontPortResult> getDeviceFrontPort(GetDeviceFrontPortArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getDeviceFrontPort:getDeviceFrontPort
      arguments:
        # arguments dictionary
    data "netbox_get_device_front_port" "name" {
        # arguments
    }

    The following arguments are supported:

    CableConnector double
    Cable connector to match.
    CableEnd string
    Cable end. One of: A, B.
    CableId double
    Id of the cable.
    Cabled bool
    Whether cabled is set.
    Color string
    Color to match.
    Created string
    CustomFieldFilters Dictionary<string, string>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    Description string
    DeviceId double
    Id of the device.
    DeviceName string
    Name of the device.
    DeviceRoleId double
    Id of the device role.
    DeviceRoleSlug string
    Slug of the device role.
    DeviceStatus string
    Device status to match.
    DeviceTypeId double
    Id of the device type.
    DeviceTypeModel string
    Model of the device type.
    Id double
    NetBox id.
    Label string
    Physical label.
    LastUpdated string
    LocationId double
    Id of the location.
    LocationSlug string
    Slug of the location.
    MarkConnected bool
    Treat as if a cable is connected.
    ModuleId double
    Id of the installed module this component belongs to.
    Name string
    Occupied bool
    Whether occupied is set.
    OwnerGroupId double
    Id of the owner group.
    OwnerGroupName string
    Name of the owner group.
    OwnerId double
    Id of the owner the object is assigned to.
    OwnerName string
    Name of the owner.
    Positions double
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    Q string
    Search term, matched against the fields NetBox searches for this object type.
    RackId double
    Id of the rack.
    RackName string
    Name of the rack.
    RearPortId double
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    RegionId string
    Id of the region.
    RegionSlug string
    Slug of the region.
    SiteGroupId string
    Id of the site group.
    SiteGroupSlug string
    Slug of the site group.
    SiteId double
    Id of the site.
    SiteSlug string
    Slug of the site.
    TagId double
    Id of a tag the object carries.
    TagSlug string
    Slug of a tag the object carries.
    TenantId double
    Id of the tenant.
    TenantSlug string
    Slug of the tenant.
    Type string
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    VirtualChassis string
    Virtual Chassis.
    VirtualChassisId double
    Id of the virtual chassis.
    CableConnector float64
    Cable connector to match.
    CableEnd string
    Cable end. One of: A, B.
    CableId float64
    Id of the cable.
    Cabled bool
    Whether cabled is set.
    Color string
    Color to match.
    Created string
    CustomFieldFilters map[string]string
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    Description string
    DeviceId float64
    Id of the device.
    DeviceName string
    Name of the device.
    DeviceRoleId float64
    Id of the device role.
    DeviceRoleSlug string
    Slug of the device role.
    DeviceStatus string
    Device status to match.
    DeviceTypeId float64
    Id of the device type.
    DeviceTypeModel string
    Model of the device type.
    Id float64
    NetBox id.
    Label string
    Physical label.
    LastUpdated string
    LocationId float64
    Id of the location.
    LocationSlug string
    Slug of the location.
    MarkConnected bool
    Treat as if a cable is connected.
    ModuleId float64
    Id of the installed module this component belongs to.
    Name string
    Occupied bool
    Whether occupied is set.
    OwnerGroupId float64
    Id of the owner group.
    OwnerGroupName string
    Name of the owner group.
    OwnerId float64
    Id of the owner the object is assigned to.
    OwnerName string
    Name of the owner.
    Positions float64
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    Q string
    Search term, matched against the fields NetBox searches for this object type.
    RackId float64
    Id of the rack.
    RackName string
    Name of the rack.
    RearPortId float64
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    RegionId string
    Id of the region.
    RegionSlug string
    Slug of the region.
    SiteGroupId string
    Id of the site group.
    SiteGroupSlug string
    Slug of the site group.
    SiteId float64
    Id of the site.
    SiteSlug string
    Slug of the site.
    TagId float64
    Id of a tag the object carries.
    TagSlug string
    Slug of a tag the object carries.
    TenantId float64
    Id of the tenant.
    TenantSlug string
    Slug of the tenant.
    Type string
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    VirtualChassis string
    Virtual Chassis.
    VirtualChassisId float64
    Id of the virtual chassis.
    cable_connector number
    Cable connector to match.
    cable_end string
    Cable end. One of: A, B.
    cable_id number
    Id of the cable.
    cabled bool
    Whether cabled is set.
    color string
    Color to match.
    created string
    custom_field_filters map(string)
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    description string
    device_id number
    Id of the device.
    device_name string
    Name of the device.
    device_role_id number
    Id of the device role.
    device_role_slug string
    Slug of the device role.
    device_status string
    Device status to match.
    device_type_id number
    Id of the device type.
    device_type_model string
    Model of the device type.
    id number
    NetBox id.
    label string
    Physical label.
    last_updated string
    location_id number
    Id of the location.
    location_slug string
    Slug of the location.
    mark_connected bool
    Treat as if a cable is connected.
    module_id number
    Id of the installed module this component belongs to.
    name string
    occupied bool
    Whether occupied is set.
    owner_group_id number
    Id of the owner group.
    owner_group_name string
    Name of the owner group.
    owner_id number
    Id of the owner the object is assigned to.
    owner_name string
    Name of the owner.
    positions number
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    q string
    Search term, matched against the fields NetBox searches for this object type.
    rack_id number
    Id of the rack.
    rack_name string
    Name of the rack.
    rear_port_id number
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    region_id string
    Id of the region.
    region_slug string
    Slug of the region.
    site_group_id string
    Id of the site group.
    site_group_slug string
    Slug of the site group.
    site_id number
    Id of the site.
    site_slug string
    Slug of the site.
    tag_id number
    Id of a tag the object carries.
    tag_slug string
    Slug of a tag the object carries.
    tenant_id number
    Id of the tenant.
    tenant_slug string
    Slug of the tenant.
    type string
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    virtual_chassis string
    Virtual Chassis.
    virtual_chassis_id number
    Id of the virtual chassis.
    cableConnector Double
    Cable connector to match.
    cableEnd String
    Cable end. One of: A, B.
    cableId Double
    Id of the cable.
    cabled Boolean
    Whether cabled is set.
    color String
    Color to match.
    created String
    customFieldFilters Map<String,String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    description String
    deviceId Double
    Id of the device.
    deviceName String
    Name of the device.
    deviceRoleId Double
    Id of the device role.
    deviceRoleSlug String
    Slug of the device role.
    deviceStatus String
    Device status to match.
    deviceTypeId Double
    Id of the device type.
    deviceTypeModel String
    Model of the device type.
    id Double
    NetBox id.
    label String
    Physical label.
    lastUpdated String
    locationId Double
    Id of the location.
    locationSlug String
    Slug of the location.
    markConnected Boolean
    Treat as if a cable is connected.
    moduleId Double
    Id of the installed module this component belongs to.
    name String
    occupied Boolean
    Whether occupied is set.
    ownerGroupId Double
    Id of the owner group.
    ownerGroupName String
    Name of the owner group.
    ownerId Double
    Id of the owner the object is assigned to.
    ownerName String
    Name of the owner.
    positions Double
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    q String
    Search term, matched against the fields NetBox searches for this object type.
    rackId Double
    Id of the rack.
    rackName String
    Name of the rack.
    rearPortId Double
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    regionId String
    Id of the region.
    regionSlug String
    Slug of the region.
    siteGroupId String
    Id of the site group.
    siteGroupSlug String
    Slug of the site group.
    siteId Double
    Id of the site.
    siteSlug String
    Slug of the site.
    tagId Double
    Id of a tag the object carries.
    tagSlug String
    Slug of a tag the object carries.
    tenantId Double
    Id of the tenant.
    tenantSlug String
    Slug of the tenant.
    type String
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    virtualChassis String
    Virtual Chassis.
    virtualChassisId Double
    Id of the virtual chassis.
    cableConnector number
    Cable connector to match.
    cableEnd string
    Cable end. One of: A, B.
    cableId number
    Id of the cable.
    cabled boolean
    Whether cabled is set.
    color string
    Color to match.
    created string
    customFieldFilters {[key: string]: string}
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    description string
    deviceId number
    Id of the device.
    deviceName string
    Name of the device.
    deviceRoleId number
    Id of the device role.
    deviceRoleSlug string
    Slug of the device role.
    deviceStatus string
    Device status to match.
    deviceTypeId number
    Id of the device type.
    deviceTypeModel string
    Model of the device type.
    id number
    NetBox id.
    label string
    Physical label.
    lastUpdated string
    locationId number
    Id of the location.
    locationSlug string
    Slug of the location.
    markConnected boolean
    Treat as if a cable is connected.
    moduleId number
    Id of the installed module this component belongs to.
    name string
    occupied boolean
    Whether occupied is set.
    ownerGroupId number
    Id of the owner group.
    ownerGroupName string
    Name of the owner group.
    ownerId number
    Id of the owner the object is assigned to.
    ownerName string
    Name of the owner.
    positions number
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    q string
    Search term, matched against the fields NetBox searches for this object type.
    rackId number
    Id of the rack.
    rackName string
    Name of the rack.
    rearPortId number
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    regionId string
    Id of the region.
    regionSlug string
    Slug of the region.
    siteGroupId string
    Id of the site group.
    siteGroupSlug string
    Slug of the site group.
    siteId number
    Id of the site.
    siteSlug string
    Slug of the site.
    tagId number
    Id of a tag the object carries.
    tagSlug string
    Slug of a tag the object carries.
    tenantId number
    Id of the tenant.
    tenantSlug string
    Slug of the tenant.
    type string
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    virtualChassis string
    Virtual Chassis.
    virtualChassisId number
    Id of the virtual chassis.
    cable_connector float
    Cable connector to match.
    cable_end str
    Cable end. One of: A, B.
    cable_id float
    Id of the cable.
    cabled bool
    Whether cabled is set.
    color str
    Color to match.
    created str
    custom_field_filters Mapping[str, str]
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    description str
    device_id float
    Id of the device.
    device_name str
    Name of the device.
    device_role_id float
    Id of the device role.
    device_role_slug str
    Slug of the device role.
    device_status str
    Device status to match.
    device_type_id float
    Id of the device type.
    device_type_model str
    Model of the device type.
    id float
    NetBox id.
    label str
    Physical label.
    last_updated str
    location_id float
    Id of the location.
    location_slug str
    Slug of the location.
    mark_connected bool
    Treat as if a cable is connected.
    module_id float
    Id of the installed module this component belongs to.
    name str
    occupied bool
    Whether occupied is set.
    owner_group_id float
    Id of the owner group.
    owner_group_name str
    Name of the owner group.
    owner_id float
    Id of the owner the object is assigned to.
    owner_name str
    Name of the owner.
    positions float
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    q str
    Search term, matched against the fields NetBox searches for this object type.
    rack_id float
    Id of the rack.
    rack_name str
    Name of the rack.
    rear_port_id float
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    region_id str
    Id of the region.
    region_slug str
    Slug of the region.
    site_group_id str
    Id of the site group.
    site_group_slug str
    Slug of the site group.
    site_id float
    Id of the site.
    site_slug str
    Slug of the site.
    tag_id float
    Id of a tag the object carries.
    tag_slug str
    Slug of a tag the object carries.
    tenant_id float
    Id of the tenant.
    tenant_slug str
    Slug of the tenant.
    type str
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    virtual_chassis str
    Virtual Chassis.
    virtual_chassis_id float
    Id of the virtual chassis.
    cableConnector Number
    Cable connector to match.
    cableEnd String
    Cable end. One of: A, B.
    cableId Number
    Id of the cable.
    cabled Boolean
    Whether cabled is set.
    color String
    Color to match.
    created String
    customFieldFilters Map<String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    description String
    deviceId Number
    Id of the device.
    deviceName String
    Name of the device.
    deviceRoleId Number
    Id of the device role.
    deviceRoleSlug String
    Slug of the device role.
    deviceStatus String
    Device status to match.
    deviceTypeId Number
    Id of the device type.
    deviceTypeModel String
    Model of the device type.
    id Number
    NetBox id.
    label String
    Physical label.
    lastUpdated String
    locationId Number
    Id of the location.
    locationSlug String
    Slug of the location.
    markConnected Boolean
    Treat as if a cable is connected.
    moduleId Number
    Id of the installed module this component belongs to.
    name String
    occupied Boolean
    Whether occupied is set.
    ownerGroupId Number
    Id of the owner group.
    ownerGroupName String
    Name of the owner group.
    ownerId Number
    Id of the owner the object is assigned to.
    ownerName String
    Name of the owner.
    positions Number
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    q String
    Search term, matched against the fields NetBox searches for this object type.
    rackId Number
    Id of the rack.
    rackName String
    Name of the rack.
    rearPortId Number
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    regionId String
    Id of the region.
    regionSlug String
    Slug of the region.
    siteGroupId String
    Id of the site group.
    siteGroupSlug String
    Slug of the site group.
    siteId Number
    Id of the site.
    siteSlug String
    Slug of the site.
    tagId Number
    Id of a tag the object carries.
    tagSlug String
    Slug of a tag the object carries.
    tenantId Number
    Id of the tenant.
    tenantSlug String
    Slug of the tenant.
    type String
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    virtualChassis String
    Virtual Chassis.
    virtualChassisId Number
    Id of the virtual chassis.

    getDeviceFrontPort Result

    The following output properties are available:

    ColorHex string
    RGB color in hex (e.g. ff0000).
    Created string
    CustomFields Dictionary<string, string>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    DeviceId double
    Id of the device.
    Id double
    NetBox id.
    Label string
    Physical label.
    LastUpdated string
    MarkConnected bool
    Treat as if a cable is connected.
    ModuleId double
    Id of the installed module this component belongs to.
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    Positions double
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    RearPortId double
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    RearPortPosition double
    Position on rearportid. Requires rearportid. Must be a whole number.
    RearPorts List<GetDeviceFrontPortRearPort>
    Mappings of the front port's positions onto rear ports of the same device, one object per position. Derived from rearportid and rearportposition when those are set; an empty set, or neither form, leaves the port unmapped. Changing the set recreates every mapping, since NetBox 4.6 rejects an update that resends an existing one.
    Tags List<string>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls List<string>
    Slugs of all tags on the object, including the provider's default_tags.
    Type string
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    Url string
    CableConnector double
    Cable connector to match.
    CableEnd string
    Cable end. One of: A, B.
    CableId double
    Id of the cable.
    Cabled bool
    Whether cabled is set.
    Color string
    Color to match.
    CustomFieldFilters Dictionary<string, string>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    DeviceName string
    Name of the device.
    DeviceRoleId double
    Id of the device role.
    DeviceRoleSlug string
    Slug of the device role.
    DeviceStatus string
    Device status to match.
    DeviceTypeId double
    Id of the device type.
    DeviceTypeModel string
    Model of the device type.
    LocationId double
    Id of the location.
    LocationSlug string
    Slug of the location.
    Occupied bool
    Whether occupied is set.
    OwnerGroupId double
    Id of the owner group.
    OwnerGroupName string
    Name of the owner group.
    OwnerName string
    Name of the owner.
    Q string
    Search term, matched against the fields NetBox searches for this object type.
    RackId double
    Id of the rack.
    RackName string
    Name of the rack.
    RegionId string
    Id of the region.
    RegionSlug string
    Slug of the region.
    SiteGroupId string
    Id of the site group.
    SiteGroupSlug string
    Slug of the site group.
    SiteId double
    Id of the site.
    SiteSlug string
    Slug of the site.
    TagId double
    Id of a tag the object carries.
    TagSlug string
    Slug of a tag the object carries.
    TenantId double
    Id of the tenant.
    TenantSlug string
    Slug of the tenant.
    VirtualChassis string
    Virtual Chassis.
    VirtualChassisId double
    Id of the virtual chassis.
    ColorHex string
    RGB color in hex (e.g. ff0000).
    Created string
    CustomFields map[string]string
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    DeviceId float64
    Id of the device.
    Id float64
    NetBox id.
    Label string
    Physical label.
    LastUpdated string
    MarkConnected bool
    Treat as if a cable is connected.
    ModuleId float64
    Id of the installed module this component belongs to.
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    Positions float64
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    RearPortId float64
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    RearPortPosition float64
    Position on rearportid. Requires rearportid. Must be a whole number.
    RearPorts []GetDeviceFrontPortRearPort
    Mappings of the front port's positions onto rear ports of the same device, one object per position. Derived from rearportid and rearportposition when those are set; an empty set, or neither form, leaves the port unmapped. Changing the set recreates every mapping, since NetBox 4.6 rejects an update that resends an existing one.
    Tags []string
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls []string
    Slugs of all tags on the object, including the provider's default_tags.
    Type string
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    Url string
    CableConnector float64
    Cable connector to match.
    CableEnd string
    Cable end. One of: A, B.
    CableId float64
    Id of the cable.
    Cabled bool
    Whether cabled is set.
    Color string
    Color to match.
    CustomFieldFilters map[string]string
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    DeviceName string
    Name of the device.
    DeviceRoleId float64
    Id of the device role.
    DeviceRoleSlug string
    Slug of the device role.
    DeviceStatus string
    Device status to match.
    DeviceTypeId float64
    Id of the device type.
    DeviceTypeModel string
    Model of the device type.
    LocationId float64
    Id of the location.
    LocationSlug string
    Slug of the location.
    Occupied bool
    Whether occupied is set.
    OwnerGroupId float64
    Id of the owner group.
    OwnerGroupName string
    Name of the owner group.
    OwnerName string
    Name of the owner.
    Q string
    Search term, matched against the fields NetBox searches for this object type.
    RackId float64
    Id of the rack.
    RackName string
    Name of the rack.
    RegionId string
    Id of the region.
    RegionSlug string
    Slug of the region.
    SiteGroupId string
    Id of the site group.
    SiteGroupSlug string
    Slug of the site group.
    SiteId float64
    Id of the site.
    SiteSlug string
    Slug of the site.
    TagId float64
    Id of a tag the object carries.
    TagSlug string
    Slug of a tag the object carries.
    TenantId float64
    Id of the tenant.
    TenantSlug string
    Slug of the tenant.
    VirtualChassis string
    Virtual Chassis.
    VirtualChassisId float64
    Id of the virtual chassis.
    color_hex string
    RGB color in hex (e.g. ff0000).
    created string
    custom_fields map(string)
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    device_id number
    Id of the device.
    id number
    NetBox id.
    label string
    Physical label.
    last_updated string
    mark_connected bool
    Treat as if a cable is connected.
    module_id number
    Id of the installed module this component belongs to.
    name string
    owner_id number
    Id of the owner the object is assigned to.
    positions number
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    rear_port_id number
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    rear_port_position number
    Position on rearportid. Requires rearportid. Must be a whole number.
    rear_ports list(object)
    Mappings of the front port's positions onto rear ports of the same device, one object per position. Derived from rearportid and rearportposition when those are set; an empty set, or neither form, leaves the port unmapped. Changing the set recreates every mapping, since NetBox 4.6 rejects an update that resends an existing one.
    tags list(string)
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls list(string)
    Slugs of all tags on the object, including the provider's default_tags.
    type string
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    url string
    cable_connector number
    Cable connector to match.
    cable_end string
    Cable end. One of: A, B.
    cable_id number
    Id of the cable.
    cabled bool
    Whether cabled is set.
    color string
    Color to match.
    custom_field_filters map(string)
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    device_name string
    Name of the device.
    device_role_id number
    Id of the device role.
    device_role_slug string
    Slug of the device role.
    device_status string
    Device status to match.
    device_type_id number
    Id of the device type.
    device_type_model string
    Model of the device type.
    location_id number
    Id of the location.
    location_slug string
    Slug of the location.
    occupied bool
    Whether occupied is set.
    owner_group_id number
    Id of the owner group.
    owner_group_name string
    Name of the owner group.
    owner_name string
    Name of the owner.
    q string
    Search term, matched against the fields NetBox searches for this object type.
    rack_id number
    Id of the rack.
    rack_name string
    Name of the rack.
    region_id string
    Id of the region.
    region_slug string
    Slug of the region.
    site_group_id string
    Id of the site group.
    site_group_slug string
    Slug of the site group.
    site_id number
    Id of the site.
    site_slug string
    Slug of the site.
    tag_id number
    Id of a tag the object carries.
    tag_slug string
    Slug of a tag the object carries.
    tenant_id number
    Id of the tenant.
    tenant_slug string
    Slug of the tenant.
    virtual_chassis string
    Virtual Chassis.
    virtual_chassis_id number
    Id of the virtual chassis.
    colorHex String
    RGB color in hex (e.g. ff0000).
    created String
    customFields Map<String,String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    deviceId Double
    Id of the device.
    id Double
    NetBox id.
    label String
    Physical label.
    lastUpdated String
    markConnected Boolean
    Treat as if a cable is connected.
    moduleId Double
    Id of the installed module this component belongs to.
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    positions Double
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    rearPortId Double
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    rearPortPosition Double
    Position on rearportid. Requires rearportid. Must be a whole number.
    rearPorts List<GetDeviceFrontPortRearPort>
    Mappings of the front port's positions onto rear ports of the same device, one object per position. Derived from rearportid and rearportposition when those are set; an empty set, or neither form, leaves the port unmapped. Changing the set recreates every mapping, since NetBox 4.6 rejects an update that resends an existing one.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    type String
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    url String
    cableConnector Double
    Cable connector to match.
    cableEnd String
    Cable end. One of: A, B.
    cableId Double
    Id of the cable.
    cabled Boolean
    Whether cabled is set.
    color String
    Color to match.
    customFieldFilters Map<String,String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    deviceName String
    Name of the device.
    deviceRoleId Double
    Id of the device role.
    deviceRoleSlug String
    Slug of the device role.
    deviceStatus String
    Device status to match.
    deviceTypeId Double
    Id of the device type.
    deviceTypeModel String
    Model of the device type.
    locationId Double
    Id of the location.
    locationSlug String
    Slug of the location.
    occupied Boolean
    Whether occupied is set.
    ownerGroupId Double
    Id of the owner group.
    ownerGroupName String
    Name of the owner group.
    ownerName String
    Name of the owner.
    q String
    Search term, matched against the fields NetBox searches for this object type.
    rackId Double
    Id of the rack.
    rackName String
    Name of the rack.
    regionId String
    Id of the region.
    regionSlug String
    Slug of the region.
    siteGroupId String
    Id of the site group.
    siteGroupSlug String
    Slug of the site group.
    siteId Double
    Id of the site.
    siteSlug String
    Slug of the site.
    tagId Double
    Id of a tag the object carries.
    tagSlug String
    Slug of a tag the object carries.
    tenantId Double
    Id of the tenant.
    tenantSlug String
    Slug of the tenant.
    virtualChassis String
    Virtual Chassis.
    virtualChassisId Double
    Id of the virtual chassis.
    colorHex string
    RGB color in hex (e.g. ff0000).
    created string
    customFields {[key: string]: string}
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    deviceId number
    Id of the device.
    id number
    NetBox id.
    label string
    Physical label.
    lastUpdated string
    markConnected boolean
    Treat as if a cable is connected.
    moduleId number
    Id of the installed module this component belongs to.
    name string
    ownerId number
    Id of the owner the object is assigned to.
    positions number
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    rearPortId number
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    rearPortPosition number
    Position on rearportid. Requires rearportid. Must be a whole number.
    rearPorts GetDeviceFrontPortRearPort[]
    Mappings of the front port's positions onto rear ports of the same device, one object per position. Derived from rearportid and rearportposition when those are set; an empty set, or neither form, leaves the port unmapped. Changing the set recreates every mapping, since NetBox 4.6 rejects an update that resends an existing one.
    tags string[]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls string[]
    Slugs of all tags on the object, including the provider's default_tags.
    type string
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    url string
    cableConnector number
    Cable connector to match.
    cableEnd string
    Cable end. One of: A, B.
    cableId number
    Id of the cable.
    cabled boolean
    Whether cabled is set.
    color string
    Color to match.
    customFieldFilters {[key: string]: string}
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    deviceName string
    Name of the device.
    deviceRoleId number
    Id of the device role.
    deviceRoleSlug string
    Slug of the device role.
    deviceStatus string
    Device status to match.
    deviceTypeId number
    Id of the device type.
    deviceTypeModel string
    Model of the device type.
    locationId number
    Id of the location.
    locationSlug string
    Slug of the location.
    occupied boolean
    Whether occupied is set.
    ownerGroupId number
    Id of the owner group.
    ownerGroupName string
    Name of the owner group.
    ownerName string
    Name of the owner.
    q string
    Search term, matched against the fields NetBox searches for this object type.
    rackId number
    Id of the rack.
    rackName string
    Name of the rack.
    regionId string
    Id of the region.
    regionSlug string
    Slug of the region.
    siteGroupId string
    Id of the site group.
    siteGroupSlug string
    Slug of the site group.
    siteId number
    Id of the site.
    siteSlug string
    Slug of the site.
    tagId number
    Id of a tag the object carries.
    tagSlug string
    Slug of a tag the object carries.
    tenantId number
    Id of the tenant.
    tenantSlug string
    Slug of the tenant.
    virtualChassis string
    Virtual Chassis.
    virtualChassisId number
    Id of the virtual chassis.
    color_hex str
    RGB color in hex (e.g. ff0000).
    created str
    custom_fields Mapping[str, str]
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description str
    device_id float
    Id of the device.
    id float
    NetBox id.
    label str
    Physical label.
    last_updated str
    mark_connected bool
    Treat as if a cable is connected.
    module_id float
    Id of the installed module this component belongs to.
    name str
    owner_id float
    Id of the owner the object is assigned to.
    positions float
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    rear_port_id float
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    rear_port_position float
    Position on rearportid. Requires rearportid. Must be a whole number.
    rear_ports Sequence[GetDeviceFrontPortRearPort]
    Mappings of the front port's positions onto rear ports of the same device, one object per position. Derived from rearportid and rearportposition when those are set; an empty set, or neither form, leaves the port unmapped. Changing the set recreates every mapping, since NetBox 4.6 rejects an update that resends an existing one.
    tags Sequence[str]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls Sequence[str]
    Slugs of all tags on the object, including the provider's default_tags.
    type str
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    url str
    cable_connector float
    Cable connector to match.
    cable_end str
    Cable end. One of: A, B.
    cable_id float
    Id of the cable.
    cabled bool
    Whether cabled is set.
    color str
    Color to match.
    custom_field_filters Mapping[str, str]
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    device_name str
    Name of the device.
    device_role_id float
    Id of the device role.
    device_role_slug str
    Slug of the device role.
    device_status str
    Device status to match.
    device_type_id float
    Id of the device type.
    device_type_model str
    Model of the device type.
    location_id float
    Id of the location.
    location_slug str
    Slug of the location.
    occupied bool
    Whether occupied is set.
    owner_group_id float
    Id of the owner group.
    owner_group_name str
    Name of the owner group.
    owner_name str
    Name of the owner.
    q str
    Search term, matched against the fields NetBox searches for this object type.
    rack_id float
    Id of the rack.
    rack_name str
    Name of the rack.
    region_id str
    Id of the region.
    region_slug str
    Slug of the region.
    site_group_id str
    Id of the site group.
    site_group_slug str
    Slug of the site group.
    site_id float
    Id of the site.
    site_slug str
    Slug of the site.
    tag_id float
    Id of a tag the object carries.
    tag_slug str
    Slug of a tag the object carries.
    tenant_id float
    Id of the tenant.
    tenant_slug str
    Slug of the tenant.
    virtual_chassis str
    Virtual Chassis.
    virtual_chassis_id float
    Id of the virtual chassis.
    colorHex String
    RGB color in hex (e.g. ff0000).
    created String
    customFields Map<String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    deviceId Number
    Id of the device.
    id Number
    NetBox id.
    label String
    Physical label.
    lastUpdated String
    markConnected Boolean
    Treat as if a cable is connected.
    moduleId Number
    Id of the installed module this component belongs to.
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    positions Number
    Number of positions on the front port, at least the number of rear_ports mappings. NetBox checks a lower value against the mappings it already holds, so remove mappings in one apply and lower positions in the next. Must be a whole number.
    rearPortId Number
    Rear port of a single-position front port: the same as rearports = [{position = 1, rearportid = ..., rearportposition = ...}]. Conflicts with rearports and with positions > 1.
    rearPortPosition Number
    Position on rearportid. Requires rearportid. Must be a whole number.
    rearPorts List<Property Map>
    Mappings of the front port's positions onto rear ports of the same device, one object per position. Derived from rearportid and rearportposition when those are set; an empty set, or neither form, leaves the port unmapped. Changing the set recreates every mapping, since NetBox 4.6 rejects an update that resends an existing one.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    type String
    Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
    url String
    cableConnector Number
    Cable connector to match.
    cableEnd String
    Cable end. One of: A, B.
    cableId Number
    Id of the cable.
    cabled Boolean
    Whether cabled is set.
    color String
    Color to match.
    customFieldFilters Map<String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    deviceName String
    Name of the device.
    deviceRoleId Number
    Id of the device role.
    deviceRoleSlug String
    Slug of the device role.
    deviceStatus String
    Device status to match.
    deviceTypeId Number
    Id of the device type.
    deviceTypeModel String
    Model of the device type.
    locationId Number
    Id of the location.
    locationSlug String
    Slug of the location.
    occupied Boolean
    Whether occupied is set.
    ownerGroupId Number
    Id of the owner group.
    ownerGroupName String
    Name of the owner group.
    ownerName String
    Name of the owner.
    q String
    Search term, matched against the fields NetBox searches for this object type.
    rackId Number
    Id of the rack.
    rackName String
    Name of the rack.
    regionId String
    Id of the region.
    regionSlug String
    Slug of the region.
    siteGroupId String
    Id of the site group.
    siteGroupSlug String
    Slug of the site group.
    siteId Number
    Id of the site.
    siteSlug String
    Slug of the site.
    tagId Number
    Id of a tag the object carries.
    tagSlug String
    Slug of a tag the object carries.
    tenantId Number
    Id of the tenant.
    tenantSlug String
    Slug of the tenant.
    virtualChassis String
    Virtual Chassis.
    virtualChassisId Number
    Id of the virtual chassis.

    Supporting Types

    GetDeviceFrontPortRearPort

    Position double
    Position on the front port, 1-based and unique per port. Must be a whole number.
    RearPortId double
    Id of the rear port the position maps to.
    RearPortPosition double
    Position on that rear port, 1-based; each rear port position takes one mapping. Must be a whole number.
    Position float64
    Position on the front port, 1-based and unique per port. Must be a whole number.
    RearPortId float64
    Id of the rear port the position maps to.
    RearPortPosition float64
    Position on that rear port, 1-based; each rear port position takes one mapping. Must be a whole number.
    position number
    Position on the front port, 1-based and unique per port. Must be a whole number.
    rear_port_id number
    Id of the rear port the position maps to.
    rear_port_position number
    Position on that rear port, 1-based; each rear port position takes one mapping. Must be a whole number.
    position Double
    Position on the front port, 1-based and unique per port. Must be a whole number.
    rearPortId Double
    Id of the rear port the position maps to.
    rearPortPosition Double
    Position on that rear port, 1-based; each rear port position takes one mapping. Must be a whole number.
    position number
    Position on the front port, 1-based and unique per port. Must be a whole number.
    rearPortId number
    Id of the rear port the position maps to.
    rearPortPosition number
    Position on that rear port, 1-based; each rear port position takes one mapping. Must be a whole number.
    position float
    Position on the front port, 1-based and unique per port. Must be a whole number.
    rear_port_id float
    Id of the rear port the position maps to.
    rear_port_position float
    Position on that rear port, 1-based; each rear port position takes one mapping. Must be a whole number.
    position Number
    Position on the front port, 1-based and unique per port. Must be a whole number.
    rearPortId Number
    Id of the rear port the position maps to.
    rearPortPosition Number
    Position on that rear port, 1-based; each rear port position takes one mapping. Must be a whole number.

    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.1
    published on Monday, Nov 16, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial