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-instance/network-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 Deprecated 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 Boolean
isEnabled()
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
-
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:
java.lang.String
name, ornull
if it 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:
java.lang.Class
type, ornull
if it 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:
java.lang.Boolean
enabled, ornull
if it is not present.
-
isEnabled
@Deprecated(forRemoval=true) default Boolean isEnabled()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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:
java.lang.String
description, ornull
if it 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:
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad
routerId, ornull
if it 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:
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.types.rev151018.RouteDistinguisher
routeDistinguisher, ornull
if it is not present.
-
-