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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PoolUpdate.Record
Represents all the fields in a PoolUpdate

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

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String ref
The XenAPI reference (OpaqueRef) to this object.

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`ref` The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToOtherConfig(Connection c, java.lang.String key, java.lang.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 First published in XenServer 7.1.
`Task`	`applyAsync(Connection c, Host host)` Apply the selected update to a host First published in XenServer 7.1.
`void`	`destroy(Connection c)` Removes the database entry.
`Task`	`destroyAsync(Connection c)` Removes the database entry.
`boolean`	`equals(java.lang.Object obj)` If obj is a PoolUpdate, compares XenAPI references for equality.
`java.util.Set<Types.UpdateAfterApplyGuidance>`	`getAfterApplyGuidance(Connection c)` Get the after_apply_guidance field of the given pool_update.
`static java.util.Set<PoolUpdate>`	`getAll(Connection c)` Return a list of all the pool_updates known to the system.
`static java.util.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 java.util.Set<PoolUpdate>`	`getByNameLabel(Connection c, java.lang.String label)` Get all the pool_update instances with the given label.
`static PoolUpdate`	`getByUuid(Connection c, java.lang.String uuid)` Get a reference to the pool_update instance with the specified UUID.
`java.lang.Boolean`	`getEnforceHomogeneity(Connection c)` Get the enforce_homogeneity field of the given pool_update.
`java.util.Set<Host>`	`getHosts(Connection c)` Get the hosts field of the given pool_update.
`java.lang.Long`	`getInstallationSize(Connection c)` Get the installation_size field of the given pool_update.
`java.lang.String`	`getKey(Connection c)` Get the key field of the given pool_update.
`java.lang.String`	`getNameDescription(Connection c)` Get the name/description field of the given pool_update.
`java.lang.String`	`getNameLabel(Connection c)` Get the name/label field of the given pool_update.
`java.util.Map<java.lang.String,java.lang.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.
`java.lang.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.
`java.lang.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 First published in XenServer 7.1.
`static Task`	`introduceAsync(Connection c, VDI vdi)` Introduce update VDI First published in XenServer 7.1.
`void`	`poolApply(Connection c)` Apply the selected update to all hosts in the pool First published in XenServer 7.1.
`Task`	`poolApplyAsync(Connection c)` Apply the selected update to all hosts in the pool 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 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 First published in XenServer 7.1.
`Types.LivepatchStatus`	`precheck(Connection c, Host host)` Execute the precheck stage of the selected update on a host First published in XenServer 7.1.
`Task`	`precheckAsync(Connection c, Host host)` Execute the precheck stage of the selected update on a host First published in XenServer 7.1.
`void`	`removeFromOtherConfig(Connection c, java.lang.String key)` Remove the given key and its corresponding value from the other_config field of the given pool_update.
`void`	`setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig)` Set the other_config field of the given pool_update.
`java.lang.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 Detail
- ref
```
protected final java.lang.String ref
```
  The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString
```
public java.lang.String toWireString()
```
Specified by:

toWireString in class XenAPIObject

Returns:
The XenAPI reference (OpaqueRef) to this object.

equals
```
public boolean equals(java.lang.Object obj)
```
If obj is a PoolUpdate, compares XenAPI references for equality.

Overrides:

equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

getRecord

public PoolUpdate.Record getRecord(Connection c)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given pool_update. First published in XenServer 7.1.

Returns:: all fields from the object
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getByUuid

public static PoolUpdate getByUuid(Connection c,
                   java.lang.String uuid)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Get a reference to the pool_update instance with the specified UUID. First published in XenServer 7.1.

Parameters:: uuid - UUID of object to return
Returns:: reference to the object
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getByNameLabel

public static java.util.Set<PoolUpdate> getByNameLabel(Connection c,
                                       java.lang.String label)
                                                throws Types.BadServerResponse,
                                                       Types.XenAPIException,
                                                       org.apache.xmlrpc.XmlRpcException

Get all the pool_update instances with the given label. First published in XenServer 7.1.

Parameters:: label - label of object to return
Returns:: references to objects with matching names
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given pool_update. First published in XenServer 7.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getNameLabel

