Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.terminal.rev181121

Interface SystemTerminalCommonConfig

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Config, Config, Config, State, State, State, SystemSshServerConfig, SystemTelnetServerConfig
@Generated("mdsal-binding-generator") public interface SystemTerminalCommonConfig extends org.opendaylight.yangtools.yang.binding.DataObject
Common configuration data for terminal services

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

 grouping system-terminal-common-config {
   leaf timeout {
     type uint16;
     units seconds;
   }
   leaf rate-limit {
     type uint16;
     units conn/min;
   }
   leaf session-limit {
     type uint16;
   }
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opendaylight.yangtools.yang.common.Uint16
    getRateLimit()
    Return rateLimit, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getSessionLimit()
    Return sessionLimit, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getTimeout()
    Return timeout, or null if it is not present.
    Class<? extends SystemTerminalCommonConfig>
    implementedInterface()
     
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireRateLimit()
    Return rateLimit, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireSessionLimit()
    Return sessionLimit, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireTimeout()
    Return timeout, guaranteed to be non-null.

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

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

    • getTimeout

      org.opendaylight.yangtools.yang.common.Uint16 getTimeout()
      Return timeout, or null if it is not present. 
           
         Set the idle timeout in seconds on terminal connections to the system for the
         protocol.
      Returns:
      Uint16 timeout, or null if it is not present.

    • requireTimeout

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireTimeout()
      Return timeout, guaranteed to be non-null. 
           
         Set the idle timeout in seconds on terminal connections to the system for the
         protocol.
      Returns:
      Uint16 timeout, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if timeout is not present

    • getRateLimit

      org.opendaylight.yangtools.yang.common.Uint16 getRateLimit()
      Return rateLimit, or null if it is not present. 
           
         Set a limit on the number of connection attempts per minute to the system for
         the protocol.
      Returns:
      Uint16 rateLimit, or null if it is not present.

    • requireRateLimit

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireRateLimit()
      Return rateLimit, guaranteed to be non-null. 
           
         Set a limit on the number of connection attempts per minute to the system for
         the protocol.
      Returns:
      Uint16 rateLimit, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rateLimit is not present

    • getSessionLimit

      org.opendaylight.yangtools.yang.common.Uint16 getSessionLimit()
      Return sessionLimit, or null if it is not present. 
           
         Set a limit on the number of simultaneous active terminal sessions to the system
         for the protocol (e.g., ssh, telnet, ...)
      Returns:
      Uint16 sessionLimit, or null if it is not present.

    • requireSessionLimit

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireSessionLimit()
      Return sessionLimit, guaranteed to be non-null. 
           
         Set a limit on the number of simultaneous active terminal sessions to the system
         for the protocol (e.g., ssh, telnet, ...)
      Returns:
      Uint16 sessionLimit, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if sessionLimit is not present