Notice

Legal notices
Publication Date
February 2021

Copyright
Copyright © 2013-2020, Nozomi Networks. All rights reserved.
Nozomi Networks believes the information it furnishes to be
accurate and reliable. However, Nozomi Networks assumes no
responsibility for the use of this information, nor any infringement of
patents or other rights of third parties which may result from its use.
No license is granted by implication or otherwise under any patent,
copyright, or other intellectual property right of Nozomi Networks
except as specifically described by applicable user licenses. Nozomi
Networks reserves the right to change specifications at any time
without notice.
 | Table of Contents | v

Table of Contents

Legal notices.......................................................................................... iii

Chapter 1: Preliminaries.........................................................................9
Prepare a Safe and Secure Environment...................................................................................10

Chapter 2: Installation.......................................................................... 11
Installing a Physical Appliance....................................................................................................12
Installing on Virtual Hardware..................................................................................................... 12
Installing the Container............................................................................................................... 14
Setup Phase 1.............................................................................................................................16
Setup Phase 2.............................................................................................................................18
Additional settings....................................................................................................................... 20

Chapter 3: Users................................................................................... 25
Users Introduction....................................................................................................................... 26
Managing Users.......................................................................................................................... 27
Managing Groups........................................................................................................................ 30
Password policies........................................................................................................................32
Active Directory Users.................................................................................................................35
SAML Integration.........................................................................................................................37

Chapter 4: Basics..................................................................................39
Environment................................................................................................................................. 40
Asset............................................................................................................................................ 40
Node............................................................................................................................................ 40
Session........................................................................................................................................ 41
Link.............................................................................................................................................. 41
Variable........................................................................................................................................ 42
Vulnerability................................................................................................................................. 42
Query........................................................................................................................................... 42
Protocol........................................................................................................................................ 43
Incident & Alert............................................................................................................................43
Trace............................................................................................................................................ 44
Charts.......................................................................................................................................... 45
Tables.......................................................................................................................................... 46
Navigation through objects..........................................................................................................46

Chapter 5: User Interface Reference...................................................49

Supported Web Browsers........................................................................................................... 50
Navigation header....................................................................................................................... 50
Dashboard................................................................................................................................... 51
Alerts............................................................................................................................................ 55
Asset View...................................................................................................................................56
Network View...............................................................................................................................58
Process View...............................................................................................................................73
Queries........................................................................................................................................ 77
Reports........................................................................................................................................ 80
Time Machine.............................................................................................................................. 85
 | Table of Contents | vi

Vulnerabilities...............................................................................................................................88
Settings........................................................................................................................................ 89
System....................................................................................................................................... 110
Continuous Traces.................................................................................................................... 122

Chapter 6: Security features.............................................................. 125

Security Control Panel.............................................................................................................. 126
Security Configurations............................................................................................................. 126
Manage Network Learning........................................................................................................ 131
Alerts.......................................................................................................................................... 135
Custom Checks: Assertions...................................................................................................... 136
Custom Checks: Specific Checks............................................................................................. 138
Alerts Dictionary........................................................................................................................ 140
Incidents Dictionary................................................................................................................... 148
Packet rules...............................................................................................................................150
Hybrid Threat Detection............................................................................................................ 154

Chapter 7: Vulnerability Assessment................................................155

Basics........................................................................................................................................ 156
Passive detection...................................................................................................................... 157
Configuration..............................................................................................................................158

Chapter 8: Smart Polling.................................................................... 159

Strategies................................................................................................................................... 160
Plans.......................................................................................................................................... 160
Extracted information.................................................................................................................163

Chapter 9: Queries.............................................................................. 165

Overview.................................................................................................................................... 166
Reference.................................................................................................................................. 167
Examples................................................................................................................................... 177

Chapter 10: Maintenance....................................................................181

System Overview.......................................................................................................................182
Data Backup and Restore.........................................................................................................183
Reboot and shutdown............................................................................................................... 186
Software Update and Rollback................................................................................................. 187
Data Factory Reset................................................................................................................... 189
Full factory reset with data sanitization.....................................................................................189
Host-based intrusion detection system..................................................................................... 189
Action on log disk full usage.....................................................................................................190
Support...................................................................................................................................... 190

Chapter 11: Central Management Console.......................................191

Overview.................................................................................................................................... 192
Deployment................................................................................................................................ 193
Settings...................................................................................................................................... 195
Connecting Appliances.............................................................................................................. 195
Troubleshooting......................................................................................................................... 196
Propagation of users and user groups..................................................................................... 197
CMC connected appliance - Date and Time............................................................................ 197
Appliances List.......................................................................................................................... 198
Appliances Map......................................................................................................................... 200
HA (High Availability)................................................................................................................ 202
 | Table of Contents | vii

Alerts.......................................................................................................................................... 204
Functionalities Overview............................................................................................................205
Updating.....................................................................................................................................206
Single-Sign-On through the CMC............................................................................................. 206

Chapter 12: Remote Collector............................................................209

Overview.................................................................................................................................... 210
Deployment................................................................................................................................ 211
Using a Guardian with connected Remote Collectors.............................................................. 215
Troubleshooting......................................................................................................................... 217
Updating.....................................................................................................................................218
Disabling a Remote Collector................................................................................................... 218

Chapter 13: Configuration.................................................................. 219

Features Control Panel............................................................................................................. 220
Editing Configuration files..........................................................................................................220
Basic configuration rules........................................................................................................... 221
Configuring the Garbage Collector............................................................................................228
Configuring alerts...................................................................................................................... 229
Configuring nodes..................................................................................................................... 230
Configuring links........................................................................................................................ 232
Configuring variables................................................................................................................. 234
Configuring protocols.................................................................................................................237
Configuring decryption...............................................................................................................242
Configuring trace....................................................................................................................... 244
Configuring Time Machine........................................................................................................ 246
Configuring retention................................................................................................................. 247
Configuring Bandwidth Throttling.............................................................................................. 249
Configuring Remote Collector Bandwidth Throttling................................................................. 250
Configuring the CMC synchronization.......................................................................................251
Configuring session hijacking protection...................................................................................253
Configuring UDP Flood Detection............................................................................................. 254

Chapter 14: Compatibility reference................................................. 255

SSH compatibility...................................................................................................................... 256
Chapter

1
Preliminaries
Topics: In this chapter you will receive preliminary information to get a
Guardian or a CMC properly and securely installed.
• Prepare a Safe and Secure
Environment
Prepare a Safe and Secure Environment
Before starting the installation process, some preliminary information need to be checked to ensure
optimal and secure operation of the system.
If you are installing a physical appliance, install it in a location that has been physically secured and to
which only authorized personnel can have access. Observe the following precautions to help prevent
potential issues for property damage, personel injury or death.
• Do not use damaged equipment, including exposed, frayed or damaged power cables.
• Do not operate the appliance with any covers removed.
• Choose a suitable location for the appliance: it should be situated in a clean, dust-free area that is
well ventilated. Avoid area where heat, electrical noise and electromagnetic fields are generated.
Avoid areas where it can get wet. Protect the appliance from liquid intrusion. If the appliance gets
wet disconnect power to the appliance.
• Use a regulating uninterruptible power supply (UPS) to protect the appliance from power surges,
voltage spikes and to keep your system operating in case of a power failure.
• A reliable ground must be maintained at all times. To ensure this, the rack itself should be grounded
and the appliance chassis should be connected for grounding to the rack via the provided appliance
grounding cable.
• It should be mounted into a rack or otherwise placed so that the amount of airflow required for safe
operation is not compromised.
• If mounted into a rack it should be placed so that a hazardous condition does not arise due to
uneven mechanical loading.
If you are installing a virtual appliance, contact your virtual infrastructure manager to ensure that all
the possible precautions are put in place to guarantee that the system's console is only accessible to
authorized personnel only.
The appliance's management port should get an IP address assigned in a dedicated management
VLAN, so that access to it can be controlled at different levels and restricted only to a selected set of
hosts and people.
Before connecting any SPAN/mirror port to the appliance, ensure that the configuration on the switch/
router/firewall or other networking device has been set in order to allow only traffic in output. The
appliance's ports are configured in order to read only the traffic and not inject any packet, however to
prevent any human error (e.g. a span port cable put into the management port) it's useful to check that
no packet can be injected from those ports.
Chapter

2
Installation
Topics: In this chapter you will receive the fundamental information
necessary to get both Nozomi Networks Solution physical and
• Installing a Physical Appliance virtual appliances up and running.
• Installing on Virtual Hardware
Further information on additional configuration is given in the
• Installing the Container Configuration chapter.
• Setup Phase 1
Maintenance tasks are described in the Maintenance chapter.
• Setup Phase 2
• Additional settings
 | Installation | 12

Installing a Physical Appliance

If you have purchased a physical appliance from Nozomi Networks, it is already configured with the
latest stable release of Nozomi Networks Solution N2OS.
The first phase of the configuration needs to attach to the serial console of the appliance, using a null-
modem serial cable. N1000, N750 and P500 appliances use an RJ45 Console plug, NSG-L and NSG-
M Series have a USB serial plug, while the R50 and R150 need a DB9 serial plug.
Once the cable is connected, open a terminal emulator, that can be Hyper Terminal or Putty on
Windows and cu or minicom on macOS and other *nix platforms.
Connect setting the speed to 9600 bauds and no parity bit set. The appliance will show a login prompt.
Now proceed to the section Setup Phase 1 on page 16.

Installing on Virtual Hardware

Installation on Virtual Hardware has been tested on a variety of OVA-compatible environments.
However, the current release of N2OS officially supports these hypervisors:
1. VMware ESXi 5.5 or newer
2. HyperV 2012 or newer
3. XEN 4.4 or newer
4. KVM 1.2 or newer
The minimum requirements for a Guardian Virtual Machine (VM) resources are:
• 4 vCPU running at 2 Ghz
• 4 GB of RAM
• 10 GB of minimum disk space, running on SSD or hybrid storage (100+ GB of disk recommended)
• 2 or more NICs (maximum number depends on hypervisor), one will be used for management and
the 1 or more other for traffic monitoring
Ensure that all these resources are provided in healthy conditions. Overall hypervisor load must be
under control and no ballooning should regularly occur on the Guardian VM, otherwise unexpected
behavior of the system may be experienced, such as dropped packets or overall poor system
performance.

Virtual Machine Sizing

The following tables list the minimum size requirements for Guardian and CMC instances when they
run on virtual machines. These values are based on assumed amounts of nodes and throughput.
Consider these recommendations as a starting point for calculating the best size for your VM.
Differences in your distribution of protocols and hypervisor hardware may require you to choose
different settings.

Guardian Sizing Recommendations

Small Guardian Instances

Min Max Max Throughput Min vCPU Recommended RAM Min Disk
Model Nodes (Mbps) vCPU (GB) (GB)
V100 100 50 2 4 4 20
V100 100 250 4 6 4 20
V100 100 500 6 8 6 20
V100 100 1000 8 10 8 20
V100 250 50 2 4 4 20
 | Installation | 13

Medium Guardian Instances

Min Max Max Throughput Min vCPU Recommended RAM Min Disk
Model Nodes (Mbps) vCPU (GB) (GB)
V100 250 250 4 6 4 20
V100 250 500 6 8 6 20

Large Guardian Instances

Min Max Max Throughput Min vCPU Recommended RAM Min Disk
Model Nodes (Mbps) vCPU (GB) (GB)
V100 250 1000 8 10 8 20
V100 1000 50 2 4 4 50
V100 1000 1000 8 10 8 100
V100 2500 1000 8 10 8 250
V250 5000 500 6 8 12 250
V250 5000 1000 8 10 12 250
V750 10000 500 6 8 16 250
V750 10000 1000 8 10 16 250
V1000 40000 1000 8 10 24 250

CMC Sizing Recommendations

The following table suggests sizes for instances running the CMC.

CMC Instances

Number of Mode vCPU RAM (GB) Min Disk

Appliances
25 Multi-context 4 8 100+ GB
25 All-in-one 8 32 100+ GB
50 Multi-context 6 12 200+ GB
50 All-in-one 16 64 200+ GB
100 Multi-context 10 16 1+ TB
250 Multi-context 12 32 1+ TB
500 Multi-context 16 64 1+ TB

Installing the Virtual Machine

In this section we will cover the installation of the Virtual Machine into the hypervisor. A running VM
will be obtained, however further configuration enabling external access will be provided in subsequent
sections.
In order to proceed you should be familiar with importing OVA Virtual Machine in your hypervisor
environment. Should this not be the case, please refer to the manual or support service of your
hypervisor.
1. Import the Virtual Machine into the hypervisor and configure resources according to the minimum
requirements specified in the previous section.
 | Installation | 14

2. After importing the VM, go to the hypervisor settings of the VM disk and set a desired size. Some
hypervisors, for instance VMware ESX >= 6.0, allow to change the disk size at this stage. With
hypervisors that do not allow this operation, you must STOP HERE with this section and proceed
with instructions contained in Adding a secondary disk to Virtual Machine on page 14.
3. Boot the VM. It will now boot into a valid N2OS environment.
4. Login as admin
You will be instantly logged in, no password is set by default.
5. Go to privileged mode with the command:

enable-me

You will now be able to perform changes into the system.

Adding a secondary disk to Virtual Machine

In this section we will cover how to add a bigger virtual data disk to the N2OS VM, in case the
main disk could not be grown during the first import. In order to proceed you should be familiar with
managing virtual disks in your hypervisor environment. Otherwise please refer to the manual or support
service of your hypervisor.
1. Add a disk to the VM and restart it
2. In the VM console, use the following command to obtain the name of the disk devices:

sysctl kern.disks

3. Assuming ada1 is the device disk added as secondary disk (note that ada0 is the OS device),
execute this command to move the data partition to it

data_move ada1

Adding a monitoring interface to the Virtual Machine

By default the VM has one management network interface and one monitoring interface. Depending on
deployment needs, it may be useful to add more monitoring interfaces to the appliance. To add one or
more interfaces, follow these steps:
1. If the VM is powered on, shut it down
2. Add one or more network interfaces from the hypervisor configuration
3. Power on the VM
The newly added interface(s) will be automatically recognized and used by the Guardian.

Installing the Container

The Container enables to install the Nozomi Networks Solution on embedded platforms like switches,
routers and firewalls with a Container Engine onboard.
It's also a good platform for tightly integrated scenarios where several products have to interact on the
same hardware platform to provide a unified experience.
For all the remaining use cases, a Physical Appliance or a Virtual Appliance are the recommended
options.
 | Installation | 15

Install on Docker
After these steps we'll have an image ready and a running container based on it.
A prerequisite for the steps below is to have Docker installed. We have tested with version 18.06 and
18.09.
The image can be built from the directory containing the artifacts with the command:
docker build -t n2os .
Once the image has been built, it can be run using for instance this command:
docker run --hostname=nozomi-sga --name=nozomi-sga --
volume=<path_to_data_folder>:/data --network=host -d n2os
where <path_to_data_folder> is the path to a volume where the appliance's data will be stored,
and saved for future runs.
The image has been built to automatically monitor all network interfaces shown to the container -- and
the network=host setting will allow to access all network interfaces of the host computer.
The container can be stopped anytime with:
docker stop nozomi-sga
and executed with
docker start nozomi-sga

Additional Details
The Container has the same features provided by the Physical and Virtual Appliances. A key difference
is that provisioning of "system" settings must be performed from Docker commands, and thus are not
editable from inside the container itself. A notable example is the hostname: it has to be set when
launching a new instance of the image.
It is mandatory to use volumes for the /data partition to make sure that data will survive to updates of
the image.
To update a container, build the new version of the n2os image, stop and destroy the current running
containers and start a new one with the updated image. Data will be automatically migrated to the new
version.
The network=host Docker parameter allows to let the container monitor the physical NICs of the
host machine. However, by default it will let the container monitor all the available ones. To restrict to
a subset, create a cfg/n2osids_if file into the /data volume with the list of interfaces to monitor
separated by comma (e.g: eth1,eth2).
Container version build can be customized using the following variables which can be passed to docker
build command using the --build-arg command line switch, for example: docker build --
build-arg APT_PROXY=x.x.x.x:yy -t n2os ..

Parameter Default Description

value
APT_PROXY none Proxy to be used to download container
packages
N2OS_HTTP_PORT 80 Specify custom http web port
N2OS_HTTPS_PORT 443 Specify custom https web port
 | Installation | 16

Setup Phase 1
We will now setup the very basic configuration needed to start using the Nozomi Networks Solution.
After these steps the system will have the management interface setup and reachable as text console
via SSH and as web console via HTTPS.
We assume that Nozomi Networks Solution has already been installed and ready to be configured
for the first time. Depending on the case, a serial console must be used in this phase (for Physical
Appliances) or the text hypervisor console (for Virtual Appliances).
1. The console will display a prompt with the text "N2OS - login:". Type admin and then press [Enter].
In the Virtual Appliance, you will be instantly logged in, as no password is set by default. In Physical
Appliances, nozominetworks is the default password.
2. Elevate the privileges with the command: enable-me
3. Now launch the initial configuration wizard with the command: setup

4. You will be prompted to choose the admin password first. Select a strong password as this will allow
the admin user to access the appliance through SSH.

5. Secondly, you will need to setup the management interface IP address. Select the "2 Network
Interfaces" menu in the dialog.

6. Now you will need to setup the management interface IP address. Depending on the appliance
model, the management interface can be named em0 or mgmt. Select it and press [Enter].
 | Installation | 17

7. Edit the values for IP address (ipaddr) and Netmask (netmask). Enable DHCP to configure all
automatically. Then move up to "X. Save/Exit" and press [Enter].

8. Now select "Default Router/Gateway" from the menu, and enter the IP address of the default
gateway. Press [Tab] and then [Enter] to save and exit.

9. Now select "DNS nameservers" from the menu, and configure the IP addresses of DNS servers.

10.Move up to "X Exit" and press [Enter].

11.The basic networking setup is done; the remaining steps will be performed by opening the web
console running on the management interface.
 | Installation | 18

Setup Phase 2
This second phase of the setup will be performed with the web console. Before starting to use the web
console, be sure to use one of the supported web browsers.
The web console can be accessed pointing at https://<appliance_ip> where <appliance_ip>
is the IP address assigned to the management interface. Please note that the product integrates self-
signed SSL certificates to get started, so add an exception in your browser. Later in this chapter we will
provide steps to import valid ones. You should now see the login screen:

Default username and password are admin / nozominetworks. For security reasons you will be
prompted to change these credentials at first login.
Once logged in, the remaining steps of the setup can be completed. Go to Administration >
General and change the host name.

Now fix date and time settings. Go to Administration > Date and time, and change the time
zone, set the date and (optional) enable the NTP client.
 | Installation | 19

The appliance is almost ready to be put into production: next step is to install a valid license.

License
In the Administration > Updates & Licenses page, you will need to set a new license. First
copy the machine ID, then you can use it along with the Activation Code that you have received from
Nozomi Networks to obtain a license key. Once you have a valid license key, paste it inside the text
box. After confirmation, the appliance begins to monitor the configured network interfaces.

Figure 1: The License page

 | Installation | 20

Additional settings
In this chapter some additional, non-mandatory settings of the system will be explained.

Network Flows
This section describes the basic network flows to operate the solution components.

Required Ports and Protocols

Table 1: Operator's Access to Guardian, CMC, and RC

Port Protocol Source Destination Purpose

tcp/443 https Operator Guardian/CMC Operator’s https access to Guardian/
CMC GUI
tcp/22 ssh Operator Guardian/CMC/RC Operator’s ssh access to Guardian/
CMC/Remote Collector shell

Table 2: Communications between RC, Guardian, and CMC

Port Protocol Source Destination Purpose

tcp/443 https Guardian/ CMC Sync from Guardian to CMC or between
CMC CMCs of different tiers in the hierarchy
tcp/443 https RC Guardian Sync from Remote Collector to Guardian
tcp/6000 proprietary RC Guardian Transmission of monitored traffic from
(on TLS) Remote Collector to Guardian

Install CA certificates
In this section we will add a CA certificate to an appliance: the procedure is needed to trust the
certificate exposed by nginx over HTTPS, especially to secure the communication between a CMC and
the connected appliances.
Before taking these steps:
• If your intermediate CA and Root CA certificates are in separate files, you must combine them. For
example:

cat <intermediate_root-_cert> <ca_root_cert> > cert.crt

• Copy your certificate to /data/tmp. The certificate must be in PEM format. Neither DER nor
PKCS#12 formats are supported.
1. Upload the CA certificate file to the appliance with an SSH client in the /data/tmp folder. For
example, given you have cert.crt file, open a terminal, cd into the directory and then upload

scp cert.crt admin@<appliance_ip>:/data/tmp

2. Log into the text-console, either directly or through SSH then elevate the privileges

enable-me

3. Execute the script n2os-addcacert

n2os-addcacert cert.crt

Now the imported CA certificate is trusted by the appliance and could be used to secure the HTTPS
communication from a connected appliance to a CMC as described in Connecting Appliances on
page 195.
 | Installation | 21

Install SSL certificates

In this section we will import a real SSL certificate into the appliance, needed to securely encrypt all
traffic between client computers and the N2OS appliance over HTTPS.
The N2OS webserver that exposes the HTTPS interface is nginx. Before starting, be sure you have
a certificate and a key file that are both compatible with NGINX; name them https_nozomi.crt and
https_nozomi.key. If the certificate is password-protected, you must remove the password before using
the certificate with the appliance; the following steps include the necessary command.
1. Upload the certificate and key file to the appliance with an SSH client in the /data/tmp folder.
For example, given you have https_nozomi.crt and https_nozomi.key in the same folder, open a
terminal, cd into it and then upload

scp https_nozomi.* admin@<appliance_ip>:/data/tmp

2. Log into the text-console, either directly or through SSH then elevate the privileges

enable-me

3. If your certificate is protected by a password, remove it so that you aren't prompted for it each time
the server restarts.

openssl rsa -in <private_ssl_certificate_key> -out https_nozomi.key

4. Execute the command n2os-addtlscert

n2os-addtlscert https_nozomi.crt https_nozomi.key

5. Now restart nginx by issuing the command

service nginx restart

6. Verify that the certificate is correctly loaded by pointing your browser to https://
<appliance_ip>/ and checking that the certificate is now recognized as valid.
7. We can safely save the new setup by issuing this command in the console

n2os-save

Now the imported SSL certificates are correctly working and will be applied also on next reboot.

Enabling SNMP
Monitoring the health state of the Nozomi Networks Solution appliance is important. This can be
performed in a standard manner by enabling the SNMP daemon.
The current SNMP daemon supports versions v1, v2c and v3. This feature is not available in the
container version.
Please log into the text-console, either directly or through SSH, and issue the following commands.
1. Elevate the privileges with the command: enable-me
2. Use vi or nano to edit /etc/snmpd.conf
3. Edit the location, contact and community variables. For community, choose a strong
password.
4. Provide other variables's value, if needed. For example for SNMP v3 User-based security Model
(USM), uncomment the following lines to create a user "bsnmp" and set privacy and encryption
options to SHA256 message digests and AES encryption for this user:

engine := 0x80:0x10:0x08:0x10:0x80:0x25
snmpEngineID = $(engine)

user1 := "bsnmp"
user1passwd :=
0x22:0x98:0x1a:0x6e:0x39:0x93:0x16: ... :0x05:0x16:0x33:0x38:0x60
 | Installation | 22

begemotSnmpdModulePath."usm" = "/usr/lib/snmp_usm.so"
%usm

usmUserStatus.$(engine).$(user1) = 5
usmUserAuthProtocol.$(engine).$(user1) = $(HMACSHAAuthProtocol)
usmUserAuthKeyChange.$(engine).$(user1) = $(user1passwd)
usmUserPrivProtocol.$(engine).$(user1) = $(AesCfb128Protocol)
usmUserPrivKeyChange.$(engine).$(user1) = $(user1passwd)
usmUserStatus.$(engine).$(user1) = 1

5. Change the previous user1passwd variable. Launch the bsnmpget command and convert the SHA
or MD5 output to exe format:

sh -c "SNMPUSER=bsnmp SNMPPASSWD=<newpassword> SNMPAUTH=<sha|md5>

SNMPPRIV=<aes|des> bsnmpget -v 3 -D -K -o verbose"

echo <SHA output> | sed 's/.\{2\}/:0x&/g;s/^.\{6\}//g'

6. Now edit the /etc/rc.conf file to add the line

bsnmpd_enable="YES"

7. Start the service with the command

service bsnmpd start

8. Save all settings by issuing the command

n2os-save

9. In the USM case with the default values provided by the /etc/snmpd.config file, check the
functionality with a command similar to:

snmpstatus -v3 -u bsnmp -a SHA -A <password> -x AES -X <password> -l

authPriv <appliance_ip>

Configuring internal firewall

The Full Stack edition (aka Physical and Virtual Appliances, not Container) comes with the possibility to
restrict access to the management interface, ssh terminal, snmp service and icmp protocol.
To limit access to these services you just need to add the required configurations in the /data/cfg/
n2os.conf.user file.
Default settings permit connections from any ip addresses. The system completely ignores lines
containing invalid ip addresses.
Pay attention when changing internal firewall rules because you can lose access to device
administration interface. If something goes wrong console access will be required to fix the
rules.
These are the configuration settings which allow you to fine tune the firewalling rules.

Parameter Description
system firewall icmp Configure acl for icmp protocol
system firewall https Configure acl for http and https services
system firewall ssh Configure acl for ssh service
system firewall snmp Configure acl for snmp service

Please log into the text-console, either directly or through SSH, and issue the following commands.
1. Use vi or nano to edit /data/cfg/n2os.conf.user
 | Installation | 23

2. Add the required configuration lines. For example the following line will allow connections only from
the networks 192.168.55.0/24 or from the host 10.10.10.10.

system firewall https 192.168.55.0/24, 10.10.10.10

3. Write configuration changes to disk and exit the text editor.

4. Apply new settings using the following command

n2os-firewall-update

Ipv6 setup
The Full Stack edition (aka Physical and Virtual Appliances, not Container) comes with the possibility to
be accessed via ipv6.
In order to enable ipv6 on the management interface you need to issue the following command

n2os-setupipv6

and then reboot the appliance. After reboot the address can be retrieved using a system command
such as ifconfig
After the above operations it will be possible to access to the appliance UI by enclosing the address in
the squared brackets, as shown in the following screenshot.

Figure 2: Access a Guardian via ipv6 address

Similarly, appliances may be configured to sync towards a CMC or another appliance in HA specifying
the ipv6 address in square brackets.

Figure 3: HA connection for two CMC.

Chapter

3
Users
Topics: In this section all aspects related to users authentication and
authorization will be covered.
• Users Introduction
You will be guided on the following:
• Managing Users
• Managing Groups 1. Understand different types of available users (Local, Active
• Password policies Directory, SAML).
• Active Directory Users 2. Setup and define local users.
3. Setup groups and define allowed nodes and sections.
• SAML Integration
4. Configure Active Directory and import users and groups.
5. Configure SAML and import users.
 | Users | 26

Users Introduction
Users provide a way to define both authentication and authorization policies within Nozomi Networks
Solution.
Three different users types are available that differ mainly for the different authentication procedures
and for the way in which users are typically inserted. The available user types are:
1. Local Users: Authentication is enforced with a password, and the user is created from the web
console.
2. Active Directory Users: Authentication is managed by Active Directory. User's properties and
groups are also imported from Active Directory. In order to work properly Active Directory needs to
be configured in the Nozomi web console (see Configuring Active Directory Integration using the UI
on page 35).
3. SAML Users: Password is not required since Single Sign On Authentication is enforced through
an authentication server that uses SAML. Users can be inserted via the web console or imported
from a CSV file. In order to work properly a SAML application needs to be properly configured in the
Nozomi web console (see SAML Integration on page 37).
Authorization policies are defined using the groups.
Each group define two aspects:
• A list of allowed features.
• A filter to enable visualization only of specific nodes subsets.
When an user belongs to a group, the user can perform only the operations allowed by the group and
can see only the nodes that respect the group node filter.
A user can belong to several groups and inherits the authorizations of all the groups to which the user
belongs. Therefore, when a user belongs to more than one group, each node will be visible if it satisfies
the filter of just one of the groups and its features will be availble if it is available in just one of the
groups.
Two specific group types are available with already predefined authorization policies:
• Administrators: All features available.
• Authentication Only: No feature available except authentication.
When a group is not Administrators nor Authentication Only the allowed features (sections)
can be enabled/disabled individually.
 | Users | 27

Managing Users
In this section we will overview the management operations related to users.

List of users
1. Go to the Administration > Users page. Here you can see a list of all users. From the users
page it's possible to create and delete users and change the password and/or username of existing
users.

Adding an user
1. Go to the Administration > Users page.

Click on the "Add" button. You will get to this screen:

2. The first step is to select the type (source) of desired user. Typically only Local or SAML types
should be used. Active Directory can also be created but it is responsability of the operator to
ensure that the added user exists also in the Active Directory. Therefore, it is preferable to directly
import these users from Active Directory.
Once the source is selected, the kind of data to be inserted depends on the user type:
Local User Here you have to specify username, password, and the users group(s) (Groups
configuration will be covered in the next section).
SAML User Here you have to specify just username, and group(s) since a password is not required
for SAML users.
 | Users | 28

3. You can eventually change the check boxes Must Update Password, Is suspended, and Is
Expired.
4. Finally clicking "New User" will add the user.

Import SAML users

1. Go to the Administration > Users page.

Click on the "Import" button you will get an upload dialog.

2. You can then drop or select a CSV file that contains the list of the SAML users to be added. The
CSV file has to contain three comma separated fields for each row. The first field defines the user
name, the second field is the Autentication Group that has to be associated to the user (typically
is an Autentication only group), and the last field has to contain one or more groups (separated by
semicolumns) that define additional groups associated to the user (typically used to define allowed
features).
A CSV file example is as follow:

user_1,authentication_group_1,group_1;group_2
user_2,authentication_group_2,group_3

3. When import is completed you will get a message that reports the number of users that have been
correctly imported.

Edit a local user

1. Go to the Administration > Users page. Browse through the list of users and select the one
you want to edit, by selecting edit. You will get to a form like this:

2. Here you can adjust the username and update the password. Of course you will have to enter two
matching passwords to update it correctly. Clicking on the "x" button (or ESC on the keyboard) will
close this window.

Adding SSH keys to admin users

1. Using SSH public keys it is possible to login to SSH console without having to type the password.
To configure SSH password-less authentication you must add SSH public keys to the user account
through the Administration > Users page.
 | Users | 29

In the user list you will find a key icon which will allow you to add SSH keys:

In the form you will find the required fields for ssh key based authentication:

2. To allow authentication using SSH keys you'll just need to paste the public keys in the first field.
Every admin user can have its own keys. If you need more than one key you can just paste them
one per line. Non admin users are not allowed to use password less ssh authentication. When an
admin user expires the associated SSH keys will be removed.
Make sure that the pasted key doesn't contains new lines. The system won't use invalid keys.
Enabling the second option will allow you to login using the root account.
SSH public keys will be propagated to the attached appliances or CMC. Default keys replica
updates interval is 30 minutes. This behaviour can be changed via ssh_key_update interval
setting in n2os.conf.user file.
 | Users | 30

Managing Groups
In this section we will overview the management operations related to user groups, changing the
sections of the platform the user can access.

