"da",
"ddnss",
"desec",
+ "df",
"dgon",
"dnsimple",
"do",
"da",
"ddnss",
"desec",
+ "df",
"dgon",
"dnsimple",
"do",
"leaf" : 1,
"path" : "/cluster/acme/directories",
"text" : "directories"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get schema of ACME challenge types.",
+ "method" : "GET",
+ "name" : "challengeschema",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "user" : "all"
+ },
+ "returns" : {
+ "items" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "Human readable name, falls back to id",
+ "type" : "string"
+ },
+ "schema" : {
+ "type" : "object"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/acme/challenge-schema",
+ "text" : "challenge-schema"
}
],
"info" : {
"type" : "integer",
"typetext" : "<integer>"
},
+ "vlanaware" : {
+ "description" : "Allow vm VLANs to pass through this vnet.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"vnet" : {
"description" : "The SDN vnet object identifier.",
"format" : "pve-sdn-vnet-id",
},
"tag" : {
"description" : "vlan or vxlan id",
- "optional" : 0,
+ "optional" : 1,
"type" : "integer",
"typetext" : "<integer>"
},
"optional" : 1,
"type" : "string"
},
+ "vlanaware" : {
+ "description" : "Allow vm VLANs to pass through this vnet.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"vnet" : {
"description" : "The SDN vnet object identifier.",
"format" : "pve-sdn-vnet-id",
"typetext" : "<integer>"
},
"mtu" : {
- "description" : "mtu",
+ "description" : "MTU",
"optional" : 1,
"type" : "integer",
"typetext" : "<integer>"
"typetext" : "<string>"
},
"tag" : {
- "description" : "vlan tag",
+ "description" : "Service-VLAN Tag",
+ "minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "<integer>"
+ "typetext" : "<integer> (0 - N)"
+ },
+ "vlan-protocol" : {
+ "default" : "802.1q",
+ "enum" : [
+ "802.1q",
+ "802.1ad"
+ ],
+ "optional" : 1,
+ "type" : "string"
},
"vrf-vxlan" : {
"description" : "l3vni.",
"evpn",
"faucet",
"qinq",
+ "simple",
"vlan",
"vxlan"
],
"typetext" : "<integer>"
},
"mtu" : {
- "description" : "mtu",
+ "description" : "MTU",
"optional" : 1,
"type" : "integer",
"typetext" : "<integer>"
"typetext" : "<string>"
},
"tag" : {
- "description" : "vlan tag",
+ "description" : "Service-VLAN Tag",
+ "minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "<integer>"
+ "typetext" : "<integer> (0 - N)"
},
"type" : {
"description" : "Plugin type.",
"evpn",
"faucet",
"qinq",
+ "simple",
"vlan",
"vxlan"
],
"format" : "pve-configid",
"type" : "string"
},
+ "vlan-protocol" : {
+ "default" : "802.1q",
+ "enum" : [
+ "802.1q",
+ "802.1ad"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"vrf-vxlan" : {
"description" : "l3vni.",
"optional" : 1,
],
"type" : "string"
},
+ "mtu" : {
+ "description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
+ "maximum" : 65520,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer"
+ },
"ne2k_isa" : {
"alias" : "macaddr",
"keyAlias" : "model"
"format" : "pve-qm-hostpci",
"optional" : 1,
"type" : "string",
- "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
+ "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
"verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"hotplug" : {
],
"type" : "string"
},
+ "mtu" : {
+ "description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
+ "maximum" : 65520,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer"
+ },
"ne2k_isa" : {
"alias" : "macaddr",
"keyAlias" : "model"
},
"optional" : 1,
"type" : "string",
- "typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
+ "typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
},
"node" : {
"description" : "The cluster node name.",
"VM.Config.Memory",
"VM.Config.Network",
"VM.Config.HWType",
- "VM.Config.Options"
+ "VM.Config.Options",
+ "VM.Config.Cloudinit"
],
"any",
1
"format" : "pve-qm-hostpci",
"optional" : 1,
"type" : "string",
- "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
+ "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
"verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"hotplug" : {
],
"type" : "string"
},
+ "mtu" : {
+ "description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
+ "maximum" : 65520,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer"
+ },
"ne2k_isa" : {
"alias" : "macaddr",
"keyAlias" : "model"
},
"optional" : 1,
"type" : "string",
- "typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
+ "typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
},
"node" : {
"description" : "The cluster node name.",
"VM.Config.Memory",
"VM.Config.Network",
"VM.Config.HWType",
- "VM.Config.Options"
+ "VM.Config.Options",
+ "VM.Config.Cloudinit"
],
"any",
1
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "generate-password" : {
+ "default" : 0,
+ "description" : "Generates a random password to be used as ticket instead of the API ticket.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"cert" : {
"type" : "string"
},
+ "password" : {
+ "description" : "Returned if requested with 'generate-password' param. Consists of printable ASCII characters ('!' .. '~').",
+ "optional" : 1,
+ "type" : "string"
+ },
"port" : {
"type" : "integer"
},
"format" : "pve-qm-hostpci",
"optional" : 1,
"type" : "string",
- "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
+ "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
"verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"hotplug" : {
],
"type" : "string"
},
+ "mtu" : {
+ "description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
+ "maximum" : 65520,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer"
+ },
"ne2k_isa" : {
"alias" : "macaddr",
"keyAlias" : "model"
},
"optional" : 1,
"type" : "string",
- "typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
+ "typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
},
"node" : {
"description" : "The cluster node name.",
"path" : "/nodes/{node}/qemu",
"text" : "qemu"
},
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "List all custom and default CPU models.",
+ "method" : "GET",
+ "name" : "index",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "description" : "Only returns custom models when the current user has Sys.Audit on /nodes.",
+ "user" : "all"
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "custom" : {
+ "description" : "True if this is a custom CPU model.",
+ "type" : "boolean"
+ },
+ "name" : {
+ "description" : "Name of the CPU model. Identifies it for subsequent API calls. Prefixed with 'custom-' for custom models.",
+ "type" : "string"
+ },
+ "vendor" : {
+ "description" : "CPU vendor visible to the guest when this model is selected. Vendor of 'reported-model' in case of custom models.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{name}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/cpu",
+ "text" : "cpu"
+ },
{
"children" : [
{
"returns" : {
"items" : {
"properties" : {
+ "bytes_used" : {
+ "title" : "Used",
+ "type" : "integer"
+ },
+ "crush_rule" : {
+ "title" : "Crush Rule",
+ "type" : "integer"
+ },
+ "crush_rule_name" : {
+ "title" : "Crush Rule Name",
+ "type" : "string"
+ },
+ "min_size" : {
+ "title" : "Min Size",
+ "type" : "integer"
+ },
+ "percent_used" : {
+ "title" : "%-Used",
+ "type" : "number"
+ },
+ "pg_autoscale_mode" : {
+ "optional" : 1,
+ "title" : "PG Autoscale Mode",
+ "type" : "string"
+ },
+ "pg_num" : {
+ "title" : "PG Num",
+ "type" : "integer"
+ },
"pool" : {
+ "title" : "ID",
"type" : "integer"
},
"pool_name" : {
+ "title" : "Name",
"type" : "string"
},
"size" : {
+ "title" : "Size",
"type" : "integer"
}
},
},
{
"info" : {
+ "DELETE" : {
+ "allowtoken" : 1,
+ "description" : "Delete subscription key of this node.",
+ "method" : "DELETE",
+ "name" : "delete",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/nodes/{node}",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "null"
+ }
+ },
"GET" : {
"allowtoken" : 1,
"description" : "Read subscription info.",
}
}
},
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/nodes/{node}",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/nodes/{node}",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/nodes/{node}",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/nodes/{node}",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/nodes/{node}",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
"format" : {
"alias" : {
"description" : "Alias for the Domain to verify ACME Challenge over DNS",
- "format" : "pve-acme-domain",
+ "format" : "pve-acme-alias",
"format_description" : "domain",
"optional" : 1,
"type" : "string"
"properties" : {
"status" : {
"description" : "Status of zone",
+ "enum" : [
+ "available",
+ "pending",
+ "error"
+ ],
"type" : "string"
},
"zone" : {
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "upgrade",
+ "login",
"ceph_install",
- "login"
+ "upgrade"
],
"optional" : 1,
"type" : "string"
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "upgrade",
+ "login",
"ceph_install",
- "login"
+ "upgrade"
],
"optional" : 1,
"type" : "string"
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "upgrade",
+ "login",
"ceph_install",
- "login"
+ "upgrade"
],
"optional" : 1,
"type" : "string"
"optional" : 1,
"type" : "boolean"
},
+ "VM.Config.Cloudinit" : {
+ "optional" : 1,
+ "type" : "boolean"
+ },
"VM.Config.Disk" : {
"optional" : 1,
"type" : "boolean"
Script that will be executed during various steps in the vms lifetime.
-`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
+`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
Map host PCI devices into guest.
cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
-`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
+`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
Specify network devices.
Script that will be executed during various steps in the vms lifetime.
-`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
+`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
Map host PCI devices into guest.
cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
-`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
+`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
Specify network devices.
Script that will be executed during various steps in the vms lifetime.
-`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
+`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
Map host PCI devices into guest.
+
+
You can us the 'lspci' command to list existing PCI devices.
+`legacy-igd`=`<boolean>` ('default =' `0`);;
+
+Pass this device in legacy IGD mode, making it the primary and exclusive graphics device in the VM. Requires 'pc-i440fx' machine type and VGA set to 'none'.
+
`mdev`=`<string>` ;;
The type of mediated device to use.
cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
-`net[n]`: `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
+`net[n]`: `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
Specify network devices.
Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.
+`mtu`=`<integer> (1 - 65520)` ;;
+
+Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
+
`queues`=`<integer> (0 - 16)` ;;
Number of packet queues to be used on the device.
projects / pve-docs.git / commitdiff