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 protocolThis 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/protocolTo create instances of this class use
ProtocolBuilder
.- See Also:
ProtocolBuilder
,ProtocolKey
-
-
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 Modifier and Type Method Description Aggregate
getAggregate()
Configuration and state parameters relating to locally generated aggregate routesConfig
getConfig()
Configuration parameters relating to the routing protocol instanceClass<? extends InstallProtocolType>
getIdentifier()
The protocol name for the routing or forwarding protocol to be instantiatedString
getName()
An operator-assigned identifier for the routing or forwarding protocol.State
getState()
State parameters relating to the routing protocol instanceStatic
getStatic()
Configuration and state parameters relating to static routesdefault Class<Protocol>
implementedInterface()
ProtocolKey
key()
-
-
-
Method Detail
-
implementedInterface
default Class<Protocol> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
getIdentifier
Class<? extends InstallProtocolType> getIdentifier()
The protocol name for the routing or forwarding protocol to be instantiated- Returns:
java.lang.Class
identifier
, ornull
if not present
-
getName
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
, ornull
if not present
-
getConfig
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
, ornull
if not present
-
getState
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
, ornull
if not present
-
getStatic
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
, ornull
if not present
-
getAggregate
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
, ornull
if not present
-
key
ProtocolKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<ProtocolKey>
-
-