netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
netbox.getVirtualMachines
Explore with Pulumi AI
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const vmwCluster01 = netbox.getCluster({
name: "vmw-cluster-01",
});
const baseVm = vmwCluster01.then(vmwCluster01 => netbox.getVirtualMachines({
nameRegex: "myvm-1",
filters: [{
name: "cluster_id",
value: vmwCluster01.id,
}],
}));
import pulumi
import pulumi_netbox as netbox
vmw_cluster01 = netbox.get_cluster(name="vmw-cluster-01")
base_vm = netbox.get_virtual_machines(name_regex="myvm-1",
filters=[{
"name": "cluster_id",
"value": vmw_cluster01.id,
}])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v3/netbox"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
vmwCluster01, err := netbox.LookupCluster(ctx, &netbox.LookupClusterArgs{
Name: pulumi.StringRef("vmw-cluster-01"),
}, nil)
if err != nil {
return err
}
_, err = netbox.GetVirtualMachines(ctx, &netbox.GetVirtualMachinesArgs{
NameRegex: pulumi.StringRef("myvm-1"),
Filters: []netbox.GetVirtualMachinesFilter{
{
Name: "cluster_id",
Value: vmwCluster01.Id,
},
},
}, 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 vmwCluster01 = Netbox.GetCluster.Invoke(new()
{
Name = "vmw-cluster-01",
});
var baseVm = Netbox.GetVirtualMachines.Invoke(new()
{
NameRegex = "myvm-1",
Filters = new[]
{
new Netbox.Inputs.GetVirtualMachinesFilterInputArgs
{
Name = "cluster_id",
Value = vmwCluster01.Apply(getClusterResult => getClusterResult.Id),
},
},
});
});
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.GetClusterArgs;
import com.pulumi.netbox.inputs.GetVirtualMachinesArgs;
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 vmwCluster01 = NetboxFunctions.getCluster(GetClusterArgs.builder()
.name("vmw-cluster-01")
.build());
final var baseVm = NetboxFunctions.getVirtualMachines(GetVirtualMachinesArgs.builder()
.nameRegex("myvm-1")
.filters(GetVirtualMachinesFilterArgs.builder()
.name("cluster_id")
.value(vmwCluster01.applyValue(getClusterResult -> getClusterResult.id()))
.build())
.build());
}
}
variables:
vmwCluster01:
fn::invoke:
function: netbox:getCluster
arguments:
name: vmw-cluster-01
baseVm:
fn::invoke:
function: netbox:getVirtualMachines
arguments:
nameRegex: myvm-1
filters:
- name: cluster_id
value: ${vmwCluster01.id}
Using getVirtualMachines
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 getVirtualMachines(args: GetVirtualMachinesArgs, opts?: InvokeOptions): Promise<GetVirtualMachinesResult>
function getVirtualMachinesOutput(args: GetVirtualMachinesOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachinesResult>
def get_virtual_machines(filters: Optional[Sequence[GetVirtualMachinesFilter]] = None,
id: Optional[str] = None,
limit: Optional[float] = None,
name_regex: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVirtualMachinesResult
def get_virtual_machines_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVirtualMachinesFilterArgs]]]] = None,
id: Optional[pulumi.Input[str]] = None,
limit: Optional[pulumi.Input[float]] = None,
name_regex: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachinesResult]
func GetVirtualMachines(ctx *Context, args *GetVirtualMachinesArgs, opts ...InvokeOption) (*GetVirtualMachinesResult, error)
func GetVirtualMachinesOutput(ctx *Context, args *GetVirtualMachinesOutputArgs, opts ...InvokeOption) GetVirtualMachinesResultOutput
> Note: This function is named GetVirtualMachines
in the Go SDK.
public static class GetVirtualMachines
{
public static Task<GetVirtualMachinesResult> InvokeAsync(GetVirtualMachinesArgs args, InvokeOptions? opts = null)
public static Output<GetVirtualMachinesResult> Invoke(GetVirtualMachinesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetVirtualMachinesResult> getVirtualMachines(GetVirtualMachinesArgs args, InvokeOptions options)
public static Output<GetVirtualMachinesResult> getVirtualMachines(GetVirtualMachinesArgs args, InvokeOptions options)
fn::invoke:
function: netbox:index/getVirtualMachines:getVirtualMachines
arguments:
# arguments dictionary
The following arguments are supported:
- Filters
List<Get
Virtual Machines Filter> - Id string
- The ID of this resource.
- Limit double
- Name
Regex string
- Filters
[]Get
Virtual Machines Filter - Id string
- The ID of this resource.
- Limit float64
- Name
Regex string
- filters
List<Get
Virtual Machines Filter> - id String
- The ID of this resource.
- limit Double
- name
Regex String
- filters
Get
Virtual Machines Filter[] - id string
- The ID of this resource.
- limit number
- name
Regex string
- filters
Sequence[Get
Virtual Machines Filter] - id str
- The ID of this resource.
- limit float
- name_
regex str
- filters List<Property Map>
- id String
- The ID of this resource.
- limit Number
- name
Regex String
getVirtualMachines Result
The following output properties are available:
- Id string
- The ID of this resource.
- Vms
List<Get
Virtual Machines Vm> - Filters
List<Get
Virtual Machines Filter> - Limit double
- Name
Regex string
- Id string
- The ID of this resource.
- Vms
[]Get
Virtual Machines Vm - Filters
[]Get
Virtual Machines Filter - Limit float64
- Name
Regex string
- id String
- The ID of this resource.
- vms
List<Get
Virtual Machines Vm> - filters
List<Get
Virtual Machines Filter> - limit Double
- name
Regex String
- id string
- The ID of this resource.
- vms
Get
Virtual Machines Vm[] - filters
Get
Virtual Machines Filter[] - limit number
- name
Regex string
- id str
- The ID of this resource.
- vms
Sequence[Get
Virtual Machines Vm] - filters
Sequence[Get
Virtual Machines Filter] - limit float
- name_
regex str
- id String
- The ID of this resource.
- vms List<Property Map>
- filters List<Property Map>
- limit Number
- name
Regex String
Supporting Types
GetVirtualMachinesFilter
GetVirtualMachinesVm
- Cluster
Id double - Comments string
- Config
Context string - Custom
Fields Dictionary<string, string> - Description string
- Device
Id double - Device
Name string - Disk
Size doubleMb - Local
Context stringData - Memory
Mb double - Name string
- Platform
Id double - Platform
Slug string - Primary
Ip string - Primary
Ip4 string - Primary
Ip6 string - Role
Id double - Site
Id double - Status string
- Tag
Ids List<double> - Tenant
Id double - Vcpus double
- Vm
Id double
- Cluster
Id float64 - Comments string
- Config
Context string - Custom
Fields map[string]string - Description string
- Device
Id float64 - Device
Name string - Disk
Size float64Mb - Local
Context stringData - Memory
Mb float64 - Name string
- Platform
Id float64 - Platform
Slug string - Primary
Ip string - Primary
Ip4 string - Primary
Ip6 string - Role
Id float64 - Site
Id float64 - Status string
- Tag
Ids []float64 - Tenant
Id float64 - Vcpus float64
- Vm
Id float64
- cluster
Id Double - comments String
- config
Context String - custom
Fields Map<String,String> - description String
- device
Id Double - device
Name String - disk
Size DoubleMb - local
Context StringData - memory
Mb Double - name String
- platform
Id Double - platform
Slug String - primary
Ip String - primary
Ip4 String - primary
Ip6 String - role
Id Double - site
Id Double - status String
- tag
Ids List<Double> - tenant
Id Double - vcpus Double
- vm
Id Double
- cluster
Id number - comments string
- config
Context string - custom
Fields {[key: string]: string} - description string
- device
Id number - device
Name string - disk
Size numberMb - local
Context stringData - memory
Mb number - name string
- platform
Id number - platform
Slug string - primary
Ip string - primary
Ip4 string - primary
Ip6 string - role
Id number - site
Id number - status string
- tag
Ids number[] - tenant
Id number - vcpus number
- vm
Id number
- cluster_
id float - comments str
- config_
context str - custom_
fields Mapping[str, str] - description str
- device_
id float - device_
name str - disk_
size_ floatmb - local_
context_ strdata - memory_
mb float - name str
- platform_
id float - platform_
slug str - primary_
ip str - primary_
ip4 str - primary_
ip6 str - role_
id float - site_
id float - status str
- tag_
ids Sequence[float] - tenant_
id float - vcpus float
- vm_
id float
- cluster
Id Number - comments String
- config
Context String - custom
Fields Map<String> - description String
- device
Id Number - device
Name String - disk
Size NumberMb - local
Context StringData - memory
Mb Number - name String
- platform
Id Number - platform
Slug String - primary
Ip String - primary
Ip4 String - primary
Ip6 String - role
Id Number - site
Id Number - status String
- tag
Ids List<Number> - tenant
Id Number - vcpus Number
- vm
Id Number
Package Details
- Repository
- netbox e-breuninger/terraform-provider-netbox
- License
- Notes
- This Pulumi package is based on the
netbox
Terraform Provider.
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger