pool_patch
Deprecated
Class: pool_patch
Pool-wide patches
| Published in: | XenServer 4.1 (miami) | Pool-wide patches |
| Deprecated in: | XenServer 7.1 (ely) | |
Enums
after_apply_guidance
| Values: | restartHVM | This patch requires HVM guests to be restarted once applied. |
| restartPV | This patch requires PV guests to be restarted once applied. |
| restartHost | This patch requires the host to be restarted once applied. |
| restartXAPI | This patch requires XAPI to be restarted once applied. |
Fields
enum after_apply_guidance set
after_apply_guidance
[RO/runtime]
What the client should do after this patch has been applied.
| Default value: | {} |
| Published in: | XenServer 4.1 (miami) | What the client should do after this patch has been applied. |
host_patch ref set
host_patches
[RO/runtime]
This hosts this patch is applied to.
| Published in: | XenServer 4.1 (miami) | This hosts this patch is applied to. |
string
name_description
[RO/constructor]
a notes field containing human-readable description
| Default value: | "" |
| Published in: | XenServer 4.0 (rio) | a notes field containing human-readable description |
string
name_label
[RO/constructor]
a human-readable name
| Default value: | "" |
| Published in: | XenServer 4.0 (rio) | a human-readable name |
(string → string) map
other_config
[RW]
additional configuration
| Default value: | {} |
| Published in: | XenServer 4.1 (miami) | additional configuration |
bool
pool_applied
[RO/runtime]
This patch should be applied across the entire pool
| Default value: | false |
| Published in: | XenServer 4.1 (miami) | This patch should be applied across the entire pool |
pool_update ref
pool_update
[RO/constructor]
A reference to the associated pool_update object
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 7.1 (ely) | A reference to the associated pool_update object |
int
size
[RO/runtime]
Size of the patch
| Default value: | 0 |
| Published in: | XenServer 4.1 (miami) | Size of the patch |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
string
version
[RO/constructor]
Patch version number
| Default value: | "" |
| Published in: | XenServer 4.1 (miami) | Patch version number |
Messages
void
add_to_other_config
(session ref, pool_patch ref, string, string)
Add the given key-value pair to the other_config field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| string key | Key to add |
| string value | Value to add |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | additional configuration |
Deprecated
string
apply
(session ref, pool_patch ref, host ref)
Apply the selected patch to a host and return its output
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | The patch to apply |
| host ref host | The host to apply the patch too |
| Minimum role: | pool-operator |
| Result: | the output of the patch application process |
| Published in: | XenServer 4.1 (miami) | Apply the selected patch to a host and return its output |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
void
clean
(session ref, pool_patch ref)
Removes the patch's files from the server
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | The patch to clean up |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | Removes the patch's files from the server |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
void
clean_on_host
(session ref, pool_patch ref, host ref)
Removes the patch's files from the specified host
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | The patch to clean up |
| host ref host | The host on which to clean the patch |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.1 (tampa) | Removes the patch's files from the specified host |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
void
destroy
(session ref, pool_patch ref)
Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | The patch to destroy |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches. |
| Deprecated in: | XenServer 7.1 (ely) | |
enum after_apply_guidance set
get_after_apply_guidance
(session ref, pool_patch ref)
Get the after_apply_guidance field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | What the client should do after this patch has been applied. |
Deprecated
pool_patch ref set
get_all
(session ref)
Return a list of all the pool_patchs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | references to all objects |
| Published in: | XenServer 4.1 (miami) | Pool-wide patches |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
(pool_patch ref → pool_patch record) map
get_all_records
(session ref)
Return a map of pool_patch references to pool_patch records for all pool_patchs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | records of all objects |
| Published in: | XenServer 4.1 (miami) | Pool-wide patches |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
pool_patch ref set
get_by_name_label
(session ref, string)
Get all the pool_patch instances with the given label.
| Parameters: | session ref session_id | Reference to a valid session |
| string label | label of object to return |
| Minimum role: | read-only |
| Result: | references to objects with matching names |
| Published in: | XenServer 4.1 (miami) | Pool-wide patches |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
pool_patch ref
get_by_uuid
(session ref, string)
Get a reference to the pool_patch instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return |
| Minimum role: | read-only |
| Result: | reference to the object |
| Published in: | XenServer 4.1 (miami) | Pool-wide patches |
| Deprecated in: | XenServer 7.1 (ely) | |
host_patch ref set
get_host_patches
(session ref, pool_patch ref)
Get the host_patches field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | This hosts this patch is applied to. |
string
get_name_description
(session ref, pool_patch ref)
Get the name/description field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | a notes field containing human-readable description |
string
get_name_label
(session ref, pool_patch ref)
Get the name/label field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | a human-readable name |
(string → string) map
get_other_config
(session ref, pool_patch ref)
Get the other_config field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | additional configuration |
bool
get_pool_applied
(session ref, pool_patch ref)
Get the pool_applied field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | This patch should be applied across the entire pool |
pool_update ref
get_pool_update
(session ref, pool_patch ref)
Get the pool_update field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | A reference to the associated pool_update object |
Deprecated
pool_patch record
get_record
(session ref, pool_patch ref)
Get a record containing the current state of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 4.1 (miami) | Pool-wide patches |
| Deprecated in: | XenServer 7.1 (ely) | |
int
get_size
(session ref, pool_patch ref)
Get the size field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | Size of the patch |
string
get_uuid
(session ref, pool_patch ref)
Get the uuid field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
string
get_version
(session ref, pool_patch ref)
Get the version field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | Patch version number |
Deprecated
void
pool_apply
(session ref, pool_patch ref)
Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | The patch to apply |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
void
pool_clean
(session ref, pool_patch ref)
Removes the patch's files from all hosts in the pool, but does not remove the database entries
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | The patch to clean up |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.1 (tampa) | Removes the patch's files from all hosts in the pool, but does not remove the database entries |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
string
precheck
(session ref, pool_patch ref, host ref)
Execute the precheck stage of the selected patch on a host and return its output
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | The patch whose prechecks will be run |
| host ref host | The host to run the prechecks on |
| Minimum role: | pool-operator |
| Result: | the output of the patch prechecks |
| Published in: | XenServer 4.1 (miami) | Execute the precheck stage of the selected patch on a host and return its output |
| Deprecated in: | XenServer 7.1 (ely) | |
void
remove_from_other_config
(session ref, pool_patch ref, string)
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.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | additional configuration |
void
set_other_config
(session ref, pool_patch ref, (string → string) map)
Set the other_config field of the given pool_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| pool_patch ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | additional configuration |