virt.instance.create

Create a new virtualized instance.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: virt_instance_create

virt_instance_create

Type: object
No Additional Properties

name Required

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

iso_volume

Iso Volume

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

source_type

Source Type

Type: enum (of null or string) Default: "IMAGE"

Must be one of:

• null
• "IMAGE"
• "ISO"
• "VOLUME"

storage_pool

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.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

image

Image

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

Type: null

root_disk_size

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

Root Disk Io Bus

Type: enum (of string) Default: "NVME"

Must be one of:

• "NVME"
• "VIRTIO-BLK"
• "VIRTIO-SCSI"

remote

Remote

Type: const Default: "LINUX_CONTAINERS"

Must be one of:

• "LINUX_CONTAINERS"

Specific value: "LINUX_CONTAINERS"

instance_type

Instance Type

Type: enum (of string) Default: "CONTAINER"

Must be one of:

• "CONTAINER"
• "VM"

environment

Environment

Default: null

Any of

• Option 1
• Option 2

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: string

Type: null

autostart

Autostart

Default: true

Any of

• Option 1
• Option 2

Type: boolean

Type: null

cpu

Cpu

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

devices

Devices

Default: null

Any of

• Option 1
• Option 2

Type: array
No Additional Items

Each item of this array must be:

One of

• Disk
• GPU
• Proxy
• TPM
• USB
• NIC
• PCI
• CDROM

Disk

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "DISK"

Specific value: "DISK"

source

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

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

destination

Destination

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

boot_priority

Boot Priority

Default: null

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 0

Type: null

io_bus

Io Bus

Type: enum (of null or string) Default: null

Must be one of:

• "NVME"
• "VIRTIO-BLK"
• "VIRTIO-SCSI"
• null

storage_pool

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.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

GPU

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "GPU"

Specific value: "GPU"

gpu_type Required

Gpu Type

Type: enum (of string)

Must be one of:

• "PHYSICAL"
• "MDEV"
• "MIG"
• "SRIOV"

id

Id

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

gid

Gid

Default: null

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

uid

Uid

Default: null

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

mode

Mode

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

mdev

Mdev

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

mig_uuid

Mig Uuid

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

pci

Pci

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

productid

Productid

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

vendorid

Vendorid

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

Proxy

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "PROXY"

Specific value: "PROXY"

source_proto Required

Source Proto

Type: enum (of string)

Must be one of:

• "UDP"
• "TCP"

source_port Required

Source Port

Type: integer

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

dest_proto Required

Dest Proto

Type: enum (of string)

Must be one of:

• "UDP"
• "TCP"

dest_port Required

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

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "TPM"

Specific value: "TPM"

path

Path

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

pathrm

Pathrm

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

USB

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "USB"

Specific value: "USB"

bus

Bus

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

dev

Dev

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

product_id

Product Id

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

vendor_id

Vendor Id

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

NIC

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "NIC"

Specific value: "NIC"

network

Network

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

nic_type

Nic Type

Default: null

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "BRIDGED"
• "MACVLAN"

Type: null

parent

Parent

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

mac

Mac

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

PCI

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "PCI"

Specific value: "PCI"

address Required

Address

Type: string

Must be at least 1 characters long

CDROM

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "CDROM"

Specific value: "CDROM"

source Required

Source

Type: string

Must be at least 1 characters long

boot_priority

Boot Priority

Default: null

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 0

Type: null

Type: null

memory

Memory

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

secure_boot

Secure Boot

Type: boolean Default: false

enable_vnc

Enable Vnc

Type: boolean Default: false

vnc_port

Vnc Port

Default: null

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

volume

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.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

vnc_password

Vnc Password

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

image_os

Image Os

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: enum (of null or string)

Must be one of:

• "LINUX"
• "FREEBSD"
• "WINDOWS"
• "ARCHLINUX"
• null

privileged_mode

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.

Return value

VirtInstanceEntry

Type: object
No Additional Properties

id Required

Id

Type: string

name Required

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

type

Type

Type: enum (of string) Default: "CONTAINER"

Must be one of:

• "CONTAINER"
• "VM"

status Required

Status

Type: enum (of string)

Must be one of:

• "RUNNING"
• "STOPPED"
• "UNKNOWN"
• "ERROR"
• "FROZEN"
• "STARTING"
• "STOPPING"
• "FREEZING"
• "THAWED"
• "ABORTING"

cpu Required

Cpu

Any of

• Option 1
• Option 2

Type: string

Type: null

memory Required

Memory

Any of

• Option 1
• Option 2

Type: integer

Type: null

autostart Required

Autostart

Type: boolean

environment Required

Environment

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: string

aliases Required

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

VirtInstanceAlias

Type: object
No Additional Properties

type Required

Type

Type: enum (of string)

Must be one of:

• "INET"
• "INET6"

address Required

Address

Type: string

Must be at least 1 characters long

netmask Required

Netmask

Any of

• Option 1
• Option 2

Type: integer

Type: null

image Required

Image

Type: object
No Additional Properties

architecture Required

Architecture

Any of

• Option 1
• Option 2

Type: string

Type: null

description Required

Description

Any of

• Option 1
• Option 2

Type: string

Type: null

os Required

Os

Any of

• Option 1
• Option 2

Type: string

Type: null

release Required

Release

Any of

• Option 1
• Option 2

Type: string

Type: null

serial Required

Serial

Any of

• Option 1
• Option 2

Type: string

Type: null

type Required

Type

Any of

• Option 1
• Option 2

Type: string

Type: null

variant Required

Variant

Any of

• Option 1
• Option 2

Type: string

Type: null

secureboot Required

Secureboot

Any of

• Option 1
• Option 2

Type: boolean

Type: null

userns_idmap Required

Any of

• UserNsIdmap
• Option 2

UserNsIdmap

Type: object
No Additional Properties

uid Required

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

maprange Required

Maprange

Type: integer

nsid Required

Nsid

Type: integer

Type: null

gid Required

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

maprange Required

Maprange

Type: integer

nsid Required

Nsid

Type: integer

Type: null

Type: null

raw Required

Raw

Any of

• Option 1
• Option 2

Type: object

Type: null

vnc_enabled Required

Vnc Enabled

Type: boolean

vnc_port Required

Vnc Port

Any of

• Option 1
• Option 2

Type: integer

Type: null

vnc_password Required

Vnc Password

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

secure_boot Required

Secure Boot

Any of

• Option 1
• Option 2

Type: boolean

Type: null

privileged_mode Required

Privileged Mode

Any of

• Option 1
• Option 2

Type: boolean

Type: null

root_disk_size Required

Root Disk Size

Any of

• Option 1
• Option 2

Type: integer

Type: null

root_disk_io_bus Required

Root Disk Io Bus

Type: enum (of null or string)

Must be one of:

• "NVME"
• "VIRTIO-BLK"
• "VIRTIO-SCSI"
• null

storage_pool Required

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