module bbf-voltmf {

    yang-version 1.1;

    namespace "urn:bbf:yang:bbf-voltmf";

    prefix bbf-voltmf;

    import bbf-device-aggregation {
      prefix bbf-dev-agg;
    }
    import bbf-device-types {
      prefix bbf-dvct;
    }
    import bbf-network-function {
      prefix bbf-nf;
    }
    import bbf-network-function-client {
      prefix bbf-nfc;
    }
    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-xpon-types {
      prefix bbf-xpon-types;
    }
    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:      Tim Carey, Nokia

     Editor:      Jeff Hartley, Commscope

     WA Director: Mengmeng Li, China Mobile

     WA Director: Bruno Cornaglia, Vodafone";

    description
      "This module contains a collection of YANG definitions for
     supporting the Broadband Forum requirements for the virtual
     OLT management functionality (vOLTMF) functionality as
     described in TR-451.

     Copyright (c) 2019-2022, 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-451; see
     the TR itself for full legal notices.";

    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>";

    }


    container voltmf {
      description
        "Data nodes associated with the vOLTMF.";
      container nf-topology {
        description
          "The VNFs, VNF instances and network function links that
         cannot be discovered.

         When an ONU Management Proxy is not deployed, the vOLTMF has
         knowledge of:
           VNFs: vOMCI Function, vOMCI Proxy
           VNF Instances and links of Network Functions:
             vOMCI Function, vOMCI Proxy

         When an ONU Management Proxy is deployed, the vOLTMF has
         knowledge of:
           VNFs: vOMCI Function, vOMCI Proxy, ONU Management Proxy
           VNF Instances and links of Network Functions: vOMCI Proxy,
             ONU Management Proxy.";
        leaf type {
          type identityref {
            base bbf-nft:nf-topology;
          }
          description
            "The type of deployment topology used by this network
function.";
        }

        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 by this network
function, when 'type' is set to 'other-topology'.";
        }

        list vnf {
          key "name";
          description
            "Data nodes describing the VNF 'flavor' (not instance) being
used. For example, vendor or version info.";
          leaf name {
            type bbf-yang:string-ascii64;
            description
              "The VNF 'flavor' (not instance) being used.";
          }

          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 instance.";
          }

          leaf vnf {
            type leafref {
              path "../../vnf/name";
            }
            mandatory true;
            description
              "The VNF 'flavor' (not instance) being used.";
          }

          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
            "A link to a network function. Depending on usage, this may
be to a physical or virtual NF, and may be one-ended or
two-ended.";
          leaf name {
            type bbf-yang:string-ascii64;
            description
              "The name of the link to the network function.";
          }

          list endpoint {
            key "nf-instance endpoint";
            max-elements 2;
            description
              "An endpoint at the network function.";
            leaf nf-instance {
              type bbf-yang:string-ascii64;
              description
                "The name of the instance of the network function at the
remote end of the link.

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 endpoint at the network function.";
            }

            leaf nf-type {
              type bbf-yang:string-ascii64;
              description
                "The type of the network function endpoint.";
            }
          }  // 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'";
              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')";
              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
          "Data nodes to manage remote network functions (NF).";
        container nf-client {
          description
            "Data nodes to manage the clients of the network function.";
          leaf enabled {
            type boolean;
            default "true";
            description
              "Administratively enable the use of the client
             connectivity capability to the network function.";
          }

          container initiate {
            description
              "Configures client initiating underlying connections. If
there are multiple remote-servers, they may be
connected to in parallel.";
            list remote-server {
              key "name";
              description
                "A remote server the client will 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 remote communication endpoint
(e.g, vOMCI-proxy, vOMCI-function, vOLTMF, OLT).";
              }

              leaf on-demand {
                type boolean;
                default "false";
                description
                  "Determines whether the client establishes a
connection to the endpoint only on-demand ('true')
or is establishes a connection permanently
('false').";
              }

              leaf local-service-endpoint {
                type bbf-yang:string-ascii64;
                description
                  "The name that the NF will use when reporting the
NF as an endpoint. For example, see sections
5.8.2.1 Hello vOMCI service and 5.7.1.2.1.1 Hello
Message (service-endpoint-name) in TR-451 for how
this parameter is used for vOMCI communication.";
                reference
                  "TR-451: vOMCI Specification, sections 5.8.2.1,
                  5.7.1.2.1.1";

              }

              choice transport {
                mandatory true;
                description
                  "Selects between available client transports.";
              }  // choice transport
            }  // list remote-server
          }  // container initiate
        }  // container nf-client
      }  // container remote-nf

      container statistics {
        config false;
        description
          "Counters for the vOLTMF messages sent between the vOLTMF and
         vOMCI function or ONU Management 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 voltmf

    notification onu-discovery-result {
      description
        "Reports the result of the discovery procedure for an ONU.";
      leaf onu-serial-number {
        type bbf-xpon-types:onu-serial-number;
        description
          "The TC layer ONU serial number of the discovered ONU.";
      }

      leaf discovery-result {
        type enumeration {
          enum "successful" {
            value 0;
            description
              "The ONU discovery procedure was successful.";
          }
          enum "failed-no-connectivity" {
            value 1;
            description
              "The ONU discovery procedure failed to discover the ONU
             because the ONU is not reachable.";
          }
          enum "failed-unknown-onu" {
            value 2;
            description
              "The ONU discovery procedure failed to discover the ONU
             because the ONU is not known to the vOLTMF.";
          }
        }
        mandatory true;
        description
          "The result of the discovery process for this ONU.";
      }

      anydata device-info {
        description
          "The device information obtained as the result of the
         discovery process.";
      }

      anydata software-info {
        description
          "The software information obtained as the result of the
         discovery process.";
      }
    }  // notification onu-discovery-result
  }  // module bbf-voltmf