Develop for XenServer

Class: host_patch

June 19, 2024

Contributed by:

X X

This class is deprecated.

Represents a patch stored on a server

Fields for class: host_patch

Field	Type	Qualifier	Description
`applied`	`bool`	RO/runtime	Deprecated. True if the patch has been applied
`host`	`host ref`	RO/constructor	Deprecated. Host the patch relates to
`name_description`	`string`	RO/constructor	Deprecated. a notes field containing human-readable description
`name_label`	`string`	RO/constructor	Deprecated. a human-readable name
`other_config`	`(string -> string) map`	RW	Deprecated. additional configuration
`pool_patch`	`pool_patch ref`	RO/constructor	Deprecated. The patch applied
`size`	`int`	RO/runtime	Deprecated. Size of the patch
`timestamp_applied`	`datetime`	RO/runtime	Deprecated. Time the patch was applied
`uuid`	`string`	RO/runtime	Deprecated. Unique identifier/object reference
`version`	`string`	RO/constructor	Deprecated. Patch version number

RPCs associated with class: host_patch

RPC name: add_to_other_config

This message is deprecated.

Overview:

Add the given key-value pair to the other_config field of the given host_patch.

Signature:

void add_to_other_config (session ref session_ref, host_patch ref self, string key, string value)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	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

Return Type: void

RPC name: apply

This message is deprecated.

Overview:

Apply the selected patch and return its output

Signature:

string apply (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	The patch to apply

Minimum Role: pool-operator

Return Type: string

the output of the patch application process

RPC name: destroy

This message is deprecated.

Overview:

Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch

Signature:

void destroy (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	The patch to destroy

Minimum Role: pool-operator

Return Type: void

RPC name: get_all

This message is deprecated.

Overview:

Return a list of all the host_patchs known to the system.

Signature:

host_patch ref set get_all (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session

Minimum Role: read-only

Return Type: host_patch ref set

references to all objects

RPC name: get_all_records

This message is deprecated.

Overview:

Return a map of host_patch references to host_patch records for all host_patchs known to the system.

Signature:

(host_patch ref -> host_patch record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session

Minimum Role: read-only

Return Type: (host_patch ref -> host_patch record) map

records of all objects

RPC name: get_applied

This message is deprecated.

Overview:

Get the applied field of the given host_patch.

Signature:

bool get_applied (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_by_name_label

This message is deprecated.

Overview:

Get all the host_patch instances with the given label.

Signature:

host_patch ref set get_by_name_label (session ref session_ref, string label)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`string`	`label`	label of object to return

Minimum Role: read-only

Return Type: host_patch ref set

references to objects with matching names

RPC name: get_by_uuid

This message is deprecated.

Overview:

Get a reference to the host_patch instance with the specified UUID.

Signature:

host_patch ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`string`	`uuid`	UUID of object to return

Minimum Role: read-only

Return Type: host_patch ref

reference to the object

RPC name: get_host

This message is deprecated.

Overview:

Get the host field of the given host_patch.

Signature:

host ref get_host (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: host ref

value of the field

RPC name: get_name_description

This message is deprecated.

Overview:

Get the name/description field of the given host_patch.

Signature:

string get_name_description (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_name_label

This message is deprecated.

Overview:

Get the name/label field of the given host_patch.

Signature:

string get_name_label (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_other_config

This message is deprecated.

Overview:

Get the other_config field of the given host_patch.

Signature:

(string -> string) map get_other_config (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_pool_patch

This message is deprecated.

Overview:

Get the pool_patch field of the given host_patch.

Signature:

pool_patch ref get_pool_patch (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: pool_patch ref

value of the field

RPC name: get_record

This message is deprecated.

Overview:

Get a record containing the current state of the given host_patch.

Signature:

host_patch record get_record (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: host_patch record

all fields from the object

RPC name: get_size

This message is deprecated.

Overview:

Get the size field of the given host_patch.

Signature:

int get_size (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: int

value of the field

RPC name: get_timestamp_applied

This message is deprecated.

Overview:

Get the timestamp_applied field of the given host_patch.

Signature:

datetime get_timestamp_applied (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: datetime

value of the field

RPC name: get_uuid

This message is deprecated.

Overview:

Get the uuid field of the given host_patch.

Signature:

string get_uuid (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_version

This message is deprecated.

Overview:

Get the version field of the given host_patch.

Signature:

string get_version (session ref session_ref, host_patch ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: remove_from_other_config

This message is deprecated.

Overview:

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.

Signature:

void remove_from_other_config (session ref session_ref, host_patch ref self, string key)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`host_patch ref`	`self`	reference to the object
`string`	`key`	Key to remove

Minimum Role: pool-operator

Return Type: void

RPC name: set_other_config

This message is deprecated.

Overview:

Set the other_config field of the given host_patch.

Signature:

void set_other_config (session ref session_ref, host_patch ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	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

Return Type: void

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: host_patch

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Was this helpful

Class: host_patch

Fields for class: host_patch

RPCs associated with class: host_patch

RPC name: add_to_other_config

RPC name: apply

RPC name: destroy

RPC name: get_all

RPC name: get_all_records

RPC name: get_applied

RPC name: get_by_name_label

RPC name: get_by_uuid

RPC name: get_host

RPC name: get_name_description

RPC name: get_name_label

RPC name: get_other_config

RPC name: get_pool_patch

RPC name: get_record

RPC name: get_size

RPC name: get_timestamp_applied

RPC name: get_uuid

RPC name: get_version

RPC name: remove_from_other_config

RPC name: set_other_config

In this article