"optional" : 1,
"type" : "integer"
},
+ "log" : {
+ "description" : "Log level for firewall rule",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"optional" : 1,
"type" : "string"
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
"type" : "integer"
},
+ "log" : {
+ "description" : "Log level for firewall rule",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"optional" : 1,
"type" : "string"
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
"type" : "integer"
},
+ "log_ratelimit" : {
+ "description" : "Log ratelimiting settings",
+ "format" : {
+ "burst" : {
+ "default" : 5,
+ "description" : "Inital burst of packages which will get logged",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "enable" : {
+ "default" : "1",
+ "default_key" : 1,
+ "description" : "Enable or disable log rate limiting",
+ "type" : "boolean"
+ },
+ "rate" : {
+ "default" : "1/second",
+ "description" : "Frequency with which the burst bucket gets refilled",
+ "format_description" : "rate",
+ "optional" : 1,
+ "pattern" : "[1-9][0-9]*\\/(second|minute|hour|day)",
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string"
+ },
"policy_in" : {
"description" : "Input policy.",
"enum" : [
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
+ "log_ratelimit" : {
+ "description" : "Log ratelimiting settings",
+ "format" : {
+ "burst" : {
+ "default" : 5,
+ "description" : "Inital burst of packages which will get logged",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "enable" : {
+ "default" : "1",
+ "default_key" : 1,
+ "description" : "Enable or disable log rate limiting",
+ "type" : "boolean"
+ },
+ "rate" : {
+ "default" : "1/second",
+ "description" : "Frequency with which the burst bucket gets refilled",
+ "format_description" : "rate",
+ "optional" : 1,
+ "pattern" : "[1-9][0-9]*\\/(second|minute|hour|day)",
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[enable=]<1|0> [,burst=<integer>] [,rate=<rate>]"
+ },
"policy_in" : {
"description" : "Input policy.",
"enum" : [
"additionalProperties" : 0,
"properties" : {
"node" : {
- "description" : "The cluster node name.",
+ "description" : "Target node.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
"additionalProperties" : 0,
"properties" : {
"node" : {
- "description" : "The cluster node name.",
+ "description" : "Target node.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
"description" : "Set bandwidth/io limits various operations.",
"format" : {
"clone" : {
- "description" : "bandwidth limit in MiB/s for cloning disks",
+ "description" : "bandwidth limit in KiB/s for cloning disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"default" : {
- "description" : "default bandwidth limit in MiB/s",
+ "description" : "default bandwidth limit in KiB/s",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"migration" : {
- "description" : "bandwidth limit in MiB/s for migrating guests",
+ "description" : "bandwidth limit in KiB/s for migrating guests (including moving local disks)",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"move" : {
- "description" : "bandwidth limit in MiB/s for moving disks",
+ "description" : "bandwidth limit in KiB/s for moving disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"restore" : {
- "description" : "bandwidth limit in MiB/s for restoring guests from backups",
+ "description" : "bandwidth limit in KiB/s for restoring guests from backups",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
},
"mac_prefix" : {
"description" : "Prefix for autogenerated MAC addresses.",
+ "format" : "mac-prefix",
"optional" : 1,
- "pattern" : "(?^i:[a-f0-9]{2}(?::[a-f0-9]{2}){0,2}:?)",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"max_workers" : {
"description" : "Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
+ },
+ "u2f" : {
+ "description" : "u2f",
+ "format" : {
+ "appid" : {
+ "description" : "U2F AppId URL override. Defaults to the origin.",
+ "format_description" : "APPID",
+ "optional" : 1,
+ "type" : "string"
+ },
+ "origin" : {
+ "description" : "U2F Origin override. Mostly useful for single nodes with a single URL.",
+ "format_description" : "URL",
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[appid=<APPID>] [,origin=<URL>]"
}
}
},
"optional" : 1,
"type" : "integer"
},
+ "log" : {
+ "description" : "Log level for firewall rule",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"optional" : 1,
"type" : "string"
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"type" : "string",
"typetext" : "<volume>"
},
+ "cicustom" : {
+ "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
+ "format" : "pve-qm-cicustom",
+ "optional" : 1,
+ "type" : "string"
+ },
"cipassword" : {
"description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
"optional" : 1,
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"optional" : 1,
"type" : "string"
},
+ "ivshmem" : {
+ "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
+ "format" : {
+ "name" : {
+ "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
+ "format_description" : "string",
+ "optional" : 1,
+ "pattern" : "[a-zA-Z0-9\\-]+",
+ "type" : "string"
+ },
+ "size" : {
+ "description" : "The size of the file in MB.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "optional" : 1,
+ "type" : "string"
+ },
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
"migrate",
"rollback",
"snapshot",
- "snapshot-delete"
+ "snapshot-delete",
+ "suspending",
+ "suspended"
],
"optional" : 1,
"type" : "string"
},
"macaddr" : {
"description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
+ "format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
- "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"model" : {
"default_key" : 1,
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "<volume>"
},
+ "cicustom" : {
+ "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
+ "format" : "pve-qm-cicustom",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[meta=<volume>] [,network=<volume>] [,user=<volume>]"
+ },
"cipassword" : {
"description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
"optional" : 1,
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"ipconfig[n]" : {
"description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.\n",
"type" : "string",
"typetext" : "[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]"
},
+ "ivshmem" : {
+ "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
+ "format" : {
+ "name" : {
+ "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
+ "format_description" : "string",
+ "optional" : 1,
+ "pattern" : "[a-zA-Z0-9\\-]+",
+ "type" : "string"
+ },
+ "size" : {
+ "description" : "The size of the file in MB.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "size=<integer> [,name=<string>]"
+ },
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
"migrate",
"rollback",
"snapshot",
- "snapshot-delete"
+ "snapshot-delete",
+ "suspending",
+ "suspended"
],
"optional" : 1,
"type" : "string"
},
"macaddr" : {
"description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
+ "format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
- "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"model" : {
"default_key" : 1,
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsihw" : {
"default" : "lsi",
"type" : "string",
"typetext" : "<volume>"
},
+ "cicustom" : {
+ "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
+ "format" : "pve-qm-cicustom",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[meta=<volume>] [,network=<volume>] [,user=<volume>]"
+ },
"cipassword" : {
"description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
"optional" : 1,
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"ipconfig[n]" : {
"description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.\n",
"type" : "string",
"typetext" : "[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]"
},
+ "ivshmem" : {
+ "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
+ "format" : {
+ "name" : {
+ "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
+ "format_description" : "string",
+ "optional" : 1,
+ "pattern" : "[a-zA-Z0-9\\-]+",
+ "type" : "string"
+ },
+ "size" : {
+ "description" : "The size of the file in MB.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "size=<integer> [,name=<string>]"
+ },
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
"migrate",
"rollback",
"snapshot",
- "snapshot-delete"
+ "snapshot-delete",
+ "suspending",
+ "suspended"
],
"optional" : 1,
"type" : "string"
},
"macaddr" : {
"description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
+ "format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
- "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"model" : {
"default_key" : 1,
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsihw" : {
"default" : "lsi",
"description" : "HA manager service status.",
"type" : "object"
},
+ "lock" : {
+ "description" : "The current config lock, if any.",
+ "optional" : 1,
+ "type" : "string"
+ },
"maxdisk" : {
"description" : "Root disk size in bytes.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "statestorage" : {
+ "description" : "The storage for the VM state",
+ "format" : "pve-storage-id",
+ "optional" : 1,
+ "requires" : "todisk",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "todisk" : {
+ "default" : 0,
+ "description" : "If set, suspends the VM to disk. Will be resumed on next VM start.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "bwlimit" : {
+ "default" : "clone limit from datacenter or storage config",
+ "description" : "Override I/O bandwidth limit (in KiB/s).",
+ "minimum" : "0",
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
"description" : {
"description" : "Description for the new VM.",
"optional" : 1,
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "bwlimit" : {
+ "default" : "move limit from datacenter or storage config",
+ "description" : "Override I/O bandwidth limit (in KiB/s).",
+ "minimum" : "0",
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
"delete" : {
"default" : 0,
"description" : "Delete the original disk after successful copy. By default the original disk is kept as unused disk.",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "bwlimit" : {
+ "default" : "migrate limit from datacenter or storage config",
+ "description" : "Override I/O bandwidth limit (in KiB/s).",
+ "minimum" : "0",
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
"force" : {
"description" : "Allow to migrate VMs which use local devices. Only root may use this option.",
"optional" : 1,
"optional" : 1,
"type" : "number"
},
+ "lock" : {
+ "description" : "The current config lock, if any.",
+ "optional" : 1,
+ "type" : "string"
+ },
"maxdisk" : {
"description" : "Root disk size in bytes.",
"optional" : 1,
"type" : "string"
},
"bwlimit" : {
- "description" : "Override i/o bandwidth limit (in KiB/s).",
+ "default" : "restore limit from datacenter or storage config",
+ "description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "integer",
"type" : "string",
"typetext" : "<volume>"
},
+ "cicustom" : {
+ "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
+ "format" : "pve-qm-cicustom",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[meta=<volume>] [,network=<volume>] [,user=<volume>]"
+ },
"cipassword" : {
"description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
"optional" : 1,
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"ipconfig[n]" : {
"description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.\n",
"type" : "string",
"typetext" : "[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]"
},
+ "ivshmem" : {
+ "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
+ "format" : {
+ "name" : {
+ "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
+ "format_description" : "string",
+ "optional" : 1,
+ "pattern" : "[a-zA-Z0-9\\-]+",
+ "type" : "string"
+ },
+ "size" : {
+ "description" : "The size of the file in MB.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "size=<integer> [,name=<string>]"
+ },
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
"migrate",
"rollback",
"snapshot",
- "snapshot-delete"
+ "snapshot-delete",
+ "suspending",
+ "suspended"
],
"optional" : 1,
"type" : "string"
},
"macaddr" : {
"description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
+ "format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
- "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"model" : {
"default_key" : 1,
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
],
"optional" : 1,
"type" : "string"
+ },
+ "wwn" : {
+ "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
+ "format_description" : "wwn",
+ "optional" : 1,
+ "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsihw" : {
"default" : "lsi",
"description" : "Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.",
"format_description" : "fstype;fstype;...",
"optional" : 1,
- "pattern" : "(?^:[a-zA-Z0-9; ]+)",
+ "pattern" : "(?^:[a-zA-Z0-9_; ]+)",
"type" : "string"
},
"nesting" : {
},
"hwaddr" : {
"description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)",
+ "format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
- "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"ip" : {
"description" : "IPv4 address in CIDR format.",
"description" : "Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.",
"format_description" : "fstype;fstype;...",
"optional" : 1,
- "pattern" : "(?^:[a-zA-Z0-9; ]+)",
+ "pattern" : "(?^:[a-zA-Z0-9_; ]+)",
"type" : "string"
},
"nesting" : {
},
"hwaddr" : {
"description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)",
+ "format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
- "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"ip" : {
"description" : "IPv4 address in CIDR format.",
"description" : "HA manager service status.",
"type" : "object"
},
+ "lock" : {
+ "description" : "The current config lock, if any.",
+ "optional" : 1,
+ "type" : "string"
+ },
"maxdisk" : {
"description" : "Root disk size in bytes.",
"optional" : 1,
"optional" : 1,
"type" : "integer"
},
+ "log" : {
+ "description" : "Log level for firewall rule",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"optional" : 1,
"type" : "string"
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "bwlimit" : {
+ "default" : "migrate limit from datacenter or storage config",
+ "description" : "Override I/O bandwidth limit (in KiB/s).",
+ "minimum" : "0",
+ "optional" : 1,
+ "type" : "number",
+ "typetext" : "<number> (0 - N)"
+ },
"force" : {
"description" : "Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.",
"optional" : 1,
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "bwlimit" : {
+ "default" : "clone limit from datacenter or storage config",
+ "description" : "Override I/O bandwidth limit (in KiB/s).",
+ "minimum" : "0",
+ "optional" : 1,
+ "type" : "number",
+ "typetext" : "<number> (0 - N)"
+ },
"description" : {
"description" : "Description for the new CT.",
"optional" : 1,
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "bwlimit" : {
+ "default" : "clone limit from datacenter or storage config",
+ "description" : "Override I/O bandwidth limit (in KiB/s).",
+ "minimum" : "0",
+ "optional" : 1,
+ "type" : "number",
+ "typetext" : "<number> (0 - N)"
+ },
"delete" : {
"default" : 0,
"description" : "Delete the original volume after successful copy. By default the original is kept as an unused volume entry.",
"optional" : 1,
"type" : "number"
},
+ "lock" : {
+ "description" : "The current config lock, if any.",
+ "optional" : 1,
+ "type" : "string"
+ },
"maxdisk" : {
"description" : "Root disk size in bytes.",
"optional" : 1,
"type" : "string"
},
"bwlimit" : {
- "description" : "Override i/o bandwidth limit (in KiB/s).",
+ "default" : "restore limit from datacenter or storage config",
+ "description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "number",
"description" : "Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.",
"format_description" : "fstype;fstype;...",
"optional" : 1,
- "pattern" : "(?^:[a-zA-Z0-9; ]+)",
+ "pattern" : "(?^:[a-zA-Z0-9_; ]+)",
"type" : "string"
},
"nesting" : {
},
"hwaddr" : {
"description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)",
+ "format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
- "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"ip" : {
"description" : "IPv4 address in CIDR format.",
"type" : "integer",
"typetext" : "<integer> (0 - 6)"
},
+ "unique" : {
+ "description" : "Assign a unique random ethernet address.",
+ "optional" : 1,
+ "requires" : "restore",
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"unprivileged" : {
"default" : 0,
"description" : "Makes the container run as unprivileged user. (Should not be modified manually.)",
]
},
"protected" : 1,
+ "proxyto" : "node",
"returns" : {
"items" : {
"properties" : {
1
]
},
+ "proxyto" : "node",
"returns" : {
"type" : "string"
}
"default" : "ceph.target",
"description" : "Ceph service name.",
"optional" : 1,
- "pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
+ "pattern" : "(ceph|mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
"type" : "string"
}
}
"default" : "ceph.target",
"description" : "Ceph service name.",
"optional" : 1,
- "pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
+ "pattern" : "(ceph|mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
"type" : "string"
}
}
"optional" : 1,
"type" : "integer"
},
+ "log" : {
+ "description" : "Log level for firewall rule",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"optional" : 1,
"type" : "string"
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"type" : "string",
"typetext" : "<string>"
},
+ "log" : {
+ "description" : "Log level for firewall rule.",
+ "enum" : [
+ "emerg",
+ "alert",
+ "crit",
+ "err",
+ "warning",
+ "notice",
+ "info",
+ "debug",
+ "nolog"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
"optional" : 1,
"type" : "string"
},
+ "log_nf_conntrack" : {
+ "default" : 0,
+ "description" : "Enable logging of conntrack information.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
"ndp" : {
"description" : "Enable NDP.",
"optional" : 1,
"optional" : 1,
"type" : "string"
},
+ "log_nf_conntrack" : {
+ "default" : 0,
+ "description" : "Enable logging of conntrack information.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"ndp" : {
"description" : "Enable NDP.",
"optional" : 1,
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "cmd" : {
+ "default" : "login",
+ "description" : "Run specific command or default to login.",
+ "enum" : [
+ "upgrade",
+ "ceph_install",
+ "login"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"height" : {
"description" : "sets the height of the console in pixels.",
"maximum" : 2160,
},
"upgrade" : {
"default" : 0,
- "description" : "Run 'apt-get dist-upgrade' instead of normal shell.",
+ "description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "cmd" : {
+ "default" : "login",
+ "description" : "Run specific command or default to login.",
+ "enum" : [
+ "upgrade",
+ "ceph_install",
+ "login"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
},
"upgrade" : {
"default" : 0,
- "description" : "Run 'apt-get dist-upgrade' instead of normal shell.",
+ "description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "cmd" : {
+ "default" : "login",
+ "description" : "Run specific command or default to login.",
+ "enum" : [
+ "upgrade",
+ "ceph_install",
+ "login"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
},
"upgrade" : {
"default" : 0,
- "description" : "Run 'apt-get dist-upgrade' instead of normal shell.",
+ "description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"description" : "Set bandwidth/io limits various operations.",
"format" : {
"clone" : {
- "description" : "bandwidth limit in MiB/s for cloning disks",
+ "description" : "bandwidth limit in KiB/s for cloning disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"default" : {
- "description" : "default bandwidth limit in MiB/s",
+ "description" : "default bandwidth limit in KiB/s",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"migration" : {
- "description" : "bandwidth limit in MiB/s for migrating guests",
+ "description" : "bandwidth limit in KiB/s for migrating guests (including moving local disks)",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"move" : {
- "description" : "bandwidth limit in MiB/s for moving disks",
+ "description" : "bandwidth limit in KiB/s for moving disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"restore" : {
- "description" : "bandwidth limit in MiB/s for restoring guests from backups",
+ "description" : "bandwidth limit in KiB/s for restoring guests from backups",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"description" : "Set bandwidth/io limits various operations.",
"format" : {
"clone" : {
- "description" : "bandwidth limit in MiB/s for cloning disks",
+ "description" : "bandwidth limit in KiB/s for cloning disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"default" : {
- "description" : "default bandwidth limit in MiB/s",
+ "description" : "default bandwidth limit in KiB/s",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"migration" : {
- "description" : "bandwidth limit in MiB/s for migrating guests",
+ "description" : "bandwidth limit in KiB/s for migrating guests (including moving local disks)",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"move" : {
- "description" : "bandwidth limit in MiB/s for moving disks",
+ "description" : "bandwidth limit in KiB/s for moving disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"restore" : {
- "description" : "bandwidth limit in MiB/s for restoring guests from backups",
+ "description" : "bandwidth limit in KiB/s for restoring guests from backups",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"maxLength" : 128,
"optional" : 1,
"type" : "string",
- "typetext" : "<string>"
+ "typetext" : "type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]"
},
"user_attr" : {
"description" : "LDAP user attribute name",
"maxLength" : 128,
"optional" : 1,
"type" : "string",
- "typetext" : "<string>"
+ "typetext" : "type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]"
},
"type" : {
"description" : "Realm type.",
"leaf" : 1,
"path" : "/access/password",
"text" : "password"
+ },
+ {
+ "info" : {
+ "POST" : {
+ "description" : "Finish a u2f challenge.",
+ "method" : "POST",
+ "name" : "verify_tfa",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "response" : {
+ "description" : "The response to the current authentication challenge.",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "user" : "all"
+ },
+ "protected" : 1,
+ "returns" : {
+ "properties" : {
+ "ticket" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "PUT" : {
+ "description" : "Change user u2f authentication.",
+ "method" : "PUT",
+ "name" : "change_tfa",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "action" : {
+ "description" : "The action to perform",
+ "enum" : [
+ "delete",
+ "new",
+ "confirm"
+ ],
+ "type" : "string"
+ },
+ "config" : {
+ "description" : "A TFA configuration. This must currently be of type TOTP of not set at all.",
+ "format" : "pve-tfa-config",
+ "maxLength" : 128,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]"
+ },
+ "key" : {
+ "description" : "When adding TOTP, the shared secret value.",
+ "optional" : 1,
+ "pattern" : "(?^:[A-Z2-7=]{16}|[A-Fa-f0-9]{40})",
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "The current password.",
+ "maxLength" : 64,
+ "minLength" : 5,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "response" : {
+ "description" : "Either the the response to the current u2f registration challenge, or, when adding TOTP, the currently valid TOTP value.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "userid" : {
+ "description" : "User ID",
+ "format" : "pve-userid",
+ "maxLength" : 64,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "or",
+ [
+ "userid-param",
+ "self"
+ ],
+ [
+ "and",
+ [
+ "userid-param",
+ "Realm.AllocateUser"
+ ],
+ [
+ "userid-group",
+ [
+ "User.Modify"
+ ]
+ ]
+ ]
+ ],
+ "description" : "A user can change their own u2f or totp token."
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/access/tfa",
+ "text" : "tfa"
}
],
"info" : {
VMID for the clone.
+`--bwlimit` `<integer> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
`--description` `<string>` ::
Description for the new VM.
Enable booting from specified disk.
-`--bwlimit` `<integer> (0 - N)` ::
+`--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
-Override i/o bandwidth limit (in KiB/s).
+Override I/O bandwidth limit (in KiB/s).
`--cdrom` `<volume>` ::
This is an alias for option -ide2
+`--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
+
+cloud-init: Specify custom files to replace the automatically generated ones at start.
+
`--cipassword` `<password>` ::
cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
Enable/disable hugepages memory.
-`--ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
+
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
+`--ivshmem` `size=<integer> [,name=<string>]` ::
+
+Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
+
`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
-`--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete>` ::
+`--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
Lock/unlock the VM.
Allow reboot. If set to '0' the VM exit on reboot.
-`--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
-`--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
Target node.
+`--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
`--force` `<boolean>` ::
Allow to migrate VMs which use local devices. Only root may use this option.
Target storage.
+`--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
`--delete` `<boolean>` ('default =' `0`)::
Delete the original disk after successful copy. By default the original disk is kept as unused disk.
This is an alias for option -ide2
+`--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
+
+cloud-init: Specify custom files to replace the automatically generated ones at start.
+
`--cipassword` `<password>` ::
cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
Enable/disable hugepages memory.
-`--ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
+
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
+`--ivshmem` `size=<integer> [,name=<string>]` ::
+
+Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
+
`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
-`--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete>` ::
+`--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
Lock/unlock the VM.
Revert a pending change.
-`--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
-`--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
Ignore locks - only root is allowed to use this option.
+`--statestorage` `<string>` ::
+
+The storage for the VM state
++
+NOTE: Requires option(s): `todisk`
+
+`--todisk` `<boolean>` ('default =' `0`)::
+
+If set, suspends the VM to disk. Will be resumed on next VM start.
+
*qm template* `<vmid>` `[OPTIONS]`
Create a Template.
projects / pve-docs.git / commitdiff