List of groups
1. Go to the Administration > Users page and select the Groups tab.

Adding a local group

1. Go to the Administration > Users page. Select the Groups tab.

2. Click the "Add" button. You will get to the following screen:

Then, under "General" tab, the following data has to be defined:

3. Define the group name and define if the group has to be propagated to the connected appliances.
 | Users | 31

4. Define if the group belongs to one of the predefined types, Admin or Authentication only,
enabling the respective check boxes. If none of the two check boxes is selected the user does not
belong to any of the predefined types and the allowed features have to be defined manually (see
below)
5. If the group does not belong to one of the predefined types you will have to select one or more
section(s) that the group will be allowed to view and to interact with.
Optionally, under "Filters" tab (visible on the right of previous screen), you can:
• define "Zone filters" by picking one or more from the list, to limit zones visibility for a group;
• define "Node filters" by entering a list of subnet addresses in CIDR format and separated by
comma. This limits the nodes a user can view in the Nodes, Links, Variables list, Graph, Queries
and Assertions;
• define "Allowed appliances" by selecting ones that users can access to and see data coming of.
This feature is available only for CMCs and only if the "is admin" group permission is disabled.

Edit a group
1. Go to the Administration > Users page. Move to the Groups tab. Browse through the list of
groups and select the one you are wanting to edit by clicking on edit.
2. You will get to a form like the previous one used to create a group with different sections enabled or
disabled depending on the group type.
3. You can define the same data as described above.
 | Users | 32

Password policies
In this section we will provide an overview on how to manage local password policies.

Shell password policies

Passwords for local console and SSH accounts must meet the following complexity requirements. A
valid password must contain characters from these classes:
• Upper case letters
• Lower case letters
• Digits
• Other characters
They must be at least 12 characters long when they match 3 of these 4 classes, or 7 characters long
when they match all 4 classes.
Characters that form a common pattern are discarded.

Web GUI password policies

Passwords for web GUI local accounts must meet complexity requirements. By default, they must have
at least eight characters, include a combination of upper-case and lower-case letters and numbers.
The password history policy determines the number of unique new passwords that must be associated
with a user account before an old password can be reused. The password lockout policy prevents
bruteforcing attacks by disabling a user login for a fixed time after x unsuccessful attempts.
Local passwords and local user accounts can be forced to expire after a period of time. Admin
accounts can be protected from expiring. See below table for settings.
The default policies can be changed in the /data/cfg/n2os.conf.user file to best suit
organizational requirements.
Password policies can be checked using the info tooltip while adding or editing user.
 | Users | 33

Parameter Default Description

value
password_policy maximum_attempts 3 Number of unsuccessful login attempts
before user lock
password_policy lock_time 5 Number of minutes that a user account
is locked out after unsuccessful login
attempts
password_policy history 3 Number of unique password to be used
password_policy digit 1 Number of numbers that a password must
contain
password_policy lower 1 Number of lower case characters that a
password must contain
password_policy upper 1 Number of upper case characters that a
password must contain
password_policy symbol 0 Number of symbols that a password must
contain
password_policy min_password_length 12 Minimum password length
password_policy max_password_length 128 Maximum password length
 | Users | 34

Parameter Default Description

value
password_policy false Disable inactive user policy flag
inactive_user_expire_enable
password_policy inactive_user_lifetime 60 Required inactive days to force user as
disabled
password_policy admin_can_expire false This setting can prevent admin accounts
from expiring
password_policy password_expire_enable false Password expiration feature
password_policy password_lifetime 90 Required days to force password change
 | Users | 35

Active Directory Users

Besides local users, already existing users of an Active Directory domain can also be configured to
login. Moreover, their permissions can be defined upon their group.
In order to proceed with the configuration, you will need to have the following:
1. The domain name (aka pre-Windows 2000 name) (In this manual we will refer to it using
<domainname>)
2. The domain Distinguished Name (in this manual we will refer to it using <domainDN>)
3. One or more Domain Controller IP addresses. (In this manual we will refer to an IP using
<domaincontrollerip>)

Configuring Active Directory Integration using the UI

In this section we will configure the Active Directory Integration from the UI.

1. Go to the Administration > Users page. Select the Active Directory tab.
2. Enter Username and Password.
You need to prepend the Domain Name to the Username, separated by a backslash character, as
shown in the example.
3. Specify a Domain Controller IP/Hostname.
You can check if the Active Directory service is running on port 389 (LDAP) or on port 636 (LDAPS)
by using the Check Connection button and the LDAPS selector.
By default server's SSL certificate is not verified, you can enable it using the Verify SSL selector.
Should you need to add another Domain Controller IP you can click on the Add host button.
4. Specify the Domain details in Domain name and Distinguished name.
5. Optionally configure the Connection timeout
6. Save the configuration by clicking on the Save button, which will also validate the data.
If there are errors, they will be shown beside the Status field.
The Delete configuration button allows you to delete the Active Directory configuration by
removing all its variables. This action is not recoverable.

Import Active Directory Groups

This section explains how to import an existing group from an Active Directory infrastructure. This step
is fundamental to allow Active Directory users log into the system.
1. Go to the Administration > Users page. Select the Groups tab. In the Groups page, click on
the Import from Active Directory button.
 | Users | 36

2. From the import screen, start specifying a domain administrative credential. Then click on the
Retrieve groups button to retrieve the list of groups.

In the Username field type the Active Directory user logon name in the <domainname>
\<domainusername> format. You can also click on the Filter by group name checkbox and
type the name of a group you want to retrieve.
3. Now filter and select the desired groups to import. If you want to import also related groups (e.g.
parent groups) be sure to flag the checkbox near the Import button.

4. When finished, click the Import button. You will be redirected to the list of groups.

5. Now you can edit the group permissions. Active Directory users belonging to this group will be
automatically assigned to it and will inherit all permissions of the configured group.
6. After configuring Active Directory groups permissions, users can log into the system with the
<domainname>\<domainusername> user and their current domain password in the login screen.
 | Users | 37

SAML Integration
Nozomi supports SAML (Security Assertion Markup Language) Single Sign-On (SSO) authentication;
our integration requires your Identity Provider (IdP) to be compatible with SAML 2.0.
The SAML configuration process is often error-prone. This section assumes that you’re familiar with the
SAML protocol, your IdP software, and the exact details of your specific IdP implementation.
Before configuring Nozomi, define a new application in your IdP. This application should consist of:
• The Assertion Consumer Service (ACS) URL for Nozomi; an ACS specifies the /auth path. For
example, https://10.0.1.10/saml/auth
• The issuer URL for your IdP; it specifies the /saml/metadata path. For example, /saml/metadata.
The nature of this value depends entirely on your IdP.
• A metadata XML file that describes your IdP’s SAML parameters. Before configuring Nozomi,
download the file from your IdP vendor and save it to a location accessible to Nozomi.
To configure SAML integration:
1. Click the SAML tab on the Administration > Users page.

2. In the Nozomi URL field, enter the URL for your Nozomi instance. Note that the form of this URL
determines how authentication is processed. For example if the value you enter specifies HTTPS,
Nozomi uses the HTTPS protocol when processing login requests.
3. Click Load the Metadata XML file, and locate and select the metadata file provided by your IdP.
This file tells Guardian how to configure SAML parameters for use with your specific IdP solution.
4. In the SAML Role Attribute Key field, enter a string that will be used to map role names between
Guardian and your IdP. The value in this field is used to compare groups defined in Guardian with
those defined in your IdP. The nature of this value depends on your IdP. (For example, if you are
using Microsoft Office 365 as your IdP, the value might be http://schemas.microsoft.com/
ws/2008/identity/claims/role).
5. Click Save.
6. Test the integration by clicking Single Sign On on the Guardian login page; be sure to use
credentials known by your IdP.
Note: In order for SAML to work properly, groups that match the SAML roles must already exist in the
system. Groups are found using the role's name; for example, if the SAML role attribute specifies an
Operator role, the IdP looks for the Operator group when authorizing an authenticating user.
Once configured, the login page displays a new Single Sign On button:
If authentication fails, Nozomi writes errors to either:
• In Audit on page 120 page, or
• In the /data/log/n2os/production.log log file.
If it becomes necessary, click Delete configuration to entirely remove your current SAML integration.
We advise deletion only in rare cases when your authentication method changes.
Note: Nozomi doesn’t support the logout SAML protocol.
Chapter

4
Basics
Topics: In the chapter you will get introduced to some basic concepts of the
Nozomi Networks Solution and some recurring graphical interface
• Environment controls will be explained.
• Asset
You must have a solid understanding of these concepts in order to
• Node understand how to properly use and configure the N2OS system.
• Session
• Link
• Variable
• Vulnerability
• Query
• Protocol
• Incident & Alert
• Trace
• Charts
• Tables
• Navigation through objects
 | Basics | 40

Environment
The Nozomi Networks Solution Environment is the real time representation of the network
monitored by the Guardian, providing a synthetic view of all the assets, all the network nodes and the
communications between them.

Asset View
In the Asset View section are displayed all your assets, intended as single discrete endpoints. In this
section it is easy to visualize, find and drill down on asset information such as hardware and software
versions.
For more details see Asset View on page 56

Network View
In the Network View section are contained all the generic network information which are not related
to the SCADA side of some protocols like the list of nodes, the connection between nodes and the
topology.
For more details see Network View on page 58

Process View
In the Process View section are contained all the SCADA specific information like the SCADA
producers list, the producer variables with their history of values and other related information, a
section with the analysis on the variables values and some variables related statistics.
For more details see Process View on page 73

Asset
An asset in the Environment represents an actor in the network communication and, depending on the
nodes and components involved, it can be something ranging from a simple personal computer to an
OT device.
All the assets are listed in the Environment > Asset View > List section and can also be
viewed in a more graphical way in the Environment > Asset View > Diagram section which
aggregates the assets in different levels.

Figure 4: An example list of assets

Node
A node in the Environment represents an actor in the network communication and, depending on the
protocols involved, it can be something ranging from a simple personal computer to an RTU or a PLC.
All the nodes in the Environment are listed in the Environment > Network View > Nodes section
or can be viewed in a more graphical way in the Environment > Network View > Graph section.
 | Basics | 41

When a node is involved in a communication using SCADA protocols it can be a consumer or a

producer. SCADA producers can be analyzed in detail in the Environment > Process View
section.

Figure 5: An example list of network nodes

Session
A session is a semi-permanent interactive information interchange between two or more
communicating nodes.
A session is set up or established at a certain point in time, and then turned down at some later point.
An established communication session may involve more than one message in each direction.
The Nozomi Networks Solution shows the status of a session depending on the transport protocol, for
example a TCP session can be in the SYN or SYN-ACK status before being OPEN.
When a session is closed it will be retained for a certain amount of time and can still be queried to
perform subsequent analysis.
All the sessions are listed in the Environment > Network View > Sessions.

Figure 6: An example list of network sessions

Link
A link in the Environment represents the communication between two nodes using a specific protocol.
 | Basics | 42

All the links are listed in the Environment > Network View > Link section and can be viewed in
a more graphical way in the Environment > Network View > Graph section.

Figure 7: An example list of network links

Variable
The Guardian creates a variable for each used command, monitored measure and, more in general,
for each information that is accessed or modified by the SCADA/ICS system. Different characteristics
can be attached to a variable depending on the protocol that is used to access or modify it. For
instance, highly specialized protocols such as IEC-60870-5-104 will generate and update variables with
specific type and quality for each sampled value that can also determine if the sample is valid or not.
A variable has many properties, described in Process Variables on page 73 in detail. In particular,
the RTU ID and name properties will have specific values depending on the protocol, as explained in
the following section.
A recurring concept of a variable used as an universal identifier inside the system is the var_key. The
var_key is an identifier of the variable that puts together the node IP address, the RTU ID and the
name in the form <node_ip>/<RTU_id>/<name>. For instance, a variable with name ioa-2-99,
located at RTU ID 24567 and accessed with the IP address 10.0.1.2 will have a var_key equals to
10.0.1.2/24567/ioa-2-99.

Vulnerability
A vulnerability is a weakness which allows an attacker to reduce a system's information assurance.
By constantly analyzing industrial network assets against a state-of-the-art repository of ICS
vulnerabilities, the Nozomi Networks Solution permits operators to stay on top of device vulnerabilities,
updates and patch requirements.

Figure 8: The vulnerabilities

Query
The N2QL (Nozomi Networks Query Language) syntax is inspired by the most common Linux and Unix
terminal scripting languages: the query is a concatenation of single commands separated by the |
symbol in which the output of a command is the input of the next command. In this way it is possible to
create complex data processing by composing several simple operations.
 | Basics | 43

The following example is a query that lists all nodes ordered by received_bytes (in descending order):

nodes | sort received.bytes desc

For a reference of the graphical user interface or how you can create/edit queries go to the Query -
User interface reference
For a full reference of commands, data sources, and examples of the query language go to the Query -
complete reference

Protocol
In the Environment a link can communicate with one or more protocols. A protocol can be recognized
by the system simply by the transport layer and the port or by a deep inspection of its application layer
packets.

SCADA protocols mapping

All SCADA protocols are recognized by deep packet inspection and for each of them there is a
mapping that brings protocol specific concepts to the more generic and flexible Environment Variable
model.
As an example of such mappings, consider the following table:

Protocol RTU ID Name

Modbus Unit identifier (r|dr|c|di)<register address>
IEC 104 Common address <ioa>-<high byte>-<low byte>
Siemens S7 (Timer or Fixed to 1 (C|T)<address>
Counter area)
Siemens S7 (DB or DI Fixed to 1 (DB|DI)<db number>.<type>_<byte
area) position>.<bitposition>
Siemens S7 (other areas) Fixed to 1 (P|I|Q|M|L).<type>_<byte
position>.<bitposition>
Beckhoff ADS <AMSNetId <Index Group>/<Index Offset>
Target><AMSPort
Target>
and more...

Incident & Alert

An alert represents an event of interest in the observed system. Alerts can be of different kinds, for
instance they can derive from anomaly-based learning, assertions or protocol validation. In section
Alerts Dictionary on page 140 a complete list of alerts is given as a reference.
NOTE: when an alert is raised a trace request is issued.
An incident is a summarized view of alerts. When multiple alerts describe different aspects of the
same situation, N2OS's powerful correlation engine is able to group them and to provide a simple and
clear view of what is happening in the monitored system.
In section Incidents Dictionary on page 148 a complete list of incidents is given as a reference.
 | Basics | 44

Figure 9: The Alerts section

Trace
A trace is a sequence of network packets that have been processed so far and can be downloaded in
a pcap file for subsequent analysis.

The Nozomi Networks Solution shows the button with which you can download the available
traces. A trace can be generated by an alert or by issuing a trace request manually clicking on ; you
can find this icon in all the sections that are related to the trace feature. However, in order to issue a
trace, non admin users need the Trace permission.
For a detailed explanation of the traces configuration go to Configuring trace on page 244.
A continuous trace is a collection of network packets that are kept for future download. Such
collections can be requested through the GUI. The Nozomi Networks Solution will keep registering a
continuous trace from the moment it has been requested until the request is paused.

For a detailed explanation of the continuous traces go to Continuous Traces on page 122.
Some examples:

Figure 10: Some alerts with trace, click on the three

dots then on the cloud icon to download the pcap file

Figure 11: From the Links section click on the bolt icon to issue a manual trace request
 | Basics | 45

Figure 12: It is possible to send a trace request also from the graph view

Charts
Charts are often used in the Nozomi Networks Solution to show different kinds of information, from
network traffic to the history of values of a variable. Here is a brief description of the two main chart
controls.

Area charts

A The title of the chart

B The buttons to switch on and off the live update of the chart
C The time window control, click to open the historic view
D The unit of measure of the chart
E The legend, in this case the entries in the legend represent a categorization
of the traffic. It is possible to click each entry to show or hide the associated
data series in the chart

History charts

A Buttons for detaching the chart, exporting the data to an Excel or CSV file
 | Basics | 46

B The time window control

C The unit of measure
D The navigator: it is possible to interact with it using the mouse. Drag it to
change the visibility of the time window, enlarge or shrink it to change the
width of the time window

Tables
Tables are used in many sections of the Nozomi Networks Solution, for example for listing nodes or
links. Tables offer different functionalities to the user, here is a brief introduction.

Figure 13: A table with a filter and a sorting applied

A Filtering control: while typing in it the rows in the table will be updated
according to the filter
B Sorting control: clicking on it will sort the table, clicking on the same heading
twice will change the sorting direction. Press the CTRL key while clicking to
activate multiple column sorting
C The reset buttons are separated in two sections and can independently
remove the filters and the sorting from the table
D Clicking this button will update the data in the table, click on Live to
periodically update the table content
E Use this menu to hide or show the columns. In order to save space, certain
tables have hidden columns by default

Navigation through objects

The navigation icon , allows you to go directly to related objects.

Two examples:
 | Basics | 47

Figure 14: Navigation options for a node

Figure 15: Navigation options for a link

Chapter

5
User Interface Reference
Topics: In this chapter we will describe every aspect of the graphical user
interface. For each view of the GUI we attached a screenshot with a
• Supported Web Browsers reference explaining the meaning and the behavior of each interface
• Navigation header control.
• Dashboard
• Alerts
• Asset View
• Network View
• Process View
• Queries
• Reports
• Time Machine
• Vulnerabilities
• Settings
• System
• Continuous Traces
 | User Interface Reference | 50

Supported Web Browsers

To have the best experience with the Nozomi Networks Solution web console be sure to use one of the
following web browsers:
• Google Chrome version 48 and later
• Chromium version 48 and later
• Safari version 9.0 and later (for macOS)
• Firefox version 49 and later
• Microsoft Internet Explorer version 11
• Microsoft Edge version 12 and later

Navigation header
The navigation bar is always present on the top of the Nozomi Networks Solution user interface. It
enables the user to navigate through the pages and it also displays some useful information about the
status of the system.

A The sections of the Nozomi Networks Solution; by clicking on them you will
change the page
B The user menu; by clicking on it you can logout or access the Other actions
page
C The sub navigation bar with:
• the collapse button: click on it to reduce the height of the navigation bar
• the monitoring mode button: click on it to disable the auto logout
• the time machine status: it is either LIVE, if the displayed data are
realtime, or a timestamp when a time machine snapshot is loaded
• the hostname
• the N2OS version
• the NTP offset
• disk statistics, i.e., the used space and the available space
• the license information
• the language switcher

D The button that shows the administration menu.

Figure 16: The administration menu

 | User Interface Reference | 51

Dashboard
The Nozomi Networks Solution offers multiple dashboards that are fully configurable. If you want to
configure them, go to Dashboard Configuration on page 52.
On top of all dashboards there are some useful controls:
• on the left, a time selector component allows you to choose the time window for the dashboard
data. Notice that all widgets are influenced by the time selector,
• on the right, a dropdown menu and a button with the wrench icon allow you, respectively, to choose
the dashboard that you want to see and to go directly to the dashboard configuration page.

Explanation of the sections of the first default built-in dashboard

Environment information A high level view of what the Nozomi Networks Solution saw in
your network, click on a section (except Protocols) for further
details
Traffic by category A live chart of the traffic volume, divided between OT and IT
Assets Overview Assets divided in levels as per IEC 62443
Alerts flow over time Alerts risk charted over time
Situational awareness Gives you a list of evidences, ordered by severity
Latest alerts Latest alerts as they are raised
Failed assertions A list of your failed assertions

NOTE: it is possible to see more details for a section by clicking on the button (where available).
 | User Interface Reference | 52

Dashboard Configuration
Go to Administration > Dashboards and choose the widgets that you want in your dashboard
along with their position and dimensions.
Note: Only allowed users can customize the dashboard.
Note: The first time that you customize your dashboard, you will not find any dashboard defined. In the
Dashboard section you will find just the built-in templates.

Main actions
Here you can find the main actions that you can execute on dashboards.

Import The Import button allows you to choose a dashboard configuration previously
saved in your computer.
New Dashboard... After clicking on the New Dashboard... button you can choose a built-in
template to start from.

Do not specify a template if you want to start from scratch.

Choose a With this dropdown menu, when defined, you can choose the dashboard that
Dashboard you want to modify.

Dashboard actions
Here you can find the main actions that you can execute on the dashboard configuration.

+ Add row With + Add row you can add a new row to the dashboard.
History Using this feature you can restore a previously saved version of the dashboard
that you are editing.
Delete Remove the dashboard from your dashboard list.
 | User Interface Reference | 53

Edit By clicking on the Edit button you can rename the dashboard configuration and
customize the dashboard visibility.

Discard When you make some changes to the configuration and you want to discard it,
press Discard.
Clone After choosing a dashboard configuration, click on the Clone button to create a
new dashboard as a copy of the chosen one.
Export This button allows you to save the dashboard configuration to your local
computer.
Save After a change in the configuration, the Save button starts to blink and when
you click on it the new configuration is saved. As mentioned above, if you are an
admin user you will save the new default configuration for all the other users.

Row actions
In this section are explained all the actions that you can perform on a row in the dashboard
configuration page.

+ Add widget With + Add widget you can add a new widget to the row. By default it is added
after the widgets already present in the row.
Move row up/down By clicking on these buttons, you are able to move the row up or down in the
dashboard.
Delete row If you want to completely remove the row from the dashboard, you have to click
on the delete button.

Widget actions
When you want to change the aspect that a widget has in the dashboard, you can follow the
instructions below.
 | User Interface Reference | 54

Increase/decrease width With these buttons you can increase or decrease the width of the
widget.
Increase/decrease height With these buttons you can increase or decrease the height of the
widget.
Adjust height in row By clicking on this button, the height of all the other widgets in the same
row is set to the current widget's height.
Move widget before/after With these buttons you can move the widget in the row, one step left or
one step right.
Move widget up/down By clicking on these buttons, you can move the widget in the previous
or in the next row.
Delete widget If you want to completely remove the widget from the row, you have to
click on the delete button.
 | User Interface Reference | 55

Alerts
Alerts are listed in the Alerts table. The Alerts comes in two fashions: standard and expert. It is possible
to switch between the two versions by means of the buttons present at the top of the page, as shown in
the figure below.

Figure 17: Standard/Expert mode selection

Non admin users can access this section only if at least one of the groups they belong to has the Alerts
permission enabled. However, only admin users can perform actions on alerts (i.e. acknowledgment,
removal).

Figure 18: Alerts table in standard mode

Figure 19: Alerts table in expert mode

An explanation of the Alerts table (expert mode)

A The time span control enables the user to view alerts in a defined time
range.
B By selecting a grouping field the table will show all the alerts aggregated by
the selected field, for an example see the sample picture
C Clicking on the alert id will show a popup with more details.
D Clicking on the gear icon will open the learning page
 | User Interface Reference | 56

Figure 20: The Alerts table grouped by protocol and sorted by risk

Figure 21: The Alerts details popup

Asset View

Figure 22: The Assets table

In this page are listed all the Assets using a table. By clicking on an Asset link it is possible to view a
popup with some additional details about the asset.
 | User Interface Reference | 57

Figure 23: The Asset details popup

 | User Interface Reference | 58

Network View

Network Nodes

Figure 24: The Nodes table

This page shows all the nodes in the Environment.

In addition to the node information there is an Actions column which enables the user to gain more
information about a node, here is an explanation:

Figure 25: Opens the configuration popup of the node

With this popup you can set node properties. If you use the same value to override the Device ID
property for two or more nodes, they will be grouped under the same Asset.
Figure 26: Configuration popup of the node
 | User Interface Reference | 59

Figure 27: Opens a popup with only the alerts associated with the current node

Figure 28: Opens a popup with the requested traces

Figure 29: Opens a popup with the form to request a trace

Figure 30: By clicking this icon you can manage the learning of the node

Figure 31: Opens a popup that allows you to navigate to different sections

In this page are listed all the Nodes using a table. By clicking on an IP link it is possible to view a popup
with some additional details about the node.

Figure 32: The Node details popup

Network Links
 | User Interface Reference | 60

Figure 33: The Links table

This page shows all the links in the Environment.

In addition to the link information there is an Actions column which enable the user to gain more
information about a link, here is an explanation:

Figure 34: Opens the configuration popup of the link

Figure 35: Opens a popup with only the alerts associated with the current link

Figure 36: Opens a popup with the history of TCP events (Available only for TCP links)

Figure 37: Opens a popup with the urls captured from

the analyzed traffic (Available only for some protocols)

Figure 38: By clicking this icon you can manage the learning
of the link (its color depends on the learning status of the link)

Link Events

Figure 39: The link events popup

A The link availability calculated on the UP and DOWN events

B The time span control enables the user to view only the events in the
specified time range
 | User Interface Reference | 61

C The graphical history of the events, a point with value 1 represents an UP

event, a value -1 represents a DOWN event
D The history of events showed in a table

Figure 40: A schematic representation of two link downtimes: d0 and d1

How Link Availability is calculated

A history of events is stored for each link. Two events are of particular interest for computing
availability: UP and DOWN. The former occurs when an activity is detected on an inactive link, whereas
the latter occurs when an active link stops its activity. Every event has a timestamp for tracking the
precise moment at which it happened.
Guardian computes the total downtime of a link by taking the history of events in a finite time window
and summing up all the time spans starting with a DOWN event and ending with an UP event.
By default a link is considered active, therefore the availability of the link will be 100% minus the
percentage of total downtime.
Track Availability
The "Track Availability" feature allows for an accurate computation of the availability. It enables the
monitoring of the activity on the link at regular intervals, generating extra UP and DOWN events
depending on the detected activity on both sides of the link during the last interval.
To specify the interval for a Link, go to the Links table (or any other section where the Link Actions are

displayed) and click on the button, in order to open the following form.
 | User Interface Reference | 62

It is advisable to choose a value that is greater than then the expected link polling time, in order to
avoid too frequent checks that are likely to produce spurious DOWN events.
Note: link_events generation is disabled by default, to enable it use the configuration rule described in
Configuring links

Network Sessions

Figure 41: The Sessions table

In this page are listed all the Sessions using a table. By clicking on the From or To node ids additional
details about the involved Nodes are displayed. The buttons in the Actions column enable the user
to ask or to see the traces and to navigate through the UI. In the other columns there are fine-grained
information about each session, like the source and destination ports, the number of transferred
packets or bytes, etc.

Network Graph
The network graph page gives a visual overview of the network. In the graph every vertex can
represent a single network node or an ensemble of nodes, while every edge represents one or multiple
links between nodes or nodes ensembles. Edges and vertexes are annotated to give information about
the identification of the node, the protocols used in the communications between two nodes, and more.
The position of the nodes in the graph is determined by either a specific layout or a dynamic automatic
adjustment algorithm that looks for minimal overlap and best readability of the items. An overview
picture of the network graph is given below.
 | User Interface Reference | 63

Figure 42: The Main Network Graph with the auxiliary zone/topology
graph window on the left and the information pane on the right

The nature of data represented in the graph in controlled by the graph layout menu, that permits
to select the type of graph and how the nodes are assembled together in the graph. The detailed
description of the options available in the latyout menu is given below.
The user can also control the graph by zooming in and out, centering in specific zones, and get
information about specific elements by clicking on them with the mouse as described in the graph
control paragraph.
On the left and the right of the network graph two ausiliary windows are available to provide additional
information and control.
• Information pane (right). It contains additional information concerning the node or link selected in
the network graph (see graph control)
• Zone/Topology graph (left). It contains the network visualisation in terms of zone or topology. A
detailed description of the feature is provided in the Zone/Topology graph chapter
The contents of the graph can be filtered using different criteria in order to obtain a clearer
representation, or to evidence specific aspects. A detailed description of the controls available is
provided in the table and figure given below:

Figure 43: The Network Graph with the available commands

A Buttons to increase (left) or decrease (right) the node icons size. It also
affects the label size
B The button to toggle the information pane
C The button to toggle the dynamic adjustment motion of the items
 | User Interface Reference | 64

D An evidenced node. When the mouse is placed over a node the size of the
node icon is increased as well as the label
E A link
F The button to toggle the topology pane
G The button to toggle the zone pane
H When present, this icon indicates that graph filtering is active. The filter can
be one of the filters in the filter bar (see R and S below), or it can be the
zone/topology filter activated when user clicks on a Link/Node in the zone/
topology graphs
I The button that exports a PDF report containing the graph. Notice that the
graph is exported as it is currently shown on the page.
J The ? button shows the legend for link and nodes. The content of the legend
is aware of the selected perspectives.

K The button to reset all the customizations and reload the data
L The button reload the data keeping the current customizations. If the live
sliding button is put on "live" the graph is automatically periodically updated,
otherwise just a single update is performed when the use request it
M The button to filter by activity time
N The magic wand button will open a wizard to help the user to filter the graph
and view only the desired information. It contains some solutions to reduce
the amount of visualised data for big graphs.
O This button permits to configure the nodes visualisation options as described
below.
P The button permits to configure the links visualisation options as described
below.
Q The button that allows to select a graph layout.
R The button lets you select the filter types that are available in the main
network graph window. The selected filters are shown at the center top of
the graph window (S). By default no filter is selected
S This example shows the filters enabled in R. Once a filter is enabled, and
a value is inserted in the filter, the graph is automatically updated. If more
than one filter is enabled then a logical and criteria is applied; only the nodes
that satisfy all the specified filters are shown. Note that if a node passes the
filters, then all the nodes directly connected to it are shown in the graph. For
example if a specific IP filter is used, then the specified node is shown along
with all the nodes connected to it.
 | User Interface Reference | 65

Layout options
The layout define the way in which the nodes and links are shown in the graph.

Purdue model Arrange all the graph in rows and places the nodes in separate rows
according to their level. This allows to distinguish the different levels and
isolate potential problems due to communications that cross two or more
level boundaries.
Standard It is the default layout and the kind of visualization depends on Group_by
property:
• Group_by not defined: All the nodes and links are shown
• Group_by defined: All the nodes belonging to the same groups are
collpsed into a single node

Grouped The nodes are grouped according to the criteria defined in Group_by, and
the graph is visualized as following
• Group_by not defined: All the nodes and links are shown
• Group_by defined: All the nodes belonging to the same group are
shown and are placed inside a circle that represent the group, links
between nodes belonging to the same group are shown, while links
between nodes of different groups are replaced by links between groups
represented as lines that connects the circles
 | User Interface Reference | 66

Clustered The nodes are clustered according to different criteria as described below.
Once some nodes are clustered together, a single circle is shown that
represent the cluster of nodes, then when the user zoom-in the circle is
expanded and the internal nodes are shown. Possibly a cluster can contain
other subclusters and so no. This layout can be useful when visualizing
large graphs since permits to have an overall view of the graph and at the
same time visualize the details just of the part of interest without cluttering
the visualization with a mess of data that is not of interest. The way in which
the nodes are clustered depends on the value defined by Group_by:
• Group_by not defined: The nodes are clustered based on their
connections. Nodes with a large number of links tends to act as cluster
center and have neighbourg nodes assigned in the same cluster
• Group_by defined: At the highest level a cluster is created for each
group, then inside the each high level cluster some subclusters are
possibly created clustering around nodes with an high number of links.
For example if Group_by is equal to "Zones", then a cluster is created
for each zone, and inside each zone other subclusters are possibly
created around nodes with an high number of links

Group by Define the group that can possibly be used for the Standard, Grouped,
and Clustered layouts. Nodes with the chosen property (i.e. zone, subnet,
etc) are assigned to the same group, then the way in which the group is
displayed depends on the layout chosen as described above.

