Class: poolupdate

Last published : Oct 01, 2026
Poolwide updates to the host software
Related information
XenServer 8.4 Management API

Fields for class: poolupdate

Field Type Qualifier Description
after_apply_guidance update_after_apply_guidance set RO/constructor What the client should do after this update has been applied.
enforce_homogeneity bool RO/constructor Flag - if true, all hosts in a pool must apply this update
hosts host ref set RO/runtime The hosts that have applied this update.
installation_size int RO/constructor Size of the update in bytes
key string RO/constructor GPG key of the update
name_description string RO/constructor a notes field containing human-readable description
name_label string RO/constructor a human-readable name
other_config (string -> string) map RW additional configuration
uuid string RO/runtime Unique identifier/object reference
vdi VDI ref RO/constructor VDI the update was uploaded to
version string RO/constructor Update version number

RPCs associated with class: poolupdate

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given poolupdate.
Signature:
void add_to_other_config (session ref session_ref, pool_update ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update 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: apply

Overview:
Apply the selected update to a host
Signature:
void apply (session ref session_ref, pool_update ref self, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self The update to apply
host ref host The host to apply the update to.
Minimum Role: pool-operator
Return Type: void

RPC name: destroy

Overview:
Removes the database entry. Only works on unapplied update.
Signature:
void destroy (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self The update to destroy
Minimum Role: pool-operator
Return Type: void

RPC name: getafterapplyguidance

Overview:
Get the afterapplyguidance field of the given poolupdate.
Signature:
update_after_apply_guidance set get_after_apply_guidance (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: update_after_apply_guidance set
value of the field

RPC name: getall

Overview:
Return a list of all the poolupdates known to the system.
Signature:
pool_update 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: pool_update ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of poolupdate references to poolupdate records for all poolupdates known to the system.
Signature:
(pool_update ref -> pool_update 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: (pool_update ref -> pool_update record) map
records of all objects

RPC name: getbynamelabel

Overview:
Get all the poolupdate instances with the given label.
Signature:
pool_update ref set get_by_name_label (session ref session_ref, string label)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string label label of object to return
Minimum Role: read-only
Return Type: pool_update ref set
references to objects with matching names

RPC name: getbyuuid

Overview:
Get a reference to the poolupdate instance with the specified UUID.
Signature:
pool_update 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 UUID of object to return
Minimum Role: read-only
Return Type: pool_update ref
reference to the object

RPC name: getenforcehomogeneity

Overview:
Get the enforcehomogeneity field of the given poolupdate.
Signature:
bool get_enforce_homogeneity (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: gethosts

Overview:
Get the hosts field of the given poolupdate.
Signature:
host ref set get_hosts (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: host ref set
value of the field

RPC name: getinstallationsize

Overview:
Get the installationsize field of the given poolupdate.
Signature:
int get_installation_size (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getkey

Overview:
Get the key field of the given poolupdate.
Signature:
string get_key (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getnamedescription

Overview:
Get the name/description field of the given poolupdate.
Signature:
string get_name_description (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getnamelabel

Overview:
Get the name/label field of the given poolupdate.
Signature:
string get_name_label (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given poolupdate.
Signature:
(string -> string) map get_other_config (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given poolupdate.
Signature:
pool_update record get_record (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: pool_update record
all fields from the object

RPC name: getuuid

Overview:
Get the uuid field of the given poolupdate.
Signature:
string get_uuid (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getvdi

Overview:
Get the vdi field of the given poolupdate.
Signature:
VDI ref get_vdi (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: VDI ref
value of the field

RPC name: getversion

Overview:
Get the version field of the given poolupdate.
Signature:
string get_version (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: introduce

Overview:
Introduce update VDI
Signature:
pool_update ref introduce (session ref session_ref, VDI ref vdi)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VDI ref vdi The VDI which contains a software update.
Minimum Role: pool-operator
Return Type: pool_update ref
the introduced pool update

RPC name: poolapply

Overview:
Apply the selected update to all hosts in the pool
Signature:
void pool_apply (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self The update to apply
Minimum Role: pool-operator
Return Type: void

RPC name: poolclean

Overview:
Removes the update's files from all hosts in the pool, but does not revert the update
Signature:
void pool_clean (session ref session_ref, pool_update ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self The update to clean up
Minimum Role: pool-operator
Return Type: void

RPC name: precheck

Overview:
Execute the precheck stage of the selected update on a host
Signature:
livepatch_status precheck (session ref session_ref, pool_update ref self, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self The update whose prechecks will be run
host ref host The host to run the prechecks on.
Minimum Role: pool-operator
Return Type: livepatch_status
The precheck pool update

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given poolupdate. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, pool_update ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
string key Key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: setotherconfig

Overview:
Set the otherconfig field of the given poolupdate.
Signature:
void set_other_config (session ref session_ref, pool_update ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
pool_update ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void