Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Hardware
  5. Hardware/mapping
  6. Pci
Proxmox Virtual Environment (Proxmox VE) v6.18.1 published on Tuesday, Jan 7, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

proxmoxve.Hardware/mapping.Pci

Explore with Pulumi AI

Proxmox Virtual Environment (Proxmox VE) v6.18.1 published on Tuesday, Jan 7, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

Manages a PCI hardware mapping in a Proxmox VE cluster.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.Hardware.Pci;
import com.pulumi.proxmoxve.Hardware.PciArgs;
import com.pulumi.proxmoxve.Hardware.inputs.PciMapArgs;
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) {
        var example = new Pci("example", PciArgs.builder()
            .comment("This is a comment")
            .maps(PciMapArgs.builder()
                .comment("This is a device specific comment")
                .id("8086:5916")
                .iommu_group(0)
                .node("pve")
                .path("0000:00:02.0")
                .subsystem_id("8086:2068")
                .build())
            .mediatedDevices(true)
            .build());

    }
}
Copy
resources:
  example:
    type: proxmoxve:Hardware/mapping:Pci
    properties:
      comment: This is a comment
      # The actual map of devices.
      maps:
        - comment: This is a device specific comment
          id: 8086:5916
          iommu_group: 0
          node: pve
          path: 0000:00:02.0
          subsystem_id: 8086:2068
      mediatedDevices: true
Copy

Create Pci Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Pci(name: string, args: PciArgs, opts?: CustomResourceOptions);
@overload
def Pci(resource_name: str,
        args: PciArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Pci(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        maps: Optional[Sequence[_hardware.mapping.PciMapArgs]] = None,
        comment: Optional[str] = None,
        mediated_devices: Optional[bool] = None,
        name: Optional[str] = None)
func NewPci(ctx *Context, name string, args PciArgs, opts ...ResourceOption) (*Pci, error)
public Pci(string name, PciArgs args, CustomResourceOptions? opts = null)
public Pci(String name, PciArgs args)
public Pci(String name, PciArgs args, CustomResourceOptions options)

type: proxmoxve:Hardware/mapping/pci:Pci
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PciArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PciArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PciArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PciArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PciArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Pci Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Pci resource accepts the following input properties:

Maps This property is required. List<Pulumi.ProxmoxVE.Hardware.Mapping.Inputs.PciMap>
The actual map of devices for the PCI hardware mapping.
Comment string
The comment of this PCI hardware mapping.
MediatedDevices bool
Indicates whether to enable mediated devices.
Name string
The name of this PCI hardware mapping.
Maps This property is required. []PciMapTypeArgs
The actual map of devices for the PCI hardware mapping.
Comment string
The comment of this PCI hardware mapping.
MediatedDevices bool
Indicates whether to enable mediated devices.
Name string
The name of this PCI hardware mapping.
maps This property is required. List<PciMap>
The actual map of devices for the PCI hardware mapping.
comment String
The comment of this PCI hardware mapping.
mediatedDevices Boolean
Indicates whether to enable mediated devices.
name String
The name of this PCI hardware mapping.
maps This property is required. PciMap[]
The actual map of devices for the PCI hardware mapping.
comment string
The comment of this PCI hardware mapping.
mediatedDevices boolean
Indicates whether to enable mediated devices.
name string
The name of this PCI hardware mapping.
maps This property is required. Sequence[hardware.mapping.PciMapArgs]
The actual map of devices for the PCI hardware mapping.
comment str
The comment of this PCI hardware mapping.
mediated_devices bool
Indicates whether to enable mediated devices.
name str
The name of this PCI hardware mapping.
maps This property is required. List<Property Map>
The actual map of devices for the PCI hardware mapping.
comment String
The comment of this PCI hardware mapping.
mediatedDevices Boolean
Indicates whether to enable mediated devices.
name String
The name of this PCI hardware mapping.

Outputs

All input properties are implicitly available as output properties. Additionally, the Pci resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Pci Resource

Get an existing Pci resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PciState, opts?: CustomResourceOptions): Pci
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        maps: Optional[Sequence[_hardware.mapping.PciMapArgs]] = None,
        mediated_devices: Optional[bool] = None,
        name: Optional[str] = None) -> Pci
