Class: crashdump

Last published : Oct 01, 2026
This class is deprecated.
A VM crashdump
Related information
XenServer 9 Management API

Fields for class: crashdump

Field Type Qualifier Description
other_config (string -> string) map RW Deprecated. additional configuration
uuid string RO/runtime Deprecated. Unique identifier/object reference
VDI VDI ref RO/constructor Deprecated. the virtual disk
VM VM ref RO/constructor Deprecated. the virtual machine

RPCs associated with class: crashdump

RPC name: addtootherconfig

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

This message is deprecated.
Overview:
Destroy the specified crashdump
Signature:
void destroy (session ref session_ref, crashdump ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
crashdump ref self The crashdump to destroy
Minimum Role: pool-operator
Return Type: void

RPC name: getall

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

RPC name: getallrecords

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

RPC name: getbyuuid

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

RPC name: getotherconfig

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

RPC name: getrecord

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

RPC name: getuuid

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

RPC name: getVDI

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

RPC name: getVM

This message is deprecated.
Overview:
Get the VM field of the given crashdump.
Signature:
VM ref get_VM (session ref session_ref, crashdump ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
crashdump ref self reference to the object
Minimum Role: read-only
Return Type: VM ref
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 crashdump. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, crashdump ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
crashdump 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 crashdump.
Signature:
void set_other_config (session ref session_ref, crashdump ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
crashdump ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void