| Key | Value |
|---|---|
| name | Server name. |
| cpu | CPU quota in core MHz. |
| smp | Number of virtual processors, or ‘auto’ to calculate based on cpu. When the server starts, this key stays unchanged, but two extra keys, “smp:cores” and “smp:sockets”, appear with the number of cores allocated and the number of sockets (virtual cpus) that these appear in. |
| mem | virtual memory size in MB. |
| persistent | ‘true’ means that server will revert to a ‘stopped’ status on server stop or shutdown, rather than being destroyed automatically. |
| ide:BUS[0-1]:UNIT[0-1] scsi:BUS[0]:UNIT[0-7] block:INDEX[0-7] |
Drive UUID to connect as specified device. |
| ide:BUS[0-1]:UNIT[0-1]:media scsi:BUS[0]:UNIT[0-7]:media block:INDEX[0-7]:media |
Media type – set to ‘cdrom’ to simulate a cdrom, set to ‘disk’ or leave unset to simulate a hard disk. |
| boot | Device to boot, e.g. ide:0:0 or ide:1:0. Set to a list to make multiple devices bootable. |
| nic:0:model | Create network interface with given type (use ‘e1000′ as default value; ‘rtl8139′ or ‘virtio’ are also available). |
| nic:0:dhcp | The IP address offered by DHCP to network interface 0. If unset, no address is offered. Set to ‘auto’ to allocate a temporary IP at boot. When the server starts, this key stays unchanged, but an extra key “nic:0:dhcp:ip” appears with the IP allocated. |
| nic:0:firewall:policy | Defines the action to be applied to all packets not matching an existing firewall rule. Possible values are ‘accept’ or ‘reject’. This key only exists if the built-in firewall is in use, and setting it to any value will enable the firewall. |
| nic:0:firewall:accept | Defines which, if any, inbound ports should be opened and to which protocols. Takes a space separated list in the form PROTOCOL/[IP ADDRESS]/[CIDR MASK]/PORT[:RANGE], eg. “tcp/22″ or “udp/10.0.0.0/16/5900:5902″. See the control panel firewall tooltip for more details. This key only exists if the built-in firewall is in use, and setting it to any value will enable the firewall. |
| nic:0:firewall:reject | Defines which, if any, inbound ports should be closed and to which protocols. Takes a space separated list in the form PROTOCOL/[IP ADDRESS]/[CIDR MASK]/PORT[:RANGE], eg. “tcp/22″ or “udp/10.0.0.0/16/5900:5902″. See the control panel firewall tooltip for more details. This key only exists if the built-in firewall is in use, and setting it to any value will enable the firewall. |
| nic:1:model | Create network interface with given type (use ‘e1000′ as default value; ‘rtl8139′ or ‘virtio’ are also available). |
| nic:1:vlan | The VLAN to which the network interface is attached. |
| nic:1:mac | The MAC address of the network interface. If unset, a randomly generated address is used. If set, should be unique on the VLAN. |
| vnc | IP address for overlay VNC access on port 5900. Set to ‘auto’, to reuse nic:0:dhcp if available, or otherwise allocate a temporary IP at boot. |
| password | Password for VNC access (maximum of 8 characters). If unset, VNC is disabled. |
| vnc:tls | Set to ‘on’ to require VeNCrypt-style TLS auth in addition to the password. If this is unset, only unencrypted VNC is available. |
| tags | optional, space-separated list of tags |
| user:* | optional, user-defined KEY VALUE pairs |
| avoid:drives | optional, space-separated list of existing drives to ensure this new server is created on physical different hardware than those existing drives |
| avoid:servers | optional, space-separated list of existing servers to ensure this new server is created on physical different hardware than those existing servers |
0 Comments