Package com.xensource.xenapi

Class PoolUpdate

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.PoolUpdate

public class PoolUpdate
extends XenAPIObject

Pool-wide updates to the host software First published in XenServer 7.1.

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PoolUpdate.Record	Represents all the fields in a PoolUpdate

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	ref	The XenAPI reference (OpaqueRef) to this object.

Method Summary

Modifier and Type	Method	Description
void	addToOtherConfig(Connection c, String key, String value)	Add the given key-value pair to the other_config field of the given pool_update.
void	apply(Connection c, Host host)	Apply the selected update to a host Minimum allowed role: pool-operator First published in XenServer 7.1.
Task	applyAsync(Connection c, Host host)	Apply the selected update to a host Minimum allowed role: pool-operator First published in XenServer 7.1.
void	destroy(Connection c)	Removes the database entry.
Task	destroyAsync(Connection c)	Removes the database entry.
boolean	equals(Object obj)	If obj is a PoolUpdate, compares XenAPI references for equality.
Set<Types.UpdateAfterApplyGuidance>	getAfterApplyGuidance(Connection c)	Get the after_apply_guidance field of the given pool_update.
static Set<PoolUpdate>	getAll(Connection c)	Return a list of all the pool_updates known to the system.
static Map<PoolUpdate,PoolUpdate.Record>	getAllRecords(Connection c)	Return a map of pool_update references to pool_update records for all pool_updates known to the system.
static Set<PoolUpdate>	getByNameLabel(Connection c, String label)	Get all the pool_update instances with the given label.
static PoolUpdate	getByUuid(Connection c, String uuid)	Get a reference to the pool_update instance with the specified UUID.
Boolean	getEnforceHomogeneity(Connection c)	Get the enforce_homogeneity field of the given pool_update.
Set<Host>	getHosts(Connection c)	Get the hosts field of the given pool_update.
Long	getInstallationSize(Connection c)	Get the installation_size field of the given pool_update.
String	getKey(Connection c)	Get the key field of the given pool_update.
String	getNameDescription(Connection c)	Get the name/description field of the given pool_update.
String	getNameLabel(Connection c)	Get the name/label field of the given pool_update.
Map<String,String>	getOtherConfig(Connection c)	Get the other_config field of the given pool_update.
PoolUpdate.Record	getRecord(Connection c)	Get a record containing the current state of the given pool_update.
String	getUuid(Connection c)	Get the uuid field of the given pool_update.
VDI	getVdi(Connection c)	Get the vdi field of the given pool_update.
String	getVersion(Connection c)	Get the version field of the given pool_update.
int	hashCode()
static PoolUpdate	introduce(Connection c, VDI vdi)	Introduce update VDI Minimum allowed role: pool-operator First published in XenServer 7.1.
static Task	introduceAsync(Connection c, VDI vdi)	Introduce update VDI Minimum allowed role: pool-operator First published in XenServer 7.1.
void	poolApply(Connection c)	Apply the selected update to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 7.1.
Task	poolApplyAsync(Connection c)	Apply the selected update to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 7.1.
void	poolClean(Connection c)	Removes the update's files from all hosts in the pool, but does not revert the update Minimum allowed role: pool-operator First published in XenServer 7.1.
Task	poolCleanAsync(Connection c)	Removes the update's files from all hosts in the pool, but does not revert the update Minimum allowed role: pool-operator First published in XenServer 7.1.
Types.LivepatchStatus	precheck(Connection c, Host host)	Execute the precheck stage of the selected update on a host Minimum allowed role: pool-operator First published in XenServer 7.1.
Task	precheckAsync(Connection c, Host host)	Execute the precheck stage of the selected update on a host Minimum allowed role: pool-operator First published in XenServer 7.1.
void	removeFromOtherConfig(Connection c, String key)	Remove the given key and its corresponding value from the other_config field of the given pool_update.
void	setOtherConfig(Connection c, Map<String,String> otherConfig)	Set the other_config field of the given pool_update.
String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

