-
XenServer Software Development Kit
-
-
-
Class: PVS_proxy
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Class: PVS_proxy
a proxy connects a VM/VIF with a PVS site
Fields for class: PVS_proxy
| Field | Type | Qualifier | Description |
|---|---|---|---|
currently_attached |
bool |
RO/runtime | true = VM is currently proxied |
site |
PVS_site ref |
RO/constructor | PVS site this proxy is part of |
status |
pvs_proxy_status |
RO/runtime | The run-time status of the proxy |
uuid |
string |
RO/runtime | Unique identifier/object reference |
VIF |
VIF ref |
RO/constructor | VIF of the VM using the proxy |
RPCs associated with class: PVS_proxy
RPC name: create
Overview:
Configure a VM/VIF to use a PVS proxy
Signature:
PVS_proxy ref create (session ref session_ref, PVS_site ref site, VIF ref VIF)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_site ref |
site |
PVS site that we proxy for |
VIF ref |
VIF |
VIF for the VM that needs to be proxied |
Minimum Role: pool-operator
Return Type: PVS_proxy ref
The reference of the created PVS proxy
RPC name: destroy
Overview:
remove (or switch off) a PVS proxy for this VM
Signature:
void destroy (session ref session_ref, PVS_proxy ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_proxy ref |
self |
this PVS proxy |
Minimum Role: pool-operator
Return Type: void
RPC name: get_all
Overview:
Return a list of all the PVS_proxys known to the system.
Signature:
PVS_proxy 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_proxy ref set
references to all objects
RPC name: get_all_records
Overview:
Return a map of PVS_proxy references to PVS_proxy records for all PVS_proxys known to the system.
Signature:
(PVS_proxy ref -> PVS_proxy 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_proxy ref -> PVS_proxy record) map
records of all objects
RPC name: get_by_uuid
Overview:
Get a reference to the PVS_proxy instance with the specified UUID.
Signature:
PVS_proxy 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_proxy ref
reference to the object
RPC name: get_currently_attached
Overview:
Get the currently_attached field of the given PVS_proxy.
Signature:
bool get_currently_attached (session ref session_ref, PVS_proxy ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_proxy ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: bool
value of the field
RPC name: get_record
Overview:
Get a record containing the current state of the given PVS_proxy.
Signature:
PVS_proxy record get_record (session ref session_ref, PVS_proxy ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_proxy ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: PVS_proxy record
all fields from the object
RPC name: get_site
Overview:
Get the site field of the given PVS_proxy.
Signature:
PVS_site ref get_site (session ref session_ref, PVS_proxy ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_proxy ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: PVS_site ref
value of the field
RPC name: get_status
Overview:
Get the status field of the given PVS_proxy.
Signature:
pvs_proxy_status get_status (session ref session_ref, PVS_proxy ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_proxy ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: pvs_proxy_status
value of the field
RPC name: get_uuid
Overview:
Get the uuid field of the given PVS_proxy.
Signature:
string get_uuid (session ref session_ref, PVS_proxy ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_proxy ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
RPC name: get_VIF
Overview:
Get the VIF field of the given PVS_proxy.
Signature:
VIF ref get_VIF (session ref session_ref, PVS_proxy ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_proxy ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: VIF ref
value of the field
Share
Share
In this article
This Preview product documentation is Cloud Software Group Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Cloud Software Group Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Cloud Software Group product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.