TR-069 (ACS - Auto configuration server)

Starting from Splynx 3.1 version we have in-built ACS server based on GenieACS - open source TR-069 remote management solution with advanced device provisioning capabilities. GenieACS can work with any device that supports the TR-069 protocol. It auto-discovers the device’s parameter tree (including vendor-specific parameters) making no assumptions about the device’s data model.

Using Splynx you can configure devices directly from Splynx web page.

To enable ACS in Splynx, navigate to Config/Integrations and find Main modules button:

main modules

and enable a toggle for TR-069(ACS):

enable

Once TR-069 (ACS) is enabled you will see a new sector under left side menu under topic Networking:

menu

Let's start configuring the ACS server:

Step 1

Navigate to Config/Networking/TR-069(ACS) and install the ACS server:

install

Once installed specify global parameters:

global config

Here we have next options:

  • Enable ACS services - enable/disable ACS services. Can be used to reboot of ACS server;

  • SSL enabled by default - enable/disable using of domain name except of IP for access. Enable only if HTTPS/SSL enabled under Config / Main / HTTPS/SSL;

  • Allowed networks - list of allowed networks for connecting to cwmp service. To allow all host use 'all' value;

  • Username - using for authorization to connect to cwmp service. ATTENTION - authorization enabled only if username and password is not empty;

  • Password - using for authorization to connect to cwmp service. ATTENTION - authorization enabled only if username and password is not empty;

  • Hostname - hostname without protocol and port(192.168.105.80 or mysplynx.com depending on your configuration);

  • Periodic inform inverval(seconds) - interval on how often Splynx will sync with an ACS.

Don't forget to click on "Save" button when configuration is completed.

Step 2

On the same menu Config/Networking/TR-069(ACS) let's configure ACS User Interface parameters:

config_ui

  • Enable ACS UI - enable/disable an access via web interface;

  • Allowed networks - specify allowed networks from which you can access to the ACS UI;

  • UI username - username for UI access;

  • UI password - password for UI access.

Don't forget to click on "Save" button when configuration is completed.

Step 3

Click on a link for UI here:

UI link

And you should be redirected to the Genie ACS page, if you prompted for login/password use a login/password from a previous step.

After successful login you will see this window where you should click on "ABRACADABRA" button.

abracadabra

The default username and password for GenieACS: admin/admin

Once this done, you will see GenieACS dashboard:

genie

Connect the device

Let's add some TR-069 client. We will use a Mikrotik device as an example. First of all, TR-069 package should be installed on Mikrotik. If this package is not installed, use the next steps to install it:

  1. Open Winbox and connect to the router;

  2. Update router to latest stable version System > Packages > Check for updates and update if required;

  3. Navigate to Mikrotik Downloads and download the package for your device;

  4. Extract the downloaded archive and find tr069-client-X.XX.npk;

  5. Upload tr069-client-X.XX.npk into your device and reboot Mikrotik (System > Reboot);

  6. After reboot you should see a TR-069 option in menu:

tr-mikrotik

Click on TR069 item and configure connection to the ACS:

  1. Enable client;

  2. ACS URL is a URL from menu on step 3 for a CWMP (ends with port 7547);

URL

If you noticed we are using here another URL - it's because we changed a hostname from IP 192.168.105.80 to a domain name.

  1. Specify username and password with values from global parameters (Step 1);

  2. Enable "Periodic Inform Enabled".

That's all. After that you should see next:

connected

Should appear "Connection Request Username" and "Connection Request Password" - do not change these parameters (only when you need to reconnect this device with an ACS, these values can be removed and re-enable client - with new connection you will see a new values).

Important note for Mikrotik devices: if you are using HTTPS/SSL on your Splynx server you can get an error about SSL, asking for the local certificate. In this case you need to run 2 commands in Mikrotik terminal:

/tool fetch https://letsencrypt.org/certs/trustid-x3-root.pem.txt
/certificate import file-name=trustid-x3-root.pem.txt passphrase=""

and do not change any other config in TR-069 client ("Client certificate" option must be "none"), just re-enable TR-069 client.

After that device will be registered under GenieACS:

device under genie

as well under Splynx:

device in Splynx

Devices can be in statuses: Online, Online today, Offline.

Main parameters for ACS are configured and device is connected so you can manage the device remotely now. Also we have a few more options to configure: Attributes, Types and Groups.

additional config

Types:

Simply add different types of devices:

types

NOTE! Before configuring ACS groups you need to connect some device to ACS server.

Groups:

Under groups you can create new entries to group devices.

groups

Here can be selected the next parameters and the inventory product code (if existed), selected photo of device etc. You can use next tool to grab some parameters from a device:

Groups are using for auto-provision devices and load device's parameters and properties from correct TR069 attributes.

Once some device is added you can create a group base on that device, provision configuration parameters from this device, edit them and save. After that these parameters can be used for configuration of other devices from this group using the existed parameters.

wizzard

We have a few options here:

