1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getVirtualMachine
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 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_group_slug: Optional[str] = None,
                            cluster_id: Optional[float] = None,
                            custom_field_filters: Optional[Mapping[str, str]] = None,
                            device_id: Optional[float] = None,
                            device_name: Optional[str] = None,
                            id: Optional[float] = None,
                            name: Optional[str] = None,
                            owner_id: Optional[float] = None,
                            platform_id: Optional[float] = None,
                            platform_slug: Optional[str] = None,
                            region_slug: Optional[str] = None,
                            role_id: Optional[float] = None,
                            role_slug: Optional[str] = None,
                            site_id: Optional[float] = None,
                            site_slug: Optional[str] = None,
                            status: Optional[str] = None,
                            tag_slug: Optional[str] = None,
                            tenant_id: Optional[float] = None,
                            opts: Optional[InvokeOptions] = None) -> GetVirtualMachineResult
    def get_virtual_machine_output(cluster_group_slug: pulumi.Input[Optional[str]] = None,
                            cluster_id: pulumi.Input[Optional[float]] = None,
                            custom_field_filters: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                            device_id: pulumi.Input[Optional[float]] = None,
                            device_name: pulumi.Input[Optional[str]] = None,
                            id: pulumi.Input[Optional[float]] = None,
                            name: pulumi.Input[Optional[str]] = None,
                            owner_id: pulumi.Input[Optional[float]] = None,
                            platform_id: pulumi.Input[Optional[float]] = None,
                            platform_slug: 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,
                            site_id: pulumi.Input[Optional[float]] = None,
                            site_slug: pulumi.Input[Optional[str]] = None,
                            status: pulumi.Input[Optional[str]] = None,
                            tag_slug: pulumi.Input[Optional[str]] = None,
                            tenant_id: pulumi.Input[Optional[float]] = 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 dictionary
    data "netbox_get_virtual_machine" "name" {
        # arguments
    }

    The following arguments are supported:

    ClusterGroupSlug string
    Slug of the cluster group.
    ClusterId double
    Id of the cluster (a virtual machine needs a cluster or a site).
    CustomFieldFilters Dictionary<string, string>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    DeviceId double
    Id of the device hosting the VM.
    DeviceName string
    Name of the device hosting the virtual machine.
    Id double
    NetBox id.
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    PlatformId double
    Id of the platform.
    PlatformSlug string
    Slug of the platform.
    RegionSlug string
    Slug of the region of the site.
    RoleId double
    Id of the functional device role.
    RoleSlug string
    Slug of the role.
    SiteId double
    Id of the site (a virtual machine needs a cluster or a site).
    SiteSlug string
    Slug of the site.
    Status string
    Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
    TagSlug string
    Slug of a tag the object carries.
    TenantId double
    Id of the tenant.
    ClusterGroupSlug string
    Slug of the cluster group.
    ClusterId float64
    Id of the cluster (a virtual machine needs a cluster or a site).
    CustomFieldFilters map[string]string
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    DeviceId float64
    Id of the device hosting the VM.
    DeviceName string
    Name of the device hosting the virtual machine.
    Id float64
    NetBox id.
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    PlatformId float64
    Id of the platform.
    PlatformSlug string
    Slug of the platform.
    RegionSlug string
    Slug of the region of the site.
    RoleId float64
    Id of the functional device role.
    RoleSlug string
    Slug of the role.
    SiteId float64
    Id of the site (a virtual machine needs a cluster or a site).
    SiteSlug string
    Slug of the site.
    Status string
    Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
    TagSlug string
    Slug of a tag the object carries.
    TenantId float64
    Id of the tenant.
    cluster_group_slug string
    Slug of the cluster group.
    cluster_id number
    Id of the cluster (a virtual machine needs a cluster or a site).
    custom_field_filters map(string)
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    device_id number
    Id of the device hosting the VM.
    device_name string
    Name of the device hosting the virtual machine.
    id number
    NetBox id.
    name string
    owner_id number
    Id of the owner the object is assigned to.
    platform_id number
    Id of the platform.
    platform_slug string
    Slug of the platform.
    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.
    site_id number
    Id of the site (a virtual machine needs a cluster or a site).
    site_slug string
    Slug of the site.
    status string
    Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
    tag_slug string
    Slug of a tag the object carries.
    tenant_id number
    Id of the tenant.
    clusterGroupSlug String
    Slug of the cluster group.
    clusterId Double
    Id of the cluster (a virtual machine needs a cluster or a site).
    customFieldFilters Map<String,String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    deviceId Double
    Id of the device hosting the VM.
    deviceName String
    Name of the device hosting the virtual machine.
    id Double
    NetBox id.
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    platformId Double
    Id of the platform.
    platformSlug String
    Slug of the platform.
    regionSlug String
    Slug of the region of the site.
    roleId Double
    Id of the functional device role.
    roleSlug String
    Slug of the role.
    siteId Double
    Id of the site (a virtual machine needs a cluster or a site).
    siteSlug String
    Slug of the site.
    status String
    Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
    tagSlug String
    Slug of a tag the object carries.
    tenantId Double
    Id of the tenant.
    clusterGroupSlug string
    Slug of the cluster group.
    clusterId number
    Id of the cluster (a virtual machine needs a cluster or a site).
    customFieldFilters {[key: string]: string}
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    deviceId number
    Id of the device hosting the VM.
    deviceName string
    Name of the device hosting the virtual machine.
    id number
    NetBox id.
    name string
    ownerId number
    Id of the owner the object is assigned to.
    platformId number
    Id of the platform.
    platformSlug string
    Slug of the platform.
    regionSlug string
    Slug of the region of the site.
    roleId number
    Id of the functional device role.
    roleSlug string
    Slug of the role.
    siteId number
    Id of the site (a virtual machine needs a cluster or a site).
    siteSlug string
    Slug of the site.
    status string
    Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
    tagSlug string
    Slug of a tag the object carries.
    tenantId number
    Id of the tenant.
    cluster_group_slug str
    Slug of the cluster group.
    cluster_id float
    Id of the cluster (a virtual machine needs a cluster or a site).
    custom_field_filters Mapping[str, str]
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    device_id float
    Id of the device hosting the VM.
    device_name str
    Name of the device hosting the virtual machine.
    id float
    NetBox id.
    name str
    owner_id float
    Id of the owner the object is assigned to.
    platform_id float
    Id of the platform.
    platform_slug str
    Slug of the platform.
    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.
    site_id float
    Id of the site (a virtual machine needs a cluster or a site).
    site_slug str
    Slug of the site.
    status str
    Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
    tag_slug str
    Slug of a tag the object carries.
    tenant_id float
    Id of the tenant.
    clusterGroupSlug String
    Slug of the cluster group.
    clusterId Number
    Id of the cluster (a virtual machine needs a cluster or a site).
    customFieldFilters Map<String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    deviceId Number
    Id of the device hosting the VM.
    deviceName String
    Name of the device hosting the virtual machine.
    id Number
    NetBox id.
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    platformId Number
    Id of the platform.
    platformSlug String
    Slug of the platform.
    regionSlug String
    Slug of the region of the site.
    roleId Number
    Id of the functional device role.
    roleSlug String
    Slug of the role.
    siteId Number
    Id of the site (a virtual machine needs a cluster or a site).
    siteSlug String
    Slug of the site.
    status String
    Operational status. One of: offline, active, planned, staged, failed, decommissioning, paused.
    tagSlug String
    Slug of a tag the object carries.
    tenantId Number
    Id of the tenant.

    getVirtualMachine Result

    The following output properties are available:

    ClusterId double
    Id of the cluster (a virtual machine needs a cluster or a site).
    Comments string
    ConfigContext string
    Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
    ConfigTemplateId double
    Id of the config template.
    Created string
    CustomFields Dictionary<string, string>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    DeviceId double
    Id of the device hosting the VM.
    DiskSizeMb double
    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.
    InterfaceCount double
    Number of interfaces on the virtual machine.
    LastUpdated string
    LocalContextData string
    Local config context data as JSON text (use jsonencode()).
    MemoryMb double
    Memory in MB. Must be a whole number.
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    PlatformId double
    Id of the platform.
    PrimaryIp4Id double
    Id of the primary IPv4 address (managed by netboxprimaryip).
    PrimaryIp6Id double
    Id of the primary IPv6 address (managed by netboxprimaryip).
    RoleId double
    Id of the functional device role.
    Serial string
    Serial number.
    SiteId double
    Id of the site (a virtual machine needs a cluster or a site).
    StartOnBoot string
    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.
    Tags List<string>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls List<string>
    Slugs of all tags on the object, including the provider's default_tags.
    TenantId double
    Id of the tenant.
    Url string
    Vcpus double
    Number of virtual CPUs (fractions allowed).
    VirtualDiskCount double
    Number of virtual disks on the virtual machine.
    VirtualMachineTypeId double
    Id of the virtual machine type.
    ClusterGroupSlug string
    Slug of the cluster group.
    CustomFieldFilters Dictionary<string, string>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    DeviceName string
    Name of the device hosting the virtual machine.
    PlatformSlug string
    Slug of the platform.
    RegionSlug string
    Slug of the region of the site.
    RoleSlug string
    Slug of the role.
    SiteSlug string
    Slug of the site.
    TagSlug string
    Slug of a tag the object carries.
    ClusterId float64
    Id of the cluster (a virtual machine needs a cluster or a site).
    Comments string
    ConfigContext string
    Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
    ConfigTemplateId float64
    Id of the config template.
    Created string
    CustomFields map[string]string
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    DeviceId float64
    Id of the device hosting the VM.
    DiskSizeMb float64
    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.
    InterfaceCount float64
    Number of interfaces on the virtual machine.
    LastUpdated string
    LocalContextData string
    Local config context data as JSON text (use jsonencode()).
    MemoryMb float64
    Memory in MB. Must be a whole number.
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    PlatformId float64
    Id of the platform.
    PrimaryIp4Id float64
    Id of the primary IPv4 address (managed by netboxprimaryip).
    PrimaryIp6Id float64
    Id of the primary IPv6 address (managed by netboxprimaryip).
    RoleId float64
    Id of the functional device role.
    Serial string
    Serial number.
    SiteId float64
    Id of the site (a virtual machine needs a cluster or a site).
    StartOnBoot string
    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.
    Tags []string
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls []string
    Slugs of all tags on the object, including the provider's default_tags.
    TenantId float64
    Id of the tenant.
    Url string
    Vcpus float64
    Number of virtual CPUs (fractions allowed).
    VirtualDiskCount float64
    Number of virtual disks on the virtual machine.
    VirtualMachineTypeId float64
    Id of the virtual machine type.
    ClusterGroupSlug string
    Slug of the cluster group.
    CustomFieldFilters map[string]string
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    DeviceName string
    Name of the device hosting the virtual machine.
    PlatformSlug string
    Slug of the platform.
    RegionSlug string
    Slug of the region of the site.
    RoleSlug string
    Slug of the role.
    SiteSlug string
    Slug of the site.
    TagSlug string
    Slug of a tag the object carries.
    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_id number
    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_mb number
    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_data string
    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_id number
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primary_ip6_id 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_boot string
    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.
    tags list(string)
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls list(string)
    Slugs of all tags on the object, including the provider's default_tags.
    tenant_id number
    Id of the tenant.
    url string
    vcpus number
    Number of virtual CPUs (fractions allowed).
    virtual_disk_count number
    Number of virtual disks on the virtual machine.
    virtual_machine_type_id number
    Id of the virtual machine type.
    cluster_group_slug string
    Slug of the cluster group.
    custom_field_filters map(string)
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    device_name string
    Name of the device hosting the virtual machine.
    platform_slug string
    Slug of the platform.
    region_slug string
    Slug of the region of the site.
    role_slug string
    Slug of the role.
    site_slug string
    Slug of the site.
    tag_slug string
    Slug of a tag the object carries.
    clusterId Double
    Id of the cluster (a virtual machine needs a cluster or a site).
    comments String
    configContext String
    Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
    configTemplateId Double
    Id of the config template.
    created String
    customFields Map<String,String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    deviceId Double
    Id of the device hosting the VM.
    diskSizeMb Double
    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.
    interfaceCount Double
    Number of interfaces on the virtual machine.
    lastUpdated String
    localContextData String
    Local config context data as JSON text (use jsonencode()).
    memoryMb Double
    Memory in MB. Must be a whole number.
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    platformId Double
    Id of the platform.
    primaryIp4Id Double
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primaryIp6Id Double
    Id of the primary IPv6 address (managed by netboxprimaryip).
    roleId Double
    Id of the functional device role.
    serial String
    Serial number.
    siteId Double
    Id of the site (a virtual machine needs a cluster or a site).
    startOnBoot String
    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.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    tenantId Double
    Id of the tenant.
    url String
    vcpus Double
    Number of virtual CPUs (fractions allowed).
    virtualDiskCount Double
    Number of virtual disks on the virtual machine.
    virtualMachineTypeId Double
    Id of the virtual machine type.
    clusterGroupSlug String
    Slug of the cluster group.
    customFieldFilters Map<String,String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    deviceName String
    Name of the device hosting the virtual machine.
    platformSlug String
    Slug of the platform.
    regionSlug String
    Slug of the region of the site.
    roleSlug String
    Slug of the role.
    siteSlug String
    Slug of the site.
    tagSlug String
    Slug of a tag the object carries.
    clusterId number
    Id of the cluster (a virtual machine needs a cluster or a site).
    comments string
    configContext string
    Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
    configTemplateId number
    Id of the config template.
    created string
    customFields {[key: string]: string}
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    deviceId number
    Id of the device hosting the VM.
    diskSizeMb number
    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.
    interfaceCount number
    Number of interfaces on the virtual machine.
    lastUpdated string
    localContextData string
    Local config context data as JSON text (use jsonencode()).
    memoryMb number
    Memory in MB. Must be a whole number.
    name string
    ownerId number
    Id of the owner the object is assigned to.
    platformId number
    Id of the platform.
    primaryIp4Id number
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primaryIp6Id number
    Id of the primary IPv6 address (managed by netboxprimaryip).
    roleId number
    Id of the functional device role.
    serial string
    Serial number.
    siteId number
    Id of the site (a virtual machine needs a cluster or a site).
    startOnBoot string
    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.
    tags string[]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls string[]
    Slugs of all tags on the object, including the provider's default_tags.
    tenantId number
    Id of the tenant.
    url string
    vcpus number
    Number of virtual CPUs (fractions allowed).
    virtualDiskCount number
    Number of virtual disks on the virtual machine.
    virtualMachineTypeId number
    Id of the virtual machine type.
    clusterGroupSlug string
    Slug of the cluster group.
    customFieldFilters {[key: string]: string}
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    deviceName string
    Name of the device hosting the virtual machine.
    platformSlug string
    Slug of the platform.
    regionSlug string
    Slug of the region of the site.
    roleSlug string
    Slug of the role.
    siteSlug string
    Slug of the site.
    tagSlug string
    Slug of a tag the object carries.
    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_id float
    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_mb float
    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_data str
    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_id float
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primary_ip6_id float
    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_boot str
    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.
    tags Sequence[str]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls Sequence[str]
    Slugs of all tags on the object, including the provider's default_tags.
    tenant_id float
    Id of the tenant.
    url str
    vcpus float
    Number of virtual CPUs (fractions allowed).
    virtual_disk_count float
    Number of virtual disks on the virtual machine.
    virtual_machine_type_id float
    Id of the virtual machine type.
    cluster_group_slug str
    Slug of the cluster group.
    custom_field_filters Mapping[str, str]
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    device_name str
    Name of the device hosting the virtual machine.
    platform_slug str
    Slug of the platform.
    region_slug str
    Slug of the region of the site.
    role_slug str
    Slug of the role.
    site_slug str
    Slug of the site.
    tag_slug str
    Slug of a tag the object carries.
    clusterId Number
    Id of the cluster (a virtual machine needs a cluster or a site).
    comments String
    configContext String
    Rendered config context (localcontextdata merged with the context assigned through cluster, platform, role, site, tenant and tags) as JSON text, decode with jsondecode().
    configTemplateId Number
    Id of the config template.
    created String
    customFields Map<String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    deviceId Number
    Id of the device hosting the VM.
    diskSizeMb Number
    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.
    interfaceCount Number
    Number of interfaces on the virtual machine.
    lastUpdated String
    localContextData String
    Local config context data as JSON text (use jsonencode()).
    memoryMb Number
    Memory in MB. Must be a whole number.
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    platformId Number
    Id of the platform.
    primaryIp4Id Number
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primaryIp6Id Number
    Id of the primary IPv6 address (managed by netboxprimaryip).
    roleId Number
    Id of the functional device role.
    serial String
    Serial number.
    siteId Number
    Id of the site (a virtual machine needs a cluster or a site).
    startOnBoot String
    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.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    tenantId Number
    Id of the tenant.
    url String
    vcpus Number
    Number of virtual CPUs (fractions allowed).
    virtualDiskCount Number
    Number of virtual disks on the virtual machine.
    virtualMachineTypeId Number
    Id of the virtual machine type.
    clusterGroupSlug String
    Slug of the cluster group.
    customFieldFilters Map<String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    deviceName String
    Name of the device hosting the virtual machine.
    platformSlug String
    Slug of the platform.
    regionSlug String
    Slug of the region of the site.
    roleSlug String
    Slug of the role.
    siteSlug String
    Slug of the site.
    tagSlug String
    Slug of a tag the object carries.

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox
    Viewing docs for netbox 6.0.0
    published on Wednesday, Nov 4, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial