Class: host_crashdump
Represents a host crash dump
Published in:
XenServer 4.0 (rio)
Represents a host crash dump
Fields
host ref
host
[RO/constructor]
Host the crashdump relates to
Published in:
XenServer 4.0 (rio)
Host the crashdump relates to
(string → string) map
other_config
[RW]
additional configuration
Default value:
{}
Published in:
XenServer 4.1 (miami)
additional configuration
int
size
[RO/runtime]
Size of the crashdump
Published in:
XenServer 4.0 (rio)
Size of the crashdump
datetime
timestamp
[RO/runtime]
Time the crash happened
Published in:
XenServer 4.0 (rio)
Time the crash happened
string
uuid
[RO/runtime]
Unique identifier/object reference
Published in:
XenServer 4.0 (rio)
Unique identifier/object reference
Messages
Hide implicit
void
add_to_other_config
(session ref, host_crashdump ref, string, string)
Add the given key-value pair to the other_config field of the given host_crashdump.
Parameters:
session ref session_id
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
Published in:
XenServer 4.1 (miami)
additional configuration
void
destroy
(session ref, host_crashdump ref)
Destroy specified host crash dump, removing it from the disk.
Parameters:
session ref session_id
Reference to a valid session
host_crashdump ref self
The host crashdump to destroy
Minimum role:
pool-operator
Published in:
XenServer 4.0 (rio)
Destroy specified host crash dump, removing it from the disk.
host_crashdump ref set
get_all
(session ref)
Return a list of all the host_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)
Represents a host crash dump
(host_crashdump ref → host_crashdump record) map
get_all_records
(session ref)
Return a map of host_crashdump references to host_crashdump records for all host_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)
Represents a host crash dump
host_crashdump ref
get_by_uuid
(session ref, string)
Get a reference to the host_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)
Represents a host crash dump
host ref
get_host
(session ref, host_crashdump ref)
Get the host field of the given host_crashdump.
Parameters:
session ref session_id
Reference to a valid session
host_crashdump ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.0 (rio)
Host the crashdump relates to
(string → string) map
get_other_config
(session ref, host_crashdump ref)
Get the other_config field of the given host_crashdump.
Parameters:
session ref session_id
Reference to a valid session
host_crashdump ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.1 (miami)
additional configuration
host_crashdump record
get_record
(session ref, host_crashdump ref)
Get a record containing the current state of the given host_crashdump.
Parameters:
session ref session_id
Reference to a valid session
host_crashdump ref self
reference to the object
Minimum role:
read-only
Result:
all fields from the object
Published in:
XenServer 4.0 (rio)
Represents a host crash dump
int
get_size
(session ref, host_crashdump ref)
Get the size field of the given host_crashdump.
Parameters:
session ref session_id
Reference to a valid session
host_crashdump ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.0 (rio)
Size of the crashdump
datetime
get_timestamp
(session ref, host_crashdump ref)
Get the timestamp field of the given host_crashdump.
Parameters:
session ref session_id
Reference to a valid session
host_crashdump ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.0 (rio)
Time the crash happened
string
get_uuid
(session ref, host_crashdump ref)
Get the uuid field of the given host_crashdump.
Parameters:
session ref session_id
Reference to a valid session
host_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, host_crashdump ref, string)
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.
Parameters:
session ref session_id
Reference to a valid session
host_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, host_crashdump ref, (string → string) map)
Set the other_config field of the given host_crashdump.
Parameters:
session ref session_id
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
Published in:
XenServer 4.1 (miami)
additional configuration
void
upload
(session ref, host_crashdump ref, string, (string → string) map)
Upload the specified host crash dump to a specified URL
Parameters:
session ref session_id
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
Published in:
XenServer 4.0 (rio)
Upload the specified host crash dump to a specified URL