Class: pool_update
Pool-wide updates to the host software
| Published in: |
XenServer 7.1 (ely) |
Pool-wide updates to the host software |
Enums
update_after_apply_guidance
| Values: |
restartHVM |
This update requires HVM guests to be restarted once applied. |
|
restartPV |
This update requires PV guests to be restarted once applied. |
|
restartHost |
This update requires the host to be restarted once applied. |
|
restartXAPI |
This update requires XAPI to be restarted once applied. |
livepatch_status
| Values: |
ok_livepatch_complete |
An applicable live patch exists for every required component |
|
ok_livepatch_incomplete |
An applicable live patch exists but it is not sufficient |
|
ok |
There is no applicable live patch |
Fields
enum update_after_apply_guidance set
after_apply_guidance
[RO/constructor]
What the client should do after this update has been applied.
| Default value: |
{} |
| Published in: |
XenServer 7.1 (ely) |
What the client should do after this update has been applied. |
bool
enforce_homogeneity
[RO/constructor]
Flag - if true, all hosts in a pool must apply this update
| Default value: |
false |
| Published in: |
XenServer 7.3 (inverness) |
Flag - if true, all hosts in a pool must apply this update |
host ref set
hosts
[RO/runtime]
The hosts that have applied this update.
| Published in: |
XenServer 7.1 (ely) |
The hosts that have applied this update. |
int
installation_size
[RO/constructor]
Size of the update in bytes
| Default value: |
0 |
| Published in: |
XenServer 7.1 (ely) |
Size of the update in bytes |
string
key
[RO/constructor]
GPG key of the update
| Default value: |
"" |
| Published in: |
XenServer 7.1 (ely) |
GPG key of the update |
string
name_description
[RO/constructor]
a notes field containing human-readable description
| Default value: |
"" |
| Published in: |
XenServer 4.0 (rio) |
|
string
name_label
[RO/constructor]
a human-readable name
| Default value: |
"" |
| Published in: |
XenServer 4.0 (rio) |
|
(string → string) map
other_config
[RW]
additional configuration
| Default value: |
{} |
| Published in: |
XenServer 7.3 (inverness) |
additional configuration |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: |
XenServer 4.0 (rio) |
Unique identifier/object reference |
VDI ref
vdi
[RO/constructor]
VDI the update was uploaded to
| Published in: |
XenServer 4.0 (rio) |
VDI the update was uploaded to |
string
version
[RO/constructor]
Update version number
| Default value: |
"" |
| Published in: |
XenServer 7.1 (ely) |
Update version number |
Messages
void
add_to_other_config
(session ref, pool_update ref, string, string)
Add the given key-value pair to the other_config field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
|
string key |
Key to add |
|
string value |
Value to add |
| Minimum role: |
pool-operator |
| Published in: |
XenServer 7.3 (inverness) |
additional configuration |
void
apply
(session ref, pool_update ref, host ref)
Apply the selected update to a host
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
The update to apply |
|
host ref host |
The host to apply the update to. |
| Minimum role: |
pool-operator |
| Published in: |
XenServer 7.1 (ely) |
Apply the selected update to a host |
void
destroy
(session ref, pool_update ref)
Removes the database entry. Only works on unapplied update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
The update to destroy |
| Minimum role: |
pool-operator |
| Published in: |
XenServer 7.1 (ely) |
Removes the database entry. Only works on unapplied update. |
enum update_after_apply_guidance set
get_after_apply_guidance
(session ref, pool_update ref)
Get the after_apply_guidance field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 7.1 (ely) |
What the client should do after this update has been applied. |
pool_update ref set
get_all
(session ref)
Return a list of all the pool_updates 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 7.1 (ely) |
Pool-wide updates to the host software |
(pool_update ref → pool_update record) map
get_all_records
(session ref)
Return a map of pool_update references to pool_update records for all pool_updates 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 7.1 (ely) |
Pool-wide updates to the host software |
pool_update ref set
get_by_name_label
(session ref, string)
Get all the pool_update 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 7.1 (ely) |
Pool-wide updates to the host software |
pool_update ref
get_by_uuid
(session ref, string)
Get a reference to the pool_update 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 7.1 (ely) |
Pool-wide updates to the host software |
bool
get_enforce_homogeneity
(session ref, pool_update ref)
Get the enforce_homogeneity field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 7.3 (inverness) |
Flag - if true, all hosts in a pool must apply this update |
host ref set
get_hosts
(session ref, pool_update ref)
Get the hosts field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 7.1 (ely) |
The hosts that have applied this update. |
int
get_installation_size
(session ref, pool_update ref)
Get the installation_size field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 7.1 (ely) |
Size of the update in bytes |
string
get_key
(session ref, pool_update ref)
Get the key field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 7.1 (ely) |
GPG key of the update |
string
get_name_description
(session ref, pool_update ref)
Get the name/description field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 4.0 (rio) |
|
string
get_name_label
(session ref, pool_update ref)
Get the name/label field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 4.0 (rio) |
|
(string → string) map
get_other_config
(session ref, pool_update ref)
Get the other_config field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 7.3 (inverness) |
additional configuration |
pool_update record
get_record
(session ref, pool_update ref)
Get a record containing the current state of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
all fields from the object |
| Published in: |
XenServer 7.1 (ely) |
Pool-wide updates to the host software |
string
get_uuid
(session ref, pool_update ref)
Get the uuid field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update 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 |
VDI ref
get_vdi
(session ref, pool_update ref)
Get the vdi field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 4.0 (rio) |
VDI the update was uploaded to |
string
get_version
(session ref, pool_update ref)
Get the version field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 7.1 (ely) |
Update version number |
pool_update ref
introduce
(session ref, VDI ref)
Introduce update VDI
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VDI ref vdi |
The VDI which contains a software update. |
| Minimum role: |
pool-operator |
| Result: |
the introduced pool update |
| Published in: |
XenServer 7.1 (ely) |
Introduce update VDI |
void
pool_apply
(session ref, pool_update ref)
Apply the selected update to all hosts in the pool
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
The update to apply |
| Minimum role: |
pool-operator |
| Published in: |
XenServer 7.1 (ely) |
Apply the selected update to all hosts in the pool |
void
pool_clean
(session ref, pool_update ref)
Removes the update's files from all hosts in the pool, but does not revert the update
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
The update to clean up |
| Minimum role: |
pool-operator |
| Published in: |
XenServer 7.1 (ely) |
Removes the update's files from all hosts in the pool, but does not revert the update |
enum livepatch_status
precheck
(session ref, pool_update ref, host ref)
Execute the precheck stage of the selected update on a host
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
The update whose prechecks will be run |
|
host ref host |
The host to run the prechecks on. |
| Minimum role: |
pool-operator |
| Result: |
The precheck pool update |
| Published in: |
XenServer 7.1 (ely) |
Execute the precheck stage of the selected update on a host |
void
remove_from_other_config
(session ref, pool_update ref, string)
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.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
|
string key |
Key to remove |
| Minimum role: |
pool-operator |
| Published in: |
XenServer 7.3 (inverness) |
additional configuration |
void
set_other_config
(session ref, pool_update ref, (string → string) map)
Set the other_config field of the given pool_update.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
pool_update ref self |
reference to the object |
|
(string → string) map value |
New value to set |
| Minimum role: |
pool-operator |
| Published in: |
XenServer 7.3 (inverness) |
additional configuration |
