View Source XenAPI.PBD (XenAPI v0.1.2)

Link to this section Summary

Functions

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

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

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

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

Destroy the specified PBD instance.

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

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

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

Return a map of PBD references to PBD records for all PBDs known to the system.

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

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

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

Get the currently_attached field of the given PBD.

Get the currently_attached field of the given PBD. (Raise error on XMLRPC failure)

Get the device_config field of the given PBD.

Get the device_config field of the given PBD. (Raise error on XMLRPC failure)

Get the host field of the given PBD.

Get the host field of the given PBD. (Raise error on XMLRPC failure)

Get the other_config field of the given PBD.

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

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

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

Get the SR field of the given PBD.

Get the SR field of the given PBD. (Raise error on XMLRPC failure)

Get the uuid field of the given PBD.

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

Activate the specified PBD, causing the referenced SR to be attached and scanned

Activate the specified PBD, causing the referenced SR to be attached and scanned (Raise error on XMLRPC failure)

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

Sets the PBD's device_config field

Sets the PBD's device_config field (Raise error on XMLRPC failure)

Set the other_config field of the given PBD.

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

Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned

Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_other_config(xen_session, pbd_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, pbd_ref, key, value)

View Source

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

Link to this function

create(xen_session, args)

View Source

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

Link to this function

create!(xen_session, args)

View Source

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

Link to this function

destroy(xen_session, pbd_ref)

View Source

Destroy the specified PBD instance.

Link to this function

destroy!(xen_session, pbd_ref)

View Source

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

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

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

Link to this function

get_all_records(xen_session)

View Source

Return a map of PBD references to PBD records for all PBDs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of PBD references to PBD records for all PBDs 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 PBD instance with the specified UUID.

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_currently_attached(xen_session, pbd_ref)

View Source

Get the currently_attached field of the given PBD.

Link to this function

get_currently_attached!(xen_session, pbd_ref)

View Source

Get the currently_attached field of the given PBD. (Raise error on XMLRPC failure)

Link to this function

get_device_config(xen_session, pbd_ref)

View Source

Get the device_config field of the given PBD.

Link to this function

get_device_config!(xen_session, pbd_ref)

View Source

Get the device_config field of the given PBD. (Raise error on XMLRPC failure)

Link to this function

get_host(xen_session, pbd_ref)

View Source

Get the host field of the given PBD.

Link to this function

get_host!(xen_session, pbd_ref)

View Source

Get the host field of the given PBD. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, pbd_ref)

View Source

Get the other_config field of the given PBD.

Link to this function

get_other_config!(xen_session, pbd_ref)

View Source

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

Link to this function

get_record(xen_session, pbd_ref)

View Source

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

Link to this function

get_record!(xen_session, pbd_ref)

View Source

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

Link to this function

get_SR(xen_session, pbd_ref)

View Source

Get the SR field of the given PBD.

Link to this function

get_SR!(xen_session, pbd_ref)

View Source

Get the SR field of the given PBD. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, pbd_ref)

View Source

Get the uuid field of the given PBD.

Link to this function

get_uuid!(xen_session, pbd_ref)

View Source

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

Link to this function

plug(xen_session, pbd_ref)

View Source

Activate the specified PBD, causing the referenced SR to be attached and scanned

Link to this function

plug!(xen_session, pbd_ref)

View Source

Activate the specified PBD, causing the referenced SR to be attached and scanned (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, pbd_ref, key)

View Source

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

Link to this function

remove_from_other_config!(xen_session, pbd_ref, key)

View Source

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

Link to this function

set_device_config(xen_session, pbd_ref, value)

View Source

Sets the PBD's device_config field

Link to this function

set_device_config!(xen_session, pbd_ref, value)

View Source

Sets the PBD's device_config field (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, pbd_ref, value)

View Source

Set the other_config field of the given PBD.

Link to this function

set_other_config!(xen_session, pbd_ref, value)

View Source

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

Link to this function

unplug(xen_session, pbd_ref)

View Source

Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned

Link to this function

unplug!(xen_session, pbd_ref)

View Source

Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned (Raise error on XMLRPC failure)