Product documentation
Develop for XenServer®
XenServer 9 preview XenServer 8.4
View PDF

Class: message

June 8, 2026
Contributed by: 
X

An message for the attention of the administrator

Fields for class: message

Field Type Qualifier Description
body string RO/runtime The body of the message
cls cls RO/runtime The class of the object this message is associated with
name string RO/runtime The name of the message
obj_uuid string RO/runtime The uuid of the object this message is associated with
priority int RO/runtime The message priority, 0 being low priority
timestamp datetime RO/runtime The time at which the message was created
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: message

RPC name: create

Overview:

Signature:

message ref create (session ref session_ref, string name, int priority, cls cls, string obj_uuid, string body)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
string name The name of the message
int priority The priority of the message
cls cls The class of object this message is associated with
string obj_uuid The uuid of the object this message is associated with
string body The body of the message

Minimum Role: pool-operator

Return Type: message ref

The reference of the created message

RPC name: destroy

Overview:

Signature:

void destroy (session ref session_ref, message ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
message ref self The reference of the message to destroy

Minimum Role: pool-operator

Return Type: void

RPC name: destroy_all

Overview:

Signature:

void destroy_all (session ref session_ref, (string -> string) map filters)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
(string -> string) map filters Optional filters identifying messages to destroy: before (RFC3339 DateTime, destroy messages dated before this timestamp), after (RFC3339 DateTime, destroy messages dated after this timestamp), and priority (int, only destroy messages with this priority). All provided conditions must be met (logical AND). If no filters are provided, all messages are destroyed. If no timezone is specified in a timestamp, UTC is assumed.

Minimum Role: pool-operator

Return Type: void

RPC name: destroy_many

Overview:

Signature:

void destroy_many (session ref session_ref, message ref set messages)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
message ref set messages Messages to destroy

Minimum Role: pool-operator

Return Type: void

RPC name: get

Overview:

Signature:

(message ref -> message record) map get (session ref session_ref, cls cls, string obj_uuid, datetime since)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
cls cls The class of object
string obj_uuid The uuid of the object
datetime since The cutoff time. When the timezone is missing, UTC is assumed

Minimum Role: read-only

Return Type: (message ref -> message record) map

The relevant messages

RPC name: get_all

Overview:

Signature:

message 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: message ref set

The references to the messages

RPC name: get_all_records

Overview:

Signature:

(message ref -> message 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: (message ref -> message record) map

The messages

RPC name: get_all_records_where

Overview:

Signature:

(message ref -> message record) map get_all_records_where (session ref session_ref, string expr)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
string expr The expression to match

Minimum Role: read-only

Return Type: (message ref -> message record) map

The messages

RPC name: get_by_uuid

Overview:

Signature:

message 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 The uuid of the message

Minimum Role: read-only

Return Type: message ref

The message reference

RPC name: get_record

Overview:

Signature:

message record get_record (session ref session_ref, message ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
message ref self The reference to the message

Minimum Role: read-only

Return Type: message record

The message record

RPC name: get_since

Overview:

Signature:

(message ref -> message record) map get_since (session ref session_ref, datetime since)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
datetime since The cutoff time. When the timezone is missing, UTC is assumed

Minimum Role: read-only

Return Type: (message ref -> message record) map

The relevant messages

Class: message
June 8, 2026
Contributed by: 
X
June 8, 2026
Contributed by: 
X

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.