Interface NetworkInstanceConfig
- All Superinterfaces:
org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>
,org.opendaylight.yangtools.binding.BindingObject
,org.opendaylight.yangtools.binding.DataContainer
,org.opendaylight.yangtools.binding.Grouping
@Generated("mdsal-binding-generator")
public interface NetworkInstanceConfig
extends org.opendaylight.yangtools.binding.Grouping
Configuration parameters relating to a top-level network instance
This 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; } }
-
Method Summary
Modifier and TypeMethodDescriptionReturn description, ornull
if it is not present.Return enabled, ornull
if it is not present.getName()
Return name, ornull
if it is not present.Return routeDistinguisher, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad
Return routerId, ornull
if it is not present.getType()
Return type, ornull
if it is not present.default @NonNull String
Return description, guaranteed to be non-null.default @NonNull Boolean
Return enabled, guaranteed to be non-null.default @NonNull String
Return name, guaranteed to be non-null.default @NonNull RouteDistinguisher
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
Return routerId, guaranteed to be non-null.default @NonNull NetworkInstanceType
Return type, guaranteed to be non-null.Methods inherited from interface org.opendaylight.yangtools.binding.BindingContract
implementedInterface
-
Method Details
-
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
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
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:
NetworkInstanceType
type, ornull
if it is not present.
-
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:
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
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
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
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
-