Interface SystemGlobalConfig
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingObject,org.opendaylight.yangtools.yang.binding.DataContainer,org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface SystemGlobalConfig extends org.opendaylight.yangtools.yang.binding.DataObject
system-wide configuration parametersThis 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 Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QNameQNAME
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DomainNamegetDomainName()Return domainName, ornullif it is not present.DomainNamegetHostname()Return hostname, ornullif it is not present.StringgetLoginBanner()Return loginBanner, ornullif it is not present.StringgetMotdBanner()Return motdBanner, ornullif it is not present.Class<? extends SystemGlobalConfig>implementedInterface()default @NonNull DomainNamerequireDomainName()Return domainName, guaranteed to be non-null.default @NonNull DomainNamerequireHostname()Return hostname, guaranteed to be non-null.default @NonNull StringrequireLoginBanner()Return loginBanner, guaranteed to be non-null.default @NonNull StringrequireMotdBanner()Return motdBanner, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
Class<? extends SystemGlobalConfig> implementedInterface()
- Specified by:
implementedInterfacein interfaceorg.opendaylight.yangtools.yang.binding.DataContainer- Specified by:
implementedInterfacein interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
getHostname
DomainName getHostname()
Return hostname, ornullif it is not present.The hostname of the device -- should be a single domain label, without the domain.- Returns:
DomainNamehostname, ornullif 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:
DomainNamehostname, guaranteed to be non-null.- Throws:
NoSuchElementException- if hostname is not present
-
getDomainName
DomainName getDomainName()
Return domainName, ornullif it is not present.Specifies the domain name used to form fully qualified name for unqualified hostnames.- Returns:
DomainNamedomainName, ornullif 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:
DomainNamedomainName, guaranteed to be non-null.- Throws:
NoSuchElementException- if domainName is not present
-
getLoginBanner
String getLoginBanner()
Return loginBanner, ornullif it is not present.The console login message displayed before the login prompt, i.e., before a user logs into the system.- Returns:
StringloginBanner, ornullif 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:
StringloginBanner, guaranteed to be non-null.- Throws:
NoSuchElementException- if loginBanner is not present
-
getMotdBanner
String getMotdBanner()
Return motdBanner, ornullif 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:
StringmotdBanner, ornullif 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:
StringmotdBanner, guaranteed to be non-null.- Throws:
NoSuchElementException- if motdBanner is not present
-
-