Interface SystemGlobalConfig

  • 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 SystemGlobalConfig
    extends org.opendaylight.yangtools.yang.binding.DataObject
    system-wide configuration parameters

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

     grouping system-global-config {
       leaf hostname {
         type oc-inet:domain-name;
       }
       leaf domain-name {
         type oc-inet:domain-name;
       }
       leaf login-banner {
         type string;
       }
       leaf motd-banner {
         type string;
       }
     }
     
    The schema path to identify an instance is openconfig-systemsystem-global-config
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        DomainName getHostname()
        Return hostname, or null if it is not present.
             
                 The hostname of the device -- should be a single domain label, without the
                 domain.
             
         
        Returns:
        DomainName hostname, or null if it is not present.
      • requireHostname

        default @NonNull DomainName requireHostname()
        Return hostname, guaranteed to be non-null.
             
                 The hostname of the device -- should be a single domain label, without the
                 domain.
             
         
        Returns:
        DomainName hostname, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if hostname is not present
      • getDomainName

        DomainName getDomainName()
        Return domainName, or null if it is not present.
             
                 Specifies the domain name used to form fully qualified name for unqualified
                 hostnames.
             
         
        Returns:
        DomainName domainName, or null if it is not present.
      • requireDomainName

        default @NonNull DomainName requireDomainName()
        Return domainName, guaranteed to be non-null.
             
                 Specifies the domain name used to form fully qualified name for unqualified
                 hostnames.
             
         
        Returns:
        DomainName domainName, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if domainName is not present
      • getLoginBanner

        String getLoginBanner()
        Return loginBanner, or null if it is not present.
             
                 The console login message displayed before the login prompt, i.e., before a user
                 logs into the system.
             
         
        Returns:
        String loginBanner, or null if it is not present.
      • requireLoginBanner

        default @NonNull String requireLoginBanner()
        Return loginBanner, guaranteed to be non-null.
             
                 The console login message displayed before the login prompt, i.e., before a user
                 logs into the system.
             
         
        Returns:
        String loginBanner, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if loginBanner is not present
      • getMotdBanner

        String getMotdBanner()
        Return motdBanner, or null if it is not present.
             
                 The console message displayed after a user logs into the system. They system may
                 append additional standard information such as the current system date and time,
                 uptime, last login timestamp, etc.
             
         
        Returns:
        String motdBanner, or null if it is not present.
      • requireMotdBanner

        default @NonNull String requireMotdBanner()
        Return motdBanner, guaranteed to be non-null.
             
                 The console message displayed after a user logs into the system. They system may
                 append additional standard information such as the current system date and time,
                 uptime, last login timestamp, etc.
             
         
        Returns:
        String motdBanner, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if motdBanner is not present