Develop for XenServer

Class: PVS_site

June 19, 2024

Contributed by:

X X

machines serving blocks of data for provisioning VMs

Fields for class: PVS_site

Field	Type	Qualifier	Description
`cache_storage`	`PVS_cache_storage ref set`	RO/runtime	The SR used by PVS proxy for the cache
`name_description`	`string`	RW	a notes field containing human-readable description
`name_label`	`string`	RW	a human-readable name
`proxies`	`PVS_proxy ref set`	RO/runtime	The set of proxies associated with the site
`PVS_uuid`	`string`	RO/constructor	Unique identifier of the PVS site, as configured in PVS
`servers`	`PVS_server ref set`	RO/runtime	The set of PVS servers in the site
`uuid`	`string`	RO/runtime	Unique identifier/object reference

RPCs associated with class: PVS_site

RPC name: forget

Overview:

Remove a site’s meta data

Signature:

void forget (session ref session_ref, PVS_site ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`PVS_site ref`	`self`	this PVS site

Minimum Role: pool-operator

Return Type: void

Possible Error Codes: PVS_SITE_CONTAINS_RUNNING_PROXIES, PVS_SITE_CONTAINS_SERVERS

RPC name: get_all

Overview:

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

Signature:

PVS_site 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: PVS_site ref set

references to all objects

RPC name: get_all_records

Overview:

Return a map of PVS_site references to PVS_site records for all PVS_sites known to the system.

Signature:

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

records of all objects

RPC name: get_by_name_label

Overview:

Get all the PVS_site instances with the given label.

Signature:

PVS_site 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: PVS_site ref set

references to objects with matching names

RPC name: get_by_uuid

Overview:

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

Signature:

PVS_site 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: PVS_site ref

reference to the object

RPC name: get_cache_storage

Overview:

Get the cache_storage field of the given PVS_site.

Signature:

PVS_cache_storage ref set get_cache_storage (session ref session_ref, PVS_site ref self)
<!--NeedCopy-->

Arguments:

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

Minimum Role: read-only

Return Type: PVS_cache_storage ref set

value of the field

RPC name: get_name_description

Overview:

Get the name/description field of the given PVS_site.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_name_label

Overview:

Get the name/label field of the given PVS_site.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_proxies

Overview:

Get the proxies field of the given PVS_site.

Signature:

PVS_proxy ref set get_proxies (session ref session_ref, PVS_site ref self)
<!--NeedCopy-->

Arguments:

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

Minimum Role: read-only

Return Type: PVS_proxy ref set

value of the field

RPC name: get_PVS_uuid

Overview:

Get the PVS_uuid field of the given PVS_site.

Signature:

string get_PVS_uuid (session ref session_ref, PVS_site ref self)
<!--NeedCopy-->

Arguments:

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

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_record

Overview:

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

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: PVS_site record

all fields from the object

RPC name: get_servers

Overview:

Get the servers field of the given PVS_site.

Signature:

PVS_server ref set get_servers (session ref session_ref, PVS_site ref self)
<!--NeedCopy-->

Arguments:

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

Minimum Role: read-only

Return Type: PVS_server ref set

value of the field

RPC name: get_uuid

Overview:

Get the uuid field of the given PVS_site.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: string

value of the field

RPC name: introduce

Overview:

Introduce new PVS site

Signature:

PVS_site ref introduce (session ref session_ref, string name_label, string name_description, string PVS_uuid)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`string`	`name_label`	name of the PVS site
`string`	`name_description`	description of the PVS site
`string`	`PVS_uuid`	unique identifier of the PVS site

Minimum Role: pool-operator

Return Type: PVS_site ref

the new PVS site

RPC name: set_name_description

Overview:

Set the name/description field of the given PVS_site.

Signature:

void set_name_description (session ref session_ref, PVS_site ref self, string value)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`PVS_site ref`	`self`	reference to the object
`string`	`value`	New value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_name_label

Overview:

Set the name/label field of the given PVS_site.

Signature:

void set_name_label (session ref session_ref, PVS_site ref self, string value)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`PVS_site ref`	`self`	reference to the object
`string`	`value`	New value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_PVS_uuid

Overview:

Update the PVS UUID of the PVS site

Signature:

void set_PVS_uuid (session ref session_ref, PVS_site ref self, string value)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`PVS_site ref`	`self`	this PVS site
`string`	`value`	PVS UUID to be used

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: PVS_site

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Class: PVS_site

Fields for class: PVS_site

RPCs associated with class: PVS_site

RPC name: forget

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_name_label

RPC name: get_by_uuid

RPC name: get_cache_storage

RPC name: get_name_description

RPC name: get_name_label

RPC name: get_proxies

RPC name: get_PVS_uuid

RPC name: get_record

RPC name: get_servers

RPC name: get_uuid

RPC name: introduce

RPC name: set_name_description

RPC name: set_name_label

RPC name: set_PVS_uuid

In this article