public java.lang.String getNameLabel(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the name/label field of the given pool_update. First published in XenServer 7.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getNameDescription

public java.lang.String getNameDescription(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException

Get the name/description field of the given pool_update. First published in XenServer 7.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getVersion

public java.lang.String getVersion(Connection c)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Get the version field of the given pool_update. First published in XenServer 7.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getInstallationSize

public java.lang.Long getInstallationSize(Connection c)
                                   throws Types.BadServerResponse,
                                          Types.XenAPIException,
                                          org.apache.xmlrpc.XmlRpcException

Get the installation_size field of the given pool_update. First published in XenServer 7.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getKey

public java.lang.String getKey(Connection c)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Get the key field of the given pool_update. First published in XenServer 7.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getAfterApplyGuidance

public java.util.Set<Types.UpdateAfterApplyGuidance> getAfterApplyGuidance(Connection c)
                                                                    throws Types.BadServerResponse,
                                                                           Types.XenAPIException,
                                                                           org.apache.xmlrpc.XmlRpcException

Get the after_apply_guidance field of the given pool_update. First published in XenServer 7.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getVdi

public VDI getVdi(Connection c)
           throws Types.BadServerResponse,
                  Types.XenAPIException,
                  org.apache.xmlrpc.XmlRpcException

Get the vdi field of the given pool_update. First published in XenServer 7.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getHosts

public java.util.Set<Host> getHosts(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get the hosts field of the given pool_update. First published in XenServer 7.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getOtherConfig

public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
                                                                throws Types.BadServerResponse,
                                                                       Types.XenAPIException,
                                                                       org.apache.xmlrpc.XmlRpcException

Get the other_config field of the given pool_update. First published in XenServer 7.3.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getEnforceHomogeneity

public java.lang.Boolean getEnforceHomogeneity(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException

Get the enforce_homogeneity field of the given pool_update. First published in XenServer 7.3.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                  java.util.Map<java.lang.String,java.lang.String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the other_config field of the given pool_update. First published in XenServer 7.3.

Parameters:: otherConfig - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                    java.lang.String key,
                    java.lang.String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the other_config field of the given pool_update. First published in XenServer 7.3.

Parameters:: key - Key to add; value - Value to add
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
                         java.lang.String key)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

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. First published in XenServer 7.3.

Parameters:: key - Key to remove
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

introduceAsync

public static Task introduceAsync(Connection c,
                  VDI vdi)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Introduce update VDI First published in XenServer 7.1.

Parameters:: vdi - The VDI which contains a software update.
Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

introduce

public static PoolUpdate introduce(Connection c,
                   VDI vdi)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Introduce update VDI First published in XenServer 7.1.

Parameters:: vdi - The VDI which contains a software update.
Returns:: the introduced pool update
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

precheckAsync

public Task precheckAsync(Connection c,
                 Host host)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Execute the precheck stage of the selected update on a host First published in XenServer 7.1.

Parameters:: host - The host to run the prechecks on.
Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

precheck

public Types.LivepatchStatus precheck(Connection c,
                             Host host)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Execute the precheck stage of the selected update on a host First published in XenServer 7.1.

Parameters:: host - The host to run the prechecks on.
Returns:: The precheck pool update
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

applyAsync

public Task applyAsync(Connection c,
              Host host)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException

Apply the selected update to a host First published in XenServer 7.1.

Parameters:: host - The host to apply the update to.
Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

apply

public void apply(Connection c,
         Host host)
           throws Types.BadServerResponse,
                  Types.XenAPIException,
                  org.apache.xmlrpc.XmlRpcException

Apply the selected update to a host First published in XenServer 7.1.

Parameters:: host - The host to apply the update to.
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

poolApplyAsync

public Task poolApplyAsync(Connection c)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Apply the selected update to all hosts in the pool First published in XenServer 7.1.

Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

poolApply

public void poolApply(Connection c)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException

Apply the selected update to all hosts in the pool First published in XenServer 7.1.

Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

poolCleanAsync

public Task poolCleanAsync(Connection c)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Removes the update's files from all hosts in the pool, but does not revert the update First published in XenServer 7.1.

Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

poolClean
```
public void poolClean(Connection c)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException
```
Removes the update's files from all hosts in the pool, but does not revert the update First published in XenServer 7.1.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Removes the database entry. Only works on unapplied update. First published in XenServer 7.1.

Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException