Deprecated
Class: host_cpu
A physical CPU
| Published in: | XenServer 4.0 (rio) | A physical CPU |
| Deprecated in: | XenServer 5.6 (midnight-ride) | Deprecated in favour of the Host.cpu_info field |
Fields
int
family
[RO/runtime]
the family (number) of the physical CPU
| Published in: | XenServer 4.0 (rio) | the family (number) of the physical CPU |
string
features
[RO/runtime]
the physical CPU feature bitmap
| Published in: | XenServer 4.0 (rio) | the physical CPU feature bitmap |
string
flags
[RO/runtime]
the flags of the physical CPU (a decoded version of the features field)
| Published in: | XenServer 4.0 (rio) | the flags of the physical CPU (a decoded version of the features field) |
host ref
host
[RO/runtime]
the host the CPU is in
| Published in: | XenServer 4.0 (rio) | the host the CPU is in |
int
model
[RO/runtime]
the model number of the physical CPU
| Published in: | XenServer 4.0 (rio) | the model number of the physical CPU |
string
modelname
[RO/runtime]
the model name of the physical CPU
| Published in: | XenServer 4.0 (rio) | the model name of the physical CPU |
int
number
[RO/runtime]
the number of the physical CPU within the host
| Published in: | XenServer 4.0 (rio) | the number of the physical CPU within the host |
(string → string) map
other_config
[RW]
additional configuration
| Default value: | {} |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
int
speed
[RO/runtime]
the speed of the physical CPU
| Published in: | XenServer 4.0 (rio) | the speed of the physical CPU |
string
stepping
[RO/runtime]
the stepping of the physical CPU
| Published in: | XenServer 4.0 (rio) | the stepping of the physical CPU |
float
utilisation
[RO/runtime]
the current CPU utilisation
| Published in: | XenServer 4.0 (rio) | the current CPU utilisation |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
string
vendor
[RO/runtime]
the vendor of the physical CPU
| Published in: | XenServer 4.0 (rio) | the vendor of the physical CPU |
Messages
void
add_to_other_config
(session ref, host_cpu ref, string, string)
Add the given key-value pair to the other_config field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu 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 |
Deprecated
host_cpu ref set
get_all
(session ref)
Return a list of all the host_cpus 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) | A physical CPU |
| Deprecated in: | XenServer 5.6 (midnight-ride) | Deprecated in favour of the Host.cpu_info field |
Deprecated
(host_cpu ref → host_cpu record) map
get_all_records
(session ref)
Return a map of host_cpu references to host_cpu records for all host_cpus 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) | A physical CPU |
| Deprecated in: | XenServer 5.6 (midnight-ride) | Deprecated in favour of the Host.cpu_info field |
Deprecated
host_cpu ref
get_by_uuid
(session ref, string)
Get a reference to the host_cpu 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) | A physical CPU |
| Deprecated in: | XenServer 5.6 (midnight-ride) | Deprecated in favour of the Host.cpu_info field |
int
get_family
(session ref, host_cpu ref)
Get the family field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the family (number) of the physical CPU |
string
get_features
(session ref, host_cpu ref)
Get the features field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the physical CPU feature bitmap |
string
get_flags
(session ref, host_cpu ref)
Get the flags field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the flags of the physical CPU (a decoded version of the features field) |
host ref
get_host
(session ref, host_cpu ref)
Get the host field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the host the CPU is in |
int
get_model
(session ref, host_cpu ref)
Get the model field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the model number of the physical CPU |
string
get_modelname
(session ref, host_cpu ref)
Get the modelname field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the model name of the physical CPU |
int
get_number
(session ref, host_cpu ref)
Get the number field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the number of the physical CPU within the host |
(string → string) map
get_other_config
(session ref, host_cpu ref)
Get the other_config field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
Deprecated
host_cpu record
get_record
(session ref, host_cpu ref)
Get a record containing the current state of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 4.0 (rio) | A physical CPU |
| Deprecated in: | XenServer 5.6 (midnight-ride) | Deprecated in favour of the Host.cpu_info field |
int
get_speed
(session ref, host_cpu ref)
Get the speed field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the speed of the physical CPU |
string
get_stepping
(session ref, host_cpu ref)
Get the stepping field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the stepping of the physical CPU |
float
get_utilisation
(session ref, host_cpu ref)
Get the utilisation field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the current CPU utilisation |
string
get_uuid
(session ref, host_cpu ref)
Get the uuid field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu 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
(session ref, host_cpu ref)
Get the vendor field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the vendor of the physical CPU |
void
remove_from_other_config
(session ref, host_cpu ref, string)
Remove the given key and its corresponding value from the other_config field of the given host_cpu. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu 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_cpu ref, (string → string) map)
Set the other_config field of the given host_cpu.
| Parameters: | session ref session_id | Reference to a valid session |
| host_cpu 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 |