Class: hostcrashdump

Last published : Oct 01, 2026
Represents a host crash dump
Related information
XenServer 9 Management API

Fields for class: hostcrashdump

Field Type Qualifier Description
host host ref RO/constructor Host the crashdump relates to
other_config (string -> string) map RW additional configuration
size int RO/runtime Size of the crashdump
timestamp datetime RO/runtime Time the crash happened
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: hostcrashdump

RPC name: addtootherconfig

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

Overview:
Destroy specified host crash dump, removing it from the disk.
Signature:
void destroy (session ref session_ref, host_crashdump ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_crashdump ref self The host crashdump to destroy
Minimum Role: pool-operator
Return Type: void

RPC name: getall

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

RPC name: getallrecords

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

RPC name: getbyuuid

Overview:
Get a reference to the hostcrashdump instance with the specified UUID.
Signature:
host_crashdump 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_crashdump ref
reference to the object

RPC name: gethost

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

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given hostcrashdump.
Signature:
(string -> string) map get_other_config (session ref session_ref, host_crashdump ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_crashdump 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 hostcrashdump.
Signature:
host_crashdump record get_record (session ref session_ref, host_crashdump ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_crashdump ref self reference to the object
Minimum Role: read-only
Return Type: host_crashdump record
all fields from the object

RPC name: getsize

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

RPC name: gettimestamp

Overview:
Get the timestamp field of the given hostcrashdump.
Signature:
datetime get_timestamp (session ref session_ref, host_crashdump ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_crashdump ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getuuid

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

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given hostcrashdump. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, host_crashdump ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_crashdump 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 hostcrashdump.
Signature:
void set_other_config (session ref session_ref, host_crashdump ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_crashdump ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: upload

Overview:
Upload the specified host crash dump to a specified URL
Signature:
void upload (session ref session_ref, host_crashdump ref self, string url, (string -> string) map options)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host_crashdump ref self The host crashdump to upload
string url The URL to upload to
(string -> string) map options Extra configuration operations
Minimum Role: pool-operator
Return Type: void