<?xml version="1.0" encoding="UTF-8"?>
<!--
  Device:2 Root Data Model: Common Object definitions [InterfaceStack]

  Copyright (c) 2010-2024, 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.

  Comments or questions about this Broadband Forum data model should be
  directed to <info@broadband-forum.org>.
-->

<dm:document
    xmlns:dm="urn:broadband-forum-org:cwmp:datamodel-1-10"
    xmlns:dmr="urn:broadband-forum-org:cwmp:datamodel-report-1-0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="
      urn:broadband-forum-org:cwmp:datamodel-1-10
        https://www.broadband-forum.org/cwmp/cwmp-datamodel-1-10.xsd
      urn:broadband-forum-org:cwmp:datamodel-report-1-0
        https://www.broadband-forum.org/cwmp/cwmp-datamodel-report-1-0.xsd"
    spec="urn:broadband-forum-org:tr-181-2-21-0-interfacestack"
    file="tr-181-2-21-0-interfacestack.xml">

  <import file="tr-069-biblio.xml" spec="urn:broadband-forum-org:tr-069"/>

  <import file="tr-106-types.xml" spec="urn:broadband-forum-org:tr-106">
    <component name="Alias"/>
  </import>

  <import file="tr-181-2-root.xml"
      spec="urn:broadband-forum-org:tr-181-2-21-root">
    <component name="Root"/>
  </import>

  <component name="InterfaceStack">

    <object name="Device.InterfaceStack.{i}." access="readOnly"
        numEntriesParameter="InterfaceStackNumberOfEntries" minEntries="0"
        maxEntries="unbounded" version="2.0">
      <description>
        This table contains information about the relationships between the
        multiple layers of interface objects ({{bibref|TR-181i2|Section 4.3}}).
        In particular, it contains information on which interfaces run ''on top
        of'' which other interfaces.

        This table is auto-generated by the CPE based on the ''LowerLayers''
        parameters on individual interface objects.

        Each table row represents a "link" between two interface objects, a
        higher-layer interface object (referenced by {{param|HigherLayer}}) and
        a lower-layer interface object (referenced by {{param|LowerLayer}}).
        Consequently, if a referenced interface object is deleted, the CPE MUST
        delete the corresponding {{object}} row(s) that had referenced it.
      </description>
      <uniqueKey functional="true">
        <parameter ref="HigherLayer"/>
        <parameter ref="LowerLayer"/>
      </uniqueKey>
      <uniqueKey functional="false">
        <parameter ref="Alias"/>
      </uniqueKey>

      <component ref="Alias" version="2.3"/>

      <parameter name="HigherLayer" access="readOnly">
        <description>
          {{noreference}}A reference to the interface object corresponding to
          the higher layer of the relationship, i.e. the interface which runs
          on ''top'' of the interface identified by the corresponding instance
          of {{param|LowerLayer}}.

          When the referenced higher layer interface is deleted, the CPE MUST
          delete the table row.
        </description>
        <syntax>
          <string>
            <size maxLength="256"/>
            <pathRef refType="strong" targetType="row"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="LowerLayer" access="readOnly">
        <description>
          {{noreference}}A reference to the interface object corresponding to
          the lower layer of the relationship, i.e. the interface which runs
          ''below'' the interface identified by the corresponding instance of
          {{param|HigherLayer}}.

          When the referenced lower layer interface is deleted, the CPE MUST
          delete the table row.
        </description>
        <syntax>
          <string>
            <size maxLength="256"/>
            <pathRef refType="strong" targetType="row"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="HigherAlias" access="readOnly">
        <description>
          The value of the ''Alias'' parameter for the interface object
          referenced by {{param|HigherLayer}}.
        </description>
        <syntax>
          <string>
            <size maxLength="64"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="LowerAlias" access="readOnly">
        <description>
          The value of the ''Alias'' parameter for the interface object
          referenced by {{param|LowerLayer}}.
        </description>
        <syntax>
          <string>
            <size maxLength="64"/>
          </string>
        </syntax>
      </parameter>
    </object>
  </component>

  <model name="InterfaceStack:2.21">
    <component ref="Root"/>
    <component ref="InterfaceStack"/>
  </model>
</dm:document>
