host_patch
Deprecated
Class: host_patch
Represents a patch stored on a server
| Published in: | XenServer 4.0 (rio) | Represents a patch stored on a server |
| Deprecated in: | XenServer 7.1 (ely) | |
Fields
bool
applied
[RO/runtime]
True if the patch has been applied
| Published in: | XenServer 4.0 (rio) | True if the patch has been applied |
host ref
host
[RO/constructor]
Host the patch relates to
| Published in: | XenServer 4.0 (rio) | Host the patch relates 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 |
pool_patch ref
pool_patch
[RO/constructor]
The patch applied
| Default value: | Null |
| Published in: | XenServer 4.1 (miami) | The patch applied |
int
size
[RO/runtime]
Size of the patch
| Published in: | XenServer 4.0 (rio) | Size of the patch |
datetime
timestamp_applied
[RO/runtime]
Time the patch was applied
| Published in: | XenServer 4.0 (rio) | Time the patch was applied |
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
| Published in: | XenServer 4.0 (rio) | Patch version number |
Messages
void
add_to_other_config
(session ref, host_patch ref, string, string)
Add the given key-value pair to the other_config field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_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, host_patch ref)
Apply the selected patch and return its output
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | The patch to apply |
| Minimum role: | pool-operator |
| Result: | the output of the patch application process |
| Published in: | XenServer 4.0 (rio) | Apply the selected patch and return its output |
| Deprecated in: | XenServer 4.1 (miami) | |
Deprecated
void
destroy
(session ref, host_patch ref)
Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | The patch to destroy |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.0 (rio) | Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch |
| Deprecated in: | XenServer 4.1 (miami) | |
Deprecated
host_patch ref set
get_all
(session ref)
Return a list of all the host_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.0 (rio) | Represents a patch stored on a server |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
(host_patch ref → host_patch record) map
get_all_records
(session ref)
Return a map of host_patch references to host_patch records for all host_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.0 (rio) | Represents a patch stored on a server |
| Deprecated in: | XenServer 7.1 (ely) | |
bool
get_applied
(session ref, host_patch ref)
Get the applied field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | True if the patch has been applied |
Deprecated
host_patch ref set
get_by_name_label
(session ref, string)
Get all the host_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.0 (rio) | Represents a patch stored on a server |
| Deprecated in: | XenServer 7.1 (ely) | |
Deprecated
host_patch ref
get_by_uuid
(session ref, string)
Get a reference to the host_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.0 (rio) | Represents a patch stored on a server |
| Deprecated in: | XenServer 7.1 (ely) | |
host ref
get_host
(session ref, host_patch ref)
Get the host field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Host the patch relates to |
string
get_name_description
(session ref, host_patch ref)
Get the name/description field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_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, host_patch ref)
Get the name/label field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_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, host_patch ref)
Get the other_config field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | additional configuration |
pool_patch ref
get_pool_patch
(session ref, host_patch ref)
Get the pool_patch field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | The patch applied |
Deprecated
host_patch record
get_record
(session ref, host_patch ref)
Get a record containing the current state of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 4.0 (rio) | Represents a patch stored on a server |
| Deprecated in: | XenServer 7.1 (ely) | |
int
get_size
(session ref, host_patch ref)
Get the size field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Size of the patch |
datetime
get_timestamp_applied
(session ref, host_patch ref)
Get the timestamp_applied field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Time the patch was applied |
string
get_uuid
(session ref, host_patch ref)
Get the uuid field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_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, host_patch ref)
Get the version field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_patch ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Patch version number |
void
remove_from_other_config
(session ref, host_patch ref, string)
Remove the given key and its corresponding value from the other_config field of the given host_patch. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| host_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, host_patch ref, (string → string) map)
Set the other_config field of the given host_patch.
| Parameters: | session ref session_id | Reference to a valid session |
| host_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 |