published on Monday, Nov 16, 2026 by e-breuninger
published on Monday, Nov 16, 2026 by e-breuninger
A virtual machine (virtualization.virtualmachine).
From the official documentation:
A virtual machine is a virtualized compute instance. These behave in NetBox very similarly to device objects, but without any physical attributes. For example, a VM may have interfaces assigned to it with IP addresses and VLANs, however its interfaces cannot be connected via cables (because they are virtual). Each VM may also define its compute, memory, and storage resources as well.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = netbox.getVirtualMachine({
name: "test-virtual_machine",
});
import pulumi
import pulumi_netbox as netbox
test = netbox.get_virtual_machine(name="test-virtual_machine")
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.LookupVirtualMachine(ctx, &netbox.LookupVirtualMachineArgs{
Name: pulumi.StringRef("test-virtual_machine"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;
return await Deployment.RunAsync(() =>
{
var test = Netbox.GetVirtualMachine.Invoke(new()
{
Name = "test-virtual_machine",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.NetboxFunctions;
import com.pulumi.netbox.inputs.GetVirtualMachineArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var test = NetboxFunctions.getVirtualMachine(GetVirtualMachineArgs.builder()
.name("test-virtual_machine")
.build());
}
}
variables:
test:
fn::invoke:
function: netbox:getVirtualMachine
arguments:
name: test-virtual_machine
Example coming soon!
Using getVirtualMachine
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getVirtualMachine(args: GetVirtualMachineArgs, opts?: InvokeOptions): Promise<GetVirtualMachineResult>
function getVirtualMachineOutput(args: GetVirtualMachineOutputArgs, opts?: InvokeOutputOptions): Output<GetVirtualMachineResult>def get_virtual_machine(cluster: Optional[str] = None,
cluster_group_id: Optional[float] = None,
cluster_group_slug: Optional[str] = None,
cluster_id: Optional[float] = None,
cluster_type_id: Optional[float] = None,
cluster_type_slug: Optional[str] = None,
config_template_id: Optional[float] = None,
contact: Optional[float] = None,
contact_group_slug: Optional[str] = None,
contact_role: Optional[float] = None,
created: Optional[str] = None,
custom_field_filters: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
device_id: Optional[float] = None,
device_name: Optional[str] = None,
disk: Optional[float] = None,
has_local_context_data: Optional[bool] = None,
has_primary_ip: Optional[bool] = None,
id: Optional[float] = None,
interface_count: Optional[float] = None,
last_updated: Optional[str] = None,
mac_address: Optional[str] = None,
memory: Optional[float] = None,
name: Optional[str] = None,
owner_group_id: Optional[float] = None,
owner_group_name: Optional[str] = None,
owner_id: Optional[float] = None,
owner_name: Optional[str] = None,
platform_id: Optional[float] = None,
platform_slug: Optional[str] = None,
primary_ip4: Optional[str] = None,
primary_ip4_id: Optional[float] = None,
primary_ip6: Optional[str] = None,
primary_ip6_id: Optional[float] = None,
q: Optional[str] = None,
region_id: Optional[str] = None,
region_slug: Optional[str] = None,
role_id: Optional[float] = None,
role_slug: Optional[str] = None,
serial: Optional[str] = None,
site_group_id: Optional[str] = None,
site_group_slug: Optional[str] = None,
site_id: Optional[float] = None,
site_slug: Optional[str] = None,
start_on_boot: Optional[str] = None,
status: Optional[str] = None,
tag_id: Optional[float] = None,
tag_slug: Optional[str] = None,
tenant_group_id: Optional[str] = None,
tenant_group_slug: Optional[str] = None,
tenant_id: Optional[float] = None,
tenant_slug: Optional[str] = None,
vcpus: Optional[float] = None,
virtual_disk_count: Optional[float] = None,
virtual_machine_type_id: Optional[float] = None,
virtual_machine_type_slug: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVirtualMachineResult
def get_virtual_machine_output(cluster: pulumi.Input[Optional[str]] = None,
cluster_group_id: pulumi.Input[Optional[float]] = None,
cluster_group_slug: pulumi.Input[Optional[str]] = None,
cluster_id: pulumi.Input[Optional[float]] = None,
cluster_type_id: pulumi.Input[Optional[float]] = None,
cluster_type_slug: pulumi.Input[Optional[str]] = None,
config_template_id: pulumi.Input[Optional[float]] = None,
contact: pulumi.Input[Optional[float]] = None,
contact_group_slug: pulumi.Input[Optional[str]] = None,
contact_role: pulumi.Input[Optional[float]] = None,
created: pulumi.Input[Optional[str]] = None,
custom_field_filters: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
description: pulumi.Input[Optional[str]] = None,
device_id: pulumi.Input[Optional[float]] = None,
device_name: pulumi.Input[Optional[str]] = None,
disk: pulumi.Input[Optional[float]] = None,
has_local_context_data: pulumi.Input[Optional[bool]] = None,
has_primary_ip: pulumi.Input[Optional[bool]] = None,
id: pulumi.Input[Optional[float]] = None,
interface_count: pulumi.Input[Optional[float]] = None,
last_updated: pulumi.Input[Optional[str]] = None,
mac_address: pulumi.Input[Optional[str]] = None,
memory: pulumi.Input[Optional[float]] = None,
name: pulumi.Input[Optional[str]] = None,
owner_group_id: pulumi.Input[Optional[float]] = None,
owner_group_name: pulumi.Input[Optional[str]] = None,
owner_id: pulumi.Input[Optional[float]] = None,
owner_name: pulumi.Input[Optional[str]] = None,
platform_id: pulumi.Input[Optional[float]] = None,
platform_slug: pulumi.Input[Optional[str]] = None,
primary_ip4: pulumi.Input[Optional[str]] = None,
primary_ip4_id: pulumi.Input[Optional[float]] = None,
primary_ip6: pulumi.Input[Optional[str]] = None,
primary_ip6_id: pulumi.Input[Optional[float]] = None,
q: pulumi.Input[Optional[str]] = None,
region_id: pulumi.Input[Optional[str]] = None,
region_slug: pulumi.Input[Optional[str]] = None,
role_id: pulumi.Input[Optional[float]] = None,
role_slug: pulumi.Input[Optional[str]] = None,
serial: pulumi.Input[Optional[str]] = None,
site_group_id: pulumi.Input[Optional[str]] = None,
site_group_slug: pulumi.Input[Optional[str]] = None,
site_id: pulumi.Input[Optional[float]] = None,
site_slug: pulumi.Input[Optional[str]] = None,
start_on_boot: pulumi.Input[Optional[str]] = None,
status: pulumi.Input[Optional[str]] = None,
tag_id: pulumi.Input[Optional[float]] = None,
tag_slug: pulumi.Input[Optional[str]] = None,
tenant_group_id: pulumi.Input[Optional[str]] = None,
tenant_group_slug: pulumi.Input[Optional[str]] = None,
tenant_id: pulumi.Input[Optional[float]] = None,
tenant_slug: pulumi.Input[Optional[str]] = None,
vcpus: pulumi.Input[Optional[float]] = None,
virtual_disk_count: pulumi.Input[Optional[float]] = None,
virtual_machine_type_id: pulumi.Input[Optional[float]] = None,
virtual_machine_type_slug: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetVirtualMachineResult]func LookupVirtualMachine(ctx *Context, args *LookupVirtualMachineArgs, opts ...InvokeOption) (*LookupVirtualMachineResult, error)
func LookupVirtualMachineOutput(ctx *Context, args *LookupVirtualMachineOutputArgs, opts ...InvokeOption) LookupVirtualMachineResultOutput> Note: This function is named LookupVirtualMachine in the Go SDK.
public static class GetVirtualMachine
{
public static Task<GetVirtualMachineResult> InvokeAsync(GetVirtualMachineArgs args, InvokeOptions? opts = null)
public static Output<GetVirtualMachineResult> Invoke(GetVirtualMachineInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetVirtualMachineResult> Invoke(GetVirtualMachineInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOptions options)
public static Output<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOptions options)
public static Output<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOutputOptions options)
fn::invoke:
function: netbox:index/getVirtualMachine:getVirtualMachine
arguments:
# arguments dictionarydata "netbox_get_virtual_machine" "name" {
# arguments
}The following arguments are supported:
- Cluster string
- Cluster.
- Cluster
Group doubleId - Id of the cluster group.
- Cluster
Group stringSlug - Slug of the cluster group.
- Cluster
Id double - Id of the cluster (a virtual machine needs a cluster or a site).
- Cluster
Type doubleId - Id of the cluster type.
- Cluster
Type stringSlug - Slug of the cluster type.
- Config
Template doubleId - Id of the config template.
- Contact double
- Id of the contact.
- Contact
Group stringSlug - Slug of the contact group.
- Contact
Role double - Id of the contact role.
- Created string
- Custom
Field Dictionary<string, string>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- Description string
- Device
Id double - Id of the device hosting the VM.
- Device
Name string - Name of the device hosting the virtual machine.
- Disk double
- Disk to match.
- Has
Local boolContext Data - Whether the object has local config context data.
- Has
Primary boolIp - Has a primary IP.
- Id double
- NetBox id.
- Interface
Count double - Number of interfaces on the virtual machine.
- Last
Updated string - Mac
Address string - Mac address to match.
- Memory double
- Memory to match.
- Name string
- Owner
Group doubleId - Id of the owner group.
- Owner
Group stringName - Name of the owner group.
- Owner
Id double - Id of the owner the object is assigned to.
- Owner
Name string - Name of the owner.
- Platform
Id double - Id of the platform.
- Platform
Slug string - Slug of the platform.
- Primary
Ip4 string - Primary IPv4 (address).
- Primary
Ip4Id double - Id of the primary IPv4 address (managed by netboxprimaryip).
- Primary
Ip6 string - Primary IPv6 (address).
- Primary
Ip6Id double - Id of the primary IPv6 address (managed by netboxprimaryip).
- Q string
- Search term, matched against the fields NetBox searches for this object type.
- Region
Id string - Id of the region.
- Region
Slug string - Slug of the region of the site.
- Role
Id double - Id of the functional device role.
- Role
Slug string - Slug of the role.
- Serial string
- Serial number.
- Site
Group stringId - Id of the site group.
- Site
Group stringSlug - Slug of the site group.
- Site
Id double - Id of the site (a virtual machine needs a cluster or a site).
- Site
Slug string - Slug of the site.
- Start
On stringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- Status string
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- Tag
Id double - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- Tenant
Group stringId - Id of the tenant group.
- Tenant
Group stringSlug - Slug of the tenant group.
- Tenant
Id double - Id of the tenant.
- Tenant
Slug string - Slug of the tenant.
- Vcpus double
- Number of virtual CPUs (fractions allowed).
- Virtual
Disk doubleCount - Number of virtual disks on the virtual machine.
- Virtual
Machine doubleType Id - Id of the virtual machine type.
- Virtual
Machine stringType Slug - Slug of the virtual machine type.
- Cluster string
- Cluster.
- Cluster
Group float64Id - Id of the cluster group.
- Cluster
Group stringSlug - Slug of the cluster group.
- Cluster
Id float64 - Id of the cluster (a virtual machine needs a cluster or a site).
- Cluster
Type float64Id - Id of the cluster type.
- Cluster
Type stringSlug - Slug of the cluster type.
- Config
Template float64Id - Id of the config template.
- Contact float64
- Id of the contact.
- Contact
Group stringSlug - Slug of the contact group.
- Contact
Role float64 - Id of the contact role.
- Created string
- Custom
Field map[string]stringFilters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- Description string
- Device
Id float64 - Id of the device hosting the VM.
- Device
Name string - Name of the device hosting the virtual machine.
- Disk float64
- Disk to match.
- Has
Local boolContext Data - Whether the object has local config context data.
- Has
Primary boolIp - Has a primary IP.
- Id float64
- NetBox id.
- Interface
Count float64 - Number of interfaces on the virtual machine.
- Last
Updated string - Mac
Address string - Mac address to match.
- Memory float64
- Memory to match.
- Name string
- Owner
Group float64Id - Id of the owner group.
- Owner
Group stringName - Name of the owner group.
- Owner
Id float64 - Id of the owner the object is assigned to.
- Owner
Name string - Name of the owner.
- Platform
Id float64 - Id of the platform.
- Platform
Slug string - Slug of the platform.
- Primary
Ip4 string - Primary IPv4 (address).
- Primary
Ip4Id float64 - Id of the primary IPv4 address (managed by netboxprimaryip).
- Primary
Ip6 string - Primary IPv6 (address).
- Primary
Ip6Id float64 - Id of the primary IPv6 address (managed by netboxprimaryip).
- Q string
- Search term, matched against the fields NetBox searches for this object type.
- Region
Id string - Id of the region.
- Region
Slug string - Slug of the region of the site.
- Role
Id float64 - Id of the functional device role.
- Role
Slug string - Slug of the role.
- Serial string
- Serial number.
- Site
Group stringId - Id of the site group.
- Site
Group stringSlug - Slug of the site group.
- Site
Id float64 - Id of the site (a virtual machine needs a cluster or a site).
- Site
Slug string - Slug of the site.
- Start
On stringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- Status string
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- Tag
Id float64 - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- Tenant
Group stringId - Id of the tenant group.
- Tenant
Group stringSlug - Slug of the tenant group.
- Tenant
Id float64 - Id of the tenant.
- Tenant
Slug string - Slug of the tenant.
- Vcpus float64
- Number of virtual CPUs (fractions allowed).
- Virtual
Disk float64Count - Number of virtual disks on the virtual machine.
- Virtual
Machine float64Type Id - Id of the virtual machine type.
- Virtual
Machine stringType Slug - Slug of the virtual machine type.
- cluster string
- Cluster.
- cluster_
group_ numberid - Id of the cluster group.
- cluster_
group_ stringslug - Slug of the cluster group.
- cluster_
id number - Id of the cluster (a virtual machine needs a cluster or a site).
- cluster_
type_ numberid - Id of the cluster type.
- cluster_
type_ stringslug - Slug of the cluster type.
- config_
template_ numberid - Id of the config template.
- contact number
- Id of the contact.
- contact_
group_ stringslug - Slug of the contact group.
- contact_
role number - Id of the contact role.
- created string
- custom_
field_ map(string)filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description string
- device_
id number - Id of the device hosting the VM.
- device_
name string - Name of the device hosting the virtual machine.
- disk number
- Disk to match.
- has_
local_ boolcontext_ data - Whether the object has local config context data.
- has_
primary_ boolip - Has a primary IP.
- id number
- NetBox id.
- interface_
count number - Number of interfaces on the virtual machine.
- last_
updated string - mac_
address string - Mac address to match.
- memory number
- Memory to match.
- name string
- owner_
group_ numberid - Id of the owner group.
- owner_
group_ stringname - Name of the owner group.
- owner_
id number - Id of the owner the object is assigned to.
- owner_
name string - Name of the owner.
- platform_
id number - Id of the platform.
- platform_
slug string - Slug of the platform.
- primary_
ip4 string - Primary IPv4 (address).
- primary_
ip4_ numberid - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary_
ip6 string - Primary IPv6 (address).
- primary_
ip6_ numberid - Id of the primary IPv6 address (managed by netboxprimaryip).
- q string
- Search term, matched against the fields NetBox searches for this object type.
- region_
id string - Id of the region.
- region_
slug string - Slug of the region of the site.
- role_
id number - Id of the functional device role.
- role_
slug string - Slug of the role.
- serial string
- Serial number.
- site_
group_ stringid - Id of the site group.
- site_
group_ stringslug - Slug of the site group.
- site_
id number - Id of the site (a virtual machine needs a cluster or a site).
- site_
slug string - Slug of the site.
- start_
on_ stringboot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status string
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- tag_
id number - Id of a tag the object carries.
- tag_
slug string - Slug of a tag the object carries.
- tenant_
group_ stringid - Id of the tenant group.
- tenant_
group_ stringslug - Slug of the tenant group.
- tenant_
id number - Id of the tenant.
- tenant_
slug string - Slug of the tenant.
- vcpus number
- Number of virtual CPUs (fractions allowed).
- virtual_
disk_ numbercount - Number of virtual disks on the virtual machine.
- virtual_
machine_ numbertype_ id - Id of the virtual machine type.
- virtual_
machine_ stringtype_ slug - Slug of the virtual machine type.
- cluster String
- Cluster.
- cluster
Group DoubleId - Id of the cluster group.
- cluster
Group StringSlug - Slug of the cluster group.
- cluster
Id Double - Id of the cluster (a virtual machine needs a cluster or a site).
- cluster
Type DoubleId - Id of the cluster type.
- cluster
Type StringSlug - Slug of the cluster type.
- config
Template DoubleId - Id of the config template.
- contact Double
- Id of the contact.
- contact
Group StringSlug - Slug of the contact group.
- contact
Role Double - Id of the contact role.
- created String
- custom
Field Map<String,String>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description String
- device
Id Double - Id of the device hosting the VM.
- device
Name String - Name of the device hosting the virtual machine.
- disk Double
- Disk to match.
- has
Local BooleanContext Data - Whether the object has local config context data.
- has
Primary BooleanIp - Has a primary IP.
- id Double
- NetBox id.
- interface
Count Double - Number of interfaces on the virtual machine.
- last
Updated String - mac
Address String - Mac address to match.
- memory Double
- Memory to match.
- name String
- owner
Group DoubleId - Id of the owner group.
- owner
Group StringName - Name of the owner group.
- owner
Id Double - Id of the owner the object is assigned to.
- owner
Name String - Name of the owner.
- platform
Id Double - Id of the platform.
- platform
Slug String - Slug of the platform.
- primary
Ip4 String - Primary IPv4 (address).
- primary
Ip4Id Double - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary
Ip6 String - Primary IPv6 (address).
- primary
Ip6Id Double - Id of the primary IPv6 address (managed by netboxprimaryip).
- q String
- Search term, matched against the fields NetBox searches for this object type.
- region
Id String - Id of the region.
- region
Slug String - Slug of the region of the site.
- role
Id Double - Id of the functional device role.
- role
Slug String - Slug of the role.
- serial String
- Serial number.
- site
Group StringId - Id of the site group.
- site
Group StringSlug - Slug of the site group.
- site
Id Double - Id of the site (a virtual machine needs a cluster or a site).
- site
Slug String - Slug of the site.
- start
On StringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status String
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- tag
Id Double - Id of a tag the object carries.
- String
- Slug of a tag the object carries.
- tenant
Group StringId - Id of the tenant group.
- tenant
Group StringSlug - Slug of the tenant group.
- tenant
Id Double - Id of the tenant.
- tenant
Slug String - Slug of the tenant.
- vcpus Double
- Number of virtual CPUs (fractions allowed).
- virtual
Disk DoubleCount - Number of virtual disks on the virtual machine.
- virtual
Machine DoubleType Id - Id of the virtual machine type.
- virtual
Machine StringType Slug - Slug of the virtual machine type.
- cluster string
- Cluster.
- cluster
Group numberId - Id of the cluster group.
- cluster
Group stringSlug - Slug of the cluster group.
- cluster
Id number - Id of the cluster (a virtual machine needs a cluster or a site).
- cluster
Type numberId - Id of the cluster type.
- cluster
Type stringSlug - Slug of the cluster type.
- config
Template numberId - Id of the config template.
- contact number
- Id of the contact.
- contact
Group stringSlug - Slug of the contact group.
- contact
Role number - Id of the contact role.
- created string
- custom
Field {[key: string]: string}Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description string
- device
Id number - Id of the device hosting the VM.
- device
Name string - Name of the device hosting the virtual machine.
- disk number
- Disk to match.
- has
Local booleanContext Data - Whether the object has local config context data.
- has
Primary booleanIp - Has a primary IP.
- id number
- NetBox id.
- interface
Count number - Number of interfaces on the virtual machine.
- last
Updated string - mac
Address string - Mac address to match.
- memory number
- Memory to match.
- name string
- owner
Group numberId - Id of the owner group.
- owner
Group stringName - Name of the owner group.
- owner
Id number - Id of the owner the object is assigned to.
- owner
Name string - Name of the owner.
- platform
Id number - Id of the platform.
- platform
Slug string - Slug of the platform.
- primary
Ip4 string - Primary IPv4 (address).
- primary
Ip4Id number - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary
Ip6 string - Primary IPv6 (address).
- primary
Ip6Id number - Id of the primary IPv6 address (managed by netboxprimaryip).
- q string
- Search term, matched against the fields NetBox searches for this object type.
- region
Id string - Id of the region.
- region
Slug string - Slug of the region of the site.
- role
Id number - Id of the functional device role.
- role
Slug string - Slug of the role.
- serial string
- Serial number.
- site
Group stringId - Id of the site group.
- site
Group stringSlug - Slug of the site group.
- site
Id number - Id of the site (a virtual machine needs a cluster or a site).
- site
Slug string - Slug of the site.
- start
On stringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status string
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- tag
Id number - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- tenant
Group stringId - Id of the tenant group.
- tenant
Group stringSlug - Slug of the tenant group.
- tenant
Id number - Id of the tenant.
- tenant
Slug string - Slug of the tenant.
- vcpus number
- Number of virtual CPUs (fractions allowed).
- virtual
Disk numberCount - Number of virtual disks on the virtual machine.
- virtual
Machine numberType Id - Id of the virtual machine type.
- virtual
Machine stringType Slug - Slug of the virtual machine type.
- cluster str
- Cluster.
- cluster_
group_ floatid - Id of the cluster group.
- cluster_
group_ strslug - Slug of the cluster group.
- cluster_
id float - Id of the cluster (a virtual machine needs a cluster or a site).
- cluster_
type_ floatid - Id of the cluster type.
- cluster_
type_ strslug - Slug of the cluster type.
- config_
template_ floatid - Id of the config template.
- contact float
- Id of the contact.
- contact_
group_ strslug - Slug of the contact group.
- contact_
role float - Id of the contact role.
- created str
- custom_
field_ Mapping[str, str]filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description str
- device_
id float - Id of the device hosting the VM.
- device_
name str - Name of the device hosting the virtual machine.
- disk float
- Disk to match.
- has_
local_ boolcontext_ data - Whether the object has local config context data.
- has_
primary_ boolip - Has a primary IP.
- id float
- NetBox id.
- interface_
count float - Number of interfaces on the virtual machine.
- last_
updated str - mac_
address str - Mac address to match.
- memory float
- Memory to match.
- name str
- owner_
group_ floatid - Id of the owner group.
- owner_
group_ strname - Name of the owner group.
- owner_
id float - Id of the owner the object is assigned to.
- owner_
name str - Name of the owner.
- platform_
id float - Id of the platform.
- platform_
slug str - Slug of the platform.
- primary_
ip4 str - Primary IPv4 (address).
- primary_
ip4_ floatid - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary_
ip6 str - Primary IPv6 (address).
- primary_
ip6_ floatid - Id of the primary IPv6 address (managed by netboxprimaryip).
- q str
- Search term, matched against the fields NetBox searches for this object type.
- region_
id str - Id of the region.
- region_
slug str - Slug of the region of the site.
- role_
id float - Id of the functional device role.
- role_
slug str - Slug of the role.
- serial str
- Serial number.
- site_
group_ strid - Id of the site group.
- site_
group_ strslug - Slug of the site group.
- site_
id float - Id of the site (a virtual machine needs a cluster or a site).
- site_
slug str - Slug of the site.
- start_
on_ strboot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status str
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- tag_
id float - Id of a tag the object carries.
- tag_
slug str - Slug of a tag the object carries.
- tenant_
group_ strid - Id of the tenant group.
- tenant_
group_ strslug - Slug of the tenant group.
- tenant_
id float - Id of the tenant.
- tenant_
slug str - Slug of the tenant.
- vcpus float
- Number of virtual CPUs (fractions allowed).
- virtual_
disk_ floatcount - Number of virtual disks on the virtual machine.
- virtual_
machine_ floattype_ id - Id of the virtual machine type.
- virtual_
machine_ strtype_ slug - Slug of the virtual machine type.
- cluster String
- Cluster.
- cluster
Group NumberId - Id of the cluster group.
- cluster
Group StringSlug - Slug of the cluster group.
- cluster
Id Number - Id of the cluster (a virtual machine needs a cluster or a site).
- cluster
Type NumberId - Id of the cluster type.
- cluster
Type StringSlug - Slug of the cluster type.
- config
Template NumberId - Id of the config template.
- contact Number
- Id of the contact.
- contact
Group StringSlug - Slug of the contact group.
- contact
Role Number - Id of the contact role.
- created String
- custom
Field Map<String>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description String
- device
Id Number - Id of the device hosting the VM.
- device
Name String - Name of the device hosting the virtual machine.
- disk Number
- Disk to match.
- has
Local BooleanContext Data - Whether the object has local config context data.
- has
Primary BooleanIp - Has a primary IP.
- id Number
- NetBox id.
- interface
Count Number - Number of interfaces on the virtual machine.
- last
Updated String - mac
Address String - Mac address to match.
- memory Number
- Memory to match.
- name String
- owner
Group NumberId - Id of the owner group.
- owner
Group StringName - Name of the owner group.
- owner
Id Number - Id of the owner the object is assigned to.
- owner
Name String - Name of the owner.
- platform
Id Number - Id of the platform.
- platform
Slug String - Slug of the platform.
- primary
Ip4 String - Primary IPv4 (address).
- primary
Ip4Id Number - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary
Ip6 String - Primary IPv6 (address).
- primary
Ip6Id Number - Id of the primary IPv6 address (managed by netboxprimaryip).
- q String
- Search term, matched against the fields NetBox searches for this object type.
- region
Id String - Id of the region.
- region
Slug String - Slug of the region of the site.
- role
Id Number - Id of the functional device role.
- role
Slug String - Slug of the role.
- serial String
- Serial number.
- site
Group StringId - Id of the site group.
- site
Group StringSlug - Slug of the site group.
- site
Id Number - Id of the site (a virtual machine needs a cluster or a site).
- site
Slug String - Slug of the site.
- start
On StringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status String
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- tag
Id Number - Id of a tag the object carries.
- String
- Slug of a tag the object carries.
- tenant
Group StringId - Id of the tenant group.
- tenant
Group StringSlug - Slug of the tenant group.
- tenant
Id Number - Id of the tenant.
- tenant
Slug String - Slug of the tenant.
- vcpus Number
- Number of virtual CPUs (fractions allowed).
- virtual
Disk NumberCount - Number of virtual disks on the virtual machine.
- virtual
Machine NumberType Id - Id of the virtual machine type.
- virtual
Machine StringType Slug - Slug of the virtual machine type.
getVirtualMachine Result
The following output properties are available:
- Cluster
Id double - Id of the cluster (a virtual machine needs a cluster or a site).
- Comments string
- Config
Context string - Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
- Config
Template doubleId - Id of the config template.
- Created 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
Id double - Id of the device hosting the VM.
- Disk
Size doubleMb - Disk size in MB. Once the machine has virtual disks NetBox computes it as their sum and it can no longer be set; leave it unset then. Must be a whole number.
- Id double
- NetBox id.
- Interface
Count double - Number of interfaces on the virtual machine.
- Last
Updated string - Local
Context stringData - Local config context data as JSON text (use jsonencode()).
- Memory
Mb double - Memory in MB. Must be a whole number.
- Name string
- Owner
Id double - Id of the owner the object is assigned to.
- Platform
Id double - Id of the platform.
- Primary
Ip4Id double - Id of the primary IPv4 address (managed by netboxprimaryip).
- Primary
Ip6Id double - Id of the primary IPv6 address (managed by netboxprimaryip).
- Role
Id double - Id of the functional device role.
- Serial string
- Serial number.
- Site
Id double - Id of the site (a virtual machine needs a cluster or a site).
- Start
On stringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- Status string
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- 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.
- Tenant
Id double - Id of the tenant.
- Url string
- Vcpus double
- Number of virtual CPUs (fractions allowed).
- Virtual
Disk doubleCount - Number of virtual disks on the virtual machine.
- Virtual
Machine doubleType Id - Id of the virtual machine type.
- Cluster string
- Cluster.
- Cluster
Group doubleId - Id of the cluster group.
- Cluster
Group stringSlug - Slug of the cluster group.
- Cluster
Type doubleId - Id of the cluster type.
- Cluster
Type stringSlug - Slug of the cluster type.
- Contact double
- Id of the contact.
- Contact
Group stringSlug - Slug of the contact group.
- Contact
Role double - Id of the contact role.
- Custom
Field Dictionary<string, string>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- Device
Name string - Name of the device hosting the virtual machine.
- Disk double
- Disk to match.
- Has
Local boolContext Data - Whether the object has local config context data.
- Has
Primary boolIp - Has a primary IP.
- Mac
Address string - Mac address to match.
- Memory double
- Memory to match.
- Owner
Group doubleId - Id of the owner group.
- Owner
Group stringName - Name of the owner group.
- Owner
Name string - Name of the owner.
- Platform
Slug string - Slug of the platform.
- Primary
Ip4 string - Primary IPv4 (address).
- Primary
Ip6 string - Primary IPv6 (address).
- Q string
- Search term, matched against the fields NetBox searches for this object type.
- Region
Id string - Id of the region.
- Region
Slug string - Slug of the region of the site.
- Role
Slug string - Slug of the role.
- Site
Group stringId - Id of the site group.
- Site
Group stringSlug - Slug of the site group.
- Site
Slug string - Slug of the site.
- Tag
Id double - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- Tenant
Group stringId - Id of the tenant group.
- Tenant
Group stringSlug - Slug of the tenant group.
- Tenant
Slug string - Slug of the tenant.
- Virtual
Machine stringType Slug - Slug of the virtual machine type.
- Cluster
Id float64 - Id of the cluster (a virtual machine needs a cluster or a site).
- Comments string
- Config
Context string - Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
- Config
Template float64Id - Id of the config template.
- Created 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
Id float64 - Id of the device hosting the VM.
- Disk
Size float64Mb - Disk size in MB. Once the machine has virtual disks NetBox computes it as their sum and it can no longer be set; leave it unset then. Must be a whole number.
- Id float64
- NetBox id.
- Interface
Count float64 - Number of interfaces on the virtual machine.
- Last
Updated string - Local
Context stringData - Local config context data as JSON text (use jsonencode()).
- Memory
Mb float64 - Memory in MB. Must be a whole number.
- Name string
- Owner
Id float64 - Id of the owner the object is assigned to.
- Platform
Id float64 - Id of the platform.
- Primary
Ip4Id float64 - Id of the primary IPv4 address (managed by netboxprimaryip).
- Primary
Ip6Id float64 - Id of the primary IPv6 address (managed by netboxprimaryip).
- Role
Id float64 - Id of the functional device role.
- Serial string
- Serial number.
- Site
Id float64 - Id of the site (a virtual machine needs a cluster or a site).
- Start
On stringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- Status string
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- []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.
- Tenant
Id float64 - Id of the tenant.
- Url string
- Vcpus float64
- Number of virtual CPUs (fractions allowed).
- Virtual
Disk float64Count - Number of virtual disks on the virtual machine.
- Virtual
Machine float64Type Id - Id of the virtual machine type.
- Cluster string
- Cluster.
- Cluster
Group float64Id - Id of the cluster group.
- Cluster
Group stringSlug - Slug of the cluster group.
- Cluster
Type float64Id - Id of the cluster type.
- Cluster
Type stringSlug - Slug of the cluster type.
- Contact float64
- Id of the contact.
- Contact
Group stringSlug - Slug of the contact group.
- Contact
Role float64 - Id of the contact role.
- Custom
Field map[string]stringFilters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- Device
Name string - Name of the device hosting the virtual machine.
- Disk float64
- Disk to match.
- Has
Local boolContext Data - Whether the object has local config context data.
- Has
Primary boolIp - Has a primary IP.
- Mac
Address string - Mac address to match.
- Memory float64
- Memory to match.
- Owner
Group float64Id - Id of the owner group.
- Owner
Group stringName - Name of the owner group.
- Owner
Name string - Name of the owner.
- Platform
Slug string - Slug of the platform.
- Primary
Ip4 string - Primary IPv4 (address).
- Primary
Ip6 string - Primary IPv6 (address).
- Q string
- Search term, matched against the fields NetBox searches for this object type.
- Region
Id string - Id of the region.
- Region
Slug string - Slug of the region of the site.
- Role
Slug string - Slug of the role.
- Site
Group stringId - Id of the site group.
- Site
Group stringSlug - Slug of the site group.
- Site
Slug string - Slug of the site.
- Tag
Id float64 - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- Tenant
Group stringId - Id of the tenant group.
- Tenant
Group stringSlug - Slug of the tenant group.
- Tenant
Slug string - Slug of the tenant.
- Virtual
Machine stringType Slug - Slug of the virtual machine type.
- cluster_
id number - Id of the cluster (a virtual machine needs a cluster or a site).
- comments string
- config_
context string - Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
- config_
template_ numberid - Id of the config template.
- created string
- custom_
fields map(string) - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description string
- device_
id number - Id of the device hosting the VM.
- disk_
size_ numbermb - Disk size in MB. Once the machine has virtual disks NetBox computes it as their sum and it can no longer be set; leave it unset then. Must be a whole number.
- id number
- NetBox id.
- interface_
count number - Number of interfaces on the virtual machine.
- last_
updated string - local_
context_ stringdata - Local config context data as JSON text (use jsonencode()).
- memory_
mb number - Memory in MB. Must be a whole number.
- name string
- owner_
id number - Id of the owner the object is assigned to.
- platform_
id number - Id of the platform.
- primary_
ip4_ numberid - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary_
ip6_ numberid - Id of the primary IPv6 address (managed by netboxprimaryip).
- role_
id number - Id of the functional device role.
- serial string
- Serial number.
- site_
id number - Id of the site (a virtual machine needs a cluster or a site).
- start_
on_ stringboot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status string
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- 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.
- tenant_
id number - Id of the tenant.
- url string
- vcpus number
- Number of virtual CPUs (fractions allowed).
- virtual_
disk_ numbercount - Number of virtual disks on the virtual machine.
- virtual_
machine_ numbertype_ id - Id of the virtual machine type.
- cluster string
- Cluster.
- cluster_
group_ numberid - Id of the cluster group.
- cluster_
group_ stringslug - Slug of the cluster group.
- cluster_
type_ numberid - Id of the cluster type.
- cluster_
type_ stringslug - Slug of the cluster type.
- contact number
- Id of the contact.
- contact_
group_ stringslug - Slug of the contact group.
- contact_
role number - Id of the contact role.
- custom_
field_ map(string)filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- device_
name string - Name of the device hosting the virtual machine.
- disk number
- Disk to match.
- has_
local_ boolcontext_ data - Whether the object has local config context data.
- has_
primary_ boolip - Has a primary IP.
- mac_
address string - Mac address to match.
- memory number
- Memory to match.
- owner_
group_ numberid - Id of the owner group.
- owner_
group_ stringname - Name of the owner group.
- owner_
name string - Name of the owner.
- platform_
slug string - Slug of the platform.
- primary_
ip4 string - Primary IPv4 (address).
- primary_
ip6 string - Primary IPv6 (address).
- q string
- Search term, matched against the fields NetBox searches for this object type.
- region_
id string - Id of the region.
- region_
slug string - Slug of the region of the site.
- role_
slug string - Slug of the role.
- site_
group_ stringid - Id of the site group.
- site_
group_ stringslug - Slug of the site group.
- site_
slug string - Slug of the site.
- tag_
id number - Id of a tag the object carries.
- tag_
slug string - Slug of a tag the object carries.
- tenant_
group_ stringid - Id of the tenant group.
- tenant_
group_ stringslug - Slug of the tenant group.
- tenant_
slug string - Slug of the tenant.
- virtual_
machine_ stringtype_ slug - Slug of the virtual machine type.
- cluster
Id Double - Id of the cluster (a virtual machine needs a cluster or a site).
- comments String
- config
Context String - Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
- config
Template DoubleId - Id of the config template.
- created 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
Id Double - Id of the device hosting the VM.
- disk
Size DoubleMb - Disk size in MB. Once the machine has virtual disks NetBox computes it as their sum and it can no longer be set; leave it unset then. Must be a whole number.
- id Double
- NetBox id.
- interface
Count Double - Number of interfaces on the virtual machine.
- last
Updated String - local
Context StringData - Local config context data as JSON text (use jsonencode()).
- memory
Mb Double - Memory in MB. Must be a whole number.
- name String
- owner
Id Double - Id of the owner the object is assigned to.
- platform
Id Double - Id of the platform.
- primary
Ip4Id Double - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary
Ip6Id Double - Id of the primary IPv6 address (managed by netboxprimaryip).
- role
Id Double - Id of the functional device role.
- serial String
- Serial number.
- site
Id Double - Id of the site (a virtual machine needs a cluster or a site).
- start
On StringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status String
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- 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.
- tenant
Id Double - Id of the tenant.
- url String
- vcpus Double
- Number of virtual CPUs (fractions allowed).
- virtual
Disk DoubleCount - Number of virtual disks on the virtual machine.
- virtual
Machine DoubleType Id - Id of the virtual machine type.
- cluster String
- Cluster.
- cluster
Group DoubleId - Id of the cluster group.
- cluster
Group StringSlug - Slug of the cluster group.
- cluster
Type DoubleId - Id of the cluster type.
- cluster
Type StringSlug - Slug of the cluster type.
- contact Double
- Id of the contact.
- contact
Group StringSlug - Slug of the contact group.
- contact
Role Double - Id of the contact role.
- custom
Field Map<String,String>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- device
Name String - Name of the device hosting the virtual machine.
- disk Double
- Disk to match.
- has
Local BooleanContext Data - Whether the object has local config context data.
- has
Primary BooleanIp - Has a primary IP.
- mac
Address String - Mac address to match.
- memory Double
- Memory to match.
- owner
Group DoubleId - Id of the owner group.
- owner
Group StringName - Name of the owner group.
- owner
Name String - Name of the owner.
- platform
Slug String - Slug of the platform.
- primary
Ip4 String - Primary IPv4 (address).
- primary
Ip6 String - Primary IPv6 (address).
- q String
- Search term, matched against the fields NetBox searches for this object type.
- region
Id String - Id of the region.
- region
Slug String - Slug of the region of the site.
- role
Slug String - Slug of the role.
- site
Group StringId - Id of the site group.
- site
Group StringSlug - Slug of the site group.
- site
Slug String - Slug of the site.
- tag
Id Double - Id of a tag the object carries.
- String
- Slug of a tag the object carries.
- tenant
Group StringId - Id of the tenant group.
- tenant
Group StringSlug - Slug of the tenant group.
- tenant
Slug String - Slug of the tenant.
- virtual
Machine StringType Slug - Slug of the virtual machine type.
- cluster
Id number - Id of the cluster (a virtual machine needs a cluster or a site).
- comments string
- config
Context string - Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
- config
Template numberId - Id of the config template.
- created 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
Id number - Id of the device hosting the VM.
- disk
Size numberMb - Disk size in MB. Once the machine has virtual disks NetBox computes it as their sum and it can no longer be set; leave it unset then. Must be a whole number.
- id number
- NetBox id.
- interface
Count number - Number of interfaces on the virtual machine.
- last
Updated string - local
Context stringData - Local config context data as JSON text (use jsonencode()).
- memory
Mb number - Memory in MB. Must be a whole number.
- name string
- owner
Id number - Id of the owner the object is assigned to.
- platform
Id number - Id of the platform.
- primary
Ip4Id number - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary
Ip6Id number - Id of the primary IPv6 address (managed by netboxprimaryip).
- role
Id number - Id of the functional device role.
- serial string
- Serial number.
- site
Id number - Id of the site (a virtual machine needs a cluster or a site).
- start
On stringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status string
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- 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.
- tenant
Id number - Id of the tenant.
- url string
- vcpus number
- Number of virtual CPUs (fractions allowed).
- virtual
Disk numberCount - Number of virtual disks on the virtual machine.
- virtual
Machine numberType Id - Id of the virtual machine type.
- cluster string
- Cluster.
- cluster
Group numberId - Id of the cluster group.
- cluster
Group stringSlug - Slug of the cluster group.
- cluster
Type numberId - Id of the cluster type.
- cluster
Type stringSlug - Slug of the cluster type.
- contact number
- Id of the contact.
- contact
Group stringSlug - Slug of the contact group.
- contact
Role number - Id of the contact role.
- custom
Field {[key: string]: string}Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- device
Name string - Name of the device hosting the virtual machine.
- disk number
- Disk to match.
- has
Local booleanContext Data - Whether the object has local config context data.
- has
Primary booleanIp - Has a primary IP.
- mac
Address string - Mac address to match.
- memory number
- Memory to match.
- owner
Group numberId - Id of the owner group.
- owner
Group stringName - Name of the owner group.
- owner
Name string - Name of the owner.
- platform
Slug string - Slug of the platform.
- primary
Ip4 string - Primary IPv4 (address).
- primary
Ip6 string - Primary IPv6 (address).
- q string
- Search term, matched against the fields NetBox searches for this object type.
- region
Id string - Id of the region.
- region
Slug string - Slug of the region of the site.
- role
Slug string - Slug of the role.
- site
Group stringId - Id of the site group.
- site
Group stringSlug - Slug of the site group.
- site
Slug string - Slug of the site.
- tag
Id number - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- tenant
Group stringId - Id of the tenant group.
- tenant
Group stringSlug - Slug of the tenant group.
- tenant
Slug string - Slug of the tenant.
- virtual
Machine stringType Slug - Slug of the virtual machine type.
- cluster_
id float - Id of the cluster (a virtual machine needs a cluster or a site).
- comments str
- config_
context str - Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
- config_
template_ floatid - Id of the config template.
- created str
- custom_
fields Mapping[str, str] - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description str
- device_
id float - Id of the device hosting the VM.
- disk_
size_ floatmb - Disk size in MB. Once the machine has virtual disks NetBox computes it as their sum and it can no longer be set; leave it unset then. Must be a whole number.
- id float
- NetBox id.
- interface_
count float - Number of interfaces on the virtual machine.
- last_
updated str - local_
context_ strdata - Local config context data as JSON text (use jsonencode()).
- memory_
mb float - Memory in MB. Must be a whole number.
- name str
- owner_
id float - Id of the owner the object is assigned to.
- platform_
id float - Id of the platform.
- primary_
ip4_ floatid - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary_
ip6_ floatid - Id of the primary IPv6 address (managed by netboxprimaryip).
- role_
id float - Id of the functional device role.
- serial str
- Serial number.
- site_
id float - Id of the site (a virtual machine needs a cluster or a site).
- start_
on_ strboot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status str
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- 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.
- tenant_
id float - Id of the tenant.
- url str
- vcpus float
- Number of virtual CPUs (fractions allowed).
- virtual_
disk_ floatcount - Number of virtual disks on the virtual machine.
- virtual_
machine_ floattype_ id - Id of the virtual machine type.
- cluster str
- Cluster.
- cluster_
group_ floatid - Id of the cluster group.
- cluster_
group_ strslug - Slug of the cluster group.
- cluster_
type_ floatid - Id of the cluster type.
- cluster_
type_ strslug - Slug of the cluster type.
- contact float
- Id of the contact.
- contact_
group_ strslug - Slug of the contact group.
- contact_
role float - Id of the contact role.
- custom_
field_ Mapping[str, str]filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- device_
name str - Name of the device hosting the virtual machine.
- disk float
- Disk to match.
- has_
local_ boolcontext_ data - Whether the object has local config context data.
- has_
primary_ boolip - Has a primary IP.
- mac_
address str - Mac address to match.
- memory float
- Memory to match.
- owner_
group_ floatid - Id of the owner group.
- owner_
group_ strname - Name of the owner group.
- owner_
name str - Name of the owner.
- platform_
slug str - Slug of the platform.
- primary_
ip4 str - Primary IPv4 (address).
- primary_
ip6 str - Primary IPv6 (address).
- q str
- Search term, matched against the fields NetBox searches for this object type.
- region_
id str - Id of the region.
- region_
slug str - Slug of the region of the site.
- role_
slug str - Slug of the role.
- site_
group_ strid - Id of the site group.
- site_
group_ strslug - Slug of the site group.
- site_
slug str - Slug of the site.
- tag_
id float - Id of a tag the object carries.
- tag_
slug str - Slug of a tag the object carries.
- tenant_
group_ strid - Id of the tenant group.
- tenant_
group_ strslug - Slug of the tenant group.
- tenant_
slug str - Slug of the tenant.
- virtual_
machine_ strtype_ slug - Slug of the virtual machine type.
- cluster
Id Number - Id of the cluster (a virtual machine needs a cluster or a site).
- comments String
- config
Context String - Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
- config
Template NumberId - Id of the config template.
- created String
- custom
Fields Map<String> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description String
- device
Id Number - Id of the device hosting the VM.
- disk
Size NumberMb - Disk size in MB. Once the machine has virtual disks NetBox computes it as their sum and it can no longer be set; leave it unset then. Must be a whole number.
- id Number
- NetBox id.
- interface
Count Number - Number of interfaces on the virtual machine.
- last
Updated String - local
Context StringData - Local config context data as JSON text (use jsonencode()).
- memory
Mb Number - Memory in MB. Must be a whole number.
- name String
- owner
Id Number - Id of the owner the object is assigned to.
- platform
Id Number - Id of the platform.
- primary
Ip4Id Number - Id of the primary IPv4 address (managed by netboxprimaryip).
- primary
Ip6Id Number - Id of the primary IPv6 address (managed by netboxprimaryip).
- role
Id Number - Id of the functional device role.
- serial String
- Serial number.
- site
Id Number - Id of the site (a virtual machine needs a cluster or a site).
- start
On StringBoot - Power state the virtual machine takes when its host boots. One of: on, off, laststate.
- status String
- Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
- 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.
- tenant
Id Number - Id of the tenant.
- url String
- vcpus Number
- Number of virtual CPUs (fractions allowed).
- virtual
Disk NumberCount - Number of virtual disks on the virtual machine.
- virtual
Machine NumberType Id - Id of the virtual machine type.
- cluster String
- Cluster.
- cluster
Group NumberId - Id of the cluster group.
- cluster
Group StringSlug - Slug of the cluster group.
- cluster
Type NumberId - Id of the cluster type.
- cluster
Type StringSlug - Slug of the cluster type.
- contact Number
- Id of the contact.
- contact
Group StringSlug - Slug of the contact group.
- contact
Role Number - Id of the contact role.
- custom
Field Map<String>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- device
Name String - Name of the device hosting the virtual machine.
- disk Number
- Disk to match.
- has
Local BooleanContext Data - Whether the object has local config context data.
- has
Primary BooleanIp - Has a primary IP.
- mac
Address String - Mac address to match.
- memory Number
- Memory to match.
- owner
Group NumberId - Id of the owner group.
- owner
Group StringName - Name of the owner group.
- owner
Name String - Name of the owner.
- platform
Slug String - Slug of the platform.
- primary
Ip4 String - Primary IPv4 (address).
- primary
Ip6 String - Primary IPv6 (address).
- q String
- Search term, matched against the fields NetBox searches for this object type.
- region
Id String - Id of the region.
- region
Slug String - Slug of the region of the site.
- role
Slug String - Slug of the role.
- site
Group StringId - Id of the site group.
- site
Group StringSlug - Slug of the site group.
- site
Slug String - Slug of the site.
- tag
Id Number - Id of a tag the object carries.
- String
- Slug of a tag the object carries.
- tenant
Group StringId - Id of the tenant group.
- tenant
Group StringSlug - Slug of the tenant group.
- tenant
Slug String - Slug of the tenant.
- virtual
Machine StringType Slug - Slug of the virtual machine type.
Package Details
- Repository
- netbox e-breuninger/terraform-provider-netbox
- License
- Notes
- This Pulumi package is based on the
netboxTerraform Provider.
published on Monday, Nov 16, 2026 by e-breuninger