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
    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

      • getRpcRequestsQuota

        NonZeroUint16Type getRpcRequestsQuota()
        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 not present

      • isSwitchFeaturesMandatory

        Boolean isSwitchFeaturesMandatory()
        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 not present

      • getGlobalNotificationQuota

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

      • isIsStatisticsPollingOn

        Boolean isIsStatisticsPollingOn()
        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 not present

      • isIsTableStatisticsPollingOn

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

      • isIsFlowStatisticsPollingOn

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

      • isIsGroupStatisticsPollingOn

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

      • isIsMeterStatisticsPollingOn

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

      • isIsPortStatisticsPollingOn

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

      • isIsQueueStatisticsPollingOn

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

      • isIsStatisticsRpcEnabled

        @Deprecated
Boolean isIsStatisticsRpcEnabled()
        Deprecated.
        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 not present

      • getBarrierIntervalTimeoutLimit

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

      • getBarrierCountLimit

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

      • getEchoReplyTimeout

        NonZeroUint32Type getEchoReplyTimeout()
        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 not present

      • getThreadPoolMinThreads

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

      • getThreadPoolMaxThreads

        NonZeroUint16Type getThreadPoolMaxThreads()
        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 not present

      • getThreadPoolTimeout

        org.opendaylight.yangtools.yang.common.Uint32 getThreadPoolTimeout()
        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 not present

      • isEnableFlowRemovedNotification

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

      • isSkipTableFeatures

        Boolean isSkipTableFeatures()
        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 not present

      • getBasicTimerDelay

        NonZeroUint32Type getBasicTimerDelay()
        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 not present

      • getMaximumTimerDelay

        NonZeroUint32Type getMaximumTimerDelay()
        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 not present

      • isUseSingleLayerSerialization

        Boolean isUseSingleLayerSerialization()
        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 not present

      • isEnableEqualRole

        Boolean isEnableEqualRole()
        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 not present

      • getDeviceConnectionRateLimitPerMin

        org.opendaylight.yangtools.yang.common.Uint16 getDeviceConnectionRateLimitPerMin()
        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 not present

      • getDeviceConnectionHoldTimeInSeconds

        org.opendaylight.yangtools.yang.common.Uint16 getDeviceConnectionHoldTimeInSeconds()
        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 not present

      • getDeviceDatastoreRemovalDelay

        NonZeroUint32Type getDeviceDatastoreRemovalDelay()
        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 not present

      • isEnableCustomTrustManager

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