libvirt.Domain

Clock configuration for the domain.

CPU configuration for the domain.

Domain start flags corresponding to virDomainCreateFlags. Only used when running=true.

currentMemory Double

Actual memory allocation at boot time. If not set, defaults to memory value.

description String

Human-readable description of the domain.

Domain shutdown behavior. Controls how the domain is stopped when running changes from true to false or when the resource is destroyed.

Devices attached to the domain (disks, network interfaces, etc.).

Hypervisor features to enable.

hwuuid String

Hardware UUID for the domain.

iothreads Double

Number of I/O threads for virtio disks.

maxMemory Double

Maximum memory for hotplug. Must be >= memory.

maxMemorySlots Double

Number of slots for memory hotplug. Required when max_memory is set.

metadata String

Custom metadata XML for the domain.

This allows applications to store custom information within the domain's XML configuration.

Requirements:

Must be valid XML
Must use custom namespaces (e.g., xmlns:app1="http://app1.org/app1/")
Only one top-level element per namespace

Example:

<app1:foo xmlns:app1="http://app1.org/app1/">
  <app1:bar>some content</app1:bar>
</app1:foo>

See libvirt metadata documentation for more details.

name String

Domain name. Must be unique on the host.

onCrash String

Action to take when guest crashes (destroy, restart, preserve, rename-restart, coredump-destroy, coredump-restart).

onPoweroff String

Action to take when guest requests poweroff (destroy, restart, preserve, rename-restart).

onReboot String

Action to take when guest requests reboot (destroy, restart, preserve, rename-restart).

Operating system configuration for the domain.

Power management configuration for the domain.

running Boolean

Whether the domain should be running. If true, the domain will be started after creation. If false or unset, the domain will only be defined but not started.

title String

Short description title for the domain.

type String

Domain type (e.g., 'kvm', 'qemu').

unit String

Memory unit (KiB, MiB, GiB, TiB).

uuid String

Domain UUID. If not specified, one will be generated.

memory number

Maximum memory allocation in the specified unit. Default unit is KiB.

vcpu number

Number of virtual CPUs.

autostart boolean

Whether the domain should be started automatically when the host boots.

bootloader string

Bootloader path for paravirtualized guests (Xen).

bootloaderArgs string

Arguments to pass to bootloader.

Clock configuration for the domain.

CPU configuration for the domain.

Domain start flags corresponding to virDomainCreateFlags. Only used when running=true.

currentMemory number

Actual memory allocation at boot time. If not set, defaults to memory value.

description string

Human-readable description of the domain.

Domain shutdown behavior. Controls how the domain is stopped when running changes from true to false or when the resource is destroyed.

Devices attached to the domain (disks, network interfaces, etc.).

Hypervisor features to enable.

hwuuid string

Hardware UUID for the domain.

iothreads number

Number of I/O threads for virtio disks.

maxMemory number

Maximum memory for hotplug. Must be >= memory.

maxMemorySlots number

Number of slots for memory hotplug. Required when max_memory is set.

metadata string

Custom metadata XML for the domain.

This allows applications to store custom information within the domain's XML configuration.

Requirements:

Must be valid XML
Must use custom namespaces (e.g., xmlns:app1="http://app1.org/app1/")
Only one top-level element per namespace

Example:

<app1:foo xmlns:app1="http://app1.org/app1/">
  <app1:bar>some content</app1:bar>
</app1:foo>

See libvirt metadata documentation for more details.

name string

Domain name. Must be unique on the host.

onCrash string

Action to take when guest crashes (destroy, restart, preserve, rename-restart, coredump-destroy, coredump-restart).

onPoweroff string

Action to take when guest requests poweroff (destroy, restart, preserve, rename-restart).

onReboot string

Action to take when guest requests reboot (destroy, restart, preserve, rename-restart).

Operating system configuration for the domain.

clock DomainClockArgs

Power management configuration for the domain.

running boolean

