org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev180313.routing.ribs

Interface Rib

All Superinterfaces:

AddressFamily, Augmentable<Rib>, BindingObject, ChildOf<Ribs>, DataContainer, DataObject, Identifiable<RibKey>

public interface Rib
extends ChildOf<Ribs>, Augmentable<Rib>, AddressFamily, Identifiable<RibKey>

Each entry contains a configuration for a RIB identified by the 'name' key. Entries having the same key as a system-controlled entry in the list '/routing/ribs/rib' are used for configuring parameters of that entry. Other entries define additional user-controlled RIBs.

This class represents the following YANG schema fragment defined in module ietf-routing

 list rib {
   key name;
   leaf name {
     type string;
   }
   uses address-family {
   }
   leaf default-rib {
     if-feature multiple-ribs;
     type boolean;
     default true;
     config false;
   }
   container routes {
     config false;
     list route {
       leaf route-preference {
         type route-preference;
       }
       container next-hop {
         uses next-hop-state-content;
       }
       uses route-metadata;
     }
   }
   action active-route {
     output {
       container route {
         container next-hop {
           uses next-hop-state-content;
         }
         uses route-metadata;
       }
     }
     input;
   }
   leaf description {
     type string;
   }
 }
 

The schema path to identify an instance is ietf-routing/routing/ribs/rib

To create instances of this class use RibBuilder.

See Also:

RibBuilder, RibKey

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method and Description
@Nullable String	getDescription() Textual description of the RIB.
@Nullable String	getName() The name of the RIB.For system-controlled entries, the value of this leafmust be the same as the name of the corresponding entryin the operational state.For user-controlled entries, an arbitrary name can beused.
@Nullable Routes	getRoutes() Current contents of the RIB.
@Nullable Boolean	isDefaultRib() This flag has the value of 'true' if and only if the RIBis the default RIB for the given address family.By default, control-plane protocols place their routesin the default RIBs.
RibKey	key() Returns an unique key for the object.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev180313.AddressFamily

getAddressFamily

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

getImplementedInterface

Field Detail

QNAME

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

Method Detail

getName

@Nullable String getName()

The name of the RIB.For system-controlled entries, the value of this leafmust be the same as the name of the corresponding entryin the operational state.For user-controlled entries, an arbitrary name can beused.

Returns:

java.lang.String name, or null if not present

isDefaultRib

@Nullable Boolean isDefaultRib()

This flag has the value of 'true' if and only if the RIBis the default RIB for the given address family.By default, control-plane protocols place their routesin the default RIBs.

Returns:

java.lang.Boolean defaultRib, or null if not present

getRoutes

@Nullable Routes getRoutes()

Current contents of the RIB.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev180313.routing.ribs.rib.Routes routes, or null if not present

getDescription

@Nullable String getDescription()

Textual description of the RIB.

Returns:

java.lang.String description, or null if not present

key

RibKey key()

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<RibKey>

Returns:

Key for the object