Class: PIF_metrics
The metrics associated with a physical network interface
| Published in: | XenServer 4.0 (rio) | The metrics associated with a physical network interface |
Fields
bool
carrier
[RO/runtime]
Report if the PIF got a carrier or not
| Published in: | XenServer 4.0 (rio) | Report if the PIF got a carrier or not |
string
device_id
[RO/runtime]
Report device ID
| Published in: | XenServer 4.0 (rio) | Report device ID |
string
device_name
[RO/runtime]
Report device name
| Published in: | XenServer 4.0 (rio) | Report device name |
bool
duplex
[RO/runtime]
Full duplex capability of the link (if available)
| Published in: | XenServer 4.0 (rio) | Full duplex capability of the link (if available) |
Removed
float
io_read_kbs
[RO/runtime]
Read bandwidth (KiB/s)
| Default value: | 0. |
| Published in: | XenServer 4.0 (rio) | |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled and replaced by RRDs |
Removed
float
io_write_kbs
[RO/runtime]
Write bandwidth (KiB/s)
| Default value: | 0. |
| Published in: | XenServer 4.0 (rio) | |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled and replaced by RRDs |
datetime
last_updated
[RO/runtime]
Time at which this information was last updated
| Published in: | XenServer 4.0 (rio) | Time at which this information was last updated |
(string → string) map
other_config
[RW]
additional configuration
| Default value: | {} |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
string
pci_bus_path
[RO/runtime]
PCI bus path of the pif (if available)
| Published in: | XenServer 4.0 (rio) | PCI bus path of the pif (if available) |
int
speed
[RO/runtime]
Speed of the link in Mbit/s (if available)
| Published in: | XenServer 4.0 (rio) | Speed of the link in Mbit/s (if available) |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
string
vendor_id
[RO/runtime]
Report vendor ID
| Published in: | XenServer 4.0 (rio) | Report vendor ID |
string
vendor_name
[RO/runtime]
Report vendor name
| Published in: | XenServer 4.0 (rio) | Report vendor name |
Messages
void
add_to_other_config
(session ref, PIF_metrics ref, string, string)
Add the given key-value pair to the other_config field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| string key | Key to add |
| string value | Value to add |
| Minimum role: | pool-operator |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
PIF_metrics ref set
get_all
(session ref)
Return a list of all the PIF_metrics instances 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 4.0 (rio) | The metrics associated with a physical network interface |
(PIF_metrics ref → PIF_metrics record) map
get_all_records
(session ref)
Return a map of PIF_metrics references to PIF_metrics records for all PIF_metrics instances 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 4.0 (rio) | The metrics associated with a physical network interface |
PIF_metrics ref
get_by_uuid
(session ref, string)
Get a reference to the PIF_metrics 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 4.0 (rio) | The metrics associated with a physical network interface |
bool
get_carrier
(session ref, PIF_metrics ref)
Get the carrier field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Report if the PIF got a carrier or not |
string
get_device_id
(session ref, PIF_metrics ref)
Get the device_id field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Report device ID |
string
get_device_name
(session ref, PIF_metrics ref)
Get the device_name field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Report device name |
bool
get_duplex
(session ref, PIF_metrics ref)
Get the duplex field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Full duplex capability of the link (if available) |
Removed
float
get_io_read_kbs
(session ref, PIF_metrics ref)
Get the io/read_kbs field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled and replaced by RRDs |
Removed
float
get_io_write_kbs
(session ref, PIF_metrics ref)
Get the io/write_kbs field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled and replaced by RRDs |
datetime
get_last_updated
(session ref, PIF_metrics ref)
Get the last_updated field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Time at which this information was last updated |
(string → string) map
get_other_config
(session ref, PIF_metrics ref)
Get the other_config field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
string
get_pci_bus_path
(session ref, PIF_metrics ref)
Get the pci_bus_path field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | PCI bus path of the pif (if available) |
PIF_metrics record
get_record
(session ref, PIF_metrics ref)
Get a record containing the current state of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 4.0 (rio) | The metrics associated with a physical network interface |
int
get_speed
(session ref, PIF_metrics ref)
Get the speed field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Speed of the link in Mbit/s (if available) |
string
get_uuid
(session ref, PIF_metrics ref)
Get the uuid field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
string
get_vendor_id
(session ref, PIF_metrics ref)
Get the vendor_id field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Report vendor ID |
string
get_vendor_name
(session ref, PIF_metrics ref)
Get the vendor_name field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Report vendor name |
void
remove_from_other_config
(session ref, PIF_metrics ref, string)
Remove the given key and its corresponding value from the other_config field of the given PIF_metrics. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-operator |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
void
set_other_config
(session ref, PIF_metrics ref, (string → string) map)
Set the other_config field of the given PIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF_metrics ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 5.0 (orlando) | additional configuration |