Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openflow.rev181121

Interface OpenflowConnectionsConfig

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Config, State
    @Generated("mdsal-binding-generator")
public interface OpenflowConnectionsConfig
extends org.opendaylight.yangtools.yang.binding.DataObject
    Configuration data for OpenFlow controller connections

    This class represents the following YANG schema fragment defined in module openconfig-openflow 

     grouping openflow-connections-config {
   leaf aux-id {
     type of-types:auxiliary-id;
   }
   leaf priority {
     type uint8;
   }
   leaf address {
     type oc-inet:ip-address;
   }
   leaf port {
     type oc-inet:port-number;
     default 6653;
   }
   leaf transport {
     type of-types:transport;
     default TCP;
   }
   leaf certificate-id {
     type string;
   }
   leaf source-interface {
     type oc-if:base-interface-ref;
   }
 }
    The schema path to identify an instance is openconfig-openflowopenflow-connections-config

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        Class<? extends OpenflowConnectionsConfig> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getAuxId

        AuxiliaryId getAuxId()
        Return auxId, or null if it is not present. 
             
         Controller auxiliary ID. Must be 0 for the main controller. One controller may
         have multiple auxiliary connections as specified by the Openflow protocol.
         Besides configuring the main controller, it is also possible to configure
         auxiliary connections. The main controller must have the aux-id set to zero. All
         others must have an aux-id different from 0.
        Returns:
        AuxiliaryId auxId, or null if it is not present.

      • requireAuxId

        default @NonNull AuxiliaryId requireAuxId()
        Return auxId, guaranteed to be non-null. 
             
         Controller auxiliary ID. Must be 0 for the main controller. One controller may
         have multiple auxiliary connections as specified by the Openflow protocol.
         Besides configuring the main controller, it is also possible to configure
         auxiliary connections. The main controller must have the aux-id set to zero. All
         others must have an aux-id different from 0.
        Returns:
        AuxiliaryId auxId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if auxId is not present

      • getPriority

        org.opendaylight.yangtools.yang.common.Uint8 getPriority()
        Return priority, or null if it is not present. 
             
         Optional value for servicing auxiliary connections with different priorities.
        Returns:
        Uint8 priority, or null if it is not present.

      • requirePriority

        default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requirePriority()
        Return priority, guaranteed to be non-null. 
             
         Optional value for servicing auxiliary connections with different priorities.
        Returns:
        Uint8 priority, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if priority is not present

      • getAddress

        IpAddress getAddress()
        Return address, or null if it is not present. 
             
         The IP address of the controller.
        Returns:
        IpAddress address, or null if it is not present.

      • requireAddress

        default @NonNull IpAddress requireAddress()
        Return address, guaranteed to be non-null. 
             
         The IP address of the controller.
        Returns:
        IpAddress address, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if address is not present

      • getPort

        PortNumber getPort()
        Return port, or null if it is not present. 
             
         Controller port to use.
        Returns:
        PortNumber port, or null if it is not present.

      • requirePort

        default @NonNull PortNumber requirePort()
        Return port, guaranteed to be non-null. 
             
         Controller port to use.
        Returns:
        PortNumber port, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if port is not present

      • getTransport

        Transport getTransport()
        Return transport, or null if it is not present. 
             
         Controller transport protocol used.
        Returns:
        Transport transport, or null if it is not present.

      • requireTransport

        default @NonNull Transport requireTransport()
        Return transport, guaranteed to be non-null. 
             
         Controller transport protocol used.
        Returns:
        Transport transport, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if transport is not present

      • getCertificateId

        String getCertificateId()
        Return certificateId, or null if it is not present. 
             
         Certificate ID is used for TLS connections. When installed, certificates are
         associated with an ID. This ID specifies the certificate to use in a TLS
         connection.
        Returns:
        String certificateId, or null if it is not present.

      • requireCertificateId

        default @NonNull String requireCertificateId()
        Return certificateId, guaranteed to be non-null. 
             
         Certificate ID is used for TLS connections. When installed, certificates are
         associated with an ID. This ID specifies the certificate to use in a TLS
         connection.
        Returns:
        String certificateId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if certificateId is not present

      • getSourceInterface

        String getSourceInterface()
        Return sourceInterface, or null if it is not present. 
             
         Optionally specify the source interface for the controller connection.
        Returns:
        String sourceInterface, or null if it is not present.

      • requireSourceInterface

        default @NonNull String requireSourceInterface()
        Return sourceInterface, guaranteed to be non-null. 
             
         Optionally specify the source interface for the controller connection.
        Returns:
        String sourceInterface, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if sourceInterface is not present