docs/user-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
   2 .. SPDX-License-Identifier: CC-BY-4.0\r
   3 .. Copyright (C) 2020 CommScope Inc.\r
   4 \r
   5 TR-069 Adapter User Guide\r
   6 =========================\r
   7 \r
   8 This document provides a quick start for using TR-069 Adapter.\r
   9 \r
  10 \r
  11 TR-069 Device Connecting to TR-069 Adapter\r
  12 ------------------------------------------\r
  13 \r
  14 Configure URL **http://<external_address_tr-069Adapter>/CPEMgmt/acs** to Device as Management Server URL. \r
  15 \r
  16 Importing a Initial PnP Configuration file\r
  17 ------------------------------------------\r
  18 Initial PnP Configuration file supports the ability to configure the PnP parameters that TR-069Adapter must provision to the Device as part of a BootStrap Inform. The configuration XML (3GPP TS 32.594) file is used to define the initial PnP Configurations for Device. Before importing a configuration file to a server you must edit the file to enter the required configuration details.\r
  19 \r
  20 To import a configuration file:\r
  21 \r
  22 1.      Access the sample configuration file (samplexmls/macid.xml) from the distribution package.\r
  23 \r
  24 2.      Edit the macid string in macid.xml file with the device’s macid value.\r
  25 \r
  26 3.      Edit the file to add the device configuration details, in the same format as mentioned in the sample file.\r
  27 \r
  28 4.      To import initial PnP configuration file using curl use following command \r
  29 \r
  30     ``$curl -F 'files=@<completeFilePath>' http://<external_address>/importConfig``\r
  31 \r
  32     For example:\r
  33     ``$curl -F 'files=@/home/tr069admin/0005b9423910.xml' http://tr069.amazonaws.com/importConfig``\r
  34 \r
  35 5.      You can check the imported configuration file details by entering the config service IP, external port, getConfig command, and MACID as shown in the below format in your browser:\r
  36 \r
  37     ``http://<config_service_IP>:<external_port>/<getConfig>/<MAC_ID>``  \r
  38 \r
  39     For example, ``http://tr069.amazonaws.com/getConfig/0005B9423910`` \r
  40 \r
  41 \r
  42 Mounting a Device in SDN-R\r
  43 --------------------------\r
  44 \r
  45 Device will get auto mounted in SDN-R once the BootStrap message is received from device and forwarded to VES Collector as VES PnfRegistration message by TR-069 Adapter. \r