A couple of examples of graph with different options are given below

Figure 44: The Environment Graph with the zones pane opened with
the Group_by=Zones, Layout = Grouped and zone perspective.
 | User Interface Reference | 67

Figure 45: The Environment Graph with the zones and info pane
opened with the Group_by=Zones, Layout = Clustered. The
info pane contains information regarding the Undefined zone

Graph control
The user can move and zoom the graph using the mouse, and it is also possible to increase/decrease
the size of the icons and the text to have the better readability.

Move To move the graph click somewhere, not on a node, and start dragging
Zoom (mode 1) With the mouse inside the window, turn the mouse wheel up and down
to zoom in and out (scrolling). The zoom will be centered on the mouse
position
Zoom (mode 2) Drag in vertical direction while keeping pressed the 'z' key. The zoom will be
centered on the position where started the mouse dragging
Icon and Text Without chaging the zoom it is possible to increase/decrease the size of the
size icons and labels using the buttons identified with letter C in the figure below

Other mouse actions are also available that permits to perform additional actions.

Single click Single click on a node or a link. Fill the info pane with information
regarding the node or link selected. The kind of information displayed
depends on the nature of the node or link selected (nodes, cluster, ...)
Double click Double click on a node. Show a new window with extenden information
regarding the node or link clicked. The action can be perfromed only on
nodes not on clusters or links
Mouse over Mouse over a node or a link. Evidence the node or link
Mouse down Single click down on a node or a link without releasing the mouse
button. Evidence the selected node or link and the elements directly
connected to it

Nodes visualisation options

It permits to define which nodes are shown (filtering), and how they are shown (colouring based on
some properties)
 | User Interface Reference | 68

Perspective Change the color of the nodes according to a predefined criterion

Roles Allow you to filter the graph by node roles
Exclude IDs Remove the specified IDs from the graph view; it is possible to specify more
IDs separated by comma
ID filter The graph can be filtered by one or more ID addresses, separated by
comma
ID filter exact If checked, the ID filter will let the graph show only the nodes with exactly
match the specified ID(s) and not with a "start with" criterion
Display Choose the label formatting of the nodes
Show broadcast If checked, it includes in the graph all the nodes with a broadcast IP
Only confirmed If checked, it shows only the nodes that exchanged some data in both
nodes directions while communicating

Links visualisation options

It permits to define which links are shown (filtering), and how they are shown (colouring based on some
properties)
 | User Interface Reference | 69

Perspective Change the color of the links according to a predefined criterion

Protocols Allows the ability to filter the graph by link protocols
Enable links If checked, links will become bolder in reaction to mouse movements making
highlighting the link easier to select (may affect performance)
Show protocols If checked, every link will show its protocols
Only with If checked, it shows only the links which exchanged some data in both
confirmed data directions

Zone / Topology Graph

It provide a network visualization that describe the netwrok topology or zones The visualisation of
zone or topology graph is mutually exclusive and can be controlled with the zone and topology toggle
buttons (G and F in the figure below). Inside the zone graph each node represent a zone and each link
represent all the links between nodes in the the connected zones. When the user click on a zone the
information pane is populated with all the nodes/links that belong to the clicked zone, the main network
graph is filtered to show only the nodes and the links of the zone, and the filtering icon (H) appears.
In a similar way when a link is clicked in the zone graph the information pane is populated with all the
links between the two zones, and the networks graph shows only nodes and links that belong to one
of the two zones connected. When the user click in a region of the zone graph without any node or link
the visualisation in the network graph is resetted to show all the nodes and links.

Figure 46: The Environment Graph with the zones pane opened and the
zones perspective active to highlight the zone of origin of each node.
 | User Interface Reference | 70

The zones pane offers the ability to filter the graph by clicking on a zone or on a link between two
zones. The zones graph also has a legend and shares some of the nodes and links options. Clicking
on a node or link in the zone pane will show some additional information about the zone or the links
between the zones. See the basic configuration rules to customize Zones.

Figure 47: The Environment Graph with the transferred bytes node
perspective highlighting the high traffic usage of the consumer nodes

"Magic wand" options

The wizard help the user with several hints to improve the performance of the graph. Settings
annotated with an orange exclamation mark are considered suboptimal. Green thumbs annotate
options whose settings are considered helpful.
 | User Interface Reference | 71

Show broadcast Broadcast addresses are not actual network nodes in that no asset is
bound to a broadcast address. They are used to represent communications
performed by a node towards an entire subnet. Removing broadcast nodes
reduces the complexity of a graph.
Only with Unconfirmed links can be hidden easily to reduce the complexity of an
confirmed data entangled graph.
Only confirmed Unconfirmed nodes can be hidden to reduce the size of a large graph.
nodes
Exclude tangled Nodes whose connections cause the node to be too complex can be
nodes removed to improve the readability of the graph.
Protocols Nodes and edges can be filtered so to show only those items participating
in communications involing one of the selected protocols. By clicking on
"SCADA", all SCADA protocols are selected.
 | User Interface Reference | 72

Traffic
The Traffic tab in the Environment > Network View page shows some useful charts about
throughput, protocols and opened TCP connections.

Figure 48: The traffic charts

An explanation of the sections

A The throughput chart showing traffic divided in macro categories

B The throughput chart showing traffic for each protocol
C A pie chart showing the proportions of packets sent by protocol
D A pie chart showing the proportions of traffic generated by protocol
E The number of opened TCP connections
 | User Interface Reference | 73

Process View
The process view tab can be accessed only by users that have the Process view permission.

Process Variables

Figure 49: The process view table, showing a large number of variables

In the variables list there are many details about each variable, here is an explanation for each field:

Actions By clicking on Variable details you will open the variable details page. A
click on Add to favourites will add the variable to favourites variable list.
Host The IP address of the producer which variable belongs to
Host label The label of the variable host
RTU ID An identifier of the variable container, for an explanation of the format see
Protocol on page 43
Name The name assigned to the variable, for an explanation on how this is
calculated see Protocol on page 43
Label A configurable description, for instructions see Configuring variables on
page 234
 | User Interface Reference | 74

Type The type of the value, can be analog or digital

Value The current valid value of the variable
Last value The last observed value with an indicator showing if it is valid (green) or not
(red). By clicking on the icon the variable history chart will appear.
Last valid quality The last time the variable had a valid value quality
Last quality Last value quality
Min value The minimum value the variable has ever had
Max value The maximum value the variable has ever had
Unit The unit of measure, for instructions on its configuration see Configuring
variables on page 234
Protocol The protocol used to write or read
# Changes The number of times the variable value changed
# Requests The number of read operations
Last client The IP address of the last client querying the variable
Last FC The function code of the last operation performed
Last FC Info The function code information of the last operation performed
First activity The first time an operation was performed
Last activity The last time an operation was performed
Last change The last time an operation performed on the variable changed its value
Flow control The status of the flow control can be:
status
• CYCLIC if the variable is detected to be updated or read at regular
intervals
• NOT CYCLIC otherwise
• DISABLED if flow control has been disabled from the learning control
panel
• LEARNING if the algorithm is still analyzing the flow
When the status is CYCLIC there is a chart indicating the timing and the
average value in milliseconds.

Flow anomaly in It is true if the system has detected that an anomaly is in progress, it is false
progress otherwise. When an anomaly is in progress a Resolve button appear, by
clicking on it the user can tell the system that the anomaly has ended, if the
anomaly continue another alert is raised.

Active checks It shows the active checks enabled on the variable

History enabled A boolean flag showing if the value history is enabled for the variable

Variable details
To see the details of a variable, you can click on the magnifying glass icon beside the variable.
In the Process Variable details you can see all the info of the variable and its value history in a chart
and in a table (if it is configured as monitored, see Configuring variables on page 234).
 | User Interface Reference | 75

With the buttons above the chart, you can open the chart in another window or export the data in Excel
or CSV format.
By default, the chart shows the variable value history only for a specific period of time. Clicking on the
Live update checkbox makes the chart update in real-time.

Figure 50: The detailed view of a variable

Favorite variables
To add a variable to the favorite variables list, you can click on the star icon beside the variable.
Here you can see a chosen group of variables, those variables can also have their values plotted on
the same chart to make a comparison easier.
 | User Interface Reference | 76

Figure 51: The process view table with favourites variables on top
 | User Interface Reference | 77

Queries
All the data sources of the Nozomi Networks Solution can be queried using N2QL (Nozomi Networks
Query Language) from the query page (Analysis > Queries). In that page, you can also see all the
queries that are already saved in the running installation.
You can choose between Standard (currently offered as beta feature) and Expert, the first allows for
an easier experience, useful if you want to quickly have a look at your data, the second allows for more
complex queries but requires more expertise.

Figure 52: Choose between Standard and Expert

Go to Queries on page 165 to get a complete reference of query commands and data sources.

Query builder
The Query builder enables the user to easily create and execute queries on the observed system. To
do so just click through the different options.

Figure 53: The Query builder

While you build your query the available options change to reflect your choices, guiding you through
the process.
 | User Interface Reference | 78

Figure 54: The Query builder during a query

Query Editor
The Query Editor enables the user to execute queries on the observed system. To execute a query just
type the query text in the field and press the enter key on the keyboard.

Figure 55: The Query Editor. Some sample queries are displayed
at the beginning, clicking on them will trigger the execution

After the execution, the result will be displayed like in the figure below. If the user has enough
privileges (i.e. it belongs to a group with admin privileges), by clicking on the floppy icon on the right,
the query will be saved and displayed in the Saved Queries section, otherwise the button is disabled.
To save a query, you must specify a description and a group. The query results can be exported
by clicking on the Export button, and by choosing between the Excel or the CSV format. The
corresponding file will be produced in background (to facilitate the production of queries with large
amount of data) and it can be retrieved through the Exports List submenu, once ready. When an
export is downloaded it is automatically removed from the filesystem.

Figure 56: The Query Editor during a query

 | User Interface Reference | 79

Saved Queries
When a query is saved, it will be displayed in the Saved Queries section. Here, by using the group
selector, it is possible to change the current group and to restrict the view to the queries of the chosen
group.
Query groups, a simple but powerful method to organize the queries, can be created, renamed and
deleted only by admin users. When a group is deleted, all the queries contained in it will be eliminated.
By clicking on the pen icon, it is possible to change the description and/or the group of a query. By
clicking on the trash icon, the saved query will be deleted. As for the saving actions, the user requires
admin privileges in order to perform such operations.

Figure 57: The Saved Queries

 | User Interface Reference | 80

Reports
On the report page (Analysis > Reports), you can generate Custom Reports
Custom Reports are based on custom queries and layouts. You can define them using the Report
Management section.

Report Management
Use the Report Management section to create or edit reports.

Figure 58: Report management

On the left you can find the list of created and saved reports; the selected report is highlighted. You can
also perform some actions:
• Create a new report, by clicking on the New report... button. When you create a report, you
must specify a name and a layout, that can be empty o pre-filled.

Figure 59: New report creation

• Import an exported report, by clicking on the Import Schema button
On the right you can see the preview of the selected report. On the top you can find some action
buttons and options:
• Format: changes the report pages format
• Add page: adds a page to the layout
• Save: saves layout changes
• Edit: allows to change report name and group
 | User Interface Reference | 81

Figure 60: Edit report

• Delete: deletes the report
• Export schema: export the report
• Generate PDF: starts the Report generation
The report layout is made by a set of pages. Each page contains a set of rows; you can:
• Add a row to the bottom of the page, by clicking on the the Add row button
• Delete a row, by clicking on its trash button
• Move the row up/down, by clicking its the up/down arrow buttons

Figure 61: Report row

Each row is split in two columns; you can fill columns by adding elements, tha can be widgets and,
if you have saved queries, queries. Each element can be removed by clicking on its trash button.
Depending on the element type, it can fill one or two column and you can change the width of the
element by clicking on its reduce/enlarge buttons. Some widgets have additional options (e.g. Style
for [custom text]).

Figure 62: Report row with two single-column elements

Report generation
In the Report Management section you'll find a Generate PDF button. This button lets you generate:
• On-demand reports: generated immediately.
• Scheduled reports: generated cyclically, based on a custom recurrence. This feature is available
only for users granted the Allow editor permission. Scheduled reports can be managed through
the Scheduled Reports section.
 | User Interface Reference | 82

Figure 63: Generate PDF dialog

After report files are generated (either on-demand or scheduled), users can download them from the
Generated Reports section. When scheduling reports, you can optionally send the report files by email.

Generated Reports
After creation, both on-demand and scheduled generated reports are available in the Generated
Reports section as PDF files.

Figure 64: Generated Reports

In this section you can browse the created reports, download them, and delete them if necessary.
You can also configure report retention by clicking the Configure button. You can set the number of
days that a scheduled report remains available after it's generated, and set the maximum number of
reports that can be stored. The default values are 90 days and 500 stored reports.

Note: If the appliance runs low on disk space, the oldest reports are automatically deleted to make
room for the newest ones.

Scheduled Reports
The Scheduled Reports section displays all scheduled reports after they are set up.
 | User Interface Reference | 83

Figure 65: Scheduled Reports

In this section, you can browse the scheduled reports, edit them, and delete them if necesary. Click the
Edit button to see the available schedule settings. Edit and save these settings in order to update the
selected schedule.

Report settings

Report custom logo

You can upload a custom logo to replace the Nozomi Networks logo. After you upload your logo, you
can delete it (the Nozomi Networks logo will be restored), or upload a new one to replace it.
You can edit the report custom logo section visibility to grant or deny user access to the custom logo.
Non-administrative users can see/change the report custom logo only if they are granted the Report
and Allow editor permissions. You can edit users' reports permissions on the user groups section.

Figure 66: The Report custom logo section

Note: Using a logo of a different size than suggested by the tooltip can break the layout of generated
reports by introducing overlapping page headers.
 | User Interface Reference | 84

Report SMTP settings

You can configure SMTP settings in order to optionally receive Scheduled Reports by email.
Once enabled and saved, scheduled reports with the Email recipients field set will be sent to
the specified recipients' email addresses.

Figure 67: The Report SMTP settings section

Note: When enabled, for each scheduled report, an email will be sent starting from the next
scheduled recurrence.
 | User Interface Reference | 85

Time Machine
With the Time Machine the user can load a previously saved state (called snapshot) and go back in
time, analysing the data in the Nozomi Networks Solution from a past situation. It's possible to load a
single snapshot and use the platform as usual or load two snapshots and make a comparison in an
user interface that highlights what's changed.

Time Machine Snapshots List

Figure 68: The Time Machine Snapshots List

The snapshots periodically taken by the Nozomi Networks Solution are displayed in this table.
Snapshots can be used to go back in time to analyze the Environment status at a certain point in the
past. Moreover, they can be compared by means of a diff.

To load a snapshot

Figure 69: Load snapshot button

Click on the Load snapshot button to load a snapshot and analyze it like if you were in the past. The
user interface will become gray to highlight that you are watching a static snapshot.
Click one of the forward buttons to return to the present and watch the Environment in real time.

Figure 70: Forward button

Figure 71: Forward button in header

 | User Interface Reference | 86

To request a diff
To request a diff from the snapshots list you must select two snapshots by clicking on the plus button
shown in the figure.

Figure 72: Plus button: click on it to include the snapshot in the diff

You can exclude the frequently changing fields from the diff result by selecting the corresponding
checkboxs. The fields like the one representing a time will not influence the result anymore.

Figure 73: Check it to exclude the frequently changing fields

After the snapshots are selected just click on the diff button, the request will be processed and the
differences between the two snapshots will be shown.

Figure 74: The button to execute the diff between two snapshots

To configure retention, snapshot interval and event-based snapshot see Configuring Time Machine on
page 246.

Time Machine Diff from Alert

Figure 75: Fast diff button

Sometimes it is more convenient to request a snapshots diff starting from an alert, this automatic
feature will use the previous and the next snapshots according to the alert time.
To make such a request, just open the alert details popup by clicking on an alert ID in the alerts table
and click on the time machine diff button; you will be redirected to the diff result page.
 | User Interface Reference | 87

Time Machine Diff Result

Figure 76: Diff result, click on Show changes to see the differences

A Use these buttons to navigate between the Environment items

B Use these buttons to navigate between the subsections; in the example are
displayed the nodes with changes

In the diff result page there are four sections: Nodes, Links, Variables and Graph. In the Nodes,
Links and Variables sections there are three subsections: Added, Removed, Changed. By navigating
these sections and subsections you can observe how the Environment changed between the two
snapshots. You can see, for example, if a node has been added or if a variable value has changed. In
the next image there is a popup with the detailed changes for a single node.

Figure 77: Diff details for node

In addition to the tabular representation there is also a graph view of changes. Thanks to the graph
view and the use of colors, you can quickly spot which nodes or links have been added, removed or
have some changes. An item that has been added is green, one that has been removed is red and,
finally, one that has changes is blue. Details are shown on the right side of the graph by clicking on a
node or a link with changes.

Figure 78: Diff result as a graph

 | User Interface Reference | 88

Vulnerabilities

Figure 79: The Vulnerabilities table

This page lists all the vulnerabilities in a table. The user can filter it to show only the most likely
vulnerabilities; the likelihood threshold can be configured as shown in the picture below.

Figure 80: The most likely filter configuration form

By clicking on a CVE link it is possible to view a popup with some additional details about the
vulnerability.

Figure 81: The vulnerability details popup

 | User Interface Reference | 89

Settings

Command Line Interface (CLI)

The Command Line Interface (CLI) allows you to change some configuration parameters and to
perform troubleshooting activities.
See the Configuration section for a complete list of configuration rules.

Figure 82: The Command Line Interface executing the license_info command

Useful commands

help Show the list of available commands

history Show the commands previously entered
clear Clear the console

Keyboard shortcuts

Ctrl+R Reverse search through commands history

Esc Cancel search
Up arrow Previous entry in history
Down arrow Next entry in history
Tab Invoke completion handler
Ctrl+A Move cursor to the beginning of line
Ctrl+E Move cursor to the end of line
 | User Interface Reference | 90

Threat Intelligence
The Threat Intelligence section allows you to enrich the Nozomi Networks Solution with
additional information to improve the detection of malware and anomalies.

Figure 83: The Threat Intelligence section

The Threat Intelligence section allows you to manage Packet rules, Yara rules, STIX
indicators and Vulnerabilities.
Packet rules are executed on every packet. They raise an alert of type SIGN:PACKET-RULE if a
match is found. For an explanation of the packet rules format see Packet rules on page 150.
Yara rules are executed on every file transferred over the network by protocols like HTTP or SMB.
An alert of type SIGN:MALWARE-DETECTED is raised when a match is found. Yara rules conform
to the specifications found at YaraRules.
STIX indicators contain informations about malicious IP addresses, malware signatures or
malicious DNS domains. This information is used to enrich existing alerts, or to raise new ones.
Vulnerabilities are assigned to each node and depend on the installed software we identify in the
traffic. The Nozomi Networks Solution leverages CVE, a dictionary that provides definitions for publicly
disclosed cybersecurity vulnerabilities and exposures.
Threat Intelligence already shipped with the Nozomi Networks Solution can be enabled or disabled but
not modified or deleted. New Threat Intelligence content can always be added, edited and deleted by
the user.
 | User Interface Reference | 91

Threat Intelligence Update

Threat Intelligence can also be updated automatically by the Nozomi Networks Solution. In the
Administration > Updates & Licenses page you can monitor the status of the update. The
information shown in this page depends on whether your Guardian is connected to a CMC or it is
standalone.

When not connected to a CMC

Figure 84: Update service status

An additional license, named "Threat Intelligence", is required in order to enable the service. The
Threat Intelligence license can be added or modified using the Set new license button in the same
way as it was done for the Base license. For more information please see the corresponding section in
the license page.
Then you can configure the feature by clicking on the Update service configuration button.
You can enable Threat Intelligence to received updates automatically. As the note says, make sure
that you can reach https://nozomi-contents.s3.amazonaws.com from your Guardian / CMC, otherwise
the Nozomi Networks Solution will not be able to fetch any Threat Intelligence update; once you are
done, check that the connection can be established by clicking on the "Check connection" button.

Figure 85: Update service configuration

When connected to a CMC

Figure 86: Update service connection configuration when connected to a CMC

 | User Interface Reference | 92

In this scenario your Threat Intelligence will be managed by the CMC to which you are connected.
The Nozomi Networks Solution will synchronize them. If this is your case make sure you have Threat
Intelligence enabled on your CMC.

Connect through a proxy server

Figure 87: Update service connection configuration through a proxy server

In this scenario your Threat Intelligence will be downloaded through the configured proxy server which
requires authentication. If your Threat Intelligence updates are managed by the CMC the proxy server
will not be used.

Manual Update
If you do not have the possibility to connect your appliance or CMC to the internet you can add
brand new Threat Intelligence updates through manual update. Ask Support for the manual update
package and drop it in the area shown in the image below. After the update, the new contents will be
propagated to the attached appliances or CMC. Should you want to switch to the Threat Intelligence
online updatescontents-update-enabled you have to enable the "Nozomi Networks Update Service"
and click "Save".

Figure 88: Manual update service configuration

 | User Interface Reference | 93

Understanding if you have the latest Threat Intelligence update

Figure 89: Threat Intelligence license and status

In this screenshot there is some additional information:

• Threat Intelligence contents are up to date.
• Threat Intelligence contents version number and the timestamp when this version was installed.
To let you know about the latest changes in Threat Intelligence, we have added this information in
the navigation header; clicking there will also send you to the Administration > Updates &
Licenses page.

Figure 90: Navigation header showing the update

status and version number of Threat Intelligence
 | User Interface Reference | 94

Firewall integrations
From this section it is possible to configure several integrations with firewalls offered by Guardian:
• Fortinet FortiGate V6 on page 94
• Check Point Gateway on page 95
• Palo Alto Networks V8 on page 96
• Palo Alto Networks V9 on page 96
• Cisco ASA on page 97
• Cisco FTD on page 98
• Cisco ISE on page 98

In all these sections the provided user must have administrative privileges.
When the integration is working some policies will be produced and inserted in the firewall, these
policies will be displayed in the policies section.

Fortinet FortiGate V6
As a prerequisite to configure the integration with FortiGate V6 you need to have a REST API access
token, which can be generated directly from the firewall admin UI.
The access token needs to have permissions to insert, read and delete entities as addresses,
addrgroups, routes, sessions and policies. Additionally, the Guardian address subnet needs to be
added to the trusted hosts.
The vdom field is optional. In case you need to specify multiple vdoms, you can use ',' as a separator,
e.g. vdom1,vdom2.

Figure 91: The FortiGate V6 configuration section

In addition it is possible to tune the behaviour of the integration with these options:

Insert a new policy on If checked, new policies will be placed on top of all existing policies;
top of all policies otherwise they will be placed only on top of Guardian's policies. This option is
meaningful only in case new policies can be sent, i.e. in case nodes blocking
or link blocking are enabled
Enable nodes blocking If checked, the new nodes appearing in the environment will be blocked by
the firewall
Enable links blocking If checked, the new links appearing in the environment will be blocked by the
firewall
 | User Interface Reference | 95

Enable session kill If checked, the alerts will trigger a session kill by the FortiGate v6 for the
involved link. It is possible to choose which alert types will be considered
Keep on killing This option works in conjunction with Enable session kill. If checked,
sessions the firewall integration will kill sessions having the same source and
destination IP addresses, same destination port and protocol of sessions
already killed.
Enable logging If checked, the policies inserted will have the logging feature enabled

This integration uses the REST API, which is supported by FortiOS version 6 or higher.

Check Point Gateway

Figure 92: The Check Point Gateway configuration section

In addition it is possible to tune the behaviour of the integration with these options:

Enable nodes blocking If checked, the new nodes appearing in the environment will be blocked by
the firewall
Enable links blocking If checked, the new links appearing in the environment will be blocked by the
firewall

Figure 93: The Guardian policies inserted in the Check Point Gateway
 | User Interface Reference | 96

Palo Alto Networks V8

Figure 94: The Palo Alto V8 configuration section

Add '!' before endpoint declaration to skip SSL check.

In addition it is possible to tune the behaviour of the integration with these options:

Enable nodes blocking If checked, the new nodes appearing in the environment will be blocked by
the firewall
Enable links blocking If checked, the new links appearing in the environment will be blocked by the
firewall

Figure 95: The Guardian policies inserted in the Palo Alto v8 Firewall

Palo Alto Networks V9

Starting from version 9.0, PAN-OS provides a REST API. The Guardian integration relying on this new
API supports the same features as the previous Palo Alto integration and also the following ones:
• Commit by user: commits the current changes required by the user represented by the credentials
used for the api. Global commits are no longer performed
• Dynamic Access Groups for Node Blocking: the Dynamic Access Group references a tag which is
then assigned to new IP address objects that are created on the firewall. This will then automatically
apply the global Guardian denylist rule to each new address without having to modify the firewall
ruleset
 | User Interface Reference | 97

Figure 96: The Palo Alto v9 configuration section

Add '!' before endpoint declaration to skip SSL check.

In addition it is possible to tune the behaviour of the integration with these options:

Enable nodes blocking If checked, the new nodes appearing in the environment will be blocked by
the firewall
Enable links blocking If checked, the new links appearing in the environment will be blocked by the
firewall
Enable session kill If checked, the alerts will trigger a session kill by the firewall for the involved
link. It is possible to choose which alert types will be considered
Keep on killing This option works in conjunction with Enable session kill. If checked,
sessions the firewall integration will kill sessions having the same source and
destination IP addresses and same destination port of sessions already
killed.

Figure 97: The Guardian policies inserted in the Palo Alto v9 Firewall

Cisco ASA

Figure 98: The Cisco ASA configuration section

SSL check is always skipped.

In addition it is possible to tune the behaviour of the integration with these options:

Enable nodes blocking If checked, the new nodes appearing in the environment will be blocked by
the firewall
 | User Interface Reference | 98

Enable links blocking If checked, the new links appearing in the environment will be blocked by the
firewall
Enable session kill If checked, the alerts will trigger a session kill by the Cisco ASA for the
involved link. It is possible to choose which alert types will be considered

Figure 99: The Guardian policies inserted in the Cisco ASA

Cisco FTD
Permit to kill sessions.

Figure 100: The Cisco FTD configuration section

SSL check is always skipped.

In addition it is possible to tune the behaviour of the integration with these option:

Enable session kill If checked, the alerts will trigger a session kill by the Cisco FTD for the
involved link. It is possible to choose which alert types will be considered

Cisco ISE

The Cisco ISE configuration

The preferred method to authenticate with Cisco ISE is via certificates. Guardian supports:
• Authentication using certificates issued by the ISE internal CA
• Authentication using certificates issued by an external CA (third party certificates)
Along with the client associated with the certificate and the certificate password, you need to upload
the identity certificate and the private key.
 | User Interface Reference | 99

Figure 101: The Cisco ISE configuration using an ISE internal CA certificate

If you are using a third party certificate, you need to upload the external CA certificate as well.

Figure 102: The Cisco ISE configuration using a third part certificate

It is also possible to authenticate via username and password. If you want to use an existing client, you
have to specify the password.

Figure 103: The Cisco ISE configuration using an existing client

Otherwise you can create a new client directly from the Guardian integration configuration window
by using the Create client button once you have specified the new client name. Remember that
you need to approve the new client from the Cisco ISE pxGrid Services window. The password
returned by Cisco ISE will not be displayed, but will be kept in the Guardian configuration.
 | User Interface Reference | 100

Figure 104: The Cisco ISE configuration to create a new client

The available options are:

Enable nodes blocking If checked, the new nodes appearing in the environment will be blocked
by the firewall. Along with this option you can also choose the policy the
Guardian integration has to use. To do that you need to provide valid
connection details and use the Pull policies button before saving the
configuration.

Figure 105: The Guardian pull policies functionality

A list of policies already available in Cisco ISE will be displayed. In addition to

those, you can also choose the ANC_NOZOMI_BLOCK_IP policy. Once you
have chosen a policy for a given Guardian integration, you will not be able to
change it.

Figure 106: The Guardian policies inserted in the Cisco ISE

Troubleshooting configuration
The UI performs fields validations when the Save and the Pull policies buttons are pressed. In
case of missing fields, a warning message will be displayed. If there are any authentication errors, e.g.
wrong password or certificate mismatch, the UI will display a message detailing the reason of the error.
For further details regarding errors you may experience you can also search for the 'Cisco ISE' string in
the log file /data/log/n2os/n2osjobs.log.
 | User Interface Reference | 101

Data Integration
In this section (Administration > Data Integration) users are allowed to configure several
endpoints. Each endpoint could receive Alerts or other items depending on its configuration.

Figure 107: Some examples of configured endpoint

FireEye CloudCollector
Besides Alerts, with FireEye CloudCollector integration it is possible to send Health Logs, DNS Logs,
HTTP Logs and File transfer Logs.

IBM QRadar (LEEF)

The IBM QRadar integration permits the sending of all Alerts (and optionally Health Logs) in LEEF
format. You can also send assets information to QRadar beginning with version 2.0.0 of the QRadar
App. Clicking on How this integration works displays a window providing additional details.
 | User Interface Reference | 102

Common Event Format (CEF)

With this integration you are able to send, in CEF format, Alerts and Health Logs.

ServiceNow
This integration allows you to forward incidents and assets information to a ServiceNow instance.
Using the options below, you can decide whether sending only new incidents or also historical ones.
Additionally, you can choose if assets already existing in ServiceNow need be updated with information
present in the appliance or if assets in ServiceNow will only be created if they do not exist there yet.
Clicking on How this integration works displays a window providing additional details.
 | User Interface Reference | 103

Tanium
This integration allows you to forward assets information to a Tanium instance. Clicking on How this
integration works displays a window providing additional details.

Splunk - Common Information Model (JSON)

If you need to send Alerts to a Splunk - Common Information Model instance, you can use this kind
of integration. Data are sent in JSON format and you are also able to filter on Alerts. You can also
send Health Logs and Audit Logs. Clicking on How this integration works displays a window
providing additional details.
 | User Interface Reference | 104

SMTP forwarding
To send Reports, Alerts and/or Health Logs to an email address, you can configure an SMTP
forwarding endpoint. In this case, you are also able to filter on Alerts.
 | User Interface Reference | 105

SNMP Trap
Use this kind of integration to send Alerts through an SNMP Trap.

Syslog Forwarder
Use this kind of integration to send the captured Syslog events to a Syslog endpoint.
It is useful to passively capture logs and forward them to a SIEM.
Note: In order to enable the Syslog events capture see Enable Syslog capture feature on page 225.

Custom JSON
This type of integration sends all the Alerts to a specific URI using the JSON format.

Custom CSV
This type of integration sends the results of the specified query to a specific URI using the CSV format.
 | User Interface Reference | 106

DNS Reverse Lookup

This integration sends reverse DNS requests for the nodes in the environment and uses the names
provided by the DNS as labels for the nodes that don't have a label yet. You can pre-filter the nodes
by specifying a query filter. The strategy runs once a day, but you can run it on demand by selecting
'Rerun the strategy on all the data'.

CheckPoint IoT
This integration allows you to forward assets information and nodes blocking policies to an instance
of CheckPoint Smart Console. Clicking on How this integration works displays a window
providing additional details. This integration is available only on CMCs.
 | User Interface Reference | 107

