Interface NetworkInstanceConfig
-
- 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 NetworkInstanceConfig extends org.opendaylight.yangtools.yang.binding.DataObject
Configuration parameters relating to a top-level network instanceThis class represents the following YANG schema fragment defined in module openconfig-network-instance
grouping network-instance-config { leaf name { type string; } leaf type { type identityref { base network-instance-type; } } leaf enabled { type boolean; } leaf description { type string; } leaf router-id { type yang:dotted-quad; } leaf route-distinguisher { type nit:route-distinguisher; } }
The schema path to identify an instance is openconfig-network-instancenetwork-instance-config
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description String
getDescription()
Return description, ornull
if it is not present.Boolean
getEnabled()
Return enabled, ornull
if it is not present.String
getName()
Return name, ornull
if it is not present.RouteDistinguisher
getRouteDistinguisher()
Return routeDistinguisher, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad
getRouterId()
Return routerId, ornull
if it is not present.Class<? extends NetworkInstanceType>
getType()
Return type, ornull
if it is not present.Class<? extends NetworkInstanceConfig>
implementedInterface()
default @NonNull String
requireDescription()
Return description, guaranteed to be non-null.default @NonNull Boolean
requireEnabled()
Return enabled, guaranteed to be non-null.default @NonNull String
requireName()
Return name, guaranteed to be non-null.default @NonNull RouteDistinguisher
requireRouteDistinguisher()
Return routeDistinguisher, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad
requireRouterId()
Return routerId, guaranteed to be non-null.default @NonNull Class<? extends NetworkInstanceType>
requireType()
Return type, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
Class<? extends NetworkInstanceConfig> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
getName
String getName()
Return name, ornull
if it is not present.An operator-assigned unique name for the forwarding instance
- Returns:
String
name, ornull
if it is not present.
-
requireName
default @NonNull String requireName()
Return name, guaranteed to be non-null.An operator-assigned unique name for the forwarding instance
- Returns:
String
name, guaranteed to be non-null.- Throws:
NoSuchElementException
- if name is not present
-
getType
Class<? extends NetworkInstanceType> getType()
Return type, ornull
if it is not present.The type of network instance. The value of this leaf indicates the type of forwarding entries that should be supported by this network instance
- Returns:
Class<? extends NetworkInstanceType>
type, ornull
if it is not present.
-
requireType
default @NonNull Class<? extends NetworkInstanceType> requireType()
Return type, guaranteed to be non-null.The type of network instance. The value of this leaf indicates the type of forwarding entries that should be supported by this network instance
- Returns:
Class<? extends NetworkInstanceType>
type, guaranteed to be non-null.- Throws:
NoSuchElementException
- if type is not present
-
getEnabled
Boolean getEnabled()
Return enabled, ornull
if it is not present.Whether the network instance should be configured to be active on the network element
- Returns:
Boolean
enabled, ornull
if it is not present.
-
requireEnabled
default @NonNull Boolean requireEnabled()
Return enabled, guaranteed to be non-null.Whether the network instance should be configured to be active on the network element
- Returns:
Boolean
enabled, guaranteed to be non-null.- Throws:
NoSuchElementException
- if enabled is not present
-
getDescription
String getDescription()
Return description, ornull
if it is not present.A free-form string to be used by the network operator to describe the function of this network instance
- Returns:
String
description, ornull
if it is not present.
-
requireDescription
default @NonNull String requireDescription()
Return description, guaranteed to be non-null.A free-form string to be used by the network operator to describe the function of this network instance
- Returns:
String
description, guaranteed to be non-null.- Throws:
NoSuchElementException
- if description is not present
-
getRouterId
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad getRouterId()
Return routerId, ornull
if it is not present.A identifier for the local network instance - typically used within associated routing protocols or signalling routing information in another network instance
- Returns:
DottedQuad
routerId, ornull
if it is not present.
-
requireRouterId
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad requireRouterId()
Return routerId, guaranteed to be non-null.A identifier for the local network instance - typically used within associated routing protocols or signalling routing information in another network instance
- Returns:
DottedQuad
routerId, guaranteed to be non-null.- Throws:
NoSuchElementException
- if routerId is not present
-
getRouteDistinguisher
RouteDistinguisher getRouteDistinguisher()
Return routeDistinguisher, ornull
if it is not present.The route distinguisher that should be used for the local VRF or VSI instance when it is signalled via BGP.
- Returns:
RouteDistinguisher
routeDistinguisher, ornull
if it is not present.
-
requireRouteDistinguisher
default @NonNull RouteDistinguisher requireRouteDistinguisher()
Return routeDistinguisher, guaranteed to be non-null.The route distinguisher that should be used for the local VRF or VSI instance when it is signalled via BGP.
- Returns:
RouteDistinguisher
routeDistinguisher, guaranteed to be non-null.- Throws:
NoSuchElementException
- if routeDistinguisher is not present
-
-