Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018

Interface NetworkInstanceConfig

  • 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
    public interface NetworkInstanceConfig
extends org.opendaylight.yangtools.yang.binding.DataObject
    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;
   }
 }
    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  

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getName

        @Nullable String getName()
        An operator-assigned unique name for the forwarding instance
        Returns:
        java.lang.String name, or null if not present

      • getType

        @Nullable Class<? extends NetworkInstanceType> getType()
        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, or null if not present

      • isEnabled

        @Nullable Boolean isEnabled()
        Whether the network instance should be configured to be active on the network element
        Returns:
        java.lang.Boolean enabled, or null if not present

      • getDescription

        @Nullable String getDescription()
        A free-form string to be used by the network operator to describe the function of this network instance
        Returns:
        java.lang.String description, or null if not present

      • getRouterId

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad getRouterId()
        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, or null if not present

      • getRouteDistinguisher

        @Nullable RouteDistinguisher getRouteDistinguisher()
        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, or null if not present