virt.instance.create ==================== Create a new virtualized instance. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: virt_instance_create

virt_instance_create

Type: object
No Additional Properties

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

Iso Volume

Default: null

Type: string

Must be at least 1 characters long

Type: null

Source Type

Type: enum (of null or string) Default: "IMAGE"
Must be one of:
  • null
  • "IMAGE"
  • "ISO"
  • "VOLUME"

Storage Pool

Default: null

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.

Type: string

Must be at least 1 characters long

Type: null

Image

Default: null

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

Type: null

Root Disk Size

Type: integer Default: 10

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

Root Disk Io Bus

Type: enum (of string) Default: "NVME"
Must be one of:
  • "NVME"
  • "VIRTIO-BLK"
  • "VIRTIO-SCSI"

Remote

Type: const Default: "LINUX_CONTAINERS"
Must be one of:
  • "LINUX_CONTAINERS"
Specific value: "LINUX_CONTAINERS"

Instance Type

Type: enum (of string) Default: "CONTAINER"
Must be one of:
  • "CONTAINER"
  • "VM"

Environment

Default: null

Type: object

Each additional property must conform to the following schema

Type: string
Type: null

Autostart

Default: true

Type: boolean
Type: null

Cpu

Default: null

Type: string
Type: null

Devices

Default: null

Type: array
No Additional Items
Each item of this array must be:

Disk

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const
Must be one of:
  • "DISK"
Specific value: "DISK"

Source

Default: null

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

Type: string

Must be at least 1 characters long

Type: null

Destination

Default: null

Type: string
Type: null

Boot Priority

Default: null

Type: integer

Value must be greater or equal to 0

Type: null

Io Bus

Type: enum (of null or string) Default: null
Must be one of:
  • "NVME"
  • "VIRTIO-BLK"
  • "VIRTIO-SCSI"
  • null

Storage Pool

Default: null

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.

Type: string

Must be at least 1 characters long

Type: null

GPU

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const
Must be one of:
  • "GPU"
Specific value: "GPU"

Gpu Type

Type: enum (of string)
Must be one of:
  • "PHYSICAL"
  • "MDEV"
  • "MIG"
  • "SRIOV"

Id

Default: null

Type: string
Type: null

Gid

Default: null

Type: integer

Value must be greater or equal to 0 and lesser or equal to 90000000

Type: null

Uid

Default: null

Type: integer

Value must be greater or equal to 0 and lesser or equal to 90000000

Type: null

Mode

Default: null

Type: string
Type: null

Mdev

Default: null

Type: string

Must be at least 1 characters long

Type: null

Mig Uuid

Default: null

Type: string

Must be at least 1 characters long

Type: null

Pci

Default: null

Type: string

Must be at least 1 characters long

Type: null

Productid

Default: null

Type: string

Must be at least 1 characters long

Type: null

Vendorid

Default: null

Type: string

Must be at least 1 characters long

Type: null

Proxy

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const
Must be one of:
  • "PROXY"
Specific value: "PROXY"

Source Proto

Type: enum (of string)
Must be one of:
  • "UDP"
  • "TCP"

Source Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Dest Proto

Type: enum (of string)
Must be one of:
  • "UDP"
  • "TCP"

Dest Port

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

TPM

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const
Must be one of:
  • "TPM"
Specific value: "TPM"

Path

Default: null

Type: string
Type: null

Pathrm

Default: null

Type: string
Type: null

USB

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const
Must be one of:
  • "USB"
Specific value: "USB"

Bus

Default: null

Type: integer
Type: null

Dev

Default: null

Type: integer
Type: null

Product Id

Default: null

Type: string
Type: null

Vendor Id

Default: null

Type: string
Type: null

NIC

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const
Must be one of:
  • "NIC"
Specific value: "NIC"

Network

Default: null

Type: string

Must be at least 1 characters long

Type: null

Nic Type

Default: null

Type: enum (of string)
Must be one of:
  • "BRIDGED"
  • "MACVLAN"
Type: null

Parent

Default: null

Type: string

Must be at least 1 characters long

Type: null

Mac

Default: null

Type: string
Type: null

PCI

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const
Must be one of:
  • "PCI"
Specific value: "PCI"

Address

Type: string

Must be at least 1 characters long

CDROM

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const
Must be one of:
  • "CDROM"
Specific value: "CDROM"

Source

Type: string

Must be at least 1 characters long

Boot Priority

Default: null

Type: integer

Value must be greater or equal to 0

Type: null
Type: null

Memory

Default: null

Type: integer
Type: null

Secure Boot

Type: boolean Default: false

Enable Vnc

Type: boolean Default: false

Vnc Port

Default: null

Type: integer

Value must be greater or equal to 5900 and lesser or equal to 65535

Type: null

Volume

Default: null

This should be set when source type is "VOLUME" and should be the name of the virt volume which should
be used to boot the VM instance.

Type: string

Must be at least 1 characters long

Type: null

Vnc Password

Default: null

Type: string

Must be at least 1 characters long

Type: null

Image Os

Default: null

Type: string
Type: enum (of null or string)
Must be one of:
  • "LINUX"
  • "FREEBSD"
  • "WINDOWS"
  • "ARCHLINUX"
  • null

Privileged Mode

Type: boolean Default: false

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.

VirtInstanceEntry

Type: object
No Additional Properties

Id

Type: string

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

Type

Type: enum (of string) Default: "CONTAINER"
Must be one of:
  • "CONTAINER"
  • "VM"

Status

Type: enum (of string)
Must be one of:
  • "RUNNING"
  • "STOPPED"
  • "UNKNOWN"
  • "ERROR"
  • "FROZEN"
  • "STARTING"
  • "STOPPING"
  • "FREEZING"
  • "THAWED"
  • "ABORTING"

Cpu


Type: string
Type: null

Memory


Type: integer
Type: null

Autostart

Type: boolean

Environment

Type: object

Each additional property must conform to the following schema

Type: string

Aliases

Type: array of object
No Additional Items
Each item of this array must be:

VirtInstanceAlias

Type: object
No Additional Properties

Type

Type: enum (of string)
Must be one of:
  • "INET"
  • "INET6"

Address

Type: string

Must be at least 1 characters long

Netmask


Type: integer
Type: null

Image

Type: object
No Additional Properties

Architecture


Type: string
Type: null

Description


Type: string
Type: null

Os


Type: string
Type: null

Release


Type: string
Type: null

Serial


Type: string
Type: null

Type


Type: string
Type: null

Variant


Type: string
Type: null

Secureboot


Type: boolean
Type: null


UserNsIdmap

Type: object
No Additional Properties


IdmapUserNsEntry

Type: object
No Additional Properties

Hostid

Type: integer

Maprange

Type: integer

Nsid

Type: integer
Type: null


IdmapUserNsEntry

Type: object
No Additional Properties

Hostid

Type: integer

Maprange

Type: integer

Nsid

Type: integer
Type: null
Type: null

Raw


Type: object
Type: null

Vnc Enabled

Type: boolean

Vnc Port


Type: integer
Type: null

Vnc Password


Type: string

Must be at least 1 characters long

Type: null

Secure Boot


Type: boolean
Type: null

Privileged Mode


Type: boolean
Type: null

Root Disk Size


Type: integer
Type: null

Root Disk Io Bus

Type: enum (of null or string)
Must be one of:
  • "NVME"
  • "VIRTIO-BLK"
  • "VIRTIO-SCSI"
  • null

Storage Pool

Type: string

Storage pool in which the root of the instance is located.

Must be at least 1 characters long



*Required roles:* VIRT_INSTANCE_WRITE