published on Wednesday, Jul 15, 2026 by e-breuninger
published on Wednesday, Jul 15, 2026 by e-breuninger
This resource is used to define the out-of-band (OOB) IP for a given device. Modelled as a separate resource (like netbox.DevicePrimaryIp) to avoid a dependency cycle between the device and an IP address assigned to one of its own interfaces.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
// Note that some terraform code is not included in the example for brevity
const test = new netbox.Device("test", {
name: "%[1]s",
deviceTypeId: testNetboxDeviceType.id,
roleId: testNetboxDeviceRole.id,
siteId: testNetboxSite.id,
});
const oob = new netbox.IpAddress("oob", {
ipAddress: "10.0.0.5/24",
status: "active",
deviceInterfaceId: testNetboxDeviceInterface.id,
});
const testDeviceOobIp = new netbox.DeviceOobIp("test", {
deviceId: test.deviceId,
ipAddressId: oob.ipAddressId,
});
import pulumi
import pulumi_netbox as netbox
# Note that some terraform code is not included in the example for brevity
test = netbox.Device("test",
name="%[1]s",
device_type_id=test_netbox_device_type["id"],
role_id=test_netbox_device_role["id"],
site_id=test_netbox_site["id"])
oob = netbox.IpAddress("oob",
ip_address="10.0.0.5/24",
status="active",
device_interface_id=test_netbox_device_interface["id"])
test_device_oob_ip = netbox.DeviceOobIp("test",
device_id=test.device_id,
ip_address_id=oob.ip_address_id)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v5/netbox"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Note that some terraform code is not included in the example for brevity
test, err := netbox.NewDevice(ctx, "test", &netbox.DeviceArgs{
Name: pulumi.String("%[1]s"),
DeviceTypeId: pulumi.Any(testNetboxDeviceType.Id),
RoleId: pulumi.Any(testNetboxDeviceRole.Id),
SiteId: pulumi.Any(testNetboxSite.Id),
})
if err != nil {
return err
}
oob, err := netbox.NewIpAddress(ctx, "oob", &netbox.IpAddressArgs{
IpAddress: pulumi.String("10.0.0.5/24"),
Status: pulumi.String("active"),
DeviceInterfaceId: pulumi.Any(testNetboxDeviceInterface.Id),
})
if err != nil {
return err
}
_, err = netbox.NewDeviceOobIp(ctx, "test", &netbox.DeviceOobIpArgs{
DeviceId: test.DeviceId,
IpAddressId: oob.IpAddressId,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;
return await Deployment.RunAsync(() =>
{
// Note that some terraform code is not included in the example for brevity
var test = new Netbox.Device("test", new()
{
Name = "%[1]s",
DeviceTypeId = testNetboxDeviceType.Id,
RoleId = testNetboxDeviceRole.Id,
SiteId = testNetboxSite.Id,
});
var oob = new Netbox.IpAddress("oob", new()
{
IpAddress = "10.0.0.5/24",
Status = "active",
DeviceInterfaceId = testNetboxDeviceInterface.Id,
});
var testDeviceOobIp = new Netbox.DeviceOobIp("test", new()
{
DeviceId = test.DeviceId,
IpAddressId = oob.IpAddressId,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.Device;
import com.pulumi.netbox.DeviceArgs;
import com.pulumi.netbox.IpAddress;
import com.pulumi.netbox.IpAddressArgs;
import com.pulumi.netbox.DeviceOobIp;
import com.pulumi.netbox.DeviceOobIpArgs;
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) {
// Note that some terraform code is not included in the example for brevity
var test = new Device("test", DeviceArgs.builder()
.name("%[1]s")
.deviceTypeId(testNetboxDeviceType.id())
.roleId(testNetboxDeviceRole.id())
.siteId(testNetboxSite.id())
.build());
var oob = new IpAddress("oob", IpAddressArgs.builder()
.ipAddress("10.0.0.5/24")
.status("active")
.deviceInterfaceId(testNetboxDeviceInterface.id())
.build());
var testDeviceOobIp = new DeviceOobIp("testDeviceOobIp", DeviceOobIpArgs.builder()
.deviceId(test.deviceId())
.ipAddressId(oob.ipAddressId())
.build());
}
}
resources:
# Note that some terraform code is not included in the example for brevity
test:
type: netbox:Device
properties:
name: '%[1]s'
deviceTypeId: ${testNetboxDeviceType.id}
roleId: ${testNetboxDeviceRole.id}
siteId: ${testNetboxSite.id}
oob:
type: netbox:IpAddress
properties:
ipAddress: 10.0.0.5/24
status: active
deviceInterfaceId: ${testNetboxDeviceInterface.id}
testDeviceOobIp:
type: netbox:DeviceOobIp
name: test
properties:
deviceId: ${test.deviceId}
ipAddressId: ${oob.ipAddressId}
Example coming soon!
Create DeviceOobIp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DeviceOobIp(name: string, args: DeviceOobIpArgs, opts?: CustomResourceOptions);@overload
def DeviceOobIp(resource_name: str,
args: DeviceOobIpArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DeviceOobIp(resource_name: str,
opts: Optional[ResourceOptions] = None,
device_id: Optional[float] = None,
ip_address_id: Optional[float] = None,
device_oob_ip_id: Optional[str] = None)func NewDeviceOobIp(ctx *Context, name string, args DeviceOobIpArgs, opts ...ResourceOption) (*DeviceOobIp, error)public DeviceOobIp(string name, DeviceOobIpArgs args, CustomResourceOptions? opts = null)
public DeviceOobIp(String name, DeviceOobIpArgs args)
public DeviceOobIp(String name, DeviceOobIpArgs args, CustomResourceOptions options)
type: netbox:DeviceOobIp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "netbox_device_oob_ip" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args DeviceOobIpArgs
- 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 DeviceOobIpArgs
- 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 DeviceOobIpArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeviceOobIpArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeviceOobIpArgs
- 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 deviceOobIpResource = new Netbox.DeviceOobIp("deviceOobIpResource", new()
{
DeviceId = 0,
IpAddressId = 0,
DeviceOobIpId = "string",
});
example, err := netbox.NewDeviceOobIp(ctx, "deviceOobIpResource", &netbox.DeviceOobIpArgs{
DeviceId: pulumi.Float64(0),
IpAddressId: pulumi.Float64(0),
DeviceOobIpId: pulumi.String("string"),
})
resource "netbox_device_oob_ip" "deviceOobIpResource" {
lifecycle {
create_before_destroy = true
}
device_id = 0
ip_address_id = 0
device_oob_ip_id = "string"
}
var deviceOobIpResource = new DeviceOobIp("deviceOobIpResource", DeviceOobIpArgs.builder()
.deviceId(0.0)
.ipAddressId(0.0)
.deviceOobIpId("string")
.build());
device_oob_ip_resource = netbox.DeviceOobIp("deviceOobIpResource",
device_id=float(0),
ip_address_id=float(0),
device_oob_ip_id="string")
const deviceOobIpResource = new netbox.DeviceOobIp("deviceOobIpResource", {
deviceId: 0,
ipAddressId: 0,
deviceOobIpId: "string",
});
type: netbox:DeviceOobIp
properties:
deviceId: 0
deviceOobIpId: string
ipAddressId: 0
DeviceOobIp 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 DeviceOobIp resource accepts the following input properties:
- Device
Id double - Ip
Address doubleId - Device
Oob stringIp Id - The ID of this resource.
- Device
Id float64 - Ip
Address float64Id - Device
Oob stringIp Id - The ID of this resource.
- device_
id number - ip_
address_ numberid - device_
oob_ stringip_ id - The ID of this resource.
- device
Id Double - ip
Address DoubleId - device
Oob StringIp Id - The ID of this resource.
- device
Id number - ip
Address numberId - device
Oob stringIp Id - The ID of this resource.
- device_
id float - ip_
address_ floatid - device_
oob_ strip_ id - The ID of this resource.
- device
Id Number - ip
Address NumberId - device
Oob StringIp Id - The ID of this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the DeviceOobIp resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing DeviceOobIp Resource
Get an existing DeviceOobIp 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?: DeviceOobIpState, opts?: CustomResourceOptions): DeviceOobIp@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
device_id: Optional[float] = None,
device_oob_ip_id: Optional[str] = None,
ip_address_id: Optional[float] = None) -> DeviceOobIpfunc GetDeviceOobIp(ctx *Context, name string, id IDInput, state *DeviceOobIpState, opts ...ResourceOption) (*DeviceOobIp, error)public static DeviceOobIp Get(string name, Input<string> id, DeviceOobIpState? state, CustomResourceOptions? opts = null)public static DeviceOobIp get(String name, Output<String> id, DeviceOobIpState state, CustomResourceOptions options)resources: _: type: netbox:DeviceOobIp get: id: ${id}import {
to = netbox_device_oob_ip.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.
- Device
Id double - Device
Oob stringIp Id - The ID of this resource.
- Ip
Address doubleId
- Device
Id float64 - Device
Oob stringIp Id - The ID of this resource.
- Ip
Address float64Id
- device_
id number - device_
oob_ stringip_ id - The ID of this resource.
- ip_
address_ numberid
- device
Id Double - device
Oob StringIp Id - The ID of this resource.
- ip
Address DoubleId
- device
Id number - device
Oob stringIp Id - The ID of this resource.
- ip
Address numberId
- device_
id float - device_
oob_ strip_ id - The ID of this resource.
- ip_
address_ floatid
- device
Id Number - device
Oob StringIp Id - The ID of this resource.
- ip
Address NumberId
Package Details
- Repository
- netbox e-breuninger/terraform-provider-netbox
- License
- Notes
- This Pulumi package is based on the
netboxTerraform Provider.
published on Wednesday, Jul 15, 2026 by e-breuninger