Route Constrain policies
[bgpcep.git] / bgp / extensions / route-target / src / main / yang / bgp-route-target-constrain.yang
1 module bgp-route-target-constrain {
2     yang-version 1;
3     namespace "urn:opendaylight:params:xml:ns:yang:bgp:route:target:constrain";
4     prefix "bgp-route-target";
5
6     import bgp-types { prefix bgp-t; revision-date 2018-03-29; }
7     import bgp-rib { prefix bgp-rib; revision-date 2018-03-29; }
8     import bmp-monitor { prefix bmp-mon; revision-date 2018-03-29; }
9     import bgp-message { prefix bgp-msg; revision-date 2018-03-29; }
10     import ietf-inet-types { prefix inet; revision-date 2013-07-15; }
11
12     organization "AT&T Services, Inc.";
13
14     contact "Claudio D. Gasparini <claudio.gasparini@pantheon.tech>";
15
16     description
17         "This module contains the base data model of a BGP message.
18         It rolls up the definitions contained in RFC4684.
19
20         Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
21
22         This program and the accompanying materials are made available
23         under the terms of the Eclipse Public License v1.0 which
24         accompanies this distribution, and is available at
25         http://www.eclipse.org/legal/epl-v10.html";
26
27     revision 2018-06-18 {
28         description "Initial version";
29     }
30
31     identity route-target-constrain-subsequent-address-family {
32         description "SAFI 132 Route Target constrains";
33         reference "https://www.iana.org/assignments/safi-namespace/safi-namespace.xhtml";
34
35         base bgp-t:subsequent-address-family;
36     }
37
38     grouping route-target-constrain {
39         reference "https://tools.ietf.org/html/rfc4684#page-8";
40         description "The Route Target constrains NLRI is carried in BGP [RFC4684] using BGP Multiprotocol
41             Extensions [RFC4760] with an Address Family Identifier (AFI) of 1 (IPV4)
42             and a Subsequent Address Family Identifier (SAFI) of 132 (ROUTE-TARGET)";
43
44         leaf origin-as {
45             type inet:as-number;
46         }
47
48         choice route-target-constrain-choice {
49             case route-target-constrain-default-case {
50                 uses bgp-t:route-target-constrain-default-route-grouping;
51             }
52             case route-target-constrain-route-case {
53                 uses bgp-t:route-target-extended-community-grouping;
54             }
55             case route-target-constrain-ipv4-route-case {
56                 uses bgp-t:route-target-ipv4-grouping;
57             }
58             case route-target-constrain-as-4-extended-community-case {
59                 uses bgp-t:as-4-route-target-extended-community-grouping;
60             }
61             mandatory true;
62         }
63     }
64
65     grouping route-target-constrain-destination {
66         list route-target-constrain-destination {
67             uses route-target-constrain;
68             uses bgp-msg:path-id-grouping;
69         }
70     }
71
72     grouping route-target-constrain-routes {
73         container route-target-constrain-routes {
74             list route-target-constrain-route {
75                 key "route-key path-id";
76                 uses bgp-rib:route;
77                 uses route-target-constrain;
78             }
79         }
80     }
81
82     augment "/bgp-msg:update/bgp-msg:attributes/bgp-mp:mp-reach-nlri/bgp-mp:advertized-routes/bgp-mp:destination-type" {
83         case destination-route-target-constrain-advertized-case {
84             container destination-route-target-constrain {
85                 uses route-target-constrain-destination;
86             }
87         }
88     }
89
90     augment "/bgp-msg:update/bgp-msg:attributes/bgp-mp:mp-unreach-nlri/bgp-mp:withdrawn-routes/bgp-mp:destination-type" {
91         case destination-route-target-constrain-withdrawn-case {
92             container destination-route-target-constrain{
93                 uses route-target-constrain-destination;
94             }
95         }
96     }
97
98     augment "/bgp-rib:application-rib/bgp-rib:tables/bgp-rib:routes" {
99         case route-target-constrain-routes-case {
100             uses route-target-constrain-routes;
101         }
102     }
103
104     augment "/bgp-rib:bgp-rib/bgp-rib:rib/bgp-rib:loc-rib/bgp-rib:tables/bgp-rib:routes" {
105         case route-target-constrain-routes-case {
106             uses route-target-constrain-routes;
107         }
108     }
109
110     augment "/bgp-rib:bgp-rib/bgp-rib:rib/bgp-rib:peer/bgp-rib:adj-rib-in/bgp-rib:tables/bgp-rib:routes" {
111         case route-target-constrain-routes-case {
112             uses route-target-constrain-routes;
113         }
114     }
115
116     augment "/bgp-rib:bgp-rib/bgp-rib:rib/bgp-rib:peer/bgp-rib:effective-rib-in/bgp-rib:tables/bgp-rib:routes" {
117         case route-target-constrain-routes-case {
118             uses route-target-constrain-routes;
119         }
120     }
121
122     augment "/bgp-rib:bgp-rib/bgp-rib:rib/bgp-rib:peer/bgp-rib:adj-rib-out/bgp-rib:tables/bgp-rib:routes" {
123         case route-target-constrain-routes-case {
124             uses route-target-constrain-routes;
125         }
126     }
127
128     augment "/bmp-mon:bmp-monitor/bmp-mon:monitor/bmp-mon:router/bmp-mon:peer/bmp-mon:pre-policy-rib/bmp-mon:tables/bmp-mon:routes" {
129         case route-target-constrain-routes-case {
130             uses route-target-constrain-routes;
131         }
132     }
133
134     augment "/bmp-mon:bmp-monitor/bmp-mon:monitor/bmp-mon:router/bmp-mon:peer/bmp-mon:post-policy-rib/bmp-mon:tables/bmp-mon:routes" {
135         case route-target-constrain-routes-case {
136             uses route-target-constrain-routes;
137         }
138     }
139 }