Interface SystemNtpConfig

  • 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 SystemNtpConfig
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Configuration data for system-wide NTP operation.

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

     grouping system-ntp-config {
       leaf enabled {
         type boolean;
         default false;
       }
       leaf ntp-source-address {
         type oc-inet:ip-address;
       }
       leaf enable-ntp-auth {
         type boolean;
         default false;
       }
     }
     
    The schema path to identify an instance is openconfig-systemsystem-ntp-config
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        Boolean getEnabled()
        Return enabled, or null if it is not present.
             
                 Enables the NTP protocol and indicates that the system should attempt to
                 synchronize the system clock with an NTP server from the servers defined in the
                 'ntp/server' list.
             
         
        Returns:
        Boolean enabled, or null if it is not present.
      • requireEnabled

        default @NonNull Boolean requireEnabled()
        Return enabled, guaranteed to be non-null.
             
                 Enables the NTP protocol and indicates that the system should attempt to
                 synchronize the system clock with an NTP server from the servers defined in the
                 'ntp/server' list.
             
         
        Returns:
        Boolean enabled, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if enabled is not present
      • getNtpSourceAddress

        IpAddress getNtpSourceAddress()
        Return ntpSourceAddress, or null if it is not present.
             
                 Source address to use on outgoing NTP packets
             
         
        Returns:
        IpAddress ntpSourceAddress, or null if it is not present.
      • requireNtpSourceAddress

        default @NonNull IpAddress requireNtpSourceAddress()
        Return ntpSourceAddress, guaranteed to be non-null.
             
                 Source address to use on outgoing NTP packets
             
         
        Returns:
        IpAddress ntpSourceAddress, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ntpSourceAddress is not present
      • getEnableNtpAuth

        Boolean getEnableNtpAuth()
        Return enableNtpAuth, or null if it is not present.
             
                 Enable or disable NTP authentication -- when enabled, the system will only use
                 packets containing a trusted authentication key to synchronize the time.
             
         
        Returns:
        Boolean enableNtpAuth, or null if it is not present.
      • requireEnableNtpAuth

        default @NonNull Boolean requireEnableNtpAuth()
        Return enableNtpAuth, guaranteed to be non-null.
             
                 Enable or disable NTP authentication -- when enabled, the system will only use
                 packets containing a trusted authentication key to synchronize the time.
             
         
        Returns:
        Boolean enableNtpAuth, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if enableNtpAuth is not present