diff --git a/docs/data-sources/virtual_environment_group.md b/docs/data-sources/virtual_environment_group.md index 56eb0358..53eb783e 100644 --- a/docs/data-sources/virtual_environment_group.md +++ b/docs/data-sources/virtual_environment_group.md @@ -24,8 +24,8 @@ data "proxmox_virtual_environment_group" "operations_team" { ## Attribute Reference - `acl` - The access control list. - - `path` - The path. - - `propagate` - Whether to propagate to child paths. - - `role_id` - The role identifier. + - `path` - The path. + - `propagate` - Whether to propagate to child paths. + - `role_id` - The role identifier. - `comment` - The group comment. - `members` - The group members as a list with `username@realm` entries. diff --git a/docs/data-sources/virtual_environment_pool.md b/docs/data-sources/virtual_environment_pool.md index 95e0b1bd..81a96503 100644 --- a/docs/data-sources/virtual_environment_pool.md +++ b/docs/data-sources/virtual_environment_pool.md @@ -25,8 +25,8 @@ data "proxmox_virtual_environment_pool" "operations_pool" { - `comment` - The pool comment. - `members` - The pool members. - - `datastore_id` - The datastore identifier. - - `id` - The member identifier. - - `node_name` - The node name. - - `type` - The member type. - - `vm_id` - The virtual machine identifier. + - `datastore_id` - The datastore identifier. + - `id` - The member identifier. + - `node_name` - The node name. + - `type` - The member type. + - `vm_id` - The virtual machine identifier. diff --git a/docs/data-sources/virtual_environment_user.md b/docs/data-sources/virtual_environment_user.md index 7d002df2..d25c46d1 100644 --- a/docs/data-sources/virtual_environment_user.md +++ b/docs/data-sources/virtual_environment_user.md @@ -24,9 +24,9 @@ data "proxmox_virtual_environment_user" "operations_user" { ## Attribute Reference - `acl` - The access control list. - - `path` - The path. - - `propagate` - Whether to propagate to child paths. - - `role_id` - The role identifier. + - `path` - The path. + - `propagate` - Whether to propagate to child paths. + - `role_id` - The role identifier. - `comment` - The user comment. - `email` - The user's email address. - `enabled` - Whether the user account is enabled. diff --git a/docs/data-sources/virtual_environment_vms.md b/docs/data-sources/virtual_environment_vms.md index 34fa7b25..07099ba3 100644 --- a/docs/data-sources/virtual_environment_vms.md +++ b/docs/data-sources/virtual_environment_vms.md @@ -26,7 +26,7 @@ data "proxmox_virtual_environment_vms" "ubuntu_vms" { ## Attribute Reference - `vms` - The VMs list. - - `name` - The virtual machine name. - - `node_name` - The node name. - - `tags` - A list of tags of the VM. - - `vm_id` - The VM identifier. + - `name` - The virtual machine name. + - `node_name` - The node name. + - `tags` - A list of tags of the VM. + - `vm_id` - The VM identifier. diff --git a/docs/resources/virtual_environment_cluster_firewall.md b/docs/resources/virtual_environment_cluster_firewall.md index 6bbfb887..e3b9f6d7 100644 --- a/docs/resources/virtual_environment_cluster_firewall.md +++ b/docs/resources/virtual_environment_cluster_firewall.md @@ -33,10 +33,11 @@ resource "proxmox_virtual_environment_cluster_firewall" "example" { - `input_policy` - (Optional) The default input policy (`ACCEPT`, `DROP`, `REJECT`). - `output_policy` - (Optional) The default output policy (`ACCEPT`, `DROP`, `REJECT`). - `log_ratelimit` - (Optional) The log rate limit. - - `enabled` - (Optional) Enable or disable the log rate limit. - - `burst` - (Optional) Initial burst of packages which will always get - logged before the rate is applied (defaults to `5`). - - `rate` - (Optional) Frequency with which the burst bucket gets refilled (defaults to `1/second`). + - `enabled` - (Optional) Enable or disable the log rate limit. + - `burst` - (Optional) Initial burst of packages which will always get + logged before the rate is applied (defaults to `5`). + - `rate` - (Optional) Frequency with which the burst bucket gets refilled + (defaults to `1/second`). ## Attribute Reference diff --git a/docs/resources/virtual_environment_cluster_firewall_security_group.md b/docs/resources/virtual_environment_cluster_firewall_security_group.md index d960df45..1547e913 100644 --- a/docs/resources/virtual_environment_cluster_firewall_security_group.md +++ b/docs/resources/virtual_environment_cluster_firewall_security_group.md @@ -45,43 +45,46 @@ resource "proxmox_virtual_environment_cluster_firewall_security_group" "webserve - `name` - (Required) Security group name. - `comment` - (Optional) Security group comment. - `rule` - (Optional) Firewall rule block (multiple blocks supported). - - `action` - (Required) Rule action (`ACCEPT`, `DROP`, `REJECT`). - - `type` - (Required) Rule type (`in`, `out`). - - `comment` - (Optional) Rule comment. - - `dest` - (Optional) 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. - - `dport` - (Optional) 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. - - `enable` - (Optional) Enable this rule. Defaults to `true`. - - `iface` - (Optional) Network interface name. You have to use network - configuration key names for VMs and containers ('net\d+'). Host related - rules can use arbitrary strings. - - `log` - (Optional) Log level for this rule (`emerg`, `alert`, `crit`, - `err`, `warning`, `notice`, `info`, `debug`, `nolog`). - - `macro`- (Optional) Macro name. Use predefined standard macro - from - - `proto` - (Optional) Restrict packet protocol. You can use protocol names - as defined in '/etc/protocols'. - - `source` - (Optional) 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. - - `sport` - (Optional) 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. + - `action` - (Required) Rule action (`ACCEPT`, `DROP`, `REJECT`). + - `type` - (Required) Rule type (`in`, `out`). + - `comment` - (Optional) Rule comment. + - `dest` - (Optional) 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. + - `dport` - (Optional) 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. + - `enable` - (Optional) Enable this rule. Defaults to `true`. + - `iface` - (Optional) Network interface name. You have to use network + configuration key names for VMs and containers ('net\d+'). Host related + rules can use arbitrary strings. + - `log` - (Optional) Log level for this rule (`emerg`, `alert`, `crit`, + `err`, `warning`, `notice`, `info`, `debug`, `nolog`). + - `macro`- (Optional) Macro name. Use predefined standard macro + from + - `proto` - (Optional) Restrict packet protocol. You can use protocol names + as defined in '/etc/protocols'. + - `source` - (Optional) 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. + - `sport` - (Optional) 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. ## Attribute Reference - `rule` - - `pos` - Position of the rule in the list. + - `pos` - Position of the rule in the list. There are no attribute references available for this resource. diff --git a/docs/resources/virtual_environment_container.md b/docs/resources/virtual_environment_container.md index 91f6de53..fa2c13e4 100644 --- a/docs/resources/virtual_environment_container.md +++ b/docs/resources/virtual_environment_container.md @@ -100,111 +100,114 @@ output "ubuntu_container_public_key" { ## Argument Reference - `clone` - (Optional) The cloning configuration. - - `datastore_id` - (Optional) The identifier for the target datastore. - - `node_name` - (Optional) The name of the source node (leave blank, if - equal to the `node_name` argument). - - `vm_id` - (Required) The identifier for the source container. + - `datastore_id` - (Optional) The identifier for the target datastore. + - `node_name` - (Optional) The name of the source node (leave blank, if + equal to the `node_name` argument). + - `vm_id` - (Required) The identifier for the source container. - `console` - (Optional) The console configuration. - - `enabled` - (Optional) Whether to enable the console device (defaults - to `true`). - - `mode` - (Optional) The console mode (defaults to `tty`). - - `console` - Console. - - `shell` - Shell. - - `tty` - TTY. - - `tty_count` - (Optional) The number of available TTY (defaults to `2`). + - `enabled` - (Optional) Whether to enable the console device (defaults + to `true`). + - `mode` - (Optional) The console mode (defaults to `tty`). + - `console` - Console. + - `shell` - Shell. + - `tty` - TTY. + - `tty_count` - (Optional) The number of available TTY (defaults to `2`). - `cpu` - (Optional) The CPU configuration. - - `architecture` - (Optional) The CPU architecture (defaults to `amd64`). - - `amd64` - x86 (64 bit). - - `arm64` - ARM (64-bit). - - `armhf` - ARM (32 bit). - - `i386` - x86 (32 bit). - - `cores` - (Optional) The number of CPU cores (defaults to `1`). - - `units` - (Optional) The CPU units (defaults to `1024`). + - `architecture` - (Optional) The CPU architecture (defaults to `amd64`). + - `amd64` - x86 (64 bit). + - `arm64` - ARM (64-bit). + - `armhf` - ARM (32 bit). + - `i386` - x86 (32 bit). + - `cores` - (Optional) The number of CPU cores (defaults to `1`). + - `units` - (Optional) The CPU units (defaults to `1024`). - `description` - (Optional) The description. - `disk` - (Optional) The disk configuration. - - `datastore_id` - (Optional) The identifier for the datastore to create the - disk in (defaults to `local`). - - `size` - (Optional) The size of the root filesystem in gigabytes (defaults - to `4`). Requires `datastore_id` to be set. + - `datastore_id` - (Optional) The identifier for the datastore to create the + disk in (defaults to `local`). + - `size` - (Optional) The size of the root filesystem in gigabytes (defaults + to `4`). Requires `datastore_id` to be set. - `initialization` - (Optional) The initialization configuration. - - `dns` - (Optional) The DNS configuration. - - `domain` - (Optional) The DNS search domain. - - `server` - (Optional) The DNS server. The `server` attribute is deprecated and will be removed in a future release. Please use the `servers` attribute instead. - - `servers` - (Optional) The list of DNS servers. - - `hostname` - (Optional) The hostname. - - `ip_config` - (Optional) The IP configuration (one block per network - device). - - `ipv4` - (Optional) The IPv4 configuration. - - `address` - (Optional) The IPv4 address (use `dhcp` for - autodiscovery). - - `gateway` - (Optional) The IPv4 gateway (must be omitted - when `dhcp` is used as the address). - - `ipv6` - (Optional) The IPv4 configuration. - - `address` - (Optional) The IPv6 address (use `dhcp` for - autodiscovery). - - `gateway` - (Optional) The IPv6 gateway (must be omitted - when `dhcp` is used as the address). - - `user_account` - (Optional) The user account configuration. - - `keys` - (Optional) The SSH keys for the root account. - - `password` - (Optional) The password for the root account. + - `dns` - (Optional) The DNS configuration. + - `domain` - (Optional) The DNS search domain. + - `server` - (Optional) The DNS server. The `server` attribute is + deprecated and will be removed in a future release. Please use + the `servers` attribute instead. + - `servers` - (Optional) The list of DNS servers. + - `hostname` - (Optional) The hostname. + - `ip_config` - (Optional) The IP configuration (one block per network + device). + - `ipv4` - (Optional) The IPv4 configuration. + - `address` - (Optional) The IPv4 address (use `dhcp` for + autodiscovery). + - `gateway` - (Optional) The IPv4 gateway (must be omitted + when `dhcp` is used as the address). + - `ipv6` - (Optional) The IPv4 configuration. + - `address` - (Optional) The IPv6 address (use `dhcp` for + autodiscovery). + - `gateway` - (Optional) The IPv6 gateway (must be omitted + when `dhcp` is used as the address). + - `user_account` - (Optional) The user account configuration. + - `keys` - (Optional) The SSH keys for the root account. + - `password` - (Optional) The password for the root account. - `memory` - (Optional) The memory configuration. - - `dedicated` - (Optional) The dedicated memory in megabytes (defaults - to `512`). - - `swap` - (Optional) The swap size in megabytes (defaults to `0`). + - `dedicated` - (Optional) The dedicated memory in megabytes (defaults + to `512`). + - `swap` - (Optional) The swap size in megabytes (defaults to `0`). - `mount_point` - - `acl` (Optional) Explicitly enable or disable ACL support. - - `backup` (Optional) Whether to include the mount point in backups (only - used for volume mount points). - - `mount_options` (Optional) List of extra mount options. - - `path` (Required) Path to the mount point as seen from inside the - container. - - `quota` (Optional) Enable user quotas inside the container (not supported - with ZFS subvolumes). - - `read_only` (Optional) Read-only mount point. - - `replicate` (Optional) Will include this volume to a storage replica job. - - `shared` (Optional) Mark this non-volume mount point as available on all - nodes. - - `size` (Optional) Volume size (only for volume mount points). - Can be specified with a unit suffix (e.g. `10G`). - - `volume` (Required) Volume, device or directory to mount into the - container. + - `acl` (Optional) Explicitly enable or disable ACL support. + - `backup` (Optional) Whether to include the mount point in backups (only + used for volume mount points). + - `mount_options` (Optional) List of extra mount options. + - `path` (Required) Path to the mount point as seen from inside the + container. + - `quota` (Optional) Enable user quotas inside the container (not supported + with ZFS subvolumes). + - `read_only` (Optional) Read-only mount point. + - `replicate` (Optional) Will include this volume to a storage replica job. + - `shared` (Optional) Mark this non-volume mount point as available on all + nodes. + - `size` (Optional) Volume size (only for volume mount points). + Can be specified with a unit suffix (e.g. `10G`). + - `volume` (Required) Volume, device or directory to mount into the + container. - `network_interface` - (Optional) A network interface (multiple blocks - supported). - - `bridge` - (Optional) The name of the network bridge (defaults - to `vmbr0`). - - `enabled` - (Optional) Whether to enable the network device (defaults - to `true`). - - `firewall` - (Optional) Whether this interface's firewall rules should be - used (defaults to `false`). - - `mac_address` - (Optional) The MAC address. - - `mtu` - (Optional) Maximum transfer unit of the interface. Cannot be - larger than the bridge's MTU. - - `name` - (Required) The network interface name. - - `rate_limit` - (Optional) The rate limit in megabytes per second. - - `vlan_id` - (Optional) The VLAN identifier. + supported). + - `bridge` - (Optional) The name of the network bridge (defaults + to `vmbr0`). + - `enabled` - (Optional) Whether to enable the network device (defaults + to `true`). + - `firewall` - (Optional) Whether this interface's firewall rules should be + used (defaults to `false`). + - `mac_address` - (Optional) The MAC address. + - `mtu` - (Optional) Maximum transfer unit of the interface. Cannot be + larger than the bridge's MTU. + - `name` - (Required) The network interface name. + - `rate_limit` - (Optional) The rate limit in megabytes per second. + - `vlan_id` - (Optional) The VLAN identifier. - `node_name` - (Required) The name of the node to assign the container to. - `operating_system` - (Required) The Operating System configuration. - - `template_file_id` - (Required) The identifier for an OS template file. - - `type` - (Optional) The type (defaults to `unmanaged`). - - `alpine` - Alpine. - - `archlinux` - Arch Linux. - - `centos` - CentOS. - - `debian` - Debian. - - `fedora` - Fedora. - - `gentoo` - Gentoo. - - `opensuse` - openSUSE. - - `ubuntu` - Ubuntu. - - `unmanaged` - Unmanaged. + - `template_file_id` - (Required) The identifier for an OS template file. + - `type` - (Optional) The type (defaults to `unmanaged`). + - `alpine` - Alpine. + - `archlinux` - Arch Linux. + - `centos` - CentOS. + - `debian` - Debian. + - `fedora` - Fedora. + - `gentoo` - Gentoo. + - `opensuse` - openSUSE. + - `ubuntu` - Ubuntu. + - `unmanaged` - Unmanaged. - `pool_id` - (Optional) The identifier for a pool to assign the container to. - `started` - (Optional) Whether to start the container (defaults to `true`). - `startup` - (Optional) Defines startup and shutdown behavior of the container. - - `order` - (Required) A non-negative number defining the general startup - order. - - `up` - (Optional) A non-negative number defining the delay in seconds - before the next container is started. - - `down` - (Optional) A non-negative number defining the delay in seconds - before the next container is shut down. -- `start_on_boot` - (Optional) Automatically start container when the host system boots (defaults to `true`). + - `order` - (Required) A non-negative number defining the general startup + order. + - `up` - (Optional) A non-negative number defining the delay in seconds + before the next container is started. + - `down` - (Optional) A non-negative number defining the delay in + seconds before the next container is shut down. +- `start_on_boot` - (Optional) Automatically start container when the host + system boots (defaults to `true`). - `tags` - (Optional) A list of tags the container tags. This is only meta information (defaults to `[]`). Note: Proxmox always sorts the container tags. If the list in template is not sorted, then Proxmox will always report a @@ -215,13 +218,13 @@ output "ubuntu_container_public_key" { the host (defaults to `false`). - `vm_id` - (Optional) The container identifier - `features` - (Optional) The container feature flags. Changing flags (except nesting) is only allowed for `root@pam` authenticated user. - - `nesting` - (Optional) Whether the container is nested (defaults - to `false`) - - `fuse` - (Optional) Whether the container supports FUSE mounts (defaults - to `false`) - - `keyctl` - (Optional) Whether the container supports `keyctl()` system + - `nesting` - (Optional) Whether the container is nested (defaults + to `false`) + - `fuse` - (Optional) Whether the container supports FUSE mounts (defaults + to `false`) + - `keyctl` - (Optional) Whether the container supports `keyctl()` system call (defaults to `false`) - - `mount` - (Optional) List of allowed mount types (`cifs` or `nfs`) + - `mount` - (Optional) List of allowed mount types (`cifs` or `nfs`) ## Attribute Reference diff --git a/docs/resources/virtual_environment_file.md b/docs/resources/virtual_environment_file.md index 02223703..5d8291cc 100644 --- a/docs/resources/virtual_environment_file.md +++ b/docs/resources/virtual_environment_file.md @@ -98,33 +98,34 @@ resource "proxmox_virtual_environment_file" "ubuntu_container_template" { ## Argument Reference -- `content_type` - (Optional) The content type. If not specified, the content type will be inferred from the file - extension. Valid values are: - - `dump` (allowed extensions: `.vzdump`) - - `iso` (allowed extensions: `.iso`, `.img`) - - `snippets` (allowed extensions: any) - - `vztmpl` (allowed extensions: `.tar.gz`, `.tar.xz`, `tar.zst`) +- `content_type` - (Optional) The content type. If not specified, the content + type will be inferred from the file extension. Valid values are: + - `dump` (allowed extensions: `.vzdump`) + - `iso` (allowed extensions: `.iso`, `.img`) + - `snippets` (allowed extensions: any) + - `vztmpl` (allowed extensions: `.tar.gz`, `.tar.xz`, `tar.zst`) - `datastore_id` - (Required) The datastore id. - `node_name` - (Required) The node name. - `overwrite` - (Optional) Whether to overwrite an existing file (defaults to - `true`). -- `source_file` - (Optional) The source file (conflicts with `source_raw`), could be a - local file or a URL. If the source file is a URL, the file will be downloaded - and stored locally before uploading it to Proxmox VE. - - `checksum` - (Optional) The SHA256 checksum of the source file. - - `file_name` - (Optional) The file name to use instead of the source file - name. Useful when the source file does not have a valid file extension, for example - when the source file is a URL referencing a `.qcow2` image. - - `insecure` - (Optional) Whether to skip the TLS verification step for - HTTPS sources (defaults to `false`). - - `min_tls` - (Optional) The minimum required TLS version for HTTPS sources. "Supported values: `1.0|1.1|1.2|1.3` (defaults to `1.3`). - - `path` - (Required) A path to a local file or a URL. + `true`). +- `source_file` - (Optional) The source file (conflicts with `source_raw`), + could be a local file or a URL. If the source file is a URL, the file will + be downloaded and stored locally before uploading it to Proxmox VE. + - `checksum` - (Optional) The SHA256 checksum of the source file. + - `file_name` - (Optional) The file name to use instead of the source file + name. Useful when the source file does not have a valid file extension, + for example when the source file is a URL referencing a `.qcow2` image. + - `insecure` - (Optional) Whether to skip the TLS verification step for + HTTPS sources (defaults to `false`). + - `min_tls` - (Optional) The minimum required TLS version for HTTPS + sources. "Supported values: `1.0|1.1|1.2|1.3` (defaults to `1.3`). + - `path` - (Required) A path to a local file or a URL. - `source_raw` - (Optional) The raw source (conflicts with `source_file`). - - `data` - (Required) The raw data. - - `file_name` - (Required) The file name. - - `resize` - (Optional) The number of bytes to resize the file to. + - `data` - (Required) The raw data. + - `file_name` - (Required) The file name. + - `resize` - (Optional) The number of bytes to resize the file to. - `timeout_upload` - (Optional) Timeout for uploading ISO/VSTMPL files in - seconds (defaults to 1800). + seconds (defaults to 1800). ## Attribute Reference diff --git a/docs/resources/virtual_environment_firewall_ipset.md b/docs/resources/virtual_environment_firewall_ipset.md index ea7f48dc..0b7557d4 100644 --- a/docs/resources/virtual_environment_firewall_ipset.md +++ b/docs/resources/virtual_environment_firewall_ipset.md @@ -48,10 +48,10 @@ resource "proxmox_virtual_environment_firewall_ipset" "ipset" { - `name` - (Required) IPSet name. - `comment` - (Optional) IPSet comment. - `cidr` - (Optional) IP/CIDR block (multiple blocks supported). - - `name` - Network/IP specification in CIDR format. - - `comment` - (Optional) Arbitrary string annotation. - - `nomatch` - (Optional) Entries marked as `nomatch` are skipped as if those - were not added to the set. + - `name` - Network/IP specification in CIDR format. + - `comment` - (Optional) Arbitrary string annotation. + - `nomatch` - (Optional) Entries marked as `nomatch` are skipped as if those + were not added to the set. ## Attribute Reference diff --git a/docs/resources/virtual_environment_firewall_options.md b/docs/resources/virtual_environment_firewall_options.md index 7ab85fdb..9ed769fe 100644 --- a/docs/resources/virtual_environment_firewall_options.md +++ b/docs/resources/virtual_environment_firewall_options.md @@ -39,20 +39,22 @@ resource "proxmox_virtual_environment_firewall_options" "example" { - `dhcp` - (Optional)Enable DHCP. - `enabled` - (Optional) Enable or disable the firewall. - `ipfilter` - (Optional) Enable default IP filters. This is equivalent to - adding an empty `ipfilter-net` 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. + adding an empty `ipfilter-net` 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. - `log_level_in` - (Optional) Log level for incoming - packets (`emerg`, `alert`, `crit`, `err`, `warning`, `notice`, `info`, `debug`, `nolog`). + packets (`emerg`, `alert`, `crit`, `err`, `warning`, `notice`, `info`, + `debug`, `nolog`). - `log_level_out` - (Optional) Log level for outgoing - packets (`emerg`, `alert`, `crit`, `err`, `warning`, `notice`, `info`, `debug`, `nolog`). + packets (`emerg`, `alert`, `crit`, `err`, `warning`, `notice`, `info`, + `debug`, `nolog`). - `macfilter` - (Optional) Enable/disable MAC address filter. - `ndp` - (Optional) Enable NDP (Neighbor Discovery Protocol). - `input_policy` - (Optional) The default input - policy (`ACCEPT`, `DROP`, `REJECT`). + policy (`ACCEPT`, `DROP`, `REJECT`). - `output_policy` - (Optional) The default output - policy (`ACCEPT`, `DROP`, `REJECT`). + policy (`ACCEPT`, `DROP`, `REJECT`). - `radv` - (Optional) Enable Router Advertisement. ## Attribute Reference diff --git a/docs/resources/virtual_environment_firewall_rules.md b/docs/resources/virtual_environment_firewall_rules.md index a4b00edf..54fdcb79 100644 --- a/docs/resources/virtual_environment_firewall_rules.md +++ b/docs/resources/virtual_environment_firewall_rules.md @@ -57,54 +57,54 @@ resource "proxmox_virtual_environment_firewall_rules" "inbound" { - `node_name` - (Optional) Node name. Leave empty for cluster level rules. - `vm_id` - (Optional) VM ID. Leave empty for cluster level rules. - `container_id` - (Optional) Container ID. Leave empty for cluster level - rules. + rules. - `rule` - (Optional) Firewall rule block (multiple blocks supported). - The provider supports two types of the `rule` blocks: - - a rule definition block, which includes the following arguments: - - `action` - (Required) Rule action (`ACCEPT`, `DROP`, `REJECT`). - - `type` - (Required) Rule type (`in`, `out`). - - `comment` - (Optional) Rule comment. - - `dest` - (Optional) 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. - - `dport` - (Optional) 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. - - `enabled` - (Optional) Enable this rule. Defaults to `true`. - - `iface` - (Optional) Network interface name. You have to use network - configuration key names for VMs and containers ('net\d+'). Host - related rules can use arbitrary strings. - - `log` - (Optional) Log level for this rule (`emerg`, `alert`, `crit`, - `err`, `warning`, `notice`, `info`, `debug`, `nolog`). - - `macro`- (Optional) Macro name. Use predefined standard macro - from - - `proto` - (Optional) Restrict packet protocol. You can use protocol - names as defined in '/etc/protocols'. - - `source` - (Optional) 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. - - `sport` - (Optional) 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. - - a security group insertion block, which includes the following arguments: - - `comment` - (Optional) Rule comment. - - `enabled` - (Optional) Enable this rule. Defaults to `true`. - - `iface` - (Optional) Network interface name. You have to use network - configuration key names for VMs and containers ('net\d+'). Host - related rules can use arbitrary strings. - - `security_group` - (Required) Security group name. + The provider supports two types of the `rule` blocks: + - A rule definition block, which includes the following arguments: + - `action` - (Required) Rule action (`ACCEPT`, `DROP`, `REJECT`). + - `type` - (Required) Rule type (`in`, `out`). + - `comment` - (Optional) Rule comment. + - `dest` - (Optional) 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. + - `dport` - (Optional) 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. + - `enabled` - (Optional) Enable this rule. Defaults to `true`. + - `iface` - (Optional) Network interface name. You have to use network + configuration key names for VMs and containers ('net\d+'). Host + related rules can use arbitrary strings. + - `log` - (Optional) Log level for this rule (`emerg`, `alert`, `crit`, + `err`, `warning`, `notice`, `info`, `debug`, `nolog`). + - `macro`- (Optional) Macro name. Use predefined standard macro + from + - `proto` - (Optional) Restrict packet protocol. You can use protocol + names as defined in '/etc/protocols'. + - `source` - (Optional) 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. + - `sport` - (Optional) 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. + - a security group insertion block, which includes the following arguments: + - `comment` - (Optional) Rule comment. + - `enabled` - (Optional) Enable this rule. Defaults to `true`. + - `iface` - (Optional) Network interface name. You have to use network + configuration key names for VMs and containers ('net\d+'). Host + related rules can use arbitrary strings. + - `security_group` - (Required) Security group name. ## Attribute Reference - `rule` - - `pos` - Position of the rule in the list. + - `pos` - Position of the rule in the list. diff --git a/docs/resources/virtual_environment_group.md b/docs/resources/virtual_environment_group.md index bb10cb81..46b31f2f 100644 --- a/docs/resources/virtual_environment_group.md +++ b/docs/resources/virtual_environment_group.md @@ -21,9 +21,9 @@ resource "proxmox_virtual_environment_group" "operations_team" { ## Argument Reference - `acl` - (Optional) The access control list (multiple blocks supported). - - `path` - The path. - - `propagate` - Whether to propagate to child paths. - - `role_id` - The role identifier. + - `path` - The path. + - `propagate` - Whether to propagate to child paths. + - `role_id` - The role identifier. - `comment` - (Optional) The group comment. - `group_id` - (Required) The group identifier. diff --git a/docs/resources/virtual_environment_hosts.md b/docs/resources/virtual_environment_hosts.md index 405a0455..34908552 100644 --- a/docs/resources/virtual_environment_hosts.md +++ b/docs/resources/virtual_environment_hosts.md @@ -30,15 +30,15 @@ resource "proxmox_virtual_environment_hosts" "first_node_host_entries" { - `node_name` - (Required) A node name. - `entry` - (Required) A host entry (multiple blocks supported). - - `address` - (Required) The IP address. - - `hostnames` - (Required) The hostnames. + - `address` - (Required) The IP address. + - `hostnames` - (Required) The hostnames. ## Attribute Reference - `addresses` - The IP addresses. - `digest` - The SHA1 digest. - `entries` - The host entries (conversion of `addresses` and `hostnames` into - objects). + objects). - `hostnames` - The hostnames associated with each of the IP addresses. ## Important Notes diff --git a/docs/resources/virtual_environment_pool.md b/docs/resources/virtual_environment_pool.md index f8ae4200..50673cd2 100644 --- a/docs/resources/virtual_environment_pool.md +++ b/docs/resources/virtual_environment_pool.md @@ -26,11 +26,11 @@ resource "proxmox_virtual_environment_pool" "operations_pool" { ## Attribute Reference - `members` - The pool members. - - `datastore_id` - The datastore identifier. - - `id` - The member identifier. - - `node_name` - The node name. - - `type` - The member type. - - `vm_id` - The virtual machine identifier. + - `datastore_id` - The datastore identifier. + - `id` - The member identifier. + - `node_name` - The node name. + - `type` - The member type. + - `vm_id` - The virtual machine identifier. ## Import diff --git a/docs/resources/virtual_environment_user.md b/docs/resources/virtual_environment_user.md index 53d92a64..a17cf2af 100644 --- a/docs/resources/virtual_environment_user.md +++ b/docs/resources/virtual_environment_user.md @@ -36,9 +36,9 @@ resource "proxmox_virtual_environment_role" "operations_monitoring" { ## Argument Reference - `acl` - (Optional) The access control list (multiple blocks supported). - - `path` - The path. - - `propagate` - Whether to propagate to child paths. - - `role_id` - The role identifier. + - `path` - The path. + - `propagate` - Whether to propagate to child paths. + - `role_id` - The role identifier. - `comment` - (Optional) The user comment. - `email` - (Optional) The user's email address. - `enabled` - (Optional) Whether the user account is enabled. diff --git a/docs/resources/virtual_environment_vm.md b/docs/resources/virtual_environment_vm.md index 5c4ff126..75ea8324 100644 --- a/docs/resources/virtual_environment_vm.md +++ b/docs/resources/virtual_environment_vm.md @@ -107,419 +107,420 @@ output "ubuntu_vm_public_key" { - `acpi` - (Optional) Whether to enable ACPI (defaults to `true`). - `agent` - (Optional) The QEMU agent configuration. - - `enabled` - (Optional) Whether to enable the QEMU agent (defaults - to `false`). - - `timeout` - (Optional) The maximum amount of time to wait for data from - the QEMU agent to become available ( defaults to `15m`). - - `trim` - (Optional) Whether to enable the FSTRIM feature in the QEMU agent - (defaults to `false`). - - `type` - (Optional) The QEMU agent interface type (defaults to `virtio`). - - `isa` - ISA Serial Port. - - `virtio` - VirtIO (paravirtualized). + - `enabled` - (Optional) Whether to enable the QEMU agent (defaults + to `false`). + - `timeout` - (Optional) The maximum amount of time to wait for data from + the QEMU agent to become available ( defaults to `15m`). + - `trim` - (Optional) Whether to enable the FSTRIM feature in the QEMU agent + (defaults to `false`). + - `type` - (Optional) The QEMU agent interface type (defaults to `virtio`). + - `isa` - ISA Serial Port. + - `virtio` - VirtIO (paravirtualized). - `audio_device` - (Optional) An audio device. - - `device` - (Optional) The device (defaults to `intel-hda`). - - `AC97` - Intel 82801AA AC97 Audio. - - `ich9-intel-hda` - Intel HD Audio Controller (ich9). - - `intel-hda` - Intel HD Audio. - - `driver` - (Optional) The driver (defaults to `spice`). - - `spice` - Spice. - - `enabled` - (Optional) Whether to enable the audio device (defaults - to `true`). + - `device` - (Optional) The device (defaults to `intel-hda`). + - `AC97` - Intel 82801AA AC97 Audio. + - `ich9-intel-hda` - Intel HD Audio Controller (ich9). + - `intel-hda` - Intel HD Audio. + - `driver` - (Optional) The driver (defaults to `spice`). + - `spice` - Spice. + - `enabled` - (Optional) Whether to enable the audio device (defaults + to `true`). - `bios` - (Optional) The BIOS implementation (defaults to `seabios`). - - `ovmf` - OVMF (UEFI). - - `seabios` - SeaBIOS. + - `ovmf` - OVMF (UEFI). + - `seabios` - SeaBIOS. - `boot_order` - (Optional) Specify a list of devices to boot from in the order - they appear in the list (defaults to `[]`). + they appear in the list (defaults to `[]`). - `cdrom` - (Optional) The CDROM configuration. - - `enabled` - (Optional) Whether to enable the CDROM drive (defaults - to `false`). - - `file_id` - (Optional) A file ID for an ISO file (defaults to `cdrom` as - in the physical drive). - - `interface` - (Optional) A hardware interface to connect CDROM drive to, - must be `ideN` (defaults to `ide3`). Note that `q35` machine type only - supports `ide0` and `ide2`. + - `enabled` - (Optional) Whether to enable the CDROM drive (defaults + to `false`). + - `file_id` - (Optional) A file ID for an ISO file (defaults to `cdrom` as + in the physical drive). + - `interface` - (Optional) A hardware interface to connect CDROM drive to, + must be `ideN` (defaults to `ide3`). Note that `q35` machine type only + supports `ide0` and `ide2`. - `clone` - (Optional) The cloning configuration. - - `datastore_id` - (Optional) The identifier for the target datastore. - - `node_name` - (Optional) The name of the source node (leave blank, if - equal to the `node_name` argument). - - `retries` - (Optional) Number of retries in Proxmox for clone vm. - Sometimes Proxmox errors with timeout when creating multiple clones at - once. - - `vm_id` - (Required) The identifier for the source VM. - - `full` - (Optional) Full or linked clone (defaults to `true`). + - `datastore_id` - (Optional) The identifier for the target datastore. + - `node_name` - (Optional) The name of the source node (leave blank, if + equal to the `node_name` argument). + - `retries` - (Optional) Number of retries in Proxmox for clone vm. + Sometimes Proxmox errors with timeout when creating multiple clones at + once. + - `vm_id` - (Required) The identifier for the source VM. + - `full` - (Optional) Full or linked clone (defaults to `true`). - `cpu` - (Optional) The CPU configuration. - - `architecture` - (Optional) The CPU architecture (defaults to `x86_64`). - - `aarch64` - ARM (64 bit). - - `x86_64` - x86 (64-bit). - - `cores` - (Optional) The number of CPU cores (defaults to `1`). - - `flags` - (Optional) The CPU flags. - - `+aes`/`-aes` - Activate AES instruction set for HW acceleration. - - `+amd-no-ssb`/`-amd-no-ssb` - Notifies guest OS that host is not - vulnerable for Spectre on AMD CPUs. - - `+amd-ssbd`/`-amd-ssbd` - Improves Spectre mitigation performance with - AMD CPUs, best used with "virt-ssbd". - - `+hv-evmcs`/`-hv-evmcs` - Improve performance for nested - virtualization (only supported on Intel CPUs). - - `+hv-tlbflush`/`-hv-tlbflush` - Improve performance in overcommitted - Windows guests (may lead to guest BSOD on old CPUs). - - `+ibpb`/`-ibpb` - Allows improved Spectre mitigation on AMD CPUs. - - `+md-clear`/`-md-clear` - Required to let the guest OS know if MDS is - mitigated correctly. - - `+pcid`/`-pcid` - Meltdown fix cost reduction on Westmere, Sandy- and - Ivy Bridge Intel CPUs. - - `+pdpe1gb`/`-pdpe1gb` - Allows guest OS to use 1 GB size pages, if - host HW supports it. - - `+spec-ctrl`/`-spec-ctrl` - Allows improved Spectre mitigation with - Intel CPUs. - - `+ssbd`/`-ssbd` - Protection for "Speculative Store Bypass" for Intel - models. - - `+virt-ssbd`/`-virt-ssbd` - Basis for "Speculative Store Bypass" - protection for AMD models. - - `hotplugged` - (Optional) The number of hotplugged vCPUs (defaults - to `0`). - - `limit` - (Optional) Limit of CPU usage, `0...128`. (defaults to `0` -- no limit). - - `numa` - (Boolean) Enable/disable NUMA. (default to `false`) - - `sockets` - (Optional) The number of CPU sockets (defaults to `1`). - - `type` - (Optional) The emulated CPU type, it's recommended to - use `x86-64-v2-AES` (defaults to `qemu64`). - - `486` - Intel 486. - - `Broadwell`/`Broadwell-IBRS`/`Broadwell-noTSX`/`Broadwell-noTSX-IBRS` - - Intel Core Processor (Broadwell, 2014). - - `Cascadelake-Server`/`Cascadelake-Server-noTSX`/`Cascadelake-Server-v2`/`Cascadelake-Server-v4`/`Cascadelake-Server-v5` - - Intel Xeon 32xx/42xx/52xx/62xx/82xx/92xx (2019). - - `Conroe` - Intel Celeron_4x0 (Conroe/Merom Class Core 2, 2006). - - `Cooperlake`/`Cooperlake-v2` - - `EPYC`/`EPYC-IBPB`/`EPYC-Milan`/`EPYC-Rome`/`EPYC-Rome-v2`/`EPYC-v3` - - AMD EPYC Processor (2017). - - `Haswell`/`Haswell-IBRS`/`Haswell-noTSX`/`Haswell-noTSX-IBRS` - Intel - Core Processor (Haswell, 2013). - - `Icelake-Client`/`Icelake-Client-noTSX` - - `Icelake-Server`/`Icelake-Server-noTSX`/`Icelake-Server-v3`/`Icelake-Server-v4`/`Icelake-Server-v5`/`Icelake-Server-v6` - - `IvyBridge`/`IvyBridge-IBRS` - Intel Xeon E3-12xx v2 (Ivy Bridge, - 2012). - - `KnightsMill` - Intel Xeon Phi 72xx (2017). - - `Nehalem`/`Nehalem-IBRS` - Intel Core i7 9xx (Nehalem Class Core i7, - 2008). - - `Opteron_G1` - AMD Opteron 240 (Gen 1 Class Opteron, 2004). - - `Opteron_G2` - AMD Opteron 22xx (Gen 2 Class Opteron, 2006). - - `Opteron_G3` - AMD Opteron 23xx (Gen 3 Class Opteron, 2009). - - `Opteron_G4` - AMD Opteron 62xx class CPU (2011). - - `Opteron_G5` - AMD Opteron 63xx class CPU (2012). - - `Penryn` - Intel Core 2 Duo P9xxx (Penryn Class Core 2, 2007). - - `SandyBridge`/`SandyBridge-IBRS` - Intel Xeon E312xx (Sandy Bridge, - 2011). - - `SapphireRapids` - - `Skylake-Client`/`Skylake-Client-IBRS`/`Skylake-Client-noTSX-IBRS`/`Skylake-Client-v4` - - Intel Core Processor (Skylake, 2015). - - `Skylake-Server`/`Skylake-Server-IBRS`/`Skylake-Server-noTSX-IBRS`/`Skylake-Server-v4`/`Skylake-Server-v5` - - Intel Xeon Processor (Skylake, 2016). - - `Westmere`/`Westmere-IBRS` - Intel Westmere E56xx/L56xx/X56xx ( - Nehalem-C, 2010). - - `athlon` - AMD Athlon. - - `core2duo` - Intel Core 2 Duo. - - `coreduo` - Intel Core Duo. - - `host` - Host pass-through. - - `kvm32`/`kvm64` - Common KVM processor (32 & 64 bit variants). - - `max` - Maximum amount of features from host CPU. - - `pentium` - Intel Pentium (1993). - - `pentium2` - Intel Pentium 2 (1997-1999). - - `pentium3` - Intel Pentium 3 (1999-2001). - - `phenom` - AMD Phenom (2010). - - `qemu32`/`qemu64` - QEMU Virtual CPU version 2.5+ (32 & 64 bit - variants). - - `x86-64-v2`/`x86-64-v2-AES`/`x86-64-v3`/`x86-64-v4` - See - - `custom-` - Custom CPU model. All `custom-` values - should be defined in `/etc/pve/virtual-guest/cpu-models.conf` file. - - `units` - (Optional) The CPU units (defaults to `1024`). + - `architecture` - (Optional) The CPU architecture (defaults to `x86_64`). + - `aarch64` - ARM (64 bit). + - `x86_64` - x86 (64-bit). + - `cores` - (Optional) The number of CPU cores (defaults to `1`). + - `flags` - (Optional) The CPU flags. + - `+aes`/`-aes` - Activate AES instruction set for HW acceleration. + - `+amd-no-ssb`/`-amd-no-ssb` - Notifies guest OS that host is not + vulnerable for Spectre on AMD CPUs. + - `+amd-ssbd`/`-amd-ssbd` - Improves Spectre mitigation performance with + AMD CPUs, best used with "virt-ssbd". + - `+hv-evmcs`/`-hv-evmcs` - Improve performance for nested + virtualization (only supported on Intel CPUs). + - `+hv-tlbflush`/`-hv-tlbflush` - Improve performance in overcommitted + Windows guests (may lead to guest BSOD on old CPUs). + - `+ibpb`/`-ibpb` - Allows improved Spectre mitigation on AMD CPUs. + - `+md-clear`/`-md-clear` - Required to let the guest OS know if MDS is + mitigated correctly. + - `+pcid`/`-pcid` - Meltdown fix cost reduction on Westmere, Sandy- and + Ivy Bridge Intel CPUs. + - `+pdpe1gb`/`-pdpe1gb` - Allows guest OS to use 1 GB size pages, if + host HW supports it. + - `+spec-ctrl`/`-spec-ctrl` - Allows improved Spectre mitigation with + Intel CPUs. + - `+ssbd`/`-ssbd` - Protection for "Speculative Store Bypass" for Intel + models. + - `+virt-ssbd`/`-virt-ssbd` - Basis for "Speculative Store Bypass" + protection for AMD models. + - `hotplugged` - (Optional) The number of hotplugged vCPUs (defaults + to `0`). + - `limit` - (Optional) Limit of CPU usage, `0...128`. (defaults to `0` -- no limit). + - `numa` - (Boolean) Enable/disable NUMA. (default to `false`) + - `sockets` - (Optional) The number of CPU sockets (defaults to `1`). + - `type` - (Optional) The emulated CPU type, it's recommended to + use `x86-64-v2-AES` (defaults to `qemu64`). + - `486` - Intel 486. + - `Broadwell`/`Broadwell-IBRS`/`Broadwell-noTSX`/`Broadwell-noTSX-IBRS` - Intel Core Processor (Broadwell, 2014). + - `Cascadelake-Server`/`Cascadelake-Server-noTSX`/`Cascadelake-Server-v2`/`Cascadelake-Server-v4`/`Cascadelake-Server-v5` - Intel Xeon 32xx/42xx/52xx/62xx/82xx/92xx (2019). + - `Conroe` - Intel Celeron_4x0 (Conroe/Merom Class Core 2, 2006). + - `Cooperlake`/`Cooperlake-v2` + - `EPYC`/`EPYC-IBPB`/`EPYC-Milan`/`EPYC-Rome`/`EPYC-Rome-v2`/`EPYC-v3` - + AMD EPYC Processor (2017). + - `Haswell`/`Haswell-IBRS`/`Haswell-noTSX`/`Haswell-noTSX-IBRS` - Intel + Core Processor (Haswell, 2013). + - `Icelake-Client`/`Icelake-Client-noTSX` + - `Icelake-Server`/`Icelake-Server-noTSX`/`Icelake-Server-v3`/ + `Icelake-Server-v4`/`Icelake-Server-v5`/`Icelake-Server-v6` + - `IvyBridge`/`IvyBridge-IBRS` - Intel Xeon E3-12xx v2 (Ivy Bridge, + 2012). + - `KnightsMill` - Intel Xeon Phi 72xx (2017). + - `Nehalem`/`Nehalem-IBRS` - Intel Core i7 9xx (Nehalem Class Core i7, + 2008). + - `Opteron_G1` - AMD Opteron 240 (Gen 1 Class Opteron, 2004). + - `Opteron_G2` - AMD Opteron 22xx (Gen 2 Class Opteron, 2006). + - `Opteron_G3` - AMD Opteron 23xx (Gen 3 Class Opteron, 2009). + - `Opteron_G4` - AMD Opteron 62xx class CPU (2011). + - `Opteron_G5` - AMD Opteron 63xx class CPU (2012). + - `Penryn` - Intel Core 2 Duo P9xxx (Penryn Class Core 2, 2007). + - `SandyBridge`/`SandyBridge-IBRS` - Intel Xeon E312xx (Sandy Bridge, + 2011). + - `SapphireRapids` + - `Skylake-Client`/`Skylake-Client-IBRS`/`Skylake-Client-noTSX-IBRS`/`Skylake-Client-v4` - + Intel Core Processor (Skylake, 2015). + - `Skylake-Server`/`Skylake-Server-IBRS`/`Skylake-Server-noTSX-IBRS`/`Skylake-Server-v4`/`Skylake-Server-v5` - + Intel Xeon Processor (Skylake, 2016). + - `Westmere`/`Westmere-IBRS` - Intel Westmere E56xx/L56xx/X56xx ( + Nehalem-C, 2010). + - `athlon` - AMD Athlon. + - `core2duo` - Intel Core 2 Duo. + - `coreduo` - Intel Core Duo. + - `host` - Host pass-through. + - `kvm32`/`kvm64` - Common KVM processor (32 & 64 bit variants). + - `max` - Maximum amount of features from host CPU. + - `pentium` - Intel Pentium (1993). + - `pentium2` - Intel Pentium 2 (1997-1999). + - `pentium3` - Intel Pentium 3 (1999-2001). + - `phenom` - AMD Phenom (2010). + - `qemu32`/`qemu64` - QEMU Virtual CPU version 2.5+ (32 & 64 bit + variants). + - `x86-64-v2`/`x86-64-v2-AES`/`x86-64-v3`/`x86-64-v4` + See + - `custom-` - Custom CPU model. All `custom-` values + should be defined in `/etc/pve/virtual-guest/cpu-models.conf` file. + - `units` - (Optional) The CPU units (defaults to `1024`). - `description` - (Optional) The description. - `disk` - (Optional) A disk (multiple blocks supported). - - `cache` - (Optional) The cache type (defaults to `none`). - - `none` - No cache. - - `directsync` - Write to the host cache and wait for completion. - - `writethrough` - Write to the host cache, but write through to - the guest. - - `writeback` - Write to the host cache, but write back to the - guest when possible. - - `unsafe` - Write directly to the disk bypassing the host cache. - - `datastore_id` - (Optional) The identifier for the datastore to create - the disk in (defaults to `local-lvm`). - - `path_in_datastore` - (Optional) The in-datastore path to the disk image. - ***Experimental.***Use to attach another VM's disks, - or (as root only) host's filesystem paths (`datastore_id` empty string). - See "*Example: Attached disks*". - - `discard` - (Optional) Whether to pass discard/trim requests to the - underlying storage. Supported values are `on`/`ignore` (defaults - to `ignore`). - - `file_format` - (Optional) The file format (defaults to `qcow2`). - - `qcow2` - QEMU Disk Image v2. - - `raw` - Raw Disk Image. - - `vmdk` - VMware Disk Image. - - `file_id` - (Optional) The file ID for a disk image (experimental - - might cause high CPU utilization during import, especially with large - disk images). - - `interface` - (Required) The disk interface for Proxmox, currently `scsi`, - `sata` and `virtio` interfaces are supported. Append the disk index at - the end, for example, `virtio0` for the first virtio disk, `virtio1` for - the second, etc. - - `iothread` - (Optional) Whether to use iothreads for this disk (defaults - to `false`). - - `size` - (Optional) The disk size in gigabytes (defaults to `8`). - - `speed` - (Optional) The speed limits. - - `read` - (Optional) The maximum read speed in megabytes per second. - - `read_burstable` - (Optional) The maximum burstable read speed in - megabytes per second. - - `write` - (Optional) The maximum write speed in megabytes per second. - - `write_burstable` - (Optional) The maximum burstable write speed in - megabytes per second. - - `ssd` - (Optional) Whether to use an SSD emulation option for this disk ( - defaults to `false`). Note that SSD emulation is not supported on VirtIO - Block drives. + - `cache` - (Optional) The cache type (defaults to `none`). + - `none` - No cache. + - `directsync` - Write to the host cache and wait for completion. + - `writethrough` - Write to the host cache, but write through to + the guest. + - `writeback` - Write to the host cache, but write back to the + guest when possible. + - `unsafe` - Write directly to the disk bypassing the host cache. + - `datastore_id` - (Optional) The identifier for the datastore to create + the disk in (defaults to `local-lvm`). + - `path_in_datastore` - (Optional) The in-datastore path to the disk image. + ***Experimental.***Use to attach another VM's disks, + or (as root only) host's filesystem paths (`datastore_id` empty string). + See "*Example: Attached disks*". + - `discard` - (Optional) Whether to pass discard/trim requests to the + underlying storage. Supported values are `on`/`ignore` (defaults + to `ignore`). + - `file_format` - (Optional) The file format (defaults to `qcow2`). + - `qcow2` - QEMU Disk Image v2. + - `raw` - Raw Disk Image. + - `vmdk` - VMware Disk Image. + - `file_id` - (Optional) The file ID for a disk image (experimental - + might cause high CPU utilization during import, especially with large + disk images). + - `interface` - (Required) The disk interface for Proxmox, currently `scsi`, + `sata` and `virtio` interfaces are supported. Append the disk index at + the end, for example, `virtio0` for the first virtio disk, `virtio1` for + the second, etc. + - `iothread` - (Optional) Whether to use iothreads for this disk (defaults + to `false`). + - `size` - (Optional) The disk size in gigabytes (defaults to `8`). + - `speed` - (Optional) The speed limits. + - `read` - (Optional) The maximum read speed in megabytes per second. + - `read_burstable` - (Optional) The maximum burstable read speed in + megabytes per second. + - `write` - (Optional) The maximum write speed in megabytes per second. + - `write_burstable` - (Optional) The maximum burstable write speed in + megabytes per second. + - `ssd` - (Optional) Whether to use an SSD emulation option for this disk ( + defaults to `false`). Note that SSD emulation is not supported on VirtIO + Block drives. - `efi_disk` - (Optional) The efi disk device (required if `bios` is set - to `ovmf`) - - `datastore_id` (Optional) The identifier for the datastore to create - the disk in (defaults to `local-lvm`). - - `file_format` (Optional) The file format. - - `type` (Optional) Size and type of the OVMF EFI disk. `4m` is newer and - recommended, and required for Secure Boot. For backwards compatibility - use `2m`. Ignored for VMs with cpu.architecture=`aarch64` (defaults - to `2m`). - - `pre_enrolled_keys` (Optional) Use am EFI vars template with - distribution-specific and Microsoft Standard keys enrolled, if used with - EFI type=`4m`. Ignored for VMs with cpu.architecture=`aarch64` (defaults - to `false`). + to `ovmf`) + - `datastore_id` (Optional) The identifier for the datastore to create + the disk in (defaults to `local-lvm`). + - `file_format` (Optional) The file format. + - `type` (Optional) Size and type of the OVMF EFI disk. `4m` is newer and + recommended, and required for Secure Boot. For backwards compatibility + use `2m`. Ignored for VMs with cpu.architecture=`aarch64` (defaults + to `2m`). + - `pre_enrolled_keys` (Optional) Use am EFI vars template with + distribution-specific and Microsoft Standard keys enrolled, if used with + EFI type=`4m`. Ignored for VMs with cpu.architecture=`aarch64` (defaults + to `false`). - `tpm_state` - (Optional) The TPM state device. - - `datastore_id` (Optional) The identifier for the datastore to create - the disk in (defaults to `local-lvm`). - - `version` (Optional) TPM state device version. Can be `v1.2` or `v2.0`. - (defaults to `v2.0`). + - `datastore_id` (Optional) The identifier for the datastore to create + the disk in (defaults to `local-lvm`). + - `version` (Optional) TPM state device version. Can be `v1.2` or `v2.0`. + (defaults to `v2.0`). - `hostpci` - (Optional) A host PCI device mapping (multiple blocks supported). - - `device` - (Required) The PCI device name for Proxmox, in form - of `hostpciX` where `X` is a sequential number from 0 to 3. - - `id` - (Optional) The PCI device ID. This parameter is not compatible - with `api_token` and requires the root `username` and `password` - configured in the proxmox provider. Use either this or `mapping`. - - `mapping` - (Optional) The resource mapping name of the device, for - example gpu. Use either this or `id`. - - `mdev` - (Optional) The mediated device ID to use. - - `pcie` - (Optional) Tells Proxmox to use a PCIe or PCI port. Some - guests/device combination require PCIe rather than PCI. PCIe is only - available for q35 machine types. - - `rombar` - (Optional) Makes the firmware ROM visible for the VM (defaults - to `true`). - - `rom_file` - (Optional) A path to a ROM file for the device to use. This - is a relative path under `/usr/share/kvm/`. - - `xvga` - (Optional) Marks the PCI(e) device as the primary GPU of the VM. - With this enabled the `vga` configuration argument will be ignored. + - `device` - (Required) The PCI device name for Proxmox, in form + of `hostpciX` where `X` is a sequential number from 0 to 3. + - `id` - (Optional) The PCI device ID. This parameter is not compatible + with `api_token` and requires the root `username` and `password` + configured in the proxmox provider. Use either this or `mapping`. + - `mapping` - (Optional) The resource mapping name of the device, for + example gpu. Use either this or `id`. + - `mdev` - (Optional) The mediated device ID to use. + - `pcie` - (Optional) Tells Proxmox to use a PCIe or PCI port. Some + guests/device combination require PCIe rather than PCI. PCIe is only + available for q35 machine types. + - `rombar` - (Optional) Makes the firmware ROM visible for the VM (defaults + to `true`). + - `rom_file` - (Optional) A path to a ROM file for the device to use. This + is a relative path under `/usr/share/kvm/`. + - `xvga` - (Optional) Marks the PCI(e) device as the primary GPU of the VM. + With this enabled the `vga` configuration argument will be ignored. - `usb` - (Optional) A host USB device mapping (multiple blocks supported). - - `host` - (Optional) The USB device ID. Use either this or `mapping`. - - `mapping` - (Optional) The resource mapping name of the device, for - example usbdevice. Use either this or `id`. - - `usb3` - (Optional) Makes the USB device a USB3 device for the VM (defaults - to `false`). + - `host` - (Optional) The USB device ID. Use either this or `mapping`. + - `mapping` - (Optional) The resource mapping name of the device, for + example usbdevice. Use either this or `id`. + - `usb3` - (Optional) Makes the USB device a USB3 device for the VM + (defaults to `false`). - `initialization` - (Optional) The cloud-init configuration. - - `datastore_id` - (Optional) The identifier for the datastore to create the - cloud-init disk in (defaults to `local-lvm`). - - `interface` - (Optional) The hardware interface to connect the cloud-init - image to. Must be one of `ide0..3`, `sata0..5`, `scsi0..30`. Will be - detected if the setting is missing but a cloud-init image is present, - otherwise defaults to `ide2`. - - `dns` - (Optional) The DNS configuration. - - `domain` - (Optional) The DNS search domain. - - `server` - (Optional) The DNS server. The `server` attribute is deprecated and will be removed in a future release. Please use the `servers` attribute instead. - - `servers` - (Optional) The list of DNS servers. - - `ip_config` - (Optional) The IP configuration (one block per network - device). - - `ipv4` - (Optional) The IPv4 configuration. - - `address` - (Optional) The IPv4 address in CIDR notation - (e.g. 192.168.2.2/24). Alternatively, set this to `dhcp` for - autodiscovery. - - `gateway` - (Optional) The IPv4 gateway (must be omitted - when `dhcp` is used as the address). - - `ipv6` - (Optional) The IPv4 configuration. - - `address` - (Optional) The IPv6 address in CIDR notation - (e.g. fd1c:000:0000::0000:000:7334/64). Alternatively, set this - to `dhcp` for autodiscovery. - - `gateway` - (Optional) The IPv6 gateway (must be omitted - when `dhcp` is used as the address). - - `user_account` - (Optional) The user account configuration (conflicts - with `user_data_file_id`). - - `keys` - (Optional) The SSH keys. - - `password` - (Optional) The SSH password. - - `username` - (Optional) The SSH username. - - `network_data_file_id` - (Optional) The identifier for a file containing - network configuration data passed to the VM via cloud-init (conflicts - with `ip_config`). - - `user_data_file_id` - (Optional) The identifier for a file containing - custom user data (conflicts with `user_account`). - - `vendor_data_file_id` - (Optional) The identifier for a file containing - all vendor data passed to the VM via cloud-init. - - `meta_data_file_id` - (Optional) The identifier for a file containing - all meta data passed to the VM via cloud-init. + - `datastore_id` - (Optional) The identifier for the datastore to create the + cloud-init disk in (defaults to `local-lvm`). + - `interface` - (Optional) The hardware interface to connect the cloud-init + image to. Must be one of `ide0..3`, `sata0..5`, `scsi0..30`. Will be + detected if the setting is missing but a cloud-init image is present, + otherwise defaults to `ide2`. + - `dns` - (Optional) The DNS configuration. + - `domain` - (Optional) The DNS search domain. + - `server` - (Optional) The DNS server. The `server` attribute is + deprecated and will be removed in a future release. Please use the + `servers` attribute instead. + - `servers` - (Optional) The list of DNS servers. + - `ip_config` - (Optional) The IP configuration (one block per network + device). + - `ipv4` - (Optional) The IPv4 configuration. + - `address` - (Optional) The IPv4 address in CIDR notation + (e.g. 192.168.2.2/24). Alternatively, set this to `dhcp` for + autodiscovery. + - `gateway` - (Optional) The IPv4 gateway (must be omitted + when `dhcp` is used as the address). + - `ipv6` - (Optional) The IPv4 configuration. + - `address` - (Optional) The IPv6 address in CIDR notation + (e.g. fd1c:000:0000::0000:000:7334/64). Alternatively, set this + to `dhcp` for autodiscovery. + - `gateway` - (Optional) The IPv6 gateway (must be omitted + when `dhcp` is used as the address). + - `user_account` - (Optional) The user account configuration (conflicts + with `user_data_file_id`). + - `keys` - (Optional) The SSH keys. + - `password` - (Optional) The SSH password. + - `username` - (Optional) The SSH username. + - `network_data_file_id` - (Optional) The identifier for a file containing + network configuration data passed to the VM via cloud-init (conflicts + with `ip_config`). + - `user_data_file_id` - (Optional) The identifier for a file containing + custom user data (conflicts with `user_account`). + - `vendor_data_file_id` - (Optional) The identifier for a file containing + all vendor data passed to the VM via cloud-init. + - `meta_data_file_id` - (Optional) The identifier for a file containing + all meta data passed to the VM via cloud-init. - `keyboard_layout` - (Optional) The keyboard layout (defaults to `en-us`). - - `da` - Danish. - - `de` - German. - - `de-ch` - Swiss German. - - `en-gb` - British English. - - `en-us` - American English. - - `es` - Spanish. - - `fi` - Finnish. - - `fr` - French. - - `fr-be` - Belgian French. - - `fr-ca` - French Canadian. - - `fr-ch` - Swish French. - - `hu` - Hungarian. - - `is` - Icelandic. - - `it` - Italian. - - `ja` - Japanese. - - `lt` - Lithuanian. - - `mk` - Macedonian. - - `nl` - Dutch. - - `no` - Norwegian. - - `pl` - Polish. - - `pt` - Portuguese. - - `pt-br` - Brazilian Portuguese. - - `sl` - Slovenian. - - `sv` - Swedish. - - `tr` - Turkish. + - `da` - Danish. + - `de` - German. + - `de-ch` - Swiss German. + - `en-gb` - British English. + - `en-us` - American English. + - `es` - Spanish. + - `fi` - Finnish. + - `fr` - French. + - `fr-be` - Belgian French. + - `fr-ca` - French Canadian. + - `fr-ch` - Swish French. + - `hu` - Hungarian. + - `is` - Icelandic. + - `it` - Italian. + - `ja` - Japanese. + - `lt` - Lithuanian. + - `mk` - Macedonian. + - `nl` - Dutch. + - `no` - Norwegian. + - `pl` - Polish. + - `pt` - Portuguese. + - `pt-br` - Brazilian Portuguese. + - `sl` - Slovenian. + - `sv` - Swedish. + - `tr` - Turkish. - `kvm_arguments` - (Optional) Arbitrary arguments passed to kvm. - `machine` - (Optional) The VM machine type (defaults to `pc`). - - `pc` - Standard PC (i440FX + PIIX, 1996). - - `q35` - Standard PC (Q35 + ICH9, 2009). + - `pc` - Standard PC (i440FX + PIIX, 1996). + - `q35` - Standard PC (Q35 + ICH9, 2009). - `memory` - (Optional) The memory configuration. - - `dedicated` - (Optional) The dedicated memory in megabytes (defaults - to `512`). - - `floating` - (Optional) The floating memory in megabytes (defaults - to `0`). - - `shared` - (Optional) The shared memory in megabytes (defaults to `0`). + - `dedicated` - (Optional) The dedicated memory in megabytes (defaults + to `512`). + - `floating` - (Optional) The floating memory in megabytes (defaults + to `0`). + - `shared` - (Optional) The shared memory in megabytes (defaults to `0`). - `migrate` - (Optional) Migrate the VM on node change instead of re-creating - it (defaults to `false`). + it (defaults to `false`). - `name` - (Optional) The virtual machine name. - `network_device` - (Optional) A network device (multiple blocks supported). - - `bridge` - (Optional) The name of the network bridge (defaults - to `vmbr0`). - - `enabled` - (Optional) Whether to enable the network device (defaults - to `true`). - - `firewall` - (Optional) Whether this interface's firewall rules should be - used (defaults to `false`). - - `mac_address` - (Optional) The MAC address. - - `model` - (Optional) The network device model (defaults to `virtio`). - - `e1000` - Intel E1000. - - `rtl8139` - Realtek RTL8139. - - `virtio` - VirtIO (paravirtualized). - - `vmxnet3` - VMware vmxnet3. - - `mtu` - (Optional) Force MTU, for VirtIO only. Set to 1 to use the bridge - MTU. Cannot be larger than the bridge MTU. - - `queues` - (Optional) The number of queues for VirtIO (1..64). - - `rate_limit` - (Optional) The rate limit in megabytes per second. - - `vlan_id` - (Optional) The VLAN identifier. + - `bridge` - (Optional) The name of the network bridge (defaults + to `vmbr0`). + - `enabled` - (Optional) Whether to enable the network device (defaults + to `true`). + - `firewall` - (Optional) Whether this interface's firewall rules should be + used (defaults to `false`). + - `mac_address` - (Optional) The MAC address. + - `model` - (Optional) The network device model (defaults to `virtio`). + - `e1000` - Intel E1000. + - `rtl8139` - Realtek RTL8139. + - `virtio` - VirtIO (paravirtualized). + - `vmxnet3` - VMware vmxnet3. + - `mtu` - (Optional) Force MTU, for VirtIO only. Set to 1 to use the bridge + MTU. Cannot be larger than the bridge MTU. + - `queues` - (Optional) The number of queues for VirtIO (1..64). + - `rate_limit` - (Optional) The rate limit in megabytes per second. + - `vlan_id` - (Optional) The VLAN identifier. - `node_name` - (Required) The name of the node to assign the virtual machine - to. + to. - `on_boot` - (Optional) Specifies whether a VM will be started during system - boot. (defaults to `true`) + boot. (defaults to `true`) - `operating_system` - (Optional) The Operating System configuration. - - `type` - (Optional) The type (defaults to `other`). - - `l24` - Linux Kernel 2.4. - - `l26` - Linux Kernel 2.6 - 5.X. - - `other` - Unspecified OS. - - `solaris` - OpenIndiania, OpenSolaris og Solaris Kernel. - - `w2k` - Windows 2000. - - `w2k3` - Windows 2003. - - `w2k8` - Windows 2008. - - `win7` - Windows 7. - - `win8` - Windows 8, 2012 or 2012 R2. - - `win10` - Windows 10 or 2016. - - `win11` - Windows 11 - - `wvista` - Windows Vista. - - `wxp` - Windows XP. + - `type` - (Optional) The type (defaults to `other`). + - `l24` - Linux Kernel 2.4. + - `l26` - Linux Kernel 2.6 - 5.X. + - `other` - Unspecified OS. + - `solaris` - OpenIndiania, OpenSolaris og Solaris Kernel. + - `w2k` - Windows 2000. + - `w2k3` - Windows 2003. + - `w2k8` - Windows 2008. + - `win7` - Windows 7. + - `win8` - Windows 8, 2012 or 2012 R2. + - `win10` - Windows 10 or 2016. + - `win11` - Windows 11 + - `wvista` - Windows Vista. + - `wxp` - Windows XP. - `pool_id` - (Optional) The identifier for a pool to assign the virtual machine - to. + to. - `reboot` - (Optional) Reboot the VM after initial creation. (defaults - to `false`) + to `false`) - `serial_device` - (Optional) A serial device (multiple blocks supported). - - `device` - (Optional) The device (defaults to `socket`). - - `/dev/*` - A host serial device. - - `socket` - A unix socket. -- `scsi_hardware` - (Optional) The SCSI hardware type (defaults - to `virtio-scsi-pci`). - - `lsi` - LSI Logic SAS1068E. - - `lsi53c810` - LSI Logic 53C810. - - `virtio-scsi-pci` - VirtIO SCSI. - - `virtio-scsi-single` - VirtIO SCSI (single queue). - - `megasas` - LSI Logic MegaRAID SAS. - - `pvscsi` - VMware Paravirtual SCSI. + - `device` - (Optional) The device (defaults to `socket`). + - `/dev/*` - A host serial device. + - `socket` - A unix socket. +- `scsi_hardware` - (Optional) The SCSI hardware type (defaults to + `virtio-scsi-pci`). + - `lsi` - LSI Logic SAS1068E. + - `lsi53c810` - LSI Logic 53C810. + - `virtio-scsi-pci` - VirtIO SCSI. + - `virtio-scsi-single` - VirtIO SCSI (single queue). + - `megasas` - LSI Logic MegaRAID SAS. + - `pvscsi` - VMware Paravirtual SCSI. - `smbios` - (Optional) The SMBIOS (type1) settings for the VM. - - `family`- (Optional) The family string. - - `manufacturer` - (Optional) The manufacturer. - - `product` - (Optional) The product ID. - - `serial` - (Optional) The serial number. - - `sku` - (Optional) The SKU number. - - `uuid` - (Optional) The UUID (defaults to randomly generated UUID). - - `version` - (Optional) The version. + - `family`- (Optional) The family string. + - `manufacturer` - (Optional) The manufacturer. + - `product` - (Optional) The product ID. + - `serial` - (Optional) The serial number. + - `sku` - (Optional) The SKU number. + - `uuid` - (Optional) The UUID (defaults to randomly generated UUID). + - `version` - (Optional) The version. - `started` - (Optional) Whether to start the virtual machine (defaults - to `true`). + to `true`). - `startup` - (Optional) Defines startup and shutdown behavior of the VM. - - `order` - (Required) A non-negative number defining the general startup - order. - - `up` - (Optional) A non-negative number defining the delay in seconds - before the next VM is started. - - `down` - (Optional) A non-negative number defining the delay in seconds - before the next VM is shut down. + - `order` - (Required) A non-negative number defining the general startup + order. + - `up` - (Optional) A non-negative number defining the delay in seconds + before the next VM is started. + - `down` - (Optional) A non-negative number defining the delay in seconds + before the next VM is shut down. - `tablet_device` - (Optional) Whether to enable the USB tablet device (defaults - to `true`). + to `true`). - `tags` - (Optional) A list of tags of the VM. This is only meta information ( - defaults to `[]`). Note: Proxmox always sorts the VM tags. If the list in - template is not sorted, then Proxmox will always report a difference on the - resource. You may use the `ignore_changes` lifecycle meta-argument to ignore - changes to this attribute. + defaults to `[]`). Note: Proxmox always sorts the VM tags. If the list in + template is not sorted, then Proxmox will always report a difference on the + resource. You may use the `ignore_changes` lifecycle meta-argument to ignore + changes to this attribute. - `template` - (Optional) Whether to create a template (defaults to `false`). - `stop_on_destroy` - (Optional) Whether to stop rather than shutdown on VM destroy (defaults to `false`) - `timeout_clone` - (Optional) Timeout for cloning a VM in seconds (defaults to - 1800). + 1800). - `timeout_create` - (Optional) Timeout for creating a VM in seconds (defaults to - 1800). + 1800). - `timeout_move_disk` - (Optional) Timeout for moving the disk of a VM in - seconds (defaults to 1800). + seconds (defaults to 1800). - `timeout_migrate` - (Optional) Timeout for migrating the VM (defaults to - 1800). + 1800). - `timeout_reboot` - (Optional) Timeout for rebooting a VM in seconds (defaults - to 1800). + to 1800). - `timeout_shutdown_vm` - (Optional) Timeout for shutting down a VM in seconds ( - defaults to 1800). + defaults to 1800). - `timeout_start_vm` - (Optional) Timeout for starting a VM in seconds (defaults - to 1800). + to 1800). - `timeout_stop_vm` - (Optional) Timeout for stopping a VM in seconds (defaults - to 300). + to 300). - `vga` - (Optional) The VGA configuration. - - `enabled` - (Optional) Whether to enable the VGA device (defaults - to `true`). - - `memory` - (Optional) The VGA memory in megabytes (defaults to `16`). - - `type` - (Optional) The VGA type (defaults to `std`). - - `cirrus` - Cirrus (deprecated since QEMU 2.2). - - `qxl` - SPICE. - - `qxl2` - SPICE Dual Monitor. - - `qxl3` - SPICE Triple Monitor. - - `qxl4` - SPICE Quad Monitor. - - `serial0` - Serial Terminal 0. - - `serial1` - Serial Terminal 1. - - `serial2` - Serial Terminal 2. - - `serial3` - Serial Terminal 3. - - `std` - Standard VGA. - - `virtio` - VirtIO-GPU. - - `vmware` - VMware Compatible. + - `enabled` - (Optional) Whether to enable the VGA device (defaults + to `true`). + - `memory` - (Optional) The VGA memory in megabytes (defaults to `16`). + - `type` - (Optional) The VGA type (defaults to `std`). + - `cirrus` - Cirrus (deprecated since QEMU 2.2). + - `qxl` - SPICE. + - `qxl2` - SPICE Dual Monitor. + - `qxl3` - SPICE Triple Monitor. + - `qxl4` - SPICE Quad Monitor. + - `serial0` - Serial Terminal 0. + - `serial1` - Serial Terminal 1. + - `serial2` - Serial Terminal 2. + - `serial3` - Serial Terminal 3. + - `std` - Standard VGA. + - `virtio` - VirtIO-GPU. + - `vmware` - VMware Compatible. - `vm_id` - (Optional) The VM identifier. - `hook_script_file_id` - (Optional) The identifier for a file containing a hook script (needs to be executable). ## Attribute Reference - `ipv4_addresses` - The IPv4 addresses per network interface published by the - QEMU agent (empty list when `agent.enabled` is `false`) + QEMU agent (empty list when `agent.enabled` is `false`) - `ipv6_addresses` - The IPv6 addresses per network interface published by the - QEMU agent (empty list when `agent.enabled` is `false`) + QEMU agent (empty list when `agent.enabled` is `false`) - `mac_addresses` - The MAC addresses published by the QEMU agent with fallback - to the network device configuration, if the agent is disabled + to the network device configuration, if the agent is disabled - `network_interface_names` - The network interface names published by the QEMU - agent (empty list when `agent.enabled` is `false`) + agent (empty list when `agent.enabled` is `false`) ## Qemu guest agent