Product documentation
Develop for XenServer
8 Citrix Hypervisor 8.2 CU1
View PDF

Class: pool_patch

June 19, 2024
Contributed by: 
X X

This class is deprecated.

Pool-wide patches

Fields for class: pool_patch

Field Type Qualifier Description
after_apply_guidance after_apply_guidance set RO/runtime Deprecated. What the client should do after this patch has been applied.
host_patches host_patch ref set RO/runtime Deprecated. This hosts this patch is applied 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_applied bool RO/runtime Deprecated. This patch should be applied across the entire pool
pool_update pool_update ref RO/constructor Deprecated. A reference to the associated pool_update object
size int RO/runtime Deprecated. Size of the patch
uuid string RO/runtime Deprecated. Unique identifier/object reference
version string RO/constructor Deprecated. Patch version number

RPCs associated with class: pool_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 pool_patch.

Signature:

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

Arguments:

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

Return Type: void

RPC name: apply

This message is deprecated.

Overview:

Apply the selected patch to a host and return its output

Signature:

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

Arguments:

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

Return Type: string

the output of the patch application process

RPC name: clean

This message is deprecated.

Overview:

Removes the patch’s files from the server

Signature:

void clean (session ref session_ref, pool_patch ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
pool_patch ref self The patch to clean up

Minimum Role: pool-operator

Return Type: void

RPC name: clean_on_host

This message is deprecated.

Overview:

Removes the patch’s files from the specified host

Signature:

void clean_on_host (session ref session_ref, pool_patch ref self, host ref host)
<!--NeedCopy-->

Arguments:

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

Return Type: void

RPC name: destroy

This message is deprecated.

Overview:

Removes the patch’s files from all hosts in the pool, and removes the database entries. Only works on unapplied patches.

Signature:

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

Arguments:

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

Minimum Role: pool-operator

Return Type: void

RPC name: get_after_apply_guidance

This message is deprecated.

Overview:

Get the after_apply_guidance field of the given pool_patch.

Signature:

after_apply_guidance set get_after_apply_guidance (session ref session_ref, pool_patch ref self)
<!--NeedCopy-->

Arguments:

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

Minimum Role: read-only

Return Type: after_apply_guidance set

value of the field

RPC name: get_all

This message is deprecated.

Overview:

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

Signature:

pool_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: pool_patch ref set

references to all objects

RPC name: get_all_records

This message is deprecated.

Overview:

Return a map of pool_patch references to pool_patch records for all pool_patchs known to the system.

Signature:

(pool_patch ref -> pool_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: (pool_patch ref -> pool_patch record) map

records of all objects

RPC name: get_by_name_label

This message is deprecated.

Overview:

Get all the pool_patch instances with the given label.

Signature:

pool_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: pool_patch ref set

references to objects with matching names

RPC name: get_by_uuid

This message is deprecated.

Overview:

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

Signature:

pool_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: pool_patch ref

reference to the object

RPC name: get_host_patches

This message is deprecated.

Overview:

Get the host_patches field of the given pool_patch.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: host_patch ref set

value of the field

RPC name: get_name_description

This message is deprecated.

Overview:

Get the name/description field of the given pool_patch.

Signature:

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

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
pool_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 pool_patch.

Signature:

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

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
pool_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 pool_patch.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_pool_applied

This message is deprecated.

Overview:

Get the pool_applied field of the given pool_patch.

Signature:

bool get_pool_applied (session ref session_ref, pool_patch ref self)
<!--NeedCopy-->

Arguments:

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

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_pool_update

This message is deprecated.

Overview:

Get the pool_update field of the given pool_patch.

Signature:

pool_update ref get_pool_update (session ref session_ref, pool_patch ref self)
<!--NeedCopy-->

Arguments:

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

Minimum Role: read-only

Return Type: pool_update ref

value of the field

RPC name: get_record

This message is deprecated.

Overview:

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

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: pool_patch record

all fields from the object

RPC name: get_size

This message is deprecated.

Overview:

Get the size field of the given pool_patch.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: int

value of the field

RPC name: get_uuid

This message is deprecated.

Overview:

Get the uuid field of the given pool_patch.

Signature:

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

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
pool_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 pool_patch.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: string

value of the field

RPC name: pool_apply

This message is deprecated.

Overview:

Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output

Signature:

void pool_apply (session ref session_ref, pool_patch ref self)
<!--NeedCopy-->

Arguments:

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

Minimum Role: pool-operator

Return Type: void

RPC name: pool_clean

This message is deprecated.

Overview:

Removes the patch’s files from all hosts in the pool, but does not remove the database entries

Signature:

void pool_clean (session ref session_ref, pool_patch ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
pool_patch ref self The patch to clean up

Minimum Role: pool-operator

Return Type: void

RPC name: precheck

This message is deprecated.

Overview:

Execute the precheck stage of the selected patch on a host and return its output

Signature:

string precheck (session ref session_ref, pool_patch ref self, host ref host)
<!--NeedCopy-->

Arguments:

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

Return Type: string

the output of the patch prechecks

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 pool_patch. If the key is not in that Map, then do nothing.

Signature:

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

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
pool_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 pool_patch.

Signature:

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

Arguments:

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

Return Type: void

Class: pool_patch
June 19, 2024
Contributed by: 
X X
June 19, 2024
Contributed by: 
X X

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.