User Guide. version 1.2.0

Size: px

Start display at page:

Download "User Guide. version 1.2.0"

Rhoda Brown
5 years ago
Views:

1 User Guide version 1.2.0

2 COPYRIGHT All rights reserved. This document, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of the license. The content of this document is furnished for informational use only, it is subject to change without notice and it does not represent a commitment on the part of Corinex Communications Corp. Corinex Communications Corp. assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. It is our policy to enhance our products as new technologies, hardware components, software and firmware become available; therefore, the information contained in this document is subject to change without notice. Some features, functions, and operations described in this document may not be included and sold in certain countries due to government regulations or marketing policies. The use of the product or its features described in this document may be restricted or regulated by law in some countries. If you are unsure which restrictions or regulations apply, you should consult your regional Corinex office or the authorized reseller. Published by: Corinex Communications, a.s. Nove Zahrady I. 13/A Bratislava 2, Slovak Republic Europe Corinex Communications Corp West Pender Street Vancouver, B.C. Canada V6E 2N7 Tel.: Fax: Corinex is a registered trademark of Corinex Communications Corp. Microsoft, MS DOS, MS; Windows are either registered trademarks or trademarks of Microsoft Corporation in the U.S.A. and/or other countries. All products or company names mentioned herein may be the trademarks of their respective owners. Copyright Corinex Communications Corp. 2

3 Document Conventions The following typographic conventions are used throughout the documents: Bold face is used: o for the names of dialog boxes and tabs Bold italic is used: o for the names of buttons, checkboxes, dropdown boxes, links o for the names of sections, attributes and fields in the dialog boxes o for the number of figures Italic face is used: o for the values of checkboxes and dropdown boxes o for the name of concrete agent, subnet, device shown in an example o to illustrate user input and for reference to a parameter or field value shown in an example o for the description of figures and tables Underline face is used for notes 3

4 Contents Quick Overview... 5 System Requirements Registration and User management Superuser registration Password Complexity Explained Login to SG Netman User management User registration Adding and Initializing an Agent Adding IP Subnet Adding Clusters Adding clusters manually Adding clusters from the scan Scanning Clusters Device Information and Configuration Information Configuration Device monitoring Device reporting Device measurements TELNET

5 Quick Overview Corinex SG Netman is a server-based application designed to offer tools for managing complex BPL networks, and for provisioning multiple services in these networks. Corinex SG Netman enables operators to install, manage, monitor and evaluate their networks. By providing a web-based GUI and automating a number of complex and tedious tasks, SG Netman maximizes operational efficiency, allows proactive diagnostics, and minimizes service deployment times. SG Netman operates as a centralized system with one controller and multiple agents in order to deploy and manage complex BPL topologies. For additional specifications, please see SG Netman datasheet. System Requirements SERVER (Controller) Minimum Processor: Dual Core 2.0 GHz Recommended Processor: Quad Core 2.4 GHz Minimum RAM: 2 GB Recommended RAM 4 GB Operating System: Linux Ubuntu 13.4, 32 bit Database: Linux Ubuntu 13.4 AGENT Recommended Processor: 2.0 GHz or faster Recommended RAM: 1.0 GB or greater Operating System: Linux Ubuntu

6 1 Registration and User management Before logging into SG Netman software, it is necessary to register with a username and password. 1.1 Superuser registration After the first entering of controller IP address into web browser, the dialog box for user registration will appear automatically. In this case (the first user registration) will be created the superuser with unlimited rights. Figure 1: Superuser registration Fill your registration details (username and password) and click on Register button to finish this process. User role function is for Superuser inactive. In the Registration dialog window the user is informed about the validation of input registration data. 1.2 Password Complexity Explained Password complexity is validated and must have a minimum length of seven characters; furthermore, minimum password length is a function of the number of character classes employed in the password itself, of which there are four: 1. Lowercase letters 2. Uppercase letters 3. Numbers 4. Special characters 6

7 One Class characters: A password with characters of only one class. The default minimum length required for this password type is 20 characters. Two Class characters: A password with characters of two classes. The default minimum length required for this password type is 15 characters. Pass Phrase: A password that consists of multiple words. The default minimum length required for this password type is 11 characters. Three Class characters: A password with characters of three classes. The default minimum length required for this password type is 8 characters. Four Class characters: A password with characters of four classes. The default minimum length required for this password type is 7 characters. 1.3 Login to SG Netman If the registration process is successful, the registered user (in this case superuser) is then able to login to SG Netman with his username and password to use the software. Figure 2: User login 7

8 After logging in, the following screen is displayed. Figure 3: SG Netman Home screen Main tab on the top of SG Netman screen consists of 2 sections: 1. Network network topology, configurations, devices information, measurements, network management 2. Settings User management 1.4 User management Figure 4: User management 8

9 In SG Netman User management are pre-defined three roles with the pre-defined (default) access permissions. Only superuser has these permissions unlimited, for other roles (Administrator, Operator, Observer) is possible to use pre-defined (default) access permissions or set/change these permissions by clicking to Access checkbox, as is described in Figure 4. Access permissions: 1. None without access 2. Read user can only read data/informations 3. Read/Write user can read and edit the data 4. Full full access (editing, removing, ) 1.5 User registration For the creating other user accounts select the Users section and add new user by Register button. Registration of users is the similar to superuser registration at the beginning but with the difference that is possible to assign the pre-defined role to new user, see below. Figure 5: User registration Figure 6: List of users 9

10 2 Adding and Initializing an Agent On main page click Add agent button and add the agent name as is shown below (e.g. agent1 ) Figure 7: Creating an agent After the adding an agent, it will then have to be authenticated an unauthenticated agent is represented by a red exclamation mark. For authentication select agent1 and go to Settings tab. Browse the hard drive to upload the certificate file with credentials to authenticate the registration request from agent to concentrator. Because agents may be installed on different servers in the network, certification files can either be generated on agent servers (self-signed certificate) or obtained from an external certification authority and subsequently uploaded to the concentrator. Settings will be saved by clicking on the Save button and confirmed with a Success dialog. Figure 8: Agent authentification Agent is now connected, as it's icon has changed to a green connected wire. Figure 9: New agent (agent1) 10

Figure 10: Adding subnet A New subnet dialog is now displayed related to agent1.

11 3 Adding IP Subnet It is necessary to assign devices to relevant IP subnets before proper device management can be enabled. To create a new IP subnet, select the agent (agent1) and click on Add subnet button. Fill in the needed IP information i.e. network address and subnet mask, and then confirm by clicking the OK button. Figure 10: Adding subnet A New subnet dialog is now displayed related to agent1. Click on the created subnet, then go into subnet settings by clicking on the Settings tab; in this screen it is possible to change subnet settings, or to delete the subnet if no clusters with devices are associated with the selected subnet. Figure 11: Subnet settings 4 Adding Clusters For each subnet, it is possible to create a several segments using clusters. Each cluster is assigned its own master/head-end, and is represented as a separate part of the subnet. There are two options for adding/creating clusters: 1. Manually, from the list of DHCP discovered devices a user can add a new cluster by selecting the MAC addresses of the discovered devices. 2. Automatically, from the network scan a user can determine from the scan all of the clusters (configured manually) and then select the clusters to add. 11

4.1 Adding clusters manually The new clusters can be manually added by clicking on the Add devices button in the Discover tab screen then choosing the MAC address (click on MAC address button) of the

12 4.1 Adding clusters manually The new clusters can be manually added by clicking on the Add devices button in the Discover tab screen then choosing the MAC address (click on MAC address button) of the master and adding it as a new cluster. Users can also change/set the configuration of each device static/dhcp dynamic IP address, configuration type, profile (Master configured in specific frequency mode, Repeater, Slave, etc.) and save the settings by clicking OK. The new clusters with selected masters will be created and then belong to Subnet A Selecting the master and adding clusters: Figure 12: Adding clusters manually The new clusters Cluster_0dff00 and Cluster_09680c are added to Subnet A Figure 13: Topology with added clusters 12

4.2 Adding clusters from the scan It is possible to scan the network in order to find all defined clusters in the network by clicking on the Scan button.

13 4.2 Adding clusters from the scan It is possible to scan the network in order to find all defined clusters in the network by clicking on the Scan button. All the clusters are displayed in the topology tree (as Unknown clusters with the end portion of the master/head-end MAC address). To see all devices, check the Show devices checkbox. Figure 14: Scanning subnet Whole network topology (all devices in the network): Figure 15: Scanning subnet all devices 13

14 Selecting the clusters (including the devices assigned to them) and their configuration: Figure 16: Adding clusters The new clusters added to Subnet A : Figure 17: Topology with added devices 14

beside To retrieve configuration information from a device, go into the Configuration tab and click on the Retrieve button.

