This module contains a collection of YANG definitions for supporting the Broadband Forum requirements for ONU Management Proxy f...
Version: 2025-02-03
module bbf-onu-management-proxy { yang-version 1.1; namespace "urn:bbf:yang:bbf-onu-management-proxy"; prefix bbf-onu-mgmt-p; import bbf-network-function { prefix bbf-nf; } import bbf-network-function-client { prefix bbf-nfc; } import bbf-network-function-server { prefix bbf-nfs; } import bbf-network-function-types { prefix bbf-nft; } import bbf-voltmf-common { prefix bbf-voltmf-c; } import bbf-voltmf-message-monitor { prefix bbf-voltmf-msg-mon; } import bbf-vomci-common { prefix bbf-vomci-c; } import bbf-vomci-types { prefix bbf-vomcit; } import bbf-yang-types { prefix bbf-yang; } import ietf-yang-schema-mount { prefix yangmnt; } organization "Broadband Forum <https://www.broadband-forum.org> SDN/NFV Work Area"; contact "Comments or questions about this Broadband Forum YANG module should be directed to <mailto:help@broadband-forum.org>. Editor: Andre Brizido, Altice Labs PS Leader: Ken Kerpez, DZS WA Director: Mengmeng Li, China Mobile WA Director: Bruno Cornaglia, Vodafone WA Director: Haomian Zheng, Huawei"; description "This module contains a collection of YANG definitions for supporting the Broadband Forum requirements for ONU Management Proxy functionality as described in TR-451. Copyright (c) 2019-2025, Broadband Forum Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>. Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license. This version of this YANG module is part of TR-451a1; see the TR itself for full legal notices."; revision "2025-02-03" { description "Amendment 1. * Approval Date: 2025-02-03. * Publication Date: 2025-02-03."; reference "TR-451a1: vOMCI Specification <https://www.broadband-forum.org/technical/download/ TR-451_Amendment-1.pdf>"; } revision "2022-06-07" { description "Issue 1. * Approval Date: 2022-06-07. * Publication Date: 2022-06-07."; reference "TR-451: vOMCI Specification <https://www.broadband-forum.org/technical/download/ TR-451_Issue-1.pdf>"; } feature nf-client { description "Indicates that client connectivity to network function endpoints is supported."; } feature nf-server { description "Indicates that server connectivity to network function endpoints is supported."; } container onu-management-proxy { description "Data nodes associated with the ONU Management Proxy."; leaf message-timeout { type uint16 { range "10..max"; } units "seconds"; default "900"; description "The maximum number of seconds for a response to be received to a transmitted message. The timeout is used to clean up stale messages."; } container nf-topology { description "The VNFs, VNF instances and network function links that cannot be discovered. The network function has knowledge of: VNFs: vOMCI Function, vOMCI Proxy, ONU Management Proxy VNF Instances and links of Network Functions: vOMCI function, vOMCI Proxy, OLT."; leaf type { type identityref { base bbf-nft:nf-topology; } description "The type of deployment topology."; } leaf other-type { when "derived-from-or-self(../type,'bbf-nft:other-topology')" { description "Only valid when the topology type is 'other-topology'."; } type bbf-yang:string-ascii64; description "The other type of deployment topology used, if 'type' is set to 'other-topology'."; } list vnf { key "name"; description "A 'flavor' of VNF (not instance) intended to be used within the network. For example, 'flavor' can be based on vendor or version info."; leaf name { type bbf-yang:string-ascii64; description "The name of the 'flavor' of VNF."; } leaf vendor { type bbf-yang:string-ascii64; description "The vendor of the VNF."; } leaf software-version { type bbf-yang:string-ascii64; description "The software version of VNF."; } leaf nf-type { type identityref { base bbf-nft:vnf-type; } mandatory true; description "The type of the VNF within the solution context. For example: 'onu-management-proxy', 'vomci-function', 'vomci-proxy'."; } } // list vnf list vnf-instance { key "name"; description "An instance of a VNF."; leaf name { type bbf-yang:string-ascii64; description "The name of the VNF instance."; } leaf vnf { type leafref { path "../../vnf/name"; } mandatory true; description "The name of the 'flavor' of VNF intended to be used within the network."; } container data { yangmnt:mount-point "device-yang-library" { description "The YANG library associated with the device."; } description "The data nodes of the device's schema."; } // container data } // list vnf-instance list nf-link { key "name"; description "An intended link between network functions within the network. Depending on usage, endpoints of a link may be at a physical and/or a virtual NF."; leaf name { type bbf-yang:string-ascii64; description "The name of the link."; } list endpoint { key "nf-instance endpoint"; max-elements 2; description "A service endpoint at an instance of a network function forming one end of a link between network functions."; leaf nf-instance { type bbf-yang:string-ascii64; description "The name of the instance of the network function. If the function is a PNF, then this value is the device identifier of the PNF."; } leaf endpoint { type bbf-yang:string-ascii64; description "The name of the service endpoint at the instance of the network function."; } leaf nf-type { type bbf-yang:string-ascii64; description "The type of network function."; } } // list endpoint } // list nf-link } // container nf-topology container onu-vomci-assignment-policy { description "The policy rules to use to associate an ONU with a list of vOMCI functions."; list rule { key "name"; ordered-by user; description "A rule to assign an ONU to vOMCI function types. A rule contains a classification of resources that match a criteria. The result is a list of vOMCI function types. The rule is applied for a given ONU according to priority, then list order as defined by the client for equal priorities. Once a match is achieved, the search is terminated and the list of vOMCI functions applied."; leaf name { type bbf-yang:string-ascii64; description "The rule name."; } leaf priority { type uint16 { range "1..max"; } mandatory true; description "Indicates the priority for applying the match criteria of this rule against the priority of match criteria of other rules in this filter. The higher the value, the lower the priority, i.e. priority 1 is the highest priority."; } container match-criteria { description "Match criteria for ONU assignment policies. Specific match criteria shall be provided using augments in a context dependent way, e.g. match criteria can be augmented for ONUs, or in another context match criteria can be augmented for another resource."; leaf criteria-type { type identityref { base bbf-vomcit:onu-vomci-criteria; } default "bbf-vomcit:any-onu"; description "The type of ONU vOMCI selection criteria to apply to this rule."; } leaf onu-vendor { when "../criteria-type = 'bbf-vomcit:onu-vendor'" { description "Only applies to ONUs."; } type bbf-vomcit:onu-vendor-id; mandatory true; description "ONU vendor as defined in the TC layer ONU-ID."; } leaf onu-software-version { when "(../criteria-type = 'bbf-vomcit:onu-vendor') or (../criteria-type = 'bbf-vomcit:onu-software-version')" { description "Only applies to ONU vendor or software version."; } type bbf-vomcit:onu-software-version; mandatory true; description "ONU vendor's software version."; } } // container match-criteria leaf-list vomci-function { type bbf-yang:string-ascii64; min-elements 1; description "Data nodes describing the VNF 'flavor' (not instance) being used for the ONU. For example, vendor or version info."; } } // list rule } // container onu-vomci-assignment-policy container remote-nf { presence "Enables access to remote network functions"; description "The remote network function (NF) configuration."; container nf-client { if-feature bbf-onu-mgmt-p:nf-client; description "Client network function configuration."; leaf enabled { type boolean; default "true"; description "Administratively enable the use of client connectivity capability to connect to network function endpoints."; } container initiate { description "Configures connections the client is to initiate. If multiple remote servers are configured, they are handled independently."; list remote-server { key "name"; description "A remote server the client is to connect to."; leaf name { type bbf-yang:string-ascii64; description "An arbitrary name for the remote server."; } leaf nf-type { type identityref { base bbf-nft:nf-type; } description "The type of network function associated with the remote endpoint (e.g, vOMCI-proxy, vOMCI-function, vOLTMF, OLT). This may be used to verify whether the endpoint when connected is of the appropriate type."; } leaf on-demand { type boolean; default "false"; description "Determines whether the client is to establish a connection to the endpoint only on-demand ('true'), i.e., only when and if the connection is needed, or whether the client is to establish a persistent connection ('false')."; } leaf local-service-endpoint { type bbf-yang:string-ascii64; description "The service endpoint name the NF is to use to identify this endpoint when establishing a session to the remote endpoint."; } choice transport { mandatory true; description "Selects between available client transports."; case kafka { description "Selection for Kafka client transport."; container kafka-agent { if-feature bbf-kafkaa:kafka-agent; description "A wrapper around the Kafka agent parameters to avoid name collisions."; leaf client-id { type string; mandatory true; description "The identifier that the Kafka agent is to use as a Kafka client to identify itself as a consumer or producer of messages (events)."; } container publication-parameters { if-feature bbf-kafkaa:message-publication; description "The Kafka agent publication properties."; list topic { key "name"; description "A topic the Kafka agent is to publish."; leaf name { type string; mandatory true; description "The name of the topic."; } leaf purpose { type string; description "The purpose of the topic (e.g., VOMCI_NOTIFICATION, VOMCI_REQUEST, VOMCI_RESPONSE)."; } leaf partition { type string; description "The partition of the topic to be used for publication and consumption of messages. The name of the partition is required if the Kafka topic is divided into several partitions, meaning that the topic is spread over a number of 'buckets' located on different Kafka brokers."; } } // list topic } // container publication-parameters container consumption-parameters { if-feature bbf-kafkaa:message-consumption; description "The Kafka agent consumption properties."; leaf group-id { type string; mandatory true; description "The consumer Group Id that is to associate this consumer with a consumer group, whereby each consumer within the group will ideally read from one partition of the topic."; } list topic { key "name"; description "A topic the Kafka agent is to consume."; leaf name { type string; mandatory true; description "The name of the topic."; } leaf purpose { type string; description "The purpose of the topic (e.g., VOMCI_NOTIFICATION, VOMCI_REQUEST, VOMCI_RESPONSE)."; } leaf partition { type string; description "The partition of the topic to be used for publication and consumption of messages. The name of the partition is required if the Kafka topic is divided into several partitions, meaning that the topic is spread over a number of 'buckets' located on different Kafka brokers."; } } // list topic } // container consumption-parameters list access-point { key "name"; min-elements 1; ordered-by user; description "An access point to a Kafka broker that a Kafka agent operating as a Kafka client may attempt to connect to in the order defined by the user. Defining more than one access point enables high- availability."; leaf name { type bbf-yang:string-ascii64; description "An arbitrary name for the access point."; } container kafka-agent-transport-parameters { description "Parameters to establish a transport layer from the Kafka agent (Kafka client) to the Kafka broker."; choice tcp-client-options { description "Selects between possible TCP transport layer configuration options."; container remote-port { description "The port of the remote host over which a TCP session is to be established to the Kafka broker."; leaf remote-port { type inet:port-number; default "9092"; description "The destination port on the remote host to which the Kafka agent as Kafka client is to attempt to establish a TCP session with the Kafka broker."; } } // container remote-port } // choice tcp-client-options } // container kafka-agent-transport-parameters notification remote-endpoint-status-change { description "A notification traceable to a client remote-endpoint and access-point. This notification is sent when a remote-endpoint is connected or disconnected."; leaf connected { type boolean; mandatory true; description "New remote-endpoint status."; } leaf last-changed { type yang:date-and-time; mandatory true; description "The system date and time when the remote-endpoint was connected or disconnected."; } } // notification remote-endpoint-status-change } // list access-point } // container kafka-agent } // case kafka } // choice transport container statistics { config false; description "Statistics associated with the remote server."; action reset { description "Reset the statistics."; } // rpc reset leaf in-messages { type yang:counter64; units "messages"; config false; description "The number of messages that have been received by the entity."; } leaf out-messages { type yang:counter64; units "messages"; config false; description "The number of messages that have been transmitted by the entity."; } leaf in-errored-messages { type yang:counter64; units "messages"; config false; description "The number of messages received by the entity that contain errors."; } } // container statistics } // list remote-server } // container initiate } // container nf-client container nf-server { if-feature bbf-onu-mgmt-p:nf-server; description "Server network function configuration."; leaf enabled { type boolean; default "true"; description "Administratively enable the use of server connectivity capability to connect to network function endpoints."; } container listen { presence "Enables server to listen for client connections."; description "Configures listen behavior."; leaf idle-timeout { type uint16; units "seconds"; default "3600"; description "The maximum number of seconds that a gRPC channel may have no outstanding RPCs, after which the server will close the connection. If set to zero, then the server is not to close the connection, if it is idle. Note that connections for which sessions have a notification subscription active are never closed."; } list listen-endpoint { key "name"; min-elements 1; description "An endpoint to listen for connections."; leaf name { type bbf-yang:string-ascii64; description "An arbitrary name for the listen endpoint."; } leaf local-service-endpoint { type bbf-yang:string-ascii64; description "The service endpoint name the NF is to use to identify this listen endpoint when a remote endpoint attempts to establish a session to it."; } choice transport { mandatory true; description "Selects between available transports."; case grpc { description "Selection for gRPC server transport."; container grpc-server { if-feature bbf-grpcs:grpc-server; description "A wrapper around the gRPC server parameters to avoid name collisions."; choice tcp-client-options { description "Selects between possible TCP transport layer configuration options."; leaf remote-port { type inet:port-number; default "8443"; description "The destination port used by the remote gRPC client to connect to this gRPC server to establish a TCP session and then start an HTTP/2 connection to establish a gRPC channel. The local gRPC server listens for incoming TCP connections on this port."; } } // choice tcp-client-options } // container grpc-server } // case grpc } // choice transport container remote-clients { config false; description "Remote clients that are currently connected to the server."; list remote-client { key "local-service-endpoint"; description "A remote client that is currently connected."; leaf local-service-endpoint { type bbf-yang:string-ascii64; description "Identity of the local service endpoint of the remote endpoint as provided as part of the vOMCI hello exchange when the connection to the remote endpoint was established."; } } // list remote-client notification remote-client-status-change { description "A notification traceable to a server listen endpoint and a remote endpoint associated with the listen endpoint. This notification is sent when remote endpoint is connected or disconnected to/from the listen endpoint."; leaf remote-client { type leafref { path "../../remote-client/local-service-endpoint"; require-instance false; } mandatory true; description "The remote endpoint that was connected or disconnected."; } leaf connected { type boolean; mandatory true; description "If 'true', the remote endpoint was connected. If 'false', the remote endpoint was disconnected."; } leaf remote-endpoint-state-last-change { type yang:date-and-time; mandatory true; description "The system date and time when the remote endpoint was connected or disconnected."; } } // notification remote-client-status-change } // container remote-clients container statistics { config false; description "Statistics associated with the local server endpoint."; action reset { description "Reset the statistics."; } // rpc reset leaf in-messages { type yang:counter64; units "messages"; config false; description "The number of messages that have been received by the entity."; } leaf out-messages { type yang:counter64; units "messages"; config false; description "The number of messages that have been transmitted by the entity."; } leaf in-errored-messages { type yang:counter64; units "messages"; config false; description "The number of messages received by the entity that contain errors."; } } // container statistics } // list listen-endpoint } // container listen } // container nf-server } // container remote-nf container statistics { config false; description "Counters for the YANG messages sent between the ONU Management Proxy and the vOMCI function or vOMCI Proxy that are not targeted to an ONU."; action reset { description "Reset the statistics counters."; } // rpc reset leaf in-messages { type yang:counter64; units "messages"; config false; description "The number of messages that have been received by the entity."; } leaf out-messages { type yang:counter64; units "messages"; config false; description "The number of messages that have been transmitted by the entity."; } leaf in-errored-messages { type yang:counter64; units "messages"; config false; description "The number of messages received by the entity that contain errors."; } } // container statistics container managed-onus { description "The ONUs that are being managed by this entity."; action create-onu { description "Create an ONU within the ONU Management Proxy."; input { leaf name { type bbf-vomcit:onu-name; description "The unique name of the ONU."; } leaf xpon-onu-type { type identityref { base bbf-vomcit:xpon-onu-type; } description "The ONU's xPON type."; } leaf vendor-id { type bbf-vomcit:onu-vendor-id; description "The vendor name of the ONU."; } leaf software-version { type bbf-vomcit:onu-software-version; description "The software version associated with the ONU."; } } } // rpc create-onu list managed-onu { key "name"; config false; description "An ONU that is being managed by this entity."; leaf name { type bbf-vomcit:onu-name; description "The unique name of the ONU."; } leaf xpon-onu-type { type identityref { base bbf-vomcit:xpon-onu-type; } description "The ONU's xPON type."; } action delete-onu { description "Delete an ONU within the ONU Proxy. Note that this is not the YANG state data but the Managed Entities state data used to manage the ONU (e.g., MIB data sync valule)."; input { leaf delete-state-data { type boolean; default "true"; description "When 'true', the ONU state data is deleted."; } } } // rpc delete-onu action delete-only-onu-state-data { description "Delete remaining state data for ONUs that have already been deleted from the list of managed ONUS. Note - Do not execute this unless the ONU has already been deleted with 'delete-onu' and with the 'delete-state-data' leaf set to 'true'. Note that this is not the YANG state data but the Managed Entities state data used to manage the ONU (e.g., MIB data sync valule)."; } // rpc delete-only-onu-state-data action set-onu-communication { description "Dynamically configure the information necessary to establish if an ONU can be communicated with by the vOMCI Proxy along with remote endpoint to use."; input { list onu-management-chain { key "nf-type nf-instance"; ordered-by user; description "The ordered list of ONU Management Proxy, vOMCI function, vOMCI Proxy and OLT instances to use for this ONU's management."; leaf nf-type { type identityref { base bbf-nft:nf-type; } description "The type of NF."; } leaf nf-instance { type bbf-yang:string-ascii64; description "The name of the NF."; } } // list onu-management-chain leaf onu-communication-available { type boolean; description "When true, the ONU is able to be communicated with across the ONU management chain of entities."; } container onu-attachment-point { description "The current ONU attachment point."; leaf olt-name { type bbf-vomcit:olt-name; description "The OLT name where the ONU is attached."; } leaf channel-termination-name { type string; description "The channel termination name where the ONU is attached."; } leaf onu-id { type bbf-xpon-types:onu-id; description "This is the TC layer ONU-ID identifier assigned to the ONU by the OLT during ONU activation."; reference "ITU-T G.984.3 clause 5.5.2 ITU-T G.987.3 clause 6.4.2 ITU-T G.9807.1 clause C.6.1.5.6 ITU-T G.989.3 clause 6.1.5.6"; } } // container onu-attachment-point leaf software-version { type bbf-vomcit:onu-software-version; description "The software version associated with the ONU."; } leaf onu-management-chain-selection { type enumeration { enum "vomci-policy" { value 0; description "Identifies that the ONU management chain is computed using a policy to select the vOMCI function instance."; } enum "configured" { value 1; description "Identifies that the ONU management chain is configured by an external entity."; } } description "The option used to determine the ONU management chain."; } leaf xpon-onu-type { type identityref { base bbf-vomcit:xpon-onu-type; } description "The ONU's xPON type."; } } } // rpc set-onu-communication notification onu-management-chain-updated { description "The notification that reports that an ONU's management chain has been modified by the entity."; list current-onu-management-chain { key "nf-type nf-instance"; ordered-by user; description "The ordered list of ONU Management Proxy, vOMCI function, vOMCI Proxy and OLT instances to use for this ONU's management."; leaf nf-type { type identityref { base bbf-nft:vnf-type; } description "The type of NF."; } leaf nf-instance { type bbf-yang:string-ascii64; description "The name of the NF."; } } // list current-onu-management-chain } // notification onu-management-chain-updated container onu-attachment-point { description "The current ONU attachment point."; leaf olt-name { type bbf-vomcit:olt-name; description "The OLT name where the ONU is attached."; } leaf channel-termination-name { type string; description "The channel termination name where the ONU is attached."; } leaf onu-id { type bbf-xpon-types:onu-id; description "This is the TC layer ONU-ID identifier assigned to the ONU by the OLT during ONU activation."; reference "ITU-T G.984.3 clause 5.5.2 ITU-T G.987.3 clause 6.4.2 ITU-T G.9807.1 clause C.6.1.5.6 ITU-T G.989.3 clause 6.1.5.6"; } } // container onu-attachment-point leaf vendor-id { type bbf-vomcit:onu-vendor-id; description "The vendor name of the ONU."; } leaf software-version { type bbf-vomcit:onu-software-version; description "The software version associated with the ONU."; } leaf voltmf-remote-endpoint { type bbf-yang:string-ascii64; description "The name remote endpoint to use for transmitting YANG messages toward the vOLTMF."; } list onu-management-chain { key "nf-type nf-instance"; config false; ordered-by user; description "The ordered list of ONU Management Proxy, vOMCI function, vOMCI Proxy and OLT instances to use for this ONU's management."; leaf nf-type { type identityref { base bbf-nft:vnf-type; } description "The type of NF."; } leaf nf-instance { type bbf-yang:string-ascii64; description "The name of the NF."; } } // list onu-management-chain container statistics { config false; description "Statistics for per ONU interactions sent between the entity and vOMCI function or ONU Management Proxy."; action reset { description "Reset the counters of the statistics."; } // rpc reset leaf in-messages { type yang:counter64; units "messages"; config false; description "The number of messages that have been received by the entity."; } leaf out-messages { type yang:counter64; units "messages"; config false; description "The number of messages that have been transmitted by the entity."; } leaf in-errored-messages { type yang:counter64; units "messages"; config false; description "The number of messages received by the entity that contain errors."; } } // container statistics } // list managed-onu } // container managed-onus } // container onu-management-proxy } // module bbf-onu-management-proxy
© 2024 YumaWorks, Inc. All rights reserved.