module bbf-olt-vomci {

    yang-version 1.1;

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

    prefix bbf-olt-vomci;

    import bbf-network-function-client {
      prefix bbf-nfc;
    }
    import bbf-network-function-server {
      prefix bbf-nfs;
    }
    import bbf-vomci-types {
      prefix bbf-vomcit;
    }
    import bbf-xponvani {
      prefix bbf-xponvani;
    }
    import bbf-yang-types {
      prefix bbf-yang;
    }
    import ietf-interfaces {
      prefix if;
    }

    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 a physical OLT's
     implementation of the vOMCI 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>";

    }


    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 remote-nf {
      presence
        "Enables access to remote network functions.";
      description
        "Data nodes to manage remote network functions (NF).";
      container nf-client {
        if-feature bbf-olt-vomci: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 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 nf-server {
        if-feature bbf-olt-vomci: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 session may remain
idle. A session will be dropped if it is idle for an
interval longer than this number of seconds. If set to
zero, then the server will never drop a session because
it is idle. Sessions that have a notification subscription
active are never dropped.";
          }

          list listen-endpoint {
            key "name";
            min-elements 1;
            description
              "The endpoints 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 name that this network function will use when
reporting itself as an endpoint. For example, see section
5.8.2.1 Hello vOMCI service in TR-451 for how this
parameter is used for vOMCI communication. The value in
this leaf is typically the same value as the name of the
'listen-endpoint' but could be different for certain
deployments. If this leaf is not configured the name of
the 'listen-endpoint' is used.";
              reference
                "TR-451 section 5.8.2.1";

            }

            choice transport {
              mandatory true;
              description
                "Selects between available transports.";
            }  // 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-clients/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.";
                }

                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
          }  // list listen-endpoint
        }  // container listen
      }  // container nf-server

      container nf-endpoint-filter {
        description
          "The network function endpoint filter.";
        list rule {
          key "name";
          ordered-by user;
          description
            "A rule to identify an endpoint of an ONU.

           A rule contains a classification of resources that match a
           criteria. The result is an endpoint name.

           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 endpoint specified in the rule is
           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 endpoint filters. 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-endpoint-criteria;
              }
              default "bbf-vomcit:any-onu";
              description
                "Indicates the type of matching criteria.";
            }

            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.";
            }
          }  // container match-criteria

          leaf endpoint {
            type bbf-yang:string-ascii64;
            description
              "This is the endpoint to use based on the match criteria.

             When operating as a server the resulting endpoint is a
             value that references the leaf 'local-service-endpoint'
             entry in the 'remote-server' list of the
             'listen-endpoint'. When operating as a client the
             resulting endpoint is a value that references the leaf
             'name' in the client's 'remote-server' list. If
             operating as both a client and server to the same
             remote endpoint which session to use (client or server)
             is unspecified as the information transmitted will reach
             the same remote endpoint.";
          }
        }  // list rule
      }  // container nf-endpoint-filter
    }  // container remote-nf
  }  // module bbf-olt-vomci