Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netbox Provider
  3. API Docs
  4. Device
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.Device

Explore with Pulumi AI

netbox logo
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

    From the official documentation:

    Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth or full depth. A device may have a height of 0U: These devices do not consume vertical rack space and cannot be assigned to a particular rack unit. A common example of a 0U device is a vertically-mounted PDU.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";

const testSite = new netbox.Site("testSite", {});
const testDeviceRole = new netbox.DeviceRole("testDeviceRole", {colorHex: "123456"});
const testManufacturer = new netbox.Manufacturer("testManufacturer", {});
const testDeviceType = new netbox.DeviceType("testDeviceType", {
    model: "test",
    manufacturerId: testManufacturer.manufacturerId,
});
const testDevice = new netbox.Device("testDevice", {
    deviceTypeId: testDeviceType.deviceTypeId,
    roleId: testDeviceRole.deviceRoleId,
    siteId: testSite.siteId,
    localContextData: JSON.stringify({
        setting_a: "Some Setting",
        setting_b: 42,
    }),
});

    import pulumi
import json
import pulumi_netbox as netbox

test_site = netbox.Site("testSite")
test_device_role = netbox.DeviceRole("testDeviceRole", color_hex="123456")
test_manufacturer = netbox.Manufacturer("testManufacturer")
test_device_type = netbox.DeviceType("testDeviceType",
    model="test",
    manufacturer_id=test_manufacturer.manufacturer_id)
test_device = netbox.Device("testDevice",
    device_type_id=test_device_type.device_type_id,
    role_id=test_device_role.device_role_id,
    site_id=test_site.site_id,
    local_context_data=json.dumps({
        "setting_a": "Some Setting",
        "setting_b": 42,
    }))

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v3/netbox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testSite, err := netbox.NewSite(ctx, "testSite", nil)
		if err != nil {
			return err
		}
		testDeviceRole, err := netbox.NewDeviceRole(ctx, "testDeviceRole", &netbox.DeviceRoleArgs{
			ColorHex: pulumi.String("123456"),
		})
		if err != nil {
			return err
		}
		testManufacturer, err := netbox.NewManufacturer(ctx, "testManufacturer", nil)
		if err != nil {
			return err
		}
		testDeviceType, err := netbox.NewDeviceType(ctx, "testDeviceType", &netbox.DeviceTypeArgs{
			Model:          pulumi.String("test"),
			ManufacturerId: testManufacturer.ManufacturerId,
		})
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"setting_a": "Some Setting",
			"setting_b": 42,
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = netbox.NewDevice(ctx, "testDevice", &netbox.DeviceArgs{
			DeviceTypeId:     testDeviceType.DeviceTypeId,
			RoleId:           testDeviceRole.DeviceRoleId,
			SiteId:           testSite.SiteId,
			LocalContextData: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var testSite = new Netbox.Site("testSite");

    var testDeviceRole = new Netbox.DeviceRole("testDeviceRole", new()
    {
        ColorHex = "123456",
    });

    var testManufacturer = new Netbox.Manufacturer("testManufacturer");

    var testDeviceType = new Netbox.DeviceType("testDeviceType", new()
    {
        Model = "test",
        ManufacturerId = testManufacturer.ManufacturerId,
    });

    var testDevice = new Netbox.Device("testDevice", new()
    {
        DeviceTypeId = testDeviceType.DeviceTypeId,
        RoleId = testDeviceRole.DeviceRoleId,
        SiteId = testSite.SiteId,
        LocalContextData = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["setting_a"] = "Some Setting",
            ["setting_b"] = 42,
        }),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.Site;
import com.pulumi.netbox.DeviceRole;
import com.pulumi.netbox.DeviceRoleArgs;
import com.pulumi.netbox.Manufacturer;
import com.pulumi.netbox.DeviceType;
import com.pulumi.netbox.DeviceTypeArgs;
import com.pulumi.netbox.Device;
import com.pulumi.netbox.DeviceArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
        var testSite = new Site("testSite");

        var testDeviceRole = new DeviceRole("testDeviceRole", DeviceRoleArgs.builder()
            .colorHex("123456")
            .build());

        var testManufacturer = new Manufacturer("testManufacturer");

        var testDeviceType = new DeviceType("testDeviceType", DeviceTypeArgs.builder()
            .model("test")
            .manufacturerId(testManufacturer.manufacturerId())
            .build());

        var testDevice = new Device("testDevice", DeviceArgs.builder()
            .deviceTypeId(testDeviceType.deviceTypeId())
            .roleId(testDeviceRole.deviceRoleId())
            .siteId(testSite.siteId())
            .localContextData(serializeJson(
                jsonObject(
                    jsonProperty("setting_a", "Some Setting"),
                    jsonProperty("setting_b", 42)
                )))
            .build());

    }
}

    resources:
  testSite:
    type: netbox:Site
  testDeviceRole:
    type: netbox:DeviceRole
    properties:
      colorHex: '123456'
  testManufacturer:
    type: netbox:Manufacturer
  testDeviceType:
    type: netbox:DeviceType
    properties:
      model: test
      manufacturerId: ${testManufacturer.manufacturerId}
  testDevice:
    type: netbox:Device
    properties:
      deviceTypeId: ${testDeviceType.deviceTypeId}
      roleId: ${testDeviceRole.deviceRoleId}
      siteId: ${testSite.siteId}
      localContextData:
        fn::toJSON:
          setting_a: Some Setting
          setting_b: 42

    Create Device Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Device(name: string, args: DeviceArgs, opts?: CustomResourceOptions);
    @overload
