Class: PCI

Last published : Oct 01, 2026
A PCI device
Related information
XenServer 9 Management API

Fields for class: PCI

Field Type Qualifier Description
class_id string RO/constructor PCI class ID
class_name string RO/constructor PCI class name
dependencies PCI ref set RO/runtime List of dependent PCI devices
device_id string RO/constructor Device ID
device_name string RO/constructor Device name
driver_name string RO/constructor Driver name
host host ref RO/constructor Physical machine that owns the PCI device
other_config (string -> string) map RW Additional configuration
pci_id string RO/constructor PCI ID of the physical device
subsystem_device_id string RO/constructor Subsystem device ID
subsystem_device_name string RO/constructor Subsystem device name
subsystem_vendor_id string RO/constructor Subsystem vendor ID
subsystem_vendor_name string RO/constructor Subsystem vendor name
uuid string RO/runtime Unique identifier/object reference
vendor_id string RO/constructor Vendor ID
vendor_name string RO/constructor Vendor name

RPCs associated with class: PCI

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given PCI.
Signature:
void add_to_other_config (session ref session_ref, PCI ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: pool-operator
Return Type: void

RPC name: disabledom0access

Overview:
Hide a PCI device from the dom0 kernel. Takes affect after next boot.
Signature:
pci_dom0_access disable_dom0_access (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self The PCI to hide
Minimum Role: pool-operator
Return Type: pci_dom0_access
The accessibility of this PCI from dom0

RPC name: enabledom0access

Overview:
Unhide a PCI device from the dom0 kernel. Takes affect after next boot.
Signature:
pci_dom0_access enable_dom0_access (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self The PCI to unhide
Minimum Role: pool-operator
Return Type: pci_dom0_access
The accessibility of this PCI from dom0

RPC name: getall

Overview:
Return a list of all the PCIs known to the system.
Signature:
PCI ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: PCI ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of PCI references to PCI records for all PCIs known to the system.
Signature:
(PCI ref -> PCI record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (PCI ref -> PCI record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the PCI instance with the specified UUID.
Signature:
PCI ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return
Minimum Role: read-only
Return Type: PCI ref
reference to the object

RPC name: getclassid

Overview:
Get the classid field of the given PCI.
Signature:
string get_class_id (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getclassname

Overview:
Get the classname field of the given PCI.
Signature:
string get_class_name (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getdependencies

Overview:
Get the dependencies field of the given PCI.
Signature:
PCI ref set get_dependencies (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: PCI ref set
value of the field

RPC name: getdeviceid

Overview:
Get the deviceid field of the given PCI.
Signature:
string get_device_id (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getdevicename

Overview:
Get the devicename field of the given PCI.
Signature:
string get_device_name (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getdom0accessstatus

Overview:
Return a PCI device dom0 access status.
Signature:
pci_dom0_access get_dom0_access_status (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self The PCI
Minimum Role: pool-operator
Return Type: pci_dom0_access
The accessibility of this PCI from dom0

RPC name: getdrivername

Overview:
Get the drivername field of the given PCI.
Signature:
string get_driver_name (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: gethost

Overview:
Get the host field of the given PCI.
Signature:
host ref get_host (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: host ref
value of the field

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given PCI.
Signature:
(string -> string) map get_other_config (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getpciid

Overview:
Get the pciid field of the given PCI.
Signature:
string get_pci_id (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given PCI.
Signature:
PCI record get_record (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: PCI record
all fields from the object

RPC name: getsubsystemdeviceid

Overview:
Get the subsystemdeviceid field of the given PCI.
Signature:
string get_subsystem_device_id (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getsubsystemdevicename

Overview:
Get the subsystemdevicename field of the given PCI.
Signature:
string get_subsystem_device_name (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getsubsystemvendorid

Overview:
Get the subsystemvendorid field of the given PCI.
Signature:
string get_subsystem_vendor_id (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getsubsystemvendorname

Overview:
Get the subsystemvendorname field of the given PCI.
Signature:
string get_subsystem_vendor_name (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getuuid

Overview:
Get the uuid field of the given PCI.
Signature:
string get_uuid (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getvendorid

Overview:
Get the vendorid field of the given PCI.
Signature:
string get_vendor_id (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getvendorname

Overview:
Get the vendorname field of the given PCI.
Signature:
string get_vendor_name (session ref session_ref, PCI ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given PCI. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, PCI ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
string key Key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: setotherconfig

Overview:
Set the otherconfig field of the given PCI.
Signature:
void set_other_config (session ref session_ref, PCI ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PCI ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void