VirtInstanceCreateArgs parameters.
No Additional PropertiesName for the new virtual instance.
Must be at least 1 characters long
Must be at most 200 characters long
Source type for instance creation.
Specific value:"IMAGE"
Storage pool under which to allocate root filesystem. Must be one of the pools listed in virt.global.config output under "storage_pools". If None (default) then the pool specified in the global configuration will be used.
Must be at least 1 characters long
Image identifier to use for creating the instance.
Must be at least 1 characters long
Must be at most 200 characters long
This can be specified when creating VMs so the root device's size can be configured. Root device for VMs is a sparse zvol and the field specifies space in GBs and defaults to 10 GBs.
Value must be greater or equal to 5
I/O bus type for the root disk (defaults to NVME for best performance).
Remote image source to use.
Specific value:"LINUX_CONTAINERS"
Type of instance to create.
Specific value:"CONTAINER"
Environment variables to set inside the instance.
Each additional property must conform to the following schema
Type: stringWhether the instance should automatically start when the host boots.
CPU allocation specification or null for automatic allocation.
Array of devices to attach to the instance.
Optional human-readable name for the virtualization device.
Must be at least 1 characters long
Optional description explaining the purpose or configuration of this device.
Must be at least 1 characters long
Whether the device should be mounted in read-only mode.
Device type identifier for virtual disk devices.
Specific value:"DISK"
For CONTAINER instances, this would be a valid pool path. For VM instances, it can be a valid zvol path or an incus storage volume name.
Must be at least 1 characters long
Target path where the disk appears inside the virtualized instance.
Boot priority for this disk device. Lower numbers boot first. null means non-bootable.
Value must be greater or equal to 0
Storage bus type for optimal performance and compatibility.
Storage pool in which the device is located. This must be one of the storage pools listed in virt.global.config output.
If this is set to None during device creation, then the default storage pool defined in virt.global.config will be used.
Must be at least 1 characters long
Optional human-readable name for the virtualization device.
Must be at least 1 characters long
Optional description explaining the purpose or configuration of this device.
Must be at least 1 characters long
Whether the device should be mounted in read-only mode.
Device type identifier for graphics processing units.
Specific value:"GPU"
Type of GPU virtualization (physical passthrough, mediated device, etc.).
Unique identifier for the GPU device.
Group ID for device permissions inside the container.
Value must be greater or equal to 0 and lesser or equal to 90000000
User ID for device permissions inside the container.
Value must be greater or equal to 0 and lesser or equal to 90000000
Permission mode for device access (e.g., '660').
Mediated device identifier for GPU virtualization.
Must be at least 1 characters long
Multi-Instance GPU UUID for NVIDIA GPU partitioning.
Must be at least 1 characters long
PCI address of the GPU device on the host system.
Must be at least 1 characters long
Product identifier for GPU device matching.
Must be at least 1 characters long
Vendor identifier for GPU device matching.
Must be at least 1 characters long
Optional human-readable name for the virtualization device.
Must be at least 1 characters long
Optional description explaining the purpose or configuration of this device.
Must be at least 1 characters long
Whether the device should be mounted in read-only mode.
Device type identifier for network port forwarding.
Specific value:"PROXY"
Network protocol (TCP or UDP) for the source connection.
Source port number on the host system to forward from.
Value must be greater or equal to 1 and lesser or equal to 65535
Network protocol (TCP or UDP) for the destination connection.
Destination port number inside the virtualized instance.
Value must be greater or equal to 1 and lesser or equal to 65535
Optional human-readable name for the virtualization device.
Must be at least 1 characters long
Optional description explaining the purpose or configuration of this device.
Must be at least 1 characters long
Whether the device should be mounted in read-only mode.
Device type identifier for Trusted Platform Module devices.
Specific value:"TPM"
Path to the TPM device on the host system.
Resource manager path for TPM device access.
Optional human-readable name for the virtualization device.
Must be at least 1 characters long
Optional description explaining the purpose or configuration of this device.
Must be at least 1 characters long
Whether the device should be mounted in read-only mode.
Device type identifier for USB devices.
Specific value:"USB"
USB bus number on the host system.
USB device number on the specified bus.
USB product identifier for device matching.
USB vendor identifier for device matching.
Optional human-readable name for the virtualization device.
Must be at least 1 characters long
Optional description explaining the purpose or configuration of this device.
Must be at least 1 characters long
Whether the device should be mounted in read-only mode.
Device type identifier for network interface cards.
Specific value:"NIC"
Name of the network to connect this NIC to.
Must be at least 1 characters long
Type of network interface (bridged or macvlan).
Parent network interface on the host system.
Must be at least 1 characters long
MAC address for the virtual network interface. null for auto-generated.
Optional human-readable name for the virtualization device.
Must be at least 1 characters long
Optional description explaining the purpose or configuration of this device.
Must be at least 1 characters long
Whether the device should be mounted in read-only mode.
Device type identifier for PCI device passthrough.
Specific value:"PCI"
PCI bus address of the device to pass through to the virtualized instance.
Must be at least 1 characters long
Optional human-readable name for the virtualization device.
Must be at least 1 characters long
Optional description explaining the purpose or configuration of this device.
Must be at least 1 characters long
Whether the device should be mounted in read-only mode.
Device type identifier for CD-ROM/DVD optical drives.
Specific value:"CDROM"
Path to the ISO image file or physical optical drive to mount.
Must be at least 1 characters long
Boot priority for this optical device. Lower numbers boot first. null means non-bootable.
Value must be greater or equal to 0
Memory allocation in bytes or null for automatic allocation.
This is only valid for containers and should only be set when container instance which is to be deployed is to run in a privileged mode.
The created virtual instance configuration.
No Additional PropertiesUnique identifier for the virtual instance.
Human-readable name for the virtual instance.
Must be at least 1 characters long
Must be at most 200 characters long
Type of virtual instance.
Current operational status of the virtual instance.
CPU configuration string or null for default allocation.
Memory allocation in bytes or null for default allocation.
Whether the instance automatically starts when the host boots.
Environment variables to set inside the instance.
Each additional property must conform to the following schema
Type: stringArray of IP aliases configured for the instance.
No Additional ItemsType of IP address (INET for IPv4, INET6 for IPv6).
IP address for the virtual instance.
Must be at least 1 characters long
Network mask in CIDR notation.
Image information used to create this instance.
No Additional PropertiesHardware architecture of the image (e.g., amd64, arm64).
Human-readable description of the image.
Operating system family of the image.
Version or release name of the operating system.
Unique serial identifier for the image.
Type of image (container, virtual-machine, etc.).
Image variant (default, cloud, minimal, etc.).
Whether the image supports UEFI Secure Boot.
User namespace ID mapping configuration for privilege isolation.
User ID mapping configuration for user namespace isolation.
Starting host ID for the mapping range.
Number of IDs to map in this range.
Starting namespace ID for the mapping range.
Group ID mapping configuration for user namespace isolation.
Starting host ID for the mapping range.
Number of IDs to map in this range.
Starting namespace ID for the mapping range.
Raw low-level configuration options (advanced use only).
Whether VNC remote access is enabled for the instance.
TCP port number for VNC connections or null if VNC is disabled.
Password for VNC access or null if no password is set.
Must be at least 1 characters long
Whether UEFI Secure Boot is enabled (VMs only) or null for containers.
Whether the container runs in privileged mode or null for VMs.
Size of the root disk in GB or null for default size.
I/O bus type for the root disk or null for default.
Storage pool in which the root of the instance is located.
Must be at least 1 characters long