VIF_metrics
Removed
Class: VIF_metrics
The metrics associated with a virtual network device
| Published in: | XenServer 4.0 (rio) | The metrics associated with a virtual network device |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled in favour of RRDs |
Fields
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
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
Messages
void
add_to_other_config
(session ref, VIF_metrics ref, string, string)
Add the given key-value pair to the other_config field of the given VIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VIF_metrics ref self | reference to the object |
| string key | Key to add |
| string value | Value to add |
| Minimum role: | vm-admin |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
Removed
VIF_metrics ref set
get_all
(session ref)
Return a list of all the VIF_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 virtual network device |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled in favour of RRDs |
Removed
(VIF_metrics ref → VIF_metrics record) map
get_all_records
(session ref)
Return a map of VIF_metrics references to VIF_metrics records for all VIF_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 virtual network device |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled in favour of RRDs |
Removed
VIF_metrics ref
get_by_uuid
(session ref, string)
Get a reference to the VIF_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 virtual network device |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled in favour of RRDs |
Removed
float
get_io_read_kbs
(session ref, VIF_metrics ref)
Get the io/read_kbs field of the given VIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VIF_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, VIF_metrics ref)
Get the io/write_kbs field of the given VIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VIF_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, VIF_metrics ref)
Get the last_updated field of the given VIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VIF_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, VIF_metrics ref)
Get the other_config field of the given VIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VIF_metrics ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
Removed
VIF_metrics record
get_record
(session ref, VIF_metrics ref)
Get a record containing the current state of the given VIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VIF_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 virtual network device |
| Deprecated in: | XenServer 6.1 (tampa) | Dummy transition |
| Removed in: | XenServer 6.1 (tampa) | Disabled in favour of RRDs |
string
get_uuid
(session ref, VIF_metrics ref)
Get the uuid field of the given VIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VIF_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 |
void
remove_from_other_config
(session ref, VIF_metrics ref, string)
Remove the given key and its corresponding value from the other_config field of the given VIF_metrics. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| VIF_metrics ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | vm-admin |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
void
set_other_config
(session ref, VIF_metrics ref, (string → string) map)
Set the other_config field of the given VIF_metrics.
| Parameters: | session ref session_id | Reference to a valid session |
| VIF_metrics ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | vm-admin |
| Published in: | XenServer 5.0 (orlando) | additional configuration |