15 After adding the selected devices, SG Netman will automatically begin periodic queries to the devices for availability. All devices whose configuration parameters have yet to be read will each have question marks (?) beside them. Reachable devices will each have a green icon them, and unreachable have red icon. beside To retrieve configuration information from a device, go into the Configuration tab and click on the Retrieve button. After obtaining the configuration information from the device, the configuration state will be changed from to and device status icon in changed from to. Figure 18: Retrieving configuration information from a device 5 Scanning Clusters Select a cluster and click on the Scan button to initiate a scan. The result topology of the scanned network can be shown in Overview (graphic view) mode or Table (list of devices) mode, see below. AGC RX / TX Physical speeds RX/TX MAC address IP address Short MAC address Figure 19: Cluster topology with parametric description 15

16 6 Device Information and Configuration Several tabs are available upon selecting a particular device. 6.1 Information This tab shows basic information that can be retrieved by clicking on the Retrieve button. After the information retrieval process is complete, information such as device uptime, number of boots, device mac address, serial number, IP address, node type, other connection parameters (including the physical PLC connections to selected device) and time-stamp of the last information update are available for viewing. To check the connection latency to the device, click on the Ping button. The pinging results are then displayed next to the Ping button. Figure 20: Device Information To view the actual physical PLC connections to a selected device, click on the Retrieve PLC connections button. The table of PLC connections shows all of the devices (nodes) connected to a selected device, the number of virtual ports to which nodes are connected, IP address, MAC address, physical speeds, node type and number of devices (children) connected. Figure 21: Retrieving PLC connection data 16

17 If more users want to edit the same device, it is possible for the first user working with device. Second user is informed that other user is currently editing the same device and the editing buttons of this device become for second user inactive (user can see the editing steps of first user). Figure 22: Editing of the same device by more users 17

18 6.2 Configuration The Configuration tab consists of basic and advanced settings. In the Basic settings section of device configuration it is possible to set: Name - The name of device Known IP address o Static changes only in SG Netman database, this change will not affect the device itself Autoconfiguration function is disabled o DHCP custom changes only in SG Netman database, this change will not affect the device itself Autoconfiguration function is enabled o DHCP dynamic IP address will be assigned automatically by DHCP server Autoconfiguration function is enabled Delete device Removing the device from SG Netman topology If the user wants to change/set the static IP address of a device (not only in SG Netman database), the user must first do so in the Advanced settings section, in order to effect changes to the device itself, and then afterwards in the Basic settings section, to update the database. Figure 23: Device configuration Functional buttons: Button Description Retrieve information/parameters from device Save changes to SG Netman database Save/set configuration to device Restart device (if it becomes necessary to restart device in order to apply configuration changes) 18

19 In the Advanced settings section it is possible to set several device parameters as shown below. Figure 24: Device configuration list of parameters 19

20 Advanced settings description of functions: Functional setting Node Type [save] Basic Mode [save] Number of Hops [restart] Fix Master [restart] Prefer Master [restart] Coupling DHCP Server [save] Static IP address [save] Static NetMask [save] Static Network [save] Use Vlan Mode [restart] MNMT Vlan [restart] Data Vlan [restart] Add Trunk Vlan [restart] Use Custom Vlan [restart] Access ETH Port [restart] Power Mask Description Configuration of the actual device [Master Repeater Slave] In Master: Signal mode for transmitting. Configure the minimum number of hops to the HE from a slave. 0 means that no extra hop must be taken to reach the HE, so the slave always connects to the HE directly (if able). 1 means one extra hop is enforced to reach the HE; that is, the equipment will first connect to a TD repeater (if able). Fixed master for a given slave by MAC address. If the slave was connected to another master, it will disconnect and connect to this FIXED master. Preferred master for a given slave by MAC address. This parameter is useful because the slave will try to connect to the preferred master if it is present and the AP_MIN_NUMBER_HOPS is valid with that master. If not, it will connect to any other master. Select RF signal injecting type of BPL. Enable/disable DHCP server initialization for the next boot, if NVRAM mode is used. IP address of the modem (for the next boot if DHCP is disabled). IP netmask of the modem (for the next boot if DHCP is disabled). IP default gateway of the modem (for the next boot if DHCP is disabled). Enable/disable the use of VLAN Manage VLAN tag of high-level FW management protocols. Configure the VLAN tag for the data packets (packets coming from the external interfaces). Add new VLAN ID to trunk list[2-4093] This parameter enables other VLAN/OVLAN parameters. Default value: no VLAN tag for tagging untagged packets from the external interface. To show the setting of actual power mask, click on the Show button. To change the power mask, choose the Edit option and set the initial and final frequency or frequencies and depth (attenuation in db) of power limitation. 20

If the device is already configured and the user do not need to change its settings, SG Netman saves its retrieved configuration to the database and the device status

(if the device is unreachable, its status icon shows as / / ).

Note: Restart Device button (3) is active only for changing of certain parameters if it becomes necessary to restart a device for setting/changing an application.

