xenorchestra v1.5.2, Mar 10 25

xenorchestra v1.5.2 published on Monday, Mar 10, 2025 by Vates

xenorchestra.getVms

Explore with Pulumi AI

xenorchestra v1.5.2 published on Monday, Mar 10, 2025 by Vates

Using getVms

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.

TypeScript
Python
Go
C#
Java
YAML

function getVms(args: GetVmsArgs, opts?: InvokeOptions): Promise<GetVmsResult>
function getVmsOutput(args: GetVmsOutputArgs, opts?: InvokeOptions): Output<GetVmsResult>

def get_vms(host: Optional[str] = None,
            pool_id: Optional[str] = None,
            power_state: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetVmsResult
def get_vms_output(host: Optional[pulumi.Input[str]] = None,
            pool_id: Optional[pulumi.Input[str]] = None,
            power_state: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetVmsResult]

func GetVms(ctx *Context, args *GetVmsArgs, opts ...InvokeOption) (*GetVmsResult, error)
func GetVmsOutput(ctx *Context, args *GetVmsOutputArgs, opts ...InvokeOption) GetVmsResultOutput

> Note: This function is named GetVms in the Go SDK.

public static class GetVms 
{
    public static Task<GetVmsResult> InvokeAsync(GetVmsArgs args, InvokeOptions? opts = null)
    public static Output<GetVmsResult> Invoke(GetVmsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVmsResult> getVms(GetVmsArgs args, InvokeOptions options)
public static Output<GetVmsResult> getVms(GetVmsArgs args, InvokeOptions options)

fn::invoke:
  function: xenorchestra:index/getVms:getVms
  arguments:
    # arguments dictionary

The following arguments are supported:

PoolId string: The ID of the pool the VM belongs to.
Host string
PowerState string: The power state of the vms. (Running, Halted)

PoolId string: The ID of the pool the VM belongs to.
Host string
PowerState string: The power state of the vms. (Running, Halted)

poolId String: The ID of the pool the VM belongs to.
host String
powerState String: The power state of the vms. (Running, Halted)

poolId string: The ID of the pool the VM belongs to.
host string
powerState string: The power state of the vms. (Running, Halted)

pool_id str: The ID of the pool the VM belongs to.
host str
power_state str: The power state of the vms. (Running, Halted)

poolId String: The ID of the pool the VM belongs to.
host String
powerState String: The power state of the vms. (Running, Halted)

getVms Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
PoolId string: The ID of the pool the VM belongs to.
Vms List<GetVmsVm>: A list of information for all vms found in this pool.
Host string
PowerState string: The power state of the vms. (Running, Halted)

Id string: The provider-assigned unique ID for this managed resource.
PoolId string: The ID of the pool the VM belongs to.
Vms []GetVmsVm: A list of information for all vms found in this pool.
Host string
PowerState string: The power state of the vms. (Running, Halted)

id String: The provider-assigned unique ID for this managed resource.
poolId String: The ID of the pool the VM belongs to.
vms List<GetVmsVm>: A list of information for all vms found in this pool.
host String
powerState String: The power state of the vms. (Running, Halted)

id string: The provider-assigned unique ID for this managed resource.
poolId string: The ID of the pool the VM belongs to.
vms GetVmsVm[]: A list of information for all vms found in this pool.
host string
powerState string: The power state of the vms. (Running, Halted)

id str: The provider-assigned unique ID for this managed resource.
pool_id str: The ID of the pool the VM belongs to.
vms Sequence[GetVmsVm]: A list of information for all vms found in this pool.
host str
power_state str: The power state of the vms. (Running, Halted)

id String: The provider-assigned unique ID for this managed resource.
poolId String: The ID of the pool the VM belongs to.
vms List<Property Map>: A list of information for all vms found in this pool.
host String
powerState String: The power state of the vms. (Running, Halted)

Supporting Types

GetVmsVm

Cpus int

The number of CPUs the VM will have. Updates to this field will cause a stop and start of the VM if the new CPU value is greater than the max CPU value. This can be determined with the following command:


$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].CPUs'
{
  "max": 4,
  "number": 2
}






    Updating the VM to use 3 CPUs would happen without stopping/starting the VM







    Updating the VM to use 5 CPUs would stop/start the VM

Disks List<GetVmsVmDisk>

The disk the VM will have access to.

Id string

Ipv4Addresses List<string>

Ipv6Addresses List<string>

This is only accessible if guest-tools is installed in the VM and if expected_ip_cidr is set on any network interfaces. This will contain a list of the ipv6 addresses across all network interfaces in order.

MemoryMax int

The amount of memory in bytes the VM will have. Updates to this field will case a stop and start of the VM if the new value is greater than the dynamic memory max. This can be determined with the following command:



$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].memory.dynamic'
[
  2147483648, # memory dynamic min
  4294967296  # memory dynamic max (4GB)
]
# Updating the VM to use 3GB of memory would happen without stopping/starting the VM
# Updating the VM to use 5GB of memory would stop/start the VM

title="Required">  NameLabel string

The name of the VM.

Networks List<GetVmsVmNetwork>

The network for the VM.

Template string

The ID of the VM template to create the new VM from.

AffinityHost string

The preferred host you would like the VM to run on. If changed on an existing VM it will require a reboot for the VM to be rescheduled.

AutoPoweron bool

If the VM will automatically turn on. Defaults to false.

BlockedOperations List<string>

List of operations on a VM that are not permitted. Examples include: clean_reboot, clean_shutdown, hard_reboot, hard_shutdown, pause, shutdown, suspend, destroy. This can be used to prevent a VM from being destroyed. The entire list can be found here

CloneType string

The type of clone to perform for the VM. Possible values include fast or full and defaults to fast. In order to perform a full clone, the VM template must not be a disk template.

CloudConfig string

The content of the cloud-init config to use. See the cloud init docs for more information.

CloudNetworkConfig string

The content of the cloud-init network configuration for the VM (uses version 1)

CoreOs bool

CpuCap int

CpuWeight int

ExpNestedHvm bool

Boolean parameter that allows a VM to use nested virtualization.

HighAvailability string

The restart priority for the VM. Possible values are best-effort, restart and empty string (no restarts on failure. Defaults to empty string

Host string

HvmBootFirmware string

The firmware to use for the VM. Possible values are bios and uefi.

NameDescription string

The description of the VM.

PowerState string

The power state of the VM. This can be Running, Halted, Paused or Suspended.

ResourceSet string

StartDelay int

Number of seconds the VM should be delayed from starting.

Tags List<string>

The tags (labels) applied to the given entity.

Vga string

The video adapter the VM should use. Possible values include std and cirrus.

Videoram int

The videoram option the VM should use. Possible values include 1, 2, 4, 8, 16

Xenstore Dictionary<string, string>

The key value pairs to be populated in xenstore.

Cpus int


$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].CPUs'
{
  "max": 4,
  "number": 2
}






    Updating the VM to use 3 CPUs would happen without stopping/starting the VM







    Updating the VM to use 5 CPUs would stop/start the VM

Disks []GetVmsVmDisk

The disk the VM will have access to.

Id string

Ipv4Addresses []string

Ipv6Addresses []string

MemoryMax int



$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].memory.dynamic'
[
  2147483648, # memory dynamic min
  4294967296  # memory dynamic max (4GB)
]
# Updating the VM to use 3GB of memory would happen without stopping/starting the VM
# Updating the VM to use 5GB of memory would stop/start the VM

