opennebula 1.5.0, Jun 27 25

opennebula 1.5.0 published on Friday, Jun 27, 2025 by opennebula

opennebula/terraform-provider-opennebula

opennebula.getVirtualMachines

Start a Neo task

Explain and create an opennebula.getVirtualMachines resource

opennebula 1.5.0 published on Friday, Jun 27, 2025 by opennebula

opennebula/terraform-provider-opennebula

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as opennebula from "@pulumi/opennebula";

const example = opennebula.getVirtualMachines({
    nameRegex: "test.*",
    order: "ASC",
    sortOn: "id",
});

import pulumi
import pulumi_opennebula as opennebula

example = opennebula.get_virtual_machines(name_regex="test.*",
    order="ASC",
    sort_on="id")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opennebula/opennebula"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opennebula.GetVirtualMachines(ctx, &opennebula.GetVirtualMachinesArgs{
			NameRegex: pulumi.StringRef("test.*"),
			Order:     pulumi.StringRef("ASC"),
			SortOn:    pulumi.StringRef("id"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opennebula = Pulumi.Opennebula;

return await Deployment.RunAsync(() => 
{
    var example = Opennebula.GetVirtualMachines.Invoke(new()
    {
        NameRegex = "test.*",
        Order = "ASC",
        SortOn = "id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opennebula.OpennebulaFunctions;
import com.pulumi.opennebula.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 example = OpennebulaFunctions.getVirtualMachines(GetVirtualMachinesArgs.builder()
            .nameRegex("test.*")
            .order("ASC")
            .sortOn("id")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: opennebula:getVirtualMachines
      arguments:
        nameRegex: test.*
        order: ASC
        sortOn: id

Virtual machines attributes

id - ID of the virtual machine.
name - Name of the virtual machine.
cpu - Amount of CPU shares assigned to the VM.
vcpu - Number of CPU cores presented to the VM.
memory - Amount of RAM assigned to the VM in MB.
disk - Disk parameters.
nic - NIC parameters.
nic_alias - NIC Alias parameters.
vmgroup - VM group parameters
tags - Tags of the virtual machine (Key = Value).

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(cpu: Optional[float] = None,
                         id: Optional[str] = None,
                         memory: Optional[float] = None,
                         name_regex: Optional[str] = None,
                         order: Optional[str] = None,
                         sort_on: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         vcpu: Optional[float] = None,
                         opts: Optional[InvokeOptions] = None) -> GetVirtualMachinesResult
def get_virtual_machines_output(cpu: Optional[pulumi.Input[float]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         memory: Optional[pulumi.Input[float]] = None,
                         name_regex: Optional[pulumi.Input[str]] = None,
                         order: Optional[pulumi.Input[str]] = None,
                         sort_on: Optional[pulumi.Input[str]] = None,
                         tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                         vcpu: Optional[pulumi.Input[float]] = 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: opennebula:index/getVirtualMachines:getVirtualMachines
  arguments:
    # arguments dictionary

The following arguments are supported:

Cpu double: Amount of CPU shares assigned to the VM.
Id string
Memory double: Amount of RAM assigned to the VM in MB.
NameRegex string: Filter virtual machines by name with a RE2 regular expression.
Order string: Ordering of the sort: ASC or DESC.
SortOn string: Attribute used to sort the VMs list among: id, name, cpu, vcpu, memory.
Tags Dictionary<string, string>: virtual machine tags (Key = Value).
Vcpu double: Number of CPU cores presented to the VM.

Cpu float64: Amount of CPU shares assigned to the VM.
Id string
Memory float64: Amount of RAM assigned to the VM in MB.
NameRegex string: Filter virtual machines by name with a RE2 regular expression.
Order string: Ordering of the sort: ASC or DESC.
SortOn string: Attribute used to sort the VMs list among: id, name, cpu, vcpu, memory.
Tags map[string]string: virtual machine tags (Key = Value).
Vcpu float64: Number of CPU cores presented to the VM.

cpu Double: Amount of CPU shares assigned to the VM.
id String
memory Double: Amount of RAM assigned to the VM in MB.
nameRegex String: Filter virtual machines by name with a RE2 regular expression.
order String: Ordering of the sort: ASC or DESC.
sortOn String: Attribute used to sort the VMs list among: id, name, cpu, vcpu, memory.
tags Map<String,String>: virtual machine tags (Key = Value).
vcpu Double: Number of CPU cores presented to the VM.

cpu number: Amount of CPU shares assigned to the VM.
id string
memory number: Amount of RAM assigned to the VM in MB.
nameRegex string: Filter virtual machines by name with a RE2 regular expression.
order string: Ordering of the sort: ASC or DESC.
sortOn string: Attribute used to sort the VMs list among: id, name, cpu, vcpu, memory.
tags {[key: string]: string}: virtual machine tags (Key = Value).
vcpu number: Number of CPU cores presented to the VM.

cpu float: Amount of CPU shares assigned to the VM.
id str
memory float: Amount of RAM assigned to the VM in MB.
name_regex str: Filter virtual machines by name with a RE2 regular expression.
order str: Ordering of the sort: ASC or DESC.
sort_on str: Attribute used to sort the VMs list among: id, name, cpu, vcpu, memory.
tags Mapping[str, str]: virtual machine tags (Key = Value).
vcpu float: Number of CPU cores presented to the VM.

cpu Number: Amount of CPU shares assigned to the VM.
id String
memory Number: Amount of RAM assigned to the VM in MB.
nameRegex String: Filter virtual machines by name with a RE2 regular expression.
order String: Ordering of the sort: ASC or DESC.
sortOn String: Attribute used to sort the VMs list among: id, name, cpu, vcpu, memory.
tags Map<String>: virtual machine tags (Key = Value).
vcpu Number: Number of CPU cores presented to the VM.

getVirtualMachines Result

The following output properties are available:

Cpu double
Id string
Memory double
Vcpu double
VirtualMachines List<GetVirtualMachinesVirtualMachine>: For each filtered virtual machine, this section collect a list of attributes. See virtual-machines-attributes
NameRegex string
Order string
SortOn string
Tags Dictionary<string, string>

Cpu float64
Id string
Memory float64
Vcpu float64
VirtualMachines []GetVirtualMachinesVirtualMachine: For each filtered virtual machine, this section collect a list of attributes. See virtual-machines-attributes
NameRegex string
Order string
SortOn string
Tags map[string]string

cpu Double
id String
memory Double
vcpu Double
virtualMachines List<GetVirtualMachinesVirtualMachine>: For each filtered virtual machine, this section collect a list of attributes. See virtual-machines-attributes
nameRegex String
order String
sortOn String
tags Map<String,String>

cpu number
id string
memory number
vcpu number
virtualMachines GetVirtualMachinesVirtualMachine[]: For each filtered virtual machine, this section collect a list of attributes. See virtual-machines-attributes
nameRegex string
order string
sortOn string
tags {[key: string]: string}

cpu float
id str
memory float
vcpu float
virtual_machines Sequence[GetVirtualMachinesVirtualMachine]: For each filtered virtual machine, this section collect a list of attributes. See virtual-machines-attributes
name_regex str
order str
sort_on str
tags Mapping[str, str]

cpu Number
id String
memory Number
vcpu Number
virtualMachines List<Property Map>: For each filtered virtual machine, this section collect a list of attributes. See virtual-machines-attributes
nameRegex String
order String
sortOn String
tags Map<String>

Supporting Types

GetVirtualMachinesVirtualMachine

Cpu double: Amount of CPU shares assigned to the VM.
Disks List<GetVirtualMachinesVirtualMachineDisk>
Id double
Memory double: Amount of RAM assigned to the VM in MB.
Name string
NicAliases List<GetVirtualMachinesVirtualMachineNicAlias>
Nics List<GetVirtualMachinesVirtualMachineNic>
Tags Dictionary<string, string>: virtual machine tags (Key = Value).
Vcpu double: Number of CPU cores presented to the VM.
Vmgroups List<GetVirtualMachinesVirtualMachineVmgroup>

Cpu float64: Amount of CPU shares assigned to the VM.
Disks []GetVirtualMachinesVirtualMachineDisk
Id float64
Memory float64: Amount of RAM assigned to the VM in MB.
Name string
NicAliases []GetVirtualMachinesVirtualMachineNicAlias
Nics []GetVirtualMachinesVirtualMachineNic
Tags map[string]string: virtual machine tags (Key = Value).
Vcpu float64: Number of CPU cores presented to the VM.
Vmgroups []GetVirtualMachinesVirtualMachineVmgroup

cpu Double: Amount of CPU shares assigned to the VM.
disks List<GetVirtualMachinesVirtualMachineDisk>
id Double
memory Double: Amount of RAM assigned to the VM in MB.
name String
nicAliases List<GetVirtualMachinesVirtualMachineNicAlias>
nics List<GetVirtualMachinesVirtualMachineNic>
tags Map<String,String>: virtual machine tags (Key = Value).
vcpu Double: Number of CPU cores presented to the VM.
vmgroups List<GetVirtualMachinesVirtualMachineVmgroup>

cpu number: Amount of CPU shares assigned to the VM.
disks GetVirtualMachinesVirtualMachineDisk[]
id number
memory number: Amount of RAM assigned to the VM in MB.
name string
nicAliases GetVirtualMachinesVirtualMachineNicAlias[]
nics GetVirtualMachinesVirtualMachineNic[]
tags {[key: string]: string}: virtual machine tags (Key = Value).
vcpu number: Number of CPU cores presented to the VM.
vmgroups GetVirtualMachinesVirtualMachineVmgroup[]

cpu float: Amount of CPU shares assigned to the VM.
disks Sequence[GetVirtualMachinesVirtualMachineDisk]
id float
memory float: Amount of RAM assigned to the VM in MB.
name str
nic_aliases Sequence[GetVirtualMachinesVirtualMachineNicAlias]
nics Sequence[GetVirtualMachinesVirtualMachineNic]
tags Mapping[str, str]: virtual machine tags (Key = Value).
vcpu float: Number of CPU cores presented to the VM.
vmgroups Sequence[GetVirtualMachinesVirtualMachineVmgroup]

cpu Number: Amount of CPU shares assigned to the VM.
disks List<Property Map>
id Number
memory Number: Amount of RAM assigned to the VM in MB.
name String
nicAliases List<Property Map>
nics List<Property Map>
tags Map<String>: virtual machine tags (Key = Value).
vcpu Number: Number of CPU cores presented to the VM.
vmgroups List<Property Map>

GetVirtualMachinesVirtualMachineDisk

Cache string
DevPrefix string
Discard string
Driver string
ImageId double
Io string
Size double
Target string
VolatileFormat string
VolatileType string

Cache string
DevPrefix string
Discard string
Driver string
ImageId float64
Io string
Size float64
Target string
VolatileFormat string
VolatileType string

cache String
devPrefix String
discard String
driver String
imageId Double
io String
size Double
target String
volatileFormat String
volatileType String

cache string
devPrefix string
discard string
driver string
imageId number
io string
size number
target string
volatileFormat string
volatileType string

cache str
dev_prefix str
discard str
driver str
image_id float
io str
size float
target str
volatile_format str
volatile_type str

cache String
devPrefix String
discard String
driver String
imageId Number
io String
size Number
target String
volatileFormat String
volatileType String

GetVirtualMachinesVirtualMachineNic

Dns string
Gateway string
Ip string
Ip6 string
Ip6Global string
Ip6Link string
Ip6Ula string
Mac string
Method string
Model string
Name string
Network string
NetworkId double
NetworkModeAuto bool
PhysicalDevice string
SchedRank string
SchedRequirements string
SecurityGroups List<double>
VirtioQueues string

Dns string
Gateway string
Ip string
Ip6 string
Ip6Global string
Ip6Link string
Ip6Ula string
Mac string
Method string
Model string
Name string
Network string
NetworkId float64
NetworkModeAuto bool
PhysicalDevice string
SchedRank string
SchedRequirements string
SecurityGroups []float64
VirtioQueues string

dns String
gateway String
ip String
ip6 String
ip6Global String
ip6Link String
ip6Ula String
mac String
method String
model String
name String
network String
networkId Double
networkModeAuto Boolean
physicalDevice String
schedRank String
schedRequirements String
securityGroups List<Double>
virtioQueues String

dns string
gateway string
ip string
ip6 string
ip6Global string
ip6Link string
ip6Ula string
mac string
method string
model string
name string
network string
networkId number
networkModeAuto boolean
physicalDevice string
schedRank string
schedRequirements string
securityGroups number[]
virtioQueues string

dns str
gateway str
ip str
ip6 str
ip6_global str
ip6_link str
ip6_ula str
mac str
method str
model str
name str
network str
network_id float
network_mode_auto bool
physical_device str
sched_rank str
sched_requirements str
security_groups Sequence[float]
virtio_queues str

dns String
gateway String
ip String
ip6 String
ip6Global String
ip6Link String
ip6Ula String
mac String
method String
model String
name String
network String
networkId Number
networkModeAuto Boolean
physicalDevice String
schedRank String
schedRequirements String
securityGroups List<Number>
virtioQueues String

GetVirtualMachinesVirtualMachineNicAlias

Dns string
Gateway string
Ip string
Ip6 string
Ip6Global string
Ip6Link string
Ip6Ula string
Mac string
Name string
Network string
NetworkId double
Parent string
SecurityGroups List<double>

Dns string
Gateway string
Ip string
Ip6 string
Ip6Global string
Ip6Link string
Ip6Ula string
Mac string
Name string
Network string
NetworkId float64
Parent string
SecurityGroups []float64

dns String
gateway String
ip String
ip6 String
ip6Global String
ip6Link String
ip6Ula String
mac String
name String
network String
networkId Double
parent String
securityGroups List<Double>

dns string
gateway string
ip string
ip6 string
ip6Global string
ip6Link string
ip6Ula string
mac string
name string
network string
networkId number
parent string
securityGroups number[]

dns str
gateway str
ip str
ip6 str
ip6_global str
ip6_link str
ip6_ula str
mac str
name str
network str
network_id float
parent str
security_groups Sequence[float]

dns String
gateway String
ip String
ip6 String
ip6Global String
ip6Link String
ip6Ula String
mac String
name String
network String
networkId Number
parent String
securityGroups List<Number>

GetVirtualMachinesVirtualMachineVmgroup

Role string
VmgroupId double

Role string
VmgroupId float64

role String
vmgroupId Double

role string
vmgroupId number

role str
vmgroup_id float

role String
vmgroupId Number

Package Details

Repository: opennebula opennebula/terraform-provider-opennebula
License
Notes: This Pulumi package is based on the opennebula Terraform Provider.

opennebula 1.5.0 published on Friday, Jun 27, 2025 by opennebula

opennebula/terraform-provider-opennebula

opennebula.getVirtualMachines

On this page

On this page

Example Usage

Virtual machines attributes

Using getVirtualMachines

getVirtualMachines Result

Supporting Types

GetVirtualMachinesVirtualMachine

GetVirtualMachinesVirtualMachineDisk

GetVirtualMachinesVirtualMachineNic

GetVirtualMachinesVirtualMachineNicAlias

GetVirtualMachinesVirtualMachineVmgroup

Package Details

On this page

On this page