Whether the domain should be running. If true, the domain will be started after creation. If false or unset, the domain will only be defined but not started.

title string

Short description title for the domain.

type string

Domain type (e.g., 'kvm', 'qemu').

unit string

Memory unit (KiB, MiB, GiB, TiB).

uuid string

Domain UUID. If not specified, one will be generated.

memory float

Maximum memory allocation in the specified unit. Default unit is KiB.

vcpu float

Number of virtual CPUs.

autostart bool

Whether the domain should be started automatically when the host boots.

bootloader str

Bootloader path for paravirtualized guests (Xen).

bootloader_args str

Arguments to pass to bootloader.

Clock configuration for the domain.

cpu DomainCpuArgs

CPU configuration for the domain.

create DomainCreateArgs

Domain start flags corresponding to virDomainCreateFlags. Only used when running=true.

current_memory float

Actual memory allocation at boot time. If not set, defaults to memory value.

description str

Human-readable description of the domain.

destroy DomainDestroyArgs

Domain shutdown behavior. Controls how the domain is stopped when running changes from true to false or when the resource is destroyed.

devices DomainDevicesArgs

Devices attached to the domain (disks, network interfaces, etc.).

features DomainFeaturesArgs

Hypervisor features to enable.

hwuuid str

Hardware UUID for the domain.

iothreads float

Number of I/O threads for virtio disks.

max_memory float

Maximum memory for hotplug. Must be >= memory.

max_memory_slots float

Number of slots for memory hotplug. Required when max_memory is set.

metadata str

Custom metadata XML for the domain.

This allows applications to store custom information within the domain's XML configuration.

Requirements:

Must be valid XML
Must use custom namespaces (e.g., xmlns:app1="http://app1.org/app1/")
Only one top-level element per namespace

Example:

<app1:foo xmlns:app1="http://app1.org/app1/">
  <app1:bar>some content</app1:bar>
</app1:foo>

See libvirt metadata documentation for more details.

name str

Domain name. Must be unique on the host.

on_crash str

Action to take when guest crashes (destroy, restart, preserve, rename-restart, coredump-destroy, coredump-restart).

on_poweroff str

Action to take when guest requests poweroff (destroy, restart, preserve, rename-restart).

on_reboot str

Action to take when guest requests reboot (destroy, restart, preserve, rename-restart).

os DomainOsArgs

Operating system configuration for the domain.

pm DomainPmArgs

Power management configuration for the domain.

running bool

Whether the domain should be running. If true, the domain will be started after creation. If false or unset, the domain will only be defined but not started.

title str

Short description title for the domain.

type str

Domain type (e.g., 'kvm', 'qemu').

unit str

Memory unit (KiB, MiB, GiB, TiB).

uuid str

Domain UUID. If not specified, one will be generated.

memory Number

Maximum memory allocation in the specified unit. Default unit is KiB.

vcpu Number

Number of virtual CPUs.

autostart Boolean

Whether the domain should be started automatically when the host boots.

bootloader String

Bootloader path for paravirtualized guests (Xen).

bootloaderArgs String

Arguments to pass to bootloader.

clock Property Map

Clock configuration for the domain.

cpu Property Map

CPU configuration for the domain.

create Property Map

Domain start flags corresponding to virDomainCreateFlags. Only used when running=true.

currentMemory Number

Actual memory allocation at boot time. If not set, defaults to memory value.

description String

Human-readable description of the domain.

destroy Property Map

Domain shutdown behavior. Controls how the domain is stopped when running changes from true to false or when the resource is destroyed.

devices Property Map

Devices attached to the domain (disks, network interfaces, etc.).

features Property Map

Hypervisor features to enable.

hwuuid String

Hardware UUID for the domain.

iothreads Number

Number of I/O threads for virtio disks.

maxMemory Number

Maximum memory for hotplug. Must be >= memory.

maxMemorySlots Number

Number of slots for memory hotplug. Required when max_memory is set.

metadata String

Custom metadata XML for the domain.

This allows applications to store custom information within the domain's XML configuration.

Requirements:

Must be valid XML
Must use custom namespaces (e.g., xmlns:app1="http://app1.org/app1/")
Only one top-level element per namespace

Example:

<app1:foo xmlns:app1="http://app1.org/app1/">
  <app1:bar>some content</app1:bar>
</app1:foo>

See libvirt metadata documentation for more details.

name String

Domain name. Must be unique on the host.

onCrash String

Action to take when guest crashes (destroy, restart, preserve, rename-restart, coredump-destroy, coredump-restart).

onPoweroff String

Action to take when guest requests poweroff (destroy, restart, preserve, rename-restart).

onReboot String

Action to take when guest requests reboot (destroy, restart, preserve, rename-restart).

os Property Map

Operating system configuration for the domain.

pm Property Map

Power management configuration for the domain.

running Boolean

Whether the domain should be running. If true, the domain will be started after creation. If false or unset, the domain will only be defined but not started.

title String

Short description title for the domain.

type String

Domain type (e.g., 'kvm', 'qemu').

unit String

Memory unit (KiB, MiB, GiB, TiB).

uuid String

Domain UUID. If not specified, one will be generated.

Outputs

All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Domain Resource

Get an existing Domain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DomainState, opts?: CustomResourceOptions): Domain

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autostart: Optional[bool] = None,
        bootloader: Optional[str] = None,
        bootloader_args: Optional[str] = None,
        clock: Optional[DomainClockArgs] = None,
        cpu: Optional[DomainCpuArgs] = None,
        create: Optional[DomainCreateArgs] = None,
        current_memory: Optional[float] = None,
        description: Optional[str] = None,
        destroy: Optional[DomainDestroyArgs] = None,
        devices: Optional[DomainDevicesArgs] = None,
        features: Optional[DomainFeaturesArgs] = None,
        hwuuid: Optional[str] = None,
        iothreads: Optional[float] = None,
        max_memory: Optional[float] = None,
        max_memory_slots: Optional[float] = None,
        memory: Optional[float] = None,
        metadata: Optional[str] = None,
        name: Optional[str] = None,
        on_crash: Optional[str] = None,
        on_poweroff: Optional[str] = None,
        on_reboot: Optional[str] = None,
        os: Optional[DomainOsArgs] = None,
        pm: Optional[DomainPmArgs] = None,
        running: Optional[bool] = None,
        title: Optional[str] = None,
        type: Optional[str] = None,
        unit: Optional[str] = None,
        uuid: Optional[str] = None,
        vcpu: Optional[float] = None) -> Domain

func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)

public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)

public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)

resources:  _:    type: libvirt:Domain    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Autostart bool

Whether the domain should be started automatically when the host boots.

Bootloader string

Bootloader path for paravirtualized guests (Xen).

BootloaderArgs string

Arguments to pass to bootloader.

Clock DomainClock

Clock configuration for the domain.

Cpu DomainCpu

CPU configuration for the domain.

Create DomainCreate

Domain start flags corresponding to virDomainCreateFlags. Only used when running=true.

CurrentMemory double

Actual memory allocation at boot time. If not set, defaults to memory value.

Description string

Human-readable description of the domain.

Destroy DomainDestroy

Domain shutdown behavior. Controls how the domain is stopped when running changes from true to false or when the resource is destroyed.

Devices DomainDevices

Devices attached to the domain (disks, network interfaces, etc.).

Features DomainFeatures

Hypervisor features to enable.

Hwuuid string

Hardware UUID for the domain.

Iothreads double

Number of I/O threads for virtio disks.

MaxMemory double

Maximum memory for hotplug. Must be >= memory.

MaxMemorySlots double

Number of slots for memory hotplug. Required when max_memory is set.

Memory double

Maximum memory allocation in the specified unit. Default unit is KiB.

Metadata string

Custom metadata XML for the domain.

This allows applications to store custom information within the domain's XML configuration.

