Get-XenPCIProperty

Last published : Nov 12, 2026
Gets a property of a PCI object.

Syntax

Get-XenPCIProperty [-PCI] <PCI>
    -XenProperty {Uuid | ClassId | ClassName | VendorId | VendorName | DeviceId | DeviceName | Host | PciId | Dependencies | OtherConfig | SubsystemVendorId | SubsystemVendorName | SubsystemDeviceId | SubsystemDeviceName | DriverName | Dom0AccessStatus}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Get-XenPCIProperty [-Ref] <XenRef[PCI]>
    -XenProperty {Uuid | ClassId | ClassName | VendorId | VendorName | DeviceId | DeviceName | Host | PciId | Dependencies | OtherConfig | SubsystemVendorId | SubsystemVendorName | SubsystemDeviceId | SubsystemDeviceName | DriverName | Dom0AccessStatus}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]

Description

Gets a specified property of a PCI object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given PCI.
ClassId: Get the class\_id field of the given PCI.
ClassName: Get the class\_name field of the given PCI.
VendorId: Get the vendor\_id field of the given PCI.
VendorName: Get the vendor\_name field of the given PCI.
DeviceId: Get the device\_id field of the given PCI.
DeviceName: Get the device\_name field of the given PCI.
Host: Get the host field of the given PCI.
PciId: Get the pci\_id field of the given PCI.
Dependencies: Get the dependencies field of the given PCI.
OtherConfig: Get the other\_config field of the given PCI.
SubsystemVendorId: Get the subsystem\_vendor\_id field of the given PCI.
SubsystemVendorName: Get the subsystem\_vendor\_name field of the given PCI.
SubsystemDeviceId: Get the subsystem\_device\_id field of the given PCI.
SubsystemDeviceName: Get the subsystem\_device\_name field of the given PCI.
DriverName: Get the driver\_name field of the given PCI.
Dom0AccessStatus: Return a PCI device dom0 access status.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-BestEffort

If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-PCI

The PCI object to operate on.
Attribute Value
Type PCI
Required True
Position 0
Accepts pipeline input True (ByValue)

-Ref

The PCI object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[PCI]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SessionOpaqueRef

The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-XenProperty

Selects which property to use.
Attribute Value
Type XenPCIProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, ClassId, ClassName, VendorId, VendorName, DeviceId, DeviceName, Host, PciId, Dependencies, OtherConfig, SubsystemVendorId, SubsystemVendorName, SubsystemDeviceId, SubsystemDeviceName, DriverName, Dom0AccessStatus

Inputs

  • PCI
  • XenRef[PCI]

Outputs

  • System.Object

Examples

Example 1: Get the ClassId property

PS> Get-XenPCI -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPCIProperty -XenProperty ClassId
Gets the ClassId property of a PCI.

Example 2: Get the ClassName property

PS> Get-XenPCI -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPCIProperty -XenProperty ClassName
Gets the ClassName property of a PCI.

Example 3: Get the VendorId property

PS> Get-XenPCI -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPCIProperty -XenProperty VendorId
Gets the VendorId property of a PCI.
  • Class: PCI
  • Using the XenServer PowerShell module