21 If the device is already configured and the user do not need to change its settings, SG Netman saves its retrieved configuration to the database and the device status icon remains (green, if the device is reachable). If the device has been configured by SG Netman, the device status icon changes to. (if the device is unreachable, its status icon shows as / / ). To save the settings to the SG Netman database/device it is necessary to use the buttons on the top portion of the screen. Note: Restart Device button (3) is active only for changing of certain parameters if it becomes necessary to restart a device for setting/changing an application. Figure 25: Example of changing/setting of device configuration Setting of Power Mask To see the actual power mask of any device go press Show button of power mask function in Advance setting section. On the picture below is possible to see the device 000BC20ADD50 transmitting the BPL signal without limitations (full power). Figure 26: Obtaining power mask setting 21

If the user wants to change the power mask of any device and limit its output power, it can be done using the Edit option in the Power Mask interface, by setting the initial and ending frequency or

22 If the user wants to change the power mask of any device and limit its output power, it can be done using the Edit option in the Power Mask interface, by setting the initial and ending frequency or frequencies and depth (attenuation in db) and applying the changes by clicking on the OK button, as described below. The power output of the device is limited, between 500 to 700 carriers (by 75 db increments) and 701 to 1300 carriers (by 30 db increments). To save the settings to the database and device it is necessary to use the top buttons Save to database, Save to device. Figure 27: Power Mask setting 6.3 Device monitoring Figure 28: Device monitoring In this section it is possible to set the conditions for reporting of monitored devices in the network, such as ping, device uptime, AGC TX, AGC RX, and measurements of SNR and CFR. Reporting PING - SG Netman will ping devices in set intervals (default value: 15 seconds); device status and availability is indicated by status icon color: Green device is pingable/reachable Red device is not pingable /reachable To change the default value it is necessary to select the undefined profile - (see below) and apply using the Set button. Using the Add button it is possible to set a new value of ping retrieval period (in seconds). Figure 29: Selecting of report profile 22

Figure 30: Ping reporting After the changing of default ping interval it is possible to change the value just using the Add button; the actual value will be rewritten.

23 Figure 30: Ping reporting After the changing of default ping interval it is possible to change the value just using the Add button; the actual value will be rewritten. To remove the ping period value, use the remove button. Note: If no value is set, device availability status will not be monitored. To add a new report (one by one) click on the Add button and select the parameter (Ping, Up time, AGC TX, AGC RX) for reporting and monitoring. These reporting parameters are also pre-defined in the Burn-in profile. See report table below. Figure 31: Selecting of pre-defined report profile (Burn in) Measurements Measurements are for monitoring PLC link quality and can be automatically collected from devices. To add a new metric to monitor, click on the Add button. In the displayed pop-up window, choose an existing PLC link to some connected device, the measurement type, and the iteration period. Figure 32: Adding measurements for monitoring 23

24 6.4 Device reporting To see the reporting results switch to Report tab. From the Filter dropdown box, select some predefined report type to see a filtered reports table with the collected values. Figure 33: List of monitored parameters 6.5 Device measurements Choose the desired type (SNR, CFR, BPC), link, and date range of measured data, then click the Load button to read the measured data and choose the measurement type (for example, SNR). The results can be exported by clicking the Generate PDF files button. Figure 34: Measurement results - SNR 24

25 Measured data are displayed in graphs after the selecting measured data records. Figure 35: Measurement results - SNR To see more traces, the user should take a snapshot of the displayed SNR/CFR scope results by clicking the Hold button (for a maximum of 8 traces). Each of the displayed traces is shown in a different colour (see below). All displayed traces can be removed by clicking on the Clear button. Figure 36: Measurement results SNR holding of results 25

csv file (without graphical results, only numeric values) using the Export

26 All of the results are possible to export by Generate PDF files button (including the graphs) or export to *.csv file (without graphical results, only numeric values) using the Export button. For showing or saving the exported data, use Download button. Figure 37: Exporting of measured results 26

Figure 38: Opening the telnet session to device The user will then be connected to

27 6.6 TELNET The last tab screen of the selected device is Telnet. To open a telnet session to the device, click on the Connect button. Figure 38: Opening the telnet session to device The user will then be connected to the device via telnet, at which point the device is ready for status check or configuration. Figure 39: Telnet session 27

Corinex Communications Corp. assumes no responsibility or liability for any errors or inaccuracies that may appear in this book.

Corinex Communications Corp. assumes no responsibility or liability for any errors or inaccuracies that may appear in this book. Copyright This Quick Start Guide, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of the license. The content of this manual