Interface NetworkInstance

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<NetworkInstance>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<NetworkInstances>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<NetworkInstanceKey>

    public interface NetworkInstance
    extends org.opendaylight.yangtools.yang.binding.ChildOf<NetworkInstances>, org.opendaylight.yangtools.yang.binding.Augmentable<NetworkInstance>, org.opendaylight.yangtools.yang.binding.Identifiable<NetworkInstanceKey>
    Network instances configured on the local system

    This class represents the following YANG schema fragment defined in module openconfig-network-instance

     list network-instance {
       key name;
       leaf name {
         type leafref {
           path ../config/name;
         }
       }
       container config {
         uses network-instance-config;
         uses network-instance-l3vrf-config {
           when "../type = 'L3VRF'" {
           }
         }
       }
       container state {
         config false;
         uses network-instance-config;
         uses network-instance-l3vrf-config {
           when "../type = 'L3VRF'" {
           }
         }
         uses network-instance-state;
       }
       container inter-instance-policies {
         uses rpol:apply-policy-group;
       }
       container table-connections {
         list table-connection {
           key "src-table dst-table";
           leaf src-table {
             type leafref {
               path ../config/src-table;
             }
           }
           leaf dst-table {
             type leafref {
               path ../config/dst-table;
             }
           }
           container config {
             uses inter-table-policies-config;
           }
           container state {
             config false;
             uses inter-table-policies-config;
           }
           uses rpol:apply-policy-group;
         }
       }
       container tables {
         list table {
           key table-name;
           leaf table-name {
             type leafref {
               path ../config/table-name;
             }
           }
           container config {
             uses table-config;
           }
           container state {
             config false;
             uses table-config;
           }
         }
       }
       container interfaces {
         container config {
           uses instance-interfaces-config;
         }
         container state {
           config false;
           uses instance-interfaces-config;
           uses instance-interfaces-state;
         }
       }
       container connection-points {
         list connection-point {
           key connection-point-id;
           leaf connection-point-id {
             type leafref {
               path ../config/connection-point-id;
             }
           }
           container config {
             uses instance-connection-point-config;
           }
           container state {
             config false;
             uses instance-connection-point-config;
             uses instance-connection-point-state;
           }
           container endpoints {
             when "../config/type = 'L2P2P' or ../config/type = 'L2VSI'" {
             }
             list endpoint {
               key endpoint-id;
               leaf endpoint-id {
                 type leafref {
                   path ../config/endpoint-id;
                 }
               }
               container config {
                 uses instance-endpoint-config;
               }
               container state {
                 config false;
                 uses instance-endpoint-config;
                 uses instance-endpoint-state;
               }
             }
           }
         }
       }
       container protocols {
         list protocol {
           key "identifier name";
           leaf identifier {
             type leafref {
               path ../config/identifier;
             }
           }
           leaf name {
             type leafref {
               path ../config/name;
             }
           }
           container config {
             uses protocols-config;
           }
           container state {
             config false;
             uses protocols-config;
             uses protocols-state;
           }
           container static {
             when "../config/identifier = 'STATIC'" {
             }
             uses lroute:local-static-top;
           }
           container aggregate {
             when "../config/identifier = 'LOCAL-AGGREGATE'" {
             }
             uses lroute:local-aggregate-top;
           }
         }
       }
     }
     
    The schema path to identify an instance is openconfig-network-instance/network-instance-top/network-instances/network-instance

    To create instances of this class use NetworkInstanceBuilder.

    See Also:
    NetworkInstanceBuilder, NetworkInstanceKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<NetworkInstance> 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()
        A unique name identifying the network instance
        Returns:
        java.lang.String name, or null if not present
      • getConfig

        @Nullable Config getConfig()
        Configuration parameters relating to a network instance
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.Config config, or null if not present
      • getState

        @Nullable State getState()
        Operational state parameters relating to a network instance
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.State state, or null if not present
      • getInterInstancePolicies

        @Nullable InterInstancePolicies getInterInstancePolicies()
        Policies dictating how RIB or FIB entries are imported to and exported from this instance
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.InterInstancePolicies interInstancePolicies, or null if not present
      • getTableConnections

        @Nullable TableConnections getTableConnections()
        Policies dictating how RIB or FIB entries are propagated between tables
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.TableConnections tableConnections, or null if not present
      • getTables

        @Nullable Tables getTables()
        The routing tables that are managed by this network instance
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.Tables tables, or null if not present
      • getInterfaces

        @Nullable Interfaces getInterfaces()
        Interfaces associated with this network intance
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.Interfaces interfaces, or null if not present
      • getConnectionPoints

        @Nullable ConnectionPoints getConnectionPoints()
        The set of connection points within a forwarding instance
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.ConnectionPoints connectionPoints, or null if not present
      • getProtocols

        @Nullable Protocols getProtocols()
        The routing protocols that are enabled for this network-instance.
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.Protocols protocols, or null if not present