Elia Battiston | 4750d3c | 2022-07-14 13:24:56 +0000 | [diff] [blame] | 1 | module bbf-xpon-onu-states {
|
| 2 | yang-version 1.1;
|
| 3 | namespace "urn:bbf:yang:bbf-xpon-onu-states";
|
| 4 | prefix bbf-xpon-onu-states;
|
| 5 |
|
| 6 | import ietf-interfaces {
|
| 7 | prefix if;
|
| 8 | }
|
| 9 | import ietf-yang-types {
|
| 10 | prefix yang;
|
| 11 | }
|
| 12 | import bbf-xpon-types {
|
| 13 | prefix bbf-xpon-types;
|
| 14 | }
|
| 15 | import bbf-xpon-onu-types {
|
| 16 | prefix bbf-xpon-onu-types;
|
| 17 | }
|
| 18 | import bbf-xpon {
|
| 19 | prefix bbf-xpon;
|
| 20 | }
|
| 21 |
|
| 22 | organization
|
| 23 | "Broadband Forum <https://www.broadband-forum.org>
|
| 24 | Fiber Access Networks Work Area";
|
| 25 | contact
|
| 26 | "Comments or questions about this Broadband Forum YANG module
|
| 27 | should be directed to <mailto:help@broadband-forum.org>.
|
| 28 |
|
| 29 | Editor: Joey Boyd, ADTRAN
|
| 30 |
|
| 31 | Editor: Samuel Chen, Broadcom
|
| 32 |
|
| 33 | Editor: Robert Peschi, Nokia
|
| 34 |
|
| 35 | WA Director: Marta Seda, Calix
|
| 36 |
|
| 37 | WA Director: Lin Wei, Huawei";
|
| 38 | description
|
| 39 | "This module contains a collection of YANG definitions about
|
| 40 | ONUs for which a virtual ANI may be or may be not configured.
|
| 41 |
|
| 42 | Copyright (c) 2018, Broadband Forum
|
| 43 |
|
| 44 | Redistribution and use in source and binary forms, with or
|
| 45 | without modification, are permitted provided that the following
|
| 46 | conditions are met:
|
| 47 |
|
| 48 | 1. Redistributions of source code must retain the above copyright
|
| 49 | notice, this list of conditions and the following disclaimer.
|
| 50 |
|
| 51 | 2. Redistributions in binary form must reproduce the above
|
| 52 | copyright notice, this list of conditions and the following
|
| 53 | disclaimer in the documentation and/or other materials
|
| 54 | provided with the distribution.
|
| 55 |
|
| 56 | 3. Neither the name of the copyright holder nor the names of its
|
| 57 | contributors may be used to endorse or promote products
|
| 58 | derived from this software without specific prior written
|
| 59 | permission.
|
| 60 |
|
| 61 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
| 62 | CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
| 63 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
| 64 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
| 65 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
| 66 | CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
| 67 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
| 68 | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
| 69 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
| 70 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
| 71 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
| 72 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
| 73 | ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| 74 |
|
| 75 | The above license is used as a license under copyright only.
|
| 76 | Please reference the Forum IPR Policy for patent licensing terms
|
| 77 | <https://www.broadband-forum.org/ipr-policy>.
|
| 78 |
|
| 79 | Any moral rights which are necessary to exercise under the above
|
| 80 | license grant are also deemed granted under this license.
|
| 81 |
|
| 82 | This version of this YANG module is part of TR-385; see
|
| 83 | the TR itself for full legal notices.";
|
| 84 |
|
| 85 | revision 2019-02-25 {
|
| 86 | description
|
| 87 | "Initial revision.
|
| 88 | * Approval Date: 2019-02-25.
|
| 89 | * Publication Date: 2019-02-25.";
|
| 90 | reference
|
| 91 | "TR-385: ITU-T PON YANG Modules
|
| 92 | <https://www.broadband-forum.org/technical/download/
|
| 93 | TR-385.pdf>";
|
| 94 | }
|
| 95 |
|
| 96 |
|
| 97 | grouping onu-state-data {
|
| 98 | description
|
| 99 | "Information about an ONU.";
|
| 100 | leaf onu-state {
|
| 101 | type identityref {
|
| 102 | base bbf-xpon-onu-types:onu-state-base;
|
| 103 | }
|
| 104 | mandatory true;
|
| 105 | description
|
| 106 | "This leaf presents the state of the ONU. The most
|
| 107 | specific applicable identity should be provided as
|
| 108 | value.";
|
| 109 | }
|
| 110 | leaf onu-id {
|
| 111 | type bbf-xpon-types:onu-id;
|
| 112 | description
|
| 113 | "This is the ITU-T TC layer ONU-ID identifier which the
|
| 114 | ONU is currently using on the channel group.";
|
| 115 | reference
|
| 116 | "ITU-T G.984.3 clause 5.5.2
|
| 117 | ITU-T G.987.3 clause 6.4.2
|
| 118 | ITU-T G.9807.1 clause C.6.1.5.6
|
| 119 | ITU-T G.989.3 clause 6.1.5.6";
|
| 120 | }
|
| 121 | leaf detected-registration-id {
|
| 122 | type string {
|
| 123 | length "0..36";
|
| 124 | }
|
| 125 | description
|
| 126 | "The registration ID value which the OLT has received from
|
| 127 | the ONU. This YANG leaf is not present if the ONU has not
|
| 128 | provided any registration ID to the OLT. Registration ID
|
| 129 | may be useful in identifying a particular ONU installed
|
| 130 | at a particular location. For ITU-T G.984.3, the leaf
|
| 131 | can only be up to 10 octets long (refer to 'password'),
|
| 132 | for ITU-T G.987.3, ITU-T G.9807.3 and ITU-T G.989.3
|
| 133 | the leaf can be up to 36 bytes long.";
|
| 134 | reference
|
| 135 | "ITU-T G.984.3 clause 9.2.4.2
|
| 136 | ITU-T G.987.3 clause 11.3.4.2
|
| 137 | ITU-T G.9807.3 clause C.11.3.4.2
|
| 138 | ITU-T G.989.3 clause 11.3.4.2";
|
| 139 | }
|
| 140 | leaf v-ani-ref {
|
| 141 | type if:interface-ref;
|
| 142 | description
|
| 143 | "The virtual ANI corresponding to this ONU when configured
|
| 144 | on this OLT. This YANG leaf is not present if no virtual
|
| 145 | ANI is corresponding to the ONU in the OLT.";
|
| 146 | }
|
| 147 | }
|
| 148 |
|
| 149 | grouping onus-present-on-local-channel-termination {
|
| 150 | description
|
| 151 | "State data of all ONUs present on a given channel termination
|
| 152 | local to this OLT.";
|
| 153 | container onus-present-on-local-channel-termination {
|
| 154 | description
|
| 155 | "State data of all ONUs present on a given channel
|
| 156 | termination local to this OLT (Refer to 'inside-olt').
|
| 157 | Even the ONUs for which no corresponding virtual ANI is
|
| 158 | configured in the OLT are accounted.
|
| 159 | An ONU is considered present on a channel termination
|
| 160 | when it is using the optical signal of this channel
|
| 161 | termination i.e. as early as the channel termination
|
| 162 | receives from the ONU a PLOAM Serial_Number_ONU message
|
| 163 | or as early as it receives a PLOAM Tuning_Resp(Complete_u)
|
| 164 | message and as long as the channel termination is not in
|
| 165 | LOBi state for this ONU (i.e in practice the ONU keeps
|
| 166 | responding to downstream OLT bandwidth map messages).";
|
| 167 | list onu {
|
| 168 | key "detected-serial-number";
|
| 169 | description
|
| 170 | "The list of all ONUs present on the channel termination.";
|
| 171 | leaf detected-serial-number {
|
| 172 | type bbf-xpon-types:onu-serial-number;
|
| 173 | mandatory true;
|
| 174 | description
|
| 175 | "The serial number of the ONU.";
|
| 176 | reference
|
| 177 | "ITU-T G.984.3, clause 9.2.4.1
|
| 178 | ITU-T G.987.3, clause 11.3.3.2
|
| 179 | ITU-T G.9807.1, clauses C11.2.6.1, C11.2.6.2 and C11.3.4.1
|
| 180 | ITU-T G.989.3, clauses 11.2.6.1, 11.2.6.2 and 11.3.4.1.";
|
| 181 | }
|
| 182 | uses onu-state-data;
|
| 183 | leaf onu-detected-datetime {
|
| 184 | type yang:date-and-time;
|
| 185 | mandatory true;
|
| 186 | description
|
| 187 | "The OLT system date and time when the ONU was detected
|
| 188 | present on the channel termination.";
|
| 189 | }
|
| 190 | leaf onu-state-last-change {
|
| 191 | type yang:date-and-time;
|
| 192 | mandatory true;
|
| 193 | description
|
| 194 | "The OLT system date and time when the 'onu-state'
|
| 195 | YANG leaf got its current value.";
|
| 196 | }
|
| 197 | }
|
| 198 | }
|
| 199 | }
|
| 200 |
|
| 201 | augment '/if:interfaces-state/if:interface'
|
| 202 | + '/bbf-xpon:channel-termination' {
|
| 203 | when "derived-from-or-self"
|
| 204 | + "(/if:interfaces/if:interface[if:name=current()]"
|
| 205 | + "/bbf-xpon:channel-termination/bbf-xpon:location, "
|
| 206 | + "'bbf-xpon-types:inside-olt')";
|
| 207 | description
|
| 208 | "State data of all ONUs present on a given channel
|
| 209 | termination local to this OLT (Refer to 'inside-olt').
|
| 210 | Even the ONUs for which no corresponding virtual ANI is
|
| 211 | configured in the OLT are accounted.
|
| 212 | An ONU is considered present on a channel termination
|
| 213 | when it is using the optical signal of this channel
|
| 214 | termination i.e. as early as the channel termination
|
| 215 | receives from the ONU a PLOAM Serial_Number_ONU message
|
| 216 | or as early as it receives a PLOAM Tuning_Resp(Complete_u)
|
| 217 | message and as long as the channel termination is not in
|
| 218 | LOBi state for this ONU (i.e in practice the ONU keeps
|
| 219 | responding to downstream OLT bandwidth map messages).";
|
| 220 | uses onus-present-on-local-channel-termination;
|
| 221 | }
|
| 222 |
|
| 223 | notification onu-state-change {
|
| 224 | description
|
| 225 | "A notification traceable to a channel termination which
|
| 226 | signifies that an ONU has transitioned into the indicated
|
| 227 | state. This notification considers not only ONUs for which a
|
| 228 | corresponding virtual ANI is configured in the OLT but also
|
| 229 | ONUs for which no corresponding virtual ANI is configured
|
| 230 | in the OLT.";
|
| 231 | leaf detected-serial-number {
|
| 232 | type bbf-xpon-types:onu-serial-number;
|
| 233 | mandatory true;
|
| 234 | description
|
| 235 | "The serial number of the ONU entering the new state.";
|
| 236 | reference
|
| 237 | "ITU-T G.984.3, clause 9.2.4.1
|
| 238 | ITU-T G.987.3, clause 11.3.3.2
|
| 239 | ITU-T G.9807.1, clauses C11.2.6.1, C11.2.6.2 and C11.3.4.1
|
| 240 | ITU-T G.989.3, clauses 11.2.6.1, 11.2.6.2 and 11.3.4.1.";
|
| 241 | }
|
| 242 | leaf channel-termination-ref {
|
| 243 | type if:interface-ref;
|
| 244 | mandatory true;
|
| 245 | description
|
| 246 | "The channel termination reporting from its point of view the
|
| 247 | new state of the ONU.";
|
| 248 | }
|
| 249 | leaf onu-state-last-change {
|
| 250 | type yang:date-and-time;
|
| 251 | mandatory true;
|
| 252 | description
|
| 253 | "The OLT system date and time when the ONU has transitioned
|
| 254 | into the indicated state.";
|
| 255 | }
|
| 256 | uses onu-state-data;
|
| 257 | }
|
| 258 | } |