module bbf-vomci-function {

    yang-version 1.1;

    namespace
      "urn:bbf:yang:bbf-vomci-function";

    prefix bbf-vomci-func;

    import bbf-yang-types {
      prefix bbf-yang;
    }
    import bbf-vomci-types {
      prefix bbf-vomcit;
    }
    import bbf-network-function-client {
      prefix bbf-nfc;
    }
    import bbf-network-function-server {
      prefix bbf-nfs;
    }
    import bbf-omci-message-retransmission {
      prefix bbf-omci-mr;
    }
    import bbf-vomci-common {
      prefix bbf-vomci-c;
    }
    import bbf-voltmf-message-monitor {
      prefix bbf-voltmf-msg-mon;
    }

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

    notification onu-alignment-result {
      description
        "Reports that the vOMCI function has completed an alignment on
an ONU.";
      leaf onu-name {
        type bbf-vomcit:onu-name;
        description
          "The name of the ONU that is the target of the alignment
result.";
      }

      leaf datastore-tag {
        type string;
        description
          "The datastore tag associated with the ONU's configuration
data kept by the vOMCI function.";
      }

      leaf alignment-state {
        type enumeration {
          enum "aligned" {
            value 0;
            description
              "The ONU state is aligned.";
          }
          enum "unaligned" {
            value 1;
            description
              "The ONU state is unaligned.";
          }
        }
        description
          "The alignment status of the ONU.";
      }
    }  // notification onu-alignment-result

    notification onu-alarm-misalignment {
      description
        "The vOMCI function detected a gap in the OMCI alarm
 message's sequence number.";
      leaf onu-name {
        type bbf-vomcit:onu-name;
        description
          "The name of the ONU that is the target of the alignment
result.";
      }

      leaf detected-sequence-number {
        type uint16;
        description
          "The sequence number that resulted in the misalignment.";
      }
    }  // notification onu-alarm-misalignment

    notification untranslated-omci-notification {
      description
        "The vOMC Message function cannot translate an OMCI Alarm or AVC
message into a specific YANG notification.";
      leaf onu-name {
        type bbf-vomcit:onu-name;
        description "The name of the ONU.";
      }

      anydata untranslated-data {
        description
          "The data received by the vOMCI function that could not be
translated.";
      }
    }  // notification untranslated-omci-notification

    notification unsupported-version-vomci-function-message {
      description
        "The vOMCI function does not support the version of the message
sent by the vOLTMF.";
      leaf request-payload-id {
        type string;
        description
          "The request payload identifier.";
      }

      leaf message-version {
        type string;
        description
          "The version that was on the message.";
      }

      leaf-list supported-message-versions {
        type string;
        description
          "The version(s) that are supported by the vOMCI function.";
      }
    }  // notification unsupported-version-vomci-function-message

    container vomci {
      description
        "Data nodes associated with the vOMCI function.";
      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 vOMCI message. The timeout is
used to clean up stale vOMCI messages. The timeout is
only applicable when OMCI message retransmission
capability is not currently enabled for this entity.";
      }

      container omci-message-retransmission {
        if-feature bbf-omci-mr:omci-message-retransmission;
        description
          "OMCI message retransmission capability.";
        leaf enabled {
          type boolean;
          default "true";
          description
            "Administratively enable the use of the OMCI message
retransmission capability for the network function.";
        }

        leaf low-priority-transmission-timeout {
          type uint16 {
            range "10..max";
          }
          units "milliseconds";
          default "1000";
          description
            "The maximum number of milliseconds that the retransmission
function waits for an acknowledge before transmitting the
low priority message (Tmax0).";
        }

        leaf high-priority-transmission-timeout {
          type uint16 {
            range "10..max";
          }
          units "milliseconds";
          default "1000";
          description
            "The maximum number of milliseconds that the retransmission
function waits for an acknowledge before transmitting the
high priority message (Tmax1).";
        }

        leaf low-priority-message-retries {
          type uint8 {
            range "0..max";
          }
          default "3";
          description
            "The maximum retries for a low priority message (Rmax0).";
        }

        leaf high-priority-message-retries {
          type uint8 {
            range "0..max";
          }
          default "3";
          description
            "The maximum retries for a high priority message (Rmax1).";
        }
      }  // container omci-message-retransmission

      container remote-nf {
        presence
          "Enables access to remote network functions";
        description
          "Data nodes to manage remote network functions (NF).";
        container nf-client {
          if-feature bbf-vomci-func: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 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

                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 nf-server {
          if-feature bbf-vomci-func:nf-server;
          description
            "Data nodes to manage the server of the network function.";
          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
          "The OMCI function statistics.";
        action reset {
          description
            "Reset the counters of the statistics.";
        }  // rpc reset

        leaf last-reset-time {
          type yang:date-and-time;
          description
            "The date and time that the counters were last reset or the
function was enabled.";
        }

        leaf out-low-priority-messages {
          type yang:counter64;
          units "messages";
          description
            "The number of ITU G.988 OMCI ME low priority messages that
have been sent by the function.";
        }

        leaf in-low-priority-messages {
          type yang:counter64;
          units "messages";
          description
            "The number of ITU G.988 OMCI ME low priority messages that
have been received by the function.";
        }

        leaf out-low-priority-messages-retransmissions {
          type yang:counter64;
          units "messages";
          description
            "The number of ITU G.988 OMCI ME low priority messages that
have been retransmitted.";
        }

        leaf out-high-priority-messages {
          type yang:counter64;
          units "messages";
          description
            "The number of ITU G.988 OMCI ME high priority messages that
have been sent by the function.";
        }

        leaf in-high-priority-messages {
          type yang:counter64;
          units "messages";
          description
            "The number of ITU G.988 OMCI ME high priority messages
that have been received by the function.";
        }

        leaf out-high-priority-messages-retransmissions {
          type yang:counter64;
          units "messages";
          description
            "The number of ITU G.988 OMCI ME high priority messages
that have been retransmitted.";
        }

        leaf min-onu-rtt {
          type uint32;
          units "milliseconds";
          description
            "The number of minimum round trip time (rtt) in milliseconds,
for any request to the ONU.";
        }

        leaf max-onu-rtt {
          type uint32;
          units "milliseconds";
          description
            "The number of maximum round trip time (rtt) in milliseconds,
for any request to the ONU.";
        }

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

      container managed-onus {
        description
          "The ONUs that are being managed by this entity.";
        action create-onu {
          description
            "Create an ONU within the vOMCI function.";
          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.";
            }
          }
        }  // 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
function along with remote endpoint to use.";
            input {
              leaf onu-communication-available {
                type boolean;
                description
                  "When true, the ONU is able to be communicated with
across the ONU management chain of entities.";
              }

              leaf olt-remote-endpoint {
                type bbf-yang:string-ascii64;
                description
                  "The remote endpoint name to use for transmitting
vOMCI messages toward the OLT.";
              }

              leaf voltmf-remote-endpoint {
                type bbf-yang:string-ascii64;
                description
                  "The remote endpoint name to use for transmitting
YANG messages toward the vOLTMF.";
              }

              leaf xpon-onu-type {
                type identityref {
                  base bbf-vomcit:xpon-onu-type;
                }
                description
                  "The ONU's xPON type.";
              }

              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
            }
          }  // rpc set-onu-communication

          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 onu-communication-available {
            type boolean;
            description
              "When true, the ONU is able to be communicated with
across the ONU management chain of entities.";
          }

          leaf olt-remote-endpoint {
            type bbf-yang:string-ascii64;
            description
              "The name remote endpoint to use for transmitting vOMCI
messages toward the OLT.";
          }

          container statistics {
            description
              "vOMCI message and retransmission statistics.";
            action reset {
              description
                "Reset the counters of the statistics.";
            }  // rpc reset

            leaf out-messages {
              type yang:counter64;
              units "counters";
              description
                "The number of vOMCI messages that have been transmitted by
the function.";
            }

            leaf in-messages {
              type yang:counter64;
              units "counters";
              description
                "The number of vOMCI messages that have been received by the
function.";
            }

            leaf errored-messages {
              type yang:counter64;
              units "counters";
              description
                "The number of vOMCI messages that have had errors. This
includes both inbound and outbound errors. For example,
unable to send, or didn't receive expected response.";
            }

            leaf last-reset-time {
              type yang:date-and-time;
              description
                "The date and time that the counters were last reset or the
function was enabled.";
            }

            leaf out-low-priority-messages {
              type yang:counter64;
              units "messages";
              description
                "The number of ITU G.988 OMCI ME low priority messages that
have been sent by the function.";
            }

            leaf in-low-priority-messages {
              type yang:counter64;
              units "messages";
              description
                "The number of ITU G.988 OMCI ME low priority messages that
have been received by the function.";
            }

            leaf out-low-priority-messages-retransmissions {
              type yang:counter64;
              units "messages";
              description
                "The number of ITU G.988 OMCI ME low priority messages that
have been retransmitted.";
            }

            leaf out-high-priority-messages {
              type yang:counter64;
              units "messages";
              description
                "The number of ITU G.988 OMCI ME high priority messages that
have been sent by the function.";
            }

            leaf in-high-priority-messages {
              type yang:counter64;
              units "messages";
              description
                "The number of ITU G.988 OMCI ME high priority messages
that have been received by the function.";
            }

            leaf out-high-priority-messages-retransmissions {
              type yang:counter64;
              units "messages";
              description
                "The number of ITU G.988 OMCI ME high priority messages
that have been retransmitted.";
            }

            leaf min-onu-rtt {
              type uint32;
              units "milliseconds";
              description
                "The number of minimum round trip time (rtt) in milliseconds,
for any request to the ONU.";
            }

            leaf max-onu-rtt {
              type uint32;
              units "milliseconds";
              description
                "The number of maximum round trip time (rtt) in milliseconds,
for any request to the ONU.";
            }
          }  // container statistics
        }  // list managed-onu
      }  // container managed-onus
    }  // container vomci
  }  // module bbf-vomci-function