Skip to main content

Virtual Machine

In Nanocl, a Virtual Machine refers to a virtual machine configuration.
Once created the system will ensure your Virtual Machine is always running.
There is the openapi specification for a VmSpecPartial used to create a Virtual Machine:

required
object (VmDisk)

Disk config of the vm (image, size) required

null or VmHostConfig (object)
Hostname
string or null

Hostname of the vm (default: generated from name)

object or null

User-defined key/value metadata.

MacAddress
string or null

Mac address of the vm (default: generated)

object

The metadata (user defined)

Name
required
string

Name of the vm

Password
string or null

Default password of the vm (default: cloud)

SshKey
string or null

Default ssh pub key for the user (recommended)

User
string or null

Default user of the vm (default: cloud)

{
  • "Name": "string",
  • "Metadata": {
    },
  • "Hostname": "string",
  • "User": "string",
  • "Password": "string",
  • "SshKey": "string",
  • "Disk": {
    },
  • "MacAddress": "string",
  • "Labels": {
    },
  • "HostConfig": { }
}