View Source XenAPI.Task (XenAPI v0.1.1)

Link to this section Summary

Functions

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

Add the given key-value pair to the other_config field of the given task. (Raise error on XMLRPC failure)

Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time.

Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time. (Raise error on XMLRPC failure)

Create a new task object which must be manually destroyed.

Create a new task object which must be manually destroyed. (Raise error on XMLRPC failure)

Destroy the task object

Destroy the task object (Raise error on XMLRPC failure)

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

Return a list of all the tasks known to the system. (Raise error on XMLRPC failure)

Return a map of task references to task records for all tasks known to the system.

Return a map of task references to task records for all tasks known to the system. (Raise error on XMLRPC failure)

Get the allowed_operations field of the given task.

Get the allowed_operations field of the given task. (Raise error on XMLRPC failure)

Get the backtrace field of the given task.

Get the backtrace field of the given task. (Raise error on XMLRPC failure)

Get all the task instances with the given label.

Get all the task instances with the given label. (Raise error on XMLRPC failure)

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

Get a reference to the task instance with the specified UUID. (Raise error on XMLRPC failure)

Get the created field of the given task.

Get the created field of the given task. (Raise error on XMLRPC failure)

Get the current_operations field of the given task.

Get the current_operations field of the given task. (Raise error on XMLRPC failure)

Get the error_info field of the given task.

Get the error_info field of the given task. (Raise error on XMLRPC failure)

Get the finished field of the given task.

Get the finished field of the given task. (Raise error on XMLRPC failure)

Get the name/description field of the given task.

Get the name/description field of the given task. (Raise error on XMLRPC failure)

Get the name/label field of the given task.

Get the name/label field of the given task. (Raise error on XMLRPC failure)

Get the other_config field of the given task.

Get the other_config field of the given task. (Raise error on XMLRPC failure)

Get the progress field of the given task.

Get the progress field of the given task. (Raise error on XMLRPC failure)

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

Get a record containing the current state of the given task. (Raise error on XMLRPC failure)

Get the resident_on field of the given task.

Get the resident_on field of the given task. (Raise error on XMLRPC failure)

Get the result field of the given task.

Get the result field of the given task. (Raise error on XMLRPC failure)

Get the status field of the given task.

Get the status field of the given task. (Raise error on XMLRPC failure)

Get the subtask_of field of the given task.

Get the subtask_of field of the given task. (Raise error on XMLRPC failure)

Get the subtasks field of the given task.

Get the subtasks field of the given task. (Raise error on XMLRPC failure)

Get the type field of the given task.

Get the type field of the given task. (Raise error on XMLRPC failure)

Get the uuid field of the given task.

Get the uuid field of the given task. (Raise error on XMLRPC failure)

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

Remove the given key and its corresponding value from the other_config field of the given task. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Set the other_config field of the given task.

Set the other_config field of the given task. (Raise error on XMLRPC failure)

Set the task status (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_other_config(xen_session, task_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, task_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given task. (Raise error on XMLRPC failure)

Link to this function

cancel(xen_session, task)

View Source

Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time.

Link to this function

cancel!(xen_session, task)

View Source

Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time. (Raise error on XMLRPC failure)

Link to this function

create(xen_session, label, description)

View Source

Create a new task object which must be manually destroyed.

Link to this function

create!(xen_session, label, description)

View Source

Create a new task object which must be manually destroyed. (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, task_ref)

View Source

Destroy the task object

Link to this function

destroy!(xen_session, task_ref)

View Source

Destroy the task object (Raise error on XMLRPC failure)

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

Return a list of all the tasks known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

Return a map of task references to task records for all tasks known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of task references to task records for all tasks known to the system. (Raise error on XMLRPC failure)

Link to this function

get_allowed_operations(xen_session, task_ref)

View Source

Get the allowed_operations field of the given task.

Link to this function

get_allowed_operations!(xen_session, task_ref)

View Source

Get the allowed_operations field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_backtrace(xen_session, task_ref)

View Source

Get the backtrace field of the given task.

Link to this function

get_backtrace!(xen_session, task_ref)

View Source

Get the backtrace field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the task instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the task instances with the given label. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the task instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_created(xen_session, task_ref)

View Source

Get the created field of the given task.

Link to this function

get_created!(xen_session, task_ref)

View Source

Get the created field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_current_operations(xen_session, task_ref)

View Source

Get the current_operations field of the given task.

Link to this function

get_current_operations!(xen_session, task_ref)

View Source

Get the current_operations field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_error_info(xen_session, task_ref)

View Source

Get the error_info field of the given task.

Link to this function

get_error_info!(xen_session, task_ref)

View Source

Get the error_info field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_finished(xen_session, task_ref)

View Source

Get the finished field of the given task.

Link to this function

get_finished!(xen_session, task_ref)

View Source

Get the finished field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, task_ref)

View Source

Get the name/description field of the given task.

Link to this function

get_name_description!(xen_session, task_ref)

View Source

Get the name/description field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, task_ref)

View Source

Get the name/label field of the given task.

Link to this function

get_name_label!(xen_session, task_ref)

View Source

Get the name/label field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, task_ref)

View Source

Get the other_config field of the given task.

Link to this function

get_other_config!(xen_session, task_ref)

View Source

Get the other_config field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_progress(xen_session, task_ref)

View Source

Get the progress field of the given task.

Link to this function

get_progress!(xen_session, task_ref)

View Source

Get the progress field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, task_ref)

View Source

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

Link to this function

get_record!(xen_session, task_ref)

View Source

Get a record containing the current state of the given task. (Raise error on XMLRPC failure)

Link to this function

get_resident_on(xen_session, task_ref)

View Source

Get the resident_on field of the given task.

Link to this function

get_resident_on!(xen_session, task_ref)

View Source

Get the resident_on field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_result(xen_session, task_ref)

View Source

Get the result field of the given task.

Link to this function

get_result!(xen_session, task_ref)

View Source

Get the result field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_status(xen_session, task_ref)

View Source

Get the status field of the given task.

Link to this function

get_status!(xen_session, task_ref)

View Source

Get the status field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_subtask_of(xen_session, task_ref)

View Source

Get the subtask_of field of the given task.

Link to this function

get_subtask_of!(xen_session, task_ref)

View Source

Get the subtask_of field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_subtasks(xen_session, task_ref)

View Source

Get the subtasks field of the given task.

Link to this function

get_subtasks!(xen_session, task_ref)

View Source

Get the subtasks field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_type(xen_session, task_ref)

View Source

Get the type field of the given task.

Link to this function

get_type!(xen_session, task_ref)

View Source

Get the type field of the given task. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, task_ref)

View Source

Get the uuid field of the given task.

Link to this function

get_uuid!(xen_session, task_ref)

View Source

Get the uuid field of the given task. (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, task_ref, key)

View Source

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

Link to this function

remove_from_other_config!(xen_session, task_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given task. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, task_ref, value)

View Source

Set the other_config field of the given task.

Link to this function

set_other_config!(xen_session, task_ref, value)

View Source

Set the other_config field of the given task. (Raise error on XMLRPC failure)

Link to this function

set_status(xen_session, task_ref, value)

View Source

Set the task status

Link to this function

set_status!(xen_session, task_ref, value)

View Source

Set the task status (Raise error on XMLRPC failure)