title="Required">  NameLabel string

The name of the VM.

Networks []GetVmsVmNetwork

The network for the VM.

Template string

The ID of the VM template to create the new VM from.

AffinityHost string

The preferred host you would like the VM to run on. If changed on an existing VM it will require a reboot for the VM to be rescheduled.

AutoPoweron bool

If the VM will automatically turn on. Defaults to false.

BlockedOperations []string

CloneType string

The type of clone to perform for the VM. Possible values include fast or full and defaults to fast. In order to perform a full clone, the VM template must not be a disk template.

CloudConfig string

The content of the cloud-init config to use. See the cloud init docs for more information.

CloudNetworkConfig string

The content of the cloud-init network configuration for the VM (uses version 1)

CoreOs bool

CpuCap int

CpuWeight int

ExpNestedHvm bool

Boolean parameter that allows a VM to use nested virtualization.

HighAvailability string

The restart priority for the VM. Possible values are best-effort, restart and empty string (no restarts on failure. Defaults to empty string

Host string

HvmBootFirmware string

The firmware to use for the VM. Possible values are bios and uefi.

NameDescription string

The description of the VM.

PowerState string

The power state of the VM. This can be Running, Halted, Paused or Suspended.

ResourceSet string

StartDelay int

Number of seconds the VM should be delayed from starting.

Tags []string

The tags (labels) applied to the given entity.

Vga string

The video adapter the VM should use. Possible values include std and cirrus.

Videoram int

The videoram option the VM should use. Possible values include 1, 2, 4, 8, 16

Xenstore map[string]string

The key value pairs to be populated in xenstore.

cpus Integer


$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].CPUs'
{
  "max": 4,
  "number": 2
}






    Updating the VM to use 3 CPUs would happen without stopping/starting the VM







    Updating the VM to use 5 CPUs would stop/start the VM

