Introduction

This guide explains how to use the FlowVision Graphical User Interface (GUI) to manage ASN servers efficiently.

The FlowVision GUI provides the following top-level menu options:

• System

• Configuration

• Statistics

• Help

The following image shows the home page of the Aviz FlowVision GUI:

The System menu lets you perform the following actions:

• Viewing the Dashboard

• Accessing the General System and Device Information

• Managing Devices

• Viewing System Log

• Managing Users

• Managing License

• Performing Backup and Restore

• Viewing Audit Logs

The Dashboard is the default home page of the FlowVision GUI. To return to the dashboard view from any other page, click System > Dashboard.

The Dashboard shows you the following data:

OPB Fabric Information

This pie chart shows you the device information based on the ASN Version and the ASN Location. You can hover the mouse pointer over the charts to display a tooltip with more relevant information.

The following image shows the ASN fabric information charts:

Platform Health

The platform health table shows you the CPU usage, and memory availability for each connected node. From this data, you can infer the overall health of the platform.

The following image shows the platform health table:

Link Information

The link information table displays the total number of ports across all connected nodes, the number of ports enabled with administrative privileges, and the number of ports that are down.

The following image shows the link information table:

Top 5 Ports by Traffic

The top 5 ports by traffic show you the top 5 ports across all connected nodes sorted on the basis of their traffic rate. The table shows you the device, port, Mode, In Pkts & the number of In Discards.

The following image shows the top 5 ports by traffic table:

SYSLOG STATISTICS

The SYSLOG Statistics shows you the nodes sorted based on the SYSLOG messages. The table shows the device IP, and the number of SYSLOG messages, filtered by severity.

The following image shows the SYSLOG Statistics:

ASN MODULE STATUS

The ASN Module Status shows the top nodes and their health with details about the various components of ASN sorted node IP.

The following image shows the ASN Module Status:

HA STATUS

The HA Status shows the HA status between the connected nodes along with the Cluster Status & Data Export Status.

The following image shows the HA Status:

To access the system and device information, click System > General.

System Information

The system information table shows you the product name, version, and technical support information about the system.

The following image shows you the system information tab:

Devices Information

The Devices Information table shows detailed information and properties of each connected ASN node. For each ASN node, the table shows the IP address, the MAC address, the Name of the device, the Version, the location, the Ubuntu version of the service, uptime, and the options to edit them.

Editing Device Properties

You can edit device properties from the Devices Information table:

1. Click the Edit button corresponding to the required node on the Devices Information table. The Device Properties window displays.

2. Change the required node property value in the editable fields. Currently, you can edit the Name and Location.

3. Click Save to apply your changes.

To manage connected nodes from the FlowVision GUI, click System > Devices.

The Devices screen shows all the connected nodes and their connection status. The nodes that are online are shown with a green status and the nodes that are offline are shown in a red status.

You can click the icon to reboot an online device. To delete a device, click the icon. ASN configuration is autosaved to the DB periodically, use the icon to save the configuration explicitly.

The following image shows the Nodes page:

Adding New Devices

To add a new device,

1. Click the icon at the top right corner of the Devices page. The Add New Device window displays.

   • Default Credentials:

     • Username: admin

     • Password: admin

2. Specify the values for IP Address, Username, and Password in their respective fields.

3. Click Save to apply your changes and add the device. Click Discard to discard your changes.

To view the system log from the FlowVision GUI, click System > Syslog.

The Syslog page shows the system logs of all the nodes that are online. You can click the device icon for each of the online devices to get the system log for that particular device. The system log shows the device IP, component, severity level, time stamp, and the severity level message with more specific information.

The following image shows the system log table of a device:

You can change the severity level of the messages displayed in the syslog table using the Severity Level drop-down menu. The available options are Debug, Info, Notice, Warning, Err, Critical, Alert, and Emergency. This is a multi-select menu where you can select multiple severity levels to be displayed.

To manage users from the FlowVision GUI, click System > User Management.

The User Management page shows the details of all the users of the system and their user privileges and roles. From the User Management page, you can add new users, edit user roles and permissions, de-activate a user, and delete a user.

The following image shows the User Management page:

Adding a New User

To add a new user,

1. Click the ADD button on the header of the user management table at the top. The New User window displays.

2. Specify the Email address, Username, Password, and Role of the new user in their respective fields. The Role drop-down field has two options - Admin and Viewer. The Admin role has full access and the Viewer role has read-only access.

3. Click Save to create the user.

Editing Existing Users

