Xapi Project Docs

Class: message

An message for the attention of the administrator

cls

string body [RO/runtime]

enum cls cls [RO/runtime]

string name [RO/runtime]

string obj_uuid [RO/runtime]

int priority [RO/runtime]

datetime timestamp [RO/runtime]

string uuid [RO/runtime]

message ref create (session ref, string, int, enum cls, string, string)

void destroy (session ref, message ref)

Prototype

void destroy_all (session ref, (string → string) map)

Prototype

void destroy_many (session ref, message ref set)

(message ref → message record) map get (session ref, enum cls, string, datetime)

message ref set get_all (session ref)

(message ref → message record) map get_all_records (session ref)

(message ref → message record) map get_all_records_where (session ref, string)

message ref get_by_uuid (session ref, string)

message record get_record (session ref, message ref)

(message ref → message record) map get_since (session ref, datetime)

Published in:	XenServer 5.0 (orlando)
Extended in:	XAPI 1.313.0 (1.313.0)	Added Certificate class

Parameters:	session ref session_id	Reference to a valid session
	string name	The name of the message
	int priority	The priority of the message
	enum 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
Result:	The reference of the created message
Published in:	XenServer 5.0 (orlando)

Parameters:	session ref session_id	Reference to a valid session
	message ref self	The reference of the message to destroy
Minimum role:	pool-operator
Published in:	XenServer 5.0 (orlando)

Parameters:	session ref session_id	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
Prototyped in:	(26.5.0-next)