Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510

Interface OpenflowProviderConfig

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<OpenflowProviderConfig>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OpenflowProviderConfigData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Implementing Classes:
    OpenFlowProviderConfigImpl
    @Generated("mdsal-binding-generator")
public interface OpenflowProviderConfig
extends org.opendaylight.yangtools.yang.binding.ChildOf<OpenflowProviderConfigData>, org.opendaylight.yangtools.yang.binding.Augmentable<OpenflowProviderConfig>

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

     container openflow-provider-config {
   leaf rpc-requests-quota {
     type non-zero-uint16-type;
     default 20000;
   }
   leaf switch-features-mandatory {
     type boolean;
     default false;
   }
   leaf global-notification-quota {
     type uint32;
     default 64000;
   }
   leaf is-statistics-polling-on {
     type boolean;
     default true;
   }
   leaf is-table-statistics-polling-on {
     type boolean;
     default true;
   }
   leaf is-flow-statistics-polling-on {
     type boolean;
     default true;
   }
   leaf is-group-statistics-polling-on {
     type boolean;
     default true;
   }
   leaf is-meter-statistics-polling-on {
     type boolean;
     default true;
   }
   leaf is-port-statistics-polling-on {
     type boolean;
     default true;
   }
   leaf is-queue-statistics-polling-on {
     type boolean;
     default true;
   }
   leaf is-statistics-rpc-enabled {
     status deprecated;
     type boolean;
     default false;
   }
   leaf barrier-interval-timeout-limit {
     type non-zero-uint32-type;
     default 500;
   }
   leaf barrier-count-limit {
     type non-zero-uint16-type;
     default 25600;
   }
   leaf echo-reply-timeout {
     type non-zero-uint32-type;
     default 2000;
   }
   leaf thread-pool-min-threads {
     type uint16;
     default 1;
   }
   leaf thread-pool-max-threads {
     type non-zero-uint16-type;
     default 32000;
   }
   leaf thread-pool-timeout {
     type uint32;
     default 60;
   }
   leaf enable-flow-removed-notification {
     type boolean;
     default true;
   }
   leaf skip-table-features {
     type boolean;
     default true;
   }
   leaf basic-timer-delay {
     type non-zero-uint32-type;
     default 3000;
   }
   leaf maximum-timer-delay {
     type non-zero-uint32-type;
     default 900000;
   }
   leaf use-single-layer-serialization {
     type boolean;
     default true;
   }
   leaf enable-equal-role {
     type boolean;
     default false;
   }
   leaf device-connection-rate-limit-per-min {
     type uint16;
     default 0;
   }
   leaf device-connection-hold-time-in-seconds {
     type uint16;
     default 0;
   }
   leaf device-datastore-removal-delay {
     type non-zero-uint32-type;
     default 500;
   }
   leaf enable-custom-trust-manager {
     type boolean;
     default false;
   }
 }
    The schema path to identify an instance is openflow-provider-config/openflow-provider-config

    To create instances of this class use OpenflowProviderConfigBuilder.

    See Also:
    OpenflowProviderConfigBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<OpenflowProviderConfig> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull OpenflowProviderConfig obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull OpenflowProviderConfig thisObj,
                             Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull OpenflowProviderConfig obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • getRpcRequestsQuota

        NonZeroUint16Type getRpcRequestsQuota()
        Return rpcRequestsQuota, or null if it is not present. 
             
         Quota for maximum number of RPC requests
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint16Type rpcRequestsQuota, or null if it is not present.

      • getSwitchFeaturesMandatory

        Boolean getSwitchFeaturesMandatory()
        Return switchFeaturesMandatory, or null if it is not present. 
             
         This parameter indicates whether it is mandatory for switch to support OF1.3
         features : table, flow, meter,group. If this is set to true and switch doesn't
         support these features its connection will be denied.
        Returns:
        java.lang.Boolean switchFeaturesMandatory, or null if it is not present.

      • isSwitchFeaturesMandatory

        @Deprecated(forRemoval=true)
default Boolean isSwitchFeaturesMandatory()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getGlobalNotificationQuota

        org.opendaylight.yangtools.yang.common.Uint32 getGlobalNotificationQuota()
        Return globalNotificationQuota, or null if it is not present. 
             
         Global notification quota
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 globalNotificationQuota, or null if it is not present.

      • getIsStatisticsPollingOn

        Boolean getIsStatisticsPollingOn()
        Return isStatisticsPollingOn, or null if it is not present. 
             
         If enabled, periodic statistics gathering will be turned on. If false takes
         precedence over the per-capability configuration.
        Returns:
        java.lang.Boolean isStatisticsPollingOn, or null if it is not present.

      • isIsStatisticsPollingOn

        @Deprecated(forRemoval=true)
