1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getVirtualMachine
Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.1
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 dictionary
    data "netbox_get_virtual_machine" "name" {
        # arguments
    }

    The following arguments are supported:

    Cluster string
    Cluster.
    ClusterGroupId double
    Id of the cluster group.
    ClusterGroupSlug string
    Slug of the cluster group.
    ClusterId double
    Id of the cluster (a virtual machine needs a cluster or a site).
    ClusterTypeId double
    Id of the cluster type.
    ClusterTypeSlug string
    Slug of the cluster type.
    ConfigTemplateId double
    Id of the config template.
    Contact double
    Id of the contact.
    ContactGroupSlug string
    Slug of the contact group.
    ContactRole double
    Id of the contact role.
    Created string
    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.
    Description string
    DeviceId double
    Id of the device hosting the VM.
    DeviceName string
    Name of the device hosting the virtual machine.
    Disk double
    Disk to match.
    HasLocalContextData bool
    Whether the object has local config context data.
    HasPrimaryIp bool
    Has a primary IP.
    Id double
    NetBox id.
    InterfaceCount double
    Number of interfaces on the virtual machine.
    LastUpdated string
    MacAddress string
    Mac address to match.
    Memory double
    Memory to match.
    Name string
    OwnerGroupId double
    Id of the owner group.
    OwnerGroupName string
    Name of the owner group.
    OwnerId double
    Id of the owner the object is assigned to.
    OwnerName string
    Name of the owner.
    PlatformId double
    Id of the platform.
    PlatformSlug string
    Slug of the platform.
    PrimaryIp4 string
    Primary IPv4 (address).
    PrimaryIp4Id double
    Id of the primary IPv4 address (managed by netboxprimaryip).
    PrimaryIp6 string
    Primary IPv6 (address).
    PrimaryIp6Id double
    Id of the primary IPv6 address (managed by netboxprimaryip).
    Q string
    Search term, matched against the fields NetBox searches for this object type.
    RegionId string
    Id of the region.
    RegionSlug string
    Slug of the region of the site.
    RoleId double
    Id of the functional device role.
    RoleSlug string
    Slug of the role.
    Serial string
    Serial number.
    SiteGroupId string
    Id of the site group.
    SiteGroupSlug string
    Slug of the site group.
    SiteId double
    Id of the site (a virtual machine needs a cluster or a site).
    SiteSlug string
    Slug of the 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.
    TagId double
    Id of a tag the object carries.
    TagSlug string
    Slug of a tag the object carries.
    TenantGroupId string
    Id of the tenant group.
    TenantGroupSlug string
    Slug of the tenant group.
    TenantId double
    Id of the tenant.
    TenantSlug string
    Slug of the tenant.
    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.
    VirtualMachineTypeSlug string
    Slug of the virtual machine type.
    Cluster string
    Cluster.
    ClusterGroupId float64
    Id of the cluster group.
    ClusterGroupSlug string
    Slug of the cluster group.
    ClusterId float64
    Id of the cluster (a virtual machine needs a cluster or a site).
    ClusterTypeId float64
    Id of the cluster type.
    ClusterTypeSlug string
    Slug of the cluster type.
    ConfigTemplateId float64
    Id of the config template.
    Contact float64
    Id of the contact.
    ContactGroupSlug string
    Slug of the contact group.
    ContactRole float64
    Id of the contact role.
    Created string
    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.
    Description string
    DeviceId float64
    Id of the device hosting the VM.
    DeviceName string
    Name of the device hosting the virtual machine.
    Disk float64
    Disk to match.
    HasLocalContextData bool
    Whether the object has local config context data.
    HasPrimaryIp bool
    Has a primary IP.
    Id float64
    NetBox id.
    InterfaceCount float64
    Number of interfaces on the virtual machine.
    LastUpdated string
    MacAddress string
    Mac address to match.
    Memory float64
    Memory to match.
    Name string
    OwnerGroupId float64
    Id of the owner group.
    OwnerGroupName string
    Name of the owner group.
    OwnerId float64
    Id of the owner the object is assigned to.
    OwnerName string
    Name of the owner.
    PlatformId float64
    Id of the platform.
    PlatformSlug string
    Slug of the platform.
    PrimaryIp4 string
    Primary IPv4 (address).
    PrimaryIp4Id float64
    Id of the primary IPv4 address (managed by netboxprimaryip).
    PrimaryIp6 string
    Primary IPv6 (address).
    PrimaryIp6Id float64
    Id of the primary IPv6 address (managed by netboxprimaryip).
    Q string
    Search term, matched against the fields NetBox searches for this object type.
    RegionId string
    Id of the region.
    RegionSlug string
    Slug of the region of the site.
    RoleId float64
    Id of the functional device role.
    RoleSlug string
    Slug of the role.
    Serial string
    Serial number.
    SiteGroupId string
    Id of the site group.
    SiteGroupSlug string
    Slug of the site group.
    SiteId float64
    Id of the site (a virtual machine needs a cluster or a site).
    SiteSlug string
    Slug of the 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.
    TagId float64
    Id of a tag the object carries.
    TagSlug string
    Slug of a tag the object carries.
    TenantGroupId string
    Id of the tenant group.
    TenantGroupSlug string
    Slug of the tenant group.
    TenantId float64
    Id of the tenant.
    TenantSlug string
    Slug of the tenant.
    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.
    VirtualMachineTypeSlug string
    Slug of the virtual machine type.
    cluster string
    Cluster.
    cluster_group_id number
    Id of the cluster group.
    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).
    cluster_type_id number
    Id of the cluster type.
    cluster_type_slug string
    Slug of the cluster type.
    config_template_id number
    Id of the config template.
    contact number
    Id of the contact.
    contact_group_slug string
    Slug of the contact group.
    contact_role number
    Id of the contact role.
    created string
    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.
    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_context_data bool
    Whether the object has local config context data.
    has_primary_ip bool
    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_id number
    Id of the owner group.
    owner_group_name string
    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_id number
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primary_ip6 string
    Primary IPv6 (address).
    primary_ip6_id 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_id string
    Id of the site group.
    site_group_slug string
    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_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.
    tag_id number
    Id of a tag the object carries.
    tag_slug string
    Slug of a tag the object carries.
    tenant_group_id string
    Id of the tenant group.
    tenant_group_slug string
    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_count number
    Number of virtual disks on the virtual machine.
    virtual_machine_type_id number
    Id of the virtual machine type.
    virtual_machine_type_slug string
    Slug of the virtual machine type.
    cluster String
    Cluster.
    clusterGroupId Double
    Id of the cluster group.
    clusterGroupSlug String
    Slug of the cluster group.
    clusterId Double
    Id of the cluster (a virtual machine needs a cluster or a site).
    clusterTypeId Double
    Id of the cluster type.
    clusterTypeSlug String
    Slug of the cluster type.
    configTemplateId Double
    Id of the config template.
    contact Double
    Id of the contact.
    contactGroupSlug String
    Slug of the contact group.
    contactRole Double
    Id of the contact role.
    created String
    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.
    description String
    deviceId Double
    Id of the device hosting the VM.
    deviceName String
    Name of the device hosting the virtual machine.
    disk Double
    Disk to match.
    hasLocalContextData Boolean
    Whether the object has local config context data.
    hasPrimaryIp Boolean
    Has a primary IP.
    id Double
    NetBox id.
    interfaceCount Double
    Number of interfaces on the virtual machine.
    lastUpdated String
    macAddress String
    Mac address to match.
    memory Double
    Memory to match.
    name String
    ownerGroupId Double
    Id of the owner group.
    ownerGroupName String
    Name of the owner group.
    ownerId Double
    Id of the owner the object is assigned to.
    ownerName String
    Name of the owner.
    platformId Double
    Id of the platform.
    platformSlug String
    Slug of the platform.
    primaryIp4 String
    Primary IPv4 (address).
    primaryIp4Id Double
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primaryIp6 String
    Primary IPv6 (address).
    primaryIp6Id Double
    Id of the primary IPv6 address (managed by netboxprimaryip).
    q String
    Search term, matched against the fields NetBox searches for this object type.
    regionId String
    Id of the region.
    regionSlug String
    Slug of the region of the site.
    roleId Double
    Id of the functional device role.
    roleSlug String
    Slug of the role.
    serial String
    Serial number.
    siteGroupId String
    Id of the site group.
    siteGroupSlug String
    Slug of the site group.
    siteId Double
    Id of the site (a virtual machine needs a cluster or a site).
    siteSlug String
    Slug of the 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.
    tagId Double
    Id of a tag the object carries.
    tagSlug String
    Slug of a tag the object carries.
    tenantGroupId String
    Id of the tenant group.
    tenantGroupSlug String
    Slug of the tenant group.
    tenantId Double
    Id of the tenant.
    tenantSlug String
    Slug of the tenant.
    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.
    virtualMachineTypeSlug String
    Slug of the virtual machine type.
    cluster string
    Cluster.
    clusterGroupId number
    Id of the cluster group.
    clusterGroupSlug string
    Slug of the cluster group.
    clusterId number
    Id of the cluster (a virtual machine needs a cluster or a site).
    clusterTypeId number
    Id of the cluster type.
    clusterTypeSlug string
    Slug of the cluster type.
    configTemplateId number
    Id of the config template.
    contact number
    Id of the contact.
    contactGroupSlug string
    Slug of the contact group.
    contactRole number
    Id of the contact role.
    created string
    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.
    description string
    deviceId number
    Id of the device hosting the VM.
    deviceName string
    Name of the device hosting the virtual machine.
    disk number
    Disk to match.
    hasLocalContextData boolean
    Whether the object has local config context data.
    hasPrimaryIp boolean
    Has a primary IP.
    id number
    NetBox id.
    interfaceCount number
    Number of interfaces on the virtual machine.
    lastUpdated string
    macAddress string
    Mac address to match.
    memory number
    Memory to match.
    name string
    ownerGroupId number
    Id of the owner group.
    ownerGroupName string
    Name of the owner group.
    ownerId number
    Id of the owner the object is assigned to.
    ownerName string
    Name of the owner.
    platformId number
    Id of the platform.
    platformSlug string
    Slug of the platform.
    primaryIp4 string
    Primary IPv4 (address).
    primaryIp4Id number
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primaryIp6 string
    Primary IPv6 (address).
    primaryIp6Id number
    Id of the primary IPv6 address (managed by netboxprimaryip).
    q string
    Search term, matched against the fields NetBox searches for this object type.
    regionId string
    Id of the region.
    regionSlug string
    Slug of the region of the site.
    roleId number
    Id of the functional device role.
    roleSlug string
    Slug of the role.
    serial string
    Serial number.
    siteGroupId string
    Id of the site group.
    siteGroupSlug string
    Slug of the site group.
    siteId number
    Id of the site (a virtual machine needs a cluster or a site).
    siteSlug string
    Slug of the 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.
    tagId number
    Id of a tag the object carries.
    tagSlug string
    Slug of a tag the object carries.
    tenantGroupId string
    Id of the tenant group.
    tenantGroupSlug string
    Slug of the tenant group.
    tenantId number
    Id of the tenant.
    tenantSlug string
    Slug of the tenant.
    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.
    virtualMachineTypeSlug string
    Slug of the virtual machine type.
    cluster str
    Cluster.
    cluster_group_id float
    Id of the cluster group.
    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).
    cluster_type_id float
    Id of the cluster type.
    cluster_type_slug str
    Slug of the cluster type.
    config_template_id float
    Id of the config template.
    contact float
    Id of the contact.
    contact_group_slug str
    Slug of the contact group.
    contact_role float
    Id of the contact role.
    created str
    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.
    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_context_data bool
    Whether the object has local config context data.
    has_primary_ip bool
    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_id float
    Id of the owner group.
    owner_group_name str
    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_id float
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primary_ip6 str
    Primary IPv6 (address).
    primary_ip6_id float
    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_id str
    Id of the site group.
    site_group_slug str
    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_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.
    tag_id float
    Id of a tag the object carries.
    tag_slug str
    Slug of a tag the object carries.
    tenant_group_id str
    Id of the tenant group.
    tenant_group_slug str
    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_count float
    Number of virtual disks on the virtual machine.
    virtual_machine_type_id float
    Id of the virtual machine type.
    virtual_machine_type_slug str
    Slug of the virtual machine type.
    cluster String
    Cluster.
    clusterGroupId Number
    Id of the cluster group.
    clusterGroupSlug String
    Slug of the cluster group.
    clusterId Number
    Id of the cluster (a virtual machine needs a cluster or a site).
    clusterTypeId Number
    Id of the cluster type.
    clusterTypeSlug String
    Slug of the cluster type.
    configTemplateId Number
    Id of the config template.
    contact Number
    Id of the contact.
    contactGroupSlug String
    Slug of the contact group.
    contactRole Number
    Id of the contact role.
    created String
    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.
    description String
    deviceId Number
    Id of the device hosting the VM.
    deviceName String
    Name of the device hosting the virtual machine.
    disk Number
    Disk to match.
    hasLocalContextData Boolean
    Whether the object has local config context data.
    hasPrimaryIp Boolean
    Has a primary IP.
    id Number
    NetBox id.
    interfaceCount Number
    Number of interfaces on the virtual machine.
    lastUpdated String
    macAddress String
    Mac address to match.
    memory Number
    Memory to match.
    name String
    ownerGroupId Number
    Id of the owner group.
    ownerGroupName String
    Name of the owner group.
    ownerId Number
    Id of the owner the object is assigned to.
    ownerName String
    Name of the owner.
    platformId Number
    Id of the platform.
    platformSlug String
    Slug of the platform.
    primaryIp4 String
    Primary IPv4 (address).
    primaryIp4Id Number
    Id of the primary IPv4 address (managed by netboxprimaryip).
    primaryIp6 String
    Primary IPv6 (address).
    primaryIp6Id Number
    Id of the primary IPv6 address (managed by netboxprimaryip).
    q String
    Search term, matched against the fields NetBox searches for this object type.
    regionId String
    Id of the region.
    regionSlug String
    Slug of the region of the site.
    roleId Number
    Id of the functional device role.
    roleSlug String
    Slug of the role.
    serial String
    Serial number.
    siteGroupId String
    Id of the site group.
    siteGroupSlug String
    Slug of the site group.
    siteId Number
    Id of the site (a virtual machine needs a cluster or a site).
    siteSlug String
    Slug of the 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.
    tagId Number
    Id of a tag the object carries.
    tagSlug String
    Slug of a tag the object carries.
    tenantGroupId String
    Id of the tenant group.
    tenantGroupSlug String
    Slug of the tenant group.
    tenantId Number
    Id of the tenant.
    tenantSlug String
    Slug of the tenant.
    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.
    virtualMachineTypeSlug String
    Slug of the virtual machine type.

    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.
    Cluster string
    Cluster.
    ClusterGroupId double
    Id of the cluster group.
    ClusterGroupSlug string
    Slug of the cluster group.
    ClusterTypeId double
    Id of the cluster type.
    ClusterTypeSlug string
    Slug of the cluster type.
    Contact double
    Id of the contact.
    ContactGroupSlug string
    Slug of the contact group.
    ContactRole double
    Id of the contact role.
    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.
    Disk double
    Disk to match.
    HasLocalContextData bool
    Whether the object has local config context data.
    HasPrimaryIp bool
    Has a primary IP.
    MacAddress string
    Mac address to match.
    Memory double
    Memory to match.
    OwnerGroupId double
    Id of the owner group.
    OwnerGroupName string
    Name of the owner group.
    OwnerName string
    Name of the owner.
    PlatformSlug string
    Slug of the platform.
    PrimaryIp4 string
    Primary IPv4 (address).
    PrimaryIp6 string
    Primary IPv6 (address).
    Q string
    Search term, matched against the fields NetBox searches for this object type.
    RegionId string
    Id of the region.
    RegionSlug string
    Slug of the region of the site.
    RoleSlug string
    Slug of the role.
    SiteGroupId string
    Id of the site group.
    SiteGroupSlug string
    Slug of the site group.
    SiteSlug string
    Slug of the site.
    TagId double
    Id of a tag the object carries.
    TagSlug string
    Slug of a tag the object carries.
    TenantGroupId string
    Id of the tenant group.
    TenantGroupSlug string
    Slug of the tenant group.
    TenantSlug string
    Slug of the tenant.
    VirtualMachineTypeSlug string
    Slug of the virtual machine type.
    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.
    Cluster string
    Cluster.
    ClusterGroupId float64
    Id of the cluster group.
    ClusterGroupSlug string
    Slug of the cluster group.
    ClusterTypeId float64
    Id of the cluster type.
    ClusterTypeSlug string
    Slug of the cluster type.
    Contact float64
    Id of the contact.
    ContactGroupSlug string
    Slug of the contact group.
    ContactRole float64
    Id of the contact role.
    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.
    Disk float64
    Disk to match.
    HasLocalContextData bool
    Whether the object has local config context data.
    HasPrimaryIp bool
    Has a primary IP.
    MacAddress string
    Mac address to match.
    Memory float64
    Memory to match.
    OwnerGroupId float64
    Id of the owner group.
    OwnerGroupName string
    Name of the owner group.
    OwnerName string
    Name of the owner.
    PlatformSlug string
    Slug of the platform.
    PrimaryIp4 string
    Primary IPv4 (address).
    PrimaryIp6 string
    Primary IPv6 (address).
    Q string
    Search term, matched against the fields NetBox searches for this object type.
    RegionId string
    Id of the region.
    RegionSlug string
    Slug of the region of the site.
    RoleSlug string
    Slug of the role.
    SiteGroupId string
    Id of the site group.
    SiteGroupSlug string
    Slug of the site group.
    SiteSlug string
    Slug of the site.
    TagId float64
    Id of a tag the object carries.
    TagSlug string
    Slug of a tag the object carries.
    TenantGroupId string
    Id of the tenant group.
    TenantGroupSlug string
    Slug of the tenant group.
    TenantSlug string
    Slug of the tenant.
    VirtualMachineTypeSlug string
    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_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 string
    Cluster.
    cluster_group_id number
    Id of the cluster group.
    cluster_group_slug string
    Slug of the cluster group.
    cluster_type_id number
    Id of the cluster type.
    cluster_type_slug string
    Slug of the cluster type.
    contact number
    Id of the contact.
    contact_group_slug string
    Slug of the contact group.
    contact_role number
    Id of the contact role.
    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.
    disk number
    Disk to match.
    has_local_context_data bool
    Whether the object has local config context data.
    has_primary_ip bool
    Has a primary IP.
    mac_address string
    Mac address to match.
    memory number
    Memory to match.
    owner_group_id number
    Id of the owner group.
    owner_group_name string
    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_id string
    Id of the site group.
    site_group_slug string
    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_id string
    Id of the tenant group.
    tenant_group_slug string
    Slug of the tenant group.
    tenant_slug string
    Slug of the tenant.
    virtual_machine_type_slug string
    Slug of the virtual machine type.
    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.
    cluster String
    Cluster.
    clusterGroupId Double
    Id of the cluster group.
    clusterGroupSlug String
    Slug of the cluster group.
    clusterTypeId Double
    Id of the cluster type.
    clusterTypeSlug String
    Slug of the cluster type.
    contact Double
    Id of the contact.
    contactGroupSlug String
    Slug of the contact group.
    contactRole Double
    Id of the contact role.
    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.
    disk Double
    Disk to match.
    hasLocalContextData Boolean
    Whether the object has local config context data.
    hasPrimaryIp Boolean
    Has a primary IP.
    macAddress String
    Mac address to match.
    memory Double
    Memory to match.
    ownerGroupId Double
    Id of the owner group.
    ownerGroupName String
    Name of the owner group.
    ownerName String
    Name of the owner.
    platformSlug String
    Slug of the platform.
    primaryIp4 String
    Primary IPv4 (address).
    primaryIp6 String
    Primary IPv6 (address).
    q String
    Search term, matched against the fields NetBox searches for this object type.
    regionId String
    Id of the region.
    regionSlug String
    Slug of the region of the site.
    roleSlug String
    Slug of the role.
    siteGroupId String
    Id of the site group.
    siteGroupSlug String
    Slug of the site group.
    siteSlug String
    Slug of the site.
    tagId Double
    Id of a tag the object carries.
    tagSlug String
    Slug of a tag the object carries.
    tenantGroupId String
    Id of the tenant group.
    tenantGroupSlug String
    Slug of the tenant group.
    tenantSlug String
    Slug of the tenant.
    virtualMachineTypeSlug String
    Slug of the virtual machine type.
    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.
    cluster string
    Cluster.
    clusterGroupId number
    Id of the cluster group.
    clusterGroupSlug string
    Slug of the cluster group.
    clusterTypeId number
    Id of the cluster type.
    clusterTypeSlug string
    Slug of the cluster type.
    contact number
    Id of the contact.
    contactGroupSlug string
    Slug of the contact group.
    contactRole number
    Id of the contact role.
    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.
    disk number
    Disk to match.
    hasLocalContextData boolean
    Whether the object has local config context data.
    hasPrimaryIp boolean
    Has a primary IP.
    macAddress string
    Mac address to match.
    memory number
    Memory to match.
    ownerGroupId number
    Id of the owner group.
    ownerGroupName string
    Name of the owner group.
    ownerName string
    Name of the owner.
    platformSlug string
    Slug of the platform.
    primaryIp4 string
    Primary IPv4 (address).
    primaryIp6 string
    Primary IPv6 (address).
    q string
    Search term, matched against the fields NetBox searches for this object type.
    regionId string
    Id of the region.
    regionSlug string
    Slug of the region of the site.
    roleSlug string
    Slug of the role.
    siteGroupId string
    Id of the site group.
    siteGroupSlug string
    Slug of the site group.
    siteSlug string
    Slug of the site.
    tagId number
    Id of a tag the object carries.
    tagSlug string
    Slug of a tag the object carries.
    tenantGroupId string
    Id of the tenant group.
    tenantGroupSlug string
    Slug of the tenant group.
    tenantSlug string
    Slug of the tenant.
    virtualMachineTypeSlug string
    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_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 str
    Cluster.
    cluster_group_id float
    Id of the cluster group.
    cluster_group_slug str
    Slug of the cluster group.
    cluster_type_id float
    Id of the cluster type.
    cluster_type_slug str
    Slug of the cluster type.
    contact float
    Id of the contact.
    contact_group_slug str
    Slug of the contact group.
    contact_role float
    Id of the contact role.
    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.
    disk float
    Disk to match.
    has_local_context_data bool
    Whether the object has local config context data.
    has_primary_ip bool
    Has a primary IP.
    mac_address str
    Mac address to match.
    memory float
    Memory to match.
    owner_group_id float
    Id of the owner group.
    owner_group_name str
    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_id str
    Id of the site group.
    site_group_slug str
    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_id str
    Id of the tenant group.
    tenant_group_slug str
    Slug of the tenant group.
    tenant_slug str
    Slug of the tenant.
    virtual_machine_type_slug str
    Slug of the virtual machine type.
    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.
    cluster String
    Cluster.
    clusterGroupId Number
    Id of the cluster group.
    clusterGroupSlug String
    Slug of the cluster group.
    clusterTypeId Number
    Id of the cluster type.
    clusterTypeSlug String
    Slug of the cluster type.
    contact Number
    Id of the contact.
    contactGroupSlug String
    Slug of the contact group.
    contactRole Number
    Id of the contact role.
    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.
    disk Number
    Disk to match.
    hasLocalContextData Boolean
    Whether the object has local config context data.
    hasPrimaryIp Boolean
    Has a primary IP.
    macAddress String
    Mac address to match.
    memory Number
    Memory to match.
    ownerGroupId Number
    Id of the owner group.
    ownerGroupName String
    Name of the owner group.
    ownerName String
    Name of the owner.
    platformSlug String
    Slug of the platform.
    primaryIp4 String
    Primary IPv4 (address).
    primaryIp6 String
    Primary IPv6 (address).
    q String
    Search term, matched against the fields NetBox searches for this object type.
    regionId String
    Id of the region.
    regionSlug String
    Slug of the region of the site.
    roleSlug String
    Slug of the role.
    siteGroupId String
    Id of the site group.
    siteGroupSlug String
    Slug of the site group.
    siteSlug String
    Slug of the site.
    tagId Number
    Id of a tag the object carries.
    tagSlug String
    Slug of a tag the object carries.
    tenantGroupId String
    Id of the tenant group.
    tenantGroupSlug String
    Slug of the tenant group.
    tenantSlug String
    Slug of the tenant.
    virtualMachineTypeSlug String
    Slug of the virtual machine type.

    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.1
    published on Monday, Nov 16, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial