"ad",
"ali",
"anx",
+ "artfiles",
"arvan",
"aurora",
"autodns",
"aws",
"azion",
"azure",
+ "bookmyname",
"bunny",
"cf",
"clouddns",
"desec",
"df",
"dgon",
+ "dnsexit",
"dnshome",
"dnsimple",
"dnsservices",
"servercow",
"simply",
"tele3",
+ "tencent",
"transip",
"udr",
"ultra",
"ad",
"ali",
"anx",
+ "artfiles",
"arvan",
"aurora",
"autodns",
"aws",
"azion",
"azure",
+ "bookmyname",
"bunny",
"cf",
"clouddns",
"desec",
"df",
"dgon",
+ "dnsexit",
"dnshome",
"dnsimple",
"dnsservices",
"servercow",
"simply",
"tele3",
+ "tencent",
"transip",
"udr",
"ultra",
}
},
"permissions" : {
- "check" : [
- "perm",
- "/sdn/vnets/{vnet}/subnets",
- [
- "SDN.Allocate"
- ]
- ]
+ "description" : "Require 'SDN.Allocate' permission on '/sdn/zones/<zone>/<vnet>'",
+ "user" : "all"
},
"protected" : 1,
"returns" : {
}
},
"permissions" : {
- "check" : [
- "perm",
- "/sdn/vnets/{vnet}/subnets/{subnet}",
- [
- "SDN.Allocate"
- ]
- ]
+ "description" : "Require 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/zones/<zone>/<vnet>'",
+ "user" : "all"
},
"returns" : {
"type" : "object"
"type" : "object"
},
"permissions" : {
- "check" : [
- "perm",
- "/sdn/vnets/{vnet}/subnets",
- [
- "SDN.Allocate"
- ]
- ]
+ "description" : "Require 'SDN.Allocate' permission on '/sdn/zones/<zone>/<vnet>'",
+ "user" : "all"
},
"protected" : 1,
"returns" : {
}
},
"permissions" : {
- "description" : "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/subnets/<subnet>'",
+ "description" : "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/zones/<zone>/<vnet>'",
"user" : "all"
},
"returns" : {
"type" : "object"
},
"permissions" : {
- "check" : [
- "perm",
- "/sdn/vnets/{vnet}/subnets",
- [
- "SDN.Allocate"
- ]
- ]
+ "description" : "Require 'SDN.Allocate' permission on '/sdn/zones/<zone>/<vnet>'",
+ "user" : "all"
},
"protected" : 1,
"returns" : {
}
},
"permissions" : {
- "check" : [
- "perm",
- "/sdn/vnets",
- [
- "SDN.Allocate"
- ]
- ]
+ "description" : "Require 'SDN.Allocate' permission on '/sdn/zones/<zone>/<vnet>'",
+ "user" : "all"
},
"protected" : 1,
"returns" : {
}
},
"permissions" : {
- "check" : [
- "perm",
- "/sdn/vnets/{vnet}",
- [
- "SDN.Allocate"
- ]
- ]
+ "description" : "Require 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/zones/<zone>/<vnet>'",
+ "user" : "all"
},
"returns" : {
"type" : "object"
"type" : "object"
},
"permissions" : {
- "check" : [
- "perm",
- "/sdn/vnets",
- [
- "SDN.Allocate"
- ]
- ]
+ "description" : "Require 'SDN.Allocate' permission on '/sdn/zones/<zone>/<vnet>'",
+ "user" : "all"
},
"protected" : 1,
"returns" : {
}
},
"permissions" : {
- "description" : "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/vnets/<vnet>'",
+ "description" : "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/zones/<zone>/<vnet>'",
"user" : "all"
},
"returns" : {
"permissions" : {
"check" : [
"perm",
- "/sdn/vnets",
+ "/sdn/zones/{zone}",
[
"SDN.Allocate"
]
"permissions" : {
"check" : [
"perm",
- "/sdn/zones",
+ "/sdn/zones/{zone}",
[
"SDN.Allocate"
]
"permissions" : {
"check" : [
"perm",
- "/sdn/zones",
+ "/sdn/zones/{zone}",
[
"SDN.Allocate"
]
"type" : "integer",
"typetext" : "<integer>"
},
+ "isis-domain" : {
+ "description" : "ISIS domain.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "isis-ifaces" : {
+ "description" : "ISIS interface.",
+ "format" : "pve-iface-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "isis-net" : {
+ "description" : "ISIS network entity title.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"loopback" : {
"description" : "source loopback interface.",
"optional" : 1,
"enum" : [
"bgp",
"evpn",
- "faucet"
+ "faucet",
+ "isis"
],
"optional" : 1,
"type" : "string"
"type" : "integer",
"typetext" : "<integer>"
},
+ "isis-domain" : {
+ "description" : "ISIS domain.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "isis-ifaces" : {
+ "description" : "ISIS interface.",
+ "format" : "pve-iface-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "isis-net" : {
+ "description" : "ISIS network entity title.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"loopback" : {
"description" : "source loopback interface.",
"optional" : 1,
"enum" : [
"bgp",
"evpn",
- "faucet"
+ "faucet",
+ "isis"
],
"format" : "pve-configid",
"type" : "string"
"permissions" : {
"check" : [
"perm",
- "/",
+ "/sdn",
[
"SDN.Audit"
]
"format" : {
"efitype" : {
"default" : "2m",
- "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).",
+ "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarch64 (ARM).",
"enum" : [
"2m",
"4m"
"type" : "string"
},
"memory" : {
- "default" : 512,
- "description" : "Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
- "minimum" : 16,
+ "description" : "Memory properties.",
+ "format" : {
+ "current" : {
+ "default" : 512,
+ "default_key" : 1,
+ "description" : "Current amount of online RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
+ "minimum" : 16,
+ "type" : "integer"
+ }
+ },
"optional" : 1,
- "type" : "integer"
+ "type" : "string"
},
"migrate_downtime" : {
"default" : 0.1,
"format" : {
"efitype" : {
"default" : "2m",
- "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).",
+ "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarch64 (ARM).",
"enum" : [
"2m",
"4m"
"type" : "string"
},
"memory" : {
- "default" : 512,
- "description" : "Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
- "minimum" : 16,
+ "description" : "Memory properties.",
+ "format" : {
+ "current" : {
+ "default" : 512,
+ "default_key" : 1,
+ "description" : "Current amount of online RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
+ "minimum" : 16,
+ "type" : "integer"
+ }
+ },
"optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (16 - N)"
+ "type" : "string",
+ "typetext" : "[current=]<integer>"
},
"migrate_downtime" : {
"default" : 0.1,
"format" : {
"efitype" : {
"default" : "2m",
- "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).",
+ "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarch64 (ARM).",
"enum" : [
"2m",
"4m"
"type" : "string"
},
"memory" : {
- "default" : 512,
- "description" : "Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
- "minimum" : 16,
+ "description" : "Memory properties.",
+ "format" : {
+ "current" : {
+ "default" : 512,
+ "default_key" : 1,
+ "description" : "Current amount of online RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
+ "minimum" : 16,
+ "type" : "integer"
+ }
+ },
"optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (16 - N)"
+ "type" : "string",
+ "typetext" : "[current=]<integer>"
},
"migrate_downtime" : {
"default" : 0.1,
"typetext" : "<integer> (100 - 999999999)"
},
"websocket" : {
- "description" : "starts websockify instead of vncproxy",
+ "description" : "Prepare for websocket upgrade (only required when using serial terminal, otherwise upgrade is always possible).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"format" : {
"efitype" : {
"default" : "2m",
- "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).",
+ "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarch64 (ARM).",
"enum" : [
"2m",
"4m"
"type" : "string"
},
"memory" : {
- "default" : 512,
- "description" : "Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
- "minimum" : 16,
+ "description" : "Memory properties.",
+ "format" : {
+ "current" : {
+ "default" : 512,
+ "default_key" : 1,
+ "description" : "Current amount of online RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
+ "minimum" : 16,
+ "type" : "integer"
+ }
+ },
"optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (16 - N)"
+ "type" : "string",
+ "typetext" : "[current=]<integer>"
},
"migrate_downtime" : {
"default" : 0.1,
"path" : "/nodes/{node}/lxc/{vmid}/pending",
"text" : "pending"
},
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get IP addresses of the specified container interface.",
+ "method" : "GET",
+ "name" : "ip",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "vmid" : {
+ "description" : "The (unique) ID of the VM.",
+ "format" : "pve-vmid",
+ "maximum" : 999999999,
+ "minimum" : 100,
+ "type" : "integer",
+ "typetext" : "<integer> (100 - 999999999)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/vms/{vmid}",
+ [
+ "VM.Audit"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "hwaddr" : {
+ "description" : "The MAC address of the interface",
+ "optional" : 0,
+ "type" : "string"
+ },
+ "inet" : {
+ "description" : "The IPv4 address of the interface",
+ "optional" : 1,
+ "type" : "string"
+ },
+ "inet6" : {
+ "description" : "The IPv6 address of the interface",
+ "optional" : 1,
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The name of the interface",
+ "optional" : 0,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/lxc/{vmid}/interfaces",
+ "text" : "interfaces"
+ },
{
"info" : {
"POST" : {
"key" : {
"description" : "Proxmox VE subscription key",
"maxLength" : 32,
- "pattern" : "pve([1248])([cbsp])-[0-9a-f]{10}",
+ "pattern" : "\\s*pve([1248])([cbsp])-[0-9a-f]{10}\\s*",
"type" : "string"
},
"node" : {
"type" : "string",
"typetext" : "<string>"
},
+ "tar" : {
+ "default" : 0,
+ "description" : "Download dirs as 'tar.zst' instead of 'zip'.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"volume" : {
"description" : "Backup volume ID or name. Currently only PBS snapshots are supported.",
"type" : "string",
"osdid" : {
"type" : "integer"
},
+ "osdid-list" : {
+ "items" : {
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
"parent" : {
"description" : "For partitions only. The device path of the disk the partition resides on.",
"optional" : 1,
The guest will attempt to boot from devices in the order they appear here.
+
-Disks, optical drives and storage USB devices that are passed through will be
-directly booted from, NICs will load PXE, and PCIe devices will either behave
-like disks (e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
+Disks, optical drives and passed-through storage USB devices will be directly
+booted from, NICs will load PXE, and PCIe devices will either behave like disks
+(e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
+
Note that only devices in this list will be marked as bootable and thus loaded
by the guest firmware (BIOS/UEFI). If you require multiple disks for booting
`efitype`=`<2m | 4m>` ('default =' `2m`);;
-Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).
+Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarch64 (ARM).
`file`=`<volume>` ;;
`host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
-Pass through host PCI device. The PCI ID of a host's PCI device or a list
+Host PCI device pass through. The PCI ID of a host's PCI device or a list
of PCI virtual functions of the host. HOSTPCIID syntax is:
+
'bus:dev.func' (hexadecimal numbers)
Specifies the QEMU machine type.
-`memory`: `<integer> (16 - N)` ('default =' `512`)::
+`memory`: `[current=]<integer>` ::
-Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
+Memory properties.
+
+`current`=`<integer> (16 - N)` ('default =' `512`);;
+
+Current amount of online RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
`migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
'vendor_id:product_id' (hexadeciaml numbers) or
'spice'
+
-You can use the 'lsusb -t' command to list existing USB devices.
+You can use the 'lsusb -t' command to list existing usb devices.
+
NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
machines - use with special care.
projects / pve-docs.git / commitdiff