Requirements:

Must be valid XML
Must use custom namespaces (e.g., xmlns:app1="http://app1.org/app1/")
Only one top-level element per namespace

Example:

<app1:foo xmlns:app1="http://app1.org/app1/">
  <app1:bar>some content</app1:bar>
</app1:foo>

See libvirt metadata documentation for more details.

Name string

Domain name. Must be unique on the host.

OnCrash string

Action to take when guest crashes (destroy, restart, preserve, rename-restart, coredump-destroy, coredump-restart).

OnPoweroff string

Action to take when guest requests poweroff (destroy, restart, preserve, rename-restart).

OnReboot string

Action to take when guest requests reboot (destroy, restart, preserve, rename-restart).

Os DomainOs

Operating system configuration for the domain.

Pm DomainPm

Power management configuration for the domain.

Running bool

Whether the domain should be running. If true, the domain will be started after creation. If false or unset, the domain will only be defined but not started.

Title string

Short description title for the domain.

Type string

Domain type (e.g., 'kvm', 'qemu').

Unit string

Memory unit (KiB, MiB, GiB, TiB).

Uuid string

Domain UUID. If not specified, one will be generated.

Vcpu double

Number of virtual CPUs.

Autostart bool

Whether the domain should be started automatically when the host boots.

Bootloader string

Bootloader path for paravirtualized guests (Xen).

BootloaderArgs string

Arguments to pass to bootloader.

Clock DomainClockArgs

Clock configuration for the domain.

Cpu DomainCpuArgs

CPU configuration for the domain.

Create DomainCreateArgs

Domain start flags corresponding to virDomainCreateFlags. Only used when running=true.

CurrentMemory float64

Actual memory allocation at boot time. If not set, defaults to memory value.

Description string

Human-readable description of the domain.

Destroy DomainDestroyArgs

Domain shutdown behavior. Controls how the domain is stopped when running changes from true to false or when the resource is destroyed.

Devices DomainDevicesArgs

Devices attached to the domain (disks, network interfaces, etc.).

Features DomainFeaturesArgs

Hypervisor features to enable.

Hwuuid string

Hardware UUID for the domain.

Iothreads float64

Number of I/O threads for virtio disks.

MaxMemory float64

Maximum memory for hotplug. Must be >= memory.

MaxMemorySlots float64

Number of slots for memory hotplug. Required when max_memory is set.

Memory float64

Maximum memory allocation in the specified unit. Default unit is KiB.

Metadata string

Custom metadata XML for the domain.

This allows applications to store custom information within the domain's XML configuration.

Requirements:

Must be valid XML
Must use custom namespaces (e.g., xmlns:app1="http://app1.org/app1/")
Only one top-level element per namespace

Example:

<app1:foo xmlns:app1="http://app1.org/app1/">
  <app1:bar>some content</app1:bar>
</app1:foo>

See libvirt metadata documentation for more details.

Name string

Domain name. Must be unique on the host.

OnCrash string

Action to take when guest crashes (destroy, restart, preserve, rename-restart, coredump-destroy, coredump-restart).

OnPoweroff string

Action to take when guest requests poweroff (destroy, restart, preserve, rename-restart).

OnReboot string

Action to take when guest requests reboot (destroy, restart, preserve, rename-restart).

Os DomainOsArgs

Operating system configuration for the domain.

Pm DomainPmArgs

Power management configuration for the domain.

Running bool

Whether the domain should be running. If true, the domain will be started after creation. If false or unset, the domain will only be defined but not started.

Title string

Short description title for the domain.

Type string

Domain type (e.g., 'kvm', 'qemu').

Unit string

Memory unit (KiB, MiB, GiB, TiB).

Uuid string

Domain UUID. If not specified, one will be generated.

Vcpu float64

Number of virtual CPUs.

autostart Boolean

Whether the domain should be started automatically when the host boots.

bootloader String

Bootloader path for paravirtualized guests (Xen).

