message
Class: message
An message for the attention of the administrator
| Published in: | XenServer 5.0 (orlando) | An message for the attention of the administrator | 
Enums
cls
| Values: | VM | VM | 
|  | Host | Host | 
|  | SR | SR | 
|  | Pool | Pool | 
|  | VMPP | VMPP | 
|  | VMSS | VMSS | 
|  | PVS_proxy | PVS_proxy | 
|  | VDI | VDI | 
|  | Certificate | Certificate | 
Fields
string
body
[RO/runtime]
The body of the message
| Published in: | XenServer 4.0 (rio) | The body of the message | 
enum cls
cls
[RO/runtime]
The class of the object this message is associated with
| Published in: | XenServer 5.0 (orlando) |  | 
| Extended in: | XAPI 1.313.0 (1.313.0) | Added Certificate class | 
string
name
[RO/runtime]
The name of the message
| Published in: | XenServer 4.0 (rio) | The name of the message | 
string
obj_uuid
[RO/runtime]
The uuid of the object this message is associated with
| Published in: | XenServer 4.0 (rio) | The uuid of the object this message is associated with | 
int
priority
[RO/runtime]
The message priority, 0 being low priority
| Published in: | XenServer 4.0 (rio) | The message priority, 0 being low priority | 
datetime
timestamp
[RO/runtime]
The time at which the message was created
| Published in: | XenServer 4.0 (rio) | The time at which the message was created | 
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference | 
Messages
message ref
create
(session ref, string, int, enum cls, string, string)
| 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) |  | 
void
destroy
(session ref, message ref)
| 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) |  | 
Prototype
void
destroy_many
(session ref, message ref set)
| Parameters: | session ref session_id | Reference to a valid session | 
|  | message ref set messages | Messages to destroy | 
| Minimum role: | pool-operator | 
| Prototyped in: | XAPI 22.19.0 (22.19.0) |  | 
(message ref → message record) map
get
(session ref, enum cls, string, datetime)
| Parameters: | session ref session_id | Reference to a valid session | 
|  | enum cls cls | The class of object | 
|  | string obj_uuid | The uuid of the object | 
|  | datetime since | The cutoff time | 
| Minimum role: | read-only | 
| Result: | The relevant messages | 
| Published in: | XenServer 5.0 (orlando) |  | 
message ref set
get_all
(session ref)
| Parameters: | session ref session_id | Reference to a valid session | 
| Minimum role: | read-only | 
| Result: | The references to the messages | 
| Published in: | XenServer 5.0 (orlando) |  | 
(message ref → message record) map
get_all_records
(session ref)
| Parameters: | session ref session_id | Reference to a valid session | 
| Minimum role: | read-only | 
| Result: | The messages | 
| Published in: | XenServer 5.0 (orlando) |  | 
(message ref → message record) map
get_all_records_where
(session ref, string)
| Parameters: | session ref session_id | Reference to a valid session | 
|  | string expr | The expression to match (not currently used) | 
| Minimum role: | read-only | 
| Result: | The messages | 
| Published in: | XenServer 5.0 (orlando) |  | 
message ref
get_by_uuid
(session ref, string)
| Parameters: | session ref session_id | Reference to a valid session | 
|  | string uuid | The uuid of the message | 
| Minimum role: | read-only | 
| Result: | The message reference | 
| Published in: | XenServer 5.0 (orlando) |  | 
message record
get_record
(session ref, message ref)
| Parameters: | session ref session_id | Reference to a valid session | 
|  | message ref self | The reference to the message | 
| Minimum role: | read-only | 
| Result: | The message record | 
| Published in: | XenServer 5.0 (orlando) |  | 
(message ref → message record) map
get_since
(session ref, datetime)
| Parameters: | session ref session_id | Reference to a valid session | 
|  | datetime since | The cutoff time | 
| Minimum role: | read-only | 
| Result: | The relevant messages | 
| Published in: | XenServer 5.0 (orlando) |  |