BUG-4931: Simple routing policy

[bgpcep.git] / bgp / rib-api / src / main / yang / bgp-rib.yang

diff --git a/bgp/rib-api/src/main/yang/bgp-rib.yang b/bgp/rib-api/src/main/yang/bgp-rib.yang
index 7df5312e92c4b78db542d4872bd26cd91f8c49e0..0133a4968316ef02b1cf7abb53623c3a6c2e4fb6 100644 (file)
--- a/bgp/rib-api/src/main/yang/bgp-rib.yang
+++ b/bgp/rib-api/src/main/yang/bgp-rib.yang
@@ -3,16 +3,16 @@ module bgp-rib {
         namespace "urn:opendaylight:params:xml:ns:yang:bgp-rib";
         prefix "rib";
 
-       import bgp-message { prefix bgp-msg; revision-date 2013-09-19; }
-       import bgp-multiprotocol { prefix bgp-mp; revision-date 2013-09-19; }
-       import ietf-inet-types { prefix inet; revision-date 2010-09-24; }
+    import bgp-message { prefix bgp-msg; revision-date 2013-09-19; }
+    import bgp-multiprotocol { prefix bgp-mp; revision-date 2013-09-19; }
+    import ietf-inet-types { prefix inet; revision-date 2010-09-24; }
 
         organization "Cisco Systems, Inc.";
         contact "Robert Varga <rovarga@cisco.com>";
 
         description
                 "This module contains the concept of a Routing Information Base,
-               as defined by RFC4271.
+        as defined by RFC4271.
 
                 Copyright (c)2013 Cisco Systems, Inc. All rights reserved.
 
@@ -27,71 +27,113 @@ module bgp-rib {
                 reference "RFC4271";
         }
 
-       typedef rib-id {
-               type inet:uri;
-       }
-
-       grouping route {
-               container attributes {
-                       uses bgp-msg:path-attributes;
-               }
-       }
-
-       grouping rib {
-               list tables {
-                       uses bgp-mp:bgp-table-type;
-                       key "afi safi";
-
-                       leaf uptodate {
-                               type boolean;
-                               default false;
-                       }
-
-                       choice routes {
-                               case ipv4-routes-case {
-                                       container ipv4-routes {
-                                               list ipv4-route {
-                                                       when "../../afi = ipv4";
-
-                                                       leaf prefix {
-                                                               type inet:ipv4-prefix;
-                                                       }
-                                                       key prefix;
-
-                                                       uses route;
-                                               }
-                                       }
-                               }
-                               case ipv6-routes-case {
-                                       container ipv6-routes {
-                                               list ipv6-route {
-                                                       when "../../afi = ipv6";
-
-                                                       leaf prefix {
-                                                               type inet:ipv6-prefix;
-                                                       }
-                                                       key prefix;
-
-                                                       uses route;
-                                               }
-                                       }
-                               }
-                       }
-               }
-       }
-
-       container bgp-rib {
-               list rib {
-                       config false;
-
-                       leaf id {
-                               type rib-id;
-                       }
-                       key id;
-
-                       container loc-rib {
-                               uses rib;
-                       }
-               }
-       }
+    typedef rib-id {
+        type inet:uri;
+    }
+
+    typedef application-rib-id {
+        type inet:uri;
+    }
+
+    typedef peer-id {
+        description
+            "An abstract peer identifier. The protocol part identifies
+            the type of the peer. One well-known protocol is define, which
+            has the following format: bgp://1.2.3.4, where 1.2.3.4 is the
+            peer's BGP Identifier in IPv4 dotted-quad format.";
+        type inet:uri;
+    }
+
+    typedef peer-role {
+        type enumeration {
+            enum ebgp;
+            enum ibgp;
+            enum rr-client;
+            enum internal;
+        }
+    }
+
+    typedef simple-routing-policy {
+        type enumeration {
+            enum announce-none { description "Don't announce routes to this peer"; }
+            enum learn-none { description "Don't learn routes from this peer"; }
+        }
+    }
+
+    grouping route {
+        uses bgp-msg:path-attributes;
+    }
+
+    grouping rib {
+        list tables {
+            uses bgp-mp:bgp-table-type;
+            key "afi safi";
+
+            container attributes {
+                leaf uptodate {
+                    type boolean;
+                    default false;
+                }
+            }
+
+            choice routes {
+               // to be augmented
+            }
+        }
+    }
+
+    list application-rib {
+        config true;
+
+        leaf id {
+            type application-rib-id;
+        }
+        key id;
+
+        uses rib;
+    }
+
+    container bgp-rib {
+        list rib {
+            config false;
+
+            leaf id {
+                type rib-id;
+            }
+            key id;
+
+            list peer {
+                key peer-id;
+                leaf peer-id {
+                    type peer-id;
+                }
+                leaf peer-role {
+                    type peer-role;
+                    mandatory true;
+                }
+                leaf simple-routing-policy {
+                    type simple-routing-policy;
+                }
+                list supported-tables {
+                    key "afi safi";
+                    uses bgp-mp:bgp-add-path-table-type;
+                }
+                container adj-rib-in {
+                    description "Routes as we have received them from the peer.";
+                    uses rib;
+                }
+                container effective-rib-in {
+                    description "Routes as processed by inbound policy.";
+                    uses rib;
+                }
+                container adj-rib-out {
+                    uses rib;
+                }
+            }
+
+            container loc-rib {
+                uses rib;
+            }
+        }
+    }
 }