To edit an existing user,

1. Click the Edit button against the user in the User Management table. The Edit User window displays.

2. Edit the required details in the Email, Username, Password, and Role fields.

3. Click Update User to update the user details.

De-Activating or Deleting Users

In the User Management table,

• Click the De-Activate button to deactivate a user.

• Click the Delete button to delete a user.

To configure the Licenses for ASN Nodes from the FlowVision GUI, click System > Licence

This page displays the current license details in a table format along with Node IP, MAC Address & Serial Number allowing you to either add a new license key for a new ASN device or update an existing license.

• The following license details are shown for each ASN device:

  • Subscriber License Key, Type & Status

  • Application License Key, Type & Status

Adding or Updating a License

To add or modify the license for an ASN node, follow these steps:

1. Click on the Edit button on the license table next to the respective Node

2. A popup window will appear with the following fields:

   1. Subscriber License Key

   2. Application License Key

3. Replace these fields with valid License values

4. After making the changes, click the Save button to apply the new license key

Information Icon

In the License Information Table, the Subscriber License Key and Application License Keycolumns include an information icon

• When hovering over the info icon, detailed license information will be displayed, including:

  • License Type

  • License Status

Introduction

ASN DPI (Deep Packet Inspection) identifies applications using pattern-based signatures. Aviz Networks provides seamless signature updates, allowing support for new applications or enhancements of existing ones without impacting the existing deployment.

Upgrade Process

Follow these steps to upgrade ASN DPI without restarting ASN modules:

1. Copy the Signature File to the ASN Device

scp asn-dpi-*.tar.gz <ASN_DEVICE>

2. Extract the Tar file

tar xzvf asn-dpi-v1-(Name).tar.gz

3. Navigate to the Installation Directory

 cd asn-dpi-install/

4. Execute the Upgrade Script

sudo ./upgrade_dpi.sh

Introduction

To perform a backup or restore from the FlowVision GUI, navigate to: System > Backup/Upgrade

The Backups page displays a list of available system backup files with the following details:

• Backup Filename

• Date of Backup Creation

• Backup Status

• Option to Delete Specific Backup Files

Additionally, this page provides options to: Upgrade the system using a .jar file. Upgrade the database using a local .sql file.

The following image illustrates the Backups page:

Creating a New Backup

To create a new backup, click the Create Backup drop-down menu and select Create Backup. This action creates a new backup file, displaying its status in the backup table.

You can also have the option to selectively backup the database or the FlowVision system. To perform this selective backup,

1. Click Create Backup > Create Backup. The New Backup window displays.

2. This will take the backup of the DB and Flowvision.

Advanced Backup

1. Click Create Backup > Create Backup (Advanced).

2. Select the backup you want to create. The available options are - Backup DB and Backup FlowVision. This is a multi-select option where you can choose either or both.

3. Click Backup to create the selected backup.

Restoring from a Backup

After completing a backup, you can find the list of backups in a table format below

Click on the Restore Icon to restore that particular backup (.sql / .jar ).

The New Backup window displays, used need to select Restore DB or Restore FlowVision or select both if both are available, then Click on the Restore button.

After Restore is completed, there will be a pop-up -

Note: The user also can download the backup files ( .sql / .jar ) by clicking the Download Icon, it will save the file to the local system.

Upgrading FlowVision

You can upgrade the FlowVision system if required. To upgrade,

There are 2 types of upgrade provided

1. Upgrade Flowvision

2. Upgrade DB (using a local file)

Upgrade Flowvision

1. Click Upgrade System on the top right corner of the Backups page. The Upgrade System window displays.

2. Select the Upgrade FlowVision checkbox and select .jar file from the local system

3. Click Upgrade to upgrade the system.

After the Upgrade, there will be a popup that -

Upgrade DB

1. Click Upgrade System on the top right corner of the Backups page. The Upgrade System window displays.

2. Select the Upgrade DB checkbox and select .sql file from the local system

3. Click Upgrade to upgrade the system.

After the Upgrade, there will be a popup that -

Deleting a Backup

To delete a specific backup file, click the icon against the corresponding backup file in the Backups table. Confirm the delete action in the Confirm Delete prompt.

To view the audit logs from the FlowVision GUI, click System > Audit Logs.

The audit logs table gives you the details of all the actions performed on the connected systems. The details include the action performed, the date, the IP address of the system used to login to the GUI, the resource used, the username of the operator that acted, and the status of the action.

The following image shows the audit logs table:

