var pveapi = [
{
"children" : [
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Corosync node list.",
+ "method" : "GET",
+ "name" : "nodes",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "node" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{node}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/config/nodes",
+ "text" : "nodes"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Get corosync totem protocol settings.",
+ "method" : "GET",
+ "name" : "totem",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "returns" : {
+ "properties" : {},
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/config/totem",
+ "text" : "totem"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "description" : "Directory index.",
+ "method" : "GET",
+ "name" : "index",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {},
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{name}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/cluster/config",
+ "text" : "config"
+ },
{
"children" : [
{
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"group" : {
"description" : "Security Group name.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
}
}
},
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
}
}
},
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"group" : {
"description" : "Security Group name.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"moveto" : {
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"group" : {
"description" : "Security Group name.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"properties" : {
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"group" : {
"description" : "Security Group name.",
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
}
}
},
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
}
}
},
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"moveto" : {
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
},
"nomatch" : {
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
},
"nomatch" : {
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"properties" : {
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "Alias name.",
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDR",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "Alias name.",
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDR",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "Alias name.",
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Enable or disable the firewall cluster wide.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"policy_in" : {
"description" : "Input policy.",
"id" : {
"description" : "The job ID.",
"maxLength" : 50,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"id" : {
"description" : "The job ID.",
"maxLength" : 50,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"default" : 0,
"description" : "Backup all known guest systems on this host.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"bwlimit" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"compress" : {
"default" : "0",
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dow" : {
"description" : "Day of week selection.",
"format" : "pve-day-of-week-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dumpdir" : {
"description" : "Store resulting files to specified directory.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enabled" : {
"default" : "1",
"description" : "Enable or disable the job.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"exclude" : {
"description" : "Exclude specified guest systems (assumes --all)",
"format" : "pve-vmid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"exclude-path" : {
"description" : "Exclude certain files/directories (shell globs).",
"format" : "string-alist",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"id" : {
"description" : "The job ID.",
"maxLength" : 50,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ionice" : {
"default" : 7,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 8)"
+ "typetext" : "<integer> (0 - 8)"
},
"lockwait" : {
"default" : 180,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"mailnotification" : {
"default" : "always",
"description" : "Comma-separated list of email addresses that should receive email notifications.",
"format" : "string-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"maxfiles" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"mode" : {
"default" : "snapshot",
"description" : "Only run if executed on this node.",
"format" : "pve-node",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pigz" : {
"default" : 0,
"description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.",
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "<integer>"
},
"quiet" : {
"default" : 0,
"description" : "Be quiet.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"remove" : {
"default" : 1,
"description" : "Remove old backup files if there are more than 'maxfiles' backup files.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"script" : {
"description" : "Use specified hook script.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"size" : {
"default" : 1024,
"minimum" : 500,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (500 - N)"
+ "typetext" : "<integer> (500 - N)"
},
"starttime" : {
"description" : "Job Start time.",
"default" : 1,
"description" : "Exclude temporary files and logs.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"stop" : {
"default" : 0,
"description" : "Stop runnig backup jobs on this host.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"stopwait" : {
"default" : 10,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"storage" : {
"description" : "Store resulting file to this storage.",
"format" : "pve-storage-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"tmpdir" : {
"description" : "Store temporary files to specified directory.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The ID of the guest system you want to backup.",
"format" : "pve-vmid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"default" : 0,
"description" : "Backup all known guest systems on this host.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"bwlimit" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"compress" : {
"default" : "0",
"description" : "Day of week selection.",
"format" : "pve-day-of-week-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dumpdir" : {
"description" : "Store resulting files to specified directory.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enabled" : {
"default" : "1",
"description" : "Enable or disable the job.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"exclude" : {
"description" : "Exclude specified guest systems (assumes --all)",
"format" : "pve-vmid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"exclude-path" : {
"description" : "Exclude certain files/directories (shell globs).",
"format" : "string-alist",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ionice" : {
"default" : 7,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 8)"
+ "typetext" : "<integer> (0 - 8)"
},
"lockwait" : {
"default" : 180,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"mailnotification" : {
"default" : "always",
"description" : "Comma-separated list of email addresses that should receive email notifications.",
"format" : "string-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"maxfiles" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"mode" : {
"default" : "snapshot",
"description" : "Only run if executed on this node.",
"format" : "pve-node",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pigz" : {
"default" : 0,
"description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.",
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "<integer>"
},
"quiet" : {
"default" : 0,
"description" : "Be quiet.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"remove" : {
"default" : 1,
"description" : "Remove old backup files if there are more than 'maxfiles' backup files.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"script" : {
"description" : "Use specified hook script.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"size" : {
"default" : 1024,
"minimum" : 500,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (500 - N)"
+ "typetext" : "<integer> (500 - N)"
},
"starttime" : {
"description" : "Job Start time.",
"default" : 1,
"description" : "Exclude temporary files and logs.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"stop" : {
"default" : 0,
"description" : "Stop runnig backup jobs on this host.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"stopwait" : {
"default" : 10,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"storage" : {
"description" : "Store resulting file to this storage.",
"format" : "pve-storage-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"tmpdir" : {
"description" : "Store temporary files to specified directory.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The ID of the guest system you want to backup.",
"format" : "pve-vmid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sid" : {
"description" : "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sid" : {
"description" : "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
"description" : "Description.",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"group" : {
"description" : "The HA group identifier.",
"format" : "pve-configid",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"max_relocate" : {
"default" : 1,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"max_restart" : {
"default" : 1,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"sid" : {
"description" : "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
"typetext" : "<type>:<name>"
},
"state" : {
- "default" : "enabled",
- "description" : "Resource state.",
+ "default" : "started",
+ "description" : "Requested resource state.",
"enum" : [
+ "started",
+ "stopped",
"enabled",
"disabled"
],
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n"
}
},
"type" : "object"
"description" : "Description.",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"group" : {
"description" : "The HA group identifier.",
"format" : "pve-configid",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"max_relocate" : {
"default" : 1,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"max_restart" : {
"default" : 1,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"sid" : {
"description" : "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
"typetext" : "<type>:<name>"
},
"state" : {
- "default" : "enabled",
- "description" : "Resource state.",
+ "default" : "started",
+ "description" : "Requested resource state.",
"enum" : [
+ "started",
+ "stopped",
"enabled",
"disabled"
],
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n"
},
"type" : {
"description" : "Resource type.",
"group" : {
"description" : "The HA group identifier.",
"format" : "pve-configid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"group" : {
"description" : "The HA group identifier.",
"format" : "pve-configid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "Description.",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"group" : {
"description" : "The HA group identifier.",
"format" : "pve-configid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nodes" : {
- "description" : "List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').",
+ "description" : "List of cluster node names with optional priority.",
"format" : "pve-ha-group-node-list",
"optional" : 1,
"type" : "string",
- "typetext" : "<node>[:<pri>]{,<node>[:<pri>]}*"
+ "typetext" : "<node>[:<pri>]{,<node>[:<pri>]}*",
+ "verbose_description" : "List of cluster node members, where a priority can be given to each node. A resource bound to a group will run on the available nodes with the highest priority. If there are more nodes in the highest priority class, the services will get distributed to those nodes. The priorities have a relative meaning only."
},
"nofailback" : {
"default" : 0,
"description" : "The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"restricted" : {
"default" : 0,
- "description" : "Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.",
+ "description" : "Resources bound to restricted groups may only run on nodes defined by the group.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>",
+ "verbose_description" : "Resources bound to restricted groups may only run on nodes defined by the group. The resource will be placed in the stopped state if no group node member is online. Resources on unrestricted groups may run on any cluster node if all group members are offline, but they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with only one member."
}
},
"type" : "object"
"description" : "Description.",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"group" : {
"description" : "The HA group identifier.",
"format" : "pve-configid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nodes" : {
- "description" : "List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').",
+ "description" : "List of cluster node names with optional priority.",
"format" : "pve-ha-group-node-list",
"optional" : 0,
"type" : "string",
- "typetext" : "<node>[:<pri>]{,<node>[:<pri>]}*"
+ "typetext" : "<node>[:<pri>]{,<node>[:<pri>]}*",
+ "verbose_description" : "List of cluster node members, where a priority can be given to each node. A resource bound to a group will run on the available nodes with the highest priority. If there are more nodes in the highest priority class, the services will get distributed to those nodes. The priorities have a relative meaning only."
},
"nofailback" : {
"default" : 0,
"description" : "The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"restricted" : {
"default" : 0,
- "description" : "Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.",
+ "description" : "Resources bound to restricted groups may only run on nodes defined by the group.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>",
+ "verbose_description" : "Resources bound to restricted groups may only run on nodes defined by the group. The resource will be placed in the stopped state if no group node member is online. Resources on unrestricted groups may run on any cluster node if all group members are offline, but they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with only one member."
},
"type" : {
"description" : "Group type.",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"email_from" : {
"description" : "Specify email address to send notification from (default is root@$hostname)",
"format" : "email-opt",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"fencing" : {
"default" : "watchdog",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"migration" : {
"description" : "For cluster wide migration settings.",
"migration_unsecure" : {
"description" : "Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead!",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"moveto" : {
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "Alias name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDR",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "Alias name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"rename" : {
"description" : "Rename an existing alias.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDR",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "Alias name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nomatch" : {
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nomatch" : {
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"properties" : {
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"rename" : {
"description" : "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dhcp" : {
"description" : "Enable DHCP.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Enable/disable firewall rules.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"ipfilter" : {
"description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"log_level_in" : {
"description" : "Log level for incoming traffic.",
"macfilter" : {
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"ndp" : {
"description" : "Enable NDP.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"policy_in" : {
"description" : "Input policy.",
"radv" : {
"description" : "Allow sending Router Advertisement.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"start" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Only list references of specified type.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"ds" : {
"description" : "The list of datasources you want to display.",
"format" : "pve-configid-list",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timeframe" : {
"description" : "Specify the time frame you are interested in.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timeframe" : {
"description" : "Specify the time frame you are interested in.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"default" : 0,
"description" : "Get current values (instead of pending values).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"default" : 1,
"description" : "Enable/disable ACPI.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"agent" : {
"default" : 0,
"description" : "Enable/disable Qemu GuestAgent.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"args" : {
"description" : "Arbitrary arguments passed to kvm.",
"optional" : 1,
"type" : "string",
+ "typetext" : "<string>",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"background_delay" : {
"description" : "Time to wait for the task to finish. We return 'null' if the task finish within that time.",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 30)"
+ "typetext" : "<integer> (1 - 30)"
},
"balloon" : {
"description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"bios" : {
"default" : "seabios",
"format" : "pve-qm-ide",
"optional" : 1,
"type" : "string",
- "typetext" : "volume"
+ "typetext" : "<volume>"
},
"cores" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"cpu" : {
"description" : "Emulated CPU type.",
"SandyBridge",
"Westmere"
],
- "format_description" : "cputype",
"type" : "string"
},
"hidden" : {
},
"optional" : 1,
"type" : "string",
- "typetext" : "[cputype=]<cputype> [,hidden=<1|0>]"
+ "typetext" : "[cputype=]<enum> [,hidden=<1|0>]"
},
"cpulimit" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "number",
- "typetext" : "number (0 - 128)",
+ "typetext" : "<number> (0 - 128)",
"verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
},
"cpuunits" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 500000)",
+ "typetext" : "<integer> (0 - 500000)",
"verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"description" : {
"description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"force" : {
"description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.",
"optional" : 1,
"requires" : "delete",
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"freeze" : {
"description" : "Freeze CPU at startup (use 'c' monitor command to start execution).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"hostpci[n]" : {
"description" : "Map host PCI devices into guest.",
"description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.",
"format" : "pve-hotplug-features",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"hugepages" : {
"description" : "Enable/disable hugepages memory.",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"keyboard" : {
"default" : "en-us",
"default" : 1,
"description" : "Enable/disable KVM hardware virtualization.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"localtime" : {
"description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"lock" : {
"description" : "Lock/unlock the VM.",
"minimum" : 16,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (16 - N)"
+ "typetext" : "<integer> (16 - N)"
},
"migrate_downtime" : {
"default" : 0.1,
"minimum" : 0,
"optional" : 1,
"type" : "number",
- "typetext" : "number (0 - N)"
+ "typetext" : "<number> (0 - N)"
},
"migrate_speed" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"name" : {
"description" : "Set a name for the VM. Only used on the configuration web interface.",
"format" : "dns-name",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"net[n]" : {
"description" : "Specify network devices.",
"e1000-82544gc",
"e1000-82545em"
],
- "format_description" : "model",
"type" : "string"
},
"ne2k_isa" : {
},
"optional" : 1,
"type" : "string",
- "typetext" : "[model=]<model> [,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>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"numa" : {
"default" : 0,
"description" : "Enable/disable NUMA.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"numa[n]" : {
"description" : "NUMA topology.",
"default" : 0,
"description" : "Specifies whether a VM will be started during system bootup.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"ostype" : {
"description" : "Specify guest operating system.",
"wvista",
"win7",
"win8",
+ "win10",
"l24",
"l26",
"solaris"
"default" : 0,
"description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"reboot" : {
"default" : 1,
"description" : "Allow reboot. If set to '0' the VM exit on reboot.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"revert" : {
"description" : "Revert a pending change.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sata[n]" : {
"description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"scsihw" : {
"default" : "lsi",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 50000)"
+ "typetext" : "<integer> (0 - 50000)"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"smbios1" : {
"description" : "Specify SMBIOS type 1 fields.",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"sockets" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"startdate" : {
"default" : "now",
"description" : "Enable/disable the USB tablet device.",
"optional" : 1,
"type" : "boolean",
+ "typetext" : "<boolean>",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"unused[n]" : {
"description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"usb[n]" : {
"description" : "Configure an USB device (n is 0 to 4).",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"vga" : {
"description" : "Select the VGA type.",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"watchdog" : {
"description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog",
"optional" : 1,
"type" : "string",
- "typetext" : "[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]",
+ "typetext" : "[[model=]<i6300esb|ib700>] [,action=<enum>]",
"verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)"
}
}
"default" : 1,
"description" : "Enable/disable ACPI.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"agent" : {
"default" : 0,
"description" : "Enable/disable Qemu GuestAgent.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"args" : {
"description" : "Arbitrary arguments passed to kvm.",
"optional" : 1,
"type" : "string",
+ "typetext" : "<string>",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"balloon" : {
"description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"bios" : {
"default" : "seabios",
"format" : "pve-qm-ide",
"optional" : 1,
"type" : "string",
- "typetext" : "volume"
+ "typetext" : "<volume>"
},
"cores" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"cpu" : {
"description" : "Emulated CPU type.",
"SandyBridge",
"Westmere"
],
- "format_description" : "cputype",
"type" : "string"
},
"hidden" : {
},
"optional" : 1,
"type" : "string",
- "typetext" : "[cputype=]<cputype> [,hidden=<1|0>]"
+ "typetext" : "[cputype=]<enum> [,hidden=<1|0>]"
},
"cpulimit" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "number",
- "typetext" : "number (0 - 128)",
+ "typetext" : "<number> (0 - 128)",
"verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
},
"cpuunits" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 500000)",
+ "typetext" : "<integer> (0 - 500000)",
"verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"description" : {
"description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"force" : {
"description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.",
"optional" : 1,
"requires" : "delete",
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"freeze" : {
"description" : "Freeze CPU at startup (use 'c' monitor command to start execution).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"hostpci[n]" : {
"description" : "Map host PCI devices into guest.",
"description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.",
"format" : "pve-hotplug-features",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"hugepages" : {
"description" : "Enable/disable hugepages memory.",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"keyboard" : {
"default" : "en-us",
"default" : 1,
"description" : "Enable/disable KVM hardware virtualization.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"localtime" : {
"description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"lock" : {
"description" : "Lock/unlock the VM.",
"minimum" : 16,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (16 - N)"
+ "typetext" : "<integer> (16 - N)"
},
"migrate_downtime" : {
"default" : 0.1,
"minimum" : 0,
"optional" : 1,
"type" : "number",
- "typetext" : "number (0 - N)"
+ "typetext" : "<number> (0 - N)"
},
"migrate_speed" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"name" : {
"description" : "Set a name for the VM. Only used on the configuration web interface.",
"format" : "dns-name",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"net[n]" : {
"description" : "Specify network devices.",
"e1000-82544gc",
"e1000-82545em"
],
- "format_description" : "model",
"type" : "string"
},
"ne2k_isa" : {
},
"optional" : 1,
"type" : "string",
- "typetext" : "[model=]<model> [,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>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"numa" : {
"default" : 0,
"description" : "Enable/disable NUMA.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"numa[n]" : {
"description" : "NUMA topology.",
"default" : 0,
"description" : "Specifies whether a VM will be started during system bootup.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"ostype" : {
"description" : "Specify guest operating system.",
"wvista",
"win7",
"win8",
+ "win10",
"l24",
"l26",
"solaris"
"default" : 0,
"description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"reboot" : {
"default" : 1,
"description" : "Allow reboot. If set to '0' the VM exit on reboot.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"revert" : {
"description" : "Revert a pending change.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sata[n]" : {
"description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"scsihw" : {
"default" : "lsi",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 50000)"
+ "typetext" : "<integer> (0 - 50000)"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"smbios1" : {
"description" : "Specify SMBIOS type 1 fields.",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"sockets" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"startdate" : {
"default" : "now",
"description" : "Enable/disable the USB tablet device.",
"optional" : 1,
"type" : "boolean",
+ "typetext" : "<boolean>",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"unused[n]" : {
"description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"usb[n]" : {
"description" : "Configure an USB device (n is 0 to 4).",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"vga" : {
"description" : "Select the VGA type.",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"watchdog" : {
"description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog",
"optional" : 1,
"type" : "string",
- "typetext" : "[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]",
+ "typetext" : "[[model=]<i6300esb|ib700>] [,action=<enum>]",
"verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)"
}
}
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"force" : {
"description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"idlist" : {
"description" : "A list of disk IDs you want to delete.",
"format" : "pve-configid-list",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"websocket" : {
"description" : "starts websockify instead of vncproxy",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"port" : {
"description" : "Port number returned by previous vncproxy call.",
"maximum" : 5999,
"minimum" : 5900,
"type" : "integer",
- "typetext" : "integer (5900 - 5999)"
+ "typetext" : "<integer> (5900 - 5999)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"vncticket" : {
"description" : "Ticket from previous call to vncproxy.",
"maxLength" : 512,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"proxy" : {
"description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).",
"format" : "address",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : "The cluster node name.",
"format" : "pve-node",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"migration_network" : {
"description" : "CIDR of the (sub) network that is used for migration.",
"format" : "CIDR",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"migration_type" : {
"description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"stateuri" : {
"description" : "Some command save/restore state from this location.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"default" : 0,
"description" : "Do not deactivate storage volumes.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"migratedfrom" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"timeout" : {
"description" : "Wait maximal timeout seconds.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"default" : 0,
"description" : "Make sure the VM stops.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"keepActive" : {
"default" : 0,
"description" : "Do not deactivate storage volumes.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"timeout" : {
"description" : "Wait maximal timeout seconds.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"properties" : {
"nocheck" : {
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"properties" : {
"key" : {
"description" : "The key (qemu monitor encoding).",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : {
"description" : "Description for the new VM.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"format" : {
"description" : "Target format for file storage.",
"default" : 0,
"description" : "Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"name" : {
"description" : "Set a name for the new VM.",
"format" : "dns-name",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"newid" : {
"description" : "VMID for the clone.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pool" : {
"description" : "Add the new VM to the specified pool.",
"format" : "pve-poolid",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "Target storage for full clone.",
"format" : "pve-storage-id",
"optional" : 1,
"requires" : "full",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"target" : {
"description" : "Target node. Only allowed if the original VM is on shared storage.",
"format" : "pve-node",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"default" : 0,
"description" : "Delete the original disk after successful copy. By default the original disk is kept as unused disk.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"disk" : {
"description" : "The disk you want to move.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "Target storage.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"force" : {
"description" : "Allow to migrate VMs which use local devices. Only root may use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"migration_network" : {
"description" : "CIDR of the (sub) network that is used for migration.",
"format" : "CIDR",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"migration_type" : {
"description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"online" : {
"description" : "Use online/live migration.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"target" : {
"description" : "Target node.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"properties" : {
"command" : {
"description" : "The monitor command.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
[
"VM.Monitor"
]
- ]
+ ],
+ "description" : "Sys.Modify is required for (sub)commands which are not read-only ('info *' and 'help')"
},
"protected" : 1,
"proxyto" : "node",
"path" : "/nodes/{node}/qemu/{vmid}/monitor",
"text" : "monitor"
},
+ {
+ "info" : {
+ "POST" : {
+ "description" : "Execute Qemu Guest Agent commands.",
+ "method" : "POST",
+ "name" : "agent",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "command" : {
+ "description" : "The QGA command.",
+ "enum" : [
+ "ping",
+ "get-time",
+ "info",
+ "fsfreeze-status",
+ "fsfreeze-freeze",
+ "fsfreeze-thaw",
+ "fstrim",
+ "network-get-interfaces",
+ "get-vcpus",
+ "get-fsinfo",
+ "get-memory-blocks",
+ "get-memory-block-info",
+ "suspend-hybrid",
+ "suspend-ram",
+ "suspend-disk",
+ "shutdown"
+ ],
+ "type" : "string"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "vmid" : {
+ "description" : "The (unique) ID of the VM.",
+ "format" : "pve-vmid",
+ "minimum" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - N)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/vms/{vmid}",
+ [
+ "VM.Monitor"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "description" : "Returns an object with a single `result` property. The type of that\nproperty depends on the executed command.",
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/qemu/{vmid}/agent",
+ "text" : "agent"
+ },
{
"info" : {
"PUT" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"disk" : {
"description" : "The disk you want to resize.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"size" : {
"description" : "The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.",
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : {
"description" : "A textual description or comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"force" : {
"description" : "For removal from config file, even if removing disk snapshots fails.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : {
"description" : "A textual description or comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"vmstate" : {
"description" : "Save the vmstate",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"full" : {
"description" : "Determine the full status of active VMs.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"default" : 1,
"description" : "Enable/disable ACPI.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"agent" : {
"default" : 0,
"description" : "Enable/disable Qemu GuestAgent.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"archive" : {
"description" : "The backup file.",
"maxLength" : 255,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"args" : {
"description" : "Arbitrary arguments passed to kvm.",
"optional" : 1,
"type" : "string",
+ "typetext" : "<string>",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"balloon" : {
"description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"bios" : {
"default" : "seabios",
"format" : "pve-qm-ide",
"optional" : 1,
"type" : "string",
- "typetext" : "volume"
+ "typetext" : "<volume>"
},
"cores" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"cpu" : {
"description" : "Emulated CPU type.",
"SandyBridge",
"Westmere"
],
- "format_description" : "cputype",
"type" : "string"
},
"hidden" : {
},
"optional" : 1,
"type" : "string",
- "typetext" : "[cputype=]<cputype> [,hidden=<1|0>]"
+ "typetext" : "[cputype=]<enum> [,hidden=<1|0>]"
},
"cpulimit" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "number",
- "typetext" : "number (0 - 128)",
+ "typetext" : "<number> (0 - 128)",
"verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
},
"cpuunits" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 500000)",
+ "typetext" : "<integer> (0 - 500000)",
"verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
},
"description" : {
"description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"force" : {
"description" : "Allow to overwrite existing VM.",
"optional" : 1,
"requires" : "archive",
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"freeze" : {
"description" : "Freeze CPU at startup (use 'c' monitor command to start execution).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"hostpci[n]" : {
"description" : "Map host PCI devices into guest.",
"description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.",
"format" : "pve-hotplug-features",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"hugepages" : {
"description" : "Enable/disable hugepages memory.",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"keyboard" : {
"default" : "en-us",
"default" : 1,
"description" : "Enable/disable KVM hardware virtualization.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"localtime" : {
"description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"lock" : {
"description" : "Lock/unlock the VM.",
"minimum" : 16,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (16 - N)"
+ "typetext" : "<integer> (16 - N)"
},
"migrate_downtime" : {
"default" : 0.1,
"minimum" : 0,
"optional" : 1,
"type" : "number",
- "typetext" : "number (0 - N)"
+ "typetext" : "<number> (0 - N)"
},
"migrate_speed" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"name" : {
"description" : "Set a name for the VM. Only used on the configuration web interface.",
"format" : "dns-name",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"net[n]" : {
"description" : "Specify network devices.",
"e1000-82544gc",
"e1000-82545em"
],
- "format_description" : "model",
"type" : "string"
},
"ne2k_isa" : {
},
"optional" : 1,
"type" : "string",
- "typetext" : "[model=]<model> [,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>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"numa" : {
"default" : 0,
"description" : "Enable/disable NUMA.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"numa[n]" : {
"description" : "NUMA topology.",
"default" : 0,
"description" : "Specifies whether a VM will be started during system bootup.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"ostype" : {
"description" : "Specify guest operating system.",
"wvista",
"win7",
"win8",
+ "win10",
"l24",
"l26",
"solaris"
"description" : "Add the VM to the specified pool.",
"format" : "pve-poolid",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"protection" : {
"default" : 0,
"description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"reboot" : {
"default" : 1,
"description" : "Allow reboot. If set to '0' the VM exit on reboot.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"sata[n]" : {
"description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"scsihw" : {
"default" : "lsi",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 50000)"
+ "typetext" : "<integer> (0 - 50000)"
},
"smbios1" : {
"description" : "Specify SMBIOS type 1 fields.",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"sockets" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"startdate" : {
"default" : "now",
"description" : "Default storage.",
"format" : "pve-storage-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"tablet" : {
"default" : 1,
"description" : "Enable/disable the USB tablet device.",
"optional" : 1,
"type" : "boolean",
+ "typetext" : "<boolean>",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"unique" : {
"description" : "Assign a unique random ethernet address.",
"optional" : 1,
"requires" : "archive",
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"unused[n]" : {
"description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"usb[n]" : {
"description" : "Configure an USB device (n is 0 to 4).",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"vga" : {
"description" : "Select the VGA type.",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"watchdog" : {
"description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog",
"optional" : 1,
"type" : "string",
- "typetext" : "[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]",
+ "typetext" : "[[model=]<i6300esb|ib700>] [,action=<enum>]",
"verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)"
}
}
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"default" : 1,
"description" : "Attach a console device (/dev/console) to the container.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"cores" : {
"description" : "The number of cores assigned to the container. A container can use all available cores by default.",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 128)"
+ "typetext" : "<integer> (1 - 128)"
},
"cpulimit" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "number",
- "typetext" : "number (0 - 128)"
+ "typetext" : "<number> (0 - 128)"
},
"cpuunits" : {
"default" : 1024,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 500000)"
+ "typetext" : "<integer> (0 - 500000)"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"description" : {
"description" : "Container description. Only used on the configuration web interface.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"hostname" : {
"description" : "Set a host name for the container.",
"format" : "dns-name",
"maxLength" : 255,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"lock" : {
"description" : "Lock/unlock the VM.",
"minimum" : 16,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (16 - N)"
+ "typetext" : "<integer> (16 - N)"
},
"mp[n]" : {
"description" : "Use volume as container mount point.",
"description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"format" : "address-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"net[n]" : {
"description" : "Specifies network interfaces for the container.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"onboot" : {
"default" : 0,
"description" : "Specifies whether a VM will be started during system bootup.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"ostype" : {
"description" : "OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.",
"default" : 0,
"description" : "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"rootfs" : {
"description" : "Use volume as container root.",
"description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"format" : "dns-name-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"startup" : {
"description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"tty" : {
"default" : 2,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 6)"
+ "typetext" : "<integer> (0 - 6)"
},
"unprivileged" : {
"default" : 0,
"description" : "Makes the container run as unprivileged user. (Should not be modified manually.)",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"unused[n]" : {
"description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"default" : 0,
"description" : "Make sure the Container stops.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timeout" : {
"default" : 60,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : {
"description" : "A textual description or comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"force" : {
"description" : "For removal from config file, even if removing disk snapshots fails.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : {
"description" : "A textual description or comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"moveto" : {
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "Alias name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDR",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "Alias name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"rename" : {
"description" : "Rename an existing alias.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDR",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "Alias name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nomatch" : {
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"cidr" : {
"description" : "Network/IP specification in CIDR format.",
"format" : "IPorCIDRorAlias",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nomatch" : {
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"properties" : {
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"name" : {
"description" : "IP set name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"rename" : {
"description" : "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dhcp" : {
"description" : "Enable DHCP.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Enable/disable firewall rules.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"ipfilter" : {
"description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"log_level_in" : {
"description" : "Log level for incoming traffic.",
"macfilter" : {
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"ndp" : {
"description" : "Enable NDP.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"policy_in" : {
"description" : "Input policy.",
"radv" : {
"description" : "Allow sending Router Advertisement.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"start" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Only list references of specified type.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"ds" : {
"description" : "The list of datasources you want to display.",
"format" : "pve-configid-list",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timeframe" : {
"description" : "Specify the time frame you are interested in.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timeframe" : {
"description" : "Specify the time frame you are interested in.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"websocket" : {
"description" : "use websocket instead of standard VNC.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"port" : {
"description" : "Port number returned by previous vncproxy call.",
"maximum" : 5999,
"minimum" : 5900,
"type" : "integer",
- "typetext" : "integer (5900 - 5999)"
+ "typetext" : "<integer> (5900 - 5999)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"vncticket" : {
"description" : "Ticket from previous call to vncproxy.",
"maxLength" : 512,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"proxy" : {
"description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).",
"format" : "address",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"force" : {
"description" : "Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"online" : {
"description" : "Use online/live migration.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"target" : {
"description" : "Target node.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"experimental" : {
"default" : 0,
"description" : "The template feature is experimental, set this flag if you know what you are doing.",
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : {
"description" : "Description for the new CT.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"experimental" : {
"default" : 0,
"description" : "The clone feature is experimental, set this flag if you know what you are doing.",
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"full" : {
"default" : 0,
"description" : "Create a full copy of all disk. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"hostname" : {
"description" : "Set a hostname for the new CT.",
"format" : "dns-name",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"newid" : {
"description" : "VMID for the clone.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pool" : {
"description" : "Add the new CT to the specified pool.",
"format" : "pve-poolid",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"snapname" : {
"description" : "The name of the snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "Target storage for full clone.",
"format" : "pve-storage-id",
"optional" : 1,
"requires" : "full",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"disk" : {
"description" : "The disk you want to resize.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"size" : {
"description" : "The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"default" : 1,
"description" : "Attach a console device (/dev/console) to the container.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"cores" : {
"description" : "The number of cores assigned to the container. A container can use all available cores by default.",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 128)"
+ "typetext" : "<integer> (1 - 128)"
},
"cpulimit" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "number",
- "typetext" : "number (0 - 128)"
+ "typetext" : "<number> (0 - 128)"
},
"cpuunits" : {
"default" : 1024,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 500000)"
+ "typetext" : "<integer> (0 - 500000)"
},
"description" : {
"description" : "Container description. Only used on the configuration web interface.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"force" : {
"description" : "Allow to overwrite existing container.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"hostname" : {
"description" : "Set a host name for the container.",
"format" : "dns-name",
"maxLength" : 255,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ignore-unpack-errors" : {
"description" : "Ignore errors when extracting the template.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"lock" : {
"description" : "Lock/unlock the VM.",
"minimum" : 16,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (16 - N)"
+ "typetext" : "<integer> (16 - N)"
},
"mp[n]" : {
"description" : "Use volume as container mount point.",
"description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"format" : "address-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"net[n]" : {
"description" : "Specifies network interfaces for the container.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"onboot" : {
"default" : 0,
"description" : "Specifies whether a VM will be started during system bootup.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"ostemplate" : {
"description" : "The OS template or backup file.",
"maxLength" : 255,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ostype" : {
"description" : "OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.",
"description" : "Sets root password inside container.",
"minLength" : 5,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pool" : {
"description" : "Add the VM to the specified pool.",
"format" : "pve-poolid",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"protection" : {
"default" : 0,
"description" : "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"restore" : {
"description" : "Mark this as restore task.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"rootfs" : {
"description" : "Use volume as container root.",
"description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"format" : "dns-name-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ssh-public-keys" : {
"description" : "Setup public SSH keys (one key per line, OpenSSH format).",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"startup" : {
"description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.",
"description" : "Default Storage.",
"format" : "pve-storage-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"swap" : {
"default" : 512,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"tty" : {
"default" : 2,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 6)"
+ "typetext" : "<integer> (0 - 6)"
},
"unprivileged" : {
"default" : 0,
"description" : "Makes the container run as unprivileged user. (Should not be modified manually.)",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"unused[n]" : {
"description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"osdid" : {
"description" : "OSD ID",
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "<integer>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"osdid" : {
"description" : "OSD ID",
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "<integer>"
}
}
},
"default" : 0,
"description" : "If set, we remove partition table entries.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"osdid" : {
"description" : "OSD ID",
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "<integer>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"dev" : {
"description" : "Block device name.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"fstype" : {
"default" : "xfs",
"journal_dev" : {
"description" : "Block device name for journal.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Only list specific types of disks.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"monid" : {
"description" : "Monitor ID",
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "<integer>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"format" : "CIDR",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pg_bits" : {
"default" : 6,
"minimum" : 6,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (6 - 14)"
+ "typetext" : "<integer> (6 - 14)"
},
"size" : {
"default" : 2,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 3)"
+ "typetext" : "<integer> (1 - 3)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"service" : {
"description" : "Ceph service name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"service" : {
"description" : "Ceph service name.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"default" : 0,
"description" : "If true, destroys pool even if in use",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"name" : {
"description" : "The name of the pool. It must be unique.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 32768)"
+ "typetext" : "<integer> (0 - 32768)"
},
"min_size" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 3)"
+ "typetext" : "<integer> (1 - 3)"
},
"name" : {
"description" : "The name of the pool. It must be unique.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pg_num" : {
"default" : 64,
"minimum" : 8,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (8 - 32768)"
+ "typetext" : "<integer> (8 - 32768)"
},
"size" : {
"default" : 2,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 3)"
+ "typetext" : "<integer> (1 - 3)"
}
}
},
"path" : "/nodes/{node}/ceph/pools",
"text" : "pools"
},
+ {
+ "children" : [
+ {
+ "info" : {
+ "DELETE" : {
+ "description" : "Unset a ceph flag",
+ "method" : "DELETE",
+ "name" : "unset_flag",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "flag" : {
+ "description" : "The ceph flag to set/unset",
+ "enum" : [
+ "full",
+ "pause",
+ "noup",
+ "nodown",
+ "noout",
+ "noin",
+ "nobackfill",
+ "norebalance",
+ "norecover",
+ "noscrub",
+ "nodeep-scrub",
+ "notieragent"
+ ],
+ "type" : "string"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "null"
+ }
+ },
+ "POST" : {
+ "description" : "Set a ceph flag",
+ "method" : "POST",
+ "name" : "set_flag",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "flag" : {
+ "description" : "The ceph flag to set/unset",
+ "enum" : [
+ "full",
+ "pause",
+ "noup",
+ "nodown",
+ "noout",
+ "noin",
+ "nobackfill",
+ "norebalance",
+ "norecover",
+ "noscrub",
+ "nodeep-scrub",
+ "notieragent"
+ ],
+ "type" : "string"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/ceph/flags/{flag}",
+ "text" : "{flag}"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "description" : "get all set ceph flags",
+ "method" : "GET",
+ "name" : "get_flags",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/nodes/{node}/ceph/flags",
+ "text" : "flags"
+ },
{
"info" : {
"GET" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"start" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"volume" : {
"description" : "Volume identifier",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"default" : 0,
"description" : "Backup all known guest systems on this host.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"bwlimit" : {
"default" : 0,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"compress" : {
"default" : "0",
"dumpdir" : {
"description" : "Store resulting files to specified directory.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"exclude" : {
"description" : "Exclude specified guest systems (assumes --all)",
"format" : "pve-vmid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"exclude-path" : {
"description" : "Exclude certain files/directories (shell globs).",
"format" : "string-alist",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ionice" : {
"default" : 7,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - 8)"
+ "typetext" : "<integer> (0 - 8)"
},
"lockwait" : {
"default" : 180,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"mailnotification" : {
"default" : "always",
"description" : "Comma-separated list of email addresses that should receive email notifications.",
"format" : "string-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"maxfiles" : {
"default" : 1,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"mode" : {
"default" : "snapshot",
"description" : "Only run if executed on this node.",
"format" : "pve-node",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pigz" : {
"default" : 0,
"description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.",
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "<integer>"
},
"quiet" : {
"default" : 0,
"description" : "Be quiet.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"remove" : {
"default" : 1,
"description" : "Remove old backup files if there are more than 'maxfiles' backup files.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"script" : {
"description" : "Use specified hook script.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"size" : {
"default" : 1024,
"minimum" : 500,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (500 - N)"
+ "typetext" : "<integer> (500 - N)"
},
"stdexcludes" : {
"default" : 1,
"description" : "Exclude temporary files and logs.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"stdout" : {
"description" : "Write tar to stdout, not to a file.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"stop" : {
"default" : 0,
"description" : "Stop runnig backup jobs on this host.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"stopwait" : {
"default" : 10,
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"storage" : {
"description" : "Store resulting file to this storage.",
"format" : "pve-storage-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"tmpdir" : {
"description" : "Store temporary files to specified directory.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "The ID of the guest system you want to backup.",
"format" : "pve-vmid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"service" : {
"description" : "Service ID",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"service" : {
"description" : "Service ID",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"service" : {
"description" : "Service ID",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"service" : {
"description" : "Service ID",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"service" : {
"description" : "Service ID",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"service" : {
"description" : "Service ID",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"default" : 0,
"description" : "Always connect to server, even if we have up to date info inside local cache.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"key" : {
"description" : "Proxmox VE subscription key",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"format" : "pve-iface",
"maxLength" : 20,
"minLength" : 2,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"format" : "pve-iface",
"maxLength" : 20,
"minLength" : 2,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"format" : "ipv4",
"optional" : 1,
"requires" : "netmask",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"address6" : {
"description" : "IP address.",
"format" : "ipv6",
"optional" : 1,
"requires" : "netmask6",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"autostart" : {
"description" : "Automatically start interface on boot.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"bond_mode" : {
"description" : "Bonding mode.",
"description" : "Specify the iterfaces you want to add to your bridge.",
"format" : "pve-iface-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"bridge_vlan_aware" : {
"description" : "Enable bridge vlan support.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"comments" : {
"description" : "Comments",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comments6" : {
"description" : "Comments",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"gateway" : {
"description" : "Default gateway address.",
"format" : "ipv4",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"gateway6" : {
"description" : "Default ipv6 gateway address.",
"format" : "ipv6",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"iface" : {
"description" : "Network interface name.",
"format" : "pve-iface",
"maxLength" : 20,
"minLength" : 2,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"netmask" : {
"description" : "Network mask.",
"format" : "ipv4mask",
"optional" : 1,
"requires" : "address",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"netmask6" : {
"description" : "Network mask.",
"optional" : 1,
"requires" : "address6",
"type" : "integer",
- "typetext" : "integer (0 - 128)"
+ "typetext" : "<integer> (0 - 128)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_bonds" : {
"description" : "Specify the interfaces used by the bonding device.",
"format" : "pve-iface-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_bridge" : {
"description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.",
"format" : "pve-iface",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_options" : {
"description" : "OVS interface options.",
"maxLength" : 1024,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_ports" : {
"description" : "Specify the iterfaces you want to add to your bridge.",
"format" : "pve-iface-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_tag" : {
"description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 4094)"
+ "typetext" : "<integer> (1 - 4094)"
},
"slaves" : {
"description" : "Specify the interfaces used by the bonding device.",
"format" : "pve-iface-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Network interface type",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Only list specific interface types.",
"format" : "ipv4",
"optional" : 1,
"requires" : "netmask",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"address6" : {
"description" : "IP address.",
"format" : "ipv6",
"optional" : 1,
"requires" : "netmask6",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"autostart" : {
"description" : "Automatically start interface on boot.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"bond_mode" : {
"description" : "Bonding mode.",
"description" : "Specify the iterfaces you want to add to your bridge.",
"format" : "pve-iface-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"bridge_vlan_aware" : {
"description" : "Enable bridge vlan support.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"comments" : {
"description" : "Comments",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comments6" : {
"description" : "Comments",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"gateway" : {
"description" : "Default gateway address.",
"format" : "ipv4",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"gateway6" : {
"description" : "Default ipv6 gateway address.",
"format" : "ipv6",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"iface" : {
"description" : "Network interface name.",
"format" : "pve-iface",
"maxLength" : 20,
"minLength" : 2,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"netmask" : {
"description" : "Network mask.",
"format" : "ipv4mask",
"optional" : 1,
"requires" : "address",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"netmask6" : {
"description" : "Network mask.",
"optional" : 1,
"requires" : "address6",
"type" : "integer",
- "typetext" : "integer (0 - 128)"
+ "typetext" : "<integer> (0 - 128)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_bonds" : {
"description" : "Specify the interfaces used by the bonding device.",
"format" : "pve-iface-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_bridge" : {
"description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.",
"format" : "pve-iface",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_options" : {
"description" : "OVS interface options.",
"maxLength" : 1024,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_ports" : {
"description" : "Specify the iterfaces you want to add to your bridge.",
"format" : "pve-iface-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"ovs_tag" : {
"description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 4094)"
+ "typetext" : "<integer> (1 - 4094)"
},
"slaves" : {
"description" : "Specify the interfaces used by the bonding device.",
"format" : "pve-iface-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Network interface type",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"start" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"upid" : {
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"upid" : {
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"upid" : {
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"upid" : {
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"errors" : {
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"limit" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"start" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"userfilter" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "Only list tasks for this VM.",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"server" : {
"format" : "pve-storage-server",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"server" : {
"format" : "pve-storage-server",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"portal" : {
"format" : "pve-storage-portal-dns",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vg" : {
"maxLength" : 100,
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"volume" : {
"description" : "Volume identifier",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"volume" : {
"description" : "Volume identifier",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"target" : {
"description" : "Target volume identifier",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"target_node" : {
"description" : "Target node. Default is local node.",
"format" : "pve-node",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"volume" : {
"description" : "Source volume identifier",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "Only list content of this type.",
"format" : "pve-storage-content",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "Only list images for this VM",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"properties" : {
"filename" : {
"description" : "The name of the file to create.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"format" : {
"enum" : [
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"size" : {
"description" : "Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)",
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vmid" : {
"description" : "Specify owner VM",
"format" : "pve-vmid",
"minimum" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"ds" : {
"description" : "The list of datasources you want to display.",
"format" : "pve-configid-list",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timeframe" : {
"description" : "Specify the time frame you are interested in.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timeframe" : {
"description" : "Specify the time frame you are interested in.",
"content" : {
"description" : "Content type.",
"format" : "pve-storage-content",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"filename" : {
"description" : "The name of the file to create.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"tmpfilename" : {
"description" : "The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trustet port on localhost.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "Only list stores which support this content type.",
"format" : "pve-storage-content-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enabled" : {
"default" : 0,
"description" : "Only list stores which are enabled (not disabled in config).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "Only list status for specified storage",
"format" : "pve-storage-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"target" : {
"description" : "If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.",
"format" : "pve-node",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"healthonly" : {
"description" : "If true returns only the health status",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"uuid" : {
"description" : "UUID for the GPT table",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"notify" : {
"default" : 0,
"description" : "Send notification mail about new packages (to email address specified for user 'root@pam').",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"quiet" : {
"default" : 0,
"description" : "Only produces output suitable for logging, omitting progress indicators.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"properties" : {
"name" : {
"description" : "Package name.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"version" : {
"description" : "Package version.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
}
}
},
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"moveto" : {
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"comment" : {
"description" : "Descriptive comment.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dest" : {
"description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dport" : {
"description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-dport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Flag to enable/disable a rule.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"maxLength" : 20,
"minLength" : 2,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"format" : "pve-fw-protocol-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"source" : {
"description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
"format" : "pve-fw-addr-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"sport" : {
"description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.",
"format" : "pve-fw-sport-spec",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Rule type.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Enable host firewall rules.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"log_level_in" : {
"description" : "Log level for incoming traffic.",
"ndp" : {
"description" : "Enable NDP.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"nf_conntrack_max" : {
"description" : "Maximum number of tracked connections.",
"minimum" : 32768,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (32768 - N)"
+ "typetext" : "<integer> (32768 - N)"
},
"nf_conntrack_tcp_timeout_established" : {
"description" : "Conntrack established timeout.",
"minimum" : 7875,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (7875 - N)"
+ "typetext" : "<integer> (7875 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nosmurfs" : {
"description" : "Enable SMURFS filter.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"smurf_log_level" : {
"description" : "Log level for SMURFS filter.",
"tcpflags" : {
"description" : "Filter illegal combinations of TCP flags.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"start" : {
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"commands" : {
"description" : "JSON encoded array of commands.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"ds" : {
"description" : "The list of datasources you want to display.",
"format" : "pve-configid-list",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timeframe" : {
"description" : "Specify the time frame you are interested in.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timeframe" : {
"description" : "Specify the time frame you are interested in.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"since" : {
"description" : "Display all log since this date-time string.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"until" : {
"description" : "Display all log until this date-time string.",
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"upgrade" : {
"default" : 0,
"description" : "Run 'apt-get dist-upgrade' instead of normal shell.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"websocket" : {
"description" : "use websocket instead of standard vnc.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"port" : {
"description" : "Port number returned by previous vncproxy call.",
"maximum" : 5999,
"minimum" : 5900,
"type" : "integer",
- "typetext" : "integer (5900 - 5999)"
+ "typetext" : "<integer> (5900 - 5999)"
},
"vncticket" : {
"description" : "Ticket from previous call to vncproxy.",
"maxLength" : 512,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"proxy" : {
"description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).",
"format" : "address",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"upgrade" : {
"default" : 0,
"description" : "Run 'apt-get dist-upgrade' instead of normal shell.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "First name server IP address.",
"format" : "ip",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dns2" : {
"description" : "Second name server IP address.",
"format" : "ip",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"dns3" : {
"description" : "Third name server IP address.",
"format" : "ip",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"search" : {
"description" : "Search domain for host-name lookup.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"timezone" : {
"description" : "Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "The storage where the template will be stored",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"template" : {
"description" : "The template wich will downloaded",
"maxLength" : 255,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"force" : {
"description" : "force if onboot=0.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - N)"
+ "typetext" : "<integer> (1 - N)"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"target" : {
"description" : "Target node.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"blocksize" : {
"description" : "block size",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comstar_hg" : {
"description" : "host group for comstar views",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comstar_tg" : {
"description" : "target group for comstar views",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"content" : {
"description" : "Allowed content types.\n\nNOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.\n",
"format" : "pve-storage-content-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"disable" : {
"description" : "Flag to disable the storage.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"format" : {
"description" : "Default image format.",
"format" : "pve-storage-format",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"is_mountpoint" : {
"default" : "no",
"description" : "Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"krbd" : {
"description" : "Access rbd through krbd kernel module.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"maxfiles" : {
"description" : "Maximal number of backup files per VM. Use '0' for unlimted.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"mkdir" : {
"default" : "yes",
"description" : "Create the directory if it doesn't exist.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"nodes" : {
"description" : "List of cluster node names.",
"format" : "pve-node-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nowritecache" : {
"description" : "disable write caching on the target",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"options" : {
"description" : "NFS mount options (see 'man nfs')",
"format" : "pve-storage-options",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pool" : {
"description" : "Pool.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"redundancy" : {
"default" : 2,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 16)"
+ "typetext" : "<integer> (1 - 16)"
},
"saferemove" : {
"description" : "Zero-out data when removing LVs.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"saferemove_throughput" : {
"description" : "Wipe throughput (cstream -t parameter value).",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"server" : {
"description" : "Server IP or DNS name.",
"format" : "pve-storage-server",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"server2" : {
"description" : "Backup volfile server IP or DNS name.",
"format" : "pve-storage-server",
"optional" : 1,
"requires" : "server",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"shared" : {
"description" : "Mark storage as shared.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"sparse" : {
"description" : "use sparse volumes",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"tagged_only" : {
"description" : "Only use logical volumes tagged with 'pve-vm-ID'.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"transport" : {
"description" : "Gluster transport: tcp or rdma",
"username" : {
"description" : "RBD Id.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
},
"type" : "object"
"authsupported" : {
"description" : "Authsupported.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"base" : {
"description" : "Base volume. This volume is automatically activated.",
"format" : "pve-volume-id",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"blocksize" : {
"description" : "block size",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comstar_hg" : {
"description" : "host group for comstar views",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"comstar_tg" : {
"description" : "target group for comstar views",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"content" : {
"description" : "Allowed content types.\n\nNOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.\n",
"format" : "pve-storage-content-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"disable" : {
"description" : "Flag to disable the storage.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"export" : {
"description" : "NFS export path.",
"format" : "pve-storage-path",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"format" : {
"description" : "Default image format.",
"format" : "pve-storage-format",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"is_mountpoint" : {
"default" : "no",
"description" : "Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"iscsiprovider" : {
"description" : "iscsi provider",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"krbd" : {
"description" : "Access rbd through krbd kernel module.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"maxfiles" : {
"description" : "Maximal number of backup files per VM. Use '0' for unlimted.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"mkdir" : {
"default" : "yes",
"description" : "Create the directory if it doesn't exist.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"monhost" : {
"description" : "Monitors daemon ips.",
"format" : "pve-storage-portal-dns-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nodes" : {
"description" : "List of cluster node names.",
"format" : "pve-node-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"nowritecache" : {
"description" : "disable write caching on the target",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"options" : {
"description" : "NFS mount options (see 'man nfs')",
"format" : "pve-storage-options",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"path" : {
"description" : "File system path.",
"format" : "pve-storage-path",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"pool" : {
"description" : "Pool.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"portal" : {
"description" : "iSCSI portal (IP or DNS name with optional port).",
"format" : "pve-storage-portal-dns",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"redundancy" : {
"default" : 2,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 16)"
+ "typetext" : "<integer> (1 - 16)"
},
"saferemove" : {
"description" : "Zero-out data when removing LVs.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"saferemove_throughput" : {
"description" : "Wipe throughput (cstream -t parameter value).",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"server" : {
"description" : "Server IP or DNS name.",
"format" : "pve-storage-server",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"server2" : {
"description" : "Backup volfile server IP or DNS name.",
"format" : "pve-storage-server",
"optional" : 1,
"requires" : "server",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"shared" : {
"description" : "Mark storage as shared.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"sparse" : {
"description" : "use sparse volumes",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"storage" : {
"description" : "The storage identifier.",
"format" : "pve-storage-id",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"tagged_only" : {
"description" : "Only use logical volumes tagged with 'pve-vm-ID'.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"target" : {
"description" : "iSCSI target.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"thinpool" : {
"description" : "LVM thin pool LV name.",
"format" : "pve-storage-vgname",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"transport" : {
"description" : "Gluster transport: tcp or rdma",
"username" : {
"description" : "RBD Id.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vgname" : {
"description" : "Volume group name.",
"format" : "pve-storage-vgname",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"volume" : {
"description" : "Glusterfs Volume.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
},
"type" : "object"
"description" : "User ID",
"format" : "pve-userid",
"maxLength" : 64,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "User ID",
"format" : "pve-userid",
"maxLength" : 64,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"append" : {
"optional" : 1,
"requires" : "groups",
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"email" : {
"format" : "email-opt",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"description" : "Enable/disable the account.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"expire" : {
"description" : "Account expiration date (seconds since epoch). '0' means no expiration date.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"firstname" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"groups" : {
"format" : "pve-groupid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"keys" : {
"description" : "Keys for two factor auth (yubico).",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"lastname" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"userid" : {
"description" : "User ID",
"format" : "pve-userid",
"maxLength" : 64,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"enabled" : {
"description" : "Optional filter for enable property.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"properties" : {
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"email" : {
"format" : "email-opt",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"enable" : {
"default" : 1,
"description" : "Enable the account (default). You can set this to '0' to disable the accout",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"expire" : {
"description" : "Account expiration date (seconds since epoch). '0' means no expiration date.",
"minimum" : 0,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (0 - N)"
+ "typetext" : "<integer> (0 - N)"
},
"firstname" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"groups" : {
"format" : "pve-groupid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"keys" : {
"description" : "Keys for two factor auth (yubico).",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"lastname" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"password" : {
"description" : "Initial password.",
"maxLength" : 64,
"minLength" : 5,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"userid" : {
"description" : "User ID",
"format" : "pve-userid",
"maxLength" : 64,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"groupid" : {
"format" : "pve-groupid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"groupid" : {
"format" : "pve-groupid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"groupid" : {
"format" : "pve-groupid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"groupid" : {
"format" : "pve-groupid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"roleid" : {
"format" : "pve-roleid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"roleid" : {
"format" : "pve-roleid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"append" : {
"optional" : 1,
"requires" : "privs",
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"privs" : {
"format" : "pve-priv-list",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"roleid" : {
"format" : "pve-roleid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"privs" : {
"format" : "pve-priv-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"roleid" : {
"format" : "pve-roleid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"delete" : {
"description" : "Remove permissions (instead of adding it).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"groups" : {
"description" : "List of groups.",
"format" : "pve-groupid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"path" : {
"description" : "Access control path",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"propagate" : {
"default" : 1,
"description" : "Allow to propagate (inherit) permissions.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"roles" : {
"description" : "List of roles.",
"format" : "pve-roleid-list",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"users" : {
"description" : "List of users.",
"format" : "pve-userid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "Authentication domain ID",
"format" : "pve-realm",
"maxLength" : 32,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "Authentication domain ID",
"format" : "pve-realm",
"maxLength" : 32,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "Description.",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"default" : {
"description" : "Use this as default realm",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"digest" : {
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
"maxLength" : 40,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"domain" : {
"description" : "AD domain name",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 65535)"
+ "typetext" : "<integer> (1 - 65535)"
},
"realm" : {
"description" : "Authentication domain ID",
"format" : "pve-realm",
"maxLength" : 32,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"secure" : {
"description" : "Use secure LDAPS protocol.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"server1" : {
"description" : "Server IP address (or DNS name)",
"format" : "address",
"maxLength" : 256,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"server2" : {
"description" : "Fallback Server IP address (or DNS name)",
"format" : "address",
"maxLength" : 256,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"tfa" : {
"description" : "Use Two-factor authentication.",
"format" : "pve-tfa-config",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"user_attr" : {
"description" : "LDAP user attribute name",
"description" : "Description.",
"maxLength" : 4096,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"default" : {
"description" : "Use this as default realm",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"domain" : {
"description" : "AD domain name",
"minimum" : 1,
"optional" : 1,
"type" : "integer",
- "typetext" : "integer (1 - 65535)"
+ "typetext" : "<integer> (1 - 65535)"
},
"realm" : {
"description" : "Authentication domain ID",
"format" : "pve-realm",
"maxLength" : 32,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"secure" : {
"description" : "Use secure LDAPS protocol.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"server1" : {
"description" : "Server IP address (or DNS name)",
"format" : "address",
"maxLength" : 256,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"server2" : {
"description" : "Fallback Server IP address (or DNS name)",
"format" : "address",
"maxLength" : 256,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"tfa" : {
"description" : "Use Two-factor authentication.",
"format" : "pve-tfa-config",
"maxLength" : 128,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"type" : {
"description" : "Realm type.",
"otp" : {
"description" : "One-time password for Two-factor authentication.",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"password" : {
"description" : "The secret password. This can also be a valid ticket.",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"path" : {
"description" : "Verify ticket, and check if user have access 'privs' on 'path'",
"maxLength" : 64,
"optional" : 1,
"requires" : "privs",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"privs" : {
"description" : "Verify ticket, and check if user have access 'privs' on 'path'",
"maxLength" : 64,
"optional" : 1,
"requires" : "path",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"realm" : {
"description" : "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.",
"format" : "pve-realm",
"maxLength" : 32,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"username" : {
"description" : "User name",
"maxLength" : 64,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"description" : "The new password.",
"maxLength" : 64,
"minLength" : 5,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"userid" : {
"description" : "User ID",
"format" : "pve-userid",
"maxLength" : 64,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"poolid" : {
"format" : "pve-poolid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"poolid" : {
"format" : "pve-poolid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"delete" : {
"description" : "Remove vms/storage (instead of adding it).",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "typetext" : "<boolean>"
},
"poolid" : {
"format" : "pve-poolid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"storage" : {
"description" : "List of storage IDs.",
"format" : "pve-storage-id-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"vms" : {
"description" : "List of virtual machines.",
"format" : "pve-vmid-list",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
"properties" : {
"comment" : {
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"poolid" : {
"format" : "pve-poolid",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
projects / pve-docs.git / blobdiff