-
XenServer Software Development Kit
-
-
-
Class: network_sriov
-
-
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: network_sriov
network-sriov which connects logical pif and physical pif
Fields for class: network_sriov
| Field | Type | Qualifier | Description |
|---|---|---|---|
configuration_mode |
sriov_configuration_mode |
RO/runtime | The mode for configure network sriov |
logical_PIF |
PIF ref |
RO/constructor | The logical PIF to connect to the SR-IOV network after enable SR-IOV on the physical PIF |
physical_PIF |
PIF ref |
RO/constructor | The PIF that has SR-IOV enabled |
requires_reboot |
bool |
RO/runtime | Indicates whether the host need to be rebooted before SR-IOV is enabled on the physical PIF |
uuid |
string |
RO/runtime | Unique identifier/object reference |
RPCs associated with class: network_sriov
RPC name: create
Overview:
Enable SR-IOV on the specific PIF. It will create a network-sriov based on the specific PIF and automatically create a logical PIF to connect the specific network.
Signature:
network_sriov ref create (session ref session_ref, PIF ref pif, network ref network)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PIF ref |
pif |
PIF on which to enable SR-IOV |
network ref |
network |
Network to connect SR-IOV virtual functions with VM VIFs |
Minimum Role: pool-operator
Return Type: network_sriov ref
The reference of the created network_sriov object
RPC name: destroy
Overview:
Disable SR-IOV on the specific PIF. It will destroy the network-sriov and the logical PIF accordingly.
Signature:
void destroy (session ref session_ref, network_sriov ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
network_sriov ref |
self |
SRIOV to destroy |
Minimum Role: pool-operator
Return Type: void
RPC name: get_all
Overview:
Return a list of all the network_sriovs known to the system.
Signature:
network_sriov 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: network_sriov ref set
references to all objects
RPC name: get_all_records
Overview:
Return a map of network_sriov references to network_sriov records for all network_sriovs known to the system.
Signature:
(network_sriov ref -> network_sriov 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: (network_sriov ref -> network_sriov record) map
records of all objects
RPC name: get_by_uuid
Overview:
Get a reference to the network_sriov instance with the specified UUID.
Signature:
network_sriov 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: network_sriov ref
reference to the object
RPC name: get_configuration_mode
Overview:
Get the configuration_mode field of the given network_sriov.
Signature:
sriov_configuration_mode get_configuration_mode (session ref session_ref, network_sriov ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
network_sriov ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: sriov_configuration_mode
value of the field
RPC name: get_logical_PIF
Overview:
Get the logical_PIF field of the given network_sriov.
Signature:
PIF ref get_logical_PIF (session ref session_ref, network_sriov ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
network_sriov ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: PIF ref
value of the field
RPC name: get_physical_PIF
Overview:
Get the physical_PIF field of the given network_sriov.
Signature:
PIF ref get_physical_PIF (session ref session_ref, network_sriov ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
network_sriov ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: PIF ref
value of the field
RPC name: get_record
Overview:
Get a record containing the current state of the given network_sriov.
Signature:
network_sriov record get_record (session ref session_ref, network_sriov ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
network_sriov ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: network_sriov record
all fields from the object
RPC name: get_remaining_capacity
Overview:
Get the number of free SR-IOV VFs on the associated PIF
Signature:
int get_remaining_capacity (session ref session_ref, network_sriov ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
network_sriov ref |
self |
the NETWORK_SRIOV object |
Minimum Role: read-only
Return Type: int
The number of free SR-IOV VFs on the associated PIF
RPC name: get_requires_reboot
Overview:
Get the requires_reboot field of the given network_sriov.
Signature:
bool get_requires_reboot (session ref session_ref, network_sriov ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
network_sriov ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: bool
value of the field
RPC name: get_uuid
Overview:
Get the uuid field of the given network_sriov.
Signature:
string get_uuid (session ref session_ref, network_sriov ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
network_sriov ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
Share
Share
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.