default Boolean isIsStatisticsPollingOn()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getIsTableStatisticsPollingOn

        Boolean getIsTableStatisticsPollingOn()
        Return isTableStatisticsPollingOn, or null if it is not present. 
             
         If enabled, periodic table statistics gathering will be turned on
        Returns:
        java.lang.Boolean isTableStatisticsPollingOn, or null if it is not present.

      • isIsTableStatisticsPollingOn

        @Deprecated(forRemoval=true)
default Boolean isIsTableStatisticsPollingOn()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getIsFlowStatisticsPollingOn

        Boolean getIsFlowStatisticsPollingOn()
        Return isFlowStatisticsPollingOn, or null if it is not present. 
             
         If enabled, periodic flow statistics gathering will be turned on
        Returns:
        java.lang.Boolean isFlowStatisticsPollingOn, or null if it is not present.

      • isIsFlowStatisticsPollingOn

        @Deprecated(forRemoval=true)
default Boolean isIsFlowStatisticsPollingOn()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getIsGroupStatisticsPollingOn

        Boolean getIsGroupStatisticsPollingOn()
        Return isGroupStatisticsPollingOn, or null if it is not present. 
             
         If enabled, periodic group statistics gathering will be turned on
        Returns:
        java.lang.Boolean isGroupStatisticsPollingOn, or null if it is not present.

      • isIsGroupStatisticsPollingOn

        @Deprecated(forRemoval=true)
default Boolean isIsGroupStatisticsPollingOn()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getIsMeterStatisticsPollingOn

        Boolean getIsMeterStatisticsPollingOn()
        Return isMeterStatisticsPollingOn, or null if it is not present. 
             
         If enabled, periodic meter statistics gathering will be turned on
        Returns:
        java.lang.Boolean isMeterStatisticsPollingOn, or null if it is not present.

      • isIsMeterStatisticsPollingOn

        @Deprecated(forRemoval=true)
default Boolean isIsMeterStatisticsPollingOn()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getIsPortStatisticsPollingOn

        Boolean getIsPortStatisticsPollingOn()
        Return isPortStatisticsPollingOn, or null if it is not present. 
             
         If enabled, periodic port statistics gathering will be turned on
        Returns:
        java.lang.Boolean isPortStatisticsPollingOn, or null if it is not present.

      • isIsPortStatisticsPollingOn

        @Deprecated(forRemoval=true)
default Boolean isIsPortStatisticsPollingOn()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getIsQueueStatisticsPollingOn

        Boolean getIsQueueStatisticsPollingOn()
        Return isQueueStatisticsPollingOn, or null if it is not present. 
             
         If enabled, periodic queue statistics gathering will be turned on
        Returns:
        java.lang.Boolean isQueueStatisticsPollingOn, or null if it is not present.

      • isIsQueueStatisticsPollingOn

        @Deprecated(forRemoval=true)
default Boolean isIsQueueStatisticsPollingOn()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getIsStatisticsRpcEnabled

        @Deprecated
Boolean getIsStatisticsRpcEnabled()
        Deprecated.
        Return isStatisticsRpcEnabled, or null if it is not present. 
             
         Expose backward compatible statistics rpcs providing result in form of async
         notification. This is deprecated, use direct statistics instead.
        Returns:
        java.lang.Boolean isStatisticsRpcEnabled, or null if it is not present.

      • isIsStatisticsRpcEnabled

        @Deprecated(forRemoval=true)