The configuration menu helps you perform the following:

• Configuring Ports

• Configuring Metadata Attributes

• Configuring Global Parameters

• Configuring System Parameters

• Configuring Kafka Security

To configure ASN ports using the FlowVision GUI, navigate to:

Configuration > Ports.

This page displays:

• Managed Nodes and their connected ports.

• A detailed Ports Table showing:

  • Admin Status.

  • Link Status (UP = Green, DOWN = Red).

  • Speed & Mode.

  • GRE Strip.

  • Port Description.

• Port Modes in ASN:

Cplane (Control Plane): Handles control-plane traffic, such as S11, N4, and N11.

Uplane (User Plane): Manages user-plane traffic, including S1-U and N3.

Hover over a device or port icon for additional details.

Editing Port Properties

• By default, selecting a node in the Devices section displays all ports associated with that ASN device.

• To modify port settings, click Action → Edit.

The following image illustrate the ports page with device, ports, and port status details:

Editing Port Properties

To edit the properties of a port,

1. Click the Edit button against the required port in the ports table. The Port Properties window displays.

2. 

   Update the above properties as required.

3. The following properties can be updated -

   • Description: Sets a custom link description

   • Admin Status: Configures the port’s administrative state (Up/Down).

   • GRE Strip: Enables or disables GRE stripping on incoming packets (applicable only to C-plane ports).

4. Click Save to apply the changes.

Update Port Mode

To update the mode of a ASN port in FlowVision, follow the steps below,

• Select the appropriate mode from the drop-down menu with the following options:

  • C-plane

  • U-plane

• After selecting the appropriate mode from the drop-down menu, Click the "Update Port Mode" button

• To proceed, click the "Continue" on the popup

The following Metadata Attributes can be modified using this menu:

• 4G-LTE/5G-NSA

• 5G-SA

• U-Plane

Configurable Metadata Extraction in ASN

From this page, you can enable or disable the following metadata extraction options on the Aviz Service Node (ASN) for 5G-NSA:

User Information

1. IMSI (International Mobile Subscriber Identity): A unique identifier for a mobile subscriber.

2. IMEI (International Mobile Equipment Identity): A unique identifier for a mobile device.

3. MSISDN (Mobile Station International Subscriber Directory Number): The phone number associated with the subscriber.

4. APN/DNN (Access Point Name / Data Network Name): Defines the network path for data connections.

5. USER TYPE: Classification of the user, typically indicating subscriber type or service level.

6. UE IP ADDR(User Equipment IP Address):The IP address assigned to the user's device.

User Location Information

1. CGI (Cell Global Identifier): A unique identifier for a cell in a mobile network.

2. SAI (Service Area Identifier): Identifies the service area within a network.

3. RAI (Routing Area Identifier): Specifies the routing area within a mobile network.

4. TAI (Tracking Area Identifier): Identifies the tracking area in LTE networks.

5. ECGI (EUTRAN CGI): A unique identifier for cells in LTE networks.

6. LAI (Local Area Identifier): Identifies the local area within a GSM network.

7. Macro eNodeB Field: Information related to the macro eNodeB, a type of base station in LTE networks.

8. Extended Macro eNodeB Field: Additional information for extended macro eNodeB configurations.

9. Cell Changed: Indicates whether the user's device has changed cells within the network.

Tunnel Information

1. IPv4 Address Uplink (SGW): The IPv4 address for the uplink from the Serving Gateway (SGW).

2. IPv4 Address Downlink (eNodeB): The IPv4 address for the downlink to the eNodeB (Evolved Node B).

3. IPv6 Address Uplink (SGW): The IPv6 address for the uplink from the Serving Gateway (SGW).

4. IPv6 Address Downlink (eNodeB): The IPv6 address for the downlink to the eNodeB (Evolved Node B).

5. TEID Uplink (SGW): The Tunnel Endpoint Identifier for the uplink from the Serving Gateway (SGW).

6. TEID Downlink (eNodeB): The Tunnel Endpoint Identifier for the downlink to the eNodeB (Evolved Node B).

7. CONTROL TEID: The Tunnel Endpoint Identifier used for control plane signaling.

8. CONTROL IP: The IP address used for control plane signaling.

9. Radio Access Type (RAT): The type of radio access technology being used (e.g., LTE, 5G).

Key Performance Indicator(KPIs)

1. Cplane Latency: The latency in the control plane, measuring the delay in signaling and control messages.