bootloaderArgs String

Arguments to pass to bootloader.

Clock configuration for the domain.

CPU configuration for the domain.

Domain start flags corresponding to virDomainCreateFlags. Only used when running=true.

currentMemory Double

Actual memory allocation at boot time. If not set, defaults to memory value.

description String

Human-readable description of the domain.

Domain shutdown behavior. Controls how the domain is stopped when running changes from true to false or when the resource is destroyed.

Devices attached to the domain (disks, network interfaces, etc.).

Hypervisor features to enable.

hwuuid String

Hardware UUID for the domain.

iothreads Double

Number of I/O threads for virtio disks.

maxMemory Double

Maximum memory for hotplug. Must be >= memory.

maxMemorySlots Double

Number of slots for memory hotplug. Required when max_memory is set.

memory Double

Maximum memory allocation in the specified unit. Default unit is KiB.

metadata String

Custom metadata XML for the domain.

This allows applications to store custom information within the domain's XML configuration.

Requirements:

Must be valid XML
Must use custom namespaces (e.g., xmlns:app1="http://app1.org/app1/")
Only one top-level element per namespace

Example:

<app1:foo xmlns:app1="http://app1.org/app1/">
  <app1:bar>some content</app1:bar>
</app1:foo>

See libvirt metadata documentation for more details.

name String

Domain name. Must be unique on the host.

onCrash String

Action to take when guest crashes (destroy, restart, preserve, rename-restart, coredump-destroy, coredump-restart).

onPoweroff String

Action to take when guest requests poweroff (destroy, restart, preserve, rename-restart).

onReboot String

Action to take when guest requests reboot (destroy, restart, preserve, rename-restart).

Operating system configuration for the domain.

Power management configuration for the domain.

running Boolean

Whether the domain should be running. If true, the domain will be started after creation. If false or unset, the domain will only be defined but not started.

title String

Short description title for the domain.

type String

Domain type (e.g., 'kvm', 'qemu').

unit String

Memory unit (KiB, MiB, GiB, TiB).

uuid String

Domain UUID. If not specified, one will be generated.

vcpu Double

Number of virtual CPUs.

autostart boolean

Whether the domain should be started automatically when the host boots.

bootloader string

Bootloader path for paravirtualized guests (Xen).

bootloaderArgs string

Arguments to pass to bootloader.

Clock configuration for the domain.

CPU configuration for the domain.

Domain start flags corresponding to virDomainCreateFlags. Only used when running=true.

currentMemory number

Actual memory allocation at boot time. If not set, defaults to memory value.

description string

Human-readable description of the domain.

Domain shutdown behavior. Controls how the domain is stopped when running changes from true to false or when the resource is destroyed.

Devices attached to the domain (disks, network interfaces, etc.).

Hypervisor features to enable.

hwuuid string

Hardware UUID for the domain.

iothreads number

Number of I/O threads for virtio disks.

maxMemory number

Maximum memory for hotplug. Must be >= memory.

maxMemorySlots number

Number of slots for memory hotplug. Required when max_memory is set.

memory number

Maximum memory allocation in the specified unit. Default unit is KiB.

metadata string

Custom metadata XML for the domain.

This allows applications to store custom information within the domain's XML configuration.

Requirements:

Must be valid XML
Must use custom namespaces (e.g., xmlns:app1="http://app1.org/app1/")
Only one top-level element per namespace

Example:

<app1:foo xmlns:app1="http://app1.org/app1/">
  <app1:bar>some content</app1:bar>
</app1:foo>

See libvirt metadata documentation for more details.

name string

Domain name. Must be unique on the host.

onCrash string

Action to take when guest crashes (destroy, restart, preserve, rename-restart, coredump-destroy, coredump-restart).

onPoweroff string

Action to take when guest requests poweroff (destroy, restart, preserve, rename-restart).

onReboot string

Action to take when guest requests reboot (destroy, restart, preserve, rename-restart).

Operating system configuration for the domain.