]
]
},
+ "protected" : 1,
"returns" : {
"type" : "object"
}
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "repeat-missed" : {
+ "default" : 0,
+ "description" : "If true, the job will be run as soon as possible if it was missed while the scheduler was not running.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"schedule" : {
"description" : "Backup schedule. The format is a subset of `systemd` calendar events.",
"format" : "pve-calendar-event",
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "repeat-missed" : {
+ "default" : 0,
+ "description" : "If true, the job will be run as soon as possible if it was missed while the scheduler was not running.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"schedule" : {
"description" : "Backup schedule. The format is a subset of `systemd` calendar events.",
"format" : "pve-calendar-event",
"upper" : {
"default" : 1000000,
"description" : "Upper, exclusive boundary for free next-id API range.",
- "max" : 999999999,
+ "max" : 1000000000,
"min" : 100,
"optional" : 1,
"type" : "integer"
"type" : "string"
},
"macfilter" : {
- "default" : 0,
+ "default" : 1,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean"
"type" : "string"
},
"macfilter" : {
- "default" : 0,
+ "default" : 1,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean",
"type" : "string"
},
"nameserver" : {
- "description" : "cloud-init: Sets DNS server IP address for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.",
+ "description" : "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.",
"format" : "address-list",
"optional" : 1,
"type" : "string"
"type" : "string"
},
"searchdomain" : {
- "description" : "cloud-init: Sets DNS search domains for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.",
+ "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
"optional" : 1,
"type" : "string"
},
"typetext" : "<string>"
},
"nameserver" : {
- "description" : "cloud-init: Sets DNS server IP address for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.",
+ "description" : "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.",
"format" : "address-list",
"optional" : 1,
"type" : "string",
"type" : "string"
},
"searchdomain" : {
- "description" : "cloud-init: Sets DNS search domains for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.",
+ "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"typetext" : "<string>"
},
"nameserver" : {
- "description" : "cloud-init: Sets DNS server IP address for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.",
+ "description" : "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.",
"format" : "address-list",
"optional" : 1,
"type" : "string",
"type" : "string"
},
"searchdomain" : {
- "description" : "cloud-init: Sets DNS search domains for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.",
+ "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"typetext" : "<string>"
},
"nameserver" : {
- "description" : "cloud-init: Sets DNS server IP address for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.",
+ "description" : "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.",
"format" : "address-list",
"optional" : 1,
"type" : "string",
"type" : "string"
},
"searchdomain" : {
- "description" : "cloud-init: Sets DNS search domains for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.",
+ "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"type" : "string"
},
"macfilter" : {
- "default" : 0,
+ "default" : 1,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean"
"type" : "string"
},
"macfilter" : {
- "default" : 0,
+ "default" : 1,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean",
"optional" : 1,
"type" : "string"
},
+ "mounted" : {
+ "type" : "boolean"
+ },
"osdid" : {
"type" : "integer"
},
"properties" : {
"commands" : {
"description" : "JSON encoded array of commands.",
+ "format" : "pve-command-batch",
"type" : "string",
- "typetext" : "<string>"
+ "typetext" : "<string>",
+ "verbose_description" : "JSON encoded array of commands, where each command is an object with the following properties:\n args: <object>\n\n\t A set of parameter names and their values.\n\n method: (GET|POST|PUT|DELETE)\n\n\t A method related to the API endpoint (GET, POST etc.).\n\n path: <string>\n\n\t A relative path to an API endpoint on this node.\n\n"
},
"node" : {
"description" : "The cluster node name.",
"protected" : 1,
"proxyto" : "node",
"returns" : {
+ "items" : {
+ "properties" : {},
+ "type" : "object"
+ },
"type" : "array"
}
}
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "ceph_install",
"upgrade",
- "login"
+ "login",
+ "ceph_install"
],
"optional" : 1,
"type" : "string"
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "ceph_install",
"upgrade",
- "login"
+ "login",
+ "ceph_install"
],
"optional" : 1,
"type" : "string"
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "ceph_install",
"upgrade",
- "login"
+ "login",
+ "ceph_install"
],
"optional" : 1,
"type" : "string"
"typetext" : "<string>"
},
"namespace" : {
- "description" : "RBD Namespace.",
+ "description" : "Namespace.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"typetext" : "<string>"
},
"namespace" : {
- "description" : "RBD Namespace.",
+ "description" : "Namespace.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"self"
],
[
- "perm",
- "/access/users/{userid}",
+ "userid-group",
[
"User.Modify"
]
"self"
],
[
- "perm",
- "/access/users/{userid}",
+ "userid-group",
[
"User.Modify"
]
"self"
],
[
- "perm",
- "/access/users/{userid}",
+ "userid-group",
[
"User.Modify"
]
"self"
],
[
- "perm",
- "/access/users/{userid}",
+ "userid-group",
[
"User.Modify"
]
"self"
],
[
- "perm",
- "/access/users/{userid}",
+ "userid-group",
[
"User.Modify"
]
"properties" : {
"code" : {
"description" : "OpenId authorization code.",
- "maxLength" : 1024,
+ "maxLength" : 4096,
"type" : "string",
"typetext" : "<string>"
},
Log level for outgoing traffic.
-`macfilter`: `<boolean>` ('default =' `0`)::
+`macfilter`: `<boolean>` ('default =' `1`)::
Enable/disable MAC address filter.
*pve-firewall simulate* `[OPTIONS]`
-Simulate firewall rules. This does not simulate kernel 'routing' table.
-Instead, this simply assumes that routing from source zone to destination
-zone is possible.
+Simulate firewall rules. This does not simulates the kernel 'routing'
+table, but simply assumes that routing from source zone to destination zone
+is possible.
`--dest` `<string>` ::
*pve-firewall stop*
-Stop firewall. This removes all Proxmox VE related iptable rules. The host
-is unprotected afterwards.
+Stop the Proxmox VE firewall service. Note, stopping actively removes all
+Proxmox VE related iptable rules rendering the host potentially
+unprotected.
Use the test, not the main repository. Use with care!
-`--version` `<octopus | pacific>` ('default =' `pacific`)::
+`--version` `<octopus | pacific | quincy>` ('default =' `pacific`)::
Ceph version to install.
`--namespace` `<string>` ::
-RBD Namespace.
+Namespace.
`--nocow` `<boolean>` ('default =' `0`)::
`--namespace` `<string>` ::
-RBD Namespace.
+Namespace.
`--nocow` `<boolean>` ('default =' `0`)::
Proxmox VE subscription key
+*pvesubscription set-offline-key* `<data>`
+
+(Internal use only!) Set a signed subscription info blob as offline key
+
+`<data>`: `<string>` ::
+
+no description available
+
*pvesubscription update* `[OPTIONS]`
Update subscription info.
`nameserver`: `<string>` ::
-Sets DNS server IP address for a container. Create will'
- .' automatically use the setting from the host if neither searchdomain nor nameserver'
- .' are set.
+Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
`searchdomain`: `<string>` ::
-Sets DNS search domains for a container. Create will'
- .' automatically use the setting from the host if neither searchdomain nor nameserver'
- .' are set.
+Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
`sshkeys`: `<string>` ::
`--nameserver` `<string>` ::
-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.
+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>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
`--searchdomain` `<string>` ::
-cloud-init: Sets DNS search domains for a container. Create will'
- .' automatically use the setting from the host if neither searchdomain nor nameserver'
- .' are set.
+cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
`--serial[n]` `(/dev/.+|socket)` ::
`--nameserver` `<string>` ::
-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.
+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>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
`--searchdomain` `<string>` ::
-cloud-init: Sets DNS search domains for a container. Create will'
- .' automatically use the setting from the host if neither searchdomain nor nameserver'
- .' are set.
+cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
`--serial[n]` `(/dev/.+|socket)` ::
The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values.
-`reported-model`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Cascadelake-Server-noTSX | Conroe | EPYC | EPYC-IBPB | EPYC-Rome | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | Icelake-Client | Icelake-Client-noTSX | Icelake-Server | Icelake-Server-noTSX | IvyBridge | IvyBridge-IBRS | KnightsMill | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Client-noTSX-IBRS | Skylake-Server | Skylake-Server-IBRS | Skylake-Server-noTSX-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
+`reported-model`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Cascadelake-Server-noTSX | Conroe | EPYC | EPYC-IBPB | EPYC-Milan | EPYC-Rome | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | Icelake-Client | Icelake-Client-noTSX | Icelake-Server | Icelake-Server-noTSX | IvyBridge | IvyBridge-IBRS | KnightsMill | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Client-noTSX-IBRS | Skylake-Server | Skylake-Server-IBRS | Skylake-Server-noTSX-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS.
`nameserver`: `<string>` ::
-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.
+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>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
`searchdomain`: `<string>` ::
-cloud-init: Sets DNS search domains for a container. Create will'
- .' automatically use the setting from the host if neither searchdomain nor nameserver'
- .' are set.
+cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
`serial[n]`: `(/dev/.+|socket)` ::