func GetPci(ctx *Context, name string, id IDInput, state *PciState, opts ...ResourceOption) (*Pci, error)
public static Pci Get(string name, Input<string> id, PciState? state, CustomResourceOptions? opts = null)
public static Pci get(String name, Output<String> id, PciState state, CustomResourceOptions options)
resources:  _:    type: proxmoxve:Hardware/mapping/pci:Pci    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Comment string
The comment of this PCI hardware mapping.
Maps List<Pulumi.ProxmoxVE.Hardware.Mapping.Inputs.PciMap>
The actual map of devices for the PCI hardware mapping.
MediatedDevices bool
Indicates whether to enable mediated devices.
Name string
The name of this PCI hardware mapping.
Comment string
The comment of this PCI hardware mapping.
Maps []PciMapTypeArgs
The actual map of devices for the PCI hardware mapping.
MediatedDevices bool
Indicates whether to enable mediated devices.
Name string
The name of this PCI hardware mapping.
comment String
The comment of this PCI hardware mapping.
maps List<PciMap>
The actual map of devices for the PCI hardware mapping.
mediatedDevices Boolean
Indicates whether to enable mediated devices.
name String
The name of this PCI hardware mapping.
comment string
The comment of this PCI hardware mapping.
maps PciMap[]
The actual map of devices for the PCI hardware mapping.
mediatedDevices boolean
Indicates whether to enable mediated devices.
name string
The name of this PCI hardware mapping.
comment str
The comment of this PCI hardware mapping.
maps Sequence[hardware.mapping.PciMapArgs]
The actual map of devices for the PCI hardware mapping.
mediated_devices bool
Indicates whether to enable mediated devices.
name str
The name of this PCI hardware mapping.
comment String
The comment of this PCI hardware mapping.
maps List<Property Map>
The actual map of devices for the PCI hardware mapping.
mediatedDevices Boolean
Indicates whether to enable mediated devices.
name String
The name of this PCI hardware mapping.

Supporting Types

PciMap
, PciMapArgs

Id This property is required. string
The ID of the map.
Node This property is required. string
The node name of the map.
Path This property is required. string
The path of the map.
Comment string
The comment of the mapped PCI device.
IommuGroup int
The IOMMU group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
SubsystemId string
The subsystem ID group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
Id This property is required. string
The ID of the map.
Node This property is required. string
The node name of the map.
Path This property is required. string
The path of the map.
Comment string
The comment of the mapped PCI device.
IommuGroup int
The IOMMU group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
SubsystemId string
The subsystem ID group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
id This property is required. String
The ID of the map.
node This property is required. String
The node name of the map.
path This property is required. String
The path of the map.
comment String
The comment of the mapped PCI device.
iommuGroup Integer
The IOMMU group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
subsystemId String
The subsystem ID group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
id This property is required. string
The ID of the map.
node This property is required. string
The node name of the map.
path This property is required. string
The path of the map.
comment string
The comment of the mapped PCI device.
iommuGroup number
The IOMMU group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
subsystemId string
The subsystem ID group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
id This property is required. str
The ID of the map.
node This property is required. str
The node name of the map.
path This property is required. str
The path of the map.
comment str
The comment of the mapped PCI device.
iommu_group int
The IOMMU group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
subsystem_id str
The subsystem ID group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
id This property is required. String
The ID of the map.
node This property is required. String
The node name of the map.
path This property is required. String
The path of the map.
comment String
The comment of the mapped PCI device.
iommuGroup Number
The IOMMU group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set
subsystemId String
The subsystem ID group of the map. Not mandatory for the Proxmox VE API call, but causes a PCI hardware mapping to be incomplete when not set

Import

#!/usr/bin/env sh

A PCI hardware mapping can be imported using their name, e.g.:

$ pulumi import proxmoxve:Hardware/mapping/pci:Pci example example
Copy

To learn more about importing existing cloud resources, see Importing resources.

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) v6.18.1 published on Tuesday, Jan 7, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve