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-vomci-common {
      prefix bbf-vomci-c;
    }
    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:      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 the virtual
OLT management functionality (vOLTMF) 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>";

    }


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

        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
          "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 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 grpc {
                  description
                    "Selection for gRPC client transport.";
                  container grpc-client {
                    if-feature bbf-grpcc:grpc-client;
                    description
                      "A wrapper around the gRPC client parameters to avoid name
collisions.";
                    container channel {
                      description
                        "The gRPC channel properties.

A gRPC channel is a persistent HTTP/2 connection within a TCP
session to a remote gRPC server. Its responsibility is to
hold all the connections and reconnect as necessary.";
                      leaf ping-interval {
                        type uint32;
                        units "seconds";
                        default "300";
                        description
                          "The interval for the HTTP/2 Pings that the gRPC client is
to send to gRPC server.

A value of 0 disables HTTP/2 Pings.

Pings are used to keep HTTP/2 connections alive during
periods of inactivity to allow initial RPCs to be made
quickly without a delay.";
                        reference
                          "grpc.io/docs/guides/keepalive/";

                      }
                    }  // container channel

                    container connection-backoff {
                      if-feature bbf-grpcc:connection-backoff;
                      description
                        "Configuration of the gRPC Connection Backoff Protocol.

The aim of the gRPC Connection Backoff Protocol is to avoid
flooding the network or the server with requests when a
connection to a server fails or has dropped. This is achieved
by exponentially backing off the start time of connection
attempts up to a limit with jitter.";
                      reference
                        "github.com/grpc/grpc/blob/master/doc/connection-backoff.md";

                      leaf enable {
                        type boolean;
                        default "true";
                        description
                          "If 'true', the Connection Backoff Protocol is enabled.";
                      }

                      leaf initial-backoff {
                        type uint16 {
                          range "1..max";
                        }
                        units "seconds";
                        default "30";
                        description
                          "The time to wait (backoff) before reattempting to establish
a connection to the server after discovering that the
initial connection attempt has failed.";
                        reference
                          "github.com/grpc/grpc/blob/master/doc/connection-backoff.md
                          - INITIAL_BACKOFF";

                      }

                      leaf min-connect-timeout {
                        type uint16 {
                          range "1..max";
                        }
                        units "seconds";
                        default "20";
                        description
                          "The minimum time to wait for a connection attempt to
complete before deeming the connection attempt failed.";
                        reference
                          "github.com/grpc/grpc/blob/master/doc/connection-backoff.md
                          - MIN_CONNECT_TIMEOUT";

                      }

                      leaf multiplier {
                        type decimal64 {
                          fraction-digits
                            2;
                        }
                        default "1.60";
                        description
                          "The factor with which to multiply the backoff value after a
failed retry.";
                        reference
                          "github.com/grpc/grpc/blob/master/doc/connection-backoff.md
                          - MULTIPLIER";

                      }

                      leaf jitter {
                        type decimal64 {
                          fraction-digits
                            2;
                        }
                        default "0.20";
                        description
                          "The factor which determines by how much backoffs are to be
randomized.

The range of values from which a value for backoff is to be
randomly selected is determined as follows:
  minimum value = backoff - (backoff * jitter)
  maximum value = backoff + (backoff * jitter).

Note that the randomized backoff is used only to determine
the deadline for the next connection attempt; the
non-randomized value is used to determine the next backoff
if the attempt fails.";
                        reference
                          "github.com/grpc/grpc/blob/master/doc/connection-backoff.md
                          - JITTER";

                      }

                      leaf max-backoff {
                        type uint16 {
                          range "1..max";
                        }
                        units "seconds";
                        description
                          "The upper bound to the backoff value; backoff is not to be
increased beyond this value.

To support redundant endpoints, the client could move to a
different endpoint, if the attempt to connect the remote
endpoint fails after the maximum backoff value has been
reached.";
                        reference
                          "github.com/grpc/grpc/blob/master/doc/connection-backoff.md
                          - MAX_BACKOFF";

                      }
                    }  // container connection-backoff

                    list access-point {
                      key "name";
                      min-elements 1;
                      ordered-by user;
                      description
                        "An access point to a gRPC server that a client may attempt
to connect to in the order as defined by the user to
establish a gRPC channel.

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 grpc-transport-parameters {
                        description
                          "Parameters to establish a transport layer from the gRPC
client to the gRPC server.";
                        choice tcp-client-options {
                          description
                            "Selects between possible TCP transport layer
configuration options.";
                          container remote-port {
                            description
                              "The port on the remote host over which a TCP
session is to be established and an HTTP/2
connection for the gRPC channel is to be started.";
                            leaf remote-address {
                              type inet:host;
                              description
                                "The IP address or hostname of the remote host to
establish a connection with.";
                            }

                            leaf remote-port {
                              type inet:port-number;
                              default "8443";
                              description
                                "The destination port on the remote host.";
                            }
                          }  // container remote-port
                        }  // choice tcp-client-options
                      }  // container grpc-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
                            "The 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 grpc-client
                }  // case grpc
              }  // 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 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