wizzard options

  • I have one fully configured device (and ready to reset configuration, (I have backup of full config) - this option can be used when you have configured one device (Device 1) of this type and you need to configure another clear device (Device 2) with existed parameters. Splynx will grab parameters from Device 1, check what parameters can be used for Device 2 configuration and pull these changes. Or you have a backup what can be used for configuration;

  • I have one non configured device and ready to configure this device (or I have backup of config and ready to apply it on next steps) - vice versa to a previous method;

  • I have two similar devices (One is fully configured, and one is not configured) - need 2 devices, one is fully configured and another one is not-configured. The configuration from both routers will be downloaded, only after that this config can be updated;

  • I have one device and ready to play with manual insert of parameters - download configuration from a device and edit this config manually;

  • I have a configuration file for import and want to import this file - in this step you need to import a .csv file with a configuration what can be imported;

  • I want to insert config manually - manual way to configure a device;

After this step you will see a window with available attributes:

provisioning attributes

You can add new items or edit existing. In the specific field you can select one attribute and choose a lot of other options.

If you select template option you can use twig to create field value.

By click on additional button near "Save" button you can preview, export settings into a .csv format (for future, use it for configuration of other devices) or import an existing .csv file with settings.

provisioning 2

Also you can view custom attributes here:

view attributes

Attributes:

Here can be added some custom attributes to be displayed under ACS devices in Splynx. For example, we need to display a DNS attribute on the main info of device:

attributes

Once the attribute is added, you need to connect some devices to proceed with its configuration.

You will be able to display all these attributes:

genie_attrtbiutes

Once some devices are added and you have groups available, click on "Attributes config" near some group:

attributes config

Select a device and click on "Load" button to load attributes. In this guide a Mikrotik device is used as an example. After the load, the attributes are ready to use:

available attributes

and after its configuration you'll see the attribute values on the device overview.

Let's see on device control menu: device overview

On the Overview tab you can see basic parameters like uptime, IP. CPU usage etc.

On the Relation tab you can set type of device (type should be created under Config/Networking/TR-069/Types), group (should be created as well) also the customer and their services can be linked to this device.

On Tasks tab you will see the pending tasks (like you run a wi-fi password change and task will be created).

On Faults tab you will see tasks what were executed with an errors.

faults-tasks

When click on Actions button you can find next options:

actions

  • Refresh - you can use it to refresh device connection between ACS and Splynx;
  • Reboot - remotely reboot a device;
  • Run provisioning - run provisioning for a device;
  • Send file - send some file to a device;
  • Factory reset - reset to factory settings;
  • Delete - delete this device from the ACS (if the device connected to the network it will return to the list. TR-069 client need to be disabled on a device in case you don't want this device to appear on the ACS again).

device setup

This view can change depends on device what you are using. This screenshot was made from a Mikrotik device. Switch between available tabs to configure needed parameters.

LAN tab

As an example we can change a DHCP server parameters:

DHCP attributes

or add some firewall rules right here:

firewall rules

On Diagnostic tab you can find diagnostic tools like ping, traceroute, upload/download statistic and wifi-analyzer:

diagnostic

To run some diagnostic tool click on "Run" button near each tool.

NOTE! This menu can differ depending on a device. These screenshots were made on a Mikrotik device.

Wi-fi analyzer shows all the available wi-fi networks and signal strength near a device.

Debug logs can be found under Administration / Logs / Files and find files by word "genie":

logs

Files and upgrades

Under Files you can upload some update files, or configuration files for a devices.

files

To upload a new file click on "Add file":

add file

Once files uploaded, you can use them to upgrade a devices under Upgrades menu:

upgrade

Now we can see devices for the upgrade (from this group) and some parameters for an update can be specified.

update 2

Click on this button to update a device.

ready for upgrade

Some features description

Relation with inventory

It is possible to assign device by ACS identifier (Barcode or Serial number) to customer before device establishes first connection to ACS. Splynx checks for some value in a field "Barcode" of inventory item, if "Barcode", on the first connection, matches with "Serial number" device field - customer will be linked automatically. If field barcode is empty or does not match "Serial number" of a device - in this case field "Serial number" will be used from inventory item. In this way you can add an inventory item with a barcode or serial number specified and assign it to a customer:

item

After this you can setup some group and auto provisioning, for example to push PPPoE login&password, wifi SSID&password on first connect. During the first connection a TR-069 device will be automatically assigned to a customer and an initial configuration will be pushed:

group_mikrotik

and after first connect:

first

Device management by customer from portal page

The customer can reboot and change SSID and Wi-Fi password for assigned devices directly from portal page on menu Service -> Hardware:

manage

Troubleshooting

Follow these instructions to troubleshoot problems with TR-069 (ACS):

Can't connect device to ACS

  1. Make sure that device is accessible from Splynx server. Use tools like ping or traceroute to ensure;

  2. Pay attention to IP restrictions. Requests have to come from IP/network allowed in this list:

    ip_restriction

  3. Make sure that CWMP URL, username and password what are configured under TR-069 client on a device is correct and ports 7547, 7567 are opened;

  4. Disable firewall on a device to ensure that it's not a firewall issue;

  5. In case of using HTTPS - try to disable option "SSL enabled by default", and use CWMP URL like http://splynxserver.com:7547/ instead of https at the beginning.

  6. Restart GenieACS services using this command - "sudo service genieacs* restart"

Device is registered in Splynx but no communication established

  1. Make sure that device is accessible from Splynx server. Use tools like ping or traceroute to ensure;

  2. Pay attention to IP restrictions. Requests have to come from IP/network allowed in this list:

    ip_restriction

  3. Refresh device using this option and wait for the result:

    refresh_Device

  4. Pay attention to windows "Tasks" and "Faults". Try to remove all tasks and all faults using remove button:

    troubleshoot_faults

  5. Disable TR-069 client on a device, remove device from Splynx and enable TR-069 client to re-add device in Splynx.