Kafka
The Kafka integration allows you to send the results of custom queries in JSON format to existing
topics of a Kafka cluster. Clicking on How this integration works displays a window providing
additional details.
 | User Interface Reference | 108

Zone configurations
In this section (Administration > Zone configurations) network zones can be added and
configured.

Figure 108: Zones table

The page lists three kinds of zones:

• Predefined or "standard" zones are indicated with a "lock" icon: they are preconfigured and they
cannot be modified.
• User-defined zones are indicated with the "pencil" and "trash" icons: they can be edited or removed
by clicking on the corresponding icon. They can also be selected trough a checkbox.
User-defined zones can be exported. If no zone is selected, the Export all button exports all
user-defined zones, otherwise the Export selected button exports only selected zones. Some
table actions can help with the zone selection/deselection. Predefined and Auto-configured zones
cannot be exported.
User-defined zones can be imported using the Import button. After the import process, zones will
be reloaded.

Figure 109: Zone configuration import

• Auto-configured zones are indicated with a "plus" icon: they are heuristically discovered by the
engine which is able to pre-fill some fields. They may be added and futher configured by clicking on
the icon. Auto-configured zones are not used by the system until when they are explicitly added and
configured.

Figure 110: Zone configuration

 | User Interface Reference | 109

Furthermore, new custom zones may be added. The zone must be given a name that cannot contain
spaces and it must include at least a network segment. All nodes pertaining to one of the segments
of a zone inherit the properties of that zone. The following optional configuration settings are also
available for every node:
• IP network segments: these can be specified in CIDR notation (e.g. 192.168.2.0/24), or by
means of a range that includes both ends (e.g. 192.168.3.0-192.68.3.255). Segments can be
concatenated by commas.
• MAC address ranges: both ends of the range are included (e.g.
08:14:27:00:00:00-08:14:27:ff:ff:ff)
• MAC address matching fallback: one of the necessary conditions to consider a node to be part
of zone is that its node ID must match the zone network segments. There are cases where this
matching strategy is not enough, for example we may want to have nodes with an IP as node
ID match a zone defined with MAC address ranges. In those cases we can enable this fallback
matching stategy in order to match against the MAC address of the node whenever the node IP
does not match any segment.
• Matching VLAN ID: only nodes belonging to such VLAN are shown. For example, consider a zone
configured as 192.168.4.0/24, with vlan id set to 5, and two nodes within such network: 192.168.4.2
and 192.168.4.3, with only the former belonging to such VLAN. When filtering the view with this
zone, only node 192.168.4.2 will be shown.
• Assigned VLAN ID: Nodes belonging to this zone will be assigned this VLAN ID.
• Level: The level defines the position of the nodes pertaining to the given zone within the Purdue
model. Once a level has been set for a zone, all nodes included in that zone will be assigned the
same level, unless a per-node configuration has been specified as well. This means that, if two or
more zones overlap, a node belonging to all of them will inherit the level of the most restrictive zone.
• Detection approach; can be used to override the global settings from the Security Control Panel.
• Learning mode; can be used to override the global settings from the Security Control Panel.
• Security profile; can be used to override the global settings from the Security Control Panel.
 | User Interface Reference | 110

System

General
In the Administration > General page it is possible to change the hostname of the Appliance
and to specify a login banner. The login banner is optional and, when set, it is shown in the login page
and at the begingging of all SSH connections.

Figure 111: The hostname and login banner input fields

Figure 112: An example of login banner

Date and time

 | User Interface Reference | 111

Figure 113: Date and time configuration panel

From the date and time page you can:

• change the timezone of the appliance
• change the current time of the appliance (you can use the Pick a date or Set as client buttons to
set a date in a simple way)
• enable or disable the time synchronization to a NTP server by writing a list of comma-separated
server addresses
 | User Interface Reference | 112

Network interfaces

Figure 114: Network interfaces list

Actions With the configuration button, you are able to define/modify the NAT rule to
be applied to the current interface.
Interface The interface name
Is mirror It is true if the interface is likely receiving mirror traffic and not only
broadcast.
Mgmt filter When on the traffic of the appliance is filtered out. It is on by default. To
change the value see the specific configuration rule in Basic configuration
rules on page 221.
BPF filter The BPF filter applied to the sniffed traffic.
NAT The NAT rule applied to the current interface.

In this form you can set the NAT configuration and the BPF filter.
 | User Interface Reference | 113

Figure 115: Interface configuration form

In the NAT part you may configure the original subnet, the destination subnet and the CIDR mask for
the NAT rule.
In the BPF filter part you may configure the filter to apply to this interface. There are two ways to
configure the filter, via a visual editor or manually. Click the "BPF Filter editor" to open the visual editor.
Here, you can edit the most common filters.
 | User Interface Reference | 114

Figure 116: BPF filter editor

More complex filters can be inserted manually in the input box by clicking the toggle.

Figure 117: Manual insertion of a BPF filter

In the Denylist part, you can upload a text file containing a denylist, i.e., a list of IP addresses or
wildcards that will not be processed by the Guardian. The effect is similar to that of the BPF filter,
however a denylist can handle tens of thousands of IP addresses, numbers that are beyond the
capability of the BPF filter.
A denylist must contain one entry per line: a dash (-) followed by a space and an IP address (wildcards
are allowed).
For example:

- 192.168.1.* Deny 192.168.1.* and 192.168.2.1. Everything else is implicitly allowed

- 192.168.2.1

- * The first line is invalid, as it would reject all traffic: invalid lines in a matchlist
are ignored. The last line is simply redundant.
- 192.168.2.*
- 192.168.2.1
 | User Interface Reference | 115

Upload PCAPs
In the Administration > Upload PCAPs page you can play a PCAP file into Guardian, the
appliance ingests the traffic as if it came through the network.

On top, there are flags that you can use to customize the behaviour of the upload/play action.

Use PCAP timestamps Check this if you want to use the time captured in the
PCAP file. Otherwise, the current time is used.
Delete data before play Check this option if you want to delete all data in the
Appliance before running the play action.
Auto play PCAP after upload With this flag enabled, the PCAP is played immediately
after the upload.

On every single PCAP file uploaded there are some available actions as shown below.

Replay PCAP With this action you can replay the PCAP.
Edit note If you need to share some note about the uploaded PCAP.
Delete from the list Erase the PCAP file from the Appliance, no Environment data will
be affected.

Alerts can be generated as result of the usage of a PCAP. If the played file is artificial, the alerts
timestamp may be not recognised by the system. In this case, a value containing InvalidDate will be
displayed in the time column of the alert table.
Note: By default, the Appliance has a retention of 10 PCAP files. To configure this value see
Configuring retention on page 247

Import

Load CSV file

This feature allows you to add nodes and assets from scratch (flagging create non-existing
nodes) or to enrich existing ones.
 | User Interface Reference | 116

Figure 118: The import page

It is easy to bind the CSV fields to the Nozomi's one. If the CSV provides the headers in the first line
of the file be sure to flag the Has header option to view the column titles. To put the data in the right
items be sure to match the right Nozomi field with the imported data, for example if the CSV file that
has to be imported contains a list of IP addresses select the ip field in the Nozomi data field
dropdown. For each column in the CSV file to import it is possible to specify in which field the data has
to be imported by using the Nozomi field dropdown.
You can only match csv fields with Nozomi mac_address and ip fields. For matching fields binding is
disabled cause it use the matching info to bind the field. It's not possible to bind fields before choosing
a match.
Nozomi field type can only have value:
• switch
• router
• printer
• group
• OT_device
• broadcast
• computer
• cctv_camera
• PLC
• HMI
• barcode_reader
• sensor
• digital_io
• inverter
• controller
• subnet
• historian
• IED
• VOIP_phone
• mobile_phone
• tablet
• mobile_device
• WAP
• IOT_device
• light_bridge
 | User Interface Reference | 117

• firewall
• RTU
• teleprotection
• active_scanner
• radio_transmitter
• UPS
• data_concentrator
• gateway
• AVR
• DSL_modem
• IO_module
• media_converter
• NTP_appliance
• PDU
• power_line_carrier
• power_quality_meter
• protection_relay
• other
other values are not considered.
Nozomi field role can only have value:
• consumer
• producer
• engineering_station
• historian
• terminal
• web_server
• dns_server
• db_server
• time_server
• antivirus_server
• gateway
• local_node
other values are not considered.
Nozomi field zone must match with an existing zone to match, you can add a zone to make it match.

Figure 119: Binding fields

It is even possible to create and import custom fields (only for assets list).
To create a new field go to Administration > Data model and choose a name and a type for
your custom fields. After this operation the field will be available in the import page in the Nozomi
field binding dropdown.

Figure 120: Data model page

 | User Interface Reference | 118

An example of a valid CSV file.

Figure 121: CSV example

Import Rockwell Configuration

With this feature a Rockwell project file can be imported, the information written in the project file will be
added to the asset data in the Nozomi Networks Solution.

Import Yokogawa Project

With this feature a Yokogawa project file can be imported, the information written in the project file will
be added to the asset data in the Nozomi Networks Solution.

Import Siemens Step7 (S7-400) Configuration

With this feature a Siemens (S7-400) configuration file can be imported, the parsed information will be
added to the asset data in the Nozomi Networks Solution.

Import Profinet GSDML/IOCM file

You can import an XML Profinet GSDML file that describes a physical device. The information
contained in the file will allow the Guardian to extract and show information about the configuration of
the described devices when their configuration packets are seen in the traffic.
 | User Interface Reference | 119

Health
All the sections described below are available for admin user. Additionally, access is granted to all
users with Health permission.

Performance
In this tab there are three charts showing, respectively, the CPU, RAM and disk usage over time.

Figure 122: The performance charts

Health Log
The health log reports the details of any kind of performance issues the appliance experiences. In
general, logs include information such as CPU, RAM, disk space, interface status, stale appliances, or
generic high load.

Figure 123: The health log table

Types of Health Log Entry

Guardian can generate many types health log entries. For example, the log cand indicate when an
appliance:
• “is under high load”
• “is no longer under high load”
• “X% cpu usage”
• “cpu usage back to normal”
• “X% ram used”
• “ram usage back to normal”
• “X% disk space used”,
• “disk space usage back to normal”
 | User Interface Reference | 120

• “Appliance is stale”
• “Appliance is no longer stale”
• “LINK_UP_on_port_N”
• “LINK_DOWN_on_port_N”
• Log_disk_full-starting-emergency-shutdown

Audit
In the Administration > Audit page are listed all relevant actions made by users, starting from
Login/Logout action to all the configuration operations, such as learn/delete of objects in Environment.
All the recorded actions are related to the IP and the username of the user who made the action and,
as seen in the other Nozomi Networks Solution tables, you can easily filter and sort on this data.

Figure 124: The audit table

Reset Data
In the Administration > Data page it is possible to selectively reset several kinds of data used by
the Nozomi Networks Solution.

Environment All learned nodes, links and variables

Network Data All the history of network data visible in the charts
Process Data All the history of process data visible in the charts like the variables
history
Assets Data All the information related to asset (e.g. software and hardware version)
Alerts The raised alerts
Traces The traces both generated by the alert and by a user request
Time machine The snapshots saved by the time machine
Queries The queries and query groups saved by each user
Assertions The assertions saved by each user
Smart Polling Data The information discovered by Smart Polling

In addition to the usual buttons for selecting and deselecting all the checkboxes, All and None, there
is also a Only data button that selects everything but traces, queries and assertions.
 | User Interface Reference | 121

Figure 125: The reset data form

 | User Interface Reference | 122

Continuous Traces
The continuous trace page can be accessed through <Username> > Other actions >
Continuous trace. Here is where the continuous traces can be requested, managed, inspected and
downloaded. For non admin users, in order to be able to reach this section and to perform any action, it
is mandatory to belong to a group with Trace permission.

Each trace is saved in pcap files whose maximum size is 100MB. When a file has reached this
threshold, it is closed and a new file is created to keep collecting the network packets. The trace files
are saved in the hard disk of the appliance. Guardian makes sure 10% of the disk is always free. For
that reason, when the hard disk usage approaches the limit, the oldest pcap files belonging to the
continuous traces are deleted.
Traces can be stopped and resumed. When a trace is resumed, a new pcap file is created.
Continuous traces are persistable. When an appliance is restarted the continuous traces, their
collected data and their statuses are resumed automatically.
In order to request a trace, enter a BPF filter in the corresponding field and click the Start button.
From the moment the button is pressed, Guardian will begin collecting packets corresponding to the
provided filter. The filter can be left empty, in which case all packets will be collected by the requested
continuous trace.
The table at the bottom of the page shows the continuous traces that have been requested. The
following information is given:

Time The time at which the trace has been requested.

ID A unique identifier of the trace request.
User The user who requested the trace.
Packet filter The BPF filter defining the collection.
In progress Whether the collection is active or stopped.

Several actions are available to manage the traces:

Figure 126: Starts the trace collection (disabled if the trace is currently in progress)
 | User Interface Reference | 123

Figure 127: Stops the trace collection (disabled if the trace is currently paused)

Figure 128: Destroy the trace and discard all data collected

Figure 129: Download an archive containing all the pcap files belonging to the trace

Figure 130: List and download the pcap files collected by the trace
Chapter

6
Security features
Topics: In this chapter we will explain how a tailored security shield can
be automatically built by Guardian and subsequently tuned to fit
• Security Control Panel specific needs.
• Security Configurations
Once the baselining has been performed, different kinds of Alerts
• Manage Network Learning will be raised when potentially dangerous conditions are met. There
• Alerts are four main categories of Alerts, each originating from different
• Custom Checks: Assertions engines within the product:
• Custom Checks: Specific 1. Protocol Validation: every packet monitored by Guardian will
Checks be checked against inherent anomalies with respect to the
• Alerts Dictionary specific transport and application protocol. This first step is
• Incidents Dictionary useful to easily detect buffer overflow attacks, denial of service
• Packet rules attacks and other kind of attacks that aim to stress non-resilient
software stacks. This engine is completely automatic, but can be
• Hybrid Threat Detection
eventually tuned as specified in Security Configurations on page
126.
2. Learned Behavior: the product incorporates the concept of
a learning phase. During the learning phase the product will
observe all network and application behavior, especially SCADA/
ICS commands between nodes. All nodes, connections,
commands and variables profiles will be monitored and analyzed
and, after the learning phase is closed, every relevant anomaly
will result in a new Alert. Details about this engine are described
in Learned Behavior.
3. Built-in Checks: known anomalies are also checked in real
time. Similarly to Protocol Validation, this engine is completely
automatic and works also when in Learning mode, but can be
eventually tuned as specified in Security Configurations on page
126.
4. Custom Checks: automatic checks such as the ones deriving
from Protocol Validation and Learned Behavior are powerful and
comprehensive, but sometimes something specific is needed.
Here comes Custom Checks, a category of custom Alerts
that can be raised by the product in specific conditions. Two
subfamilies of Custom Checks exist and are described in Custom
Checks: Assertions on page 136 and Custom Checks: Specific
Checks on page 138.
The powerful automatic autocorrelation of Guardian will generate
Incidents that will group specific Alerts into higher level actionable
items. A complete dictionary of Alerts is described at Alerts
Dictionary on page 140 and Incidents Dictionary on page 148.
Additionally, changing the value of the Security Profile changes the
visibility of the alerts shown by Guardian based on the alerts type.
 | Security features | 126

Security Control Panel

The Security Control Panel gives an overview of the current status of the leaning process and allows
the configuration of the features that manage the learning, the security profile, the zones and the alerts
tuning.

Figure 131: The Security Control Panel overview page

The learning section shows the progress of the engine for both network and process learning. The Last
detected change and the Learning started entries will report the point in time when the last behavior
change was detected and the time when the learning is started.

Security Configurations
The security features can be configured using the "Edit" tab of the security control panel. The page
guides the user through four configuration steps that allow an advanced yet simplified customization of
the features.
 | Security features | 127

Learning

Figure 132: The learning editor

Guardian provides a flexible approach to anomaly-based detection, allowing to choose from two
different approaches:
• Adaptive Learning: uses the Asset Intelligence feed to provide a baseline known for each kind
of Asset. In this way, operators can make decisions on Alerts even though they do not know the
monitored system in detail.
• Strict Learning: uses a detailed anomaly-based approach, so deviations from the baseline will
be detected and alerted. This approach is called strict because it requires the learned system
to behave like it has behaved during the learning phase, and requires some knowledge of the
monitored system in order to be mantained over time.
The engine has two distinct learning goals: the network and the process. For both cases the engine
can be in learning and in protection mode, and they can be governed independently.
1. Network Learning is about the learning of Nodes, Links, and Function Codes (e.g. commands) that
are sent from one Node to another. A wide range of parameters is checked in this engine and can
be fine-tuned as described in Manage Network Learning on page 131.
2. Process Learning is about the learning of Variables and their behavior. This learning can be fine-
tuned also with specific checks as described in Custom Checks: Specific Checks on page 138.
With the Dynamic Window option you can configure the time interval in which an engine considers a
change to be learned (every engine does this kind of evaluation per node and per network segment).
After this period of time, the learning phase is safely automatically switched to protection mode, with
the effect of:
• raising alerts when something is different from the learned baseline
• adding suspicious components to the Environment with the "is learned" attribute set to off, in such a
way that an operator can confirm, delete or take proper action from the manage panel.
In this way, stable network nodes and segments become protected automatically thus you are not
overwhelmed with alerts due to the premature closing of learning mode.
 | Security features | 128

Security profile

Figure 133: The security profile editor

The Security Profile allows to change the visibility of alerts based on their type. By default the Security
Profile is set to High. Changing the value of the Security Profile has immediate effect on newly
generated alerts and it has no effect on existing alerts. By default the Security Profile is set to High.

Zone configurations
All settings concerning the learning engine and the security profile can be customized on a per-zone
basis. Please refer to Zone configurations for the details.

Alert tunings

Figure 134: The security profile editor

In the Tuning section of the Security Control Panel it is possible to customize the alerts behavior.
Specifically, a matching criteria can be created by imposing conditions on several fields such as IP
addresses, protocol and many others.
This feature can be selectively enabled for specific user groups.
 | Security features | 129

Figure 135: Alert tuning popup

IP source/destination Set the IP of the source/destination that you want to filter.

MAC source/destination Specify the MAC of the source/destination that you want to filter.
Match IPs and MACs in both Check this if you want to select all the communications between
directions two nodes (IP or MAC) independently of their role in the
communication (source or destination).
Zone source/destination Specify the zone of the source/destination that you want to filter.
Port source/destination Specify the port of the source/destination that you want to filter.
Type ID The type ID of the alert, this field is precompiled if you create a
new modifier from an alert in Alerts page.
Trigger ID Unique identifier corresponding to the specific condition that has
triggered the alert.
Protocol Set the protocol that you want to filter.
Note Enter free-form text that describes details of the alert rule.
Execute action Select an action to perform on the matched alerts:

Mute Switch ON/OFF: to mute or not the alert

 | Security features | 130

Change risk Set a custom risk value for the alert

Change trace filter Define a custom trace filter to apply to this
alert

Priority Set a custom priority; when multiple rules trigger on an alert, the
rule with highest priority applies. "Normal" is the default value if
no selection is made.
 | Security features | 131

Manage Network Learning

In the Manage Network Learning tab it is possible to review and manage the Network Learning status
in detail. The graph is initialized with the node and link not learned perspectives which highlight in
red or orange the items unknown to the system. In this way it is easy to discover new elements and
take an action on them.

Figure 136: The manage page with the selection on an unlearned link

A A node which is not learned

B A link which is not learned. If the link is highlighted in orange it is learned,
but some protocols in it are not
C The information correlated to the current selection, the user can select the
items in it using the checkboxes and then execute some actions. When an
item is not learned it will be red, otherwise it will be green
D With the delete button the user can remove the selected item(s) from the
system
E With the learn button the user can insert the selected item(s) in the system
F When the configuration is complete the user can make it persistent using the
save button
G The discard button undo all the unsaved changes to the system

How to learn protocols

1. Click on red or orange link, information about the selection will be displayed on the right pane
 | Security features | 132

2. Check the protocol that you want to learn. In this example we check browser. It is possible to
check more than one item at once

3. Click on the Learn button, a mark will appear on all the checked items which will be learned and
the Save button will start to blink indicating some unsaved changes

4. Click on the Save button, the protocol will be learned and it will become green. In this case also the
link will change color and become orange because some protocols are learned and some others are
not

5. Learning all remaining protocols will result in a completely learned grey link
 | Security features | 133

How to learn function codes

If a protocol is a SCADA protocol, the information pane will also display the function codes. The
procedure for learning function codes is equivalent to the procedure for learning protocols.

Figure 137: A SCADA protocol with function codes

How to learn nodes

1. Click on a red node, its information will be displayed in the right pane

2. Check the item that you want to be learned

 | Security features | 134

3. Click on the Learn button, a mark will appear on all the checked items which will be learned and
the Save button will start to blink indicating some unsaved changes

4. Click on the Save button, the information pane will turn to green, the learned items and the node in
the graph will become grey

Learning from alerts or incidents

Automatic learning
1. Click on the Close alert button.

2. Choose if an alert/incident is security related or if it is just a change in the configuration of the

network. In the second case the changes which originated the alert/incident will be learned by the
Environment.
 | Security features | 135

Manual learning
1. Click on the gear icon to go to the learning page.

2. The graph will be focused on the link involved in the alert (by clicking on the X button the focus will
be removed). According to the alert there is a new node, follow the already explained procedure to
learn the desired items.

Alerts
Alerts are generated by the different engines and can be very detailed, and suitable for drill-down
analysis.
To provide a higher level view, and faster operation of the system also by users without complete
knowledge of the observed system, Incidents are generated from a powerful autocorrelation engine out
of all generated Alerts.
Incidents allow to summarize Alerts providing a high-level explanation of what really happened. They
are visible by default in the Alerts table, but can be easily hidden if a more detailed view is required.
Alerts are often a key performance factor for Nozomi environments. We recommend carefully
considering your retention policy. For more information, see Configuring retention.
 | Security features | 136

Custom Checks: Assertions

Assertions can be managed in Analysis > Assertions and are based on N2QL (fully explained
in section Queries on page 77). Thanks to the powerful query language it is possible to ensure that
certain conditions are met on the observed system and to be notified when an assertion is not satisfied.

Figure 138: The assertions page with a saved failing

assertion and another assertion during the editing phase.

A valid assertion is just a normal query with another special command appended at the end. The
assertion commands are:

assert_all <field> The assertion will be satisfied when each element in the query result set
<op> <value> matches the given condition
assert_any The assertion will be satisfied when at least one element in the query result
<field> <op> set matches the given condition
<value>
assert_empty The assertion will be satisfied when the query returns an empty result set
assert_not_empty The assertion will be satisfied when the query returns a non-empty result set

For example, it is possible to be notified when someone uses the insecure telnet protocol by saving
the assertion

links | where protocol == telnet | assert_empty

Editing an assertion
To edit an assertion just enter the text in the textbox and press the enter key to execute it. Multiple
assertions can be combined by using the logical operators && (and) and || (or). Round brackets
change the logical grouping as in a mathematical expression.
 | Security features | 137

(links | where protocol == telnet | assert_empty && links | where protocol

== iec104 | assert_empty) && (nodes | where is_learned == false |
assert_empty)

Figure 139: A complex assertion being debugged

An assertion with logical operators and brackets can quickly become complex, to make the editing task
easier a debug functionality is present. By pressing the debug button (on the right side of the textbox)
the query will be decomposed and the single pieces will be executed to show the intermediate results.

Saving an assertion

Assertions can be saved in order to have them continuously executed in the system. To save an
assertion just write it in the textbox, press the enter key to execute it and then click on the save button.
A dialog will pop up asking for the assertion name and some other information. In particular the
 | Security features | 138

assertion needs to be assigned to an existing group. It is possible to create a new group by clicking on
the "New Group" button. The following dialog will appear asking for a group name.

It is also possible to choose whether the assertion has to trigger an alert. The saved assertion will be
listed at the bottom of the page with a green or red color to indicate the result.
NOTE: when editing the alert risk only the new raised alerts are affected.

Custom Checks: Specific Checks

Specific Checks can be added to Links and Variables by opening the dedicated configuration dialog.
To configure checks on a Link, go to the Links table (or any other section where the Link Actions are

displayed) and click on the button.

Here you can flag and configure these checks:

1. Is persistent: when enabled, this check will raise a new Alert whenever a TCP handshake is
successfully completed on the Link.
2. Alert on SYN: when enabled, this check will raise a new Alert whenever a TCP SYN sent by a client
on the Link.
3. Last Activity check: when enabled, this check will raise an Alert whenever the link is not receiving
any data for more than the specified amount of seconds.
(Track Availability instead does not trigger any alert).
 | Security features | 139

To configure checks on a Variable, go to the Variables table and click on the button.

Here you can flag and configure these checks:

1. Last Activity check: when enabled, this check will raise an Alert whenever the Variable is not being
measured or changed for more than the specified amount of seconds.
2. Invalid quality check: when enabled, this check will raise an Alert whenever the Variable keeps an
invalid quality for more than the specified amount of seconds.
3. Disallowed qualities check: when enabled, this check will raise an Alert whenever the Variable gains
one of the specified qualities.
 | Security features | 140

Alerts Dictionary
As explained at the beginning of this chapter, four categories of Alerts can be generated from the
Nozomi Networks Solution. Here we propose a complete list of the different kinds of Alerts that can
be raised. It should be noted that some Alerts can specify the triggering condition: for instance the
Malformed Packet Alert can be instantiated by each protocol by some specific checked information.

Protocol Validations
An undesired protocol behavior has been detected. This can refer to a wrong single message, to
a correct single message not supposed to be transmitted or transmitted at the wrong time (state
machines violation) or to a malicious message sequence. Protocol specific error messages indicating
misconfigurations also trigger alerts that fall into this category.

Type ID Name Details

NET:RST-FROM-PRODUCER Link RST sent by The link has been dropped because of
Producer a TCP RST sent by the producer. Verify
that the device is working properly, no
misconfigurations are in place and that
network does not suffer excessive latency.

PROC:SYNC-ASKED-AGAIN Producer sync A new sync (e.g. General Interrogation in

requested iec101 and iec104) command has been
issued, while in some links it is sent only once
per started connection. It may be due to a
specific sync request of an operator, a cyclic
sync, or to someone trying to discover the
process global state.

PROC:WRONG-TIME Process time issue The time stamp specified in process data is
not aligned with current time. There could be
a time sync issue with the source device, a
malfunctioning or a packet injection. Verify the
device configuration and status.

SIGN:ARP:DUP Duplicated IP ARP messages have shown a duplicated

IP address in the network. It may be a
misconfiguration of one of the devices, or a
tentative of a MITM attack.

SIGN:DDOS DDOS attack A suspicious Distributed Denial of Service has

been detected on the network. Verify that all
the devices in the network are allowed and
behaving correctly.

SIGN:DHCP-OPERATION DHCP operation A suspicious DHCP operation has been

detected. This is related to the presence of
new Mac addresses served by DHCP server,
and to DHCP wrong replies.

SIGN:ILLEGAL-PARAMETERS Illegal parameters A request with illegal parameters (e.g. outside

request from a legal range) has been issued. This
may mean that a malfunctioning software
is trying to perform an operation without
success or that a malicious attacker is trying
to understand the functionalities of the device.
 | Security features | 141

Type ID Name Details

SIGN:INVALID-IP Invalid IP A packet with invalid IP packets reserved for
special purposes (e.g. loopback addresses)
has been detected. Packets with such
addresses can be related to misconfigurations
or spoofing/denial of service attacks.

SIGN:MAC-FLOOD Flood of MAC More than 1000 MACs have been detected in
addresses 1 sec

SIGN:MALICIOUS-PROTOCOL Malicious Protocol An attempted communication by a protocol

detected known to be related to threats has been
detected.

SIGN:MULTIPLE-ACCESS-DENIED Multiple Access Denied A host has repeatedly been denied access to
events a resource.

SIGN:MULTIPLE-OT_DEVICE- Multiple OT device A host has repeatedly tried to reserve the

RESERVATIONS reservations usage of an OT device causing a potential
denial-of-service.

SIGN:MULTIPLE-UNSUCCESSFUL- Multiple unsuccessful A host has repeatedly tried to login to a

LOGINS logins service without success. It can be either an
user or a script, and due to a malicious entity,
or a wrong configuration.

SIGN:NETWORK-MALFORMED Malformed Network A malformed packet for general-purpose

packet network protocols has been detected. For
example a maliciously malformed packet
can target known issues in devices or target
software versions, and thus should be
considered carefully as a source of a possible
attack.

SIGN:NETWORK-SCAN Network Scan The network scan engine has detected a

suspicious activity in trying to open many
ports of a target host or network (vertical
or horizontal scan). This Alert covers many
possible transport protocols.

SIGN:PROC:MISSING-VAR Missing variable An attempt to access an unexisting variable

request has been made. This may be due to a
misconfiguration or a tentative to discover
valid variables inside a producer. Example:
COT 47 in iec104.

SIGN:PROC:UNKNOWN-RTU Missing or unknown An attempt to access an unexisting, virtual