2. Per IMSI Metrics:

   • Uplane Bandwidth/Throughput: The bandwidth or throughput in the user plane, specific to each IMSI .

   • Uplane Latency: The latency in the user plane, measuring the delay in data transmission for each IMSI.

Configurable Metadata Extraction in ASN

From this page, you can enable or disable the following metadata extraction options on the Aviz Service Node (ASN) for 5G-SA:

User Information

1. IMSI (International Mobile Subscriber Identity): A unique identifier for a mobile subscriber.

2. IMEI (International Mobile Equipment Identity): A unique identifier for a mobile device.

3. MSISDN (Mobile Station International Subscriber Directory Number): The phone number associated with the subscriber.

4. APN/DNN (Access Point Name / Data Network Name): Defines the network path for data connections.

5. USER TYPE: Classification of the user, typically indicating subscriber type or service level.

6. 5G-SA TYPE: Type of 5G network architecture, such as standalone (SA) or non-standalone (NSA).

7. UE IP ADDR(User Equipment IP Address):The IP address assigned to the user's device.

User Location Information

1. CGI (Cell Global Identifier): Unique identifier for a cell in a mobile network.

2. TAI (Tracking Area Identifier): Identifier for tracking areas in a 5G network.

3. Cell Changed: Indicates whether the user's device has changed cells within the network.

Tunnel Information

1. IPV4 Address Uplink (UPF): IPv4 address for the uplink from the User Plane Function (UPF).

2. IPv4 Address Downlink (RAN): IPv4 address for the downlink to the Radio Access Network (RAN).

3. IPv6 Address Uplink (UPF): IPv6 address for the uplink from the User Plane Function (UPF).

4. IPv6 Address Downlink (RAN): IPv6 address for the downlink to the Radio Access Network (RAN).

5. TEID Uplink (UPF): Tunnel Endpoint Identifier for the uplink from the User Plane Function (UPF).

6. TEID Downlink (RAN): Tunnel Endpoint Identifier for the downlink to the Radio Access Network (RAN).

7. RAT (Radio Access Type): The type of radio access technology used, such as 5G NR.

Key Performance Indicator(KPIs)

1. Cplane Latency: The latency in the control plane, measuring the delay in signaling and control messages.

2. Per IMSI Metrics:

   • Uplane Bandwidth/Throughput: Bandwidth or throughput in the user plane for each IMSI.

   • Uplane Latency: Latency in the user plane, measuring data transmission delay for each IMSI.

The list below specifies the unique unified data type of metadata attributes exported from ASN, 5GC-control-session-data-mapping, EPC-control-session-data-mapping, and the user-session-data-mapping file.

• 5GC-control-session-data-mapping

• EPC-control-session-data-mapping

• User-session-data-mapping

To view and configure ASN global parameters from the FlowVision GUI, navigate to:

Configuration > Global.

The Global page displays various configurable parameters for each ASN Service Node.

The following image illustrates the ASN Global page:

Configure Global Parameters

Select a Node to configure the below parameters:

• Kafka Export Interval (seconds): Sets the interval for exporting data to Kafka, configurable between 5 to 300 seconds.

• 5G Control Plane Processing (N4/N11): Choose between N4 or N11 for processing 5G control plane traffic.

• HTTP2 Port: Define multiple HTTP2 ports, separated by commas (,).

• GRE Offset Strip Length: Specifies the length of the GRE header to strip from ingress packets.

• Application Identification: Enable or disable application identification.

• Metadata Export: Enable or disable data export to Kafka.

To configure and manage system attributes of ASN via the FlowVision GUI, navigate to:

Configuration > Systems.

The Systems Manager page shows the Kafka, SNMP, NTP, and Syslog configurations, this page allows users to add or remove IP addresses associated with these configurations.

The following image shows the System Parameters page:

Kafka Configurations

Configure and manage up to one Kafka server IP address for exporting metadata extracted by the Service Node.

SNMP Trap Configuration

Configure and manage up to three SNMP trap server IP addresses for receiving SNMP traps generated by the Service Node.

NTP Configuration

Configure and manage up to three NTP server IP addresses for time synchronization.

Syslog Configuration

Configure and manage up to three Syslog server IP addresses for receiving system logs from the Service Node.

SNMP Trap Threshold

Set thresholds for SNMP traps based on the following parameters:

• Disk Usage (%): Define a trigger when disk utilization exceeds a specified percentage.

• CPU Usage (%): Set a threshold for CPU utilization percentage.

• Temperature (℃): Configure the ASN appliance temperature limit before an SNMP trap is triggered.

• Memory Usage (%): Specify the threshold for memory consumption.

• FAN RPM (%): Set a limit for fan speed in Revolutions Per Minute (RPM).

To configure Kafka Security settings in the FlowVision GUI, navigate to:

Configuration > Kafka Security

This page allows you to modify Kafka security protocols and their configurations.

SASL Support:

Configure SASL authentication by providing:

• Username

• Password

• Click Save to apply the changes.

TLS Support:

To enable TLS security, upload the required files:

• CA File

• Certificate File

• Key File

• Password

After uploading the files, click on Save to apply the changes

No Security Mode:

If you don't want to configure SASL or TLS security, select "None" here to disable Kafka security.

Cancel Button, If a user modifies the configuration (e.g., switching between SASL and TLS) but clicks Cancel instead of Submit, the system will automatically revert to the previous configuration.

The Statistics menu helps you perform the following:

• Viewing Port Statistics

• Viewing Global Statistics

• Viewing Kafka Export Statistics

To view the port statistics of the connected devices from the FlowVision GUI, click Statistics >ASN> Ports.

The Ports statistics page shows you the connected Nodes, the available ports on each Node, and the counters. By default, when you select a device the statistics for all the ports in the device are displayed. If you want to get the statistics of a particular port, select the port from the list of ports.

The following image shows the ASN port statistics page:

CPLANE

• Port: The name of the port.

• Rx Packets: The number of received packets.

• GRE Decap: The number of GRE packets decapsulated.

• N11 Packets Processed: The number of N11 packets received.

• N4 packets Processed: The number of N4 packets received.

• S11 Packets processed: The number of S1-U packets received.

• Rx Drop: The percentage of packets dropped.

• Decap Drops: The number of packets dropped due to decapsulation error.

• Metadata Extracted: The number of packets from which metadata has been extracted.

UPLANE

• Port: The name of the port.

• Rx Packets: The number of received packets.

• VxLAN: The number of VxLAN packets received.

• Rx Drops: The percentage of received packets dropped.

• Decap Drops: The number of packets dropped due to decapsulation error.

• U-Plane: The number of U-Plane packets received.

• GTP-U: The number of GTP packets received.

• Metadata Extracted: The number of packets from which metadata has been extracted.

To view the Global statistics of a Node from the FlowVision GUI, click Statistics > ASN>Global.

The following image shows the global statistics page:

The page shows the following metrics:

• Total User Sessions: Indicates the total number of active user sessions on the Service Node.

• Total Subscriber: Reflects the total subscribers registered on the service node.

To view the Kafka Export statistics of a Node from the FlowVision GUI, click Statistics > ASN>Kafka Export

The following image shows the Kafka Export Statistics page:

The page shows the following metrics:

• C-Plane Data: Indicates the total number of C-Plane data export Counts from ASN Node.

• Priority C-Plane Data: Indicates the total number of Priority C-Plane data export Count from ASN Node.

• U-Plane Data: Indicates the total number of U-Plane data export Count from ASN Node.

• Priority U-Plane Data: Indicates the total number of Priority U-Plane data export Count from ASN Node

The Help page takes you to the REST API documentation. To get to the REST API from the FlowVision GUI, click Help > REST API.

This action takes you to the Swagger UI page with the FlowVision REST API.

xxx@metasrv01:~/Code/Beta/Package/metadata-appliance$ asncli

asncli#
  collect-tech-support  Collect the tech support info and Create tar file
  exit                  Exit from the Current Prompt
  quit                  Quit to Enter Native Linux Shell
  show                  Show Commands


asncli# show
  kafka-config          ASN Kafka Config
  module                ASN Modules
  version               ASN Version

asncli# show kafka-config
==================================================================
ASN Kafka Config
==================================================================
Kafka Export Status : on
Kafka Server List   : 10.4.5.227:9092
Kafka Interval Time : 30
asncli#

asncli# show module status
Calculating ASN Module Status
==================================================================
Module               Status          CPU %           MEM %
==================================================================
asn-rest-server      active          0.5             40.5MB
asn-mgmt             active          0.1             15.4MB
asn-core             active          17.2%           14.7GB
asn-snmp-trap        active          0.0             18.1MB
asncli#

asncli# show version
ASN-V1-20240715
asncli#

You can use the below command to collect-tech-support data

asncli# collect-tech-support
ASN Techsupport Collection Started
Tech Support Collection Success - /etc/log_asn/asn_techsupport_20240725_025100.tgz
asncli#