Overview and User Guide for TR-069Adapter

[oam/tr069-adapter.git] / docs / user-guide.rst

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
new file mode 100644 (file)
index 0000000..9ebd16f
--- /dev/null
+++ b/docs/user-guide.rst
@@ -0,0 +1,45 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. SPDX-License-Identifier: CC-BY-4.0\r
+.. Copyright (C) 2020 CommScope Inc.\r
+\r
+TR-069 Adapter User Guide\r
+=========================\r
+\r
+This document provides a quick start for using TR-069 Adapter.\r
+\r
+\r
+TR-069 Device Connecting to TR-069 Adapter\r
+------------------------------------------\r
+\r
+Configure URL **http://<external_address_tr-069Adapter>/CPEMgmt/acs** to Device as Management Server URL. \r
+\r
+Importing a Initial PnP Configuration file\r
+------------------------------------------\r
+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
+\r
+To import a configuration file:\r
+\r
+1.     Access the sample configuration file (samplexmls/macid.xml) from the distribution package.\r
+\r
+2.     Edit the macid string in macid.xml file with the device’s macid value.\r
+\r
+3.     Edit the file to add the device configuration details, in the same format as mentioned in the sample file.\r
+\r
+4.     To import initial PnP configuration file using curl use following command \r
+\r
+    ``$curl -F 'files=@<completeFilePath>' http://<external_address>/importConfig``\r
+\r
+    For example:\r
+    ``$curl -F 'files=@/home/tr069admin/0005b9423910.xml' http://tr069.amazonaws.com/importConfig``\r
+\r
+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
+\r
+    ``http://<config_service_IP>:<external_port>/<getConfig>/<MAC_ID>``  \r
+\r
+    For example, ``http://tr069.amazonaws.com/getConfig/0005B9423910`` \r
+\r
+\r
+Mounting a Device in SDN-R\r
+--------------------------\r
+\r
+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