Proxmox/pve-docs
5
0
Fork 0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-11-25 16:23:43 +03:00
Code Releases Activity

update static/schema information

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
2025-11-17 09:38:55 +01:00
parent 9f2b2861ed
commit f06d9cb33d
4 changed files with 209 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

166
api-viewer/apidata.js
View File

@@ -12397,6 +12397,7 @@ const apiSchema = [
"description" : "The 'VM.PowerMgmt' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter.",
"user" : "all"
},
"protected" : 1,
"returns" : {
"description" : "UPID of the worker",
"type" : "string"
@@ -12458,6 +12459,7 @@ const apiSchema = [
"description" : "The 'VM.PowerMgmt' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter.",
"user" : "all"
},
"protected" : 1,
"returns" : {
"description" : "UPID of the worker",
"type" : "string"
@@ -12521,6 +12523,7 @@ const apiSchema = [
"description" : "The 'VM.PowerMgmt' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter. Additionally, you need 'VM.Config.Disk' on the '/vms/{vmid}' path and 'Datastore.AllocateSpace' for the configured state-storage(s)",
"user" : "all"
},
"protected" : 1,
"returns" : {
"description" : "UPID of the worker",
"type" : "string"
@@ -12586,6 +12589,7 @@ const apiSchema = [
"description" : "The 'VM.Migrate' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter.",
"user" : "all"
},
"protected" : 1,
"returns" : {
"description" : "UPID of the worker",
"type" : "string"
@@ -37249,6 +37253,18 @@ const apiSchema = [
"description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications.",
"type" : "string"
},
"entrypoint" : {
"default" : "/sbin/init",
"description" : "Absolute path from container rootfs to the binary to use as init.",
"optional" : 1,
"type" : "string"
},
"env" : {
"description" : "The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config.",
"optional" : 1,
"pattern" : "(?^:(?:\\w+=[^\\0]+)(?:\\0\\w+=[^\\0]+)*)",
"type" : "string"
},
"features" : {
"description" : "Allow containers access to advanced features.",
"format" : {
@@ -37445,6 +37461,11 @@ const apiSchema = [
"optional" : 1,
"type" : "string"
},
"host-managed" : {
"description" : "Whether this interface's IP configuration should be managed by the host.",
"optional" : 1,
"type" : "boolean"
},
"hwaddr" : {
"description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)",
"format" : "mac-addr",
@@ -37810,6 +37831,19 @@ const apiSchema = [
"type" : "string",
"typetext" : "<string>"
},
"entrypoint" : {
"default" : "/sbin/init",
"description" : "Absolute path from container rootfs to the binary to use as init.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"env" : {
"description" : "The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config.",
"optional" : 1,
"pattern" : "(?^:(?:\\w+=[^\\0]+)(?:\\0\\w+=[^\\0]+)*)",
"type" : "string"
},
"features" : {
"description" : "Allow containers access to advanced features.",
"format" : {
@@ -38001,6 +38035,11 @@ const apiSchema = [
"optional" : 1,
"type" : "string"
},
"host-managed" : {
"description" : "Whether this interface's IP configuration should be managed by the host.",
"optional" : 1,
"type" : "boolean"
},
"hwaddr" : {
"description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)",
"format" : "mac-addr",
@@ -38072,7 +38111,7 @@ const apiSchema = [
},
"optional" : 1,
"type" : "string",
"typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
"typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,host-managed=<1|0>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
},
"node" : {
"description" : "The cluster node name.",
@@ -44388,6 +44427,19 @@ const apiSchema = [
"type" : "string",
"typetext" : "[[path=]<Path>] [,deny-write=<1|0>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]"
},
"entrypoint" : {
"default" : "/sbin/init",
"description" : "Absolute path from container rootfs to the binary to use as init.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"env" : {
"description" : "The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config.",
"optional" : 1,
"pattern" : "(?^:(?:\\w+=[^\\0]+)(?:\\0\\w+=[^\\0]+)*)",
"type" : "string"
},
"features" : {
"description" : "Allow containers access to advanced features.",
"format" : {
@@ -44598,6 +44650,11 @@ const apiSchema = [
"optional" : 1,
"type" : "string"
},
"host-managed" : {
"description" : "Whether this interface's IP configuration should be managed by the host.",
"optional" : 1,
"type" : "boolean"
},
"hwaddr" : {
"description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)",
"format" : "mac-addr",
@@ -44669,7 +44726,7 @@ const apiSchema = [
},
"optional" : 1,
"type" : "string",
"typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
"typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,host-managed=<1|0>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
},
"node" : {
"description" : "The cluster node name.",
@@ -52790,6 +52847,66 @@ const apiSchema = [
"path" : "/nodes/{node}/storage/{storage}/download-url",
"text" : "download-url"
},
{
"info" : {
"POST" : {
"allowtoken" : 1,
"description" : "Pull an OCI image from a registry.",
"method" : "POST",
"name" : "oci_registry_pull",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"reference" : {
"description" : "The reference to the OCI image to download.",
"pattern" : "^(?:(?:[a-zA-Z\\d]|[a-zA-Z\\d][a-zA-Z\\d-]*[a-zA-Z\\d])(?:\\.(?:[a-zA-Z\\d]|[a-zA-Z\\d][a-zA-Z\\d-]*[a-zA-Z\\d]))*(?::\\d+)?/)?[a-z\\d]+(?:/[a-z\\d]+(?:(?:(?:[._]|__|[-]*)[a-z\\d]+)+)?)*:\\w[\\w.-]{0,127}$",
"type" : "string"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
"format_description" : "storage ID",
"type" : "string",
"typetext" : "<storage ID>"
}
}
},
"permissions" : {
"check" : [
"and",
[
"perm",
"/storage/{storage}",
[
"Datastore.AllocateTemplate"
]
],
[
"perm",
"/nodes/{node}",
[
"Sys.AccessNetwork"
]
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/storage/{storage}/oci-registry-pull",
"text" : "oci-registry-pull"
},
{
"info" : {
"GET" : {
@@ -59253,6 +59370,51 @@ const apiSchema = [
"path" : "/nodes/{node}/aplinfo",
"text" : "aplinfo"
},
{
"info" : {
"GET" : {
"allowtoken" : 1,
"description" : "List all tags for an OCI repository reference.",
"method" : "GET",
"name" : "query_oci_repo_tags",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"reference" : {
"description" : "The reference to the repository to query tags from.",
"pattern" : "^(?:(?:[a-zA-Z\\d]|[a-zA-Z\\d][a-zA-Z\\d-]*[a-zA-Z\\d])(?:\\.(?:[a-zA-Z\\d]|[a-zA-Z\\d][a-zA-Z\\d-]*[a-zA-Z\\d]))*(?::\\d+)?/)?[a-z\\d]+(?:(?:[._]|__|[-]*)[a-z\\d]+)*(?:/[a-z\\d]+(?:(?:[._]|__|[-]*)[a-z\\d]+)*)*$",
"type" : "string"
}
}
},
"permissions" : {
"check" : [
"perm",
"/nodes/{node}",
[
"Sys.AccessNetwork"
]
]
},
"proxyto" : "node",
"returns" : {
"items" : {
"type" : "string"
},
"type" : "array"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/query-oci-repo-tags",
"text" : "query-oci-repo-tags"
},
{
"info" : {
"GET" : {

6
pct-network-opts.adoc
View File

@@ -1,4 +1,4 @@
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,host-managed=<1|0>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
@@ -18,6 +18,10 @@ Default gateway for IPv4 traffic.
Default gateway for IPv6 traffic.
`host-managed`=`<boolean>` ;;
Whether this interface's IP configuration should be managed by the host.
`hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
A common MAC address with the I/G (Individual/Group) bit not set.

30
pct.1-synopsis.adoc
View File

@@ -136,6 +136,14 @@ Description for the Container. Shown in the web-interface CT's summary. This is
Device to pass through to the container
`--entrypoint` `<string>` ('default =' `/sbin/init`)::
Absolute path from container rootfs to the binary to use as init.
`--env` `(?^:(?:\w+=[^\0]+)(?:\0\w+=[^\0]+)*)` ::
The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config.
`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
Allow containers access to advanced features.
@@ -176,7 +184,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,host-managed=<1|0>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
@@ -707,6 +715,14 @@ Description for the Container. Shown in the web-interface CT's summary. This is
Device to pass through to the container
`--entrypoint` `<string>` ('default =' `/sbin/init`)::
Absolute path from container rootfs to the binary to use as init.
`--env` `(?^:(?:\w+=[^\0]+)(?:\0\w+=[^\0]+)*)` ::
The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config.
`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
Allow containers access to advanced features.
@@ -747,7 +763,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,host-managed=<1|0>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
@@ -910,6 +926,14 @@ Device to pass through to the container
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`--entrypoint` `<string>` ('default =' `/sbin/init`)::
Absolute path from container rootfs to the binary to use as init.
`--env` `(?^:(?:\w+=[^\0]+)(?:\0\w+=[^\0]+)*)` ::
The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config.
`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
Allow containers access to advanced features.
@@ -938,7 +962,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,host-managed=<1|0>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.

14
pct.conf.5-opts.adoc
View File

@@ -56,6 +56,14 @@ Path to the device to pass through to the container
User ID to be assigned to the device node
`entrypoint`: `<string>` ('default =' `/sbin/init`)::
Absolute path from container rootfs to the binary to use as init.
`env`: `(?^:(?:\w+=[^\0]+)(?:\0\w+=[^\0]+)*)` ::
The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config.
`features`: `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
Allow containers access to advanced features.
@@ -152,7 +160,7 @@ Volume, device or directory to mount into the container.
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,host-managed=<1|0>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
@@ -172,6 +180,10 @@ Default gateway for IPv4 traffic.
Default gateway for IPv6 traffic.
`host-managed`=`<boolean>` ;;
Whether this interface's IP configuration should be managed by the host.
`hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
A common MAC address with the I/G (Individual/Group) bit not set.