Class: hostpatch

Last published : Oct 01, 2026
This class is deprecated.
Represents a patch stored on a server
Related information
XenServer 9 Management API

Fields for class: hostpatch

Field Type Qualifier Description
applied bool RO/runtime Deprecated. True if the patch has been applied
host host ref RO/constructor Deprecated. Host the patch relates to
name_description string RO/constructor Deprecated. a notes field containing human-readable description
name_label string RO/constructor Deprecated. a human-readable name
other_config (string -> string) map RW Deprecated. additional configuration
pool_patch pool_patch ref RO/constructor Deprecated. The patch applied
size int RO/runtime Deprecated. Size of the patch
timestamp_applied datetime RO/runtime Deprecated. Time the patch was applied
uuid string RO/runtime Deprecated. Unique identifier/object reference
version string RO/constructor Deprecated. Patch version number

RPCs associated with class: hostpatch

RPC name: addtootherconfig

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

This message is deprecated.
Overview:
Apply the selected patch and return its output
Signature:
string apply (session ref session_ref, host_patch ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_patch ref self The patch to apply
Minimum Role: pool-operator
Return Type: string
the output of the patch application process

RPC name: destroy

This message is deprecated.
Overview:
Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch
Signature:
void destroy (session ref session_ref, host_patch ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_patch ref self The patch to destroy
Minimum Role: pool-operator
Return Type: void

RPC name: getall

This message is deprecated.
Overview:
Return a list of all the hostpatchs known to the system.
Signature:
host_patch 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: host_patch ref set
references to all objects

RPC name: getallrecords

This message is deprecated.
Overview:
Return a map of hostpatch references to hostpatch records for all hostpatchs known to the system.
Signature:
(host_patch ref -> host_patch 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: (host_patch ref -> host_patch record) map
records of all objects

RPC name: getapplied

This message is deprecated.
Overview:
Get the applied field of the given hostpatch.
Signature:
bool get_applied (session ref session_ref, host_patch ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_patch ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getbynamelabel

This message is deprecated.
Overview:
Get all the hostpatch instances with the given label.
Signature:
host_patch 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: host_patch ref set
references to objects with matching names

RPC name: getbyuuid

This message is deprecated.
Overview:
Get a reference to the hostpatch instance with the specified UUID.
Signature:
host_patch 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: host_patch ref
reference to the object

RPC name: gethost

This message is deprecated.
Overview:
Get the host field of the given hostpatch.
Signature:
host ref get_host (session ref session_ref, host_patch ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_patch ref self reference to the object
Minimum Role: read-only
Return Type: host ref
value of the field

RPC name: getnamedescription

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

RPC name: getnamelabel

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

RPC name: getotherconfig

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

RPC name: getpoolpatch

This message is deprecated.
Overview:
Get the poolpatch field of the given hostpatch.
Signature:
pool_patch ref get_pool_patch (session ref session_ref, host_patch ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_patch ref self reference to the object
Minimum Role: read-only
Return Type: pool_patch ref
value of the field

RPC name: getrecord

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

RPC name: getsize

This message is deprecated.
Overview:
Get the size field of the given hostpatch.
Signature:
int get_size (session ref session_ref, host_patch ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_patch ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: gettimestampapplied

This message is deprecated.
Overview:
Get the timestampapplied field of the given hostpatch.
Signature:
datetime get_timestamp_applied (session ref session_ref, host_patch ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_patch ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getuuid

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

RPC name: getversion

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

RPC name: removefromotherconfig

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

RPC name: setotherconfig

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