Table Of Contents

Previous topic

virt.instance

Next topic

virt.instance.delete

virt.instance.create

Create a new virtualized instance.

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"
  • "ZVOL"
  • "ISO"

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

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:

Type: object
Type: object
Type: object
Type: object
Type: object
Type: object
Type: null

Memory

Default: null

Type: integer

Value must be greater or equal to 33554432

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

Zvol Path

Default: null

This 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.

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

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"

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
No Additional Items
Each item of this array must be:
Type: object

Type: object


Type: object
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


Required roles: