1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Hardware
  5. Hardware/mapping
  6. getPci
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.Hardware/mapping.getPci

Explore with Pulumi AI

Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski

Retrieves a PCI hardware mapping from a Proxmox VE cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@pulumi/proxmoxve";

const example = proxmoxve.Hardware.mapping.getPci({
    name: "example",
});
export const dataProxmoxVirtualEnvironmentHardwareMappingPci = example;
Copy
import pulumi
import pulumi_proxmoxve as proxmoxve

example = proxmoxve.Hardware.mapping.get_pci(name="example")
pulumi.export("dataProxmoxVirtualEnvironmentHardwareMappingPci", example)
Copy
package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v6/go/proxmoxve/hardware"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := hardware.GetPci(ctx, &mapping.GetPciArgs{
			Name: "example",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("dataProxmoxVirtualEnvironmentHardwareMappingPci", example)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ProxmoxVE = Pulumi.ProxmoxVE;

return await Deployment.RunAsync(() => 
{
    var example = ProxmoxVE.Hardware.Mapping.GetPci.Invoke(new()
    {
        Name = "example",
    });

    return new Dictionary<string, object?>
    {
        ["dataProxmoxVirtualEnvironmentHardwareMappingPci"] = example,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.Hardware_mapping.Hardware_mappingFunctions;
import com.pulumi.proxmoxve.Hardware.inputs.GetPciArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Hardware/mappingFunctions.getPci(GetPciArgs.builder()
            .name("example")
            .build());

        ctx.export("dataProxmoxVirtualEnvironmentHardwareMappingPci", example.applyValue(getPciResult -> getPciResult));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: proxmoxve:Hardware/mapping:getPci
      arguments:
        name: example
outputs:
  dataProxmoxVirtualEnvironmentHardwareMappingPci: ${example}
Copy

Using getPci

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPci(args: GetPciArgs, opts?: InvokeOptions): Promise<GetPciResult>
function getPciOutput(args: GetPciOutputArgs, opts?: InvokeOptions): Output<GetPciResult>
Copy
def get_pci(name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetPciResult
def get_pci_output(name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetPciResult]
Copy
func GetPci(ctx *Context, args *GetPciArgs, opts ...InvokeOption) (*GetPciResult, error)
func GetPciOutput(ctx *Context, args *GetPciOutputArgs, opts ...InvokeOption) GetPciResultOutput
Copy

> Note: This function is named GetPci in the Go SDK.

public static class GetPci 
{
    public static Task<GetPciResult> InvokeAsync(GetPciArgs args, InvokeOptions? opts = null)
    public static Output<GetPciResult> Invoke(GetPciInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPciResult> getPci(GetPciArgs args, InvokeOptions options)
public static Output<GetPciResult> getPci(GetPciArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: proxmoxve:Hardware/mapping/getPci:getPci
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of this PCI hardware mapping.
Name This property is required. string
The name of this PCI hardware mapping.
name This property is required. String
The name of this PCI hardware mapping.
name This property is required. string
The name of this PCI hardware mapping.
name This property is required. str
The name of this PCI hardware mapping.
name This property is required. String
The name of this PCI hardware mapping.

getPci Result

The following output properties are available:

Comment string
The comment of this PCI hardware mapping.
Id string
The unique identifier of this PCI hardware mapping data source.
Maps List<Pulumi.ProxmoxVE.Hardware.Mapping.Outputs.GetPciMap>
The actual map of devices for the hardware mapping.
MediatedDevices bool
Indicates whether to use with mediated devices.
Name string
The name of this PCI hardware mapping.
Comment string
The comment of this PCI hardware mapping.
Id string
The unique identifier of this PCI hardware mapping data source.
Maps []GetPciMap
The actual map of devices for the hardware mapping.
MediatedDevices bool
Indicates whether to use with mediated devices.
Name string
The name of this PCI hardware mapping.
comment String
The comment of this PCI hardware mapping.
id String
The unique identifier of this PCI hardware mapping data source.
maps List<GetPciMap>
The actual map of devices for the hardware mapping.
mediatedDevices Boolean
Indicates whether to use with mediated devices.
name String
The name of this PCI hardware mapping.
comment string
The comment of this PCI hardware mapping.
id string
The unique identifier of this PCI hardware mapping data source.
maps GetPciMap[]
The actual map of devices for the hardware mapping.
mediatedDevices boolean
Indicates whether to use with mediated devices.
name string
The name of this PCI hardware mapping.
comment str
The comment of this PCI hardware mapping.
id str
The unique identifier of this PCI hardware mapping data source.
maps Sequence[hardware.mapping.GetPciMap]
The actual map of devices for the hardware mapping.
mediated_devices bool
Indicates whether to use with mediated devices.
name str
The name of this PCI hardware mapping.
comment String
The comment of this PCI hardware mapping.
id String
The unique identifier of this PCI hardware mapping data source.
maps List<Property Map>
The actual map of devices for the hardware mapping.
mediatedDevices Boolean
Indicates whether to use with mediated devices.
name String
The name of this PCI hardware mapping.

Supporting Types

GetPciMap

Comment This property is required. string
The comment of the mapped PCI device.
Id This property is required. string
The ID attribute of the map.
IommuGroup This property is required. int
The IOMMU group attribute of the map.
Node This property is required. string
The node name attribute of the map.
Path This property is required. string
The path attribute of the map.
SubsystemId This property is required. 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.
Comment This property is required. string
The comment of the mapped PCI device.
Id This property is required. string
The ID attribute of the map.
IommuGroup This property is required. int
The IOMMU group attribute of the map.
Node This property is required. string
The node name attribute of the map.
Path This property is required. string
The path attribute of the map.
SubsystemId This property is required. 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.
comment This property is required. String
The comment of the mapped PCI device.
id This property is required. String
The ID attribute of the map.
iommuGroup This property is required. Integer
The IOMMU group attribute of the map.
node This property is required. String
The node name attribute of the map.
path This property is required. String
The path attribute of the map.
subsystemId This property is required. 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.
comment This property is required. string
The comment of the mapped PCI device.
id This property is required. string
The ID attribute of the map.
iommuGroup This property is required. number
The IOMMU group attribute of the map.
node This property is required. string
The node name attribute of the map.
path This property is required. string
The path attribute of the map.
subsystemId This property is required. 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.
comment This property is required. str
The comment of the mapped PCI device.
id This property is required. str
The ID attribute of the map.
iommu_group This property is required. int
The IOMMU group attribute of the map.
node This property is required. str
The node name attribute of the map.
path This property is required. str
The path attribute of the map.
subsystem_id This property is required. str
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.
comment This property is required. String
The comment of the mapped PCI device.
id This property is required. String
The ID attribute of the map.
iommuGroup This property is required. Number
The IOMMU group attribute of the map.
node This property is required. String
The node name attribute of the map.
path This property is required. String
The path attribute of the map.
subsystemId This property is required. 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.

Package Details

Repository
proxmoxve muhlba91/pulumi-proxmoxve
License
Apache-2.0
Notes
This Pulumi package is based on the proxmox Terraform Provider.
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski