Develop for XenServer®

Class: host_crashdump

June 8, 2026

Contributed by:

Represents a host crash dump

Fields for class: host_crashdump

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: host_crashdump

RPC name: add_to_other_config

Overview:

Add the given key-value pair to the other_config field of the given host_crashdump.

Signature:

void add_to_other_config (session ref session_ref, host_crashdump ref self, string key, string value)
<!--NeedCopy-->

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)
<!--NeedCopy-->

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: get_all

Overview:

Return a list of all the host_crashdumps known to the system.

Signature:

host_crashdump ref set get_all (session ref session_ref)
<!--NeedCopy-->

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: get_all_records

Overview:

Return a map of host_crashdump references to host_crashdump records for all host_crashdumps known to the system.

Signature:

(host_crashdump ref -> host_crashdump record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

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: get_by_uuid

Overview:

Get a reference to the host_crashdump instance with the specified UUID.

Signature:

host_crashdump ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

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: get_host

Overview:

Get the host field of the given host_crashdump.

Signature:

host ref get_host (session ref session_ref, host_crashdump ref self)
<!--NeedCopy-->

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: get_other_config

Overview:

Get the other_config field of the given host_crashdump.

Signature:

(string -> string) map get_other_config (session ref session_ref, host_crashdump ref self)
<!--NeedCopy-->

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: get_record

Overview:

Get a record containing the current state of the given host_crashdump.

Signature:

host_crashdump record get_record (session ref session_ref, host_crashdump ref self)
<!--NeedCopy-->

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: get_size

Overview:

Get the size field of the given host_crashdump.

Signature:

int get_size (session ref session_ref, host_crashdump ref self)
<!--NeedCopy-->

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: get_timestamp

Overview:

Get the timestamp field of the given host_crashdump.

Signature:

datetime get_timestamp (session ref session_ref, host_crashdump ref self)
<!--NeedCopy-->

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: get_uuid

Overview:

Get the uuid field of the given host_crashdump.

Signature:

string get_uuid (session ref session_ref, host_crashdump ref self)
<!--NeedCopy-->

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: remove_from_other_config

Overview:

Remove the given key and its corresponding value from the other_config field of the given host_crashdump. 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)
<!--NeedCopy-->

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: set_other_config

Overview:

Set the other_config field of the given host_crashdump.

Signature:

void set_other_config (session ref session_ref, host_crashdump ref self, (string -> string) map value)
<!--NeedCopy-->

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)
<!--NeedCopy-->

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

The official version of this product documentation is in English. Any non-English version is solely provided for your convenience and may include machine-translated content. For more information, please refer to the Machine Translation Disclaimer on Cloud Software Group home.

Was this helpful

Class: host_crashdump

June 8, 2026

Contributed by:

June 8, 2026

Contributed by:

Class: host_crashdump

Fields for class: host_crashdump

RPCs associated with class: host_crashdump

RPC name: add_to_other_config

RPC name: destroy

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_host

RPC name: get_other_config

RPC name: get_record

RPC name: get_size

RPC name: get_timestamp

RPC name: get_uuid

RPC name: remove_from_other_config

RPC name: set_other_config

RPC name: upload

In this article