disks List<GetVmsVmDisk>

The disk the VM will have access to.

id String

ipv4Addresses List<String>

ipv6Addresses List<String>

memoryMax Integer



$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].memory.dynamic'
[
  2147483648, # memory dynamic min
  4294967296  # memory dynamic max (4GB)
]
# Updating the VM to use 3GB of memory would happen without stopping/starting the VM
# Updating the VM to use 5GB of memory would stop/start the VM

title="Required">  nameLabel String

The name of the VM.

networks List<GetVmsVmNetwork>

The network for the VM.

template String

The ID of the VM template to create the new VM from.

affinityHost String

The preferred host you would like the VM to run on. If changed on an existing VM it will require a reboot for the VM to be rescheduled.

autoPoweron Boolean

If the VM will automatically turn on. Defaults to false.

blockedOperations List<String>

cloneType String

The type of clone to perform for the VM. Possible values include fast or full and defaults to fast. In order to perform a full clone, the VM template must not be a disk template.

cloudConfig String

The content of the cloud-init config to use. See the cloud init docs for more information.

cloudNetworkConfig String

The content of the cloud-init network configuration for the VM (uses version 1)

coreOs Boolean

cpuCap Integer

cpuWeight Integer

expNestedHvm Boolean

Boolean parameter that allows a VM to use nested virtualization.

highAvailability String

The restart priority for the VM. Possible values are best-effort, restart and empty string (no restarts on failure. Defaults to empty string

host String

hvmBootFirmware String

The firmware to use for the VM. Possible values are bios and uefi.

nameDescription String

The description of the VM.

powerState String

The power state of the VM. This can be Running, Halted, Paused or Suspended.

resourceSet String

startDelay Integer

Number of seconds the VM should be delayed from starting.

tags List<String>

The tags (labels) applied to the given entity.

vga String

The video adapter the VM should use. Possible values include std and cirrus.

videoram Integer

The videoram option the VM should use. Possible values include 1, 2, 4, 8, 16

xenstore Map<String,String>

The key value pairs to be populated in xenstore.

cpus number


$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].CPUs'
{
  "max": 4,
  "number": 2
}






    Updating the VM to use 3 CPUs would happen without stopping/starting the VM







    Updating the VM to use 5 CPUs would stop/start the VM

disks GetVmsVmDisk[]

The disk the VM will have access to.

id string

ipv4Addresses string[]

ipv6Addresses string[]

memoryMax number



$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].memory.dynamic'
[
  2147483648, # memory dynamic min
  4294967296  # memory dynamic max (4GB)
]
# Updating the VM to use 3GB of memory would happen without stopping/starting the VM
# Updating the VM to use 5GB of memory would stop/start the VM

title="Required">  nameLabel string

The name of the VM.

networks GetVmsVmNetwork[]

The network for the VM.

template string

The ID of the VM template to create the new VM from.

affinityHost string

The preferred host you would like the VM to run on. If changed on an existing VM it will require a reboot for the VM to be rescheduled.

autoPoweron boolean

If the VM will automatically turn on. Defaults to false.

blockedOperations string[]

cloneType string

The type of clone to perform for the VM. Possible values include fast or full and defaults to fast. In order to perform a full clone, the VM template must not be a disk template.

cloudConfig string

The content of the cloud-init config to use. See the cloud init docs for more information.

cloudNetworkConfig string

The content of the cloud-init network configuration for the VM (uses version 1)

coreOs boolean

cpuCap number

cpuWeight number

expNestedHvm boolean

Boolean parameter that allows a VM to use nested virtualization.

highAvailability string

