Class: SDN_controller
Describes the SDN controller that is to connect with the pool
| Published in: | XenServer 7.2 (falcon) | |
Enums
sdn_controller_protocol
| Values: | ssl | Active ssl connection |
| pssl | Passive ssl connection |
Fields
string
address
[RO/constructor]
IP address of the controller
| Default value: | "" |
| Published in: | XenServer 7.2 (falcon) | |
int
port
[RO/constructor]
TCP port of the controller
| Default value: | 0 |
| Published in: | XenServer 7.2 (falcon) | |
enum sdn_controller_protocol
protocol
[RO/constructor]
Protocol to connect with SDN controller
| Default value: | ssl |
| Published in: | XenServer 7.2 (falcon) | |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 7.2 (falcon) | |
Messages
void
forget
(session ref, SDN_controller ref)
Remove the OVS manager of the pool and destroy the db record.
| Parameters: | session ref session_id | Reference to a valid session |
| SDN_controller ref self | this SDN controller |
| Minimum role: | pool-operator |
| Published in: | XenServer 7.2 (falcon) | |
string
get_address
(session ref, SDN_controller ref)
Get the address field of the given SDN_controller.
| Parameters: | session ref session_id | Reference to a valid session |
| SDN_controller ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.2 (falcon) | |
SDN_controller ref set
get_all
(session ref)
Return a list of all the SDN_controllers known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | references to all objects |
| Published in: | XenServer 7.2 (falcon) | |
(SDN_controller ref → SDN_controller record) map
get_all_records
(session ref)
Return a map of SDN_controller references to SDN_controller records for all SDN_controllers known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | records of all objects |
| Published in: | XenServer 7.2 (falcon) | |
SDN_controller ref
get_by_uuid
(session ref, string)
Get a reference to the SDN_controller instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return |
| Minimum role: | read-only |
| Result: | reference to the object |
| Published in: | XenServer 7.2 (falcon) | |
int
get_port
(session ref, SDN_controller ref)
Get the port field of the given SDN_controller.
| Parameters: | session ref session_id | Reference to a valid session |
| SDN_controller ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.2 (falcon) | |
enum sdn_controller_protocol
get_protocol
(session ref, SDN_controller ref)
Get the protocol field of the given SDN_controller.
| Parameters: | session ref session_id | Reference to a valid session |
| SDN_controller ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.2 (falcon) | |
SDN_controller record
get_record
(session ref, SDN_controller ref)
Get a record containing the current state of the given SDN_controller.
| Parameters: | session ref session_id | Reference to a valid session |
| SDN_controller ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 7.2 (falcon) | |
string
get_uuid
(session ref, SDN_controller ref)
Get the uuid field of the given SDN_controller.
| Parameters: | session ref session_id | Reference to a valid session |
| SDN_controller ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.2 (falcon) | |
SDN_controller ref
introduce
(session ref, enum sdn_controller_protocol, string, int)
Introduce an SDN controller to the pool.
| Parameters: | session ref session_id | Reference to a valid session |
| enum 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 |
| Result: | the introduced SDN controller |
| Published in: | XenServer 7.2 (falcon) | |