If obj is a PoolUpdate, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

public PoolUpdate.Record getRecord(Connection c)
                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a record containing the current state of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

all fields from the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByUuid

public static PoolUpdate getByUuid(Connection c,
 String uuid)
                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a reference to the pool_update instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByNameLabel

public static Set<PoolUpdate> getByNameLabel(Connection c,
 String label)
                                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get all the pool_update instances with the given label. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

label - label of object to return

Returns:

references to objects with matching names

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUuid

public String getUuid(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the uuid field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getNameLabel

public String getNameLabel(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the name/label field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getNameDescription

public String getNameDescription(Connection c)
                          throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the name/description field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getVersion

public String getVersion(Connection c)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the version field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getInstallationSize

public Long getInstallationSize(Connection c)
                         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the installation_size field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getKey

public String getKey(Connection c)
              throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the key field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAfterApplyGuidance

public Set<Types.UpdateAfterApplyGuidance> getAfterApplyGuidance(Connection c)
                                                          throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the after_apply_guidance field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getVdi

public VDI getVdi(Connection c)
           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the vdi field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getHosts

public Set<Host> getHosts(Connection c)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the hosts field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getOtherConfig

public Map<String,String> getOtherConfig(Connection c)
                                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the other_config field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getEnforceHomogeneity

public Boolean getEnforceHomogeneity(Connection c)
                              throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the enforce_homogeneity field of the given pool_update. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setOtherConfig

public void setOtherConfig(Connection c,
 Map<String,String> otherConfig)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the other_config field of the given pool_update. Minimum allowed role: pool-operator First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

otherConfig - New value to set

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

addToOtherConfig

public void addToOtherConfig(Connection c,
 String key,
 String value)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add the given key-value pair to the other_config field of the given pool_update. Minimum allowed role: pool-operator First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
 String key)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Remove the given key and its corresponding value from the other_config field of the given pool_update. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

key - Key to remove

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

introduce

public static PoolUpdate introduce(Connection c,
 VDI vdi)
                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Introduce update VDI Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

vdi - The VDI which contains a software update.

Returns:

the introduced pool update

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

introduceAsync

public static Task introduceAsync(Connection c,
 VDI vdi)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Introduce update VDI Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

vdi - The VDI which contains a software update.

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

precheck

public Types.LivepatchStatus precheck(Connection c,
 Host host)
                               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Execute the precheck stage of the selected update on a host Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

host - The host to run the prechecks on.

Returns:

The precheck pool update

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

precheckAsync

public Task precheckAsync(Connection c,
 Host host)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Execute the precheck stage of the selected update on a host Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

host - The host to run the prechecks on.

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

apply

public void apply(Connection c,
 Host host)
           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Apply the selected update to a host Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

host - The host to apply the update to.

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

applyAsync

public Task applyAsync(Connection c,
 Host host)
                throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Apply the selected update to a host Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

host - The host to apply the update to.

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

poolApply

public void poolApply(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Apply the selected update to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

poolApplyAsync

public Task poolApplyAsync(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Apply the selected update to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

poolClean

public void poolClean(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Removes the update's files from all hosts in the pool, but does not revert the update Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

poolCleanAsync

public Task poolCleanAsync(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Removes the update's files from all hosts in the pool, but does not revert the update Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Removes the database entry. Only works on unapplied update. Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Removes the database entry. Only works on unapplied update. Minimum allowed role: pool-operator First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAll

public static Set<PoolUpdate> getAll(Connection c)
                              throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a list of all the pool_updates known to the system. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

references to all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllRecords

public static Map<PoolUpdate,PoolUpdate.Record> getAllRecords(Connection c)
                                                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a map of pool_update references to pool_update records for all pool_updates known to the system. Minimum allowed role: read-only First published in XenServer 7.1.

Parameters:

c - The connection the call is made on

Returns:

records of all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.