Develop for XenServer

Class: PCI

June 19, 2024

Contributed by:

X X

A PCI device

Fields for class: PCI

Field	Type	Qualifier	Description
`class_name`	`string`	RO/constructor	PCI class name
`dependencies`	`PCI ref set`	RO/runtime	List of dependent PCI devices
`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_name`	`string`	RO/constructor	Subsystem device name
`subsystem_vendor_name`	`string`	RO/constructor	Subsystem vendor name
`uuid`	`string`	RO/runtime	Unique identifier/object reference
`vendor_name`	`string`	RO/constructor	Vendor name

RPCs associated with class: PCI

RPC name: add_to_other_config

Overview:

Add the given key-value pair to the other_config field of the given PCI.

Signature:

void add_to_other_config (session ref session_ref, PCI ref self, string key, string value)
<!--NeedCopy-->

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: disable_dom0_access

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)
<!--NeedCopy-->

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: enable_dom0_access

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)
<!--NeedCopy-->

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: get_all

Overview:

Return a list of all the PCIs known to the system.

Signature:

PCI ref set get_all (session ref session_ref)
<!--NeedCopy-->

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: get_all_records

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)
<!--NeedCopy-->

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: get_by_uuid

Overview:

Get a reference to the PCI instance with the specified UUID.

Signature:

PCI ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

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: get_class_name

Overview:

Get the class_name field of the given PCI.

Signature:

string get_class_name (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_dependencies

Overview:

Get the dependencies field of the given PCI.

Signature:

PCI ref set get_dependencies (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_device_name

Overview:

Get the device_name field of the given PCI.

Signature:

string get_device_name (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_dom0_access_status

Overview:

Return a PCI device dom0 access status.

Signature:

pci_dom0_access get_dom0_access_status (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_driver_name

Overview:

Get the driver_name field of the given PCI.

Signature:

string get_driver_name (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_host

Overview:

Get the host field of the given PCI.

Signature:

host ref get_host (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_other_config

Overview:

Get the other_config field of the given PCI.

Signature:

(string -> string) map get_other_config (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_pci_id

Overview:

Get the pci_id field of the given PCI.

Signature:

string get_pci_id (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_record

Overview:

Get a record containing the current state of the given PCI.

Signature:

PCI record get_record (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_subsystem_device_name

Overview:

Get the subsystem_device_name field of the given PCI.

Signature:

string get_subsystem_device_name (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_subsystem_vendor_name

Overview:

Get the subsystem_vendor_name field of the given PCI.

Signature:

string get_subsystem_vendor_name (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_uuid

Overview:

Get the uuid field of the given PCI.

Signature:

string get_uuid (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: get_vendor_name

Overview:

Get the vendor_name field of the given PCI.

Signature:

string get_vendor_name (session ref session_ref, PCI ref self)
<!--NeedCopy-->

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: remove_from_other_config

Overview:

Remove the given key and its corresponding value from the other_config 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)
<!--NeedCopy-->

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: set_other_config

Overview:

Set the other_config field of the given PCI.

Signature:

void set_other_config (session ref session_ref, PCI ref self, (string -> string) map value)
<!--NeedCopy-->

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: PCI

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Class: PCI

Fields for class: PCI

RPCs associated with class: PCI

RPC name: add_to_other_config

RPC name: disable_dom0_access

RPC name: enable_dom0_access

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_class_name

RPC name: get_dependencies

RPC name: get_device_name

RPC name: get_dom0_access_status

RPC name: get_driver_name

RPC name: get_host

RPC name: get_other_config

RPC name: get_pci_id

RPC name: get_record

RPC name: get_subsystem_device_name

RPC name: get_subsystem_vendor_name

RPC name: get_uuid

RPC name: get_vendor_name

RPC name: remove_from_other_config

RPC name: set_other_config

In this article