Class: PCI
A PCI device
| Published in: | XenServer 6.0 (boston) | |
Fields
string
class_name
[RO/constructor]
PCI class name
| Default value: | "" |
| Published in: | XenServer 6.0 (boston) | |
PCI ref set
dependencies
[RO/runtime]
List of dependent PCI devices
| Published in: | XenServer 6.0 (boston) | |
string
device_name
[RO/constructor]
Device name
| Default value: | "" |
| Published in: | XenServer 6.0 (boston) | |
string
driver_name
[RO/constructor]
Driver name
| Default value: | "" |
| Published in: | XenServer 7.5 (kolkata) | |
host ref
host
[RO/constructor]
Physical machine that owns the PCI device
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 6.0 (boston) | |
(string → string) map
other_config
[RW]
Additional configuration
| Default value: | {} |
| Published in: | XenServer 6.0 (boston) | |
string
pci_id
[RO/constructor]
PCI ID of the physical device
| Default value: | "" |
| Published in: | XenServer 6.0 (boston) | |
string
subsystem_device_name
[RO/constructor]
Subsystem device name
| Default value: | "" |
| Published in: | XenServer 6.2 SP1 Hotfix 11 (clearwater-whetstone) | |
string
subsystem_vendor_name
[RO/constructor]
Subsystem vendor name
| Default value: | "" |
| Published in: | XenServer 6.2 SP1 Hotfix 11 (clearwater-whetstone) | |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 6.0 (boston) | |
string
vendor_name
[RO/constructor]
Vendor name
| Default value: | "" |
| Published in: | XenServer 6.0 (boston) | |
Messages
void
add_to_other_config
(session ref, PCI ref, string, string)
Add the given key-value pair to the other_config field of the given PCI.
| Parameters: | session ref session_id | 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 |
| Published in: | XenServer 6.0 (boston) | |
PCI ref set
get_all
(session ref)
Return a list of all the PCIs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | references to all objects |
| Published in: | XenServer 6.0 (boston) | |
(PCI ref → PCI record) map
get_all_records
(session ref)
Return a map of PCI references to PCI records for all PCIs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | records of all objects |
| Published in: | XenServer 6.0 (boston) | |
PCI ref
get_by_uuid
(session ref, string)
Get a reference to the PCI instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return |
| Minimum role: | read-only |
| Result: | reference to the object |
| Published in: | XenServer 6.0 (boston) | |
string
get_class_name
(session ref, PCI ref)
Get the class_name field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
PCI ref set
get_dependencies
(session ref, PCI ref)
Get the dependencies field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
string
get_device_name
(session ref, PCI ref)
Get the device_name field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
string
get_driver_name
(session ref, PCI ref)
Get the driver_name field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.5 (kolkata) | |
host ref
get_host
(session ref, PCI ref)
Get the host field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
(string → string) map
get_other_config
(session ref, PCI ref)
Get the other_config field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
string
get_pci_id
(session ref, PCI ref)
Get the pci_id field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
PCI record
get_record
(session ref, PCI ref)
Get a record containing the current state of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 6.0 (boston) | |
string
get_subsystem_device_name
(session ref, PCI ref)
Get the subsystem_device_name field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Hotfix 11 (clearwater-whetstone) | |
string
get_subsystem_vendor_name
(session ref, PCI ref)
Get the subsystem_vendor_name field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Hotfix 11 (clearwater-whetstone) | |
string
get_uuid
(session ref, PCI ref)
Get the uuid field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
string
get_vendor_name
(session ref, PCI ref)
Get the vendor_name field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
void
remove_from_other_config
(session ref, PCI ref, string)
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.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |
void
set_other_config
(session ref, PCI ref, (string → string) map)
Set the other_config field of the given PCI.
| Parameters: | session ref session_id | Reference to a valid session |
| PCI ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |