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

  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-19-0-ppp"
    file="tr-181-2-19-0-ppp.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"/>
    <dataType name="IPv4Address"/>
    <dataType name="IPv6Address"/>
  </import>

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

  <import file="tr-181-2-interface.xml"
    spec="urn:broadband-forum-org:tr-181-2-19-interface">
    <component name="Layer2InterfaceReadWrite"/>
  </import>

  <component name="PPP">

    <object name="Device.PPP." access="readOnly" minEntries="1" maxEntries="1"
        version="2.0">
      <description>
        Point-to-Point Protocol {{bibref|RFC1661}}. This object contains the
        {{object|Interface}} table.
      </description>

      <component ref="Layer2InterfaceReadWrite"/>

      <parameter name="SupportedNCPs" access="readOnly" version="2.2">
        <description>
          The Network Control Protocols (NCPs) that are supported by the
          device. {{enum}}

          Note that {{enum|IPv6CP}} is an IPv6 capability.
        </description>
        <syntax>
          <list/>
          <string>
            <enumeration value="ATCP">
              <description>
                AppleTalk Control Protocol {{bibref|RFC1378}}
              </description>
            </enumeration>
            <enumeration value="IPCP">
              <description>{{bibref|RFC1332}}</description>
            </enumeration>
            <enumeration value="IPXCP">
              <description>{{bibref|RFC1552}}</description>
            </enumeration>
            <enumeration value="NBFCP">
              <description>{{bibref|RFC2097}}</description>
            </enumeration>
            <enumeration value="IPv6CP">
              <description>{{bibref|RFC5072}}</description>
            </enumeration>
          </string>
        </syntax>
      </parameter>
    </object>

    <object base="Device.PPP.Interface.{i}.">
      <description action="replace">
        PPP interface table (a stackable interface object as described in
        {{bibref|TR-181i2|Section 4.2}}).
      </description>

      <parameter name="ConnectionStatus" access="readOnly">
        <description>
          Current status of the connection.
        </description>
        <syntax>
          <string>
            <enumeration value="Unconfigured"/>
            <enumeration value="Connecting"/>
            <enumeration value="Authenticating"/>
            <enumeration value="Connected"/>
            <enumeration value="PendingDisconnect"/>
            <enumeration value="Disconnecting"/>
            <enumeration value="Disconnected"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="LastConnectionError" access="readOnly">
        <description>
          The cause of failure for the last connection setup attempt.
        </description>
        <syntax>
          <string>
            <enumeration value="ERROR_NONE"/>
            <enumeration value="ERROR_ISP_TIME_OUT"/>
            <enumeration value="ERROR_COMMAND_ABORTED"/>
            <enumeration value="ERROR_NOT_ENABLED_FOR_INTERNET"/>
            <enumeration value="ERROR_BAD_PHONE_NUMBER"/>
            <enumeration value="ERROR_USER_DISCONNECT"/>
            <enumeration value="ERROR_ISP_DISCONNECT"/>
            <enumeration value="ERROR_IDLE_DISCONNECT"/>
            <enumeration value="ERROR_FORCED_DISCONNECT"/>
            <enumeration value="ERROR_SERVER_OUT_OF_RESOURCES"/>
            <enumeration value="ERROR_RESTRICTED_LOGON_HOURS"/>
            <enumeration value="ERROR_ACCOUNT_DISABLED"/>
            <enumeration value="ERROR_ACCOUNT_EXPIRED"/>
            <enumeration value="ERROR_PASSWORD_EXPIRED"/>
            <enumeration value="ERROR_AUTHENTICATION_FAILURE"/>
            <enumeration value="ERROR_NO_DIALTONE"/>
            <enumeration value="ERROR_NO_CARRIER"/>
            <enumeration value="ERROR_NO_ANSWER"/>
            <enumeration value="ERROR_LINE_BUSY"/>
            <enumeration value="ERROR_UNSUPPORTED_BITSPERSECOND"/>
            <enumeration value="ERROR_TOO_MANY_LINE_ERRORS"/>
            <enumeration value="ERROR_IP_CONFIGURATION"/>
            <enumeration value="ERROR_UNKNOWN"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="AutoDisconnectTime" access="readWrite">
        <description>
          The time in {{units}} since the establishment of the connection after
          which connection termination is automatically initiated by the CPE.
          This occurs irrespective of whether the connection is being used or
          not. A value of 0 (zero) indicates that the connection is not to be
          shut down automatically.
        </description>
        <syntax>
          <unsignedInt>
            <units value="seconds"/>
          </unsignedInt>
        </syntax>
      </parameter>

      <parameter name="IdleDisconnectTime" access="readWrite">
        <description>
          The time in {{units}} that if the connection remains idle, the CPE
          automatically terminates the connection. A value of 0 (zero)
          indicates that the connection is not to be shut down automatically.
        </description>
        <syntax>
          <unsignedInt>
            <units value="seconds"/>
          </unsignedInt>
        </syntax>
      </parameter>

      <parameter name="WarnDisconnectDelay" access="readWrite">
        <description>
          Time in {{units}} the {{param|ConnectionStatus}} remains in the
          {{enum|PendingDisconnect|ConnectionStatus}} state before
          transitioning to disconnecting state to drop the connection.
        </description>
        <syntax>
          <unsignedInt>
            <units value="seconds"/>
          </unsignedInt>
        </syntax>
      </parameter>

      <parameter name="Username" access="readWrite">
        <description>
          Username to be used for authentication.
        </description>
        <syntax>
          <string>
            <size maxLength="64"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="Password" access="readWrite">
        <description>
          Password to be used for authentication.
        </description>
        <syntax secured="true">
          <string>
            <size maxLength="64"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="EncryptionProtocol" access="readOnly">
        <description>
          Describes the PPP encryption protocol.
        </description>
        <syntax>
          <string>
            <enumeration value="None"/>
            <enumeration value="MPPE"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="CompressionProtocol" access="readOnly">
        <description>
          Describes the PPP compression protocol.
        </description>
        <syntax>
          <string>
            <enumeration value="None"/>
            <enumeration value="Van Jacobson">
              <description>{{bibref|RFC1332}}</description>
            </enumeration>
            <enumeration value="STAC LZS">
              <description>{{bibref|RFC1974}}</description>
            </enumeration>
          </string>
        </syntax>
      </parameter>

      <parameter name="AuthenticationProtocol" access="readOnly">
        <description>
          Describes the PPP authentication protocol.
        </description>
        <syntax>
          <string>
            <enumeration value="None" version="2.19"/>
            <enumeration value="PAP"/>
            <enumeration value="CHAP"/>
            <enumeration value="MS-CHAP"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="MaxMRUSize" access="readWrite">
        <description>
          The maximum allowed size of frames sent from the remote peer.
        </description>
        <syntax>
          <unsignedInt>
            <range minInclusive="64" maxInclusive="65535"/>
          </unsignedInt>
          <default type="object" value="1500"/>
        </syntax>
      </parameter>

      <parameter name="CurrentMRUSize" access="readOnly">
        <description>
          The current MRU in use over this connection.
        </description>
        <syntax>
          <unsignedInt>
            <range minInclusive="64" maxInclusive="65535"/>
          </unsignedInt>
        </syntax>
      </parameter>

      <parameter name="ConnectionTrigger" access="readWrite">
        <description>
          Trigger used to establish the PPP connection. {{enum}}

          Note that the reason for a PPP connection becoming disconnected to
          begin with might be either external to the CPE, such as termination
          by the BRAS or momentary disconnection of the physical interface, or
          internal to the CPE, such as use of the {{param|IdleDisconnectTime}}
          and/or {{param|AutoDisconnectTime}} parameters in this object.
        </description>
        <syntax>
          <string>
            <enumeration value="OnDemand">
              <description>
                If this PPP connection is disconnected for any reason, it is to
                remain disconnected until the CPE has one or more packets to
                communicate over this connection, at which time the CPE
                automatically attempts to reestablish the connection.
              </description>
            </enumeration>
            <enumeration value="AlwaysOn">
              <description>
                If this PPP connection is disconnected for any reason, the CPE
                automatically attempts to reestablish the connection (and
                continues to attempt to reestablish the connection as long it
                remains disconnected).
              </description>
            </enumeration>
            <enumeration value="Manual">
              <description>
                If this PPP connection is disconnected for any reason, it is to
                remain disconnected until the user of the CPE explicitly
                instructs the CPE to reestablish the connection.
              </description>
            </enumeration>
          </string>
        </syntax>
      </parameter>

      <parameter name="LCPEcho" access="readWrite">
        <description>
          A PPP LCP Echo Request is sent every {{param}} {{units}}. A value 0
          means that no LCP Echo Requests are sent. {{bibref|RFC1661|5.8
          Echo-Request and Echo-Reply}} describes the relevant LCP Echo frames.
        </description>
        <syntax>
          <unsignedInt>
            <units value="seconds"/>
          </unsignedInt>
        </syntax>
      </parameter>

      <parameter name="LCPEchoRetry" access="readWrite">
        <description>
          Applicable only when {{param|LCPEcho}} is greater than 0. When number
          of consecutive {{param}} LCP Echo Replies have been missed. The
          remote peer will be assumed dead and the connection will be
          terminated.
        </description>
        <syntax>
          <unsignedInt/>
        </syntax>
      </parameter>

      <parameter name="LCPEchoAdaptive" access="readWrite" version="2.16">
        <description>
          When traffic is received during the {{param|LCPEcho}} interval, no
          LCP Echo-Request is sent until the next {{param|LCPEcho}} interval.
        </description>
        <syntax>
          <boolean/>
          <default type="object" value="true"/>
        </syntax>
      </parameter>

      <parameter name="IPCPEnable" access="readWrite" version="2.2">
        <description>
          Enables or disables IPCP ({{bibref|RFC1332}}) on this interface. If
          this parameter is present, {{enum|IPCP|#.SupportedNCPs}} MUST be
          included in {{param|#.SupportedNCPs}}.
        </description>
        <syntax>
          <boolean/>
        </syntax>
      </parameter>

      <parameter name="IPv6CPEnable" access="readWrite" version="2.2">
        <description>
          Enables or disables IPv6CP ({{bibref|RFC5072}}) on this interface. If
          this parameter is present, {{enum|IPv6CP|#.SupportedNCPs}} MUST be
          included in {{param|#.SupportedNCPs}}.
        </description>
        <syntax>
          <boolean/>
        </syntax>
      </parameter>
    </object>

    <object name="Device.PPP.Interface.{i}.PPPoE." access="readOnly"
        minEntries="0" maxEntries="1" version="2.0"
        dmr:noDiscriminatorParameter="true">
      <description>
        PPPoE object that functionally groups PPPoE related parameters.

        PPPoE is only applicable when the lower layer provides Ethernet frames,
        e.g. ATM with EoA, PTM, or anything else that supports an Ethernet MAC.
      </description>

      <parameter name="SessionID" access="readOnly">
        <description>
          Represents the PPPoE Session ID.
        </description>
        <syntax>
          <unsignedInt>
            <range minInclusive="1"/>
          </unsignedInt>
        </syntax>
      </parameter>

      <parameter name="ACName" access="readWrite">
        <description>
          PPPoE Access Concentrator.
        </description>
        <syntax>
          <string>
            <size maxLength="256"/>
          </string>
        </syntax>
      </parameter>

      <parameter name="ServiceName" access="readWrite">
        <description>
          PPPoE Service Name.
        </description>
        <syntax>
          <string>
            <size maxLength="256"/>
          </string>
        </syntax>
      </parameter>
    </object>

    <object name="Device.PPP.Interface.{i}.IPCP." access="readOnly"
        minEntries="1" maxEntries="1" version="2.0">
      <description>
        IP Control Protocol (IPCP) client object for this PPP interface
        {{bibref|RFC1332}}. {{object}} only applies to IPv4.
      </description>

      <parameter name="LocalIPAddress" access="readOnly">
        <description>
          The local IPv4 address for this connection received via IPCP.
        </description>
        <syntax>
          <dataType ref="IPv4Address"/>
          <default type="object" value=""/>
        </syntax>
      </parameter>

      <parameter name="RemoteIPAddress" access="readOnly">
        <description>
          The remote IPv4 address for this connection received via IPCP.
        </description>
        <syntax>
          <dataType ref="IPv4Address"/>
          <default type="object" value=""/>
        </syntax>
      </parameter>

      <parameter name="DNSServers" access="readOnly">
        <description>
          {{list}} Items represent DNS Server IPv4 address(es) received via
          IPCP {{bibref|RFC1877}}.
        </description>
        <syntax>
          <list maxItems="2">
            <size/>
          </list>
          <dataType ref="IPv4Address"/>
          <default type="object" value="[]"/>
        </syntax>
      </parameter>

      <parameter name="PassthroughEnable" access="readWrite">
        <description>
          If {{false}}, the PPP Interface retrieved information is configured
          on the IP Interface stacked on top of this PPP Interface.

          If {{true}}, the PPP Interface retrieved information is propagated to
          the parameters in the referenced {{param|PassthroughDHCPPool}}
          object, replacing any existing configuration (including
          ''MinAddress'', ''MaxAddress'', ''SubnetMask'', ''IPRouters'', and
          ''DNSServers'').
        </description>
        <syntax>
          <boolean/>
          <default type="object" value="false"/>
        </syntax>
      </parameter>

      <parameter name="PassthroughDHCPPool" access="readWrite">
        <description>
          {{reference}}When {{param}} is set to {{empty}},
          {{param|PassthroughEnable}} MUST be set to {{false}} (i.e.
          passthrough can not be enabled without a pool reference specified).
        </description>
        <syntax>
          <string>
            <size maxLength="256"/>
            <pathRef refType="strong" targetParent="###.DHCPv4.Server.Pool."
                targetType="row"/>
          </string>
          <default type="object" value=""/>
        </syntax>
      </parameter>
    </object>

    <object name="Device.PPP.Interface.{i}.IPv6CP." access="readOnly"
        minEntries="1" maxEntries="1" version="2.2">
      <description>
        IPv6 Control Protocol (IPv6CP) client object for this PPP interface
        {{bibref|RFC5072}}. {{object}} only applies to IPv6.
      </description>

      <parameter name="LocalInterfaceIdentifier" access="readOnly">
        <description>
          The interface identifier for the local end of the PPP link,
          negotiated using the IPv6CP ''Interface-Identifier'' option
          {{bibref|RFC5072|Section 4.1}}.

          The identifier is represented as the rightmost 64 bits of an IPv6
          address (the leftmost 64 bits MUST be zero and MUST be ignored by the
          recipient).
        </description>
        <syntax>
          <dataType ref="IPv6Address"/>
        </syntax>
      </parameter>

      <parameter name="RemoteInterfaceIdentifier" access="readOnly">
        <description>
          The interface identifier for the remote end of the PPP link,
          negotiated using the IPv6CP ''Interface-Identifier'' option
          {{bibref|RFC5072|Section 4.1}}.

          The identifier is represented as the rightmost 64 bits of an IPv6
          address (the leftmost 64 bits MUST be zero and MUST be ignored by the
          recipient).
        </description>
        <syntax>
          <dataType ref="IPv6Address"/>
        </syntax>
      </parameter>
    </object>

    <object name="Device.PPP.Interface.{i}.PPPoA." access="readOnly"
        minEntries="0" maxEntries="1" status="deleted" version="2.2">
      <description>
        PPPoA object that functionally groups PPPoA related parameters.

        {{deprecated|2.12|because it contains no standard parameters and its
        existence causes confusion}}

        {{obsoleted|2.12}}

        {{deleted|2.15}}
      </description>
    </object>
  </component>

  <model name="PPP:2.18">
    <component ref="Root"/>
    <component ref="PPP"/>
  </model>
</dm:document>
