Class: PUSB
A physical USB device
| Published in: | XenServer 7.3 (inverness) | |
Fields
string
description
[RO/constructor]
USB device description
| Default value: | "" |
| Published in: | XenServer 7.3 (inverness) | |
host ref
host
[RO/constructor]
Physical machine that owns the USB device
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 7.3 (inverness) | |
(string → string) map
other_config
[RW]
additional configuration
| Default value: | {} |
| Published in: | XenServer 7.3 (inverness) | |
bool
passthrough_enabled
[RO/runtime]
enabled for passthrough
| Default value: | false |
| Published in: | XenServer 7.3 (inverness) | |
string
path
[RO/constructor]
port path of USB device
| Default value: | "" |
| Published in: | XenServer 7.3 (inverness) | |
string
product_desc
[RO/constructor]
product description of the USB device
| Default value: | "" |
| Published in: | XenServer 7.3 (inverness) | |
string
product_id
[RO/constructor]
product id of the USB device
| Default value: | "" |
| Published in: | XenServer 7.3 (inverness) | |
string
serial
[RO/constructor]
serial of the USB device
| Default value: | "" |
| Published in: | XenServer 7.3 (inverness) | |
float
speed
[RO/constructor]
USB device speed
| Default value: | -1. |
| Published in: | Citrix Hypervisor 8.2 (stockholm) | |
USB_group ref
USB_group
[RO/constructor]
USB group the PUSB is contained in
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 7.3 (inverness) | |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 7.3 (inverness) | |
string
vendor_desc
[RO/constructor]
vendor description of the USB device
| Default value: | "" |
| Published in: | XenServer 7.3 (inverness) | |
string
vendor_id
[RO/constructor]
vendor id of the USB device
| Default value: | "" |
| Published in: | XenServer 7.3 (inverness) | |
string
version
[RO/constructor]
USB device version
| Default value: | "" |
| Published in: | XenServer 7.3 (inverness) | |
Messages
void
add_to_other_config
(session ref, PUSB ref, string, string)
Add the given key-value pair to the other_config field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| string key | Key to add |
| string value | Value to add |
| Minimum role: | pool-admin |
| Published in: | XenServer 7.3 (inverness) | |
PUSB ref set
get_all
(session ref)
Return a list of all the PUSBs 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 7.3 (inverness) | |
(PUSB ref → PUSB record) map
get_all_records
(session ref)
Return a map of PUSB references to PUSB records for all PUSBs 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 7.3 (inverness) | |
PUSB ref
get_by_uuid
(session ref, string)
Get a reference to the PUSB 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 7.3 (inverness) | |
string
get_description
(session ref, PUSB ref)
Get the description field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
host ref
get_host
(session ref, PUSB ref)
Get the host field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
(string → string) map
get_other_config
(session ref, PUSB ref)
Get the other_config field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
bool
get_passthrough_enabled
(session ref, PUSB ref)
Get the passthrough_enabled field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
string
get_path
(session ref, PUSB ref)
Get the path field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
string
get_product_desc
(session ref, PUSB ref)
Get the product_desc field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
string
get_product_id
(session ref, PUSB ref)
Get the product_id field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
PUSB record
get_record
(session ref, PUSB ref)
Get a record containing the current state of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 7.3 (inverness) | |
string
get_serial
(session ref, PUSB ref)
Get the serial field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
float
get_speed
(session ref, PUSB ref)
Get the speed field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | Citrix Hypervisor 8.2 (stockholm) | |
USB_group ref
get_USB_group
(session ref, PUSB ref)
Get the USB_group field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
string
get_uuid
(session ref, PUSB ref)
Get the uuid field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
string
get_vendor_desc
(session ref, PUSB ref)
Get the vendor_desc field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
string
get_vendor_id
(session ref, PUSB ref)
Get the vendor_id field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
string
get_version
(session ref, PUSB ref)
Get the version field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.3 (inverness) | |
void
remove_from_other_config
(session ref, PUSB ref, string)
Remove the given key and its corresponding value from the other_config field of the given PUSB. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-admin |
| Published in: | XenServer 7.3 (inverness) | |
void
scan
(session ref, host ref)
| Parameters: | session ref session_id | Reference to a valid session |
| host ref host | The host |
| Minimum role: | pool-admin |
| Published in: | XenServer 7.3 (inverness) | |
void
set_other_config
(session ref, PUSB ref, (string → string) map)
Set the other_config field of the given PUSB.
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-admin |
| Published in: | XenServer 7.3 (inverness) | |
void
set_passthrough_enabled
(session ref, PUSB ref, bool)
| Parameters: | session ref session_id | Reference to a valid session |
| PUSB ref self | this PUSB |
| bool value | passthrough is enabled when true and disabled with false |
| Minimum role: | pool-admin |
| Published in: | XenServer 7.3 (inverness) | |