-
XenServer Software Development Kit
-
-
-
Class: SDN_controller
-
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: SDN_controller
Describes the SDN controller that is to connect with the pool
Fields for class: SDN_controller
| Field | Type | Qualifier | Description |
|---|---|---|---|
address |
string |
RO/constructor | IP address of the controller |
port |
int |
RO/constructor | TCP port of the controller |
protocol |
sdn_controller_protocol |
RO/constructor | Protocol to connect with SDN controller |
uuid |
string |
RO/runtime | Unique identifier/object reference |
RPCs associated with class: SDN_controller
RPC name: forget
Overview:
Remove the OVS manager of the pool and destroy the db record.
Signature:
void forget (session ref session_ref, SDN_controller ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
SDN_controller ref |
self |
this SDN controller |
Minimum Role: pool-operator
Return Type: void
RPC name: get_address
Overview:
Get the address field of the given SDN_controller.
Signature:
string get_address (session ref session_ref, SDN_controller ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
SDN_controller ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
RPC name: get_all
Overview:
Return a list of all the SDN_controllers known to the system.
Signature:
SDN_controller 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: SDN_controller ref set
references to all objects
RPC name: get_all_records
Overview:
Return a map of SDN_controller references to SDN_controller records for all SDN_controllers known to the system.
Signature:
(SDN_controller ref -> SDN_controller 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: (SDN_controller ref -> SDN_controller record) map
records of all objects
RPC name: get_by_uuid
Overview:
Get a reference to the SDN_controller instance with the specified UUID.
Signature:
SDN_controller 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: SDN_controller ref
reference to the object
RPC name: get_port
Overview:
Get the port field of the given SDN_controller.
Signature:
int get_port (session ref session_ref, SDN_controller ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
SDN_controller ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: int
value of the field
RPC name: get_protocol
Overview:
Get the protocol field of the given SDN_controller.
Signature:
sdn_controller_protocol get_protocol (session ref session_ref, SDN_controller ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
SDN_controller ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: sdn_controller_protocol
value of the field
RPC name: get_record
Overview:
Get a record containing the current state of the given SDN_controller.
Signature:
SDN_controller record get_record (session ref session_ref, SDN_controller ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
SDN_controller ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: SDN_controller record
all fields from the object
RPC name: get_uuid
Overview:
Get the uuid field of the given SDN_controller.
Signature:
string get_uuid (session ref session_ref, SDN_controller ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
SDN_controller ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
RPC name: introduce
Overview:
Introduce an SDN controller to the pool.
Signature:
SDN_controller ref introduce (session ref session_ref, sdn_controller_protocol protocol, string address, int port)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
sdn_controller_protocol |
protocol |
Protocol to connect with the controller. |
string |
address |
IP address of the controller. |
int |
port |
TCP port of the controller. |
Minimum Role: pool-operator
Return Type: SDN_controller ref
the introduced SDN controller
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.