Xapi Project Docs

Deprecated

Class: crashdump

A VM crashdump

Published in:	XenServer 4.0 (rio)	A VM crashdump
Deprecated in:	XenServer 7.3 (inverness)

Fields

VDI ref VDI [RO/constructor]

the virtual disk

Published in:

XenServer 4.0 (rio)

the virtual disk

VM ref VM [RO/constructor]

the virtual machine

Published in:

XenServer 4.0 (rio)

the virtual machine

(string → string) map other_config [RW]

additional configuration

Default value:	{}
Published in:	XenServer 4.1 (miami)	additional configuration

string uuid [RO/runtime]

Unique identifier/object reference

Published in:

XenServer 4.0 (rio)

Unique identifier/object reference

Messages

void add_to_other_config (session ref, crashdump ref, string, string)

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

Parameters:	session ref session_id	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
Published in:	XenServer 4.1 (miami)	additional configuration

void destroy (session ref, crashdump ref)

Destroy the specified crashdump

Parameters:	session ref session_id	Reference to a valid session
	crashdump ref self	The crashdump to destroy
Minimum role:	pool-operator
Published in:	XenServer 4.0 (rio)	Destroy the specified crashdump

VDI ref get_VDI (session ref, crashdump ref)

Get the VDI field of the given crashdump.

Parameters:	session ref session_id	Reference to a valid session
	crashdump ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)	the virtual disk

VM ref get_VM (session ref, crashdump ref)

Get the VM field of the given crashdump.

Parameters:	session ref session_id	Reference to a valid session
	crashdump ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)	the virtual machine

Deprecated

crashdump ref set get_all (session ref)

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

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	references to all objects
Published in:	XenServer 4.0 (rio)	A VM crashdump
Deprecated in:	XenServer 7.3 (inverness)

Deprecated

(crashdump ref → crashdump record) map get_all_records (session ref)

Return a map of crashdump references to crashdump records for all crashdumps known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	records of all objects
Published in:	XenServer 4.0 (rio)	A VM crashdump
Deprecated in:	XenServer 7.3 (inverness)

Deprecated

crashdump ref get_by_uuid (session ref, string)

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

Parameters:	session ref session_id	Reference to a valid session
	string uuid	UUID of object to return
Minimum role:	read-only
Result:	reference to the object
Published in:	XenServer 4.0 (rio)	A VM crashdump
Deprecated in:	XenServer 7.3 (inverness)

(string → string) map get_other_config (session ref, crashdump ref)

Get the other_config field of the given crashdump.

Parameters:	session ref session_id	Reference to a valid session
	crashdump ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.1 (miami)	additional configuration

Deprecated

crashdump record get_record (session ref, crashdump ref)

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

Parameters:	session ref session_id	Reference to a valid session
	crashdump ref self	reference to the object
Minimum role:	read-only
Result:	all fields from the object
Published in:	XenServer 4.0 (rio)	A VM crashdump
Deprecated in:	XenServer 7.3 (inverness)

string get_uuid (session ref, crashdump ref)

Get the uuid field of the given crashdump.

Parameters:	session ref session_id	Reference to a valid session
	crashdump ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)	Unique identifier/object reference

void remove_from_other_config (session ref, crashdump ref, string)

Remove the given key and its corresponding value from the other_config field of the given crashdump. If the key is not in that Map, then do nothing.

Parameters:	session ref session_id	Reference to a valid session
	crashdump ref self	reference to the object
	string key	Key to remove
Minimum role:	pool-operator
Published in:	XenServer 4.1 (miami)	additional configuration

void set_other_config (session ref, crashdump ref, (string → string) map)

Set the other_config field of the given crashdump.

Parameters:	session ref session_id	Reference to a valid session
	crashdump ref self	reference to the object
	(string → string) map value	New value to set
Minimum role:	pool-operator
Published in:	XenServer 4.1 (miami)	additional configuration

Class: crashdump

Fields

Messages Hide implicit

Classes

Messages