device (controller's logical portion) or physical
device has been made. This may be due to a
misconfiguration or a tentative to discover the
network. Example: COT 46 in iec104.

SIGN:PROTOCOL-ERROR Protocol error A generic protocol error occurred, this usually

relates to a wrong field, option or other
general violation of the protocol.

SIGN:PROTOCOL-FLOOD Protocol-based flood One or more hosts have sent a suspiciously

high amount of packets with the same
 | Security features | 142

Type ID Name Details

application layer (e.g., ping requests) to a
single, target host.

SIGN:SCADA-INJECTION OT protocol packet A correct OT protocol packet injected in the

injection wrong context has been detected: this may
cause equipment to operate improperly.
Carefully check the involved systems and
communications. Example: a correct GOOSE
message sent with a wrong sequence number
(that, if received in the right moment, would
just work instead).

SIGN:SCADA-MALFORMED Malformed OT protocol A malformed packet for an OT protocol has

packet been detected. For example a maliciously
malformed packet can target known issues in
devices or target software versions, and thus
should be considered carefully as a source of
a possible attack.

SIGN:TCP-FLOOD TCP flood One or more hosts have sent a great amount
of anomalous TCP packets or TCP FIN
packets to a single, target host.

SIGN:TCP-MALFORMED Malformed TCP layer A packet containing a semantically invalid

TCP header has been observed.

SIGN:TCP-SYN-FLOOD TCP SYN flood One or more hosts send a great amount of
TCP SYN packets to a single host. This may
cause resource exhaustion.

SIGN:UDP-FLOOD UDP flood One or more hosts have sent a great amount
of UDP packets to a single target host.

SIGN:UNSUPPORTED-FUNC Unsupported function An unsupported function has been used on

request the remote station. This may mean that a
malfunctioning software is trying to perform
an operation without success or that a
malicious attacker is trying to understand the
functionalities of the device. Example: COT 44
in iec104.

Virtual Image
Virtual image represents a set of information by which Guardian represents the monitored network.
This includes for example node properties, links, protocols, function codes, variables, variable values.
Such information is collected via learning, or external contents, such as Asset Intelligence. Alerts in this
group represent deviations from expected behaviors, accordingly to the learned or fed information.
Note: when an alert of this category is raised, if the related event is not considered a malicious attack
or an anomaly, it can be learned.

Type ID Name Details

VI:CONF-MISMATCH Configuration A parameter describing a configuration
Mismatch version that was previously imported from a
project has been observed having a different
value in the traffic. Check the traffic and if the
new configuration is legitimate, re-import to
 | Security features | 143

Type ID Name Details

Guardian the project with up-to-date reference
values. In the opposite case, restore the
legitimate configuration into the network.

VI:GLOBAL:NEW-FUNC-CODE New global function A previously unseen protocol Function Code

code for has appeared in the network.

VI:GLOBAL:NEW-MAC-VENDOR New global MAC A previously unseen MAC vendor has

vendor appeared in the network.

VI:KB:UNKNOWN-FUNC-CODE Unknown asset The node has been contacted using a function
function code code that is not known for this kind of Asset.
When a specific profile is known for the Asset,
this Alert is raised to highlight that something
strange is going on.

VI:KB:UNKNOWN-PROTOCOL Unknown asset's The node has been contacted using a protocol
protocol that is not known for this kind of Asset. When
a specific profile is known for the Asset, this
Alert is raised to highlight that something
strange is going on.

VI:NEW-ARP New ARP A new MAC Address has started requesting

ARP information.

VI:NEW-FUNC-CODE New function code A known protocol between two nodes has
started using a new function code (i.e.
message type). For example, if a client A
normally uses a function code 'read' when
talking to server B, this alert is raised if client
A begins to use a function code 'write'.

VI:NEW-LINK New link Two nodes have started communicating with

each other.

VI:NEW-MAC New MAC address A new MAC Address has appeared on the
network, in relation to an existing node.

VI:NEW-NET-DEV New network device A new network device (switch or router) has
appeared on the network.

VI:NEW-NODE New node A new node has appeared on the network.

VI:NEW-NODE:MALICIOUS-IP Bad reputation ip A node with a bad reputation IP has been

detected. It is suggested to validate the health
status of communicating nodes, as they may
be infected by some malware.

VI:NEW-NODE:TARGET New target node A new target node has appeared on the
network. This node is not yet confirmed to
exist as it still has not sent back any data.

VI:NEW-PROTOCOL New protocol used A node has started communicating with a new
protocol.

VI:NEW-PROTOCOL:APPLICATION New application on link A link between two nodes has upgraded to a
specific application protocol.
 | Security features | 144

Type ID Name Details

VI:NEW-PROTOCOL:CONFIRMED New confirmed Two nodes have started a working, confirmed
protocol connection for a given protocol.

VI:NEW-SCADA-NODE New OT node A new node, using an OT protocol, has

appeared on the network.

VI:PROC:NEW-VALUE New OT variable value A variable has been set to a value never seen
before.

VI:PROC:NEW-VAR New OT variable A new variable has been sent, or accessed

by a client. It can be a new command, a new
object, or a tentative of enumerating existing
variables from a malicious attacker.

VI:PROC:PROTOCOL-FLOW-ANOMALY Protocol flow anomaly A message aimed at reading/writing one or

multiple variables which is sent cyclically,
has changed its transmission interval time.
Example: a iec104 command breaking its
normal transmission cycle.

VI:PROC:VARIABLE-FLOW-ANOMALY Variable flow anomaly A variable which is sent cyclically has

changed its transmission interval time.

Built-in Checks
Built-in checks run without the need of learning because they are based on specific signatures or hard-
coded logics with reference to: known ICS threats (by signatures provided by Threat Intelligence),
known malicious operations, system weaknesses, or protocol-compliant operations that can impact the
network/ICS functionality.

Type ID Name Details

SIGN:ATTACK Attack found through An attack has been found by using the Threat
Threat Modeling Modeling contents.

SIGN:CLEARTEXT-PASSWORD Cleartext password A cleartext password has been issued or

requested.

SIGN:CONFIGURATION-CHANGE Configuration change A changed configuration has been uploaded

to the OT device. This can be a legitimate
operation during maintenance and upgrade of
the software or an unauthorized tentative to
disrupt the normal behavior of the system.

SIGN:CPE:CHANGE CPE change An installed software change has been

detected. The change relates to the
vulnerabilities list, possibly changing it.

SIGN:DEV-STATE-CHANGE Device state change A command that can alter the device state
has been detected. Examples are a request of
reset of processor's memory, and technology-
specific cases.

SIGN:FIRMWARE-CHANGE Firmware change A firmware has been uploaded to the device.

This can be a legitimate operation during
maintenance or an unauthorized attempt to
change the behaviour of the device.
 | Security features | 145

Type ID Name Details

SIGN:MALICIOUS-DOMAIN Malicious domain A DNS query towards a malicious domain has
been detected. It is suggested to investigate
the health status of the involved nodes.

SIGN:MALICIOUS-IP Bad ip reputation A node with a bad reputation IP has been

found.

SIGN:MALICIOUS-URL Malicious URL A request towards a malicious URL has been

detected. It is recommended to investigate the
health status of the involved nodes.

SIGN:MALWARE-DETECTED Malware detection A potentially malicious payload relating to

a YARA/Nozomi Networks rule has been
transferred over the network.

SIGN:MITM MITM attack A MITM attack has been detected. The

attacker is ARP-poisoning the victims. The
attacker node could alter the communication
between its victims.

SIGN:OT_DEVICE-REBOOT OT device reboot The OT device has been requested to

request reboot by the source node. This event may
be something correct during Engineering
operations on the OT device, for instance
the maintenance. However, it may indicate
suspicious activity of an attacker trying to
disrupt the process being controlled by the OT
device.

SIGN:OT_DEVICE-START OT device start request The OT device program has been requested
to start again by the source node (e.g.
engineering workstation). This may be
something due to Engineering operations, for
instance the maintenance of the program itself
or a system reboot for updates. However,
it may indicate suspicious activity from an
attacker trying to manipulate the device
execution.

SIGN:OT_DEVICE-STOP OT device stop request The OT device program has been requested
to stop by the source node (e.g. engineering
workstation). This may be something due
to Engineering operations, for instance the
maintenance of the program itself or a system
reboot for updates. However, it may indicate
suspicious activity from an attacker trying to
stop the device execution.

SIGN:PACKET-RULE Packet rule match A packet has matched a Packet rule.

SIGN:PASSWORD:WEAK Weak password A weak password, possibly default, has been

used to access a resource. To keep your
network secure, change and maintain the
device's default password.

SIGN:PROGRAM:CHANGE Program change A changed program has been uploaded

to the OT device. This can be a legitimate
 | Security features | 146

Type ID Name Details

operation during maintenance and upgrade of
the software or an unauthorized tentative to
disrupt the normal behavior of the system.

SIGN:PROGRAM:DOWNLOAD Program download The OT device program has been downloaded

from another host. This can be a legitimate
operation during maintenance and upgrade of
the software or an unauthorized tentative to
read the program logic.

SIGN:PROGRAM:UPLOAD Program upload A program has been uploaded to the OT

device. This can be a legitimate operation
during maintenance and upgrade of the
software or an unauthorized tentative to
disrupt the normal behavior of the system.

SIGN:PUA-DETECTED PUA detection A potentially unwanted payload relating to

a YARA/Nozomi Networks rule has been
transferred over the network.

SIGN:SUSP-TIME Suspicious time value A suspicious time has been observed in the
network. There could be a malfunctioning
device or a packet injection. Verify the device
configuration and status.

SIGN:WEAK-ENCRYPTION Weak encryption An old and insecure version of TLS has been
used to encrypt https traffic.

Custom Checks
These are checks set in place by the user. Typically the nature of an event related to a custom check
cannot generally be referred to a problem per se, if not contextualized to the specific network and
installation.

Type ID Name Details

ASRT:FAILED Assertion Failed An assertion has failed.

GENERIC:EVENT Generic Event A generic event has been generated. More

details are available in the description of the
event. This alert type can be triggered only
by scriptable protocols using the Lua scripting
API.

NET:INACTIVE-PROTOCOL Inactive protocol The link has been inactive for longer than the
set threshold.

NET:LINK-RECONNECTION Link reconnection The link configured to be persistent has

experienced a TCP complete reconnection.

NET:TCP-SYN TCP SYN The link configured to raise an alert when

a complete reconnection takes place has
experienced a reconnection.

PROC:CRITICAL-STATE-OFF Critical state off The system has recovered from a user-
defined critical process state. Investigate the
mentioned critical state.
 | Security features | 147

Type ID Name Details

PROC:CRITICAL-STATE-ON Critical state on The system has entered in a user-defined
critical process state. Check if all considered
values are still safe or not.

PROC:INVALID-VARIABLE-QUALITY Invalid variable quality The variable has showed a quality bit set for
longer than the set threshold.

PROC:NOT-ALLOWED-INVALID- Not allowed variable The variable has shown one ore more specific
VARIABLE quality quality bits not allowed to be set.

PROC:STALE-VARIABLE Stale variable The variable has not been updated for longer
than the set threshold.
 | Security features | 148

Incidents Dictionary

Hybrid Category
The Hybrid Category is assigned when Alerts belonging to different categories as defined in the Alerts
Dictionary are grouped within such one incident. The other categories are as defined in the Alerts
Dictionary.

Category Type ID Name Details

Protocol INCIDENT:ANOMALOUS- Anomalous Malformed packets have been
Validation PACKETS packets detected during the deep packet
inspection.
Built-in Checks INCIDENT:BRUTE-FORCE- Brute-force Attack Several failed login attempts to a
ATTACK node, using a specific protocol, are
detected.
Built-in Checks INCIDENT:ENG-OPERATIONS Engineering Various operations to modify the
Operations configuration, the program, or
the status of a device have been
detected.
Built-in Checks INCIDENT:FUNCTION-CODE- Function Code A node has performed several
SCAN Scan actions that are not supported by the
target devices.
Built-in Checks INCIDENT:ILLEGAL- Illegal Parameter A node has performed a scan of the
PARAMETER-SCAN Scan parameters available on a device.

Learned INCIDENT:INTERNET- Internet A node has started surfing the Web.

Behaviour NAVIGATION Navigation

Built-in Checks INCIDENT:MALICIOUS-FILE Malicious File A compressed archive with some

malware inside has been transferred.
Hybrid Threat INCIDENT:NEW- New A node has started to communicate
Detection COMMUNICATIONS Communications with a new protocol.

Hybrid Threat INCIDENT:NEW-NODE New Node A new unseen node has started to
Detection send packets in the network.
Hybrid Threat INCIDENT:PORT-SCAN Port scan A node has started a series of scans
Detection in the network.
Built-in Checks INCIDENT:SUSPICIOUS- Suspicious Activity Suspicious activity that can be
ACTIVITY potentially related to known malware
has been detected over two nodes.
Learned INCIDENT:VARIABLES-FLOW- Variables flow A timing change on a variable which
Behavior ANOMALY anomaly used to be updated or read with a
regular interval has been detected.
Learned INCIDENT:VARIABLES-FLOW- Variables flow A consumer which used to update or
Behavior ANOMALY:CONSUMER anomaly on read a variable with a regular interval
consumer has been detected to have changed
its update interval.
Learned INCIDENT:VARIABLES-FLOW- Variables flow A producer which used to update or
Behavior ANOMALY:producer anomaly on read a variable with a regular interval
producer has been detected to have changed
its update interval.
 | Security features | 149

Category Type ID Name Details

Learned INCIDENT:VARIABLES-NEW- New values on New variable values or behavior have
Behavior VALUES producer been detected in an OT device.

Learned INCIDENT:VARIABLES-NEW- New variables on New variables have been detected in

Behavior VARS producer the OT system.

Learned INCIDENT:VARIABLES-NEW- New variables A new variable has been detected in

Behavior VARS:CONSUMER requested on a consumer device.
consumer
Learned INCIDENT:VARIABLES-NEW- New variables A new variable has been detected in
Behavior VARS:producer arrived on a producer device.
producer
Learned INCIDENT:VARIABLES-SCAN Variable scan A node in the network has started
Behavior scanning not existing variables.
Built-in Checks INCIDENT:WEAK-PASSWORDS Weak Passwords Several weak passwords have been
detected in the communication of two
nodes in the network.
 | Security features | 150

Packet rules

Introduction
Packet rules are a tool provided by the Nozomi Networks Solution to enrich and expand the checks
that are already performed on the network traffic. With packet rules the user can add a check in every
moment and receive an alert of type SIGN:PACKET-RULE when a match is found. Packet rules can be
explored and edited in the section Threat Intelligence on page 90.
In the next section there is an explanation of the language used to write new packet rules.

Format
<action> <transport> <src_addr> <src_port(s)> -> <dst_addr> <dst_port(s)>
(<options>)

Basic options

action The action to execute on match, at the moment only alert is supported
transport The transport protocol to match, can be tcp, udp or ip
src_addr The set of source ip address to match (not supported at the moment, the
value will be ignored)
src_port(s) The source ports to match. The format can be any (to match everything), a
single number, a set (eg. [80,8080]), a range (eg. 400:500), a range open to
the left bound (eg. :500), a range open to the right bound (eg. 400:). A set
can contain a combination of comma separated single ports and ranges (eg.
[:5,9,10,12:]).
dst_addr The set of destination ip address to match (not supported at the moment,
the value will be ignored)
dst_port(s) The destination ports to match. The format can be any (to match
everything), a single number, a set (eg. [80,8080]), a range (eg. 400:500), a
range open to the left bound (eg. :500), a range open to the right bound (eg.
400:). A set can contain a combination of comma separated single ports and
ranges (eg. [:5,9,10,12:]).
options The options alter the behaviour of the packet rule and attach some
information to it. The current set of supported options is: content,
byte_extract, byte_test, byte_jump, isdataat, pcre, msg and
reference.
The options are a list of semicolon-separated key-value pairs (eg. content:
<value1>; pcre: <value2>).
They are explained in details in the next section.

msg option
Define the message that will be present in the alert
Example usage: msg:"a sample description"

reference option
Define the CVE associated with the packet rule.
Example usage: reference:cve,2017-0144;

content option
The content option specifies some data to be found in the payload. The option can contain printable
chars, bytes in hexadecimal format delimited by pipes or a combination of them.
 | Security features | 151

Examples:
- content: "SMB" will search for the string SMB in the payload,
- content: "|FF FF FF|" will search for 3 bytes FF in the payload,
- content: "SMB|FF FF FF|" will search for the string and 3 bytes FF in the payload.
The content option can have several modifiers which influence the behaviour:
- depth: specifies how far into the packet the content should be searched
- offset: specifies where to start searching in the packet
- distance: specifies where to start searching in the packet relatively to the last option match
- within: to be used with distance, specifies how many bytes are between pattern matches
Examples:
Given the rule alert tcp any any -> any any (content:\"x\"; content:\"y\";
distance: 2; within: 2;) the packet {'x', 0x00, 0x00, 0x00, 'y'} will match, the packet {'x', 0x00,
0x00, 0x00, 0x00, 'y'} will not because the distance and within constraints are not respected.

byte_extract option
The byte_extract option reads some bytes from the packet and saves them in a variable.
The syntax is: byte_extract:<bytes_to_extract>, <offset>, <name> [, relative][,
big|little]
For example: byte_extract:2,26,TotalDataCount,relative,little will read two bytes from
the packet at the offset 26 and put them in a variable called TotalDataCount, the offset is relative to the
last matching option and the data encoding is little endian.

byte_jump option
Read the given number of bytes at the given offset and move the offset by their numeric
representation.
The syntax is: byte_jump:<bytes to convert>,<offset>[,relative][,little][,align]
For example: byte_jump:2,1,little; will read two bytes at offset 1, intepret them as little endian
and move the offset.

byte_math option
Read the given number of bytes at the given offset, perform an arithmetic operation, save the result in
a variable and move the offset.
The syntax is: byte_math: bytes <bytes to convert>, offset <offset>, oper
<operator>, rvalue <r_value>, result <result_variable>[,relative][,endian
<endianess>]
For example: byte_math:bytes 2, offset 1, oper +, rvalue 23, result my_sum; will
read two bytes at offset 1, intepret them as big endian, add 23 to the value, store the result into the
variable my_sum and move the offset.

byte_test option
Test a byte against a value or a variable.
The syntax is: byte_test:<bytes to convert>, <operator>, <value>, <offset> [,
relative][, big|little] where <operator> can be = or >.
For example: byte_test: 2, =, var, 4, relative; will read two bytes at offset 4 (relative to
the last matching option) and test if the value is equal to the variable called var.
 | Security features | 152

dsize option
Matches payloads of a given size.
The syntax is: dsize: min<>max; or dsize: <max; or dsize: >min;
Matches if the size of the payload corresponds to the given boundaries.

id option
Matches IP packets with a given ID.
The syntax is: id: <id>;

isdataat option
Verify that the payload has data at the given position.
The syntax is: isdataat:<offset>[,relative]
For example: isdataat:2,relative; verify that there is data at offset to relative to the previous
match.

flags option
Match TCP packets with given flags.
The syntax is: flags: (FSRPAUCE0+*!)
For example: flags: SA; matches on SYN-ACK packets.

flow option
Match TCP packets with given flags.
The syntax is: flow:
[established,not_established,from_client,from_server,to_client,to_server]
For example: flow: established,from_server; matches responses in an established TCP
session.

flowbits option
Check and set boolean flags in sessions.
The syntax is: flowbits: [set,setx,unset,toggle,reset,isset,isnotset]
For example: flowbits: set,has_init; sets the has_init flag on the session if the packet rule
matches the packet. flowbits: isnotset, has_init matches on packets whose session does
not have the flag has_init set.

file_data option
Moves the point to the beginning of the content in an HTTP packet.
The syntax is: file_data;

fragbits option
Checks the flags of the header of IP packets.
The syntax is: fragbits: (MDR+*!);
For example: fragbits: MR*; matches on packet that have the More fragments or Reserved
bit flags set.

pkt_data option
Moves the pointer to the beginning of the packet payload.
 | Security features | 153

The syntax is: pkt_data;

pcre option
The pcre option specifies a regex to be found in the payload.
The syntax is: pcre:"(/<regex>/[ismxAEGR]"
Pcre modifiers:
- i: case insensitive
- s: include newline in dot metacharacter
- m: ^ and $ match immediately following or immediately before any newline
- x: ignore empty space in the pattern, except when escaped or in characters class
- A: match only at the start
- E: $ will match only at the end of the string ignoring newlines
- G: invert the greediness of the quantifiers
- R: match is relative to the last matching option

urilen option
Matches on HTTP packets whose URI has a specified size.
The syntax is: urilen: min<>max; or urilen: <max; or urilen: >min;
Hybrid Threat Detection
The Nozomi Networks Solution can leverage on different types of threat detection.
The first one is the anomaly-based analysis, where Guardian learns the behaviour of the observed
network and alerts the user when a significant deviation is detected in the system. This analysis is
generic and can be applied to every system.
The second analysis is done by Yara rules. Guardian is able to extract files transferred by protocols
such as HTTP or SMB and trigger on them an inspection by the Yara engine; when a Yara rule
matches, an alert is raised. The typical use of Yara rules is to detect the transfer of a malware. A set of
Yara rules is provided by Nozomi and can also be expanded by the user.
The third analysis is done by packet rules. They enable the user to define a criterion to match a
malicious packet and raise an alert. A set of packet rules is provided by Nozomi and can also be
expanded by the user.
The fourth analysis is done by other Indicators of Compromise (IoC) loaded via STIX. They provide
several hints like malicious domains, URLs, IPs, etc.
Guardian can correlate the output obtained with these approaches to provide a powerful and
comprehensive threat detection strategy.
Chapter

7
Vulnerability Assessment
Topics: In this section we will cover the Vulnerability Assessment module.

• Basics A Vulnerability Assessment is the process of identifying, quantifying,

and ranking the vulnerabilities in a system.
• Passive detection
• Configuration The Nozomi Networks Solution provides the ability to find vulnerable
system applications, operating systems or hardware components.
 | Vulnerability Assessment | 156

Basics
To manage vulnerability assessment the Nozomi Networks Solution uses NVD (National Vulnerability
Database) format files; the vulnerabilities files match a CPE (Common Platform Enumeration) with a
CVE (Common Vulnerabilities and Exposures):
• CPE is a structured naming scheme for information technology systems, software, and packages.
Based upon the generic syntax for Uniform Resource Identifiers (URI), CPE includes a formal name
format.
• Common Vulnerabilities and Exposures (CVE) is a dictionary of common names for publicly known
cybersecurity vulnerabilities. CVE's common identifiers make it easier to share data across separate
network security databases and tools. With CVE Identifiers, you may quickly and accurately access
fix information in one or more separate CVE-compatible databases to remediate the problem.
• The Common Weakness Enumeration Specification (CWE) provides a common language of
discourse for discussing, finding and dealing with the causes of software security vulnerabilities as
they are found in code, design, or system architecture. Each individual CWE represents a single
vulnerability type.

Figure 140: Vulnerability detail

 | Vulnerability Assessment | 157

Passive detection
The Nozomi Networks Solution offers continuous vulnerability detection, since it detects vulnerabilities
within a network by only passively listening to network traffic. This technique allows for a
comprehensive state of risk without impacting in any way the production equipment.
We will consider a passive vulnerability as any vulnerability that may be detected simply through
analysis of network traffic.
The passive vulnerability detection is a valuable component because an active scan can affect the
timing of the device or its sensitive processes.
Passive monitoring is not intrusive on network performance or operation. It is real time and can be very
useful to trace certain network security problems and to verify suspected activity.
Configuration
Vulnerabilities-related information can be provided to the Nozomi Networks Solution as follows:
• via the Threat Intelligence service (see Threat Intelligence on page 90 for more information)
• or by using our vulnerabilities-only database, if Threat Intelligence has not been subscribed.
To use the vulnerability-only database (that can be downloaded from Nozomi Networks at https://
nozomi-contents.s3.amazonaws.com/vulns/vulnassdb.tar.gz), use a tool like scp or
WinSCP to upload it to the /data/tmp folder:

scp vulnassdb.tar.gz admin@<appliance_ip>:/data/tmp

Execute these commands in the appliance:

enable-me

cd /data/contents

tar xzf /data/tmp/vulnassdb.tar.gz

Now reload the database with the command:

service n2osva restart

Additional vulnerabilities can be added to the system. They must be in the NVD (National Vulnerability
Database) format, and be placed in the /data/contents/vulnass folder. However, Nozomi
Networks gives full support only for the own-distributed files.
Chapter

8
Smart Polling
Topics: This section describes Smart Polling, the add-on that allows
Guardian to contact nodes in order to gather new information or to
• Strategies improve the already existing one.
• Plans
In Smart Polling, you can define one or more plans, i.e.,
• Extracted information configurations that instruct Guardian about which nodes to poll, and
when and how to poll them. For instance, one can define the plan
to poll known PLCs in the 192.168.38.0/24 subnet every hour using
the Ethernet/IP protocol.
Smart Polling makes the extracted data accessible in two formats.
Some data, when extracted correctly, allows Guardian to enrich its
knowledge of the network. For instance, PLC nodes polled using
the Ethernet/IP protocol are enriched with information such as
vendor, device type, or serial number in the asset or network views;
Windows computers polled with the WinRM protocol provide a list of
the installed software; Linux machines polled using SSH appear in
the asset and network view the exact name of the distribution and
their uptime. Other data that does not enrich the asset or network
views is still useful for diagnostic purposes, such as the CPU or
memory usage, or the status of the network interfaces. This data is
accessible in the Smart Polling display page.
Note: to enable Smart Polling it is required to instal and upgrade
using the advanced bundle, e.g. VERSION-advanced-
update.bundle; do not use VERSION-standard-
update.bundle
 | Smart Polling | 160

Strategies
The currently supported strategies are:

EthernetIP To be used with devices that support the Ethernet/IP protocol

Modicon Modbus To be used with Modicon Modbus devices
SEL To be used with SEL devices
SNMPv1 To be used with devices that expose the SNMPv1 service
SNMPv2 To be used with devices that expose the SNMPv2 service
SNMPv3 To be used with devices that expose the SNMPv3 service
SSH To be used with devices that expose the SSH service
WinRM To be used with Windows devices that expose the WinRM service
WMI To be used with Windows devices that expose the WMI service
CB Defense (External To be used with Carbon Black services
Service)
DNS reverse lookup The strategy extracts information about nodes by using DNS protocol
(External Service)
Aruba ClearPass (External The strategy send and extract assets information from ClearPass
Service) through HTTP Rest APIs
Cisco ISE (External Service) This strategy extracts assets information from Cisco ISE using the
pxGrid HTTP API
ServiceNow (External This strategy extracts assets information from ServiceNow using the
Service) REST Table API. It also allows you to automatically close Guardian's
incidents whenever their corresponding incidents in ServiceNow are
closed
Tanium (External Service) This strategy extracts assets information from Tanium using the
Tanium Server REST API

Plans
Plans are user-defined schedules that instruct the Guardian about the polling intentions. Each plan
defines:
• a strategy, i.e., a protocol or application to use to connect with the desired service;
• a human-readable labelto easily identify the plan;
• a query that defines the set of nodes to poll;
• a run_interval, i.e., the time interval in seconds between two successive executions of the plan; and
• additional parameters defined by the chosen strategy. For example, the SEL strategy requires a
password, while the SNMPv2 lets you restrict the requests to selected OIDs.
The Smart Polling display page gives an overview of the existing plans along with the nodes polled by
each plan. Moreover, it allows to add, modify, remove, enable, and disable the plans and to see their
logs.
 | Smart Polling | 161

Figure 141: Two user-configured plans

To add a new plan, click the top-right button "New plan". The plan configuration popup appears. A
similar popup appears when you click the configuration icon next to a plan's label in order to modify
the plan. The popup lets you define the plan parameters and to check its functionality by testing
it on a specific address. By entering an IP address in the "Host to test" field and clicking "Check
connection", a quick one-shot poll of the corresponding node is performed, and the result of the test
appears immediately, including steps that have been performed, data that has been retrieved and error
messages if any.

Figure 142: Adding or modifying a plan

Figure 143: Example of successful connection check

 | Smart Polling | 162

Plan actions
Once a plan is created, you can perform several actions on it.

Figure 144: Actions that can be performed on an existing plan

Enable/Disable Enable or disable the scheduled execution of the plan

Edit plan Update the plan parameters
Show log Show the last log messages with live-update

Figure 145: Example of last log messages

Delete plan Delete the plan and the associated data

Clearpass configuration
Integration permits to send asset information to Clearpass service. To configure ClearPass you must
add credentials (username and password) as well as the bearer token.

Figure 146: Clearpass configurations

 | Smart Polling | 163

Extracted information
The information that strategies extract during their activity are directly integrated with the information
that were already attached to the targeted nodes. This means that they can be observed in other
parts of the Nozomi Networks Solution such as Asset View on page 56, Network View on page 58 or
Vulnerabilities on page 88.
For example, the following image shows an asset whose product name has been retrieved with Smart
Polling.

Figure 147: Source information tooltip of a product name

Integrating the new information in this way is very useful, but it does not clearly show what was
collected overall and, more importantly, how information evolved over time. All of this can be found in
the Smart Polling display page, under the Polled nodes tab.

Figure 148: Smart Polling Display page

The page is divided into three columns, each one representing an increasing level of details with
respect to the currently selected row.
The first column provides a list of all the nodes that have been contacted by at least one plan. The
second column refers to the node selected in the first column and it lists all the last inserted values for
each kind of extracted information. Finally, the third column shows the last twentyfive inserted values
for the currently selected information in the second column. For numeric values, this last column is
enriched with a graph that helps in understanding how values changed over time.

Querying extracted information

Another interesting way to explore what Smart Polling collected consists in using the queries
mechanism with the node_points data source. For example, we can look at how many different
product names a node has had with the following query:

node_points | where node_id == 192.168.1.3 | where human_name ==

product_name | select value | uniq | count
Chapter

9
Queries
Topics: In this chapter are listed all the data sources, commands and
functions which can be used in N2QL (Nozomi Networks Query
• Overview Language).
• Reference
• Examples
 | Queries | 166

Overview
Each query must start by calling a data source, for example:

nodes | sort received.bytes desc | head

will show in a table the first 10 nodes which received the most bytes.
By adding the pie command at the end it is possible to display the result as a pie chart where each
slice has the node ip as label and the received.bytes field as data:

nodes | sort received.bytes desc | head | pie ip received.bytes

Sometimes query commands are not enough to achieve the desired result. As a consequence, the
query syntax supports functions. Functions allow you to apply calculations on the fields and to use the
result as a new temporary field.
For example, the query:

nodes | sort sum(sent.bytes,received.bytes) desc | column ip

sum(sent.bytes,received.bytes)

uses the sum function to sort on the aggregated parameters and to produce a chart with the columns
representing the sum of the sent and received bytes.
 | Queries | 167

Reference

Data sources
These are the available data sources with which you can start a query:

help Show this list of data sources

alerts All the alerts raised
assertions All the assertions saved by the users
assets All the assets identified in the system
captured_urls All the urls captured from network protocols
function_codes All the function codes
links The links in the system, each link has a one-to-one association with a
protocol
link_events The link events saved for each link, for instance channel up/down
events, protocol-specific parameters, etc.
nodes The nodes in the system
node_cpes All the CPEs (hardware, operating system and software versions)
detected on nodes
node_cpe_changes CPEs (hardware, operating system and software versions) changes
collected over time
node_cves All vulnerabilities detected on node's CPEs
sessions All currently live network sessions
variables The SCADA variables of the producers
variable_history The history of the variable values
variable_history_month The history of the variable values within the month specified
zones The zone nodes
zone_links The zone links

Using Basic Operators

When writing queries, please note the following details about basic operators:

Operator AND
Description To add a where clause with a logical AND, append it using the pipe
character (|). For example, the query below returns links that are from
192.168.254.0/24 AND going to 172.217.168.0/24.
Example links | where from in_subnet? 192.168.254.0/24 | where
to in_subnet? 172.217.168.0/24

Operator OR
Description To add a where clause with a logical OR, append it using the OR operator.
For example, the query below returns links with either the http OR the https
protocols.
Example links | where protocol == http OR protocol == https
 | Queries | 168

Operator ! (NOT)
Description Put an exclamation point (!) before a term to negate it. For example, the
query below returns links that do NOT (!) belong to 192.168.254.0/24.
Example nodes | where ip !in_subnet? 192.168.254.0/24 | count

Operators ==, =, <, >, <=, and >=

Description Queries support the mathematical operators listed above.

Operator " (Quotation Marks)

Description Use quotation marks (") to specify an empty string. Consider these two
cases where this technique is useful:
• Finding empty values. Example 1 below returns assets where the os field
is blank.
• Specifing that a value in the query is a string (if its type is ambiguous).
Example 2 below tells concat to treat the "--" parameter as a fixed string
to use rather than as a field from the alerts table.

Example 1 assets | where os != ""

Example 2 alerts | select concat(id_src,"--",id_dst)
 | Queries | 169

Commands
Here is the complete list of commands:

Syntax select <field1> <field2> ... <fieldN>

Parameters • the list of field(s) to output

Description The select command takes all the input items and outputs them with only the
selected fields

Syntax exclude <field1> <field2> ... <fieldN>

Parameters • the list of field(s) to remove from the output

Description The exclude command takes all the input items and outputs them without
the specified field(s)

Syntax where <field> <==|!=|<|>|<=|>=|include?|start_with?|

end_with?|in_subnet?> <value>
Parameters • field: the name of the field to which the operator will be applied
• operator
• value: the value used for the comparison. It can be a number, a string
or a list (using JSON syntax), the query engine will understand the
semantics

Description The where command will send to the output only the items which fulfill the
specified criterion, many clauses can be concatenated using the boolean OR
operator
Example • nodes | where roles include? consumer OR zone ==
office
• nodes | where ip in_subnet? 192.168.1.0/24

Syntax sort <field> [asc|desc]

Parameters • field: the field used for sorting
• asc|desc: the sorting direction

Description The sort command will sort all the items according to the field and the
direction specified, it automatically understands if the field is a number or a
string

Syntax group_by <field> [ [avg|sum] [field2] ]

Parameters • field: the field used for grouping
• avg|sum: if specified, the relative operation will be applied on field2

Description The group_by command will output a grouping of the items using the field
value. By default the output will be the count of the occurrences of distinct
values. If an operator and a field2 are specified, the output will be the
average or the sum of the field2 values

Syntax head [count]

Parameters • count: the number of items to output

Description The head command will take the first count items, if count is not specified
the default is 10
 | Queries | 170

Syntax uniq
Parameters
Description The uniq command will remove from the output the duplicated items

Syntax expand <field>

Parameters • field: the field containing the list of values to be expanded

Description The expand command will take the list of values contained in field and for
each of them it will duplicate the original item substituting the original field
value with the current value of the iteration

Syntax sub <field>

Parameters • field: the field containing the list of objects

Description The sub command will output the items contained in field

Syntax count
Parameters
Description The count command outputs the number of items

Syntax pie <label_field> <value_field>

Parameters • label_field: the field used for each slice label
• value_field: the field used for the value of the slice, must be a numeric
field

Description The pie command will output a pie chart according to the specified
parameters

Syntax column <label_field> <value_field ...>

Parameters • label_field: the field used for each column label
• value_field: one or more field used for the values of the columns

Description The column command will output an histogram, for each label a group of
columns is displayed with the value from the specified value_field(s)

Syntax history <count_field> <time_field>

Parameters • count_field: the field used to draw the Y value
• time_field: the field used to draw the X points of the time series

Description The history command will draw a chart representing an historic series of
values

Syntax distance <id_field> <distance_field>

Parameters • id_field: the field used to identify the data
• distance_field: the field on which the distances are calculated

Description The distance command will calculate a series of distances from the original
series. Each distance value is calculated as the difference between a value
and its subsequent occurrence
 | Queries | 171

Syntax bucket <field> <range>

Parameters • field: the field on which the buckets are calculated
• range: the range of tolerance in which values are grouped

Description The bucket command will group data in different buckets, different records
will be put in the same bucket when the values fall in the same multiple of
<range>

Syntax join <other_source> <field> <other_source_field>

Parameters • other_source: the name of the other data source
• field: the field of the original source used to match the object to join
• other_source_field: the field of the other data source used to match the
object to join

Description The join command will take two records and will join them in one record
when <field> and <other_source_field> have the same value

Syntax gauge <field> [min] [max]

Parameters • field: the value to draw
• min: the minimum value to put on the gauge scale
• max: the maximum value to put on the gauge scale

Description The gauge command will take a value and represent it in a graphical way

Syntax value <field>

Parameters • field: the value to draw

Description The value command will take a value and represent it in a textual way

Syntax reduce <field> [sum|avg]

Parameters • field: the field on which the reduction will be performed
• sum or avg: the reduce operation to perform, it is sum if not specified

Description The reduce command will take a series of values and calculate a single
value

Nodes-specific commands reference

Syntax where_node <field> < ==|!=|<|>|<=|>=|include?|exclude?|

start_with?|end_with? > <value>
Parameters • field: the name of the field to which the operator will be applied
• operator
• value: the value used for the comparison. It can be a number, a string
or a list (using JSON syntax), the query engine will understand the
semantics

Description The where_node command will send to the output only the items which fulfill
the specified criterion, many clauses can be concatenated using the boolean
OR operator. Compared to the generic where command, the adjacent nodes
are also included in the output.
 | Queries | 172

Syntax where_link <field> < ==|!=|<|>|<=|>=|include?|exclude?|

start_with?|end_with? > <value>
Parameters • field: the name of the field to which the operator will be applied
• operator
• value: the value used for the comparison. It can be a number, a string
or a list (using JSON syntax) the query engine will understand the
semantics

Description The where_link command will send to the output only the nodes which are
connected by a link fulfilling the specified criterion. Many clauses can be
concatenated using the boolean OR operator.

Syntax graph [node_label:<node_field>]

[node_perspective:<perspective_name>]
[link_perspective:<perspective_name>]
Parameters • node_label: add a label to the node, the label will be the content of the
specified node field
• node_perspective: apply the specified node perspective to the resulting
graph. Valid node perspective values are:
• roles
• zones
• transferred_bytes
• not_learned
• public_nodes
• reputation
• appliance_host
• link_perspective: apply the specified link perspective to the resulting
graph. Valid link perspectives are:
• transferred_bytes
• tcp_firewalled
• tcp_handshaked_connections
• tcp_connection_attempts
• tcp_retransmitted_bytes
• throughput
• interzones
• not_learned

Description The graph command renders a network graph by taking some nodes as
input.

Link Events-specific commands reference

Syntax availability
Parameters
Description The availability command computes the percentage of time a link is UP. The
computation is based on the link events UP and DOWN that are seen for the
link.

Syntax availability_history <range>

Parameters • range: the temporal window in milliseconds to use to group the link
events
 | Queries | 173

Description The availability_history command computes the percentage of time a link is

UP by grouping the link events into many buckets. Each bucket will include
the events of the temporal window specified by the range parameter.

Syntax availability_history_month <months_back> <range>

Parameters • months_back: number of months to go back in regards to the current
month to group the link events
• range: the temporal window in seconds to use to group the link events

Description The availability_history command computes the percentage of time a link is

UP by grouping the link events into many buckets. Each bucket will include
the events of the temporal window specified by the range and months
parameters.
 | Queries | 174

Functions
Here is the complete list of functions:

Syntax sum(<field>,...)
Parameters • a list of fields to sum

Description The sum function returns the sum of the fields passed as arguments
Warning Only available for nodes, links, variables and function_codes

Syntax color(<field>)
Parameters • field: the field on which to calculate the color

Description The color function generates a color in the rgb hex format from a value
Warning Only available for nodes, links, variables and function_codes

Syntax date(<time>)
Parameters • time defined as unix epoch

Description The date function returns a date from a raw time

Syntax dist(<field1>,<field2>)
Parameters • the two fields to subtract

Description The dist function returns the distance between field1 and field2

Syntax abs(<field>)
Parameters • the field on which to calculate the absolute value

Description The abs function returns the absolute value of the field

Syntax div(<field1>,<field2>)
Parameters • field1 and field2: the two field to divide

Description The div function will calculate the division field1/field2

Syntax coalesce(<field1>,<field2>,...)
Parameters • a list of fields or string literals in the format "<chars>"

Description The coalesce function will output the first value that is not null

Syntax concat(<field1>,<field2>,...)
Parameters • a list of fields or string literals in the format "<chars>"

Description The concat function will output the concatenation of the input fields or values

Syntax round(<field>,[precision])
Parameters • field: the numeric field to round
• precision: the number of decimal places
 | Queries | 175

Description The round function takes a number and output the rounded value

Syntax split(<field>,<splitter>,<index>)
Parameters • field: the field to split
• splitter: the character used to separate the string and produce the tokens
• index: the 0 based index of the token to output

Description The split function takes a string, separates it and outputs the token at the
<index> position

Syntax is_recent(<time_field>)
Parameters • time_field: the field representing a time

Description The is_recent function takes a time field and returns true if the time is not
farther than 30 minutes

Syntax seconds_ago(<time_field>)
Parameters • time_field: the field representing a time

Description The seconds_ago function returns the amount of seconds passed between
the current time and the time field value

Syntax minutes_ago(<time_field>)
Parameters • time_field: the field representing a time

Description The minutes_ago function returns the amount of minutes passed between
the current time and the time field value

Syntax hours_ago(<time_field>)
Parameters • time_field: the field representing a time

Description The hours_ago function returns the amount of hours passed between the
current time and the time field value

Syntax days_ago(<time_field>)
Parameters • time_field: the field representing a time

Description The days_ago function returns the amount of days passed between the
current time and the time field value

Syntax to_time(<time_field>)
Parameters • time_field: the field representing a time

Description The to_time function takes a string representing a date and time in ISO 8601
format and returns the corresponding UNIX timestamp in milliseconds

Syntax bitwise_and(<numeric_field>,<mask>)
Parameters • numeric_field: the numeric field on which apply the mask
• mask: a number that will be interpreted as a bit mask
 | Queries | 176

Description The bitwise_and function calculates the bitwise & operator between the
numeric_field and the mask entered by the user
 | Queries | 177

Examples

Creating a pie chart

In this example we will create a pie chart to understand the MAC vendor distribution in our network. We
choose nodes as our query source and we start to group the nodes by mac_vendor:

nodes | group_by mac_vendor

We can see the list of the vendors in our network associated with the occurrences count. To better
understand our data we can use the sort command, so the query becomes:

nodes | group_by mac_vendor | sort count desc

In the last step we use the pie command to draw the chart with the mac_vendor as a label and the
count as the value.

nodes | group_by mac_vendor | sort count desc | pie mac_vendor count

Creating a column chart

In this example we will create a column chart with the top nodes by traffic. We start by getting the
nodes and selecting the id, sent.bytes, received.bytes and the sum of sent.bytes and received.bytes.
To calculate the sum we use the sum function, the query is:

nodes | select id sent.bytes received.bytes sum(sent.bytes,received.bytes)

If we execute the previous query we notice that the sum field has a very long name, we can rename it
to be more comfortable with the next commands:

nodes | select id sent.bytes received.bytes

sum(sent.bytes,received.bytes)->sum

To obtain the top nodes by traffic we sort and take the first 10:

nodes | select id sent.bytes received.bytes

sum(sent.bytes,received.bytes)->sum | sort sum desc | head 10

Finally we use the column command to display the data in a graphical way:

nodes | select id sent.bytes received.bytes

sum(sent.bytes,received.bytes)->sum | sort sum desc | head 10 | column id
sum sent_bytes received_bytes

Note: you can access an inner field of a complex type with the dot syntax, in the example the dot
syntax is used on the fields sent and received to access their bytes sub field.
Note: after accessing a field with the dot syntax it will gain a new name to avoid ambiguity, the dot is
replaced by an underscore. In the example sent.bytes become sent_bytes.
 | Queries | 178

Using where with multiple conditions in OR

With this query we want to get all the nodes with a specific role, in particular we want all the nodes
which are web servers or DNS server.
With the where command it is possible to achieve this by writing many conditions separated by OR.
Note: the roles field contains a list of values, thus we used the include? operator to check if a value
was contained in the list.

nodes | where roles include? web_server OR roles include? dns_server |

select id roles

Using bucket and history

In this example we are going to calculate the distribution of link events towards an IP address. We start
by filtering all the link_events with id_dst equal to 192.168.1.11.
After this we sort by time, this is a very important step because bucket and history depend on how
the data are sorted.
At this point we group the data by time with bucket. The final step is to draw a chart using the
history command, we pass count as a value for the Y axis and time for the X axis.
The history command is particularly suited for displaying a big amount of data, in the image below we
can see that there are many hours of data to analyze.

link_events | where id_dst == 192.168.1.11 | sort time asc | bucket time

36000 | history count time

Using join
In this example we will join two data sources to obtain a new data source with more information. In
particular we will list the links with the labels for the source and destination nodes.
 | Queries | 179

We start by asking for the links and joining them with the nodes by matching the from field of the links
with the id field of the nodes:

links | join nodes from id

After executing the query above we will get all the links fields plus a new field called
joined_node_from_id, it contains the node which satisfies the link.from == node.id
condition. We can access the sub fields of joined_node_from_id by using the dot syntax.
Because we want to get the labels also for the to field of the links we add another join and we
exclude the empty labels of the node referred by to to get more interesting data:

links | join nodes from id | join nodes to id | where

joined_node_to_id.label != ""

We obtain a huge amount of data which is difficult to understand, just use a select to get only the
relevant information:

links | join nodes from id | join nodes to id | where

joined_node_to_id.label != "" | select from joined_node_from_id.label to
joined_node_to_id.label protocol

Computing availability history

In this example we will compute the availability history for a link. In order to achieve a reliable
availability it is recommended to enable the "Track availability" feature on the desired link.
We start from the link_events data source, filtered by source and destination ip in order to precisely
identify the target link. Consider also filtering by protocol to achieve a higher degree of precision.

link_events | where id_src == 10.254.3.9 | where id_dst == 172.31.50.2

The next step is to sort the events by ascending time of creation. Without this step the
availability_history might produce meaningless results, such as negative values. Finally, we compute
the availability_history with a bucket of 1 minute (60000 milliseconds). The complete query is as
follows.

link_events | where id_src == 10.254.3.9 | where id_dst == 172.31.50.2 |

sort time asc | availability_history 60000
Note: link_events generation is disabled by default, to enable it use the configuration rule described in
Configuring links
Chapter

10
Maintenance
Topics: In this chapter you will get the complementary information to keep
the Nozomi Networks Solution up and running with ordinary and
• System Overview extraordinary maintenance tasks.
• Data Backup and Restore
• Reboot and shutdown
• Software Update and Rollback
• Data Factory Reset
• Full factory reset with data
sanitization
• Host-based intrusion detection
system
• Action on log disk full usage
• Support
 | Maintenance | 182

System Overview
In this section a brief overview of the Nozomi Networks Solution OS (N2OS) main components is given,
so as to provide further background to administer and maintain a production system.

Partitions and Filesystem layout

In this section we will give a look at the N2OS filesystem, services and commands.
The first thing to know about the N2OS structure is the presence of four different disk partitions:
1. N2OS 1st partition, where a copy of the OS is kept and run from. Two different partitions are used
by the install and update process in order to deliver fast-switch between the running release and
new versions
2. N2OS 2nd partition, that copes with the first one to provide reliable update paths.
3. OS Configuration partition, located at /cfg, where low-level OS configuration files are kept (for
instance, network configurations, shell admin users, SSH keys, etc). This partition is copied on /etc
at the start of the bootstrap process.
4. Data partition, located at /data where all user data is kept (learned configuration, user-imported
data, traffic captures, persistent database)

Figure 149: The N2OS standard partition table

A closer look at the /data partition reveals some sub-folders, for instance:
1. cfg: where all automatically learned and user-provided configurations are kept. Two main
configuration files are stored here:
a. n2os.conf: for automatically learned configurations
b. n2os.conf.user: for additional user-provided configurations.
2. data: working directory for the embedded relational database, used for all persistent data
3. traces: where all traces are kept and rotated when necessary.
4. rrd: this directory holds the aggregated network statistics, used for example for the Traffic on page
72.

Core Services
There are some system services that you need to know for proper configuration and troubleshooting:
1. n2osids, the main monitoring process. It can be controlled with

service n2osids <operation>

(<operation> can be any of start, stop, restart). Its log files are under /data/log/n2os and start
with n2os_ids*.
2. n2ostrace, the tracing daemon. It can be controlled with

service n2ostrace <operation>

Its log files start with n2os_trace* and are located under /data/log/n2os.
 | Maintenance | 183

3. n2osva, the Asset Identification and Vulnerability Assessment daemon. It can be controlled with

service n2osva <operation>

Its log files start with n2os_va* and are located under /data/log/n2os.
4. n2ossandbox, the file sandbox daemon. It can be controlled with

service n2ossandbox <operation>

Its log files start with n2os_sandbox* and are located under /data/log/n2os.
5. nginx, the web server behind the web interface. It copes with unicorn to provide the https service up
and secured. It can be controlled with

service nginx <operation>

In order to be able to perform any operation on these services, you need to obtain the privileges using
enable-me. For instance, the following commands allow to restart the n2osids service:

enable-me
service n2osids restart

Several other tools and daemons are running in the system to deliver N2OS functionalities.

Data Backup and Restore

This section describes the methods available for backing up the system and subsequently restoring it.
Please note that a backup contains just the data -- the system software is left untouched.
Two different kinds of backup are available: Full Backup and Environment Backup. The former
contains all data, while the latter lacks historical data, extended configurations, and some other
information. Both can be executed while the system is running. Environment Backup can be used to
restore the most important part of the system on another appliance for analysis, or as a delta backup
when a full backup is available.

Full Backup

Command line
To create a new backup, go to a terminal and execute the command:

n2os-fullbackup

You can now download the backup file; for instance:

scp admin@<appliance_ip>:/data/tmp/<backup_hostname_date.nozomi_backup> .

Web application
The graphical interface for creating a backup is available under Administration > Backup/
Restore. You can generate and download a backup on-demand (by clicking the Download button) or
you can schedule a backup for a chosen date or recurrence (by clicking the Schedule backup button).
 | Maintenance | 184

When scheduling a backup, you can configure the recurrence, the maximum number of backups to
keep, and the location where backup files are stored; the location can be local or remote.
In the case of local locations, backup files are stored under the /data/backups/ folder on the
appliance.
In the case of a remote location, backup files are stored on a dedicated host; this host must provide
a user/password authentication method through one of the listed protocols, and the user must have
permissions to list, read, and write within a folder that will store the backup files. During the backup
process, the backup file is generated locally and then uploaded on the remote folder. When restored,
the backup file is first downloaded from the remote folder and then used for the restore process.

When a new scheduled backup is about to be generated, the system checks if the number of maximum
backups to keep is about to be exceeded, and if ncessary, eliminates the oldest backup.

Full Restore

Command line
In order to restore from a full backup you may do the following:
 | Maintenance | 185

1. Copy via SFTP the backup archive from the location where it was saved to the
admin@<appliance_ip>:/data/tmp/<backup_hostname_date.nozomi_backup> path of
the appliance. For instance, using the scp command line:

scp <backup_location_path>/<backup_hostname_date.nozomi_backup>
admin@<appliance_ip>:/data/tmp/<backup_hostname_date.nozomi_backup>
2. Go to a terminal and execute this command:

n2os-fullrestore /data/tmp/<backup_hostname_date.nozomi_backup>

Note: Use the --etc_restore option to restore the files from the /etc folder, the feature can be
used with a backup produced from version 20.0.1 and newer.

Web application
If automatically scheduled backups are present on the disk, they will be listed in the table of the section
named 'Restore Previous Backup'.

For each entry the following actions can be performed:

Download the backup file

This action will start the download process for the selected backup file. The file can be used manually
for the Full Restore process.

Restore the selected backup file

This action will start the Full Restore process using the selected backup file.

Delete the selected backup file

 | Maintenance | 186

This action will delete the selected backup file from the disk.
Finally, it is possible to upload a backup archive from your local machine, for instance a previously
produced backup via command-line, or downloaded with the UI.

Environment Backup
In this section you will learn how to backup the Environment backup of an existing installation.
1. Issue the save command from the CLI
2. Copy via SFTP the content of the /data/cfg folder to a safe place.

Environment Restore
In this section you will learn how to restore a Nozomi Networks Solution Environment to an existing
installation.
1. Copy the saved content of the cfg folder to the /data/cfg folder into the appliance.
2. From the console, issue the service n2osids restart command.

Reboot and shutdown

Reboot and shutdown commands can be performed from the web interface under Administration
> Operations

In addition, both commands can be entered in the text console or inside an SSH session.
To reboot the system issue the following command:

enable-me
shutdown -r now

To properly shutdown the system issue the following command:

enable-me
shutdown -p now
 | Maintenance | 187

Software Update and Rollback

In this section you will get informed about available methods for updating the system to a newer
release and rolling back to the previous one.
Rolling back to the previously installed release is transparent, and all data is migrated back to the
previous format. However, rollback to a release older than the previously installed one requires to have
a full backup available to restore.
Although the software update is built to be transparent to the user and to preseve all data, we suggest
to always have at least a Environment Backup of the system in a safe place.
An interesting aspect of the Nozomi Networks Solution update file is that it applies to both the
Guardian and the CMC, and will work for all the physical and virtual appliances to make the updating
experience frictionless. Special considerations need to be done for the Container, where different
update commands and procedures apply.

Update: Graphical method

In this section you will learn how to update the Nozomi Networks Solution software of an existing
installation.
You need to already have the new VERSION-update.bundle file that you want to install.
A running system must be updated with a more recent N2OS release.
1. Go to Administration > System operations

2. Click on Software Update and select the VERSION-update.bundle file

Warning: the system must be at least version 18.5.9 to support the .bundle format; if your system is
running a version lower than 18.5.9 you must first update to 18.5.9 to proceed
The file will be uploaded
3. Click the Proceed button
Warning: if updating version 18.5.9, the system prompts to insert the checksum that is distributed
with the .bundle; only after checksum verification the button is enabled
The update process begins. Wait some minutes for the update to complete.

Update: Command line method

In this section you will learn how to update the Nozomi Networks Solution software of an existing
installation.
You need to already have the new update file you want to install.
A running system must be updated with a more recent N2OS release.
1. Go to a terminal and cd into the directory where the VERSION-update.bundle file is located.
Then copy the file to the appliance with:

scp VERSION-update.bundle admin@<appliance_ip>:/data/tmp

2. Start the installation of the new software with:

ssh admin@<appliance_ip>

enable-me

install_update /data/tmp/VERSION-update.bundle
 | Maintenance | 188

The appliance will now reboot with the new software installed.

Rollback to the previous version

In this section you will learn how to rollback the software to the very previous version. If you would like
to rollback to a release older than the previous one, follow the instructions in the next section.
You need to have performed a release update at least once.
1. Go to the console and type the command

rollback

2. Answer y to the confirmation message and wait while the system is rebooted. All configuration and
historical data will be automatically converted to the previous version, thus no manual intervention
will be required.

Rollback to an older version

In this section you will learn how to rollback the software to a version older than the previous one.
You need to have a full backup available. If you do not have one, you cannot rollback to an older
release. Please note that this operations takes longer time than rolling back to the very previous one,
requires a full backup and does not preserve recently changed data.
1. Take the software update file VERSION-update.bundle that you want to rollback to, and install it
like if it was a new version as explained in Software Update and Rollback on page 187.
Warning: if you want to rollback to a version older than 18.5.9, you have to rollback to version
18.5.9 first since support for the previous file format was removed since
2. At reboot, ignore any error and log into the console.
3. Now follow the steps for a full restore with a backup file from the very same version of the software
that has just been re-installed.
 | Maintenance | 189

Data Factory Reset

In this section you will learn how to completely erase the N2OS data partition. IP configuration will
be kept, and the procedure is safe to execute remotely. Executing this procedure will cause the
system to lose all data!
1. Go to a terminal and execute the command:

n2os-datafactoryreset -y

2. The system will start over with a fresh data partition. Refer to Setup Phase 2 on page 18 to
complete the configuration of the system.

Data Factory Reset with Sanitization

In this section you will learn how to how to completely erase the N2OS data partition sanitizing the disk
space using the U.S. DoD 5220-22M 7-pass scheme.
This process erase the N2OS data partition in accordance to the clear guidelines suggested by the
NIST in document 800-88 rev1.
Configurations like network and console password settings will be kept.
Executing this procedure will cause the system to lose all data!
1. Go to a terminal and execute the command:

n2os-datasanitize -y

2. The system will start over with a fresh data partition. Refer to Setup Phase 2 on page 18 to
complete the configuration of the system.

Full factory reset with data sanitization

In this section you will learn how to how to completely erase your appliance clearing out the disk space
using the U.S. DoD 5220-22M 7-pass scheme.
This process erase ALL the data inside your appliance in accordance to the clear guidelines suggested
by the NIST in document 800-88 rev1.
All data and configurations will be permanently destroyed. The appliance will require to be rebooted
after this procedure. The installed N2OS version will remain the same.
Executing this procedure will cause the system to lose all data and configurations!
1. Go to a terminal and execute the command:

n2os-fullfactoryreset -iknowwhatimdoing

2. The system will start over and it will require to be reconfigured from scratch. Refer to Setup Phase 1
on page 16 to configure the system.

Host-based intrusion detection system

In this section we will provide information about the internal HIDS.

Host-based intrusion detection system

N2OS appliances can detect changes to the basic firmware image. When a change is detect a new
event is logged in the Audit log of the system and replicated to the CMC.
Default HIDS settings can be changed in the /data/cfg/n2os.conf.user file to best suit your
security requirements.
 This feature is not available in the container version due to the different security approach.

Parameter Default Description

value
hids execution interval 18 HIDS check execution interval
hours
hids ignore files Coma separater list of files to be ignored
by HIDS (ex: /etc/file1, /etc/file2)

Action on log disk full usage

System log files are keep in a dedicated log partition and are automatically rotated in order to preserve
disk usage. However sometime customers may want to shutdown the appliance if the log partition fills
up.
This feature can be enabled adding the configuration key shutdown_when_log_disk_full true
to the /data/cfg/n2os.conf.user file.
Log emergency shutdown will also raise an alert into the appliance health log.
This feature is not available in the container version.

Support
In this section you will learn how to generate the archive needed to ask support to Nozomi Networks.
Go to Administration > Support click on download button and your browser will start
downloading the support packet file. Send an email to [email protected] attaching the
file.
Chapter

11
Central Management Console
Topics: In this section we will cover the Central Management Console
product, a centralized monitoring variant of the standalone
• Overview Appliance.
• Deployment
The main idea behind the Central Management Console is to deliver
• Settings a unified experience with the Appliance, consequently the two
• Connecting Appliances products appear as similar as possible.
• Troubleshooting
• Propagation of users and user
groups
• CMC connected appliance -
Date and Time
• Appliances List
• Appliances Map
• HA (High Availability)
• Alerts
• Functionalities Overview
• Updating
• Single-Sign-On through the
CMC
 | Central Management Console | 192

Overview
The Central Management Console (CMC) has been designed to support complex deployments that
cannot be addressed with a single Appliance.
A central design principle behind the CMC is the Unified Experience, that allows to access information
in the same manner as the Appliance. Some additional functionalities have been added to allow
the simple management of hundreds of appliances, and some other functionalities relying on live
traffic availability have been removed to cope with real-world, geographic deployments of the Nozomi
Networks Solution architectures. In Functionalities Overview on page 205 a detailed overview of
differences will be given.
In the Appliances page all connected appliances can be seen and managed. A graphical
representation of all the hierarchical structure of the connected Appliances and the Appliance Map is
presented to allow a quick health check on a user-provided raster map. In Appliances List on page
198 and Appliances Map on page 200 these functionalities will be explained in detail.
Once Appliances are connected, they are periodically synchronized with the CMC. In particular, the
Environment of each Appliance is merged into a global Environment and Alerts are received for a
centralized overview of the system. Of course, Alerts can also be forwarded to a SIEM directly from the
CMC, thus enabling a simpler decoupling of components in the overall architecture. To synchronize
data, the Appliances must be running the same major release or one of the two prior major ones. For
example, if the CMC is running the version 19.0.x (the major is 19.0), Appliances can synchronize if
running one of the following versions: 19.0.x, 18.5.x or 18.0.x.
Firmware update is also simpler with a CMC. Once the new Firmware is deployed to it, all connected
Appliances are also automatically updated. In Updating on page 206 an overview of the update
process is provided for the CMC scenario.
 | Central Management Console | 193

Deployment
The first step to setup a CMC is to deploy its Virtual Machine (VM).
The CMC VM can be deployed following the steps provided in Installing the Virtual Machine on page
13. The main difference here is that the CMC version of N2OS must be used in the installation.
The difference is during the Initial Setup phase: you have to locate and configure the management NIC
but not the sniff interfaces. The reason is that the CMC does not have to sniff live traffic.

Deployment to AWS
Before starting, please request access to the CMC Amazon Machine Image (AMI) by emailing
your organization's AWS account ID and the AWS region where this AMI will be deployed to
[email protected]. For information about finding your AWS ID, please refer to Amazon's
documentation on AWS identifiers. We'll grant access upon receiving your request.

Deployment to Microsoft Azure

The Nozomi Networks CMC image has been delivered in a special Azure VHD for use in the Azure
cloud.
Prerequisites
1. The Azure storage account that is to be used must have the capabilities to store Page Blobs. This
is an Azure requirement when uploading vhd images to be used for virtual machines in the Azure
environment.
2. The Azure user performing the installation must have permissions to access the Storage Explorer.
3. Make sure there are well-defined security groups for accessing the virtual machine to be
instantiated in Azure.
4. Nozomi Networks platform images for running on Azure have a number of prerequisites. Please
contact your Nozomi Networks support team for details.
Deploying via the Azure Web UI
1. Log in to the Azure console.
2. Create a resource of type Storage Account if there aren’t any in your subscription (default
values).
Make sure the Storage Account type supports Page Blobs.
3. Select the Storage Account and Storage Explorer (preview) > Blob Container from the
menu.
Make sure the Azure user has permissions to access the Storage Explorer
4. Create a Blob Container if it doesn’t exist and select Upload for the VHD
5. When the upload is completed, from Azure home select Create a resource and choose
Managed Disks with following settings:
• SourceType=Storage Blob
• select the Nozomi Networks VHD as SourceBlob
• Size = <deployment size>
• OS = Linux, Gen1
• Leave the other parameters with their defaults
6. Once the disk is created, select it:
• click +Create VM
• choose required CPU and RAM
• Network Firewall rules - allow SSH, HTTPS and HTTP
• In the Management tab, for Boot Diagnostics select Enable with custom storage
account, then choose or create a Diagnostics storage account
• Leave the other parameters with their defaults
7. Once the virtual machine is created, select it, scroll down to the Support + troubleshooting
section and select Serial Console.
 | Central Management Console | 194

8. Log in to the console. The default console credential has no password initially and must be changed
upon first login. The console will display a prompt with the text "N2OS - login:". Type admin and
then press [Enter].
9. Elevate the privileges with the command: enable-me
10.Now launch the initial configuration wizard with the command:

env TERM=xterm /usr/local/sbin/setup

Refer to Setup Phase 1 on page 16 to configure the system.

11.Run data_enlarge to expand the disk space

data_enlarge
12.You can login to the Web UI with:
username: admin
Password: nozominetworks
 | Central Management Console | 195

Settings
The Administration > Synchronization settings page allows you to customize all the CMC
related parameters.

Sync token The token that must be used by all the appliances allowing for
synchronization to the CMC.
Sync ID The current CMC ID, which will be shown in the CMC we want
to replicate data with.
CMC context Multicontext indicates that the data gathered from the
Appliances connected to the CMC will be collected and kept
separately, whereas All-in-one means that the information
will be merged.
Appliance update policy Determines whether the Appliances connected to the CMC
will automatically receive updates when a new version of the
software is available.
Remote access to connected Enables/disables remote access of an Appliance by passing
Appliances through the CMC.
Allow remote to replicate on When a CMC attempts to replicate data on the current CMC, its
this CMC Sync ID is shown in the corresponding text-field. This validates
that the CMC that is trying to replicate is really the one that you
intended to work with.
HA (High Availability) The High Availability mode allows the CMC to replicate its own
data on another CMC. In order to activate it, you must insert
the other CMC Host and Sync Token.

Connecting Appliances
To start connecting an Appliance to a CMC open the web console of a CMC, go to Settings on page
195.
Copy the Sync Token, which you will need for configuring the Appliance.
To connect an Appliance to the CMC open the web console of the Appliance and go to
Administration > CMC connection.
 | Central Management Console | 196

In this page you can enter the parameters to connect the Appliance:

Host The CMC host address (the protocol used will be https). If no CA-emitted
certificates are used you can make the verification of certificates optional.
Sync token The Synchronization token necessary to authenticate the connection, the
pair of tokens can be generated from the CMC.
Description [Optional] A description of the Appliance, it will be displayed in the
Appliances list.
Site [Optional] If at least two Appliances have the same site in the Appliances
map you can enable a grouping by site.

The Check connection button indicates if the pairing between the CMC and the appliance is valid.
After entering the endpoint and the Sync token. Click Save to keep the configuration and open the web
console of the CMC, navigating to Appliances

The table will list all the connected Appliances. When an Appliance is connected for the first time, it
will notify its status and receive Firmware updates. However, it will not be allowed to perform additional
actions. To enable a complete integration of the Appliance you will need to "allow" it (see Appliances
List on page 198 for details).
To configure the synchronization intervals between an Appliance and the CMC see Configuring the
CMC synchronization on page 251.

Troubleshooting
In this section a list of the most useful troubleshooting tips for the CMC is given.
1. If the Appliance is not appearing at all in the CMC:
 | Central Management Console | 197

• Ensure that firewall(s) between the Appliance and the CMC allows traffic on TCP/443 port
(HTTPS), with the Appliance as Source and the CMC as the Target
• Check that the tokens are correctly configured both in the Appliance and the CMC
• Check in the /data/log/n2os/n2osjobs.log file for connection errors.
2. The Appliance ID is stored in the /data/cfg/.appliance-uuid file. Please do not edit this file
after the appliance is connected to the CMC, since it is the unique identifier of the Appliance inside
the CMC. In case a forceful change of the Appliance ID is needed, you will need to remove the old
data from the CMC by removing the old Appliance ID entry.
3. If an issue occurs during the setup of an Appliance, follow the instructions at Appliances List on
page 198 to completely delete the Appliance or just to clear its data from the CMC.

Propagation of users and user groups

As described in Users on page 25, both CMC and appliances can have their own users and user
groups. In order to simplify the management of all the possible appliances connected to a CMC, a new
synchronization feature has been added: users and user groups of the CMC can be propagated to all
the appliances.
Admin users can specify which users and user groups will be propagated to connected appliances. As
shown in the figure below, in the create/edit user group popup there is a toggle button to enable this
property, which, by default, is set to false.

The synchronization comes with the following constraints:

• All the users and user groups that arrived in the Guardian from the CMC cannot be modified.
• All the users and user groups created in the Guardian will not be synced with the CMC.
• In case of name conflicts, users and user groups in the Guardian will be overwritten with the ones
coming from the CMC.

CMC connected appliance - Date and Time

Note that when an appliance is attached to a CMC, its date and time cannot be manually set
as described in Date and time on page 110. Appliances connected to a CMC (and with no NTP
configured) will automatically get time synchronization from the parent CMC.
 | Central Management Console | 198

Appliances List
The Appliances section shows the complete list of appliances connected to the current CMC. For each
appliance, you can see some information about its status (system, throughput, alerts, license and
running N2OS version).

Actions on appliances:

Allow/Disallow an Appliance

After allowing an Appliance (an allowed Appliance has the icon)

• Nodes, Links and Variables coming from the Appliance become part of the Environment of the
CMC.
• Alerts coming from the Appliance can be seen in the Alerts section.

Focus on appliance
Allows to filter out only the appliance chosen data, such as Alerts and Environment.

Remote connect to an appliance

Connect to a remote appliance directly from the CMC. Click on this action to open a new browser tab to
the appliance selected login page. The action is hidden if the CMC isn't configured to allow this type of
communication between Appliances and CMC; to enable it go to Settings on page 195 page.

Place an appliance on the map

 | Central Management Console | 199

This action is used to place the appliance within the map (if you did not upload a map go to Appliances
Map on page 200), choose the right position of the selected appliance by clicking on the map and
Save.

Lock the appliance software version

When locked, the Appliance will not automatically update its software.

Force the software update of the appliance

Even if it is locked, the Appliance will automatically update its software, with the version installed on the
CMC.

Clear data of an appliance

Clear all data received from the selected appliance for restarting the synchronization from an empty
state.

Delete a appliance
Clear all data received from the selected Appliance and delete it from the list. If the Appliance tries to
sync with the CMC again, it appears disallowed in the list.

Set Remote Collector BPF filter

Opens the BPF editor for the selected Remote Collector. If the Remote Collector supports it, the list
of network interfaces will be displayed on the bottom and it will be possible to set the filter for each
network interface. Otherwise, the icon will appear beside the other icons and the filter will be set for all
network interface.
 | Central Management Console | 200

Appliances Map
In this page you can upload the Appliances Map by clicking on Upload map and choosing a .jpg file
from your computer.

You can inspect the appliances information in the Info pane. In the map each appliance is identified
by its own ID. The appliance marker color is related to the risk of its alerts and near the ID there is the
number of the alerts in the last 5 minutes (if greater than 0). If the alerts in last 5 minutes grows, the
appliance marker will blink for 1 minute.

If the site has been specified in the CMC connection page of the appliance, it is possible to enable the
"group by site" option. The appliances with the same site will be grouped to deliver a simpler view of a
complex N2OS installation.

Figure 150: Appliances map with "group by site" enabled

 | Central Management Console | 201

The Appliances Map is also available as a widget.

 | Central Management Console | 202

HA (High Availability)
This feature allows a CMC to replicate all its data on another CMC called replica.
Note: In order to enable the highest level of resiliency, the two CMCs must be replicating each
other. In case a CMC stops working, the connected appliances will continue to send their data
to the replica CMC.
To connect another CMC as HA (High Availability) replica, go to Administration /
Synchronization settings page.

Enable the feature by clicking the ON button and then fill the form with the Host and the Sync Token
field of the endpoint you want to replicate it with.
If the destination endpoint doesn't provide CA-Emitted TLS certificate, remember to click on Optional
so the certificates will not be verified (this option isn't recommended).
The Sync token can be found in Administration / Synchronization settings page of the
destination endpoint.

After Save, in order to confirm the connection to the two CMCs, go to Administration /
Synchronization settings page of the destination endpoint and verify the Sync ID shown is the
one of the current machine, and click on Allow button .
 | Central Management Console | 203

To verify that everything is configured correctly and it's working, see the Replication status in
the Administration / Health. Here, you can see if the various entities are synchronized, e.g.
AuditItems are elements generally with a low creation frequency, it will be 'In Sync'.
 | Central Management Console | 204

Alerts
Alerts management in the centralized console is equivalent to alerts management in an appliance (for
more information about this go to Alerts on page 55). This allows for you to have all the alerts from all
the appliances in one place.
In an appliance, you can create a query (Queries on page 77) and therefore an assertion (Custom
Checks: Assertions on page 136) that involves all the nodes/links/etc of your overall infrastructure.
In the centralized console you have the ability to create a "Global Assertion": you can make one or
more groups of assertions that can be propagated to all the appliances. The appliances cannot edit nor
delete these assertions, only the CMC has control over them.
As mentioned previously, it is possible to configure the centralized console to forward alerts to a SIEM
without having to configure each appliance (for more information on this topic, see Data Integration on
page 101).
 | Central Management Console | 205

Functionalities Overview
The unified experience offered by the CMC lacks some of the features found in the appliance user
interface.

As stated above, the Nodes table in a CMC offers only the Show alerts and Navigate actions (the
same table on a appliance has also Configure node, Show requested trace and Request a trace
actions).

Figure 151: Node actions on appliance (top) and CMC (bottom)

In the Environment Links table only the Show alerts and Navigate actions are available (the same
table on an appliance has also Configure link, Show requested trace, Request a trace and Show
events actions).

Figure 152: Link actions on appliance (top) and CMC (bottom)

In Process View Variables table the Configure variable action is not allowed, but the other actions
(Variable details, Add to favourites and Navigate) are. You have a detailed explanation in Process
Variables on page 73.

Figure 153: Variable actions on appliance (top) and CMC (bottom)

Configuration actions and trace request functionalities are available only in the appliance user
interface.
 | Central Management Console | 206

Updating
In this section we will cover the release update and rollback operations of a Nozomi Networks Solution
architecture, comprised of a Central Management Console and one or more Appliance(s).
The Nozomi Networks Solution Software Update bundle is universal (except for the Container) -- it
applies to both the Guardian and the CMC, and will work for all the physical and virtual appliances to
make for a user-friendly update experience.
Once an Appliance is connected to the Central Management Console, updates are controlled from
there. The software bundle is propagated from the CMC and, once the bundle is received by the
Appliance, the update can be performed automatically or manually. Configure this behavior on the
Synchronization settings page; select an option under Let the user perform the update on
the appliances, as shown below.

Figure 154: Update policy

If the CMC is configured to allow manual updates, the Appliance's status bar displays a message
notifying the user as soon as the Appliance receives the update bundle (see the next figure).

Figure 155: Update available notification

The update process from the Central Management Console can proceed as explained in Software
Update and Rollback on page 187. After the Central Management Console is updated, each Appliance
will receive the new Software Update.
If an error occurred during the update procedure, a message appears next to the related Appliance's
version number on the Appliances page.
To Rollback, first rollback the Central Management Console, and then proceed to rollback all the
appliances as explained in Software Update and Rollback on page 187.

Single-Sign-On through the CMC

CMC machines offer a SAML identity provider endpoint to their connected appliances in order to permit
users to login into appliances by passing through the parent CMC.
By default, this functionality is not enabled on the CMC. To use this service, you must specify the
Nozomi URL on the SAML integration page; for details see SAML Integration on page 37. You can use
either the machine's IP address (for example, https://192.168.1.122) or its domain name (for
example, https://machine.address), but to use either address interchangeably to login using
SAML, you must specify the domain name.
The identity provider endpoint is exposed only if a configuration rule indicating the external URL at
which the CMC is accessible is present in the n2os.conf.user file (see Configuration on page 219
for more information). For example, assuming the CMC can be accessed at https://192.168.1.8, the
configuration rule would be the following:

cmc identity_provider_url https://192.168.1.8

However, if the CMC is also accessible via its domain name, and the identity provider was previously
set using the domain name, you must replace the IP address with the correct domain name in the
configuration rule (for example, cmc identity_provider_url https://machine.address). Note that to make
the change effective you also have to reboot or restart all of the services.
 | Central Management Console | 207

Once the CMC has been configured, you should be able to obtain the identity provider metadata in /
idp/saml/metadata endpoint of the CMC. Continuing with the CMC in the example above, you will
find the metadata file at https://192.168.1.8/idp/saml/metadata. This file is important as it has to be
uploaded on all the appliances on which you want to have the SSO login.
The last remaining step is to configure the appliances to point to the CMC when performing SSO
operations. Specifically, you must use the following data:
• SAML role: https://nozominetworks.com/saml/group-name
• Metadata XML: the file downloaded from the CMC in the previous step
following what is described at SAML Integration on page 37
At this point everything should be setup, allowing you to be able to perform SSO via the CMC on the
configured appliances.
Note that if you have a hierarchy of CMCs in your installation, you can also setup SSO in a composable
way in order to have a SSO chain. For example, in the following scenario:
• the CMC1 is configured to perform SSO on ExternalIdP
• the CMC2 is attached to CMC1
• the Guardian G1 is attached to CMC2
We can have a SSO chain starting at G1, passing through CMC2, then through CMC1 and ending at
ExternalIdP by configuring each pair of machines as described above. In particular we want to have:
• CMC1 has an identity_provider_url specified in n2os.conf.user and it is configured to perform
SSO on ExternalIdP
• CMC2 has an identity_provider_url specified in n2os.conf.user and it is configured to perform
SSO on CMC1
• G1 is configured to perform SSO on CMC2
Assuming that you want to login into G1 by using ExternalIdP, you will be redirected through all the
configured machines. Once logged in the ExternalIdP, you will be automatically redirected back to G1.
Chapter

12
Remote Collector
Topics: In this section we will cover the Remote Collector product, an
appliance that is intended to be used to collect and forward traffic to
• Overview a Guardian.
• Deployment
A Remote Collector is a low-demanding and low-throughput
• Using a Guardian with appliance suitable for installation in isolated areas (e.g., windmills,
connected Remote Collectors solar power fields), where many small sites are to be monitored.
• Troubleshooting
• Updating
• Disabling a Remote Collector
 | Remote Collector | 210

Overview
The Remote Collector has been designed to be deployed in installations that require monitoring of
many isolated locations. Remote Collectors connect to a Guardian and act as "remote interfaces",
broadening its capture capability, and thus allowing a Guardian to be applied in simple but highly-
distributed scenarios.
A Remote Collector is an appliance meant to run on a less performant hardware than the Guardian or
the CMC, and its main task is that of just "forwarding" traffic to a Guardian. In some sense a Remote
Collector is to a Guardian as a Guardian is to a CMC. There are some key differences though. First of
all, a Remote Collector does not process sniffed traffic in any way, it just forwards it to the Guardian it
is attached to. Second, a Remote Collector has no graphical user interface. Finally, as it runs on less
performant hardware than the Guardian, a Remote Collector has a limitation on the bandwidth that it
can process.
A Guardian can be enabled to receive traffic from the Remote Collectors. When enabled it provides
an additional (virtual) network interface, called "remote-collector", which aggregates the traffic of the
Remote Collectors connected to it. The currently connected Remote Collectors can be inspected from
the "Appliances" tab.
Each Remote Collector is entitled to forward the traffic it sniffs to only one Guardian. Several Remote
Collectors can connect to a Guardian. Traffic is encrypted with high security measures over the
channel (TLS), so that it cannot be intercepted by a third-party. The Firmware of a Remote Collector
receives automatic updates from the Guardian it is connected to.
 | Remote Collector | 211

Deployment
The first step to setup a Remote Collector is to deploy its Virtual Machine (VM) or its Container.
The Remote Collector VM can be deployed following the steps provided in Installing the Virtual
Machine on page 13 for the Guardian edition. The main difference is that the Remote Collector version
of the image must be used in the installation.
Alternatively, a Remote Collector Container can be deployed following the steps in Installing the
Container on page 14, changing the container name, e.g.:
docker build -t nozomi-rc .

Guardian configuration
The Guardian has to be configured via terminal (ssh or console). In the following assume that 1.1.1.1
is the ip address of the Remote Collector.
1. Run command n2os-enable-rc
This command will open port 6000 on the firewall, which the Remote Collector uses to send the
traffic it sniffs. Moreover, a new interface called "remote-collector" will appear in the list of "Network
Interfaces".

2. The synchronization of a Remote Collector towards the Guardian for the purpose of software update
is now enabled as shown in Administration / Synchronization settings. Note down the
Sync token.
 | Remote Collector | 212

Remote Collector configuration

Each Remote Collector has to be configured via terminal (ssh or console). In the following assume that
1.2.3.4 is the ip address of the Guardian to connect to. The Remote Collector provides a TUI to help
with this setup phase; it can be started with the n2os-tui command (the command is available after
having elevated your privileges with the enable-me command).
1. Select the Remote Collector menu.

2. Select the "Set Guardian Endpoint" menu.

3. Insert the IP address of the Guardian you wish to connect to.

 | Remote Collector | 213

4. From the previous menu, select the "Set Connection Sync Token" menu. Insert the token you have
noted down using the Guardian configuration step.

5. Optionally, a bpf-filter can be added by selecting the "Set BPF Filter" menu from the previous menu.
 | Remote Collector | 214

6. Exit from the TUI.

Enable traffic forwarding

The previous steps enable the Remote Collector to communicate with the appliance, but traffic
forwarding requires the two to exchange the certificates required for encrypting the sniffed traffic
being forwarded. The following steps explain the simplest way to configure certificates exchange; see
Configuration of CA-based certificates on page 215 for an alternative approach.
1. Select the "Appliances" tab; the newly added Remote Collector appears in the list.

2. Click it and inspect the pane on the right. The "Last seen packet" property indicates whether traffic
is being forwarded.

3. Click the Refresh button.

 | Remote Collector | 215

The Refresh button appears to the right of the"Not Connected" label:

4. Switch on the "Live" notification at the top.

The button turns into a spinning wheel. After few minutes, once the procedure is complete, the date
and time of the last seen packet is displayed

Note that it takes few minutes to complete the exchange and the last step is completed only once
the Remote Collector sends the first encrypted packet to the appliance. If no trafic is being sniffed
(and therefore forwarded), the procedure remains stuck in the connecting (i.e. spinning wheel) step.

Configuration of CA-based certificates

The certificates installed by default in the Guardian and the Remote Collector are self-signed, but it
is also possible to use certificates signed with a CA authority, if your company policy demands such
requirement. Normally a "certificate chain" composed by the "Root CA" and several "Intermediate CA"s
are used to sign a "leaf" certificate. If you wish to follow this approach, then you may go through the
following steps, which have to be repeated for both the Guardian and the Remote Collector appliances.
1. Put a "leaf" certificate/key pairs under /data/ssl/https_nozomi.crt and /data/ssl/
https_nozomi.key.
This step installs your certificate in the appliance.
2. Put a the "certificate chain" under /data/ssl/trusted_nozomi.crt.
This step installs your certificate chain in the appliance. Any certificate signed with the chain will be
accepted as valid.

Final configuration
After all the appliances have been configured it is necessary to reboot them for the configuration to
take effect. Alternatively, it is sufficient to perform the following commands
1. service n2osrc stop
on the Guardian
2. service n2osrs stop
on each Remote Collector

Using a Guardian with connected Remote Collectors

In this section we briefly outline some functionalities that a Guardian offers to monitor traffic with a set
of connected Remote Collectors.
The set of connected Remote Collectors can be inspected from the "Appliances" tab of a Guardian. By
selecting a Remote Collector an information pane appears on the right, showing some more detailed
information. The information includes the health status of the Remote Collector, and the timestamp of
the last received payload traffic.
 | Remote Collector | 216

The provenience of the packets is tracked internally by the Guardian and it is displayed in several
locations, such as in the the "Nodes" tab of "Network View",

in the "Asset view",

and in the "Alerts" page.

 | Remote Collector | 217

Troubleshooting
In this section a list of the most useful troubleshooting tips for the RC is given.
1. If a Remote Collector is not appearing at all in the Appliances tab:
• Ensure that firewall(s) between the Guardian and the Remote Collector allows traffic on TCP/443
port (HTTPS), with the Remote Collector as Source and the Guardian as the Target
• Check that the tokens are correctly configured both in the Guardian and the Remote Collector
• Check the /data/log/n2os/n2osjobs.log file of the Remote Collector for connection
errors.
2. If a Remote Collector appears in the Appliances tab, but it sends no traffic (last seen packet is
empty or does not update its value):
• Ensure that firewall(s) between the Guardian and the Remote Collector allows traffic on
TCP/6000 port, with the Remote Collector as Source and the Guardian as the Target
• Check that the certificates have been correctly exchanged between the Guardian and the
Remote Collector, i.e., that the certificate at /data/ssl/https_nozomi.crt of an appliance
appears listed in /data/ssl/trusted_nozomi.crt of the other appliance, or that the
certificate chain has been trusted
• Check the /data/log/n2os/n2os_rs.log file of the Remote Collector for connection
errors. In particular errors related to certificates are logged with the error code coming directly
from the openssl library. Once identified the code it is possible to check for the corresponding
explanation at the following page: https://www.openssl.org/docs/man1.1.0/man3/
X509_STORE_CTX_get_error.html
• Make sure to restart n2osrc and n2osrs services everytime a change in the config or the
certificates is performed
Updating
In this section we will cover the release update and rollback operations of a Remote Collector.
Remote Collectors receive automatic updates from the Guardian they are attached to: as for the
Guardian to the CMC, the Remote Collector updates to the version of the Guardian if the current
firwmare version is older than the Guardian's.
Note that Remote Collector Container does not update automatically.
A Remote Collector has no graphical interface. The only other method for changing the version of a
Remote Collector is to use the manual procedure described at Software Update and Rollback on page
187.

Disabling a Remote Collector

Disabling unused remote controllers hardens your environment.
1. Log into the Guardian UI that receives data from the Remote Collector, locate the Remote Collector
on the Appliances tab, and remove it by clicking the Delete button.

2. If you remove all the remote collectors in your environment, you can prevent any remote collectors
from sending data to Guardian. This hardening measure can make your environment more secure.
To do so log into the shell of the Guardian that receives data from the Remote Collector, go to
privileged mode, and run

n2os-disable-rc
Chapter

13
Configuration
Topics: In this section we will cover the configuration of Nozomi Networks
Solution components in details.
• Features Control Panel
Some features can be quickly configured using the Features Control
• Editing Configuration files
Panel (see Features Control Panel on page 220).
• Basic configuration rules
• Configuring the Garbage Each configuration rule can be inserted in the custom
Collector n2os.conf.user configuration file (see Editing Configuration files on
page 220) and/or directly in the CLI. To get it applied you may
• Configuring alerts need different actions. For each configuration rule we will cover all
• Configuring nodes the required details.
• Configuring links
The CLI can be run from a text console (run the cli command) or
• Configuring variables from the web console under Administration > CLI.
• Configuring protocols
• Configuring decryption
• Configuring trace
• Configuring Time Machine
• Configuring retention
• Configuring Bandwidth
Throttling
• Configuring Remote Collector
Bandwidth Throttling
• Configuring the CMC
synchronization
• Configuring session hijacking
protection
• Configuring UDP Flood
Detection
 | Configuration | 220

Features Control Panel

The Features Control Panel gives an overview of the current status of system features configuration
and allows to fine tune specific values.
In the General tab, you can enable general features, such as whether to generate assets from IPv6
nodes.

The Retention tab allows to select a specific number (aka Retention level) for historical data
persistence. In some cases, you can completely disable a feature's retention.

Editing Configuration files

The Nozomi Networks Solution configuration relies on text-files located at /data/cfg.
In particular the /data/cfg/n2os.conf.user can be edited to fine-tune user-defined configuration
or mass-import rules from other systems. In this section we will see how to change and apply a
configuration rule.
Please log into the text-console, either directly or through SSH, and issue the following commands.
1. Use vi or nano to edit /data/cfg/n2os.conf.user
2. Edit a configuration rule with the text editor, see the next sections for some examples.
3. Write configuration changes to disk and exit the text editor.
 | Configuration | 221

Basic configuration rules

Set traffic filter

Products Guardian, Remote Collector

Syntax bpf_filter <bpf_expression>
Description Set the BPF filter to apply on incoming traffic to limit the type and amount of
data processed by the appliance.
Parameters • bpf_expression: the Berkeley Packet Filter expression to apply on
incoming traffic. A BPF syntax reference can be accessed on the
appliance at https://<appliance_ip>/#/bpf_guide.

Where In the n2os.conf.user file.

To apply Reload with service n2osids restart

Enable or disable management filters

Products Guardian
Syntax mgmt_filters <on|off>
Description With this rule you can switch off the filters on packets that come from/to
N2OS itself.
Parameters • on|off: choose 'off' if you want to disable the management filters (default:
on).

Where In the n2os.conf.user file.

To apply Reload with service n2osids reload

Enable or disable TCP/UDP deduplication

Products Guardian
Syntax probe deduplication enabled <status>
Description It can enable or disable the deduplication analysis that N2OS does on TCP/
UDP packets.
Parameters • status: it can be either true, to enable the feature, or false, to disable it.
(default: true)

Where In the n2os.conf.user file.

To apply Reload with service n2osids reload

Set TCP deduplication time delta

Products Guardian
Syntax probe deduplication tcp_max_delta <delta>
Description Set the desired maximum time delta, in milliseconds, to consider duplicated
a TCP packet.
Parameters • delta: the value of the maximum time delta. (default: 1)

Where In the n2os.conf.user file.

To apply Reload with service n2osids reload
 | Configuration | 222

Set UDP deduplication time delta

Products Guardian
Syntax probe deduplication udp_max_delta <delta>
Description Set the desired maximum time delta, in milliseconds, to consider duplicated
an UDP packet.
Parameters • delta: the value of the maximum time delta. (default: 1)

Where In the n2os.conf.user file.

To apply Reload with service n2osids reload

Set default Zone name

Products Guardian
Syntax ids configure vi zones add default <zone_name>
Description Set the default Zone name, for nodes not matching any of the custom
defined zones. Details on zones feature can be viewed in Network Graph on
page 62.
Remark: zones can be configured through the GUI, which is the preferred
way. Refer to Zone configurations on page 108

Parameters • zone_name: the name of the default zone

Where In the CLI

To apply It is applied automatically

Add Zone

Products Guardian
Syntax conf.user configure vi zones add <subnet>[,<subnet>,...]
<zone_name>
Description Add a new zone containing all the nodes in one or more specified
subnetworks. More subnetworks can be concatenated using commas. The
subnetworks can be specified using the CIDR notation (<ip>/<mask>) or
by indicating the end IPs of a range (both ends are included: <low_ip>-
<high_ip>).
Remark: zones can be configured through the GUI, which is the preferred
way. Refer to Zone configurations on page 108

Parameters • subnet: the subnetwork or subnetworks assigned to the zone; both IPv4
and IPv6 are supported
• zone_name: the name of the zone

Where In CLI.
To apply It is applied automatically

Assign a level to a zone

Products Guardian
Syntax conf.user configure vi zones setlevel <level>
<zone_name>.
 | Configuration | 223

Description Assigns the specified level to a zone. All nodes pertaining to the given zone
will be assigned the level.
Remark: zones can be configured through the GUI, which is the preferred
way. Refer to Zone configurations on page 108.

Parameters • level: the level assigned to the zone

• zone_name: the name of the zone

Where In CLI.
To apply It is applied automatically

Assign a security profile to a zone

Products Guardian
Syntax conf.user configure vi zones setsecprofile
<security_profile> <zone_name>.
Description Assigns the specified security profile to a zone. The visibility of the alerts
generated within the zone will follow the configured security profile.
Refer to Security Profile .

Parameters • security_profile: the security profile assigned to the zone. Values: low,
medium, high, paranoid
• zone_name: the name of the zone

Where In CLI.
To apply It is applied automatically

Add custom protocol

Products Guardian
Syntax conf.user configure probe custom-protocol <name>
<transport> <port>
Description Add a new protocol specifying a port and a transport layer
Parameters • name: the name of the protocol, it will be displayed through the user
interface; DO NOT use a protocol name already used by SG. E.g. one
can use MySNMP, or Myhttp
• transport: the transport layer, choose "udp" or "tcp"
• port: the transport layer port used to identify the custom protocol

Where In CLI.
To apply It is applied automatically

Disabling a protocol

Products Guardian
Syntax conf.user configure probe protocol <name> enable false
Description Completely disables a protocol. This can be useful to fine tune the appliance
for specific needs. Any existing learned links will be deleted!
Parameters • name: the name of the protocol to disable

Where In CLI.
 | Configuration | 224

To apply It is applied automatically

Disabling variables extraction per protocol

Products Guardian
Syntax conf.user configure probe protocol <name>
variables_enable false
Description Completely disables variables extraction for a protocol. This can be useful to
fine tune the appliance for specific needs.
Parameters • name: the name of the protocol for which disable variables extraction

Where In CLI.
To apply It is applied automatically

Set IP grouping

Products Guardian
Syntax probe ipgroup <ip>/<mask>
Description This command permits to group multiple ip addresses into one single
node. This command is particularly useful when a large network of clients
accesses the SCADA/ICS system. To provide a clearer view and get an
effective learning phase, you can map all clients to a unique node simply by
specifying the netmasks (one line for each netmask). All sections requiring
the raw IP will get the appropriate raw data. For instance, the Trace on page
44 will show the raw IP in the provided pcaps. WARNING: this command
merges all nodes information into one in an irreversible way, and the
information about original nodes is not kept.
Parameters • ip/mask: the subnetwork identifier used to group the IP addresses

Where In the n2os.conf.user file.

To apply Restart both n2osids and n2ostrace with: service n2osids restart
AND service n2ostrace restart

Set IP grouping for Public Nodes

Products Guardian
Syntax probe ipgroup public_ips <ip>
Description This command permits to group all public IP addresses into one single node
(for instance, use 0.0.0.0 as the 'ip' parameter). This command is particularly
useful when the monitored network includes nodes that have routing to the
Internet. However, all sections requiring the raw IP will get the appropriate
raw data. For instance the Trace on page 44, will show the raw IP in the
provided pcaps. WARNING: this command merges all nodes information
into one in an irreversible way, and the information about original nodes is
not kept.
Parameters • ip: the ip to map all Public Nodes to

Where In the n2os.conf.user file.

To apply Restart both n2osids and n2ostrace with: service n2osids restart
AND service n2ostrace restart
 | Configuration | 225

Skip Public Nodes Grouping for a subnet

Products Guardian
Syntax probe ipgroup public_ips_skip <ip>/<mask>
Description This is useful when the monitored network has a public addressing that has
to be monitored (i.e. public addressing used as private or public addresses
that are in security denylists).
Parameters • ip/mask: the subnetwork identifier to skip

Where In the n2os.conf.user file.

To apply Restart both n2osids and n2ostrace with: service n2osids restart
AND service n2ostrace restart

Set special Private Nodes allowlist

Products Guardian
Syntax vi private_ips <ip>/<mask>
Description This rule will set the is_public property of nodes matching the provided mask
to false. This is useful when the monitored network has a public addressing
used as private (e.g. violation of RFC 1918).
Parameters • ip/mask: the subnetwork identifier to treat as private; both IPv4 and IPv6
are supported

Where In the n2os.conf.user file.

To apply Restart n2osids with: service n2osids restart

Set GUI logout timeout

Products CMC, Guardian

Syntax conf.user configure users max_idle_minutes
<timeout_in_minutes>
Description Change the default inactivity timeout of the GUI. This timeout is used to
decide when to log out the current session when the user is not active.
Parameters • timeout_in_minutes: amount of minutes to wait before logging out.

Where In CLI.
To apply It is applied automatically

Enable Syslog capture feature

Products Guardian
Syntax conf.user configure probe protocol syslog capture_logs
<true | false>
Description With this configuration rule you can enable the passively capture of the
syslog events. It is useful when you want to forward them to a SIEM, for
further details see Syslog Forwarder on page 105
Parameters • <true | false>: true in case you want to enable it, false otherwise.

Where In CLI.
To apply It is applied automatically
 | Configuration | 226

Enable Guardian HA

Products Guardian
Syntax conf.user configure guardian replica-of <other Guardian
id>
Description With this configuration rule you can enable the Guardian HA mode for two
Guardians that sniff the same traffic and are connected to the same CMC.
During normal operations only the primary Guardian sync with the CMC,
if it stops synchronizing the secondary Guardian will start synchronize the
records from the last primary Guardian update.
Parameters • <other Guardian id>: the id of the other Guardian, it can be found
on the CMC with the query appliances | where host ==
<appliance_hostname> | select id

Where In CLI.
To apply service n2osjobs stop

Disabling Vulnerability Assessment for some nodes

Products Guardian
Syntax conf.user configure va_notification matching
<key>=<value> discard
Description With this configuration rule you can disable Vulnerability Assessment for
node matching the specified rules. The effect of this configuration rule is to
discard the matching of CVE identifiers.
Parameters • key can be one from these values:
• id: the id of a node, it can be an IP address, a netmask in the CIDR
format or a MAC address.
• label: the label of a node.
• zone: the zone in which a node is located.
• type: the type of a node.
• vendor: the vendor of a node.
• value: if a simple string is specified the match will be performed with an
"equal to" case-sensitive criterion. The matching supports two operators:
• ^: starts with.
• [: contains.
These operators must be specified right after the = symbol and their
match is case-insensitive.
Examples:
• va_notification matching id=192.168.1.123 discard
• va_notification matching id=192.168.1.0/24 discard
• va_notification matching label=^abc discard

Where In CLI.
To apply service n2osva stop

Disabling CVE generation

Products Guardian
Syntax conf.user configure va cve enable false
 | Configuration | 227

Description With this configuration rule you can disable CVE generation. CPE
generation will still be active, as a consequence CVEs on the CMC will be
calculated. This setting is useful for saving resources on a Guardian when
CVEs are only used at the CMC level.
Parameters
Where In CLI.
To apply service n2osva stop

Enabling IPv6 Assets

Products Guardian
Syntax conf.user configure vi ipv6_assets enabled
Description With this configuration rule you can enable assets generation also when
nodes are IPv6.
Parameters
Where In CLI.
To apply It is applied automatically
 | Configuration | 228

Configuring the Garbage Collector

This section decribes how to configure the Environment Garbage Collector (GC). The Garbage
Collector lets the system to discard nodes, assets, and links that are not longer useful, thus saving
system resources.

Clean up old ghost nodes

Products Guardian
Syntax conf.user configure vi gc old_ghost_nodes <seconds>
Description Set the threshold after which idle nodes that are also not confirmed and not
learned are discarded by the garbage collector.
Parameters • seconds: number of seconds after which cleanup occurs (the default is
3600, the equivalent of one hour).

Where In CLI.
To apply It is applied automatically

Clean up old public nodes

Products Guardian
Syntax conf.user configure vi gc old_public_nodes <seconds>
Description Determines how long to keep public nodes that are inactive. Expressed in
seconds.
NOTE: This cleanup strategy only applies to nodes that are not learned.

Parameters • seconds: number of seconds after which cleanup occurs (default is

259200, the equivalent of three days).

Where In CLI.
To apply It is applied automatically

Clean up old ghost links

Products Guardian
Syntax conf.user configure vi gc old_ghost_links <seconds>
Description Determines how long to wait before removing links that are not real (for
example, a connection try whose endpoint is not responding on the specified
port). Expressed in seconds.

Parameters • seconds: number of seconds after which clean up occurs. By default, this
rule is disabled.

Where In CLI.
To apply It is applied automatically
 | Configuration | 229

Configuring alerts

Configure maximum number of victims

Products Guardian
Syntax conf.user configure alerts max_victims <num>
Description Define the maximum number of victims that each alert can contains. Victims
exceeding the given value are not stored. Default value is 1000
Parameters • num: maximum number of victims stored for each alert.

Where In CLI.
To apply It is applied automatically

Configure maximum length of description

Products Guardian
Syntax conf.user configure alerts max_description_length
<nchars>
Description Define the maximum number of characters that can contain the description
of each incident. When an incident is appendding an alert description, the
append is performed only if the incident description length is smaller then
the limit.

Parameters • nchars: maximum number of characters allowed in the description of

each incident.

Where In CLI.
To apply It is applied automatically

Configure the visibility of weak credentials

Products Guardian
Syntax conf.user configure alerts hide_username_on_alerts
<true|false>
conf.user configure alerts hide_password_on_alerts
<true|false>
Description These flags determine whether usernames and passwords should be
presented or not in the description of the weak credentials alerts. By default,
the credentials are visible.

Where In CLI.
To apply It is applied automatically
 | Configuration | 230

Configuring nodes

Set node label

Products Guardian
Syntax ids configure vi node <ip> label <label>
Description Set the label to a node in the Environment, the label will appear in the
Environment > Network View > Graph, in the Environment >
Network View > Nodes and in the Environment > Process View >
Variables
Parameters • ip: the IP address of the node
• label: the label that will be displayed in the user interface

Where In CLI.
To apply It is applied automatically

Set node Device ID with priority

Products Guardian
Syntax ids configure vi node <ip> device_id_with_priority
<device_id>;<priority>
Description Adds the Device ID to the set of node Device IDs. The final Device ID, used
for node grouping under Assets is the one with the highest priority
Parameters • ip: the IP address of the node
• device_id: the Device ID to add
• priority: the priority of the Device ID. If missing, it will be se to the lowest
priority value

Where In CLI.
To apply It is applied automatically

Override node Device ID

Products Guardian
Syntax ids configure vi node <ip> device_id_override
<device_id>
Description Adds the Device ID to the set of node Device IDs, giving it the maximum
priority value. This Device ID will be used for node grouping under Assets
Parameters • ip: the IP address of the node
• device_id: the Device ID to add (with the maximum priority)

Where In CLI.
To apply It is applied automatically

Enable or disable node

Products Guardian
Syntax ids configure vi node <ip> state <state_value>
Description This directive permits to disable a node. This setting has effect in the graph:
a disabled node will not be displayed.
 | Configuration | 231

Parameters • ip: the IP address of the node

• state_value: it can be either enabled or disabled

Where In CLI.
To apply It is applied automatically

Delete node

Products Guardian
Syntax ids configure vi node <ip> :delete
Description Delete a node from the Environment
Parameters • ip: the IP of the node to delete

Where In CLI.
To apply It is applied automatically

Define a cluster

Products Guardian
Syntax conf.user configure vi cluster <ip> <name>
Description This command permits to define an High Availability cluster of observed
nodes. In particular, this permits to: accelerate the learning phase by joining
the learning data of two sibling nodes, and to group nodes by cluster in the
graph.
Parameters • name: the name of the cluster
• ip: the ip address of a cluster node

Where In CLI.
To apply It is applied automatically
 | Configuration | 232

Configuring links

Set link last activity check

Products Guardian
Syntax conf.user configure vi link <ip1> <ip2>
<protocol> :check_last_activity <seconds>
Description Set the last activity check on a link, an alert will be raised if the link remains
inactive for more than the specified seconds
Parameters • ip1, ip2: the IPs of the two nodes involved in the communication
• protocol: the protocol
• seconds: the communication timeout

Where In CLI.
To apply It is applied automatically

Set link persistency check

Products Guardian
Syntax conf.user configure vi link <ip1> <ip2>
<protocol> :is_persistent
Description Set the persistency check on a link, if a new handshake is detected an alert
will be raised
Parameters • ip1, ip2: the IPs of the two nodes involved in the communication
• protocol: the protocol

Where In CLI.
To apply It is applied automatically

Delete link

Products Guardian
Syntax ids configure vi link <ip1> <ip2> :delete
Description Delete a link
Parameters • ip1, ip2: the IPs identifying the link

Where In CLI.
To apply It is applied automatically

Delete protocol

Products Guardian
Syntax ids configure vi link <ip1> <ip2> <protocol> :delete
Description Delete a protocol from a link
Parameters • ip1, ip2: the IPs identifying the link
• protocol: the protocol of the link to delete

Where In CLI.
To apply It is applied automatically
 | Configuration | 233

Delete function code

Products Guardian
Syntax ids configure vi link <ip1> <ip2> <protocol> fc
<func_code> :delete
Description Delete a function code from a protocol
Parameters • ip1, ip2: the IPs identifying the link
• protocol: the protocol of the link
• func_code: the function code to delete

Where In CLI.
To apply It is applied automatically

Enable link_events generation

Products Guardian
Syntax conf.user configure vi link_events <enabled|disabled>
Description Enable or disable the generation of link_events records, this feature can
have an impact on performance, enable it carefully
Where In CLI.
To apply It is applied automatically
 | Configuration | 234

Configuring variables

Set default variable history <enabled | disabled>

Products Guardian
Syntax ids configure vi variable default history <enabled |
disabled>
Description Set if the variable history is enabled or not, when not set it's disabled.
The amount of the history maintained can be configured in "Variable history
retention" section in Configuring retention on page 247
NOTE: when "enabled" the Guardian performance can be affected
depending on the amount of variables and the update rate

Parameters • <enabled | disabled>: use "enabled" when you want to enable it,
"disabled" otherwise

Where In CLI.
To apply It is applied automatically

Set variable history <enabled | disabled>

Products Guardian
Syntax ids configure vi variable <var_key> history <enabled |
disabled>
Description <enabled | disabled> Define the amount of samples shown in the graphical
history of a variable.
Parameters • var_key: the variable identifier
• <enabled | disabled>: Set if the variable history is enabled or not, when
not set it's disabled.
The amount of the history maintained can be configured in "Variable
history retention" section in Configuring retention on page 247
NOTE: when "enabled" the Guardian performance can be affected
depending on the update rate of the variable

Where In CLI.
To apply It is applied automatically

Set variable label

Products Guardian
Syntax ids configure vi variable <var_key> label <label>
Description Set the label for a variable, the label will appear in the Environment >
Process View sections
Parameters • var_key: the variable identifier
• label: the label displayed in the user interface

Where In CLI.
To apply It is applied automatically
 | Configuration | 235

Set variable unit of measure

Products Guardian
Syntax ids configure vi variable <var_key> unit <unit>
Description Set a unit of measure on a variable.
Parameters • var_key: the variable identifier
• unit: the unit of measure displayed in the user interface

Where In CLI.
To apply It is applied automatically

Set variable offset

Products Guardian
Syntax ids configure vi variable <var_key> offset <offset>
Description The offset of the variable that will be used to map the 0 value of the variable.
Parameters • var_key: the variable identifier
• offset: the offset value used to calculate the final value of the variable

Where In CLI.
To apply It is applied automatically

Set variable scale

Products Guardian
Syntax ids configure vi variable <var_key> scale <scale>
Description The scale of the variable that is used to define the full range of the variable.
Parameters • var_key: the variable identifier
• scale: the scale value used to calculate the final value of the variable

Where In CLI.
To apply It is applied automatically

Set variable last update check

Products Guardian
Syntax conf.user configure vi variable
<var_key> :check_last_update <seconds>
Description Set the last update check on a variable, if the variable value is not updated
for more than the specified seconds an alert is raised
Parameters • var_key: the variable identifier
• seconds: the timeout after which a stale variable alert will be raised

Where In CLI.
To apply It is applied automatically

Set variable quality check

Products Guardian
 | Configuration | 236

Syntax conf.user configure vi variable <var_key> :check_quality

<seconds>
Description Set the quality check on a variable, if the value quality remains invalid for
more than the specified seconds an alert is raised
Parameters • var_key: the variable identifier
• seconds: the maximum amount of consecutive seconds the variable can
have an invalid quality

Where In CLI.
To apply It is applied automatically

Set a variable critical state

Products Guardian
Syntax conf.user configure cs variable <id> <var_key> [<|>|=]
<value>
Description Define a new custom critical state on a single variable that will raise on
violation of defined range.
Parameters • id: a unique ID for this critical state
• var_key: the variable identifier
• operator: the operand to evaluate for the critical state to rise. For
instance, if the > operator is specified, the variable will have to be higher
than value to trigger the critical state.
• value: the variable value to check for

Where In CLI.
To apply It is applied automatically

Set a multiple critical state

Products Guardian
Syntax conf.user configure cs multi <id> variable c1 <var_key>
[<|>|=] <value> ^ variable c2 <var_key> [<|>|=] <value>
[^ ...]
Description Creates a multi-valued critical state, that is an expression of "variable critical
states", described above. The syntax is and AND (^) expression of the
single-variable critical state.
Parameters • id: a unique ID for this critical state
• var_key: the variable identifier
• operator: the operand to evaluate for the critical state to rise. For
instance, if the > operator is specified, the variable will have to be higher
than value to trigger the critical state.
• value: the variable value to check for

Where In CLI.
To apply It is applied automatically
 | Configuration | 237

Configuring protocols

Set CA size for iec101 protocol decoder

Products Guardian
Syntax conf.user configure probe protocol iec101 ca_size <size>
Description iec101 CA size can vary across implementations, with this configuration rule
the user can customize the setting for its own environment
Parameters • <size>: the size in bytes of the CA

Where In CLI.
To apply It is applied automatically

Set LA size for iec101 protocol decoder

Products Guardian
Syntax conf.user configure probe protocol iec101 la_size <size>
Description iec101 LA size can vary across implementations, with this configuration rule
the user can customize the setting for its own environment
Parameters • <size>: the size in bytes of the LA

Where In CLI.
To apply It is applied automatically

Set IOA size for iec101 protocol decoder

Products Guardian
Syntax conf.user configure probe protocol iec101 ioa_size
<size>
Description iec101 IOA size can vary across implementations, with this configuration
rule the user can customize the setting for its own environment
Parameters • <size>: the size in bytes of the IOA

Where In CLI.
To apply It is applied automatically

Set an arbitrary amount of bytes to skip before decoding iec101 protocol

Products Guardian
Syntax conf.user configure probe protocol iec101 bytes_to_skip
<amount>
Description Based on the hardware configuration iec101 can be prefixed with a fixed
amount of bytes, with this setting Guardian can be adapted to the peculiarity
of the environment.
Parameters • <amount>: the amount of bytes to skip

Where In CLI.
To apply It is applied automatically
 | Configuration | 238

Enable the Red Electrica Espanola semantic for iec102 protocol

Products Guardian
Syntax conf.user configure probe protocol iec102 ree <enabled|
disabled>
Description There is a standard from Red Electrica Espan#ola which changes the
semantic of the iec102 protocol, after enabling this setting the iec102
protocol decoder will be compliant to the REE standard.
Parameters • <enabled|disabled>: specify enabled to enable the Red Electrica
Espan#ola semantic

Where In CLI.
To apply It is applied automatically

Set the subnet in which the iec102 protocol will be enabled

Products Guardian
Syntax conf.user configure probe protocol iec102 subnet
<subnet>
Description The detection of iec102 can lead to false positives, this rules give the
possibility to the user to enable the detection on a specific subnet
Parameters • <subnet>: a subnet in the CIDR notation

Where In CLI.
To apply It is applied automatically

Enable iec102 on the specified port

Products Guardian
Syntax conf.user configure probe protocol iec102 port <port>
Description The detection of iec102 can lead to false positives, this rules give the
possibility to the user to enable the detection on a specific port
Parameters • <port>: the TCP port

Where In CLI.
To apply It is applied automatically

Set the subnet in which the iec103 protocol will be enabled

Products Guardian
Syntax conf.user configure probe protocol iec103 subnet
<subnet>
Description The detection of iec103 can lead to false positives, this rules give the
possibility to the user to enable the detection on a specific subnet
Parameters • <subnet>: a subnet in the CIDR notation

Where In CLI.
To apply It is applied automatically
 | Configuration | 239

Enable iec103 on the specified port

Products Guardian
Syntax conf.user configure probe protocol iec103 port <port>
Description The detection of iec103 can lead to false positives, this rules give the
possibility to the user to enable the detection on a specific port
Parameters • <port>: the TCP port

Where In CLI.
To apply It is applied automatically

Force iec101 semantics inside iec103 protocol

Products Guardian
Syntax conf.user configure probe protocol iec103
force_iec101_semantics true
Description Forces change of semantics for iec103 protocol to use ASDUs of iec101
Where In CLI.
To apply It is applied automatically

Allow to recognize as iec103 very fragmented sessions

Products Guardian
Syntax conf.user configure probe protocol iec103
accept_on_fragmented true
Description Allow to accept as iec103 those packets that are always incomplete,
thus allowing situations where the protocol is heavily fragmented to be
recognized.
Where In CLI.
To apply It is applied automatically

Enable or disable the persistence of the connections for Ethernet/IP Implicit

Products Guardian
Syntax conf.user configure probe protocol ethernetip-implicit
persist-connection <true|false>
Description The Ethernet/IP Implicit decoder of Guardian is able to detect handshakes
that are then used to decode variables. In some scenarios these
handshakes are not common but it's very important to persist them so that
Guardian can continue to decode variables after a reboot or an upgrade.
By enabling this option Guardian will store on disk the data needed to
autonomously reproduce the handshake phase after a reboot.
Parameters • <true|false>: a boolean to enable or disable the feature

Where In CLI.
To apply It is applied automatically

Set the subnet in which the tg102 protocol will be enabled

Products Guardian
Syntax conf.user configure probe protocol tg102 subnet <subnet>
 | Configuration | 240

Description The detection of tg102 can lead to false positives, this rules give the
possibility to the user to enable the detection on a specific subnet
Parameters • <subnet>: a subnet in the CIDR notation

Where In CLI.
To apply It is applied automatically

Set the port range in which the tg102 protocol will be enabled

Products Guardian
Syntax conf.user configure probe protocol tg102 port_range
<src_port>-<dst_port>
Description The detection of tg102 can lead to false positives, this rules give the
possibility to the user to enable the detection on a specific port range
Parameters • <src_port>: the starting port of the range
• <dst_port>: the ending port of the range

Where In CLI.
To apply It is applied automatically

Set the subnet in which the tg800 protocol will be enabled

Products Guardian
Syntax conf.user configure probe protocol tg800 subnet <subnet>
Description The detection of tg800 can lead to false positives, this rules give the
possibility to the user to enable the detection on a specific subnet
Parameters • <subnet>: a subnet in the CIDR notation

Where In CLI.
To apply It is applied automatically

Set the port range in which the tg800 protocol will be enabled

Products Guardian
Syntax conf.user configure probe protocol tg800 port_range
<src_port>-<dst_port>
Description The detection of tg800 can lead to false positives, this rules give the
possibility to the user to enable the detection on a specific port range
Parameters • <src_port>: the starting port of the range
• <dst_port>: the ending port of the range

Where In CLI.
To apply It is applied automatically

Disable variable extraction for a Siemens S7 area and type

Products Guardian
Syntax conf.user configure probe protocol s7 exclude <area>
<type>
 | Configuration | 241

Description For performance reasons or to reduce noise it's possible to selectively

exclude variables extraction for some areas and type.
Parameters • <area>: the area, some examples are: DB, DI, M, Q
• <type>: the type of the variable, some examples are: INT, REAL, BYTE

Where In CLI.
To apply It is applied automatically
 | Configuration | 242

Configuring decryption
The following sections decribe the configuration of Guardian's decryption capabilities for links. For
more decryption details beyond the scope of this manual, contact Nozomi Networks.

IEC 60870-5-7 / 62351-3/5 encrypted links

IEC TC57 (POWER SYSTEMS management and associated information exchange) develops the
standards 60870 and 62351. IEC 60870 part 5 (by WG3) describes systems used for telecontrol. IEC
62351 (by WG15) handles the security of TC 57 series.
IEC TC57 WG15 recommends the combination of IEC 62351-3 and 5 to secure IEC 60870-5-104 links:
• IEC 62351-3 is a TLS profile to secure power systems related communication.
• IEC 62351-5 is an application security protocol applicable to IEC 60870-5-101, 104, and derivatives.
Its implementation in terms of ASDUs (i.e., real encapsulation) is outlined in IEC 60870-5-7.
In order to decrypt IEC 62351-3 (TLS) traffic, you must meet these conditions:
• The private key for each TLS server (e.g. RTU, PLC) must be available; it is used to derive session
keys.
• All the equipment where decryption is needed must operate using the
TLS_RSA_WITH_AES_128_CBC_SHA (0x00002f) cipher suite. Often, this step is accomplished by
forcing either the client or the server to confine itself to that specific cipher suite.

Configuring IEC-62351-3
The following steps assume we're decoding the communication of a TLS server with the address
192.168.1.26.
1. Upload the TLS server’s private key to /data/cfg. The file name must match the server's address.
In our case, the file must be named 192.168.1.26.key.
Your key should be similar to the following:

2. In Guardian's Features Control Panel, enable link events; this provides visibility to the TLS decoded
handshakes; for example:
 | Configuration | 243

3. Specify the key file's location by defining it in the /data/cfg/n2os.conf.user file. To continue
our example, we would use the following string:

probe protocol iec104s tls private_key 192.168.1.26 /data/

cfg/192.168.1.26.key

4. Repeat these steps for each applicable TLS server key.

5. Run the following command:

service n2osids stop

 | Configuration | 244

Configuring trace

Trace size and timeout

A trace is a sequence of packets saved to the disk in the pcap format. The number of packets in a
trace is fixed, this way when a trace of N packets is triggered Guardian starts to write to disk the N/2
packets that were sniffed before the trace was triggered, after that it tries to save another N/2 packets
and then finalize the write operation, at this point the trace can be downloaded. To avoid a trace being
pending for too much time there is also a timeout, when the time expires the trace is saved also if the
desired number of packets has not been reached.

Retention
The number of traces the Guardian can keep is limited. It is possible to configure the maximum number
of traces saved on disk and the minimum percentage of disk free before the old traces will be deleted.

Figure 156: A schematic illustration of the trace saving process

Trace parameters
The parameters involved in the process of saving a trace can be configured in the file /data/cfg/
n2os.conf.user, here is an explanation of each parameter:

name default description

value
trace trace_size 5000 The maximum number of packets that will be
stored in the trace file.
trace trace_request_timeout 60 The time in seconds after which the trace
will be finalized also if the trace_size
parameter is not fulfilled
trace max_pcaps_to_retain 100 The maximum number of pcap files to keep
on disk, when this number is exceeded the
oldest traces will be deleted
trace min_disk_free 10 The minimum percentage of disk free under
which the oldest traces will be deleted
trace false It enables the persistence of trace_request
persist_alerts_trace_requests records for traces automatically generated
by alerts. By default, the persistence of such
records is disabled.

An example of trace configuration in the /data/cfg/n2os.conf.user file

trace trace_size 2000

 | Configuration | 245

trace trace_request_timeout 60
trace max_pcaps_to_retain 200
trace min_disk_free 25
 | Configuration | 246

Configuring Time Machine

In this section we will configure the Nozomi Networks Solution Time Machine functionality.

Set snapshot interval

Products CMC, Guardian

Syntax tm snap interval <interval_seconds>
Description Set the desired interval between snapshots, in seconds.
Parameters • interval_seconds: the amount of seconds between snapshots (default:
3600)

Where In the n2os.conf.user file.

To apply Restart with service n2osjobs stop

Set snapshot retention

Products CMC, Guardian

Syntax tm snap retention <snapshot_to_keep>
Description Set the desired amount of snapshots to keep. Older snapshots will be
deleted and overwritten.
Parameters • snapshot_to_keep: the overall amount of snapshots to keep (default: 50)

Where In the n2os.conf.user file.

To apply Restart with service n2osjobs stop

Set snapshot size retention

Products CMC, Guardian

Syntax tm snap size <snapshot_dir_size>
Description Set the maximum amount of space snapshots can occupy. Older snapshots
will be deleted and overwritten.
Parameters • snapshot_dir_size: the overall amount of space snapshots can occupy in
bytes (default: 500000000)

Where In the n2os.conf.user file.

To apply Restart with service n2osjobs stop

Enable or disable automatic snapshot for each alert

Products Guardian
Syntax tm snap on_alert <status>
Description It can enable or disable the possibility to take a snapshot for each alert.
Parameters • status: it can be either true, to enable the feature, or false, to disable it.
(default: false)

Where In the n2os.conf.user file.

To apply Restart with service n2osjobs stop
 | Configuration | 247

Configuring retention
Retention of historical data is controlled for each persisted entity by a configuration entry. Modify it to
extend or reduce the default retention.
By default, the CMC retains 500,000 alerts. Note that retaining large numbers of alerts can impair
performance. We recommend limiting the number of alerts generated rather than retaining more data.
If you want to retain more alerts, we recommend an iterative approach of incrementally increasing
this value and evaluating the system's performance. In some cases, you may want to send alerts to a
different system using our data integration features instead of retaining the alerts in the appliance.

Alerts retention

Products CMC, Guardian

Syntax conf.user configure retention alert rows
<rows_to_retain>
Description Set the amount of alerts to retain
Parameters • rows_to_retain: the number of rows to keep (default: 500000)

Where In CLI.
To apply It is applied automatically

Trace requests retention

Products Guardian
Syntax conf.user configure retention trace_request rows
<rows_to_retain>
Description Set the amount of trace requests to retain
Parameters • rows_to_retain: the number of rows to keep (default: 10000)

Where In CLI.
To apply It is applied automatically

Link events retention

Products Guardian
Syntax conf.user configure retention link_event rows
<rows_to_retain>
Description Set the amount of link events to retain
Parameters • rows_to_retain: the number of rows to keep (default: 2500000)

Where In CLI.
To apply It is applied automatically

Captured urls retention

Products Guardian
Syntax conf.user configure retention captured_urls rows
<rows_to_retain>
Description Set the amount of captured "urls" (http queries, dns queries, etc) to retain
Parameters • rows_to_retain: the number of rows to keep (default: 10000)
 | Configuration | 248

Where In CLI.
To apply It is applied automatically

Variable history retention

Products Guardian
Syntax conf.user configure retention variable_history rows
<rows_to_retain>
Description Set the amount of variable historical values to retain
Parameters • rows_to_retain: the number of rows to keep (default: 1000000)

Where In CLI.
To apply It is applied automatically

Node CVE retention

Products Guardian
Syntax conf.user configure retention node_cve rows
<rows_to_retain>
Description Set the maximum amount of node_cve entries to retain
Parameters • rows_to_retain: the number of rows to keep (default: 100000)

Where In CLI.
To apply service n2osva stop

Uploaded PCAPs retention

Products Guardian
Syntax conf.user configure retention input_pcap rows
<files_to_retain>
Description Set the amount of PCAP files to retain
Parameters • files_to_retain: the number of files to keep (default: 10)

Where In CLI.
To apply It is applied automatically
 | Configuration | 249

Configuring Bandwidth Throttling

It is possible to limit the bandwidth that an appliance has at its disposal by specifying the maximum
amount of allowed traffic.

Products Guardian, Remote Collector

Syntax system traffic_shaping bandwidth <max_bandwidth>
Description Set the maximum bandwidth that the appliance can use.
Parameters • max_bandwidth: the bandwidth limit (default: no limitation)

Where In the n2os.conf.user file.

To apply Reboot the machine

For example, we can set a limit of two megabytes with the following configuration command:

system traffic_shaping bandwidth 2Mb

Notice that this command affects only the appliance on which it is executed, its effects are not
propagated to other appliances.
 | Configuration | 250

Configuring Remote Collector Bandwidth Throttling

For a Remote Collecor, it is possible to limit the bandwidth for the traffic that is sniffed and forwarded
to the Guardian, without impacting other connections on the management port, by specifying the
maximum amount of allowed bandwidth.

Products Remote Collector

Syntax remote_sensor_max_bandwidth_kb_per_sec <max_bandwidth>
Description Set the maximum egress bandwidth of forwarded traffic to use.
Parameters • max_bandwidth: the bandwidth limit in Kilobytes per seconds (default: no
limitation)

Where In the n2os.conf.user file.

To apply Restart with service n2osrs restart

For example, we can set a limit of 100 Kilobytes per second with the following configuration command:

remote_sensor_max_bandwidth_kb_per_sec 100

Notice that this command affects only the appliance on which it is executed, its effects are not
propagated to other appliances.
 | Configuration | 251

Configuring the CMC synchronization

In this section we will configure the synchronization of the appliances with their CMC.

Set the notify interval

Products CMC, Guardian, Remote Collector

Syntax cmc sync interval <interval_seconds>
Description Set the desired interval between notification messages from the appliance to
the CMC, in seconds.
Parameters • interval_seconds: the amount of seconds between status notifications
(default: 60)

Where In the n2os.conf.user file.

To apply Restart with service n2osjobs stop

Set the DB synchronization interval

Products CMC, Guardian

Syntax cmc sync_db_interval <interval_seconds>
Description Set the desired interval between DB synchronizations from the appliance to
the CMC, in seconds.
Parameters • interval_seconds: the amount of seconds between DB synchronizations
(default: 60)

Where In the n2os.conf.user file.

To apply Restart with service n2osjobs stop

Set the filesystem synchronization interval

Products CMC, Guardian

Syntax cmc sync_fs_interval <interval_seconds>
Description Set the desired interval between filesystem synchronizations from the
appliance to the CMC, in seconds.
Parameters • interval_seconds: the amount of seconds between filesystem
synchronizations (default: 60)

Where In the n2os.conf.user file.

To apply Restart with service n2osjobs stop

Set the synchronization interval for binary files

Products CMC, Guardian

Syntax cmc sync_binary_files_interval <interval_seconds>
Description Set the desired interval between synchronizations of binary files from the
appliance to the CMC, in seconds.
Parameters • interval_seconds: the amount of seconds between binary files
synchronizations (default: 60)

Where In the n2os.conf.user file.

 | Configuration | 252

To apply Restart with service n2osjobs stop

Notify only visible alerts

Products CMC, Guardian

Syntax cmc sync send_only_visible_alert <true|false>
Description Configure the appliance to send only the alerts that are visible according to
the Security Profile.
Parameters • <true|false>: a boolean to enable or disable the feature (default: false)

Where In the n2os.conf.user file.

To apply Restart with service n2osjobs stop
 | Configuration | 253

Configuring session hijacking protection

Web management interface protects itself from session hijacking attacks binding web session
to ip addresses and browser configurations. When it detects differences on these parameters it
automatically destroy the session and records the error in the audit log. This feature is enabled by
default and it can be disabled using this configuration:

Products Guardian, CMC

Syntax ui session protection false
Description Disable session hijacking protection.
Parameters true / false (default: true)
Where In the n2os.conf.user file.
To apply It is applied automatically

When closing sessions the web management interface will record in the audit log this error text

Session hijacking detected, closing session

and the details of the affected session.

Configuring UDP Flood Detection
In this section we will configure the UDP flood detection.
The detection is enabled by default and it triggers when a victim receives 20'000 UDP packets per
second for at least 10 seconds.

Enable/disable detection

Products Guardian
Syntax vi udp_flood_detection enabled <value>
Description Enable/disable the UDP flood detection.
Parameters • value: either true (enabled) or false (disabled)

Where In the n2os.conf.user file.

To apply Reload with service n2osids reload

Set detection threshold

Products Guardian
Syntax vi udp_flood_detection packets_per_second <threshold>
Description Set the UDP flood detection threshold, in packets per second.
Parameters • threshold: the amount of UDP packets per second to be transmitted to
a victim for at least 10 seconds in order to trigger the detection (default:
20000)

Where In the n2os.conf.user file.

To apply Reload with service n2osids stop

For example, we can configure the UDP flood detection to trigger when a victim receives 40'000 UDP
packets per second for at least 10 seconds with the following configuration command:

vi udp_flood_detection packets_per_second 40000

Chapter

14
Compatibility reference
Topics: In this chapter you will receive compatibility information about
Nozomi Networks products.
• SSH compatibility
SSH compatibility

Supported SSH protocols (since 19.0.4)

Function Algorithms
Key exchange [email protected]
diffie-hellman-group-exchange-sha256
diffie-hellman-group14-sha256
diffie-hellman-group16-sha512
diffie-hellman-group18-sha512

Ciphers [email protected]
[email protected]
[email protected]
aes128-ctr
aes192-ctr
aes256-ctr

MACs hmac-sha2-256
hmac-sha2-512
[email protected]
[email protected]
[email protected]
[email protected]

Host Key ssh-rsa

Algorithms
ssh-ed25519
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521