published on Wednesday, Nov 4, 2026 by e-breuninger
published on Wednesday, Nov 4, 2026 by e-breuninger
A MAC address (dcim.macaddress), optionally assigned to a device or VM interface.
From the official documentation:
A MAC address object in NetBox comprises a single Ethernet link layer address, and represents a MAC address as reported by or assigned to a network interface. MAC addresses can be assigned to device and virtual machine interfaces.
Example Usage
A MAC address is either unassigned or assigned to one interface. The assignment is written as device_interface_id or virtual_machine_interface_id, or as the assigned_object_type and assigned_object_id pair; the provider fills in the other form.
Assigned to a device interface
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = new netbox.Site("test", {name: "test-site"});
const testManufacturer = new netbox.Manufacturer("test", {name: "test-manufacturer"});
const testDeviceType = new netbox.DeviceType("test", {
manufacturerId: testManufacturer.manufacturerId,
model: "test-device-type",
});
const testDeviceRole = new netbox.DeviceRole("test", {name: "test-device-role"});
const testDevice = new netbox.Device("test", {
name: "test-device",
deviceTypeId: testDeviceType.deviceTypeId,
roleId: testDeviceRole.deviceRoleId,
siteId: test.siteId,
});
const testDeviceInterface = new netbox.DeviceInterface("test", {
deviceId: testDevice.deviceId,
name: "test-interface",
type: "1000base-t",
});
const testMacAddress = new netbox.MacAddress("test", {
macAddress: "00:11:22:33:44:55",
deviceInterfaceId: testDeviceInterface.deviceInterfaceId,
});
import pulumi
import pulumi_netbox as netbox
test = netbox.Site("test", name="test-site")
test_manufacturer = netbox.Manufacturer("test", name="test-manufacturer")
test_device_type = netbox.DeviceType("test",
manufacturer_id=test_manufacturer.manufacturer_id,
model="test-device-type")
test_device_role = netbox.DeviceRole("test", name="test-device-role")
test_device = netbox.Device("test",
name="test-device",
device_type_id=test_device_type.device_type_id,
role_id=test_device_role.device_role_id,
site_id=test.site_id)
test_device_interface = netbox.DeviceInterface("test",
device_id=test_device.device_id,
name="test-interface",
type="1000base-t")
test_mac_address = netbox.MacAddress("test",
mac_address="00:11:22:33:44:55",
device_interface_id=test_device_interface.device_interface_id)
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 {
test, err := netbox.NewSite(ctx, "test", &netbox.SiteArgs{
Name: pulumi.String("test-site"),
})
if err != nil {
return err
}
testManufacturer, err := netbox.NewManufacturer(ctx, "test", &netbox.ManufacturerArgs{
Name: pulumi.String("test-manufacturer"),
})
if err != nil {
return err
}
testDeviceType, err := netbox.NewDeviceType(ctx, "test", &netbox.DeviceTypeArgs{
ManufacturerId: testManufacturer.ManufacturerId,
Model: pulumi.String("test-device-type"),
})
if err != nil {
return err
}
testDeviceRole, err := netbox.NewDeviceRole(ctx, "test", &netbox.DeviceRoleArgs{
Name: pulumi.String("test-device-role"),
})
if err != nil {
return err
}
testDevice, err := netbox.NewDevice(ctx, "test", &netbox.DeviceArgs{
Name: pulumi.String("test-device"),
DeviceTypeId: testDeviceType.DeviceTypeId,
RoleId: testDeviceRole.DeviceRoleId,
SiteId: test.SiteId,
})
if err != nil {
return err
}
testDeviceInterface, err := netbox.NewDeviceInterface(ctx, "test", &netbox.DeviceInterfaceArgs{
DeviceId: testDevice.DeviceId,
Name: pulumi.String("test-interface"),
Type: pulumi.String("1000base-t"),
})
if err != nil {
return err
}
_, err = netbox.NewMacAddress(ctx, "test", &netbox.MacAddressArgs{
MacAddress: pulumi.String("00:11:22:33:44:55"),
DeviceInterfaceId: testDeviceInterface.DeviceInterfaceId,
})
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 = new Netbox.Site("test", new()
{
Name = "test-site",
});
var testManufacturer = new Netbox.Manufacturer("test", new()
{
Name = "test-manufacturer",
});
var testDeviceType = new Netbox.DeviceType("test", new()
{
ManufacturerId = testManufacturer.ManufacturerId,
Model = "test-device-type",
});
var testDeviceRole = new Netbox.DeviceRole("test", new()
{
Name = "test-device-role",
});
var testDevice = new Netbox.Device("test", new()
{
Name = "test-device",
DeviceTypeId = testDeviceType.DeviceTypeId,
RoleId = testDeviceRole.DeviceRoleId,
SiteId = test.SiteId,
});
var testDeviceInterface = new Netbox.DeviceInterface("test", new()
{
DeviceId = testDevice.DeviceId,
Name = "test-interface",
Type = "1000base-t",
});
var testMacAddress = new Netbox.MacAddress("test", new()
{
MacAddress = "00:11:22:33:44:55",
DeviceInterfaceId = testDeviceInterface.DeviceInterfaceId,
});
});
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.SiteArgs;
import com.pulumi.netbox.Manufacturer;
import com.pulumi.netbox.ManufacturerArgs;
import com.pulumi.netbox.DeviceType;
import com.pulumi.netbox.DeviceTypeArgs;
import com.pulumi.netbox.DeviceRole;
import com.pulumi.netbox.DeviceRoleArgs;
import com.pulumi.netbox.Device;
import com.pulumi.netbox.DeviceArgs;
import com.pulumi.netbox.DeviceInterface;
import com.pulumi.netbox.DeviceInterfaceArgs;
import com.pulumi.netbox.MacAddress;
import com.pulumi.netbox.MacAddressArgs;
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 test = new Site("test", SiteArgs.builder()
.name("test-site")
.build());
var testManufacturer = new Manufacturer("testManufacturer", ManufacturerArgs.builder()
.name("test-manufacturer")
.build());
var testDeviceType = new DeviceType("testDeviceType", DeviceTypeArgs.builder()
.manufacturerId(testManufacturer.manufacturerId())
.model("test-device-type")
.build());
var testDeviceRole = new DeviceRole("testDeviceRole", DeviceRoleArgs.builder()
.name("test-device-role")
.build());
var testDevice = new Device("testDevice", DeviceArgs.builder()
.name("test-device")
.deviceTypeId(testDeviceType.deviceTypeId())
.roleId(testDeviceRole.deviceRoleId())
.siteId(test.siteId())
.build());
var testDeviceInterface = new DeviceInterface("testDeviceInterface", DeviceInterfaceArgs.builder()
.deviceId(testDevice.deviceId())
.name("test-interface")
.type("1000base-t")
.build());
var testMacAddress = new MacAddress("testMacAddress", MacAddressArgs.builder()
.macAddress("00:11:22:33:44:55")
.deviceInterfaceId(testDeviceInterface.deviceInterfaceId())
.build());
}
}
resources:
test:
type: netbox:Site
properties:
name: test-site
testManufacturer:
type: netbox:Manufacturer
name: test
properties:
name: test-manufacturer
testDeviceType:
type: netbox:DeviceType
name: test
properties:
manufacturerId: ${testManufacturer.manufacturerId}
model: test-device-type
testDeviceRole:
type: netbox:DeviceRole
name: test
properties:
name: test-device-role
testDevice:
type: netbox:Device
name: test
properties:
name: test-device
deviceTypeId: ${testDeviceType.deviceTypeId}
roleId: ${testDeviceRole.deviceRoleId}
siteId: ${test.siteId}
testDeviceInterface:
type: netbox:DeviceInterface
name: test
properties:
deviceId: ${testDevice.deviceId}
name: test-interface
type: 1000base-t
testMacAddress:
type: netbox:MacAddress
name: test
properties:
macAddress: 00:11:22:33:44:55
deviceInterfaceId: ${testDeviceInterface.deviceInterfaceId}
Example coming soon!
Assigned to a virtual machine interface
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = new netbox.ClusterType("test", {name: "test-cluster-type"});
const testCluster = new netbox.Cluster("test", {
name: "test-cluster",
clusterTypeId: test.clusterTypeId,
});
const testVirtualMachine = new netbox.VirtualMachine("test", {
name: "test-virtual-machine",
clusterId: testCluster.clusterId,
});
const testVirtualMachineInterface = new netbox.VirtualMachineInterface("test", {
virtualMachineId: testVirtualMachine.virtualMachineId,
name: "test-interface",
});
const testMacAddress = new netbox.MacAddress("test", {
macAddress: "00:11:22:33:44:55",
virtualMachineInterfaceId: testVirtualMachineInterface.virtualMachineInterfaceId,
});
import pulumi
import pulumi_netbox as netbox
test = netbox.ClusterType("test", name="test-cluster-type")
test_cluster = netbox.Cluster("test",
name="test-cluster",
cluster_type_id=test.cluster_type_id)
test_virtual_machine = netbox.VirtualMachine("test",
name="test-virtual-machine",
cluster_id=test_cluster.cluster_id)
test_virtual_machine_interface = netbox.VirtualMachineInterface("test",
virtual_machine_id=test_virtual_machine.virtual_machine_id,
name="test-interface")
test_mac_address = netbox.MacAddress("test",
mac_address="00:11:22:33:44:55",
virtual_machine_interface_id=test_virtual_machine_interface.virtual_machine_interface_id)
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 {
test, err := netbox.NewClusterType(ctx, "test", &netbox.ClusterTypeArgs{
Name: pulumi.String("test-cluster-type"),
})
if err != nil {
return err
}
testCluster, err := netbox.NewCluster(ctx, "test", &netbox.ClusterArgs{
Name: pulumi.String("test-cluster"),
ClusterTypeId: test.ClusterTypeId,
})
if err != nil {
return err
}
testVirtualMachine, err := netbox.NewVirtualMachine(ctx, "test", &netbox.VirtualMachineArgs{
Name: pulumi.String("test-virtual-machine"),
ClusterId: testCluster.ClusterId,
})
if err != nil {
return err
}
testVirtualMachineInterface, err := netbox.NewVirtualMachineInterface(ctx, "test", &netbox.VirtualMachineInterfaceArgs{
VirtualMachineId: testVirtualMachine.VirtualMachineId,
Name: pulumi.String("test-interface"),
})
if err != nil {
return err
}
_, err = netbox.NewMacAddress(ctx, "test", &netbox.MacAddressArgs{
MacAddress: pulumi.String("00:11:22:33:44:55"),
VirtualMachineInterfaceId: testVirtualMachineInterface.VirtualMachineInterfaceId,
})
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 = new Netbox.ClusterType("test", new()
{
Name = "test-cluster-type",
});
var testCluster = new Netbox.Cluster("test", new()
{
Name = "test-cluster",
ClusterTypeId = test.ClusterTypeId,
});
var testVirtualMachine = new Netbox.VirtualMachine("test", new()
{
Name = "test-virtual-machine",
ClusterId = testCluster.ClusterId,
});
var testVirtualMachineInterface = new Netbox.VirtualMachineInterface("test", new()
{
VirtualMachineId = testVirtualMachine.VirtualMachineId,
Name = "test-interface",
});
var testMacAddress = new Netbox.MacAddress("test", new()
{
MacAddress = "00:11:22:33:44:55",
VirtualMachineInterfaceId = testVirtualMachineInterface.VirtualMachineInterfaceId,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.ClusterType;
import com.pulumi.netbox.ClusterTypeArgs;
import com.pulumi.netbox.Cluster;
import com.pulumi.netbox.ClusterArgs;
import com.pulumi.netbox.VirtualMachine;
import com.pulumi.netbox.VirtualMachineArgs;
import com.pulumi.netbox.VirtualMachineInterface;
import com.pulumi.netbox.VirtualMachineInterfaceArgs;
import com.pulumi.netbox.MacAddress;
import com.pulumi.netbox.MacAddressArgs;
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 test = new ClusterType("test", ClusterTypeArgs.builder()
.name("test-cluster-type")
.build());
var testCluster = new Cluster("testCluster", ClusterArgs.builder()
.name("test-cluster")
.clusterTypeId(test.clusterTypeId())
.build());
var testVirtualMachine = new VirtualMachine("testVirtualMachine", VirtualMachineArgs.builder()
.name("test-virtual-machine")
.clusterId(testCluster.clusterId())
.build());
var testVirtualMachineInterface = new VirtualMachineInterface("testVirtualMachineInterface", VirtualMachineInterfaceArgs.builder()
.virtualMachineId(testVirtualMachine.virtualMachineId())
.name("test-interface")
.build());
var testMacAddress = new MacAddress("testMacAddress", MacAddressArgs.builder()
.macAddress("00:11:22:33:44:55")
.virtualMachineInterfaceId(testVirtualMachineInterface.virtualMachineInterfaceId())
.build());
}
}
resources:
test:
type: netbox:ClusterType
properties:
name: test-cluster-type
testCluster:
type: netbox:Cluster
name: test
properties:
name: test-cluster
clusterTypeId: ${test.clusterTypeId}
testVirtualMachine:
type: netbox:VirtualMachine
name: test
properties:
name: test-virtual-machine
clusterId: ${testCluster.clusterId}
testVirtualMachineInterface:
type: netbox:VirtualMachineInterface
name: test
properties:
virtualMachineId: ${testVirtualMachine.virtualMachineId}
name: test-interface
testMacAddress:
type: netbox:MacAddress
name: test
properties:
macAddress: 00:11:22:33:44:55
virtualMachineInterfaceId: ${testVirtualMachineInterface.virtualMachineInterfaceId}
Example coming soon!
Assigned through the object type and id pair
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = new netbox.Site("test", {name: "test-site"});
const testManufacturer = new netbox.Manufacturer("test", {name: "test-manufacturer"});
const testDeviceType = new netbox.DeviceType("test", {
manufacturerId: testManufacturer.manufacturerId,
model: "test-device-type",
});
const testDeviceRole = new netbox.DeviceRole("test", {name: "test-device-role"});
const testDevice = new netbox.Device("test", {
name: "test-device",
deviceTypeId: testDeviceType.deviceTypeId,
roleId: testDeviceRole.deviceRoleId,
siteId: test.siteId,
});
const testDeviceInterface = new netbox.DeviceInterface("test", {
deviceId: testDevice.deviceId,
name: "test-interface",
type: "1000base-t",
});
const testMacAddress = new netbox.MacAddress("test", {
macAddress: "00:11:22:33:44:55",
assignedObjectType: "dcim.interface",
assignedObjectId: testDeviceInterface.deviceInterfaceId,
});
import pulumi
import pulumi_netbox as netbox
test = netbox.Site("test", name="test-site")
test_manufacturer = netbox.Manufacturer("test", name="test-manufacturer")
test_device_type = netbox.DeviceType("test",
manufacturer_id=test_manufacturer.manufacturer_id,
model="test-device-type")
test_device_role = netbox.DeviceRole("test", name="test-device-role")
test_device = netbox.Device("test",
name="test-device",
device_type_id=test_device_type.device_type_id,
role_id=test_device_role.device_role_id,
site_id=test.site_id)
test_device_interface = netbox.DeviceInterface("test",
device_id=test_device.device_id,
name="test-interface",
type="1000base-t")
test_mac_address = netbox.MacAddress("test",
mac_address="00:11:22:33:44:55",
assigned_object_type="dcim.interface",
assigned_object_id=test_device_interface.device_interface_id)
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 {
test, err := netbox.NewSite(ctx, "test", &netbox.SiteArgs{
Name: pulumi.String("test-site"),
})
if err != nil {
return err
}
testManufacturer, err := netbox.NewManufacturer(ctx, "test", &netbox.ManufacturerArgs{
Name: pulumi.String("test-manufacturer"),
})
if err != nil {
return err
}
testDeviceType, err := netbox.NewDeviceType(ctx, "test", &netbox.DeviceTypeArgs{
ManufacturerId: testManufacturer.ManufacturerId,
Model: pulumi.String("test-device-type"),
})
if err != nil {
return err
}
testDeviceRole, err := netbox.NewDeviceRole(ctx, "test", &netbox.DeviceRoleArgs{
Name: pulumi.String("test-device-role"),
})
if err != nil {
return err
}
testDevice, err := netbox.NewDevice(ctx, "test", &netbox.DeviceArgs{
Name: pulumi.String("test-device"),
DeviceTypeId: testDeviceType.DeviceTypeId,
RoleId: testDeviceRole.DeviceRoleId,
SiteId: test.SiteId,
})
if err != nil {
return err
}
testDeviceInterface, err := netbox.NewDeviceInterface(ctx, "test", &netbox.DeviceInterfaceArgs{
DeviceId: testDevice.DeviceId,
Name: pulumi.String("test-interface"),
Type: pulumi.String("1000base-t"),
})
if err != nil {
return err
}
_, err = netbox.NewMacAddress(ctx, "test", &netbox.MacAddressArgs{
MacAddress: pulumi.String("00:11:22:33:44:55"),
AssignedObjectType: pulumi.String("dcim.interface"),
AssignedObjectId: testDeviceInterface.DeviceInterfaceId,
})
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 = new Netbox.Site("test", new()
{
Name = "test-site",
});
var testManufacturer = new Netbox.Manufacturer("test", new()
{
Name = "test-manufacturer",
});
var testDeviceType = new Netbox.DeviceType("test", new()
{
ManufacturerId = testManufacturer.ManufacturerId,
Model = "test-device-type",
});
var testDeviceRole = new Netbox.DeviceRole("test", new()
{
Name = "test-device-role",
});
var testDevice = new Netbox.Device("test", new()
{
Name = "test-device",
DeviceTypeId = testDeviceType.DeviceTypeId,
RoleId = testDeviceRole.DeviceRoleId,
SiteId = test.SiteId,
});
var testDeviceInterface = new Netbox.DeviceInterface("test", new()
{
DeviceId = testDevice.DeviceId,
Name = "test-interface",
Type = "1000base-t",
});
var testMacAddress = new Netbox.MacAddress("test", new()
{
MacAddress = "00:11:22:33:44:55",
AssignedObjectType = "dcim.interface",
AssignedObjectId = testDeviceInterface.DeviceInterfaceId,
});
});
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.SiteArgs;
import com.pulumi.netbox.Manufacturer;
import com.pulumi.netbox.ManufacturerArgs;
import com.pulumi.netbox.DeviceType;
import com.pulumi.netbox.DeviceTypeArgs;
import com.pulumi.netbox.DeviceRole;
import com.pulumi.netbox.DeviceRoleArgs;
import com.pulumi.netbox.Device;
import com.pulumi.netbox.DeviceArgs;
import com.pulumi.netbox.DeviceInterface;
import com.pulumi.netbox.DeviceInterfaceArgs;
import com.pulumi.netbox.MacAddress;
import com.pulumi.netbox.MacAddressArgs;
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 test = new Site("test", SiteArgs.builder()
.name("test-site")
.build());
var testManufacturer = new Manufacturer("testManufacturer", ManufacturerArgs.builder()
.name("test-manufacturer")
.build());
var testDeviceType = new DeviceType("testDeviceType", DeviceTypeArgs.builder()
.manufacturerId(testManufacturer.manufacturerId())
.model("test-device-type")
.build());
var testDeviceRole = new DeviceRole("testDeviceRole", DeviceRoleArgs.builder()
.name("test-device-role")
.build());
var testDevice = new Device("testDevice", DeviceArgs.builder()
.name("test-device")
.deviceTypeId(testDeviceType.deviceTypeId())
.roleId(testDeviceRole.deviceRoleId())
.siteId(test.siteId())
.build());
var testDeviceInterface = new DeviceInterface("testDeviceInterface", DeviceInterfaceArgs.builder()
.deviceId(testDevice.deviceId())
.name("test-interface")
.type("1000base-t")
.build());
var testMacAddress = new MacAddress("testMacAddress", MacAddressArgs.builder()
.macAddress("00:11:22:33:44:55")
.assignedObjectType("dcim.interface")
.assignedObjectId(testDeviceInterface.deviceInterfaceId())
.build());
}
}
resources:
test:
type: netbox:Site
properties:
name: test-site
testManufacturer:
type: netbox:Manufacturer
name: test
properties:
name: test-manufacturer
testDeviceType:
type: netbox:DeviceType
name: test
properties:
manufacturerId: ${testManufacturer.manufacturerId}
model: test-device-type
testDeviceRole:
type: netbox:DeviceRole
name: test
properties:
name: test-device-role
testDevice:
type: netbox:Device
name: test
properties:
name: test-device
deviceTypeId: ${testDeviceType.deviceTypeId}
roleId: ${testDeviceRole.deviceRoleId}
siteId: ${test.siteId}
testDeviceInterface:
type: netbox:DeviceInterface
name: test
properties:
deviceId: ${testDevice.deviceId}
name: test-interface
type: 1000base-t
testMacAddress:
type: netbox:MacAddress
name: test
properties:
macAddress: 00:11:22:33:44:55
assignedObjectType: dcim.interface
assignedObjectId: ${testDeviceInterface.deviceInterfaceId}
Example coming soon!
Not assigned
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = new netbox.MacAddress("test", {
macAddress: "00:11:22:33:44:55",
description: "test-description",
});
import pulumi
import pulumi_netbox as netbox
test = netbox.MacAddress("test",
mac_address="00:11:22:33:44:55",
description="test-description")
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.NewMacAddress(ctx, "test", &netbox.MacAddressArgs{
MacAddress: pulumi.String("00:11:22:33:44:55"),
Description: pulumi.String("test-description"),
})
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 = new Netbox.MacAddress("test", new()
{
MacAddress = "00:11:22:33:44:55",
Description = "test-description",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.MacAddress;
import com.pulumi.netbox.MacAddressArgs;
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 test = new MacAddress("test", MacAddressArgs.builder()
.macAddress("00:11:22:33:44:55")
.description("test-description")
.build());
}
}
resources:
test:
type: netbox:MacAddress
properties:
macAddress: 00:11:22:33:44:55
description: test-description
Example coming soon!
Create MacAddress Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MacAddress(name: string, args: MacAddressArgs, opts?: CustomResourceOptions);@overload
def MacAddress(resource_name: str,
args: MacAddressArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MacAddress(resource_name: str,
opts: Optional[ResourceOptions] = None,
mac_address: Optional[str] = None,
assigned_object_id: Optional[float] = None,
assigned_object_type: Optional[str] = None,
comments: Optional[str] = None,
custom_fields: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
device_interface_id: Optional[float] = None,
owner_id: Optional[float] = None,
tags: Optional[Sequence[str]] = None,
virtual_machine_interface_id: Optional[float] = None)func NewMacAddress(ctx *Context, name string, args MacAddressArgs, opts ...ResourceOption) (*MacAddress, error)public MacAddress(string name, MacAddressArgs args, CustomResourceOptions? opts = null)
public MacAddress(String name, MacAddressArgs args)
public MacAddress(String name, MacAddressArgs args, CustomResourceOptions options)
type: netbox:MacAddress
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "netbox_mac_address" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args MacAddressArgs
- 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 MacAddressArgs
- 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 MacAddressArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MacAddressArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MacAddressArgs
- 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 macAddressResource = new Netbox.MacAddress("macAddressResource", new()
{
MacAddress = "string",
AssignedObjectId = 0.0,
AssignedObjectType = "string",
Comments = "string",
CustomFields =
{
{ "string", "string" },
},
Description = "string",
DeviceInterfaceId = 0.0,
OwnerId = 0.0,
Tags = new[]
{
"string",
},
VirtualMachineInterfaceId = 0.0,
});
example, err := netbox.NewMacAddress(ctx, "macAddressResource", &netbox.MacAddressArgs{
MacAddress: pulumi.String("string"),
AssignedObjectId: pulumi.Float64(0),
AssignedObjectType: pulumi.String("string"),
Comments: pulumi.String("string"),
CustomFields: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
DeviceInterfaceId: pulumi.Float64(0),
OwnerId: pulumi.Float64(0),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
VirtualMachineInterfaceId: pulumi.Float64(0),
})
resource "netbox_mac_address" "macAddressResource" {
lifecycle {
create_before_destroy = true
}
mac_address = "string"
assigned_object_id = 0
assigned_object_type = "string"
comments = "string"
custom_fields = {
"string" = "string"
}
description = "string"
device_interface_id = 0
owner_id = 0
tags = ["string"]
virtual_machine_interface_id = 0
}
var macAddressResource = new MacAddress("macAddressResource", MacAddressArgs.builder()
.macAddress("string")
.assignedObjectId(0.0)
.assignedObjectType("string")
.comments("string")
.customFields(Map.of("string", "string"))
.description("string")
.deviceInterfaceId(0.0)
.ownerId(0.0)
.tags("string")
.virtualMachineInterfaceId(0.0)
.build());
mac_address_resource = netbox.MacAddress("macAddressResource",
mac_address="string",
assigned_object_id=float(0),
assigned_object_type="string",
comments="string",
custom_fields={
"string": "string",
},
description="string",
device_interface_id=float(0),
owner_id=float(0),
tags=["string"],
virtual_machine_interface_id=float(0))
const macAddressResource = new netbox.MacAddress("macAddressResource", {
macAddress: "string",
assignedObjectId: 0,
assignedObjectType: "string",
comments: "string",
customFields: {
string: "string",
},
description: "string",
deviceInterfaceId: 0,
ownerId: 0,
tags: ["string"],
virtualMachineInterfaceId: 0,
});
type: netbox:MacAddress
properties:
assignedObjectId: 0
assignedObjectType: string
comments: string
customFields:
string: string
description: string
deviceInterfaceId: 0
macAddress: string
ownerId: 0
tags:
- string
virtualMachineInterfaceId: 0
MacAddress 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 MacAddress resource accepts the following input properties:
- Mac
Address string - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- Assigned
Object doubleId - Id of the interface the address is assigned to (see assignedobjecttype).
- Assigned
Object stringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- Comments string
- Custom
Fields 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
- Device
Interface doubleId - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- Owner
Id double - Id of the owner the object is assigned to.
- List<string>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- Virtual
Machine doubleInterface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- Mac
Address string - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- Assigned
Object float64Id - Id of the interface the address is assigned to (see assignedobjecttype).
- Assigned
Object stringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- Comments string
- Custom
Fields 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
- Device
Interface float64Id - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- Owner
Id float64 - Id of the owner the object is assigned to.
- []string
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- Virtual
Machine float64Interface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- mac_
address string - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- assigned_
object_ numberid - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned_
object_ stringtype - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments 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_
interface_ numberid - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- owner_
id number - Id of the owner the object is assigned to.
- list(string)
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- virtual_
machine_ numberinterface_ id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- mac
Address String - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- assigned
Object DoubleId - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned
Object StringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments String
- custom
Fields 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
- device
Interface DoubleId - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- owner
Id Double - Id of the owner the object is assigned to.
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- virtual
Machine DoubleInterface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- mac
Address string - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- assigned
Object numberId - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned
Object stringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments string
- custom
Fields {[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
- device
Interface numberId - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- owner
Id number - Id of the owner the object is assigned to.
- string[]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- virtual
Machine numberInterface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- mac_
address str - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- assigned_
object_ floatid - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned_
object_ strtype - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments 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_
interface_ floatid - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- owner_
id float - Id of the owner the object is assigned to.
- Sequence[str]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- virtual_
machine_ floatinterface_ id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- mac
Address String - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- assigned
Object NumberId - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned
Object StringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments 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
Interface NumberId - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- owner
Id Number - Id of the owner the object is assigned to.
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- virtual
Machine NumberInterface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
Outputs
All input properties are implicitly available as output properties. Additionally, the MacAddress resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated string - Mac
Address doubleId - NetBox id.
- List<string>
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated string - Mac
Address float64Id - NetBox id.
- []string
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- id string
- The provider-assigned unique ID for this managed resource.
- last_
updated string - mac_
address_ numberid - NetBox id.
- list(string)
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated String - mac
Address DoubleId - NetBox id.
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
- id string
- The provider-assigned unique ID for this managed resource.
- last
Updated string - mac
Address numberId - NetBox id.
- string[]
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- id str
- The provider-assigned unique ID for this managed resource.
- last_
updated str - mac_
address_ floatid - NetBox id.
- Sequence[str]
- Slugs of all tags on the object, including the provider's default_tags.
- url str
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated String - mac
Address NumberId - NetBox id.
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
Look up Existing MacAddress Resource
Get an existing MacAddress 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?: MacAddressState, opts?: CustomResourceOptions): MacAddress@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
assigned_object_id: Optional[float] = None,
assigned_object_type: Optional[str] = None,
comments: Optional[str] = None,
custom_fields: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
device_interface_id: Optional[float] = None,
last_updated: Optional[str] = None,
mac_address: Optional[str] = None,
mac_address_id: Optional[float] = None,
owner_id: Optional[float] = None,
tags: Optional[Sequence[str]] = None,
tags_alls: Optional[Sequence[str]] = None,
url: Optional[str] = None,
virtual_machine_interface_id: Optional[float] = None) -> MacAddressfunc GetMacAddress(ctx *Context, name string, id IDInput, state *MacAddressState, opts ...ResourceOption) (*MacAddress, error)public static MacAddress Get(string name, Input<string> id, MacAddressState? state, CustomResourceOptions? opts = null)public static MacAddress get(String name, Output<String> id, MacAddressState state, CustomResourceOptions options)resources: _: type: netbox:MacAddress get: id: ${id}import {
to = netbox_mac_address.example
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.
- Assigned
Object doubleId - Id of the interface the address is assigned to (see assignedobjecttype).
- Assigned
Object stringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- Comments string
- Custom
Fields 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
- Device
Interface doubleId - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- Last
Updated string - Mac
Address string - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- Mac
Address doubleId - NetBox id.
- Owner
Id double - Id of the owner the object is assigned to.
- List<string>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- List<string>
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- Virtual
Machine doubleInterface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- Assigned
Object float64Id - Id of the interface the address is assigned to (see assignedobjecttype).
- Assigned
Object stringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- Comments string
- Custom
Fields 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
- Device
Interface float64Id - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- Last
Updated string - Mac
Address string - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- Mac
Address float64Id - NetBox id.
- Owner
Id float64 - Id of the owner the object is assigned to.
- []string
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- []string
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- Virtual
Machine float64Interface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- assigned_
object_ numberid - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned_
object_ stringtype - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments 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_
interface_ numberid - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- last_
updated string - mac_
address string - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- mac_
address_ numberid - NetBox id.
- owner_
id number - Id of the owner the object is assigned to.
- list(string)
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- list(string)
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- virtual_
machine_ numberinterface_ id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- assigned
Object DoubleId - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned
Object StringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments String
- custom
Fields 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
- device
Interface DoubleId - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- last
Updated String - mac
Address String - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- mac
Address DoubleId - NetBox id.
- owner
Id Double - Id of the owner the object is assigned to.
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
- virtual
Machine DoubleInterface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- assigned
Object numberId - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned
Object stringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments string
- custom
Fields {[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
- device
Interface numberId - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- last
Updated string - mac
Address string - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- mac
Address numberId - NetBox id.
- owner
Id number - Id of the owner the object is assigned to.
- string[]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- string[]
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- virtual
Machine numberInterface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- assigned_
object_ floatid - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned_
object_ strtype - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments 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_
interface_ floatid - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- last_
updated str - mac_
address str - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- mac_
address_ floatid - NetBox id.
- owner_
id float - Id of the owner the object is assigned to.
- Sequence[str]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- Sequence[str]
- Slugs of all tags on the object, including the provider's default_tags.
- url str
- virtual_
machine_ floatinterface_ id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
- assigned
Object NumberId - Id of the interface the address is assigned to (see assignedobjecttype).
- assigned
Object StringType - Content type of the interface the address is assigned to. Derived from deviceinterfaceid or virtualmachineinterface_id when one of those is set. One of: dcim.interface, virtualization.vminterface.
- comments 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
Interface NumberId - Id of the device interface the address is assigned to (assignedobjecttype dcim.interface). Conflicts with virtualmachineinterfaceid and with setting the assignedobject_* pair directly.
- last
Updated String - mac
Address String - The MAC address (EUI-48) in colon, dash or dot notation, any case; the configured spelling is kept in state (NetBox stores it colon-separated and uppercased).
- mac
Address NumberId - NetBox id.
- owner
Id Number - Id of the owner the object is assigned to.
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
- virtual
Machine NumberInterface Id - Id of the virtual machine interface the address is assigned to (assignedobjecttype virtualization.vminterface). Conflicts with deviceinterfaceid and with setting the assigned*object** pair directly.
Import
In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:
terraform
import {
to = netbox_mac_address.test
id = “123”
}
The pulumi import command can be used, for example:
$ pulumi import netbox:index/macAddress:MacAddress test 123
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- netbox e-breuninger/terraform-provider-netbox
- License
- Notes
- This Pulumi package is based on the
netboxTerraform Provider.
published on Wednesday, Nov 4, 2026 by e-breuninger