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

Interface Protocol

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Protocol>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Protocols>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ProtocolKey>
    public interface Protocol
extends org.opendaylight.yangtools.yang.binding.ChildOf<Protocols>, org.opendaylight.yangtools.yang.binding.Augmentable<Protocol>, org.opendaylight.yangtools.yang.binding.Identifiable<ProtocolKey>
    A process (instance) of a routing protocol. Some systems may not support more than one instance of a particular routing protocol

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

     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/protocols/protocol

    To create instances of this class use ProtocolBuilder.

    See Also:
    ProtocolBuilder, ProtocolKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<Protocol> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getIdentifier

        @Nullable Class<? extends InstallProtocolType> getIdentifier()
        The protocol name for the routing or forwarding protocol to be instantiated
        Returns:
        java.lang.Class identifier, or null if not present

      • getName

        @Nullable String getName()
        An operator-assigned identifier for the routing or forwarding protocol. For some processes this leaf may be system defined.
        Returns:
        java.lang.String name, or null if not present

      • getConfig

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

      • getState

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

      • getStatic

        @Nullable Static getStatic()
        Configuration and state parameters relating to static routes
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.protocol.Static static, or null if not present

      • getAggregate

        @Nullable Aggregate getAggregate()
        Configuration and state parameters relating to locally generated aggregate routes
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.protocol.Aggregate aggregate, or null if not present

      • key

        ProtocolKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<ProtocolKey>