Class: message

Last published : Oct 01, 2026
An message for the attention of the administrator
Related information
XenServer 8.4 Management API

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)
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)
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: destroymany

Overview:
Signature:
void destroy_many (session ref session_ref, message ref set messages)
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)
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: getall

Overview:
Signature:
message ref set get_all (session ref session_ref)
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: getallrecords

Overview:
Signature:
(message ref -> message record) map get_all_records (session ref session_ref)
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: getallrecordswhere

Overview:
Signature:
(message ref -> message record) map get_all_records_where (session ref session_ref, string expr)
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: getbyuuid

Overview:
Signature:
message ref get_by_uuid (session ref session_ref, string uuid)
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: getrecord

Overview:
Signature:
message record get_record (session ref session_ref, message ref self)
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: getsince

Overview:
Signature:
(message ref -> message record) map get_since (session ref session_ref, datetime since)
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