def Device(resource_name: str,
           args: DeviceArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Device(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           device_type_id: Optional[float] = None,
           site_id: Optional[float] = None,
           role_id: Optional[float] = None,
           rack_face: Optional[str] = None,
           rack_position: Optional[float] = None,
           description: Optional[str] = None,
           device_id: Optional[str] = None,
           config_template_id: Optional[float] = None,
           local_context_data: Optional[str] = None,
           location_id: Optional[float] = None,
           name: Optional[str] = None,
           platform_id: Optional[float] = None,
           asset_tag: Optional[str] = None,
           rack_id: Optional[float] = None,
           custom_fields: Optional[Mapping[str, str]] = None,
           comments: Optional[str] = None,
           serial: Optional[str] = None,
           cluster_id: Optional[float] = None,
           status: Optional[str] = None,
           tags: Optional[Sequence[str]] = None,
           tenant_id: Optional[float] = None,
           virtual_chassis_id: Optional[float] = None,
           virtual_chassis_master: Optional[bool] = None,
           virtual_chassis_position: Optional[float] = None,
           virtual_chassis_priority: Optional[float] = None)
    func NewDevice(ctx *Context, name string, args DeviceArgs, opts ...ResourceOption) (*Device, error)
    public Device(string name, DeviceArgs args, CustomResourceOptions? opts = null)
    public Device(String name, DeviceArgs args)
public Device(String name, DeviceArgs args, CustomResourceOptions options)

    type: netbox:Device
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var deviceResource = new Netbox.Device("deviceResource", new()
{
    DeviceTypeId = 0,
    SiteId = 0,
    RoleId = 0,
    RackFace = "string",
    RackPosition = 0,
    Description = "string",
    DeviceId = "string",
    ConfigTemplateId = 0,
    LocalContextData = "string",
    LocationId = 0,
    Name = "string",
    PlatformId = 0,
    AssetTag = "string",
    RackId = 0,
    CustomFields = 
    {
        { "string", "string" },
    },
    Comments = "string",
    Serial = "string",
    ClusterId = 0,
    Status = "string",
    Tags = new[]
    {
        "string",
    },
    TenantId = 0,
    VirtualChassisId = 0,
    VirtualChassisMaster = false,
    VirtualChassisPosition = 0,
    VirtualChassisPriority = 0,
});

    example, err := netbox.NewDevice(ctx, "deviceResource", &netbox.DeviceArgs{
	DeviceTypeId:     pulumi.Float64(0),
	SiteId:           pulumi.Float64(0),
	RoleId:           pulumi.Float64(0),
	RackFace:         pulumi.String("string"),
	RackPosition:     pulumi.Float64(0),
	Description:      pulumi.String("string"),
	DeviceId:         pulumi.String("string"),
	ConfigTemplateId: pulumi.Float64(0),
	LocalContextData: pulumi.String("string"),
	LocationId:       pulumi.Float64(0),
	Name:             pulumi.String("string"),
	PlatformId:       pulumi.Float64(0),
	AssetTag:         pulumi.String("string"),
	RackId:           pulumi.Float64(0),
	CustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Comments:  pulumi.String("string"),
	Serial:    pulumi.String("string"),
	ClusterId: pulumi.Float64(0),
	Status:    pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantId:               pulumi.Float64(0),
	VirtualChassisId:       pulumi.Float64(0),
	VirtualChassisMaster:   pulumi.Bool(false),
	VirtualChassisPosition: pulumi.Float64(0),
	VirtualChassisPriority: pulumi.Float64(0),
})

    var deviceResource = new Device("deviceResource", DeviceArgs.builder()
    .deviceTypeId(0)
    .siteId(0)
    .roleId(0)
    .rackFace("string")
    .rackPosition(0)
    .description("string")
    .deviceId("string")
    .configTemplateId(0)
    .localContextData("string")
    .locationId(0)
    .name("string")
    .platformId(0)
    .assetTag("string")
    .rackId(0)
    .customFields(Map.of("string", "string"))
    .comments("string")
    .serial("string")
    .clusterId(0)
    .status("string")
    .tags("string")
    .tenantId(0)
    .virtualChassisId(0)
    .virtualChassisMaster(false)
    .virtualChassisPosition(0)
    .virtualChassisPriority(0)
    .build());

    device_resource = netbox.Device("deviceResource",
    device_type_id=0,
    site_id=0,
    role_id=0,
    rack_face="string",
    rack_position=0,
    description="string",
    device_id="string",
    config_template_id=0,
    local_context_data="string",
    location_id=0,
    name="string",
    platform_id=0,
    asset_tag="string",
    rack_id=0,
    custom_fields={
        "string": "string",
    },
    comments="string",
    serial="string",
    cluster_id=0,
    status="string",
    tags=["string"],
    tenant_id=0,
    virtual_chassis_id=0,
    virtual_chassis_master=False,
    virtual_chassis_position=0,
    virtual_chassis_priority=0)

    const deviceResource = new netbox.Device("deviceResource", {
    deviceTypeId: 0,
    siteId: 0,
    roleId: 0,
    rackFace: "string",
    rackPosition: 0,
    description: "string",
    deviceId: "string",
    configTemplateId: 0,
    localContextData: "string",
    locationId: 0,
    name: "string",
    platformId: 0,
    assetTag: "string",
    rackId: 0,
    customFields: {
        string: "string",
    },
    comments: "string",
    serial: "string",
    clusterId: 0,
    status: "string",
    tags: ["string"],
    tenantId: 0,
    virtualChassisId: 0,
    virtualChassisMaster: false,
    virtualChassisPosition: 0,
    virtualChassisPriority: 0,
});

    type: netbox:Device
properties:
    assetTag: string
    clusterId: 0
    comments: string
    configTemplateId: 0
    customFields:
        string: string
    description: string
    deviceId: string
    deviceTypeId: 0
    localContextData: string
    locationId: 0
    name: string
    platformId: 0
    rackFace: string
    rackId: 0
    rackPosition: 0
    roleId: 0
    serial: string
    siteId: 0
    status: string
    tags:
        - string
    tenantId: 0
    virtualChassisId: 0
    virtualChassisMaster: false
    virtualChassisPosition: 0
    virtualChassisPriority: 0

    Device Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Device resource accepts the following input properties:

    DeviceTypeId double
    RoleId double
    SiteId double
    AssetTag string
    ClusterId double
    Comments string
    ConfigTemplateId double
    CustomFields Dictionary<string, string>
    Description string
    DeviceId string
    The ID of this resource.
    LocalContextData string
    This is best managed through the use of jsonencode and a map of settings.
    LocationId double
    Name string
    PlatformId double
    RackFace string
    Valid values are front and rear. Required when rack_position is set.
    RackId double
    RackPosition double
    Serial string
    Status string
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    Tags List<string>
    TenantId double
    VirtualChassisId double
    Required when virtual_chassis_master and virtual_chassis_id is set.
    VirtualChassisMaster bool
    Required when virtual_chassis_master and virtual_chassis_id is set.
    VirtualChassisPosition double
    VirtualChassisPriority double
    DeviceTypeId float64
    RoleId float64
    SiteId float64
    AssetTag string
    ClusterId float64
    Comments string
    ConfigTemplateId float64
    CustomFields map[string]string
    Description string
    DeviceId string
    The ID of this resource.
    LocalContextData string
    This is best managed through the use of jsonencode and a map of settings.
    LocationId float64
    Name string
    PlatformId float64
    RackFace string
    Valid values are front and rear. Required when rack_position is set.
    RackId float64
    RackPosition float64
    Serial string
    Status string
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    Tags []string
    TenantId float64
    VirtualChassisId float64
    Required when virtual_chassis_master and virtual_chassis_id is set.
    VirtualChassisMaster bool
    Required when virtual_chassis_master and virtual_chassis_id is set.
    VirtualChassisPosition float64
    VirtualChassisPriority float64
    deviceTypeId Double
    roleId Double
    siteId Double
    assetTag String
    clusterId Double
    comments String
    configTemplateId Double
    customFields Map<String,String>
    description String
    deviceId String
    The ID of this resource.
    localContextData String
    This is best managed through the use of jsonencode and a map of settings.
    locationId Double
    name String
    platformId Double
    rackFace String
    Valid values are front and rear. Required when rack_position is set.
    rackId Double
    rackPosition Double
    serial String
    status String
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    tags List<String>
    tenantId Double
    virtualChassisId Double
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisMaster Boolean
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisPosition Double
    virtualChassisPriority Double
    deviceTypeId number
    roleId number
    siteId number
    assetTag string
    clusterId number
    comments string
    configTemplateId number
    customFields {[key: string]: string}
    description string
    deviceId string
    The ID of this resource.
    localContextData string
    This is best managed through the use of jsonencode and a map of settings.
    locationId number
    name string
    platformId number
    rackFace string
    Valid values are front and rear. Required when rack_position is set.
    rackId number
    rackPosition number
    serial string
    status string
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    tags string[]
    tenantId number
    virtualChassisId number
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisMaster boolean
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisPosition number
    virtualChassisPriority number
    device_type_id float
    role_id float
    site_id float
    asset_tag str
    cluster_id float
    comments str
    config_template_id float
    custom_fields Mapping[str, str]
    description str
    device_id str
    The ID of this resource.
    local_context_data str
    This is best managed through the use of jsonencode and a map of settings.
    location_id float
    name str
    platform_id float
    rack_face str
    Valid values are front and rear. Required when rack_position is set.
    rack_id float
    rack_position float
    serial str
    status str
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    tags Sequence[str]
    tenant_id float
    virtual_chassis_id float
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtual_chassis_master bool
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtual_chassis_position float
    virtual_chassis_priority float
    deviceTypeId Number
    roleId Number
    siteId Number
    assetTag String
    clusterId Number
    comments String
    configTemplateId Number
    customFields Map<String>
    description String
    deviceId String
    The ID of this resource.
    localContextData String
    This is best managed through the use of jsonencode and a map of settings.
    locationId Number
    name String
    platformId Number
    rackFace String
    Valid values are front and rear. Required when rack_position is set.
    rackId Number
    rackPosition Number
    serial String
    status String
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    tags List<String>
    tenantId Number
    virtualChassisId Number
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisMaster Boolean
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisPosition Number
    virtualChassisPriority Number

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Device resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryIpv4 double
    PrimaryIpv6 double
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryIpv4 float64
    PrimaryIpv6 float64
    id String
    The provider-assigned unique ID for this managed resource.
    primaryIpv4 Double
    primaryIpv6 Double
    id string
    The provider-assigned unique ID for this managed resource.
    primaryIpv4 number
    primaryIpv6 number
    id str
    The provider-assigned unique ID for this managed resource.
    primary_ipv4 float
    primary_ipv6 float
    id String
    The provider-assigned unique ID for this managed resource.
    primaryIpv4 Number
    primaryIpv6 Number

    Look up Existing Device Resource

    Get an existing Device resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DeviceState, opts?: CustomResourceOptions): Device
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        asset_tag: Optional[str] = None,
        cluster_id: Optional[float] = None,
        comments: Optional[str] = None,
        config_template_id: Optional[float] = None,
        custom_fields: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        device_id: Optional[str] = None,
        device_type_id: Optional[float] = None,
        local_context_data: Optional[str] = None,
        location_id: Optional[float] = None,
        name: Optional[str] = None,
        platform_id: Optional[float] = None,
        primary_ipv4: Optional[float] = None,
        primary_ipv6: Optional[float] = None,
        rack_face: Optional[str] = None,
        rack_id: Optional[float] = None,
        rack_position: Optional[float] = None,
        role_id: Optional[float] = None,
        serial: Optional[str] = None,
        site_id: Optional[float] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        tenant_id: Optional[float] = None,
        virtual_chassis_id: Optional[float] = None,
        virtual_chassis_master: Optional[bool] = None,
        virtual_chassis_position: Optional[float] = None,
        virtual_chassis_priority: Optional[float] = None) -> Device
    func GetDevice(ctx *Context, name string, id IDInput, state *DeviceState, opts ...ResourceOption) (*Device, error)
    public static Device Get(string name, Input<string> id, DeviceState? state, CustomResourceOptions? opts = null)
    public static Device get(String name, Output<String> id, DeviceState state, CustomResourceOptions options)
    resources:  _:    type: netbox:Device    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AssetTag string
    ClusterId double
    Comments string
    ConfigTemplateId double
    CustomFields Dictionary<string, string>
    Description string
    DeviceId string
    The ID of this resource.
    DeviceTypeId double
    LocalContextData string
    This is best managed through the use of jsonencode and a map of settings.
    LocationId double
    Name string
    PlatformId double
    PrimaryIpv4 double
    PrimaryIpv6 double
    RackFace string
    Valid values are front and rear. Required when rack_position is set.
    RackId double
    RackPosition double
    RoleId double
    Serial string
    SiteId double
    Status string
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    Tags List<string>
    TenantId double
    VirtualChassisId double
    Required when virtual_chassis_master and virtual_chassis_id is set.
    VirtualChassisMaster bool
    Required when virtual_chassis_master and virtual_chassis_id is set.
    VirtualChassisPosition double
    VirtualChassisPriority double
    AssetTag string
    ClusterId float64
    Comments string
    ConfigTemplateId float64
    CustomFields map[string]string
    Description string
    DeviceId string
    The ID of this resource.
    DeviceTypeId float64
    LocalContextData string
    This is best managed through the use of jsonencode and a map of settings.
    LocationId float64
    Name string
    PlatformId float64
    PrimaryIpv4 float64
    PrimaryIpv6 float64
    RackFace string
    Valid values are front and rear. Required when rack_position is set.
    RackId float64
    RackPosition float64
    RoleId float64
    Serial string
    SiteId float64
    Status string
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    Tags []string
    TenantId float64
    VirtualChassisId float64
    Required when virtual_chassis_master and virtual_chassis_id is set.
    VirtualChassisMaster bool
    Required when virtual_chassis_master and virtual_chassis_id is set.
    VirtualChassisPosition float64
    VirtualChassisPriority float64
    assetTag String
    clusterId Double
    comments String
    configTemplateId Double
    customFields Map<String,String>
    description String
    deviceId String
    The ID of this resource.
    deviceTypeId Double
    localContextData String
    This is best managed through the use of jsonencode and a map of settings.
    locationId Double
    name String
    platformId Double
    primaryIpv4 Double
    primaryIpv6 Double
    rackFace String
    Valid values are front and rear. Required when rack_position is set.
    rackId Double
    rackPosition Double
    roleId Double
    serial String
    siteId Double
    status String
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    tags List<String>
    tenantId Double
    virtualChassisId Double
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisMaster Boolean
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisPosition Double
    virtualChassisPriority Double
    assetTag string
    clusterId number
    comments string
    configTemplateId number
    customFields {[key: string]: string}
    description string
    deviceId string
    The ID of this resource.
    deviceTypeId number
    localContextData string
    This is best managed through the use of jsonencode and a map of settings.
    locationId number
    name string
    platformId number
    primaryIpv4 number
    primaryIpv6 number
    rackFace string
    Valid values are front and rear. Required when rack_position is set.
    rackId number
    rackPosition number
    roleId number
    serial string
    siteId number
    status string
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    tags string[]
    tenantId number
    virtualChassisId number
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisMaster boolean
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisPosition number
    virtualChassisPriority number
    asset_tag str
    cluster_id float
    comments str
    config_template_id float
    custom_fields Mapping[str, str]
    description str
    device_id str
    The ID of this resource.
    device_type_id float
    local_context_data str
    This is best managed through the use of jsonencode and a map of settings.
    location_id float
    name str
    platform_id float
    primary_ipv4 float
    primary_ipv6 float
    rack_face str
    Valid values are front and rear. Required when rack_position is set.
    rack_id float
    rack_position float
    role_id float
    serial str
    site_id float
    status str
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    tags Sequence[str]
    tenant_id float
    virtual_chassis_id float
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtual_chassis_master bool
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtual_chassis_position float
    virtual_chassis_priority float
    assetTag String
    clusterId Number
    comments String
    configTemplateId Number
    customFields Map<String>
    description String
    deviceId String
    The ID of this resource.
    deviceTypeId Number
    localContextData String
    This is best managed through the use of jsonencode and a map of settings.
    locationId Number
    name String
    platformId Number
    primaryIpv4 Number
    primaryIpv6 Number
    rackFace String
    Valid values are front and rear. Required when rack_position is set.
    rackId Number
    rackPosition Number
    roleId Number
    serial String
    siteId Number
    status String
    Valid values are offline, active, planned, staged, failed and inventory. Defaults to active.
    tags List<String>
    tenantId Number
    virtualChassisId Number
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisMaster Boolean
    Required when virtual_chassis_master and virtual_chassis_id is set.
    virtualChassisPosition Number
    virtualChassisPriority Number

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
    e-breuninger/terraform-provider-netbox