default Boolean isIsStatisticsRpcEnabled()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getBarrierIntervalTimeoutLimit

        NonZeroUint32Type getBarrierIntervalTimeoutLimit()
        Return barrierIntervalTimeoutLimit, or null if it is not present. 
             
         Barrier timeout
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type barrierIntervalTimeoutLimit, or null if it is not present.

      • getBarrierCountLimit

        NonZeroUint16Type getBarrierCountLimit()
        Return barrierCountLimit, or null if it is not present. 
             
         Barrier limit
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint16Type barrierCountLimit, or null if it is not present.

      • getEchoReplyTimeout

        NonZeroUint32Type getEchoReplyTimeout()
        Return echoReplyTimeout, or null if it is not present. 
             
         How long we should wait for echo reply (value is in milliseconds
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type echoReplyTimeout, or null if it is not present.

      • getThreadPoolMinThreads

        org.opendaylight.yangtools.yang.common.Uint16 getThreadPoolMinThreads()
        Return threadPoolMinThreads, or null if it is not present. 
             
         Mininum (starting) number of threads in thread pool
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 threadPoolMinThreads, or null if it is not present.

      • getThreadPoolMaxThreads

        NonZeroUint16Type getThreadPoolMaxThreads()
        Return threadPoolMaxThreads, or null if it is not present. 
             
         Maximum number of threads in thread pool
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint16Type threadPoolMaxThreads, or null if it is not present.

      • getThreadPoolTimeout

        org.opendaylight.yangtools.yang.common.Uint32 getThreadPoolTimeout()
        Return threadPoolTimeout, or null if it is not present. 
             
         After how much time (in seconds) of inactivity will be threads in pool
         terminated
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 threadPoolTimeout, or null if it is not present.

      • getEnableFlowRemovedNotification

        Boolean getEnableFlowRemovedNotification()
        Return enableFlowRemovedNotification, or null if it is not present. 
             
         Turning on flow removed notification
        Returns:
        java.lang.Boolean enableFlowRemovedNotification, or null if it is not present.

      • isEnableFlowRemovedNotification

        @Deprecated(forRemoval=true)
default Boolean isEnableFlowRemovedNotification()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getSkipTableFeatures

        Boolean getSkipTableFeatures()
        Return skipTableFeatures, or null if it is not present. 
             
         Ability to skip pulling and storing of large table features. These features are
         still available via rpc but if set to true then maintenance in DS will be
         omitted
        Returns:
        java.lang.Boolean skipTableFeatures, or null if it is not present.

      • isSkipTableFeatures

        @Deprecated(forRemoval=true)
default Boolean isSkipTableFeatures()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getBasicTimerDelay

        NonZeroUint32Type getBasicTimerDelay()
        Return basicTimerDelay, or null if it is not present. 
             
         Initial delay used in polling the statistics, value is in milliseconds
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type basicTimerDelay, or null if it is not present.

      • getMaximumTimerDelay

        NonZeroUint32Type getMaximumTimerDelay()
        Return maximumTimerDelay, or null if it is not present. 
             
         Maximum timer delay is the wait time to collect next statistics used in polling
         the statistics, value is in milliseconds
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type maximumTimerDelay, or null if it is not present.

      • getUseSingleLayerSerialization

        Boolean getUseSingleLayerSerialization()
        Return useSingleLayerSerialization, or null if it is not present. 
             
         When true, Yang models are serialized and deserialized directly to and from
         format supported by device, so serialization and deserialization is faster.
         Otherwise, models are first serialized to Openflow specification models and then
         to format supported by device, and reversed when deserializing.
        Returns:
        java.lang.Boolean useSingleLayerSerialization, or null if it is not present.

      • isUseSingleLayerSerialization

        @Deprecated(forRemoval=true)
default Boolean isUseSingleLayerSerialization()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getEnableEqualRole

        Boolean getEnableEqualRole()
        Return enableEqualRole, or null if it is not present. 
             
         When true, openflowplugin won't send any specific role request down to the
         switch after plugin internally decides the ownership of the device using Entity
         Ownership Service. In this scenario, controller connection for the device will
         be in equal role. The behavior will be same for single node setup and clustered
         setup. In clustered scenario, all the controller will be in equal role for the
         device. In this case device will send all asynchronous event messages (e.g
         packet_in) to all the controllers, but openflowplugin will drop these events for
         the controller instances that is internally not owning the device.
        Returns:
        java.lang.Boolean enableEqualRole, or null if it is not present.

      • isEnableEqualRole

        @Deprecated(forRemoval=true)
default Boolean isEnableEqualRole()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getDeviceConnectionRateLimitPerMin

        org.opendaylight.yangtools.yang.common.Uint16 getDeviceConnectionRateLimitPerMin()
        Return deviceConnectionRateLimitPerMin, or null if it is not present. 
             
         To limit the number of datapath nodes connecting to odl controller instance per
         minute. Default value 0 indicates that the device connection rate limiter will
         be disabled.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 deviceConnectionRateLimitPerMin, or null if it is not present.

      • getDeviceConnectionHoldTimeInSeconds

        org.opendaylight.yangtools.yang.common.Uint16 getDeviceConnectionHoldTimeInSeconds()
        Return deviceConnectionHoldTimeInSeconds, or null if it is not present. 
             
         device connection hold time is the least time delay in seconds a device has to
         maintain between its consecutive connection attempts. If time delay between the
         previous connection and the current connection is within device connection hold
         time, the device will not be allowed to connect to the controller. Default value
         of the device connection hold time is 0 second.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 deviceConnectionHoldTimeInSeconds, or null if it is not present.

      • getDeviceDatastoreRemovalDelay

        NonZeroUint32Type getDeviceDatastoreRemovalDelay()
        Return deviceDatastoreRemovalDelay, or null if it is not present. 
             
         Delay (in milliseconds) before device is removed from the operational data store
         in the event of device disconnection from the controller.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type deviceDatastoreRemovalDelay, or null if it is not present.

      • getEnableCustomTrustManager

        Boolean getEnableCustomTrustManager()
        Return enableCustomTrustManager, or null if it is not present. 
             
         When true would use customtrustmanager to get switch certificate for TLS
         authentication failure notification.
        Returns:
        java.lang.Boolean enableCustomTrustManager, or null if it is not present.

      • isEnableCustomTrustManager

        @Deprecated(forRemoval=true)
default Boolean isEnableCustomTrustManager()
        Deprecated, for removal: This API element is subject to removal in a future version.