The restart priority for the VM. Possible values are best-effort, restart and empty string (no restarts on failure. Defaults to empty string

host string

hvmBootFirmware string

The firmware to use for the VM. Possible values are bios and uefi.

nameDescription string

The description of the VM.

powerState string

The power state of the VM. This can be Running, Halted, Paused or Suspended.

resourceSet string

startDelay number

Number of seconds the VM should be delayed from starting.

tags string[]

The tags (labels) applied to the given entity.

vga string

The video adapter the VM should use. Possible values include std and cirrus.

videoram number

The videoram option the VM should use. Possible values include 1, 2, 4, 8, 16

xenstore {[key: string]: string}

The key value pairs to be populated in xenstore.

cpus int


$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].CPUs'
{
  "max": 4,
  "number": 2
}






    Updating the VM to use 3 CPUs would happen without stopping/starting the VM







    Updating the VM to use 5 CPUs would stop/start the VM

disks Sequence[GetVmsVmDisk]

The disk the VM will have access to.

id str

ipv4_addresses Sequence[str]

ipv6_addresses Sequence[str]

memory_max int



$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].memory.dynamic'
[
  2147483648, # memory dynamic min
  4294967296  # memory dynamic max (4GB)
]
# Updating the VM to use 3GB of memory would happen without stopping/starting the VM
# Updating the VM to use 5GB of memory would stop/start the VM

title="Required">  name_label str

The name of the VM.

networks Sequence[GetVmsVmNetwork]

The network for the VM.

template str

The ID of the VM template to create the new VM from.

affinity_host str

The preferred host you would like the VM to run on. If changed on an existing VM it will require a reboot for the VM to be rescheduled.

auto_poweron bool

If the VM will automatically turn on. Defaults to false.

blocked_operations Sequence[str]

clone_type str

The type of clone to perform for the VM. Possible values include fast or full and defaults to fast. In order to perform a full clone, the VM template must not be a disk template.

cloud_config str

The content of the cloud-init config to use. See the cloud init docs for more information.

cloud_network_config str

The content of the cloud-init network configuration for the VM (uses version 1)

core_os bool

cpu_cap int

cpu_weight int

exp_nested_hvm bool

Boolean parameter that allows a VM to use nested virtualization.

high_availability str

The restart priority for the VM. Possible values are best-effort, restart and empty string (no restarts on failure. Defaults to empty string

host str

hvm_boot_firmware str

The firmware to use for the VM. Possible values are bios and uefi.

name_description str

The description of the VM.

power_state str

The power state of the VM. This can be Running, Halted, Paused or Suspended.

resource_set str

start_delay int

Number of seconds the VM should be delayed from starting.

tags Sequence[str]

The tags (labels) applied to the given entity.

vga str

The video adapter the VM should use. Possible values include std and cirrus.

videoram int

The videoram option the VM should use. Possible values include 1, 2, 4, 8, 16

xenstore Mapping[str, str]

The key value pairs to be populated in xenstore.

cpus Number


$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].CPUs'
{
  "max": 4,
  "number": 2
}






    Updating the VM to use 3 CPUs would happen without stopping/starting the VM







    Updating the VM to use 5 CPUs would stop/start the VM

disks List<Property Map>

The disk the VM will have access to.

id String

ipv4Addresses List<String>

ipv6Addresses List<String>

memoryMax Number



$ xo-cli xo.getAllObjects filter='json:{"id": "cf7b5d7d-3cd5-6b7c-5025-5c935c8cd0b8"}' | jq '.[].memory.dynamic'
[
  2147483648, # memory dynamic min
  4294967296  # memory dynamic max (4GB)
]
# Updating the VM to use 3GB of memory would happen without stopping/starting the VM
# Updating the VM to use 5GB of memory would stop/start the VM

title="Required">  nameLabel String

The name of the VM.

networks List<Property Map>

The network for the VM.

template String

The ID of the VM template to create the new VM from.

affinityHost String

The preferred host you would like the VM to run on. If changed on an existing VM it will require a reboot for the VM to be rescheduled.

autoPoweron Boolean

If the VM will automatically turn on. Defaults to false.

blockedOperations List<String>

cloneType String

The type of clone to perform for the VM. Possible values include fast or full and defaults to fast. In order to perform a full clone, the VM template must not be a disk template.

cloudConfig String