mirror of
https://github.com/bpg/terraform-provider-proxmox.git
synced 2025-06-30 02:31:10 +00:00
76c1c2282b
* feat(cluster): Implement initial support for "hardware mappings" Right now it is alredy possible to use a mapped resource [1], but there is no dedicated `proxmox_virtual_environment_cluster_hardware_mapping` resource but this step must still be done manually (or automated through other ways that interact with the Proxmox API). This commit implements support for "hardware mapping" resources and data sources for the, currently, available bus types PCI and USB, based on the Proxmox VE API documentations [2]. There are some "specialities" in these resources and data sources: 1. The Proxmox VE API attribute, but this implementations names it "comment" since this naming is generally across the Proxmox VE web UI and API documentations. This still follows the Terraform "best practices" [3] as it improves the user experience by matching the field name to the naming used in the human-facing interfaces. 2. Like in point 1, the name of the attribute of "node checks diagnostics" for USB hardware mappings is "errors" in the Proxmox VE API while it is "checks" for hardware mappings of type PCI. The second naming pattern is also generally used across the Proxmox VE web UI and API documentations, including the "check_node" attribute that is also implemented in the "proxmox_virtual_environment_hardware_mappings" data source. Therefore, this implementation named both attributes "checks" which still follows the Terraform "best practices" [3] as it improves the user experience by matching the field name to the naming used in the human-facing interfaces. 3. This implmenetation comes with the "unique" feature of allowing comments (named "descriptions" by the Proxmox VE API) for an entry in a device map which is not possible through the web UI at all but only adding a comment for the whole mapping entry instead. Note that this implementation also adds another point in the "Known Issues" documentation since it is only possible to map a PCI/USB device using the `root` PAM account, but this is still better than having to manually configure it through the web UI or by interacting with the Proxmox VE API on other ways. [1]: https://github.com/bpg/terraform-provider-proxmox/pull/500 [2]: https://pve.proxmox.com/pve-docs/api-viewer/#/cluster/mapping/pci [3]: https://developer.hashicorp.com/terraform/plugin/best-practices/hashicorp-provider-design-principles#resource-and-attribute-schema-should-closely-match-the-underlying-api Signed-off-by: Sven Greb <development@svengreb.de> * fix linter Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com> --------- Signed-off-by: Sven Greb <development@svengreb.de> Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com> Co-authored-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
1.6 KiB
1.6 KiB
| layout | title | parent | subcategory | description |
|---|---|---|---|---|
| page | proxmox_virtual_environment_hardware_mapping_pci | Data Sources | Virtual Environment | Retrieves a PCI hardware mapping from a Proxmox VE cluster. |
Data Source: proxmox_virtual_environment_hardware_mapping_pci
Retrieves a PCI hardware mapping from a Proxmox VE cluster.
Example Usage
data "proxmox_virtual_environment_hardware_mapping_pci" "example" {
name = "example"
}
output "data_proxmox_virtual_environment_hardware_mapping_pci" {
value = data.proxmox_virtual_environment_hardware_mapping_pci.example
}
Schema
Required
name(String) The name of this PCI hardware mapping.
Read-Only
comment(String) The comment of this PCI hardware mapping.id(String) The unique identifier of this PCI hardware mapping data source.map(Attributes Set) The actual map of devices for the hardware mapping. (see below for nested schema)mediated_devices(Boolean) Indicates whether to use with mediated devices.
Nested Schema for map
Read-Only:
comment(String) The comment of the mapped PCI device.id(String) The ID attribute of the map.iommu_group(Number) The IOMMU group attribute of the map.node(String) The node name attribute of the map.path(String) The path attribute of the map.subsystem_id(String) The subsystem ID attribute of the map.Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set.