View Source XenAPI.Console (XenAPI v0.1.1)

Link to this section Summary

Functions

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

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

Create a new console instance, and return its handle. The constructor args are: other_config ( = non-optional).

Create a new console instance, and return its handle. The constructor args are: other_config ( = non-optional). (Raise error on XMLRPC failure)

Destroy the specified console instance.

Destroy the specified console instance. (Raise error on XMLRPC failure)

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

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

Return a map of console references to console records for all consoles known to the system.

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

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

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

Get the location field of the given console.

Get the location field of the given console. (Raise error on XMLRPC failure)

Get the other_config field of the given console.

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

Get the protocol field of the given console.

Get the protocol field of the given console. (Raise error on XMLRPC failure)

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

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

Get the uuid field of the given console.

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

Get the VM field of the given console.

Get the VM field of the given console. (Raise error on XMLRPC failure)

Remove the given key and its corresponding value from the other_config field of the given console. 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 console. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Set the other_config field of the given console.

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

Link to this section Functions

Link to this function

add_to_other_config(xen_session, console_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, console_ref, key, value)

View Source

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

Link to this function

create(xen_session, args)

View Source

Create a new console instance, and return its handle. The constructor args are: other_config ( = non-optional).

Link to this function

create!(xen_session, args)

View Source

Create a new console instance, and return its handle. The constructor args are: other_config ( = non-optional). (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, console_ref)

View Source

Destroy the specified console instance.

Link to this function

destroy!(xen_session, console_ref)

View Source

Destroy the specified console instance. (Raise error on XMLRPC failure)

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

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

Link to this function

get_all_records(xen_session)

View Source

Return a map of console references to console records for all consoles known to the system.

Link to this function

get_all_records!(xen_session)

View Source

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

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_location(xen_session, console_ref)

View Source

Get the location field of the given console.

Link to this function

get_location!(xen_session, console_ref)

View Source

Get the location field of the given console. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, console_ref)

View Source

Get the other_config field of the given console.

Link to this function

get_other_config!(xen_session, console_ref)

View Source

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

Link to this function

get_protocol(xen_session, console_ref)

View Source

Get the protocol field of the given console.

Link to this function

get_protocol!(xen_session, console_ref)

View Source

Get the protocol field of the given console. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, console_ref)

View Source

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

Link to this function

get_record!(xen_session, console_ref)

View Source

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

Link to this function

get_uuid(xen_session, console_ref)

View Source

Get the uuid field of the given console.

Link to this function

get_uuid!(xen_session, console_ref)

View Source

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

Link to this function

get_VM(xen_session, console_ref)

View Source

Get the VM field of the given console.

Link to this function

get_VM!(xen_session, console_ref)

View Source

Get the VM field of the given console. (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, console_ref, key)

View Source

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

Link to this function

remove_from_other_config!(xen_session, console_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given console. 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, console_ref, value)

View Source

Set the other_config field of the given console.

Link to this function

set_other_config!(xen_session, console_ref, value)

View Source

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