Class: host_metrics
The metrics associated with a host
Published in: XenServer 4.0 (rio)
The metrics associated with a host
Fields
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
bool
live
[RO/runtime]
Pool master thinks this host is live
Published in: XenServer 4.0 (rio)
Pool master thinks this host is live
Removed
int
memory_free
[RO/runtime]
Free host memory (bytes)
Default value: 0
Published in: XenServer 4.0 (rio)
Deprecated in: XenServer 5.6 (midnight-ride)
Will be disabled in favour of RRD
Removed in: XenServer 6.1 (tampa)
Disabled in favour of RRD
int
memory_total
[RO/runtime]
Total host memory (bytes)
Published in: XenServer 4.0 (rio)
Total host memory (bytes)
(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
Hide implicit
void
add_to_other_config
(session ref, host_metrics ref, string, string)
Add the given key-value pair to the other_config field of the given host_metrics.
Parameters: session ref session_id
Reference to a valid session
host_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
host_metrics ref set
get_all
(session ref)
Return a list of all the host_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 host
(host_metrics ref → host_metrics record) map
get_all_records
(session ref)
Return a map of host_metrics references to host_metrics records for all host_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 host
host_metrics ref
get_by_uuid
(session ref, string)
Get a reference to the host_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 host
datetime
get_last_updated
(session ref, host_metrics ref)
Get the last_updated field of the given host_metrics.
Parameters: session ref session_id
Reference to a valid session
host_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
bool
get_live
(session ref, host_metrics ref)
Get the live field of the given host_metrics.
Parameters: session ref session_id
Reference to a valid session
host_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
Pool master thinks this host is live
Removed
int
get_memory_free
(session ref, host_metrics ref)
Get the memory/free field of the given host_metrics.
Parameters: session ref session_id
Reference to a valid session
host_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 5.6 (midnight-ride)
Will be disabled in favour of RRD
Removed in: XenServer 6.1 (tampa)
Disabled in favour of RRD
int
get_memory_total
(session ref, host_metrics ref)
Get the memory/total field of the given host_metrics.
Parameters: session ref session_id
Reference to a valid session
host_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
Total host memory (bytes)
(string → string) map
get_other_config
(session ref, host_metrics ref)
Get the other_config field of the given host_metrics.
Parameters: session ref session_id
Reference to a valid session
host_metrics ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 5.0 (orlando)
additional configuration
host_metrics record
get_record
(session ref, host_metrics ref)
Get a record containing the current state of the given host_metrics.
Parameters: session ref session_id
Reference to a valid session
host_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 host
string
get_uuid
(session ref, host_metrics ref)
Get the uuid field of the given host_metrics.
Parameters: session ref session_id
Reference to a valid session
host_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, host_metrics ref, string)
Remove the given key and its corresponding value from the other_config field of the given host_metrics. If the key is not in that Map, then do nothing.
Parameters: session ref session_id
Reference to a valid session
host_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, host_metrics ref, (string → string) map)
Set the other_config field of the given host_metrics.
Parameters: session ref session_id
Reference to a valid session
host_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
