virt.instance.create¶
Create a new virtualized instance.
No Additional Items
Tuple Validation
Parameter 1: virt_instance_create
virt_instance_create
Type: objectNo Additional Properties
Name
Type: stringMust be at least 1
characters long
Must be at most 200
characters long
Iso Volume
Default: nullMust be at least 1
characters long
Source Type
Type: enum (of null or string) Default: "IMAGE"Must be one of:
- null
- "IMAGE"
- "ZVOL"
- "ISO"
- "VOLUME"
Storage Pool
Default: nullStorage 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
Default: nullMust be at least 1
characters long
Must be at most 200
characters long
Root Disk Size
Type: integer Default: 10This 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"
"LINUX_CONTAINERS"
Instance Type
Type: enum (of string) Default: "CONTAINER"Must be one of:
- "CONTAINER"
- "VM"
Environment
Default: nullEach additional property must conform to the following schema
Type: stringAutostart
Default: trueCpu
Default: nullDevices
Default: nullNo Additional Items
Each item of this array must be:
Memory
Default: nullSecure Boot
Type: boolean Default: falseEnable Vnc
Type: boolean Default: falseVnc Port
Default: nullValue must be greater or equal to 5900
and lesser or equal to 65535
Zvol Path
Default: nullThis is useful when a VM wants to be booted where a ZVOL already has a VM bootstrapped in it and needs
to be ported over to virt plugin. Virt will consume this zvol and add it as a DISK device to the instance
with boot priority set to 1 so the VM can be booted from it.
Must be at least 1
characters long
Volume
Default: nullThis 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.
Must be at least 1
characters long
Vnc Password
Default: nullMust be at least 1
characters long
VirtInstanceEntry
Type: objectNo Additional Properties
Id
Type: stringName
Type: stringMust 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
Memory
Autostart
Type: booleanEnvironment
Type: objectEach additional property must conform to the following schema
Type: stringAliases
Type: arrayNo Additional Items
Each item of this array must be:
Raw
Vnc Enabled
Type: booleanVnc Port
Vnc Password
Must be at least 1
characters long
Secure Boot
Root Disk Size
Root Disk Io Bus
Type: enum (of null or string)Must be one of:
- "NVME"
- "VIRTIO-BLK"
- "VIRTIO-SCSI"
- null
Storage Pool
Type: stringStorage pool in which the root of the instance is located.
Must be at least 1
characters long
Required roles: VIRT_INSTANCE_WRITE