com.xensource.xenapi

Class SDNController

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.SDNController

public class SDNController
extends XenAPIObject

Describes the SDN controller that is to connect with the pool First published in XenServer 7.2.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SDNController.Record Represents all the fields in a SDNController

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ref The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) If obj is a SDNController, compares XenAPI references for equality.
void	forget(Connection c) Remove the OVS manager of the pool and destroy the db record.
Task	forgetAsync(Connection c) Remove the OVS manager of the pool and destroy the db record.
java.lang.String	getAddress(Connection c) Get the address field of the given SDN_controller.
static java.util.Set<SDNController>	getAll(Connection c) Return a list of all the SDN_controllers known to the system.
static java.util.Map<SDNController,SDNController.Record>	getAllRecords(Connection c) Return a map of SDN_controller references to SDN_controller records for all SDN_controllers known to the system.
static SDNController	getByUuid(Connection c, java.lang.String uuid) Get a reference to the SDN_controller instance with the specified UUID.
java.lang.Long	getPort(Connection c) Get the port field of the given SDN_controller.
Types.SdnControllerProtocol	getProtocol(Connection c) Get the protocol field of the given SDN_controller.
SDNController.Record	getRecord(Connection c) Get a record containing the current state of the given SDN_controller.
java.lang.String	getUuid(Connection c) Get the uuid field of the given SDN_controller.
int	hashCode()
static SDNController	introduce(Connection c, Types.SdnControllerProtocol protocol, java.lang.String address, java.lang.Long port) Introduce an SDN controller to the pool.
static Task	introduceAsync(Connection c, Types.SdnControllerProtocol protocol, java.lang.String address, java.lang.Long port) Introduce an SDN controller to the pool.
java.lang.String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ref

protected final java.lang.String ref

The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)

If obj is a SDNController, compares XenAPI references for equality.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRecord

public SDNController.Record getRecord(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given SDN_controller. First published in XenServer 7.2.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static SDNController getByUuid(Connection c,
                      java.lang.String uuid)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Get a reference to the SDN_controller instance with the specified UUID. First published in XenServer 7.2.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given SDN_controller. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getProtocol

public Types.SdnControllerProtocol getProtocol(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException

Get the protocol field of the given SDN_controller. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAddress

public java.lang.String getAddress(Connection c)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Get the address field of the given SDN_controller. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPort

public java.lang.Long getPort(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Get the port field of the given SDN_controller. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

introduceAsync

public static Task introduceAsync(Connection c,
                  Types.SdnControllerProtocol protocol,
                  java.lang.String address,
                  java.lang.Long port)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Introduce an SDN controller to the pool. First published in XenServer 7.2.

Parameters:

protocol - Protocol to connect with the controller.

address - IP address of the controller.

port - TCP port of the controller.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

introduce

public static SDNController introduce(Connection c,
                      Types.SdnControllerProtocol protocol,
                      java.lang.String address,
                      java.lang.Long port)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Introduce an SDN controller to the pool. First published in XenServer 7.2.

Parameters:

protocol - Protocol to connect with the controller.

address - IP address of the controller.

port - TCP port of the controller.

Returns:

the introduced SDN controller

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

forgetAsync

public Task forgetAsync(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Remove the OVS manager of the pool and destroy the db record. First published in XenServer 7.2.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

forget

public void forget(Connection c)
            throws Types.BadServerResponse,
                   Types.XenAPIException,
                   org.apache.xmlrpc.XmlRpcException

Remove the OVS manager of the pool and destroy the db record. First published in XenServer 7.2.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<SDNController> getAll(Connection c)
                                           throws Types.BadServerResponse,
                                                  Types.XenAPIException,
                                                  org.apache.xmlrpc.XmlRpcException

Return a list of all the SDN_controllers known to the system. First published in XenServer 7.2.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<SDNController,SDNController.Record> getAllRecords(Connection c)
                                                                       throws Types.BadServerResponse,
                                                                              Types.XenAPIException,
                                                                              org.apache.xmlrpc.XmlRpcException

Return a map of SDN_controller references to SDN_controller records for all SDN_controllers known to the system. First published in XenServer 7.2.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException