Professional Documents
Culture Documents
ii
ClearSee Overview
Contents
Version History .............................................................................................................................i
Contents ..................................................................................................................................... iii
1 ClearSee Overview ........................................................................................................ 1-1
1.1 ClearSee Capabilities ........................................................................................ 1-1
1.2 System-Level Data Flow ................................................................................... 1-1
1.3 ClearSee Scalability Options ............................................................................. 1-2
1.4 ClearSee Provisioning Options ......................................................................... 1-2
1.5 Report and NetworkSecure Deployment Modes ............................................. 1-3
1.6 Licensing ........................................................................................................... 1-4
2 Appliance Hardware Specifications .............................................................................. 2-1
2.1 Standard Standalone Specifications ................................................................. 2-1
2.2 Enhanced Standalone Specifications................................................................ 2-2
2.3 Cluster Deployment Specifications .................................................................. 2-3
3 Software-Only Installation Requirements .................................................................... 3-1
3.1 Standard Standalone Requirements ................................................................ 3-1
3.2 Enhanced Standalone Requirements ............................................................... 3-2
3.3 DW Node Requirements................................................................................... 3-4
3.4 BI Server Requirements .................................................................................... 3-6
4 Virtual Template Requirements and Specifications ..................................................... 4-1
4.1 Virtual Machine Requirements ........................................................................ 4-1
4.2 Virtual Enhanced Standalone Requirements ................................................... 4-1
4.3 Virtual DW Requirements ................................................................................ 4-2
4.4 Virtual BI Requirements ................................................................................... 4-2
5 Network Deployment and Connectivity ....................................................................... 5-1
5.1 High Availability ................................................................................................ 5-1
5.2 Ethernet Ports in an Appliance Installation...................................................... 5-2
3550 1U Server.................................................................................... 5-2
3650 2U Server.................................................................................... 5-2
iii
ClearSee Overview
5.3 Standalone Deployments ................................................................................. 5-3
5.4 Cluster Deployments ........................................................................................ 5-4
DW Node Networking ......................................................................... 5-6
Primary and Secondary BI Servers ...................................................... 5-7
BI Server Networking .......................................................................... 5-7
6 ClearSee Installation ..................................................................................................... 6-1
6.1 Standalone Install Workflow ............................................................................ 6-1
6.2 Cluster Install Workflow ................................................................................... 6-5
6.3 Installing the ACP.............................................................................................. 6-9
6.4 Answering the Standalone Wizard ................................................................. 6-12
6.5 Answering the Cluster Wizard ........................................................................ 6-15
6.6 Advanced Wizards .......................................................................................... 6-21
6.7 Creating Installation Files for Use at a Later Time ......................................... 6-22
6.8 Virtual ClearSee Installation ........................................................................... 6-24
Virtual Install Workflow (Standalone) .............................................. 6-24
Virtual Install Workflow (Cluster) ..................................................... 6-28
Deploying the OVF Template ............................................................ 6-35
Deploying the KVM Template ........................................................... 6-43
7 ClearSee Configuration ................................................................................................. 7-1
7.1 Logging in to ClearSee as Web_Admin ............................................................. 7-1
7.2 Accessing NetXplorer ....................................................................................... 7-1
7.3 NetXplorer User Interface ................................................................................ 7-2
7.4 Integrating ClearSee with NetXplorer .............................................................. 7-3
Applying the ClearSee License ............................................................ 7-4
Building a Standalone ClearSee System .............................................. 7-7
Building a Cluster ClearSee System................................................... 7-10
Modifying a ClearSee System............................................................ 7-13
Defining a BI Instance in the Navigation Pane .................................. 7-16
Defining a BI-HA Group in the Navigation Pane ............................... 7-17
Defining a DW Instance in the Navigation Pane ............................... 7-18
iv
ClearSee Overview
Defining the Standalone ETL Group .................................................. 7-19
Defining the Cluster ETL Group ......................................................... 7-23
Editing a Server Node ....................................................................... 7-27
ClearSee Configuration with NetXplorer .......................................... 7-28
Defining DMs with Virtual IPs ........................................................... 7-36
7.5 Performing ClearSee CLI Configuration .......................................................... 7-37
Setting the Time Zone ....................................................................... 7-38
Enabling ClearSee Fields from the AOS CLI ....................................... 7-40
Changing Configuration Parameters ................................................. 7-40
Changing the Real-Time Refresh Rate .............................................. 7-41
Enabling the Exporting of Insights to Syslog ..................................... 7-43
8 ClearSee Maintenance .................................................................................................. 8-1
8.1 Cluster Maintenance ........................................................................................ 8-1
Making Changes to the Internal IP Addresses—Pacemaker and DRBD8-1
Split-Brain Inconsistency Condition .................................................... 8-7
Monitoring DW Load Status.............................................................. 8-11
Restoring the Primary BI Server ........................................................ 8-12
8.2 Standalone Backup and Restore .................................................................... 8-13
Preparing an External Device ............................................................ 8-13
Preparing a Remote Server ............................................................... 8-14
Backing Up Vertica to an External Device ......................................... 8-15
Backing Up Vertica to a Remote Server ............................................ 8-17
Restoring Vertica from an External Device ....................................... 8-19
Restoring Vertica from a Remote Server .......................................... 8-20
8.3 ClearSee Alerts ............................................................................................... 8-21
ClearSee Logs .................................................................................... 8-21
ClearSee SNMP Traps ........................................................................ 8-23
8.4 Intelligent Cubes Maintenance ...................................................................... 8-24
8.5 Changing ClearSee Server Hostnames ........................................................... 8-25
8.6 Performing ETL Administration ...................................................................... 8-27
v
ClearSee Overview
Start, Stop and Restart ...................................................................... 8-30
ETL Status .......................................................................................... 8-30
Queues .............................................................................................. 8-31
Deploy ............................................................................................... 8-32
Displaying Alerts................................................................................ 8-32
8.7 Performing Patch Management ..................................................................... 8-35
Status ................................................................................................ 8-35
Import ............................................................................................... 8-36
Install ................................................................................................. 8-36
Import and Install .............................................................................. 8-37
9 Security and Access Management ................................................................................ 9-1
9.1 Accessing ClearSee ........................................................................................... 9-1
9.2 Security ............................................................................................................. 9-1
Database Security ............................................................................... 9-1
Accessing ClearSee by HTTPS .............................................................. 9-2
Disabling HTTP in a Standalone Deployment ..................................... 9-2
Disabling HTTP in a Cluster Deployment ............................................ 9-3
Changing Web Ports in a Standalone Deployment ............................. 9-3
Changing Web Ports in a Cluster Deployment.................................... 9-4
Changing Passwords ........................................................................... 9-5
Securing Data in Motion between ClearSee and NetworkSecure ...... 9-9
9.3 Access Management ...................................................................................... 9-13
Access Privileges ............................................................................... 9-13
Access Management Process ............................................................ 9-14
Accessing the User Manager............................................................. 9-15
User Management ............................................................................ 9-17
Group Management.......................................................................... 9-24
10 ClearSee Startup and Shutdown ............................................................................... 10-27
10.1 Starting Up Your Standalone System ........................................................... 10-27
10.2 Powering Off Your Standalone System ........................................................ 10-27
vi
ClearSee Overview
10.3 Starting Up Your Cluster System .................................................................. 10-27
10.4 Powering Off Your Cluster System ............................................................... 10-28
10.5 Shutting Down a BI Server ............................................................................ 10-28
10.6 Shutting Down a DW Server ......................................................................... 10-29
10.7 Stopping the DW Database .......................................................................... 10-29
10.8 Starting the DW Database ............................................................................ 10-31
11 Appendices .................................................................................................................. 11-1
11.1 Appendix 1: External Data Source File Structures.......................................... 11-1
vii
1 ClearSee Overview
This guide describes how to install ClearSee and perform administration tasks on
ClearSee’s modules.
1-2
ClearSee Overview
Allot supports two types of software-only provisioning:
⧫ Physical environment
⧫ Virtual environment
Allot provides the following two USB flash drives for installation:
• Kickstart: A CentOS Kickstart for a clean install of the CentOS operating system
and the configuration of the operating system
• System: System installation software
1-3
ClearSee Overview
1.6 Licensing
You must have the following licenses:
• ClearSee Data Warehouse license: Purchased according to the sizing guidelines.
• One of the following:
⧫ ClearSee Network Metrics: This is the light edition, with partial functionality.
Not all reports and dashboards are enabled. This license is free and included
in the NetXplorer by default.
⧫ ClearSee Network Analytics: This is the professional edition, with full
functionality. All reports and dashboards are enabled, including Self Service.
• Real-Time Monitoring: Requiring AOS 14.5, this is purchased per in-line platform
and per 1G network bandwidth.
NOTE After you add a ClearSee system to NetXplorer, as described in
INTEGRATING CLEAR SEE WITH NETXPLORER, the following changes
occur:
• The STC (Short Term Collector) stops collecting data.
• STC/LTC historical data ceases to be available in NetXplorer.
• The Data Mediator starts collecting data for ClearSee (replacing
STC functionality).
1-4
2 Appliance Hardware Specifications
The following sections contain the specifications of the hardware as shipped from Allot in
an Appliance provisioning:
• STANDARD STANDALONE SPECIFICATIONS
• ENHANCED STANDALONE SPECIFICATIONS
• CLUSTER INSTALLATION SPECIFICATIONS
Hardware IBM x3650 M4 2U server 2 x Intel Xeon with 8 cores running at 2.0Ghz
128 GB RAM
7.3 TB of server storage via
• 2 x 146 GB
• 12 x 600 GB disks
Dual AC/DC 750W power supply
2 x 1 GbE copper connectivity (extra link for redundancy)
Supported Operating System CentOS Linux 6.6 64-bit x 86 (English only)
CentOS Linux 7.3 64-bit x 86 (English only)
Specifications as a Standalone M5 server are as follows:
Specifications for ClearSee Enhanced Standalone (M5)
Part Number PA-CS-ENH-SRV-GEN5
2-2
Appliance Hardware Specifications
Specifications for ClearSee Enhanced Extended Standalone (M5)
Part Number PA-CS-ENH-SRV-GEN5-EX
2-3
Appliance Hardware Specifications
Supported Operating System CentOS Linux 6.6 64-bit x 86 (English only)
CentOS Linux 7.3 64-bit x 86 (English only)
Specifications as M5 servers are as follows:
Specifications for ClearSee Cluster (M5)
DW Hardware Part Number: PA-CS-CLUSTER-GEN5, which is comprised of 3 x PA-CS-
NOD-SRV-GEN5 servers, with each server as follows:
• Lenovo x3650 M5 2U server
• Intel Xeon Processor E5-2640 8C 2.6GHz 20MB Cache 1866MHz
90W
• Additional Intel Xeon Processor E5-2640 8C 2.6GHz 20MB
1866MHz 90W
• 128 GB, DDR41866MHz
• 7.8 TB of server storage via:
⧫ 2 x 300 GB
⧫ 12 x 600 GB disks
• System x 900W High Efficiency Platinum AC Power Supply
DW Extended Hardware Part Number: PA-CS-CLUSTER-GEN5-EX, which is comprised of 3 x PA-
CS-NOD-SRV-GEN5-EX servers, with each server as follows:
• IBM x3650 M5 2U server
• 2 x Intel Xeon with 12 cores running at 2.6Ghz
• 256 GB RAM
• 29.4 TB of server storage via:
⧫ 2 x 300 GB
⧫ 24 x 1,200 GB disks
• Dual AC/DC 900W power supply
• 2 x 1 GE copper connectivity and 2 x 10 GbE SFP+ Multi-Mode SR
connectivity (extra link for redundancy)
BI Server Hardware Part Number: PA-CS-BI-SRV-HAP-GEN5
Lenovo x3550 M5 1U server
Intel Xeon Processor E5-2620 6C 2.4GHz 15MB Cache 1866MHz 85W
Additional Intel Xeon Processor E5-2620 6C 2.4GHz 15MB 1866MHz
85W
64 GB, DDR41866MHz
1.2 TB of server storage 8 x 300 GB disks
System x 750W High Efficiency Platinum AC Power Supply
6 x 1 GbE copper connectivity (extra links for redundancy and H/A)
Supported Operating System CentOS Linux 6.6 64-bit x 86 (English only)
CentOS Linux 7.3 64-bit x 86 (English only)
2-4
3 Software-Only Installation Requirements
In Software-Only installations, your hardware must comply with requirements regarding
operating system, networking and hard drive settings. This chapter describes these
requirements.
The following sections contain the requirements in a Software-Only installation and a
physical environment, for the three scalability options:
• STANDARD STANDALONE REQUIREMENTS
• ENHANCED STANDALONE REQUIREMENTS
• Cluster:
⧫ DW NODE REQUIREMENTS
⧫ BI SERVER REQUIREMENTS
3-2
Software-Only Installation Requirements
Configuration Settings: Swap fs configured with a minimum of 8 GB
File System • OS: 2 EXT4 file systems, / and /opt
• Data: 2 EXT4 file systems, /clearsee_input and /data
OS CentOS Linux 6.6 64-bit x 86 (English only)
CentOS Linux 7.3 64-bit x 86 (English only)
Recommended: Brought up in graphic mode (/etc/inittab set to init 5)
If other, contact Allot Support.
IOPS • OS:
⧫ Minimum: 150 MB/sec
⧫ Recommended:200 MB / Sec
• Data:
⧫ Minimum: 320 MB / Sec
⧫ Recommended: 640 MB / Sec
Power Recommended: Disable any Advanced Power Management Options, and allow
maximum power usage by the processors for optimal performance.
3-3
Software-Only Installation Requirements
⧫ If the data file systems as a whole are smaller than 16 TB, then with 2 EXT4
file systems, /clearsee_input and /data
⧫ If the data file systems as a whole are larger than 16 TB, then with 3 EXT4
file systems,* /clearsee_input, /data and /data2
OS CentOS Linux 6.6 64-bit x 86:
• Recommended: Brought up in graphic mode (/etc/inittab set to init 5)
• English only
If other, contact Allot Support.
IOPS • OS:
⧫ Minimum: 150 MB/sec
⧫ Recommended:200 MB / Sec
• Data:
⧫ Minimum: 480 MB /Sec
⧫ Recommended: 960 MB / Sec
Power Recommended: Disable any Advanced Power Management Options, and allow
maximum power usage by the processors for optimal performance.
3-4
Software-Only Installation Requirements
Network • Bond0: 2 X 1GbE interfaces for HA (Public IP)
• Bond1: 2 X 10GbE SFB+ Multi-Mode SR interfaces for HA (Private IP)
HA, in which 2 ports are used, is recommended but not required. Otherwise each
bond contains 1 port.
Configuration Settings Swap fs configured with a minimum of 8 GB
3-5
Software-Only Installation Requirements
File System • OS: 2 EXT4 file systems, / and /opt
• Data:
⧫ If the data file systems as a whole are smaller than 16 TB, then with 2 EXT4
file systems, /clearsee_input and /data
⧫ If the data file systems as a whole are larger than 16 TB, then with 3 EXT4
file systems,* /clearsee_input, /data and /data2
OS CentOS Linux 6.6 64-bit x 86 (English only)
CentOS Linux 7.3 64-bit x 86 (English only)
Recommended: Brought up in graphic mode (/etc/inittab set to init 5)
If other, contact Allot Support.
IOPS • OS:
⧫ Minimum: 150 MB/sec
⧫ Recommended:200 MB / Sec
• Data:
⧫ Minimum: 480 MB /Sec
⧫ Recommended: 960 MB / Sec
Power Recommended: Disable any Advanced Power Management Options, and allow
maximum power usage by the processors for optimal performance.
3-6
Software-Only Installation Requirements
• Bond2: 2 X 1GbE interfaces for the Internal HA IP if running through a switch. If
using cross-cable links use only 1 port!
HA, in which 2 ports are used, is recommended but not required. Otherwise each
bond contains 1 port.
Security 2 SSH keys generated for "root" user, between the two BI servers
Configuration Settings Swap fs configured with a minimum of 8 GB
3-7
4 Virtual Template Requirements and
Specifications
ClearSee can be purchased and delivered as a virtual appliance file (templates) with the
relevant products pre-installed and configured.
Allot Virtual NMS (vNMS) components are provided with two types of template:
• OVF template for deployment in VMWare/ESXi environment
• QCOW2 template for deployment in OpenStack/KVM environment
The template files for each product may be configured to support both larger and smaller
scale environments.
Operating system
4-2
5 Network Deployment and Connectivity
This chapter covers all aspects of physical connectivity and deployment, such as cabling,
interconnectivity and high availability, for the following:
• STANDALONE DEPLOYMENTS
• CLUSTER DEPLOYMENTS
Each deployment is presented in both a High Availability configuration and a non-High
Availability configuration. For more about High Availability, see HERE.
The following sections contain a table for each type of configuration, with a row for each
networking bond. These configurations are provided for the following purposes:
• As guidelines when planning a Software-Only installation.
• As a description of an Appliance installation. In the following tables, the
Connectivity column contains the actual ports employed in an Appliance
installation.
For firewall configuration, see the AOS documentation for appropriate settings.
3650 2U Server
The IBM x3650 2U server is used as the following:
• The Enhanced Standalone server
• The DW node in a Cluster deployment
5-2
Network Deployment and Connectivity
The following figure identifies the Ethernet ports on an x3650 M4:
5-3
Network Deployment and Connectivity
Non-High Availability One core switch balance-rr • Standard:
receives from both ⧫ Port 3
ClearSee and the
• Enhanced:
DM and sends to
external clients. ⧫ Port 1
Connections are
cross-cabled.
The following figure illustrates the network architecture of a Standalone deployment.
Those connections enabling High Availability are marked with a broken red line.
5-4
Network Deployment and Connectivity
5-5
Network Deployment and Connectivity
DW Node Networking
The DW nodes can be configured according to the following setups:
Availability Bond Description Mode Connectivity
High Availability Public IP: Communication with the two active- On Bond 0:
public 1GbE core switches common with backup • M4:
the BIs. Each link connects to a separate
⧫ Port 5
and interconnected switch. IP addresses
allow connectivity to the BI servers & DM. ⧫ Port 6
• M5:
⧫ Port 0 (Vertica)
⧫ Port 1 (Vertica)
Private IP: DW cluster On Bond 1:
intercommunication via two 10GbE • Port 1
Ethernet optical links. Each link connects
• Port 2
to a separate and interconnected 10GbE
switch. This network runs on a private
VLAN, with IP addresses that are not part
of the management network.
Non-High Private IP: DW cluster balance • M4:
Availability intercommunication and contains one -rr ⧫ Port 5
10GbE Ethernet optical links. This network
• M5:
runs on a private VLAN, with IP addresses
that are not part of the management ⧫ Port 0 (Vertica)
network.
Public IP: Communication with the 1GbE • Port 1
core switches for both DM (south-bound)
and BI (north-bound) communication, and
contains one 1GbE Ethernet link, and with
IP addresses that allow connectivity to the
BI servers & DM.
The possible combinations of DW servers in a Cluster deployment are as follows:
• PA-CS-CLUSTER-GEN4 server, which is comprised of 3 x PA-CS-NOD-SRV-GEN4
nodes, with additional PA-CS-NOD-SRV-GEN4 nodes as per sizing
• PA-CS-CLUSTER-GEN5 server, which is comprised of 3 x PA-CS-NOD-SRV-GEN5
nodes, with additional PA-CS-NOD-SRV-GEN5 nodes as per sizing
• PA-CS-CLUSTER-GEN5-EX server, which is comprised of 3 x PA-CS-NOD-SRV-
GEN5-EX nodes, with additional PA-CS-NOD-SRV-GEN5-EX nodes as per sizing
NOTE If the number of database nodes exceed the capacity of one 10GbE
switch (for example if the number of nodes exceed the capacity of 1
rack space), then the networking bandwidth requirement between
each of the switching entities should be as follows:
Bandwidth = Number of database nodes X 3.5Gbps + 10Gbps
5-6
Network Deployment and Connectivity
Primary and Secondary BI Servers
When connecting the BI Servers received from Allot as an Appliance, make sure that the
server indicated as the PRIMARY is configured as the Primary server. The label may be
seen on the top of the server chassis (see below) listing the serial numbers of the BI
servers.
BI Server Networking
There are four different setups according to which to configure the BI server networking
in a Cluster deployment, two for High Availability and two not. The first, Full High
Availability, is the most recommended. The configuration setups are as follows:
• High Availability: The most recommended, there are two sets of two
interconnected switches. One set is public and the other private, and within each
set one switch is active and one backup. The public set is common with the DW.
Each BI server extends six links, with bonds as follows:
Availability Bond Description Mode Connectivity
Full High Availability Public IP: External traffic connected to active- On Bond 0:
the active and backup core switches backup • Port 1
• Port 2
5-7
Network Deployment and Connectivity
Data Sync IP: Internal DRBD On Bond 1:
communication connected to the active • Port 5
and backup core switches
• Port 6
Internal HA: Communication On Bond 2:
connected to the active and backup • Port 3
core switches
• Port 4
5-8
6 ClearSee Installation
This chapter contains all ClearSee installation workflows and procedures, both
STANDALONE and CLUSTER.
Each workflow is comprised of a number of links to installation procedures, as follows:
• Use the workflow as a guide in navigating the procedures.
• Verify throughout that you perform the procedures in the order indicated by the
workflows.
There are two flash drives:
• The ACP flash drive is provided, for the installation and configuration of the Allot
Common Platform.
• For all types of installations, the System flash drive includes the installation of the
application software.
The STANDALONE and CLUSTER workflows describe installation at the same time as running
the wizard. Alternatively, you can run the wizard and create installation files for use at a
later time, as described HERE.
After performing a workflow, the last step is to finalize the installation, which is described
in CLEARSEE CONFIGURATION .
6-2
ClearSee Installation
d. Quit netmenu.
4. Move the ClearSee TGZ file to /opt/admin, and then extract the file with the
following command:
tar -xvzf <TGZ>
Where <TGZ> is the name of the file, including the extension
5. You may have previously created configuration files for use at a later time, as
described HERE. If you plan now to install ClearSee from these configuration files,
then copy the ansible_conf folder that contains the files into
/opt/admin/<TGZ>/install/, where <TGZ> is the name of the file including the
extension, and then continue with the install workflow. Otherwise, continue with
the install workflow.
6. Run the allotlogin script, as follows:
/opt/admin/bin/allotlogin.sh enable
7. Change to the folder containing the installation files:
cd /opt/admin/<TGZ>/install
Where <TGZ> is the name of the file, including the extension
NOTE If you fear you may get disconnected from the network in the course
of the installation, then you should perform the following step from
the console.
8. Run ./Allot_ClearSee.sh with any combination of flags, as described in the
following table:
If you want to do this: Do the following:
Launch the standard wizard 1. Run the script with no flags added:
./Allot_ClearSee.sh
2. Continue with the STANDALONE WIZARD .
6-3
ClearSee Installation
Launch the standard wizard so that ClearSee installs with 1. Run the script with the -e flag:
encryption ./Allot_ClearSee.sh -e
2. Continue with the STANDALONE WIZARD .
Launch the advanced wizard 1. Run the script with the -a flag:
./Allot_ClearSee.sh -a
2. Continue with the STANDALONE WIZARD , with
additional questions described HERE.
Launch the advanced wizard so that ClearSee installs with 1. Run the script with the -e and -a flags:
encryption ./Allot_ClearSee.sh -e -a
2. Continue with the STANDALONE WIZARD , with
additional questions described HERE.
Install ClearSee from a PREVIOUSLY-CREATED CONFIGURATION Run the script with with the -d flag:
FILE ./Allot_ClearSee.sh -d
Install ClearSee from a PREVIOUSLY-CREATED CONFIGURATION Run the script with the -e flag:
FILE with encryption ./Allot_ClearSee.sh -e
NOTES:
• On an Allot appliance, Allot does not recommend running the advanced
wizard.
• For servers with only one interface (no bond), you should run the
advanced wizard.
• For help, run the script with the -h flag: ./Allot_ClearSee.sh -h
Installation commences.
9. You can use the following for troubleshooting:
⧫ For details on the progress of the installation, read
/var/log/allot/ansible.log, as described in INSTALLATION AND UPGRADE LOGS.
⧫ For the installation files that ClearSee based the installation on, go to
/opt/admin/<TGZ>/ansible_conf, where <TGZ> is the name of the file,
including the extension.
10. Clean the browser cache before connecting again to the system.
11. To finalize the installation, continue with CLEARSEE CONFIGURATION .
NOTE After the installation procedure, we recommend that you do the
following:
• If you did not do so during installation, change the DW password
and system root password to be secure and unique, as described
HERE .
6-4
ClearSee Installation
6-5
ClearSee Installation
4) eno4 : 40:f2:e9:09:93:4c V
5) enp134s0f0 : 00:25:90:05:10:0c V
6) enp134s0f1 : 00:25:90:05:10:0c V
~~~ ~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7) Gateway :
8) Hostname : localhost.localdomain
9) DNS :
10) MNGT I/F :
11) NTP :
~~~ ~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12) Clear All Network Configuration
13) Quit
6-6
ClearSee Installation
b. From the CLI, log in as admin, and then change user to root, as follows:
▪ User: root
▪ Password: bagabu
4. On the primary BI server, insert the System flash drive, and then define the
network configuration with the netmenu script, as follows:
a. Run /root/netmenu.sh.
b. Define the Hostname.
NOTE The hostname as you define it here is temporary and overwritten
when the ClearSee wizard is run.
c. Define the IP and subnet mask of the interface that you plan to be the MNGT
I/F, which is normally eno1.
d. Define the interface of the MNGT I/F.
e. Optionally, provide the IP address of the Gateway, which must belong to the
management IP subnet.
A completed netmenu for a Standalone server looks similar to the following:
f. Quit netmenu.
5. Move the ClearSee TGZ file to opt/admin, and then extract the file with the
following command:
tar -xvzf <TGZ>
Where <TGZ> is the name of the file, including the extension
6. You may have previously created configuration files for use at a later time, as
described HERE. If you plan now to install ClearSee from these configuration files,
then copy the ansible_conf folder that contains the files into
/opt/admin/<TGZ>/install/, where <TGZ> is the name of the file including the
extension, and then continue with the install workflow. Otherwise, continue with
the install workflow.
7. Run the allotlogin script, as follows:
/opt/admin/bin/allotlogin.sh enable
8. Change to the folder containing the installation files:
cd /opt/admin/<TGZ>/install
Where <TGZ> is the name of the file, including the extension
NOTE If you fear you may get disconnected from the network in the course
of the installation, then you should perform the following step from
the console.
9. Run ./Allot_ClearSee.sh with any combination of flags, as described in the
following table:
6-7
ClearSee Installation
If you want to do this: Do the following:
Launch the standard wizard 3. Run the script with no flags added:
./Allot_ClearSee.sh
4. Continue with the CLUSTER WIZARD .
Launch the standard wizard so that ClearSee installs with 5. Run the script with the -e flag:
encryption ./Allot_ClearSee.sh -e
6. Continue with the CLUSTER WIZARD .
Launch the advanced wizard 7. Run the script with the -a flag:
./Allot_ClearSee.sh -a
8. Continue with the CLUSTER WIZARD , with
additional questions described HERE.
Launch the advanced wizard so that ClearSee installs with 9. Run the script with the -e and -a flags:
encryption ./Allot_ClearSee.sh -e -a
10. Continue with the CLUSTER WIZARD , with
additional questions described HERE.
Install ClearSee from a PREVIOUSLY-CREATED CONFIGURATION Run the script with with the -d flag:
FILE ./Allot_ClearSee.sh -d
Install ClearSee from a PREVIOUSLY-CREATED CONFIGURATION Run the script with the -e flag:
FILE with encryption ./Allot_ClearSee.sh -e
NOTES:
• On an Allot appliance, Allot does not recommend running the advanced
wizard.
• For servers with only one interface (no bond), you should run the
advanced wizard.
• For help, run the script with the -h flag: ./Allot_ClearSee.sh -h
Installation commences.
10. You can use the following for troubleshooting:
⧫ For details on the progress of the installation, read
/var/log/allot/ansible.log, as described in INSTALLATION AND UPGRADE LOGS.
⧫ For the installation files that ClearSee based the installation on, go to
/opt/admin/<TGZ>/ansible_conf, where <TGZ> is the name of the file,
including the extension.
11. Clean the browser cache before connecting again to the system.
12. To finalize the installation, continue with CLEARSEE CONFIGURATION .
NOTE After the installation procedure, we recommend that you do the
following:
6-8
ClearSee Installation
• If you did not do so during installation, change the DW password
and system root password to be secure and unique, as described
HERE .
6-9
ClearSee Installation
6-10
ClearSee Installation
6-11
ClearSee Installation
Options:
1. Enter 1, and then continue with and answer the following questions:
--- System Configuration ---
6-12
ClearSee Installation
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
ClearSee needs the password for the root user on the ClearSee server.
---------------------------------------------------------------------------
NOTE ClearSee supplies many of the default answers from the netmenu
script.
The following appears, completed:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Please confirm the System Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Options:
1) NTP Server :
2) DNS Server :
3) Gateway :
6-13
ClearSee Installation
4) Mail Server :
5) Hostname : single
6) Vertica Data Disk : sdb
7) Create Bonds : yes
To change an answer, enter the number of the row. To continue, enter OK:
2. Enter the number of the row that you want to change, or enter ok and then
continue with and answer the following questions:
--- Network Configuration for single, bond0 ---
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
Options:
1) Bond0_address :
2) Bond0_netmask :
3) Bond0_Bond-interface-1 :
4) Bond0_Bond-interface-2 :
6-14
ClearSee Installation
To change an answer, enter the number of the row. To continue, enter OK:
3. Enter the number of the row that you want to change, or enter ok.
The wizard’s final question appears:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
How do you want to continue?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Options:
1: Installation
2: Save configuration file
3: Exit
Please enter the option number:
Options:
5. Enter 2, and then continue with and answer the following questions:
--- System Configuration ---
---------------------------------------------------------------------------
---------------------------------------------------------------------------
6-15
ClearSee Installation
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
ClearSee needs the password for the root user on the ClearSee server.
---------------------------------------------------------------------------
Please enter the root user password or press ENTER for the default:
Please re-enter the root user password or press ENTER for the default:
NOTE ClearSee supplies many of the default answers from the netmenu
script.
Similar to the following appears:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Please confirm the System Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Options:
1) NTP Server :
2) DNS Server :
3) Mail Server :
4) Vertica Data Disk : sdb
6-16
ClearSee Installation
5) Create Bonds : yes
6) VIP ADDRESS :
7) Gateway :
8) Number of DW servers : 3
To change an answer, enter the number of the row. To continue, enter OK:
6. Enter ok, and then continue with and answer the following questions about the
BI servers, first for the Primary BI server, and second for the Secondary BI server:
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
6-17
ClearSee Installation
ClearSee needs to know the IP address.
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
6-18
ClearSee Installation
- Your answer:
---------------------------------------------------------------------------
---------------------------------------------------------------------------
Options:
1) Hostname :
2) Bond0_address :
3) Bond0_netmask :
4) Bond0_Bond-interface-1 :
5) Bond0_Bond-interface-2 :
6) Bond1_address :
7) Bond1_netmask :
8) Bond1_Bond-interface-1 :
9) Bond1_Bond-interface-2 :
10) Bond2_address :
11) Bond2_netmask :
12) Bond2_Bond-interface-1 :
13) Bond2_Bond-interface-2 :
To change an answer, enter the number of the row. To continue, enter OK:
7. Enter the number of the row that you want to change, or enter ok and then
continue with the DW servers, once for each DW server:
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
6-19
ClearSee Installation
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
---------------------------------------------------------------------------
6-20
ClearSee Installation
ClearSee needs to know the bond's second NIC interface.
---------------------------------------------------------------------------
Options:
1) Hostname :
2) Bond0_address :
3) Bond0_netmask :
4) Bond0_Bond-interface-1 :
5) Bond0_Bond-interface-2 :
6) Bond1_address :
7) Bond1_netmask :
8) Bond1_Bond-interface-1 :
9) Bond1_Bond-interface-2 :
To change an answer, enter the number of the row. To continue, enter OK:
8. Enter the number of the row that you want to change, or enter ok.
The wizard’s final question appears:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
How do you want to continue?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Options:
1: Installation
2: Save configuration file
3: Exit
Please enter the option number:
6-21
ClearSee Installation
• In the System Configuration section, the following appear:
---------------------------------------------------------------------------
ClearSee needs the data disk type of the server on which ClearSee is to be
installed. This may be, for example, sda or sdb.
---------------------------------------------------------------------------
---------------------------------------------------------------------------
ClearSee wants to know if you want high availability (HA) on the network
level. High Availability is achieved through creating a bond out of the
NICs on your ClearSee server.
---------------------------------------------------------------------------
---------------------------------------------------------------------------
How many bonds do you want to create from the NICs for single: [2]
- Your answer:
6-22
ClearSee Installation
⧫ Password: bagabu
2. Insert the System flash drive.
3. Move the ClearSee TGZ file to opt/admin, and then extract the file with the
following command:
tar -xvzf <TGZ>
Where <TGZ> is the name of the file, including the extension
4. Change to the folder containing the installation files:
cd /opt/admin/ClearSee_16.1.10/install
5. Run ./Allot_ClearSee.sh with any combination of flags, as described in the
following table:
If you want to do this: Do the following:
Launch the standard wizard 1. Run the script with no flags added:
./Allot_ClearSee.sh
2. Continue with the STANDALONE or CLUSTER
wizard.
3. For the wizard’s final question, answer 2 and
specify the folder in which to save the
ansible_conf folder.
Launch the advanced wizard 1. Run the script with the -a flag:
./Allot_ClearSee.sh -a
2. Continue with the STANDALONE or CLUSTER
wizard, with additional questions described
HERE .
3. For the wizard’s final question, answer 2 and
specify the folder in which to save the
ansible_conf folder.
NOTES:
• On an Allot appliance, Allot does not recommend running the advanced
wizard.
• For help, run the script with the -h flag: ./Allot_ClearSee.sh -h
The files are saved in a folder called ansible_conf, within
/opt/admin/ClearSee_16.1.10/install/.
6. Save the ansible_conf folder for use at a later time.
6-23
ClearSee Installation
6-24
ClearSee Installation
6-25
ClearSee Installation
6-26
ClearSee Installation
6-27
ClearSee Installation
Virtual Install Workflow (Cluster)
This workflow describes how to perform a virtual Cluster ClearSee installation. Installation
should take around two hours.
We recommend placing the virtual DWs on separate physical servers and the virtual BIs on
separate servers. However, a virtual DW and a virtual BI may be on the same physical
server.
IMPORTANT Before proceeding to a step or sub-step, verify that the processes of
the previous step or sub-step have completed.
1. Verify that your hardware and operating systems comply with the prerequisites
described in VIRTUAL TEMPLATE REQUIREMENTS AND SPECIFICATIONS .
2. Install the DW servers by doing the following for each:
a. Deploy the DW template and power on the machine, according to one of the
following:
▪ DEPLOYING THE OVF TEMPLATE
▪ DEPLOYING THE KVM TEMPLATE
b. Double-click Product Install.
6-28
ClearSee Installation
6-29
ClearSee Installation
6-30
ClearSee Installation
▪ DEPLOYING THE KVM TEMPLATE
b. Open the Console tab of the server.
c. In the allot.com dialog box, select Not Listed, and, when prompted, enter the
following:
▪ Username: root
▪ Default Password: bagabu
d. Click Sign In, and then double-click Product Install.
The Welcome dialog box appears.
6-31
ClearSee Installation
6-32
ClearSee Installation
6-33
ClearSee Installation
g. On the Network Configuration for Bond 0 dialog box, enter the network
configuration for bond 0, and then click OK.
The Bond 1 NICs dialog box appears.
h. On the Bond 1 NICs dialog box, select the NICs for bond 1, and then click OK.
The Bond 2 NICs dialog box appears.
i. On the Bond 2 NICs dialog box, select the NICs for bond 2, and then click OK.
The Number of DW Nodes dialog box appears.
6-34
ClearSee Installation
i. Installation from this point takes up to two hours.
ii. Upon completion, the Installation Successful dialog box appears.
5. For details on the progress of the installation, read /var/log/clearsee_intall.log.
6. Clean the browser cache before connecting again to the system.
7. To finalize the installation, continue with CLEARSEE CONFIGURATION .
NOTE After the installation procedure, we recommend that you do the
following:
• If you did not do so during installation, change the DW password
and system root password to be secure and unique, as described
HERE .
6-36
ClearSee Installation
6-37
ClearSee Installation
6-38
ClearSee Installation
6-39
ClearSee Installation
6-40
ClearSee Installation
6-41
ClearSee Installation
6-43
ClearSee Installation
5. Create a new instance using the following command:
virsh define <FILENAME>.xml
The Virt-Manager appears.
7. Click Open, and then click the light bulb icon to open the Virtual Machine Details
screen.
NOTE Do NOT click on the Start button at this time.
8. For each of the four NICs, do the following:
a. From the tabs on the left, select the virtual NIC.
6-44
ClearSee Installation
6-45
7 ClearSee Configuration
To finalize your ClearSee installation, you must perform the following configuration
procedures, which are relevant for both Standalone and Cluster deployments, and
Appliance and Software-Only installations.
Configuration takes place in the following areas:
• INTEGRATING CLEARSEE WITH NETXPLORER: Integrate ClearSee with NetXplorer, for
the sake of building your ClearSee system.
• PERFORMING CLEARSEE CLI CONFIGURATION: Configure ETL parameters, as well as:
⧫ SETTING THE TIME ZONE: Set the time zone, which is comprised of steps from
the Setup Tool, the Vertica menu and the Reporting panel.
⧫ ENABLING CLEARSEE FIELDS FROM THE AOS CLI: Enable some parameters so that
they can be viewed in ClearSee reports and dashboards.
⧫ CHANGING THE REAL TIME REFRESH RATE: Change how often the data refreshes
in the Real-Time monitors.
Also included is LOGGING IN TO CLEARSEE AS ADMINISTRATOR, which is helpful in setting the
time zone and elsewhere.
7-2
7.2 Accessing NetXplorer
This procedure describes how to access NetXplorer, which you must do in order to
integrate ClearSee with NetXplorer. The first time that you connect to the NetXplorer, you
may be prompted to install Java 1.6.
To connect to NetXplorer:
1. In Internet Explorer, browse to http://<NX IP> and select Launch NetXplorer in
the NetXplorer Control Panel.
OR
Double click the shortcut icon on the desktop or in the system’s Start menu.
2. The Java Application Starting window is displayed.
3. The NetXplorer Log On dialog is displayed.
Menu
Bar
Quick Access
Toolbar
Main
Toolbar
Navigation
Pane
Application
Pane
Logs Pane
7-2
ClearSee Configuration
⧫ The upper portion displays a tree-like list of subcomponents or entries
according to the application selected in the portion.
• Application Pane: Displays data regarding the currently active applications and
operations
• Logs Pane: Displays the Alarms Log, a list of the alarms triggered by the alarm
definitions
7-3
ClearSee Configuration
b. In the Data Mediator Properties dialog box, verify that the associated output
profile appears in the Associated Output Profiles area, and that no other
associated profile appears there. For more information, see Chapter 4 of the
Data Mediator Install and Admin Guide.
NOTE After you add a ClearSee system to NetXplorer, the following
changes occur:
• The STC (Short Term Collector) stops collecting data.
• STC/LTC historical data ceases to be available in NetXplorer.
• The Data Mediator starts collecting data for ClearSee (replacing
STC functionality).
If you have already built your system, and now you want to make changes, see MODIFYING
A CLEARSEE SYSTEM .
7-4
ClearSee Configuration
7-5
ClearSee Configuration
7-6
ClearSee Configuration
Building a Standalone ClearSee System
This procedure describes how to build the Standalone ClearSee system, which you must
do after installation. It is part of INTEGRATING CLEARSEE WITH NETXPLORER and CLEARSEE
CONFIGURATION .
Involved is defining the BI-DW instance and the DM, then configuring the system on the
network, and finally performing some optional configurations.
To build the Standalone ClearSee system:
1. Define the BI-DW instance, as described in DEFINING A BI INSTANCE IN THE
NAVIGATION PANE.
NOTE When situated in a standalone system, the BI instance is actually
referred to as the BI-DW instance.
2. Do one of the following:
⧫ Define the DM, as described in Chapter 3 of the Data Mediator Install and
Admin Guide, and associate the ClearSee output profile with it.
⧫ If, for the purpose of HA, you defined multiple DMs in virtual IP groups, then
connect the HAP DMs to ClearSee, as described in DEFINING DMS WITH
VIRTUAL IPS.
3. In the NetXplorer Navigation pane, right-click the Network node, and then select
Configuration.
The Network Configuration area appears.
4. Select the ClearSee tab.
7-8
ClearSee Configuration
⧫ If you do not intend to use ClearSee’s GUI, but rather just use the ClearSee
back end, then, to save resources, select Smart Data Export Only Mode, as
described in REPORT AND NETWORKSECURE DEPLOYMENT MODES.
⧫ Define the ETL group, as described in DEFINING THE STANDALONE ETL GROUP.
⧫ From the SNMP tab as needed, CONFIGURE ADDITIONAL SNMP TRAPS
DESTINATION .
⧫ From the Data Source Files tab as needed, DEFINE EXTERNAL DATA FILES.
⧫ From the Aggregations tab, CONFIGURE DATA RETENTION AND AGGREGATION
DELAY .
NOTES
• The actions performed on the Aggregations tab are required.
• As Transfer Method, the FTP option is currently not in use.
⧫ From the Report Mode dropdown list, select the appropriate mode, which
determines the reports and dashboards that appear for you in ClearSee. For
more information, see REPORT AND NETWORKSECURE DEPLOYMENT MODES. For
a list of which reports, dashboards and templates appear with which modes,
see the ClearSee Operation Guide, Chapter 4: Reports and Dashboards,
Reports and Dashboards Overview.
⧫ Click Prime Time Configuration for Prime Time settings, as described in
DEFINING PRIME TIME SETTINGS.
7. Click OK.
On the ClearSee tab of the Network Configuration area, in the ClearSee Systems
area, the Standalone ClearSee system appears.
7-9
ClearSee Configuration
7-10
ClearSee Configuration
3. Define at least three DW instances, as described in DEFINING A DW INSTANCE IN THE
NAVIGATION PANE.
4. Do one of the following:
⧫ Define the DM, as described in Chapter 3 of the Data Mediator Install and
Admin Guide, and associate the ClearSee output profile with it.
⧫ If, for the purpose of HA, you defined multiple DMs in virtual IP groups, then
connect the HAP DMs to ClearSee, as described in DEFINING DMS WITH
VIRTUAL IPS.
5. In the NetXplorer Navigation pane, right-click the Network node, and then select
Configuration.
The Network Configuration area appears.
6. Select the ClearSee tab.
7. In the ClearSee Systems area, click Add.
The ClearSee System – New dialog box appears, on the General tab.
8. Do the following:
⧫ In the System Name field, name your ClearSee system.
⧫ From the Selected BI dropdown list, select the BI-HA group that you defined
in DEFINING A BI-HA GROUP IN THE NAVIGATION PANE for your ClearSee system.
The BI Type and Deployment Type fields are populated accordingly.
⧫ From the NetworkSecure Deployment Mode dropdown list, select the
appropriate mode, which determines the NetworkSecure dashboards and
templates that appear for you in ClearSee. For more information, see REPORT
AND NETWORK SECURE DEPLOYMENT M ODES . For a list of which reports,
dashboards and templates appear with which modes, see the ClearSee
Operation Guide, Chapter 4: Reports and Dashboards.
⧫ If you do not intend to use ClearSee’s GUI, but rather just use the ClearSee
back end, then, to save resources, select Smart Data Export Only Mode, as
described in REPORT AND NETWORKSECURE DEPLOYMENT MODES.
⧫ Define the ETL group, as described in DEFINING THE CLUSTER ETL GROUP.
⧫ From the SNMP tab, as needed, CONFIGURE ADDITIONAL SNMP TRAPS
DESTINATION .
⧫ From the Data Source Files tab, as needed, DEFINE EXTERNAL DATA FILES.
⧫ From the Aggregations tab, CONFIGURE DATA RETENTION AND AGGREGATION
DELAY .
NOTES
• The actions performed on the Aggregations tab are required.
7-11
ClearSee Configuration
• As Transfer Method, the FTP option is currently not in use.
⧫ From the Report Mode dropdown list, select the appropriate mode, which
determines the reports and dashboards that appear for you in ClearSee. For
more information, see REPORT AND NETWORKSECURE DEPLOYMENT MODES. For
a list of which reports, dashboards and templates appear with which modes,
see the ClearSee Operation Guide, Chapter 4: Reports and Dashboards.
⧫ Click Prime Time Configuration for Prime Time settings, as described in
DEFINING PRIME TIME SETTINGS.
9. Click OK.
On the ClearSee tab of the Network Configuration area, in the ClearSee Systems
area, the Cluster ClearSee system appears.
7-12
ClearSee Configuration
Modifying a ClearSee System
After building a ClearSee system, you may need to modify it at a later date.
To modify a ClearSee system:
1. Do any of the following:
⧫ If your modification involves editing a server node, see EDITING A SERVER
NODE.
⧫ If your modification involves defining a new server node, see any of the
following:
▪ DEFINING A BI INSTANCE IN THE NAVIGATION PANE
▪ DEFINING A BI-HA GROUP IN THE NAVIGATION PANE
▪ DEFINING A DW INSTANCE IN THE NAVIGATION PANE
⧫ If your modification involves defining a new DM or editing the current one,
see Chapter 3 of the Data Mediator Install and Admin Guide.
2. In the NetXplorer Navigation pane, right-click the Network node, and then select
Configuration.
The Network Configuration area appears.
3. Select the ClearSee tab.
7-13
ClearSee Configuration
7-14
ClearSee Configuration
7. Click OK.
On the ClearSee tab of the Network Configuration area, in the ClearSee Systems
area, the Standalone ClearSee system appears.
7-15
ClearSee Configuration
7-16
ClearSee Configuration
7-17
ClearSee Configuration
5. In the BI 1 field, select the BI instance that you want to serve as the primary BI
instance.
6. In the BI 2 field, select the BI instance that you want to serve as the secondary BI
instance.
7. Click Save.
The BI-HA group appears in the Navigation pane, under Servers.
8. From the toolbar, click Save to permanently save the BI-HA group on the
network.
9. Return to any of the following:
⧫ BUILDING A STANDALONE CLEARSEE SYSTEM
⧫ BUILDING A CLUSTER CLEARSEE SYSTEM
⧫ MODIFYING A CLEARSEE SYSTEM
7-18
ClearSee Configuration
3. From the toolbar, click Save to permanently save the DW instance on the
network.
4. Return to any of the following:
⧫ BUILDING A CLUSTER CLEARSEE SYSTEM
⧫ MODIFYING A CLEARSEE SYSTEM
7-19
ClearSee Configuration
7-20
ClearSee Configuration
7-21
ClearSee Configuration
7-22
ClearSee Configuration
7-23
ClearSee Configuration
7-24
ClearSee Configuration
7-25
ClearSee Configuration
7-26
ClearSee Configuration
7-27
ClearSee Configuration
7-28
ClearSee Configuration
• BUILDING A STANDALONE CLEARSEE SYSTEM
• BUILDING A CLUSTER CLEARSEE SYSTEM
• MODIFYING A CLEARSEE SYSTEM
To configure additional SNMP traps destinations:
1. From the ClearSee System – New or Update dialog box, open the SNMP tab.
7-29
ClearSee Configuration
Filename Description Integration Granularity
iana.csv A presentation of a Data source for the Row = Single
common, clearly Autonomous autonomous system
defined routing System dimension value
policy to an
Internet segment
devices.csv List of user device Data source for the Row = Information
codes Devices dimension for a single device
information
subscribers.csv List of all Data source for the Row = Single
subscribers and Subscribers subscriber with
their relevant dimension various attributes
attributes, for
example age,
gender,
location/zip code,
alias name
network_access_technology. Network Access Data source for the Row = Single
csv Technology based Network Access network access
on SDR.SessionRAT Technology technology (code &
(2G, 3G, 4G) dimension name)
This procedure is a part of the following:
• BUILDING A STANDALONE CLEARSEE SYSTEM
• BUILDING A CLUSTER CLEARSEE SYSTEM
• MODIFYING A CLEARSEE SYSTEM
To define the external data files:
4. From the ClearSee System – New or Update dialog box, open the Data Source
Files tab.
7-30
ClearSee Configuration
Figure 7-26: Data Source Files Tab of the ClearSee System Dialog Box
5. Refer to Appendix 1: EXTERNAL DATA SOURCE FILE STRUCTURES for the file
structures.
6. For each file, click the Browse button.
The Choose File dialog box appears.
7. Navigate to and select the file, and then click Select.
The path appears in the Upload File column.
8. Return to any of the following:
⧫ BUILDING A STANDALONE CLEARSEE SYSTEM
⧫ BUILDING A CLUSTER CLEARSEE SYSTEM
⧫ MODIFYING A CLEARSEE SYSTEM
7-31
ClearSee Configuration
Aggregation Period Data Retention Delay
Hour The number of days that the hour The delay in hours after the hour
is retained to appear in reports has concluded for data calculations
to commence
Day The number of days that the day The delay in hours after the day
is retained to appear in reports has concluded for data calculations
to commence
Month The number of months that the The delay in hours after the month
month is retained to appear in has concluded for data calculations
reports to commence
This procedure is a part of the following:
• BUILDING A STANDALONE CLEARSEE SYSTEM
• BUILDING A CLUSTER CLEARSEE SYSTEM
• MODIFYING A CLEARSEE SYSTEM
To configure data retention and aggregation delay:
1. From the ClearSee System – New or Update dialog box, open the Aggregations
tab.
7-32
ClearSee Configuration
7-33
ClearSee Configuration
• Prime Time: The hours of the weekday in your locale when people have the most
free time and are likely to spend time online. The hours can be split up into
separate ranges of hours at different times of the day and different for weekdays
and weekends.
• Working Hours: The hours of the weekday in your locale when people are usually
at work or school, and therefore are less likely to spend time online. The hours
must be in a range and consecutive. The default is 09:00–17:00.
This procedure is a part of the following:
• BUILDING A STANDALONE CLEARSEE SYSTEM
• BUILDING A CLUSTER CLEARSEE SYSTEM
• MODIFYING A CLEARSEE SYSTEM
To define Prime Time settings:
1. From the ClearSee System – New or Update dialog box, on the General tab, click
Prime Time Configuration.
The Prime Time Configuration – Update dialog box appears.
7-34
ClearSee Configuration
7-35
ClearSee Configuration
7-36
ClearSee Configuration
a. Log in as admin and then as root.
b. For each DM HAP, run the command described below.
• In a Standalone deployment, and on the DWs of a Cluster deployment:
c. Log in as admin and then as root.
d. For each DM HAP, run the command described below.
For the procedure, run the following command:
dm_ipv=<DM HAP> ; for i in {<DM,DM>} ; do ssh-keyscan -
t rsa $i | sed "s/$i/$dm_ipv/g" >> ~/.ssh/known_hosts ;
done
Where:
• <DM HAP> is the virtual IP of the DM HAP.
• <DM> is the actual IP of a DM in the DM HAP, each separated by a comma.
As an example, consider the following solution deployment:
• 2 BI servers
• 5 DW servers
• 10 DM servers, 5 DM HAPs containing 2 DMs each
In such a deployment, the above command must be run as follows:
As Root
(2 5) 5
+ =7 * = 35 times as root
2 BIs 5 DWs 5 DM HAPs
As dbadmin
5 5 = 25 times as
* dbadmin
5 DWs 5 DM HAPs
35 + 25 = 60 times all
together
7-37
ClearSee Configuration
1. As user dbadmin, launch the ClearSee Setup tool by typing, from the CLI, the
following:
cs_setup
The ClearSee Setup tool menu appears.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| Select configuration to edit or q to quit. |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.1.50.24
1) Configuration parameters
2) Copy Command
3) SNMP Configurations
4) Busy hours
5) Concurrent Users in ClearSee
6) TimeZone configuration
7) Enable/Disable all present insights.
8) Frequency
9) Asymmetric Traffic
10) Scheduled Tasks
7-38
ClearSee Configuration
3. In a new SSH session, check that the time zone did change, and then do the
following:
⧫ If the time zone did not change, repeat the procedure until now.
⧫ If the time zone did change, continue with the procedure.
4. Restart the DW database as follows:
a. STOP THE DW DATABASE.
b. START THE DW DATABASE.
5. LOG IN TO CLEARSEE AS WEB_ADMIN.
6. From the ClearSee Reporting panel, open Preferences.
Figure 7-31: Reporting Panel with Preferences Option
7. From the menu panel on the left, under Preferences Level,
select Project Defaults.
8. From the menu panel on the left, under Preferences, on the
General tab, in the Language area, select your Time Zone.
7-39
ClearSee Configuration
NOTE If the time zone change does not take effect immediately, then log
out of ClearSee and then LOG BACK IN .
7-40
ClearSee Configuration
1. From the CLEARSEE SETUP TOOL MENU , type 1 for Configuration Parameters.
The parameters appear that are available for changing.
2. Refer to the table below for a selection of Real-Time parameters, and for each
value you want to change, do the following:
a. Type the Configuration number of the parameter.
b. Change the value.
c. Confirm the change.
Configuration Number Parameter Description Default Value
43 rt_top_values Number of top values to 15
display
52 rt_min_refresh_interval • Refresh rate for all 15
Real-Time monitors, in
seconds
• Can be any multiple of
5 between 5–30
• Must be aligned with
the device
45 rt_max_rows Maximum rows when 200000
exporting to Excel
51 maxSolicited Maximum number of open 50
Real-Time solicited jobs
7-41
ClearSee Configuration
3. In NetXplorer, in the Navigation pane, right-click Network and then, from the
popup menu, select Configuration.
4. Select the Data Mediation > Output Profiles tab.
5. From the Output Profiles list, select the ClearSee Analytics Profile, and then click
Edit.
7-42
ClearSee Configuration
c. Click OK.
7. Change the refresh rate in the CONV_RTS_CS output record as follows:
a. From the Associated Output Records list, select CONV_RTS_CS.
b. In the CONV_RTS_CS Output File > File Attributes area, change the File
Closing Interval (secs) to the new refresh rate.
c. Click OK.
8. Click or select Save from the File menu to save the changes to the
configuration.
7-43
ClearSee Configuration
Enable or disable?
3. Enter option 2.
4. As writing to Syslog is based on the severity level, you must change, in the
$ETL_HOME/cfg/connection INI file, the minimum severity level for
syslog_debug_level, as described in CHANGING THE ETL ERROR SEVERITY LEVEL.
7-44
8 ClearSee Maintenance
8.1 Cluster Maintenance
This chapter covers various maintenance and repair procedures relevant to Cluster
installations.
2. Stopping the non-Active server. Go to the console of the non-Active server (as
identified in the above step) and type the following:
[root@clearsee-bi-secondary ~]# /etc/init.d/pacemaker
stop
The following is returned:
8-2
ClearSee Maintenance
[root@clearsee-bi-primary ~]# cat
/etc/sysconfig/network-scripts/ifcfg-bond1 | grep
IPADDR
6. Determine the internal mask on the network after the change (Default:
255.255.255.0)
This can be checked by the following procedure:
[root@clearsee-bi-primary ~]# cat
/etc/sysconfig/network-scripts/ifcfg-bond1 | grep
NETMASK
[root@clearsee-bi-primary ~]# sed 's/<OLD IP>/<NEW
IP>/g' -i /etc/sysconfig/network-scripts/ifcfg-bond1
[root@clearsee-bi-primary ~]# sed 's/<OLD MASK>/<NEW
MASK>/g' -i /etc/sysconfig/network-scripts/ifcfg-bond1
7. Changing the Internal IP address on the PACEMAKER network for the secondary
BI Server:
First: determine the Internal IP Address on the network before the change.
(Default is 192.168.216.217)
This can be checked by the typing:
[root@clearsee-bi-primary ~]# cat
/etc/sysconfig/network-scripts/ifcfg-bond1 | grep
IPADDR
Determine the internal IP mask on the network. (Default: 255.255.255.0)
This can be checked by the following procedure:
[root@clearsee-bi-primary ~]# cat
/etc/sysconfig/network-scripts/ifcfg-bond1 | grep
NETMASK
[root@clearsee-bi- secondary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/sysconfig/network-
scripts/ifcfg-bond1
[root@clearsee-bi- secondary ~]# sed 's/<OLD MASK>/<NEW
MASK>/g' -i /etc/sysconfig/network-scripts/ifcfg-bond1
8. Changing the internal IP Address on the PACEMAKER network that is configured
in the hosts file for two servers (run two scripts on each server).
[root@clearsee-bi-primary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/hosts
[root@clearsee-bi-primary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/hosts
Run the following commands on the BI-Primary Server:
[root@clearsee-bi-primary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/ansible/hosts
8-3
ClearSee Maintenance
[root@clearsee-bi-primary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/ansible/hosts
9. Changing the Internal IP Address on the DRBD network on the Primary BI server:
a. Determine the internal IP Address of the Server before the change (default is
192.168.219.216). This can be checked by issuing the following command:
[root@clearsee-bi-primary ~]# cat
/etc/sysconfig/network-scripts/ifcfg-bond2 | grep
IPADDR
b. Determine the internal netmask of the Server before the change (default is
255.255.255.0). This can be checked by issuing the following command:
[root@clearsee-bi-primary ~]# cat
/etc/sysconfig/network-scripts/ifcfg-bond2 | grep
NETMASK
10. Internal IP Address of the Server after the change:
[root@clearsee-bi-primary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/sysconfig/network-
scripts/ifcfg-bond2
[root@clearsee-bi-primary ~]# sed 's/<OLD NETMASK>/<NEW
NETMASK>/g' -i /etc/sysconfig/network-scripts/ifcfg-
bond2
11. Changing the internal IP Address for the DRBD connection of the Secondary BI
server:
a. Determine the internal IP Address of the Server before the change (the
default is 192.168.219.217). To check the address, execute the following
command:
[root@clearsee-bi-primary ~]# cat
/etc/sysconfig/network-scripts/ifcfg-bond2 | grep
IPADDR
b. Determine the Internal netmask of the Server before the change (the default
is 255.255.255.0). To check the netmask execute the following command:
[root@clearsee-bi-primary ~]# cat
/etc/sysconfig/network-scripts/ifcfg-bond2 | grep
NETMASK
12. Internal Network address after the change:
[root@clearsee-bi- secondary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/sysconfig/network-
scripts/ifcfg-bond2
[root@clearsee-bi- secondary ~]# sed 's/<OLD
NETMASK>/<NEW NETMASK>/g' -i /etc/sysconfig/network-
scripts/ifcfg-bond2
13. Changing the Internal IP Address for the DRBD Connection that is configured in
the hosts file in the two servers (run the following 2 commands on both servers):
8-4
ClearSee Maintenance
[root@clearsee-bi-secondary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/hosts
[root@clearsee-bi-secondary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/hosts
14. Run the following commands only on the Primary BI server:
[root@clearsee-bi-secondary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/ansible/hosts
[root@clearsee-bi-secondary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/ansible/hosts
15. Changing the Internal IP Address for the DRBD connections that are configured in
the DRBD conf file on the two servers (run the following 2 commands on all
servers):
[root@clearsee-bi-secondary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/drbd.d/pgsql.res
[root@clearsee-bi-secondary ~]# sed 's/<OLD IP
ADDRESS>/<NEW IP ADDRESS>/g' -i /etc/drbd.d/pgsql.res
16. Restarting networking on the two servers (execute both commands on both
servers) and check that all connections restarted successfully:
[root@clearsee-bi-primary ~]# /etc/init.d/network
restart
The following is returned:
Shutting down interface bond0: [ OK ]
Shutting down interface bond1: [ OK ]
Shutting down interface bond2: [ OK ]
Shutting down loopback interface: [ OK ]
Bringing up loopback interface: [ OK ]
Bringing up interface bond0: [ OK ]
Bringing up interface bond1: [ OK ]
Bringing up interface bond2: [ OK ]
17. Checking that networking has restarted with the new IP Addresses correctly
configured:
a. Type:
[root@clearsee-bi-primary ~]# ping -c 2 192.168.120.2
The following is returned:
PING 192.168.120.2 (192.168.120.2) 56(84) bytes of data.
64 bytes from 192.168.120.2: icmp_seq=1 ttl=64 time=0.036 ms
64 bytes from 192.168.120.2: icmp_seq=2 ttl=64 time=0.033 ms
b. Type:
[root@clearsee-bi-primary ~]# ping -c 2 192.168.120.3
8-5
ClearSee Maintenance
The following is returned:
PING 192.168.120.3 (192.168.120.3) 56(84) bytes of data.
64 bytes from 192.168.120.3: icmp_seq=1 ttl=64 time=0.270 ms
64 bytes from 192.168.120.3: icmp_seq=2 ttl=64 time=0.381 ms
c. Type:
[root@clearsee-bi-primary ~]# ping -c 2 192.168.130.2
The following is returned:
PING 192.168.130.2 (192.168.130.2) 56(84) bytes of data.
64 bytes from 192.168.130.2: icmp_seq=1 ttl=64 time=0.043 ms
64 bytes from 192.168.130.2: icmp_seq=2 ttl=64 time=0.041 ms
d. Type:
[root@clearsee-bi-primary ~]# ping -c 2 192.168.130.3
The following is returned:
PING 192.168.130.3 (192.168.130.3) 56(84) bytes of data.
64 bytes from 192.168.130.3: icmp_seq=1 ttl=64 time=0.592 ms
64 bytes from 192.168.130.3: icmp_seq=2 ttl=64 time=0.350 ms
18. Bringing up the Pacemaker and DRBD processes on the active server:
[root@clearsee-bi-primary ~]# /etc/init.d/pacemaker
start
The following is returned:
Starting cluster:
Checking if cluster has been disabled at boot... [ OK ]
Checking Network Manager... [ OK ]
Global setup... [ OK ]
Loading kernel modules... [ OK ]
Mounting configfs... [ OK ]
Starting cman... [ OK ]
Waiting for quorum... [ OK ]
Starting fenced... [ OK ]
Starting dlm_controld... [ OK ]
Tuning DLM kernel config... [ OK ]
Starting gfs_controld... [ OK ]
Unfencing self... [ OK ]
Joining fence domain... [ OK ]
Starting Pacemaker Cluster Manager [ OK ]
[root@clearsee-bi-primary ~]# pcs resource start ClusterIP
[root@clearsee-bi-primary ~]# pcs resource start DRBDResource
8-6
ClearSee Maintenance
[root@clearsee-bi-primary ~]# pcs resource start DBFileSystem
[root@clearsee-bi-primary ~]# pcs resource start PostgreSQL
[root@clearsee-bi-primary ~]# pcs resource start Tomcat
19. Bringing up the Pacemaker and DRBD processes on the Inactive Server:
[root@clearsee-bi-secondary ~]# /etc/init.d/pacemaker
start
The following is returned:
Starting cluster:
Checking if cluster has been disabled at boot... [ OK ]
Checking Network Manager... [ OK ]
Global setup... [ OK ]
Loading kernel modules... [ OK ]
Mounting configfs... [ OK ]
Starting cman... [ OK ]
Waiting for quorum... [ OK ]
Starting fenced... [ OK ]
Starting dlm_controld... [ OK ]
Tuning DLM kernel config... [ OK ]
Starting gfs_controld... [ OK ]
Unfencing self... [ OK ]
Joining fence domain... [ OK ]
Starting Pacemaker Cluster Manager [ OK ]
8-7
ClearSee Maintenance
Feb 19 14:12:53 clearsee-bi-secondary kernel: block drbd0: helper command:
/sbin/drbdadm initial-split-brain minor-0 exit code 0 (0x0)
Feb 19 14:12:53 clearsee-bi-secondary kernel: block drbd0: helper command:
/sbin/drbdadm split-brain minor-0
Feb 19 14:12:53 clearsee-bi-secondary kernel: block drbd0: helper command:
/sbin/drbdadm split-brain minor-0 exit code 0 (0x0)
8-8
ClearSee Maintenance
▪ If the output matches the examples above, then continue to the next
step.
▪ If the output does not match the examples above, then resolve the
networking problem and then retry STEP 1.
2. Determine which server is currently the active server, that on which the cluster
services are located, as follows:
a. Type:
[root@clearsee-bi-primary ~]# pcs status
Similar to the following is returned:
Last updated: Thu Mar 6 07:42:04 2014
Last change: Tue Jan 21 11:16:53 2014 via cibadmin on ha-secondary
Stack: cman
Current DC: ha-secondary - partition with quorum
Version: 1.1.10-1.el6_4.4-368c726
2 Nodes configured
6 Resources configured
8-9
ClearSee Maintenance
4. Check that the fault has been repaired and that the cluster is functioning
properly by doing the following:
a. Type the following:
[root@clearsee-<active> ~]# drbdadm status
b. Verify that the output includes the statement appears as follows:
pgsql role:Primary
disk:UpToDate
<HOSTNAME> role:Secondary
peer-disk:UpToDate
2. From the console of the active server, verify that all the processes started by
typing:
[root@clearsee-<active server> ~]# pcs status
Similar to the following is returned:
Last updated: Thu Mar 6 07:52:12 2014
Last change: Thu Mar 6 07:57:02 2014 via crm_resource on ha-primary
Stack: cman
8-10
ClearSee Maintenance
Current DC: ha-secondary - partition with quorum
Version: 1.1.10-1.el6_4.4-368c726
2 Nodes configured
6 Resources configured
The active server, the Primary BI server, has been switched from ha-secondary to
ha-primary.
8-11
ClearSee Maintenance
2. Type the following command from any of the DW servers.
/opt/vertica/bin/vnetperf --hosts <IP NODE1>,<IP
NODE2>,<IP NODE3>
Where <IP NODE1>,<IP NODE2>,<IP NODE3> are the internal IP addresses of the
DWs
3. Check the following:
⧫ Value for each server: Close to 600 MB
⧫ RTT latency:
▪ Maximum recommended: 2 milliseconds
▪ Ideal RTT latency: 200 microseconds or less
⧫ Clock skew: Kept under 1 second
⧫ Throughput:
▪ Minimum recommended: 100 MB/s
▪ Ideal: 800 MB/s or more
test | date | node
| index | rtt latency (us) | clock skew (us)
---------------------------------------------------------------------------
----------------------------------------------
latency | 2014-03-05_08:49:31,924 | 192.168.10.11
| 0 | 99 | 7
latency | 2014-03-05_08:49:31,924 | 192.168.10.12
| 1 | 70 | 23128454
latency | 2014-03-05_08:49:31,924 | 192.168.10.13
| 2 | 103 | -10942248
NOTE UDP numbers may be lower, multiple network switches may reduce
performance results.
date | test | rate limit (MB/s) |
node | MB/s (sent) | MB/s (rec) | bytes (sent) | bytes
(rec) | duration (s)
---------------------------------------------------------------------------
---------------------------------------------------------------------------
----------------------------
2014-03-05_08:49:31,926 | udp-throughput | 32 |
192.168.10.11 | 30.5477 | 30.5477 | 32047104 |
32047104 | 1.00048
2014-03-05_08:49:31,926 | udp-throughput | 32 |
192.168.10.12 | 30.5141 | 30.5141 | 32047104 |
32047104 | 1.00159
…
2014-03-05_08:49:39,933 | udp-throughput | 2048 |
average | 573.521 | 572.904 | 601576789 |
601052501 | 1.00046
8-12
ClearSee Maintenance
NOTE The DNS names of the two servers are ha-primary and ha-
secondary. These names do not indicate which server is actually
currently primary or currently secondary, as follows:
When the Primary BI server fails, the Secondary BI server becomes
primary. After restoration, the formerly primary server becomes
Secondary BI. If the formerly primary server had been ha-primary,
then after restoration the Primary BI server is ha-secondary and the
Secondary BI is ha-primary.
To restore the Primary BI server:
1. Solve the hardware issues or otherwise that prevented normal operation from
the Primary BI server.
2. Verify that the system network and power cables are connected as described in
STANDALONE DEPLOYMENTS.
3. Power on the Primary BI server.
4. Refresh the Intelligence Cubes by running the following five commands:
rm -rf /cube/mstr-cube/ClusterCaches/*
rm -rf /cube/mstr-cube/ClusterCube/*
rm -rf /cube/mstr-cube/ClusterInbox/*
rm -rf /cube/mstr-cube/ClusterInBox/*
/opt/allot/clearsee/python/bin/python2.7
/opt/allot/clearsee/etl/pymodules/CubeInitialPublish/CubeInitialPublish.py
8-13
ClearSee Maintenance
3. Mount the disk and create the External directory by running the following
commands:
su -
mkdir /External
mount -o umask=0000,dmask=0000 /dev/[DEVICE NAME]
/External
Where [DEVICE NAME] is the name of the device
4. Create directories in the External directory by running the following commands:
mkdir /External/backup_vertica
mkdir /External/backup_pgsql
5. Give the dbadmin user full rights on this directory by running the following
command:
chmod -R 777 /External
8-15
ClearSee Maintenance
3. Run the VBR Python script utility to configure the backup, by doing one of the
following:
⧫ If you are currently in ClearSee 15.1 or below, then run the following
command:
/opt/vertica/bin/vbr.py –setupconfig
⧫ If you are currently in ClearSee 16.1 or above, then run the following
command:
/opt/vertica/bin/vbr.py –c
4. Create the backup’s INI file by completing the following wizard:
Snapshot name (backup_snapshot):
Destination Vertica DB bin directory (only required for object replication)
(/opt/vertica/bin):
Number of restore points (1):
Specify objects (no default):
Object restore mode (coexist, createOrReplace or create) (createOrReplace):
Enter: create
Vertica user name (dbadmin):
Save password to avoid runtime prompt? (n) [y/n]:
Enter: n
Backup host name (no default):
Enter: Localhost
Backup directory (no default):
Enter: /External/backup_vertica/
8-16
ClearSee Maintenance
Change advanced settings? (n) [y/n]:
Config file name:
Name your INI file.
Where [INI FILE] is the name of your INI file as you just named it
5. Initialize the host server/directory by running the following command:
/opt/vertica/bin/vbr.py --config-file [INI FILE].ini -
-task init
6. Run the VBR backup command with the INI file that you just created:
/opt/vertica/bin/vbr.py --config-file [INI FILE].ini -
-task backup
8-17
ClearSee Maintenance
3. Run the VBR Python script utility to configure the backup, by doing one of the
following:
⧫ If you are currently in ClearSee 15.1 or below, then run the following
command:
/opt/vertica/bin/vbr.py –setupconfig
⧫ If you are currently in ClearSee 16.1 or above, then run the following
command:
/opt/vertica/bin/vbr.py –c
4. Create the backup’s INI file by completing the following wizard:
Snapshot name (backup_snapshot):
Destination Vertica DB bin directory (only required for object replication)
(/opt/vertica/bin):
Number of restore points (1):
Specify objects (no default):
Object restore mode (coexist, createOrReplace or create) (createOrReplace):
Enter: create
Vertica user name (dbadmin):
Save password to avoid runtime prompt? (n) [y/n]:
Enter: n
Backup host name (no default):
Enter the remote server’s IP.
Backup directory (no default):
Enter: /home/dbadmin/backup_vertica/
8-18
ClearSee Maintenance
Change advanced settings? (n) [y/n]:
Config file name:
Name your INI file.
Where [INI FILE] is the name of your INI file as you just named it
5. Initialize the host server/directory by running the following command:
/opt/vertica/bin/vbr.py --config-file [INI FILE].ini -
-task init
6. Run the VBR backup command with the INI file that you just created:
/opt/vertica/bin/vbr.py --config-file [INI FILE].ini -
-task backup
8-20
ClearSee Maintenance
8. Copy from remote INI file that you created in BACKING UP THE DW to
/home/dbadmin.
9. Run the VBR restore command using your [INI FILE], as follows:
/opt/vertica/bin/vbr.py --config-file
/home/dbadmin/[INI FILE].ini --task init
/opt/vertica/bin/vbr.py --config-file
/home/dbadmin/[INI FILE].ini --task restore
Vertica is restored to the backed-up version.
10. Verify that the restore has completed, and then start the database, as described
STARTING THE DW DATABASE.
11. Switch users to root by running the following command:
su –
12. Perform an upgrade of the schema, as follows:
/opt/allot/clearsee/install/upgrade/lib/upgrade_vert.py
NOTE You may see errors saying that the column/table already exists. This
is OK.
ClearSee Logs
The following detailed ClearSee logs are available:
• ETL LOGS
• INSTALLATION AND UPGRADE LOGS
• VERTICA LOG
• POSTGRESQL LOG
• SYSTEM LOG
You can configure the severity of the alarms, as described in CHANGING THE ETL ERROR
SEVERITY LEVEL, as well as have the alarms sent to the syslog daemon.
8-21
ClearSee Maintenance
To change the ETL severity log level:
1. Open for editing the $ETL_HOME/cfg/connection.ini file, to the [logger] section.
[logger]
; Each handler log level setting defines the
; minimum value for that handler to log with.
; NOTSET implies lowest logging priority.
; Case insensitive.
; Each handler requires a level.
; SQL logs is the level at which queries are logged.
; Disabled implies handler will ignore all logs.
; Accepted values:
;
; CRITICAL
; ERROR
; WARNING
; INFO
; DEBUG
; NOTSET
;
; DISABLED
;
log_debug_level = info
repository_debug_level = warning
syslog_debug_level = disabled
sql_logs = NOTSET
2. Change the minimum severity log levels as required. Whatever level you select
for a log, that level and above will appear in the log.
ETL Logs
These Proprietary ETL (Extract Transform Load) logs are stored in the central repository
DB. These alarms alert for errors and problems related to the data loading procedures,
and they are located as follows:
• /opt/allot/clearsee/etl/logs: Containing info level logs including alerts, errors,
critical information for debugging ETL issues
• Error_log Table: From the postgres database, containing warning level logs of ETL
operation warnings and errors, and accessible via CLI, as described in DISPLAYING
ALERTS
8-22
ClearSee Maintenance
Vertica Log
You can find the Vertica log in the following location:
/vertica_catalog/clearseedwh/v_clearseedwh_node0001_catalog/vertica.log
NOTE The system also generates the standard OS MIB2 Alerts, as
described in VERTICA TRAPS .
PostgreSQL Log
The postgres log contains alerts related to postgres events such as connection errors, SQL
errors, internal database errors, exceeded size-limit errors and memory related errors.
You can find the postgres log in the following location:
/var/lib/pgsql/9.2/data/pg_log/
System Log
The system log (syslog) contains a superset of all system-level logs including ETL and DW
logs, as well as additional events not related to ETL, DW or even to ClearSee. As the
system log is disabled by default, to view these alerts you must CHANGE THE ETL SEVERITY
LEVEL.
Vertica Traps
In addition to the default traps, Vertica also creates traps. You can find the list of Vertica
traps in this link:
https://my.vertica.com/docs/7.1.x/HTML/Content/Authoring/AdministratorsGuide/Monit
oring/Vertica/ConfiguringEventTrappingForSNMP.htm
The following example illustrates a Too Many ROS Containers event posted to SNMP:
Version: 1, type: TRAPREQUEST
Enterprise OID: .1.3.6.1.4.1.31207.2.0.1
Trap agent: 72.0.0.0
Generic trap: ENTERPRISESPECIFIC (6)
Specific trap: 0
.1.3.6.1.4.1.31207.1.1 ---> 4
.1.3.6.1.4.1.31207.1.2 ---> 0
8-23
ClearSee Maintenance
.1.3.6.1.4.1.31207.1.3 ---> 2008-08-14 11:30:26.121292
.1.3.6.1.4.1.31207.1.4 ---> 4
.1.3.6.1.4.1.31207.1.5 ---> 1
.1.3.6.1.4.1.31207.1.6 ---> site01
.1.3.6.1.4.1.31207.1.7 ---> suse10-1
.1.3.6.1.4.1.31207.1.8 ---> Too many ROS containers exist on this node.
.1.3.6.1.4.1.31207.1.9 ---> QATESTDB
.1.3.6.1.4.1.31207.1.10 ---> Too Many ROS Containers
8-24
ClearSee Maintenance
8-25
ClearSee Maintenance
⧫ <OLD DW2 HOSTNAME>: The current hostname of the DW2 server, which by
default is similar to clearsee-dw-2
⧫ <OLD DW3 HOSTNAME>: The current hostname of the DW3 server, which by
default is similar to clearsee-dw-3
⧫ <NEW PRIMARY BI HOSTNAME>: The new hostname of the primary BI
server
⧫ <NEW SECONDARY BI HOSTNAME>: The new hostname of the primary BI
server
⧫ <NEW DW1 HOSTNAME>: The new hostname of the DW1 server
⧫ <NEW DW2 HOSTNAME>: The new hostname of the DW2 server
⧫ <NEW DW3 HOSTNAME>: The new hostname of the DW3 server
2. On each BI server, do the following:
a. Run the following command:
/opt/MicroStrategy/home/bin/mstrctl -s
IntelligenceServer term
b. Stop the Internal HA communcation with the following command:
service pacemaker stop
c. Run the following command:
hostnamectl set-hostname <NEW HOSTNAME>
d. Run the following commands:
grep -irl <OLD PRIMARY BI HOSTNAME> /etc/ /opt/MicroStrategy/
/opt/allot/clearsee/etl/pymodules/ | xargs sed -i "s/<OLD PRIMARY BI
HOSTNAME>/$<NEW PRIMARY BI HOSTNAME>/Ig"
grep -irl <OLD SECONDARY BI HOSTNAME> /etc/ /opt/MicroStrategy/
/opt/allot/clearsee/etl/pymodules/ | xargs sed -i "s/<OLD SECONDARY BI
HOSTNAME>/$<NEW SECONDARY BI HOSTNAME>/Ig"
grep -irl <OLD DW1 HOSTNAME> /etc/ /opt/allot/clearsee/etl/pymodules/ |
xargs sed -i "s/<OLD DW1 HOSTNAME>/$<NEW DW1 HOSTNAME>/Ig"
grep -irl <OLD DW2 HOSTNAME> /etc/ /opt/allot/clearsee/etl/pymodules/ |
xargs sed -i "s/<OLD DW2 HOSTNAME>/$<NEW DW2 HOSTNAME>/Ig"
grep -irl <OLD DW3 HOSTNAME> /etc/ /opt/allot/clearsee/etl/pymodules/ |
xargs sed -i "s/<OLD DW3 HOSTNAME>/$<NEW DW3 HOSTNAME>/Ig"
8-26
ClearSee Maintenance
3. On each DW server, do the following:
a. Stop the ETL service with the following command:
cs_admin stop
b. Run the following command:
hostnamectl set-hostname <NEW HOSTNAME>
c. Run the following commands:
sed -i 's/<OLD PRIMARY BI HOSTNAME>/<NEW PRIMARY BI HOSTNAME>/Ig'
/etc/hosts
sed -i 's/<OLD SECONDARY BI HOSTNAME>/<NEW SECONDARY BI HOSTNAME>/Ig'
/etc/hosts
sed -i 's/<OLD DW1 HOSTNAME>/<NEW DW1 HOSTNAME>/Ig' /etc/hosts
sed -i 's/<OLD DW2 HOSTNAME>/<NEW DW2 HOSTNAME>/Ig' /etc/hosts
sed -i 's/<OLD DW3 HOSTNAME>/<NEW DW3 HOSTNAME>/Ig' /etc/hosts
8-27
ClearSee Maintenance
8-28
ClearSee Maintenance
Figure 8-3 - cs_admin CLI screen
8-29
ClearSee Maintenance
Start, Stop and Restart
Start, Stop and Restart are self-explanatory: they are basic commands for launching,
halting and restarting the ETL process.
ETL Status
The ClearSee ETL Status CLI function displays the status of the DW Db status, and the
status of the ETL functions loading data into it.
Database Status Column:
• If the connection to the DW DB is operational and there are no error reports, the
status will display as OK.
• If there are error reports, the status will display as "alert" and the events will be
printed to screen.
• If there is no connection to the DB, the status will show as "failed".
ETL Status Column:
• If all modules are up and running, the status displayed is "OK".
• If one or more ETL modules have malfunctioned or are not running, the status
displayed is "alert" and all module statuses will be printed to the screen.
• If communication with the ETL watchdog fails, all modules will display as "failed".
8-30
ClearSee Maintenance
Queues
After selecting "Queues", the CLI interface displays the status of the Data Warehouse and
the ETL processes on the node.
• CPU average load during
• the past minute
• the past 5 minutes
• amount of data waiting to be pulled
• data loaded during the past 5 minutes
• amount of data waiting in the queue to be loaded
8-31
ClearSee Maintenance
Deploy
Deploys all .ini configuration files to the cluster. The .ini configuration files are located in
the directory:
$ETL_HOME/cfg/connection.ini
Displaying Alerts
This CLI option allows the display of all ClearSee errors encountered.
The user can select how far back to print. The default value is a week.
8-32
ClearSee Maintenance
8-33
ClearSee Maintenance
8-34
ClearSee Maintenance
Status
This option allows viewing all existing ClearSee patches and their states:
• If a patch is installed it will appear as “Installed “and will be colored in Green. An
Uninstalled patch will appear as “Not installed” and will be colored in Red.
8-35
ClearSee Maintenance
Import
This option allows importing patches that were located in a specific path. This command
gets a path as an argument and imports all the patches in the path to the patches
manager
Install
This option allows installing patches that were imported to the Patch manager. This
command gets a patch name as an argument (the exact name as it shown in the status
command) and installs it. It is possible to provide a list of patches separated by a space.
There are two kinds of patches: reversible and irreversible. Irreversible patches can’t be
uninstalled
When trying to install such a patch, the system will inform you that the patch is
irreversible, and ask for your permission to proceed with installation.
8-36
ClearSee Maintenance
Figure 40 - cs_patches-install reversible patch CLI screen
8-37
9 Security and Access Management
9.1 Accessing ClearSee
This procedure describes how to access ClearSee.
To access ClearSee:
• Enter the URL as follows:
http://[IP]:8080/ClearSee/servlet/mstrWeb
Where [IP] is the IP of your ClearSee.
NOTE You can also access ClearSee by HTTPS, as described HERE, as well
as change the ClearSee Web ports, as described HERE.
9.2 Security
The Allot ClearSee user interface has a robust security model, which provides controls
over what data the users can see, what objects they can use, and what functional
privileges they have.
Database Security
The ClearSee database component is secured using a number of access control,
communication and database security functions:
• User access controls: User access to the database is password-protected using a
proprietary password authentication scheme.
• Internal data communication (when deployed in a Cluster deployment)
⧫ Communication between database nodes is sent in a compressed database
internal communication format.
⧫ Communication between the BI and the database servers is password
protected.
• Database security
⧫ Access to the database is password protected.
⧫ The database supports client authentication, which prevents unauthorized
access to the database. By default, only the ClearSee BI can access the
database. Additional users and authentication methods can be added as
needed.
<Connector port="8443"
protocol="org.apache.coyote.http11.Http11NioProtocol"
maxThreads="150" SSLEnabled="true" scheme="https"
secure="true"
keystoreFile="/cert/mykeystore.jks" keystorePass="password"
clientAuth="false" sslProtocol="TLS" />
After:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />
-->
<Connector port="8443"
protocol="org.apache.coyote.http11.Http11NioProtocol"
maxThreads="150" SSLEnabled="true" scheme="https"
secure="true"
keystoreFile="/cert/mykeystore.jks" keystorePass="password"
clientAuth="false" sslProtocol="TLS" />
9-2
Security and Access Management
4. Save the file, and then run the command:
systemctl restart tomcat.service
<Connector port="8443"
protocol="org.apache.coyote.http11.Http11NioProtocol"
maxThreads="150" SSLEnabled="true" scheme="https"
secure="true"
keystoreFile="/cert/mykeystore.jks" keystorePass="password"
clientAuth="false" sslProtocol="TLS" />
After:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />
-->
<Connector port="8443"
protocol="org.apache.coyote.http11.Http11NioProtocol"
maxThreads="150" SSLEnabled="true" scheme="https"
secure="true"
keystoreFile="/cert/mykeystore.jks" keystorePass="password"
clientAuth="false" sslProtocol="TLS" />
9-3
Security and Access Management
3. Connect to the server using user admin, and then change to root.
4. Run the command:
vim /opt/tomcat/conf/server.xml
5. To change the port for HTTP access, change the following:
<Connector port="8080" protocol="HTTP/1.1"
To:
<Connector port="[PORT]" protocol="HTTP/1.1"
<Connector port="8443"
protocol="org.apache.coyote.http11.Http11NioProtocol"
maxThreads="150" SSLEnabled="true" scheme="https"
secure="true"
keystoreFile="/cert/mykeystore.jks" keystorePass="password"
clientAuth="false" sslProtocol="TLS" />
To:
<Connector port="[PORT]"
protocol="org.apache.coyote.http11.Http11NioProtocol"
maxThreads="150" SSLEnabled="true" scheme="https"
secure="true"
keystoreFile="/cert/mykeystore.jks" keystorePass="password"
clientAuth="false" sslProtocol="TLS" />
9-4
Security and Access Management
vim /opt/tomcat/conf/server.xml
c. To change the port for HTTP access, change the following:
<Connector port="8080" protocol="HTTP/1.1"
To:
<Connector port="[PORT]" protocol="HTTP/1.1"
<Connector port="8443"
protocol="org.apache.coyote.http11.Http11NioProtocol"
maxThreads="150" SSLEnabled="true" scheme="https"
secure="true"
keystoreFile="/cert/mykeystore.jks" keystorePass="password"
clientAuth="false" sslProtocol="TLS" />
To:
<Connector port="[PORT]"
protocol="org.apache.coyote.http11.Http11NioProtocol"
maxThreads="150" SSLEnabled="true" scheme="https"
secure="true"
keystoreFile="/cert/mykeystore.jks" keystorePass="password"
clientAuth="false" sslProtocol="TLS" />
Changing Passwords
The following procedures describe how to change ClearSee passwords from the DEFAULT.
After installation, Allot recommends that you change the DW password from the default,
as follows:
• To change the Allot admin password, see CHANGING THE ALLOT ADMIN PASSWORD .
• To change the DW password in a Standalone deployment, do the following:
⧫ CHANGING THE VERTICA DB PASSWORD (STANDALONE)
⧫ CHANGING THE DW USER PASSWORD (STANDALONE )
9-5
Security and Access Management
• To change the DW password in a Cluster deployment, do the following:
⧫ CHANGING THE VERTICA DB PASSWORD (CLUSTER)
⧫ CHANGING THE DW USER PASSWORD (CLUSTER)
To change the system root password, see CHANGING THE SYSTEM ROOT PASSWORD .
Default Passwords
The following are the default passwords:
• Allot admin: allot
• System root user: bugaboo
• DW:
⧫ Vertica DB: dbadmin
⧫ DW user (dbadmin): dbadmin
9-6
Security and Access Management
a. Run the following command:
vim /etc/odbc.ini
The contents of the file appear.
b. Type the letter i to enter edit mode.
c. Change the password in the following sections:
▪ [data_browse]
▪ [central_repository]
d. Press ESC to exit edit mode, and then type :wq to save the changes.
4. Change the password in the Connection file, as follows:
a. Run the following command:
vim /opt/allot/clearsee/etl/cfg/connection.ini
The contents of the file appear.
b. Type the letter i to enter edit mode.
c. Change the password in the [vertica] section.
d. Press ESC to exit edit mode, and then type :wq to save the changes.
9-7
Security and Access Management
vim /etc/odbc.ini
The contents of the file appear.
b. Type the letter i to enter edit mode.
c. Change the password in the following sections:
▪ [data_browse]
▪ [central_repository]
d. Press ESC to exit edit mode, and then type :wq to save the changes.
4. Change the password in the Connection file, as follows:
a. Run the following command:
vim /opt/allot/clearsee/etl/cfg/connection.ini
The contents of the file appear.
b. Type the letter i to enter edit mode.
c. Change the password in the [vertica] section.
d. Press ESC to exit edit mode, and then type :wq to save the changes.
5. Run the command cs_admin.
6. Type deploy.
7. At the prompt, type Y.
8. For each DB server in the cluster, do the following:
a. Run the following command:
cat /opt/allot/clearsee/etl/cfg/connection.ini
b. Change the password in the section [vertica].
c. Type :wq to save the changes.
9-8
Security and Access Management
Changing the DW User Password (Cluster)
This procedure describes how to change the DW user password, otherwise known as the
dbadmin password, in a Cluster deployment. This procedure must be performed on each
DW.
NOTE The Vertica DB password and the DW user password should be
identical.
To change the DW user password in a Cluster deployment, on each DW:
1. Log in to the DW with the current DW password, and then enter the following
command:
passwd
2. Enter your old password, and then enter your new password.
NOTE The password may not contain the $ (dollar sign) symbol.
9-9
Security and Access Management
echo "select set_config_parameter ('SSLCertificate','$(cat
/cert/selfsigned.crt)');" | vsql
echo "select set_config_parameter ('SSLPrivateKey','$(cat
/cert/server.key)');" | vsql
echo "ALTER DATABASE clearseedwh SET EnableSSL = 1;" | vsql
cs_admin stop
7. Wait until the system is down, and then verify that the system is down with the
following command:
cs_admin status
Similar to the following appears:
9-10
Security and Access Management
c. Press the space bar to select the database, and then press OK.
9-11
Security and Access Management
f. Press the space bar to select the database, and then press OK.
g. Exit the Vertica menu.
9. Verify that the parameter are configured, and then run the following command:
vsql -x -c "select parameter_name, current_value,
default_value from vs_configuration_parameters where
parameter_name in ('EnableSSL', 'SSLCertificate',
'SSLPrivateKey', 'SSLCA');"
10. Enter the dbadmin password.
11. Verify that you see the following:
⧫ The value of EnableSSL is 1.
⧫ The SSL certificate fields contain content.
9-12
Security and Access Management
Access Privileges
The administrator grants a user access to the ClearSee domains as well as other tools.
There are two access levels:
9-13
Security and Access Management
• Granted: The user has access to the reports in the domain or to the tool, and
may perform actions such as drilling down where relevant.
• Denied: The user is denied access to the domain or tool. The user may see the
domain or report in the Reports menu, but clicking it returns a blocked message.
The administrator is Web_Admin in the main client and admin/admin for the User
Manager. The administrator has access to everything.
The groups are predefined, with access levels for the groups as follows:
9-14
Security and Access Management
Accessing the User Manager
The User Manager is used for all access management procedures, such as creating users
and groups, and assigning users to groups.
Prerequisites
At least one administrator must have the necessary privileges to access the User
Manager.
1. From your browser, access the Administrator site at:
<CLEARSEE IP>:8080/ClearSee/servlet/mstrWebAdmin
2. Sign in as the admin:
⧫ Username: admin
⧫ Password: admin
On the Servers page, in the row of your ClearSee server, hover your mouse in the
Properties column.
The Modify and Administration Portal icons appear.
9-15
Security and Access Management
9-16
Security and Access Management
User Management
In order for someone to access ClearSee reports and dashboards, you must first give that
person a user account.
All users except for guest users are automatically members of the Everyone group. The
Everyone group is on the public/guest security level, and has privileges only to browse and
read reports.
9-17
Security and Access Management
9-18
Security and Access Management
OR
If you don’t know which group contains the user account, click the Everyone
group, which contains all users.
3. In the row of the user that you want to modify, in the Actions column, hover
your mouse so that the Edit icon appears, and then click the icon.
The User Editor opens.
4. Modify any account criteria as needed by continuing in CREATING A USER ACCOUNT,
from step 3 onward.
5. Click OK to save the changes.
9-19
Security and Access Management
The user now belongs to the selected group or subgroup, and inherits all its
access permissions.
NOTE Do not add the user to more than one group.
9-20
Security and Access Management
9-22
Security and Access Management
Managing User Delivery Information
After PROVIDING A USER ’S DELIVERY INFORMATION, you can perform the following
management tasks:
• To edit an address or location, in its row click Edit, and then edit the fields.
• To delete an address or location, in its row click Delete.
9-23
Security and Access Management
Group Management
Instead of assigning access privileges to many users individually, you rather create groups
and assign appropriate privileges to each group.
Denying is important in order to create an exception within a group.
Creating a Subgroup
Create a subgroup in order to change access to domains or tools for some of the users of
a group.
1. Open the User Manager, as described in ACCESSING THE USER MANAGER.
2. On the toolbar, click the New Group icon .
The Group Editor opens.
9-25
Security and Access Management
o To remove the subgroup from the group, select the group from the Selected list,
and click the left-facing arrow.
o Do not assign any of the MicroStrategy Groups to a subgroup. The MicroStrategy
license allows only one administrator (Web_Admin), which is configured
automatically during system installation.
Deleting a Subgroup
You can delete a subgroup that you no longer need. If users are assigned to the group, the
users remain in the Everyone group and any other group to which they may also be
assigned.
1. Open the User Manager, as described in ACCESSING THE USER MANAGER, and then
browse to the subgroup.
2. In the row of the subgroup you want to delete, in the Actions column, click the
Delete icon .
The user is deleted.
9-26
ClearSee Startup and Shutdown
10-27
ClearSee Startup and Shutdown
2. From any of the DW servers, start the DW database, as described in STARTING THE
DW DATABASE.
3. Do the following:
a. Power on the Primary BI server.
b. Power on the Secondary BI server.
It takes up to 30 minutes for all ETL processes on all DW nodes to start.
10-28
ClearSee Startup and Shutdown
10-29
ClearSee Startup and Shutdown
10-30
ClearSee Startup and Shutdown
10-31
ClearSee Startup and Shutdown
10-32
ClearSee Startup and Shutdown
10-33
11 Appendices
11.1 Appendix 1: External Data Source File Structures
External Source: Autonomous System
File Properties
Formatting Issues No
Encoding / Obfuscation
No
Issues
Filters No
Fields Structure
Field Name Description Type Max Length Key?
as_code autonomous system code varchar 10 Y
autonomous system
as_description varchar 255
description
Properties
Formatting Issues No
Data
Encoding / Obfuscation
No
Issues
Filters No
Fields Structure
Field Name Description Type Max Length Key?
TAC Type Allocation Code varchar 255 Y
Model Model name varchar 255
Name of device
Vendor varchar 255
manufacturer
Family Model family name varchar 255
Category Category of the device varchar 255
OS Operating system varchar 255
11-2
Appendices
Properties
Data Sample X
Encoding / Obfuscation
No
Issues
Filters No
Fields Structure
Field Name Description Type Max Length Key?
subscriber_id subscriber code varchar 128 Y
subscriber's year of birth
yob integer 4
(yob)
gender Male/Female varchar 10
Postal zip code or other
location subscriber location varchar 255
information
11-3
Appendices
The subscriber name as used
alias_name varchar 255
by the CRM
An indication if the
payment_type subscriber is pre-pad or varchar 20
post-paid subscriber
The name of the operator
the subscriber buys the
service from (for example
operator varchar 255
the carrier may be VF but
the operator may be MVNO
running on VF infrastructure)
home_city Subscriber City varchar 255
home_region Subscriber Region varchar 255
customer_crm_st
Active/Disable etc varchar 255
atus
subscription_nam
Subscription name varchar 255
e
business_resident
varchar 255
ial_ind
subscriber_reserv
For Additional Data varchar 255
ed_1
subscriber_reserv
For Additional Data varchar 255
ed_2
subscriber_reserv
For Additional Data varchar 255
ed_3
subscriber_reserv
For Additional Data varchar 255
ed_4
subscriber_reserv
For Additional Data varchar 255
ed_5
subscriber_reserv
For Additional Data varchar 255
ed_6
subscriber_reserv
For Additional Data varchar 255
ed_7
subscriber_reserv
For Additional Data varchar 255
ed_8
subscriber_reserv
For Additional Data varchar 255
ed_9
subscriber_reserv
For Additional Data varchar 255
ed_10
11-4
Appendices
Properties
Encoding / Obfuscation
No
Issues
Filters No
Fields Structure
Field Name Description Type Max Length Key?
service_plan_id Service Plane code varchar 128 Y
service_plan_des Service Plane Name /
varchar 255
cription Description
quota_existence Quota Existence integer 4
11-5
Appendices
quota_amount Quota Amount integer 64
Properties
Filters No
Fields Structure
Field Name Description Type Max Length Key?
network_cell_ke
The cell location identifier varchar 255 Y
y
Name of the cell as appears in
network_name varchar 255
the carrier records
11-6
Appendices
The Nominal capacity, which
network_nomina
above that the cell is integer
l_capacity_up
congested.
The Nominal capacity, which
network_nomina
below that the cell is not integer
l_capacity_down
congested.
Location of the cell, the top
cell_zone varchar 255
level in the hierarchy
Location of the cell, the
cell_region varchar 255
middle level in the hierarchy
Location of the cell, the
cell_city varchar 255
lowest level in the hierarchy
Properties
Filters No
11-7
Appendices
Source System to be supplied by customer
Source
Source Path TBD
Fields Structure
Field Name Description Type Max Length Key?
network_access_ The network access
varchar 32 Y
technology_key technology identifier
network_access_
Name of the network access
technology_nam varchar 255
technology
e
Properties
Formatting Issues No
Filters No
11-8
Appendices
Source Path TBD
Fields Structure
Field Name Description Type Max Length Key?
sgsn_ip_address IP address varchar 40 Y
11-9