-
XenServer Software Development Kit
-
-
-
Class: host_metrics
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Class: host_metrics
The metrics associated with a host
Fields for class: host_metrics
| Field | Type | Qualifier | Description |
|---|---|---|---|
last_updated |
datetime |
RO/runtime | Time at which this information was last updated |
live |
bool |
RO/runtime | Pool master thinks this host is live |
memory_free |
int |
RO/runtime | Removed. Free host memory (bytes) |
memory_total |
int |
RO/runtime | Total host memory (bytes) |
other_config |
(string -> string) map |
RW | additional configuration |
uuid |
string |
RO/runtime | Unique identifier/object reference |
RPCs associated with class: host_metrics
RPC name: add_to_other_config
Overview:
Add the given key-value pair to the other_config field of the given host_metrics.
Signature:
void add_to_other_config (session ref session_ref, host_metrics ref self, string key, string value)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
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
Return Type: void
RPC name: get_all
Overview:
Return a list of all the host_metrics instances known to the system.
Signature:
host_metrics ref set get_all (session ref session_ref)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: read-only
Return Type: host_metrics ref set
references to all objects
RPC name: get_all_records
Overview:
Return a map of host_metrics references to host_metrics records for all host_metrics instances known to the system.
Signature:
(host_metrics ref -> host_metrics record) map get_all_records (session ref session_ref)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: read-only
Return Type: (host_metrics ref -> host_metrics record) map
records of all objects
RPC name: get_by_uuid
Overview:
Get a reference to the host_metrics instance with the specified UUID.
Signature:
host_metrics ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string |
uuid |
UUID of object to return |
Minimum Role: read-only
Return Type: host_metrics ref
reference to the object
RPC name: get_last_updated
Overview:
Get the last_updated field of the given host_metrics.
Signature:
datetime get_last_updated (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
host_metrics ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: datetime
value of the field
RPC name: get_live
Overview:
Get the live field of the given host_metrics.
Signature:
bool get_live (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
host_metrics ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: bool
value of the field
RPC name: get_memory_free
This message is removed.
Overview:
Get the memory/free field of the given host_metrics.
Signature:
int get_memory_free (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
host_metrics ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: int
value of the field
RPC name: get_memory_total
Overview:
Get the memory/total field of the given host_metrics.
Signature:
int get_memory_total (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
host_metrics ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: int
value of the field
RPC name: get_other_config
Overview:
Get the other_config field of the given host_metrics.
Signature:
(string -> string) map get_other_config (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
host_metrics ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: (string -> string) map
value of the field
RPC name: get_record
Overview:
Get a record containing the current state of the given host_metrics.
Signature:
host_metrics record get_record (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
host_metrics ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: host_metrics record
all fields from the object
RPC name: get_uuid
Overview:
Get the uuid field of the given host_metrics.
Signature:
string get_uuid (session ref session_ref, host_metrics ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
host_metrics ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
RPC name: remove_from_other_config
Overview:
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.
Signature:
void remove_from_other_config (session ref session_ref, host_metrics ref self, string key)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
host_metrics ref |
self |
reference to the object |
string |
key |
Key to remove |
Minimum Role: pool-operator
Return Type: void
RPC name: set_other_config
Overview:
Set the other_config field of the given host_metrics.
Signature:
void set_other_config (session ref session_ref, host_metrics ref self, (string -> string) map value)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
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
Return Type: void
Share
Share
In this article
- Fields for class: host_metrics
-
RPCs associated with class: host_metrics
- RPC name: add_to_other_config
- RPC name: get_all
- RPC name: get_all_records
- RPC name: get_by_uuid
- RPC name: get_last_updated
- RPC name: get_live
- RPC name: get_memory_free
- RPC name: get_memory_total
- RPC name: get_other_config
- RPC name: get_record
- RPC name: get_uuid
- RPC name: remove_from_other_config
- RPC name: set_other_config
This Preview product documentation is Cloud Software Group Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Cloud Software Group Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Cloud Software Group product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.