View Source XenAPI.PoolPatch (XenAPI v0.3.1)

Pool-wide patches

Link to this section Summary

Functions

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

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

Apply the selected patch to a host and return its output

Apply the selected patch to a host and return its output (Raise error on XMLRPC failure)

Removes the patch's files from the server

Removes the patch's files from the server (Raise error on XMLRPC failure)

Removes the patch's files from the specified host

Removes the patch's files from the specified host (Raise error on XMLRPC failure)

Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches.

Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches. (Raise error on XMLRPC failure)

Get the after_apply_guidance field of the given pool_patch.

Get the after_apply_guidance field of the given pool_patch. (Raise error on XMLRPC failure)

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

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

Return a map of pool_patch references to pool_patch records for all pool_patchs known to the system.

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

Get all the pool_patch instances with the given label.

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

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

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

Get the host_patches field of the given pool_patch.

Get the host_patches field of the given pool_patch. (Raise error on XMLRPC failure)

Get the name/description field of the given pool_patch.

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

Get the name/label field of the given pool_patch.

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

Get the other_config field of the given pool_patch.

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

Get the pool_applied field of the given pool_patch.

Get the pool_applied field of the given pool_patch. (Raise error on XMLRPC failure)

Get the pool_update field of the given pool_patch.

Get the pool_update field of the given pool_patch. (Raise error on XMLRPC failure)

Get a record containing the current state of the given pool_patch. Returns XenAPI.PoolPatch struct.

Get a record containing the current state of the given pool_patch. Returns XenAPI.PoolPatch struct. (Raise error on XMLRPC failure)

Get the size field of the given pool_patch.

Get the size field of the given pool_patch. (Raise error on XMLRPC failure)

Get the uuid field of the given pool_patch.

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

Get the version field of the given pool_patch.

Get the version field of the given pool_patch. (Raise error on XMLRPC failure)

Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output

Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output (Raise error on XMLRPC failure)

Removes the patch's files from all hosts in the pool, but does not remove the database entries

Removes the patch's files from all hosts in the pool, but does not remove the database entries (Raise error on XMLRPC failure)

Execute the precheck stage of the selected patch on a host and return its output

Execute the precheck stage of the selected patch on a host and return its output (Raise error on XMLRPC failure)

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

Set the other_config field of the given pool_patch.

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

Link to this section Functions

Link to this function

add_to_other_config(xen_session, pool_patch_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, pool_patch_ref, key, value)

View Source

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

Link to this function

apply(xen_session, pool_patch_ref, host)

View Source

Apply the selected patch to a host and return its output

Link to this function

apply!(xen_session, pool_patch_ref, host)

View Source

Apply the selected patch to a host and return its output (Raise error on XMLRPC failure)

Link to this function

clean(xen_session, pool_patch_ref)

View Source

Removes the patch's files from the server

Link to this function

clean!(xen_session, pool_patch_ref)

View Source

Removes the patch's files from the server (Raise error on XMLRPC failure)

Link to this function

clean_on_host(xen_session, pool_patch_ref, host)

View Source

Removes the patch's files from the specified host

Link to this function

clean_on_host!(xen_session, pool_patch_ref, host)

View Source

Removes the patch's files from the specified host (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, pool_patch_ref)

View Source

Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches.

Link to this function

destroy!(xen_session, pool_patch_ref)

View Source

Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches. (Raise error on XMLRPC failure)

Link to this function

get_after_apply_guidance(xen_session, pool_patch_ref)

View Source

Get the after_apply_guidance field of the given pool_patch.

Link to this function

get_after_apply_guidance!(xen_session, pool_patch_ref)

View Source

Get the after_apply_guidance field of the given pool_patch. (Raise error on XMLRPC failure)

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

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

Link to this function

get_all_records(xen_session)

View Source

Return a map of pool_patch references to pool_patch records for all pool_patchs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

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

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the pool_patch instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the pool_patch 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 pool_patch instance with the specified UUID.

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_host_patches(xen_session, pool_patch_ref)

View Source

Get the host_patches field of the given pool_patch.

Link to this function

get_host_patches!(xen_session, pool_patch_ref)

View Source

Get the host_patches field of the given pool_patch. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, pool_patch_ref)

View Source

Get the name/description field of the given pool_patch.

Link to this function

get_name_description!(xen_session, pool_patch_ref)

View Source

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

Link to this function

get_name_label(xen_session, pool_patch_ref)

View Source

Get the name/label field of the given pool_patch.

Link to this function

get_name_label!(xen_session, pool_patch_ref)

View Source

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

Link to this function

get_other_config(xen_session, pool_patch_ref)

View Source

Get the other_config field of the given pool_patch.

Link to this function

get_other_config!(xen_session, pool_patch_ref)

View Source

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

Link to this function

get_pool_applied(xen_session, pool_patch_ref)

View Source

Get the pool_applied field of the given pool_patch.

Link to this function

get_pool_applied!(xen_session, pool_patch_ref)

View Source

Get the pool_applied field of the given pool_patch. (Raise error on XMLRPC failure)

Link to this function

get_pool_update(xen_session, pool_patch_ref)

View Source

Get the pool_update field of the given pool_patch.

Link to this function

get_pool_update!(xen_session, pool_patch_ref)

View Source

Get the pool_update field of the given pool_patch. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, pool_patch_ref)

View Source

Get a record containing the current state of the given pool_patch. Returns XenAPI.PoolPatch struct.

Link to this function

get_record!(xen_session, pool_patch_ref)

View Source

Get a record containing the current state of the given pool_patch. Returns XenAPI.PoolPatch struct. (Raise error on XMLRPC failure)

Link to this function

get_size(xen_session, pool_patch_ref)

View Source

Get the size field of the given pool_patch.

Link to this function

get_size!(xen_session, pool_patch_ref)

View Source

Get the size field of the given pool_patch. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, pool_patch_ref)

View Source

Get the uuid field of the given pool_patch.

Link to this function

get_uuid!(xen_session, pool_patch_ref)

View Source

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

Link to this function

get_version(xen_session, pool_patch_ref)

View Source

Get the version field of the given pool_patch.

Link to this function

get_version!(xen_session, pool_patch_ref)

View Source

Get the version field of the given pool_patch. (Raise error on XMLRPC failure)

Link to this function

pool_apply(xen_session, pool_patch_ref)

View Source

Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output

Link to this function

pool_apply!(xen_session, pool_patch_ref)

View Source

Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output (Raise error on XMLRPC failure)

Link to this function

pool_clean(xen_session, pool_patch_ref)

View Source

Removes the patch's files from all hosts in the pool, but does not remove the database entries

Link to this function

pool_clean!(xen_session, pool_patch_ref)

View Source

Removes the patch's files from all hosts in the pool, but does not remove the database entries (Raise error on XMLRPC failure)

Link to this function

precheck(xen_session, pool_patch_ref, host)

View Source

Execute the precheck stage of the selected patch on a host and return its output

Link to this function

precheck!(xen_session, pool_patch_ref, host)

View Source

Execute the precheck stage of the selected patch on a host and return its output (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, pool_patch_ref, key)

View Source

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

Link to this function

remove_from_other_config!(xen_session, pool_patch_ref, key)

View Source

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

View Source

Set the other_config field of the given pool_patch.

Link to this function

set_other_config!(xen_session, pool_patch_ref, value)

View Source

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