Package com.xensource.xenapi
Class PoolPatch
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.PoolPatch
Pool-wide patches
First published in XenServer 4.1.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a PoolPatch -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given pool_patch.apply
(Connection c, Host host) Deprecated.since XenServer 7.1applyAsync
(Connection c, Host host) Deprecated.since XenServer 7.1void
clean
(Connection c) Deprecated.since XenServer 7.1Deprecated.since XenServer 7.1void
cleanOnHost
(Connection c, Host host) Deprecated.since XenServer 7.1cleanOnHostAsync
(Connection c, Host host) Deprecated.since XenServer 7.1void
Deprecated.since XenServer 7.1Deprecated.since XenServer 7.1boolean
If obj is a PoolPatch, compares XenAPI references for equality.Get the after_apply_guidance field of the given pool_patch.getAll
(Connection c) Deprecated.since XenServer 7.1static Map<PoolPatch,
PoolPatch.Record> Return a map of pool_patch references to pool_patch records for all pool_patchs known to the system.getByNameLabel
(Connection c, String label) Deprecated.since XenServer 7.1static PoolPatch
getByUuid
(Connection c, String uuid) Deprecated.since XenServer 7.1Get the host_patches field of the given pool_patch.Get the name/description field of the given pool_patch.Get the name/label field of the given pool_patch.Get the other_config field of the given pool_patch.Get the pool_applied field of the given pool_patch.Get the pool_update field of the given pool_patch.Deprecated.since XenServer 7.1Get the size field of the given pool_patch.Get the uuid field of the given pool_patch.Get the version field of the given pool_patch.int
hashCode()
void
Deprecated.since XenServer 7.1Deprecated.since XenServer 7.1void
Deprecated.since XenServer 7.1Deprecated.since XenServer 7.1precheck
(Connection c, Host host) Deprecated.since XenServer 7.1precheckAsync
(Connection c, Host host) Deprecated.since XenServer 7.1void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given pool_patch.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given pool_patch.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a PoolPatch, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
@Deprecated(since="XenServer 7.1") public PoolPatch.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Get a record containing the current state of the given pool_patch. Minimum allowed role: read-only First published in XenServer 4.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
@Deprecated(since="XenServer 7.1") public static PoolPatch getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Get a reference to the pool_patch instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onuuid
- 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
@Deprecated(since="XenServer 7.1") public static Set<PoolPatch> getByNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Get all the pool_patch instances with the given label. Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onlabel
- 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_patch. Minimum allowed role: read-only First published in XenServer 4.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_patch. Minimum allowed role: read-only First published in XenServer 4.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_patch. Minimum allowed role: read-only First published in XenServer 4.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_patch. Minimum allowed role: read-only First published in XenServer 4.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.
-
getSize
public Long getSize(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the size field of the given pool_patch. Minimum allowed role: read-only First published in XenServer 4.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.
-
getPoolApplied
public Boolean getPoolApplied(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the pool_applied field of the given pool_patch. Minimum allowed role: read-only First published in XenServer 4.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.
-
getHostPatches
public Set<HostPatch> getHostPatches(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host_patches field of the given pool_patch. Minimum allowed role: read-only First published in XenServer 4.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.AfterApplyGuidance> getAfterApplyGuidance(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the after_apply_guidance field of the given pool_patch. Minimum allowed role: read-only First published in XenServer 4.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.
-
getPoolUpdate
public PoolUpdate getPoolUpdate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the pool_update field of the given pool_patch. 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_patch. Minimum allowed role: read-only First published in XenServer 4.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.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the other_config field of the given pool_patch. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onotherConfig
- 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_patch. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- 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_patch. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- 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.
-
apply
@Deprecated(since="XenServer 7.1") public String apply(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Apply the selected patch to a host and return its output Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- The host to apply the patch too- Returns:
- the output of the patch application process
- 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
@Deprecated(since="XenServer 7.1") public Task applyAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Apply the selected patch to a host and return its output Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- The host to apply the patch too- 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
@Deprecated(since="XenServer 7.1") public void poolApply(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output Minimum allowed role: pool-operator First published in XenServer 4.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
@Deprecated(since="XenServer 7.1") public Task poolApplyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output Minimum allowed role: pool-operator First published in XenServer 4.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.
-
precheck
@Deprecated(since="XenServer 7.1") public String precheck(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Execute the precheck stage of the selected patch on a host and return its output Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- The host to run the prechecks on- Returns:
- the output of the patch prechecks
- 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
@Deprecated(since="XenServer 7.1") public Task precheckAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Execute the precheck stage of the selected patch on a host and return its output Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- 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.
-
clean
@Deprecated(since="XenServer 7.1") public void clean(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Removes the patch's files from the server Minimum allowed role: pool-operator First published in XenServer 4.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.
-
cleanAsync
@Deprecated(since="XenServer 7.1") public Task cleanAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Removes the patch's files from the server Minimum allowed role: pool-operator First published in XenServer 4.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
@Deprecated(since="XenServer 7.1") public void poolClean(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Removes the patch's files from all hosts in the pool, but does not remove the database entries Minimum allowed role: pool-operator First published in XenServer 6.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
@Deprecated(since="XenServer 7.1") public Task poolCleanAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Removes the patch's files from all hosts in the pool, but does not remove the database entries Minimum allowed role: pool-operator First published in XenServer 6.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
@Deprecated(since="XenServer 7.1") public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches. Minimum allowed role: pool-operator First published in XenServer 4.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
@Deprecated(since="XenServer 7.1") public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches. Minimum allowed role: pool-operator First published in XenServer 4.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.
-
cleanOnHost
@Deprecated(since="XenServer 7.1") public void cleanOnHost(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Removes the patch's files from the specified host Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onhost
- The host on which to clean the patch- 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.
-
cleanOnHostAsync
@Deprecated(since="XenServer 7.1") public Task cleanOnHostAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Removes the patch's files from the specified host Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onhost
- The host on which to clean the patch- 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
@Deprecated(since="XenServer 7.1") public static Set<PoolPatch> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Return a list of all the pool_patchs known to the system. Minimum allowed role: read-only First published in XenServer 4.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<PoolPatch,PoolPatch.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of pool_patch references to pool_patch records for all pool_patchs known to the system. Minimum allowed role: read-only First published in XenServer 4.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.
-