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