61
www.mellanox.com Mellanox Technologies Confidential Mellanox NEO™ User Manual Version 1.2

Mellanox NEO 1 1 User Manual - ebook.konfigurasi.net · This manual is intended for cluster and data center administrators who are responsible for the deployment, configuration, and

  • Upload
    others

  • View
    7

  • Download
    0

Embed Size (px)

Citation preview

www.mellanox.com

Mellanox Technologies Confidential

Mellanox NEO™

User Manual

Version 1.2

Version 1.2 Contents

2 Document Number: MLNX-15-4587

Mellanox Technologies Confidential

Mellanox Technologies

350 Oakmead Parkway Suite 100

Sunnyvale, CA 94085

U.S.A.

www.mellanox.com

Tel: (408) 970-3400

Fax: (408) 970-3403

Mellanox Technologies, Ltd.

Hakidma 26

Ofer Industrial Park

Yokneam 2069200

Israel

www.mellanox.com

Tel: +972 (0)74 723 7200

Fax: +972 (0)4 959 3245

© Copyright 2015. Mellanox Technologies. All Rights Reserved.

Mellanox®, Mellanox logo, BridgeX®, ConnectX®, Connect-IB®, CoolBox®, CORE-Direct®, GPUDirect®, InfiniBridge®,

InfiniHost®, InfiniScale®, Kotura®, Kotura logo, MetroX®, MLNX-OS®, PhyX®, ScalableHPC®, SwitchX®, TestX®,

UFM®, Virtual Protocol Interconnect®, Voltaire® and Voltaire logo are registered trademarks of Mellanox Technologies,

Ltd.

CyPU™, ExtendX™, FabricIT™, FPGADirect™, HPC-X™, Mellanox Care™, Mellanox CloudX™, Mellanox NEO™,

Mellanox Open Ethernet™, Mellanox PeerDirect™, Mellanox Virtual Modular Switch™, MetroDX™, NVMeDirect™,

StPU™, Switch-IB™, Unbreakable-Link™ are trademarks of Mellanox Technologies, Ltd.

All other trademarks are property of their respective owners.

NOTE:

THIS HARDWARE, SOFTWARE OR TEST SUITE PRODUCT (“PRODUCT(S)”) AND ITS RELATED

DOCUMENTATION ARE PROVIDED BY MELLANOX TECHNOLOGIES “AS-IS” WITH ALL FAULTS OF ANY

KIND AND SOLELY FOR THE PURPOSE OF AIDING THE CUSTOMER IN TESTING APPLICATIONS THAT USE

THE PRODUCTS IN DESIGNATED SOLUTIONS. THE CUSTOMER'S MANUFACTURING TEST ENVIRONMENT

HAS NOT MET THE STANDARDS SET BY MELLANOX TECHNOLOGIES TO FULLY QUALIFY THE PRODUCT(S)

AND/OR THE SYSTEM USING IT. THEREFORE, MELLANOX TECHNOLOGIES CANNOT AND DOES NOT

GUARANTEE OR WARRANT THAT THE PRODUCTS WILL OPERATE WITH THE HIGHEST QUALITY. ANY

EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT ARE DISCLAIMED.

IN NO EVENT SHALL MELLANOX BE LIABLE TO CUSTOMER OR ANY THIRD PARTIES FOR ANY DIRECT,

INDIRECT, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES OF ANY KIND (INCLUDING, BUT NOT

LIMITED TO, PAYMENT FOR PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,

OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

ARISING IN ANY WAY FROM THE USE OF THE PRODUCT(S) AND RELATED DOCUMENTATION EVEN IF

ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Contents Version 1.2

3

Mellanox Technologies Confidential

Contents

Document Revision History .................................................................................................................. 6

About This Manual ................................................................................................................................ 7

1 Mellanox NEO™ Overview ............................................................................................................. 9

1.1 Mellanox NEO’s Benefits ........................................................................................................ 9

1.1.1 Central Management Console .................................................................................. 9

1.1.2 In-Depth Visibility and Control .................................................................................. 9

1.1.3 Quick Resolution of Problems .................................................................................. 9

1.1.4 Open Architecture ..................................................................................................... 9

1.2 Mellanox NEO as Network API ............................................................................................. 10

1.3 Mellanox NEO™ Software Architecture ............................................................................... 10

1.3.1 Mellanox NEO Graphical User Interface ................................................................ 11

1.3.2 Mellanox NEO Controller ........................................................................................ 11

1.3.3 Mellanox NEO Providers ........................................................................................ 11

1.3.4 Communication Protocols ....................................................................................... 11

2 Installation and Initial Configuration ........................................................................................... 12

2.1 Installation Requirements ..................................................................................................... 12

2.2 Supported Operating Systems ............................................................................................. 12

2.3 Downloading the Mellanox NEO Software ........................................................................... 12

2.4 Installing the Mellanox NEO Software .................................................................................. 12

3 Launching Mellanox NEO™ GUI .................................................................................................. 13

3.1 User Authentication .............................................................................................................. 13

4 Operating Mellanox NEO Services .............................................................................................. 14

5 Uninstalling the Mellanox NEO™ Software ................................................................................ 14

6 Getting Familiar with the Mellanox NEO™ GUI .......................................................................... 15

6.1 Account Password, General Information, User Manual and Log-out Menu ......................... 15

6.2 Network Notifications Icon .................................................................................................... 15

6.3 Main Tabs/Categories/Navigator Buttons ............................................................................. 16

6.3.1 Dashboard Window ................................................................................................ 16

6.3.2 Managed Elements Windows ................................................................................. 16

6.3.3 Reports Window ..................................................................................................... 19

6.3.4 Jobs ........................................................................................................................ 19

6.3.5 Tasks ...................................................................................................................... 20

6.3.6 Events ..................................................................................................................... 20

6.3.7 Notifications ............................................................................................................ 20

6.3.8 Logs ........................................................................................................................ 20

Version 1.2 Contents

4 Document Number: MLNX-15-4587

Mellanox Technologies Confidential

6.3.9 Providers ................................................................................................................. 20

6.3.10 Settings ................................................................................................................... 21

7 Fabric Dashboard for On Screen Status Monitoring ................................................................. 22

7.1 Overview of Fabric Dashboard ............................................................................................. 22

7.1.1 Fabric Utilization ..................................................................................................... 22

7.1.2 Top Alerted Devices ............................................................................................... 23

7.1.3 Top Bandwidth Utilization ....................................................................................... 23

7.1.4 Top Congested Devices ......................................................................................... 24

7.1.5 Recent Activity ........................................................................................................ 24

7.2 Managed Elements ............................................................................................................... 25

7.2.1 Devices ................................................................................................................... 25

7.2.2 Inventory ................................................................................................................. 31

7.2.3 Ports ........................................................................................................................ 31

7.3 Reports ................................................................................................................................. 33

7.3.1 Saving Reports ....................................................................................................... 34

7.4 Jobs ...................................................................................................................................... 36

7.5 Tasks .................................................................................................................................... 37

7.6 Events ................................................................................................................................... 40

7.6.1 Events Policy .......................................................................................................... 40

7.7 Logs ...................................................................................................................................... 41

7.8 Providers ............................................................................................................................... 42

7.8.1 Configuring Access Credentials within Mellanox NEO™ ....................................... 46

7.9 Settings ................................................................................................................................. 49

7.10 Notifications .......................................................................................................................... 52

8 Managed Devices Configuration ................................................................................................. 54

8.1 Configuring SNMP on MLNX-OS® Switch (for Port Counters Monitoring) .......................... 54

8.2 Configuring MLNX-OS switch for Sending Traps to Mellanox NEO™ ................................. 55

8.3 Configuring MLNX-OS Switch for LLDP Discovery .............................................................. 56

8.3.1 Option 2 .................................................................................................................. 56

8.4 Configuring Host for LLDP Discovery ................................................................................... 56

Appendix A: Application Events ............................................................................................... 57

Appendix B: Device Events ....................................................................................................... 58

Appendix C: Mellanox NEO™ GUI Fields Validations ............................................................. 60

Contents Version 1.2

5

Mellanox Technologies Confidential

List of Tables

Table 1: Document Revision History ....................................................................................................... 6

Table 2: Typography ................................................................................................................................ 7

Table 3: Supported Operating Systems ................................................................................................ 12

Table 4: Navigator Tabs ........................................................................................................................ 16

Table 5: Job States ................................................................................................................................ 19

Table 6: Device Port Details .................................................................................................................. 31

Table 7: Access Credentials .................................................................................................................. 46

Table 8: Application Events ................................................................................................................... 57

Table 9: Device Events .......................................................................................................................... 58

Table 10: Mellanox NEO GUI Fields Validations................................................................................... 60

Version 1.2 Document Revision History

6

Mellanox Technologies Confidential

Document Revision History

Table 1: Document Revision History

Release Date Description

1.2 August 2015 Added:

7.10: Notifications

Edited:

6.3.2: Managed Elements Windows

7.2.1: Devices

7.3: Reports

7.5: Tasks

7.6: Events

7.9: Settings

1.1 July 2015 Added:

Table 5: Job States

Edited:

Mellanox UFM®-VPI is now Mellanox NEO™

1.3: Mellanox NEO™ Software Architecture

Table 2: Typography

6.1: Account Password, General Information, User

Manual and Log-out Menu

6.3.4: Jobs

7.3.1: Saving Reports

7.8: Providers

8.1: Configuring SNMP on MLNX-OS® Switch (for

Port Counters Monitoring)

8.2: Configuring MLNX-OS switch for Sending Traps

to Mellanox NEO™

8.3: Configuring MLNX-OS Switch for LLDP

Discovery

Appendix A: Application Events

Appendix C: Mellanox NEO™ GUI Fields Validations

Removed:

Installing the Mellanox NEO Software on a VM

1.0 April 2015 First revision

Beta 1.0 January 2015 Beta revision

Mellanox NEO™ User Manual Version 1.2

7

Mellanox Technologies Confidential

About This Manual

Audience

This manual is intended for cluster and data center administrators who are responsible for the

deployment, configuration, and day-to-day maintenance of Mellanox Devices.

Document Conventions

The following conventions might appear in this document.

NOTE: Identifies important information that contains helpful suggestions.

CAUTION: Alerts you to the risk of personal injury, system damage, or loss of data.

WARNING: Warns you that failure to take or avoid a specific action might result in

personal injury or a malfunction of the hardware or software. Be aware of the hazards

involved with electrical circuitry and be familiar with standard practices for preventing

accidents before you work on any equipment.

Typography

The following table describes typographical conventions in Mellanox documentation. All

terms refer to isolated terms within body text or regular table text unless otherwise

mentioned in the Notes column.

Table 2: Typography

Term, Construct,

Text Block

Example Notes

File name, pathname /opt/neo/controller/c

onf/controller.conf

-

Console session (code) -> flashClear

<CR>

Complete sample line or block. Comprises

both input and output.

The code can also be shaded.

Linux shell prompt # The "#"character stands for the Linux shell

prompt.

String < > or [] Strings in < > or [ ] are descriptions of what

will actually be shown on the screen, for

example, the contents of <your ip> could be

192.168.1.1

Version 1.2 About This Manual

8

Mellanox Technologies Confidential

Related Documentation

For additional information, see the following documents:

Mellanox NEO™ Quick Start Guide

Mellanox NEO™ Release Notes

Mellanox NEO™ User Manual Version 1.2

9

Mellanox Technologies Confidential

1 Mellanox NEO™ Overview

Mellanox NEO™ is a powerful platform for managing scale-out computing networks.

Mellanox NEO™ enables data center operators to efficiently provision, monitor and operate

the modern data center fabric.

Mellanox NEO™ serves as interface to the fabric, thus extending existing tools capabilities

into monitoring and provisioning the data center network. Mellanox NEO™ uses an

extensive set of REST APIs to allow access to fabric-related data and provisioning activities.

Mellanox NEO™ eliminates the complexity of fabric management. It automates the

configuration of devices, provides deep visibility into traffic and health, and provides early

detection of errors and failures.

1.1 Mellanox NEO’s Benefits

Mellanox NEO presents the following benefits:

Reduces complexity of fabric management

Provides in-depth visibility into traffic and health information

Network API supports integration, automation and SDN programmable fabrics

Historical health and performance graphs

Generates preventive maintenance and “soft degradation” alerts

Quickly troubleshoots topology and connectivity issues

Integrates and streamlines fabric information into your IT systems

1.1.1 Central Management Console

Mellanox NEO™ provides network and device management functions via one central

console. Its centralized dashboard can be used to monitor, troubleshoot, configure and

optimize the system via a single interface.

1.1.2 In-Depth Visibility and Control

Mellanox NEO includes an advanced granular monitoring engine that provides real-time

access to switch, enabling cluster-wide health and performance monitoring, real-time

identification of problems and failures, quick problem resolution via granular threshold-

based alerts and utilization dashboard.

1.1.3 Quick Resolution of Problems

Mellanox NEO provides comprehensive information from switches, showing errors and

traffic issues such as congestion. The information is presented in a concise manner over a

unified dashboard and configurable monitoring sessions. The monitored data can be

correlated per job and customer, and threshold-based alarms can be set.

1.1.4 Open Architecture

Mellanox NEO provides an advanced REST interface and SDK package that are integrated

with external management tools. The combination enables data center administrators to

Version 1.2 Application Events

10

Mellanox Technologies Confidential

consolidate management dashboards while flawlessly sharing information among the various

management applications, synchronizing overall resource scheduling, and simplifying

provisioning and administration.

1.2 Mellanox NEO as Network API

Mellanox NEO serves as interface to the fabric, thus extending existing tools capabilities

into monitoring and provisioning the data center network. Mellanox NEO uses an extensive

set of REST APIs to allow access to fabric-related data and provisioning activities.

The interface can provide external tools with the fabric topology, device health and

performance status, alerts, and device and fabric management actions.

This allows taking advantage of existing tools and enhancing them, as well as building new

DevOps oriented management frameworks.

For further information on Mellanox NEO API documentation, please refer to the NEO SDK

User Manual.

1.3 Mellanox NEO™ Software Architecture

Mellanox NEO architecture includes controller and service providers (Device Manager,

Provisioning, Fabric Manager, Monitoring and Access Credentials Manager).

The controller transfers information from the service providers to the user, as well as

controls the service providers and verifies their status. It queries and fetches providers’

information and performs operations such as:

Stores a list of supported logs per each provider

Pauses, resumes, resets and fetches a specific log

Maintains a connection with a provider

Figure 1: Mellanox NEO Software Architecture

Mellanox NEO™ User Manual Version 1.2

11

Mellanox Technologies Confidential

1.3.1 Mellanox NEO Graphical User Interface

The Mellanox NEO Web GUI is the front end of the application. It communicates with the

Mellanox NEO RET API, in order to retrieve and display the relevant information.

1.3.2 Mellanox NEO Controller

The Mellanox NEO controller is the central component that enables data collection from all

the service providers. The collected data is maintained in a central repository. The controller

exposes a Restful API that allows retrieving any type of information and running any type of

supported actions.

1.3.3 Mellanox NEO Providers

Mellanox NEO providers are the data sources for the controller.

There are 6 providers as follows:

IP Discovery Provider

Device Management Provider

Provisioning Provider

Monitoring Provider

Access Credentials Provider

Ethernet (LLDP) Discovery Provider

Each Provider is an independent process (service) which communicates with the controller.

1.3.4 Communication Protocols

Mellanox NEO uses the following communication protocols:

HTTPS – used for communicating with Mellanox NEO REST API and Mellanox NEO

WebUI, as well as to collect chassis data regarding Mellanox devices

SNMP – used for collecting connectivity data and monitoring data

SSH – used for provisioning

Version 1.2 Application Events

12

Mellanox Technologies Confidential

2 Installation and Initial Configuration

2.1 Installation Requirements

Prior to the installation process, make sure that:

1. A supported version of Linux (RH6.5/CentOS6.5) is installed on your machine.

2. Python 2.6 is installed on the machine.

3. You have http/https access from your client machine (on which a browser is running) to

the machine that you intend to run Mellanox NEO™ on.

2.2 Supported Operating Systems

Table 3: Supported Operating Systems

Mellanox NEO Version Platform OS

Mellanox NEO™ Bare Metal machine

VM as one package

RedHat 6.5

RedHat 6.5

2.3 Downloading the Mellanox NEO Software

To download the Mellanox NEO 1.1 software:

1. Log into Mellanox’s Licensing and Download Portal:

http://license1.mellanox.com/LMManage/login.aspx.

2. Click the “Software” tab, select the relevant version of the software and click the zip file

to download.

3. In the Download file window, click the “Download” link.

4. Save the file on your local drive.

5. Click “Close”.

2.4 Installing the Mellanox NEO Software

To install the Mellanox NEO software:

1. Copy the Mellanox NEO installation package to a local temporary directory (example:

/tmp).

2. Enter the temporary directory.

cd /tmp

3. Extract the Mellanox NEO installation package.

tar zxvf neo-1.1.0-25.el6.tar.gz

4. Enter the new created directory.

cd neo

5. Install Mellanox NEO (recommended installation).

./neo-installer.sh –c –p all

6. [Optional] Run Mellanox NEO manually after installation is completed.

Mellanox NEO™ User Manual Version 1.2

13

Mellanox Technologies Confidential

(If the “-r” option was not used)

/opt/neo/neoservice start

7. Install and run Mellanox NEO (recommended installation).

./neo-installer.sh –c –p all -r

3 Launching Mellanox NEO™ GUI

To launch a Mellanox NEO GUI session

1. Start the Mellanox NEO server.

2. Launch the GUI by entering the following URL in your browser:

http://<NEO_server_IP>/neo

8. In the Login Window, enter your User Name and your predefined user Password and

click Submit.

3.1 User Authentication

Mellanox NEO User Authentication is based on standard Apache User Authentication. Each

Web Service client application must authenticate against the Mellanox NEO server to gain

access to the system.

The Mellanox NEO software comes with one predefined user:

Username: admin

Password: 123456

NOTE: it is recommended that you change the default password to a new and personalized

one to ensure that the your NEO account is safe from unauthorized access.

Version 1.2 Application Events

14

Mellanox Technologies Confidential

4 Operating Mellanox NEO Services

Mellanox NEO User can stop, start or restart Mellanox NEO services, or check their status

at any time.

To start Mellanox NEO services, run:

/opt/neo/neoservice start

In order to stop Mellanox NEO™ services, run:

/opt/neo/neoservice stop

In order to restart Mellanox NEO services, run:

/opt/neo/neoservice restart

In order to check Mellanox NEO services status, run:

/opt/neo/neoservice status

5 Uninstalling the Mellanox NEO™ Software

To uninstall the Mellanox NEO software, please run the following command:

/opt/neo/neo-uninstaller.sh -c -p all

Mellanox NEO™ User Manual Version 1.2

15

Mellanox Technologies Confidential

6 Getting Familiar with the Mellanox NEO™ GUI

The Mellanox NEO Software has several main GUI views. Before exploring the different

options, it is recommended to perform the following steps:

NOTE: The steps below can be performed by administrators only.

1. Click on the “Settings” tab:

Select the “Users” view to add new Mellanox NEO users, and define users’ roles and

credentials.

Select the “Email” view to add recipient lists. Upon user’s definition, these lists could

be used to distribute specific event alerts to a group of recipients.

For further instructions, see Settings.

2. Click on the “Events” tab to activate and deactivate events, and define the severity,

condition-value, description and notification parameters for each event. For further

instructions, see Events.

6.1 Account Password, General Information, User Manual and Log-out Menu

By clicking on the small profile icon at the top right corner of the interface’s frame, a drop

down menu appears. Users can change the password of their own account, read general

information about the Mellanox NEO version they are using, access the User Manual, and

log-out of the system.

6.2 Network Notifications Icon

Clicking on the small envelope icon on the top right corner of the interface’s frame, will lead

to the “Notifications” tab. The number next to the icon indicates the quantity of unread

network notifications. For further information, see Notifications.

Version 1.2 Application Events

16

Mellanox Technologies Confidential

6.3 Main Tabs/Categories/Navigator Buttons

The following table describes the main Mellanox NEO windows and categories:

Table 4: Navigator Tabs

Tab Icon Function Description

Dashboard Provides single view highlighting information and network status.

Managed

Elements

Provides a list of devices, inventory, ports and groups.

Reports Presents several reports of information collected by the

management system, and allows to save and load them.

Jobs Displays all the running and completed jobs in the system.

Tasks Displays future scheduled Jobs.

Events Provides notification events or critical device faults of the switch

and server data events. The “Events Policy” view allows the user to

activate and deactivate events, and define the severity, condition-

value, description and notification parameters for each event.

Notifications Available for administrators only. Displays all network

notifications.

Logs Available for administrators only. Displays detailed logs and

alarms that are filtered and sorted by category.

Providers Available for administrators only. Provides information on

Mellanox NEO building blocks.

Settings Available for administrators only. General system settings (default

access credentials, user management).

6.3.1 Dashboard Window

The Mellanox NEO™ dashboard enables an efficient network view from a single screen, and

serves as a starting point for event or metric exploration. The central dashboard provides

single view highlighting information and network status in the following smaller dashboard

windows:

Fabric Utilization (pie chart which also appears in the daily report)

Top Alerted Devices

Top Bandwidth Utilization

Top Congested Ports (check xmit wait for Ethernet)

Latest Network\Device Events

For more information, please refer to section Overview of Fabric Dashboard.

6.3.2 Managed Elements Windows

The Managed Elements panel provides a list of devices, inventory, ports and groups.

The Devices window displays information such as: the IP address, name, system type,

health, status and profile. Right click on a device or on multiple devices will allow

Mellanox NEO™ User Manual Version 1.2

17

Mellanox Technologies Confidential

removing them, as well as performing each of the following actions: Provisioning,

Reboot, SW Upgrade and Acknowledgment (provided that the selected devices are

capable of these actions).

For more information, please refer to Managed Elements.

The Inventory window provides detailed information about each device part (such as

CPU and FAN) - the serial number, part number, model, vendor state and health.

The Ports window provides information about all ports in the fabric - protocol type,

active speed, MTU, operational state, admin state and health.

The Groups window provides information about existing groups, their members and

group credentials (if defined), and allows the user to create new groups.

In addition, a right click on a specific group will offer the following selection of actions:

Modify Members: opens the Group Wizard in which members can be removed and

added to the group.

Delete: upon clicking on the “OK” button in the dialog box, the group will be

removed from NEO.

Provisioning: allows applying a command or a sequence of commands on all group

members at once, or on specific group members, per user selection.

NOTE: While the user may create a task for the entire group, the changes will apply to

members included in the group at the time of the task’s execution.

NOTE: Provisioing templetes of specific arguments can not be applied on groups.

Version 1.2 Application Events

18

Mellanox Technologies Confidential

Reboot: upon clicking on the “OK” button in the dialog box, all the devices in the

group will be rebooted.

SW Upgrade: when selecting this option, a dialog box appears, requiring the user to

fill in the relevant details in order to perform the upgrade on all the devices in the

group.

Report: when selecting this option, the user is forwarded to the “Reports” panel, in

which all members of the chosen group already appear as “Selected Devices”.

NOTE: Not all devices support generating reports. In case the selected group includes such

a device, a warnning will appear, and the device will be omitted.

Acknowledge: acknowledges all events related to the devices in the selected group.

Mellanox NEO™ User Manual Version 1.2

19

Mellanox Technologies Confidential

6.3.3 Reports Window

The Report panel presents several reports of information collected by the management

system. Mellanox NEO offers several options of reports: per ports or per devices.

For more information, refer to the Reports section.

6.3.4 Jobs

The Jobs panel displays all of Mellanox NEO’s running Jobs. A Job is a running task defined

by a user and applied on one or more of the devices (provisioning, software upgraded, switch

reboot etc.)

Mellanox NEO users can monitor the progress of a running job, as well as the time it was

created, its last update description and its status. The status value can be “Running”, during

operation, “Pending”, in case another job is already running, “Completed with Errors”, in

case an error has occurred, and “Completed”. To cancel a pending job, right-click on the

relevant job, and then choose “Abort”.

Table 5: Job States

Job State Description

Created Job was created and will shortly start running.

Pending Job is pending by Mellanox NEO. This state appears in

case another job that contains at least one common

device is already running.

Running The pending job was released and is now running.

Completed All sub-jobs were completed successfully

Completed with Errors All sub-jobs were completed, but on some of them,

errors occurred.

Aborted A pending job was canceled by the user.

Jobs can also be tasks scheduled by the system. In such cases, the users can monitor the

progress of these jobs but cannot control them.

For more information, please refer to Jobs.

Version 1.2 Application Events

20

Mellanox Technologies Confidential

6.3.5 Tasks

The Tasks panel presents future scheduled Jobs. The following tasks are supported:

Selecting a single or multiple devices and setting an action such as software upgrade or

provisioning (CLI-command) and the action setting data

Selecting specific action on device / devices and create a task from this action and its

setting data

Adding or deleting a task

Dynamically selecting devices using filters (wildcards) tasks

For more information, please refer to section Tasks.

6.3.6 Events

Mellanox NEO™ includes an advanced granular monitoring engine that provides real time

access to switch and server data events. Network events can either be notification events or

critical device faults. The events information includes severity, time.

For more information, please refer to Events.

6.3.7 Notifications

NOTE: This panel is visible to administrators only.

The “Notifications” tab is Mellanox NEO’s incoming messages box, providing the

administrators network notifications. For more information, please refer to Notifications.

6.3.8 Logs

NOTE: This panel is visible to administrators only.

The Logging panel presents detailed logs and alarms that are filtered and sorted by category,

providing visibility into traffic and device events as well as into Mellanox NEO server

activity history.

For more information, please refer to section Logs.

6.3.9 Providers

NOTE: This panel is visible to administrators only.

Providers are the building blocks of Mellanox NEO™. Each provider runs a specific service

such as Managing Device Access, Device Provisioning, and IP Discovery. Providers are

controlled by a controller. They can either run together with the controller on the same

machine or separately on a different device or VM (or container in the future).

For more information, please refer to Providers.

Mellanox NEO™ User Manual Version 1.2

21

Mellanox Technologies Confidential

6.3.10 Settings

NOTE: This panel is visible to administrators only.

The Settings panel allows administrators to edit users’ profiles and define general system

settings, such as default access credentials.

Version 1.2 Application Events

22

Mellanox Technologies Confidential

7 Fabric Dashboard for On Screen Status Monitoring

7.1 Overview of Fabric Dashboard

The Dashboard contains snapshot of the network view and day to day required information

such as Reports, Tasks, Jobs and Recent Events.

Network activities are displayed in the following manner:

7.1.1 Fabric Utilization

Fabric Utilization displays information on groups of switches in a pie chart view where

each switch belongs to a group according to its utilization status.

Mellanox NEO™ User Manual Version 1.2

23

Mellanox Technologies Confidential

7.1.2 Top Alerted Devices

Top Alerted Devices displays the total amount of critical events for the selected switches.

7.1.3 Top Bandwidth Utilization

The Top Bandwidth Utilization chart displays the most utilized switches in the fabric, based

on the "Normalized Bandwidth" calculated counter.

Version 1.2 Application Events

24

Mellanox Technologies Confidential

7.1.4 Top Congested Devices

Top Congested Devices displays information on normalized congestions based on the

number of delayed packets (packets that wait in queue) and bandwidth loss.

7.1.5 Recent Activity

Recent Activity provides direct access to recent events. The recent events are displayed after

clicking the red button on the upper right side of the dashboard.

There is also a list of critical events on the right side of the page which can be extracted after

choosing “View Error Events” button.

Mellanox NEO™ User Manual Version 1.2

25

Mellanox Technologies Confidential

7.2 Managed Elements

The Managed Elements tab provides a list of devices, inventory, ports and groups.

7.2.1 Devices

Devices information includes the IP address of each device, the device’s name, system type,

status, health and profile.

The “System Type” icon could be a switch ( ) or a host ( ). The switch icon will

also appear in case of a host with a bridge interface. Mellanox’s switches are

automatically identified by Mellanox NEO, and their switch icon is updated accordingly (

).

In case a device is discovered via the ETH Discovery provider, a “Not Supported” status

will be shown in the “Profile” column.

To add a device manually, click on the “Add” button and insert the Device IP address. If

you are adding a Mellanox switch, check the “Mellanox Switch” checkbox. Once you are

done adding devices, click on the “Add Devices” button. A job will be created

automatically.

To remove a device, right-click on it, and select “Remove”. A job will be created

automatically.

Version 1.2 Application Events

26

Mellanox Technologies Confidential

When clicking on the switch IP address, users are redirected to the switch’s web page, in

which they are able to configure the switch as desired.

When marking only a single device, a list with the following information appears on the

right side of the screen:

NOTE: the “Inventor OS”, “Events”, “Jobs” and “Credentials” displays are not available

for systems that are detected via the ETH Discovery provider.

Ports Tab: Provides details on each port of the device

Mellanox NEO™ User Manual Version 1.2

27

Mellanox Technologies Confidential

Inventory Tab: Provides details on switch parts, such as FAN and CPU.

OS Tab: Provides details on the Operating Systems installed on the switch

Events Tab: Lists specific switch related events.

Version 1.2 Application Events

28

Mellanox Technologies Confidential

Jobs Tab: Lists switch jobs and their status.

Credentials Tab: displays access credentials for the specific device in four protocols –

HTTP, SSH, SNMP, SNMP v3.

Groups Tab: lists the groups of which the specific device is a member.

Mellanox NEO™ User Manual Version 1.2

29

Mellanox Technologies Confidential

Links Tab: details the active links of the specific device. The “Peer Name” and “Peer IP”

columns specify the management peer IP and name, and the “Peer Port” column refers to

the port to which the interface is connected. In case the “Peer Port” is “Unknown”, the

interface is up, but no ETH discovery (LLDP) connection information is available.

Config Tab: displays the latest running config and allows updating it and saving it

locally. It is possible to view the configuration changes history according to the changes’

date and time, as well as compare two configuration files and track the differences

between them. The added text appears in green, while the removed text is red and

crossed-out.

Right click on a device will show actions that can be done on it:

Acknowledge: Acknowledges all events related to the selected device(s). This action will

gray out the selected device events.

Reboot: Reboots the device. When choosing reboot, a dialog box appears, requiring the

users to confirm their choice or create a reboot task.

Version 1.2 Application Events

30

Mellanox Technologies Confidential

SW Upgrade: Enables the user to upgrade the device’s software. When choosing SW

Upgrade, a dialog box appears, requiring the users to fill in the relevant details in order to

perform the upgrade.

3. Choosing “Create Task” directs the user to the Tasks page

4. Choosing “Submit” directs the user to the Jobs page and starts the upgrade process

immediately.

Mellanox NEO™ User Manual Version 1.2

31

Mellanox Technologies Confidential

Provisioning: Enables the user to send CLI commands via the CLI player. The

commands can be sent to one or more devices. Mellanox NEO provides templates with

common CLI commands. Clicking on “Provisioning” opens a CLI Player dialog, where

the user is required to fill in the desired CLI commands and choose an action.

Choosing “Create Task” directs the user to the Tasks page.

Choosing “Submit” directs the user to the Jobs page and starts the provisioning process

immediately.

7.2.2 Inventory

Mellanox Inventory page provides a detailed presentation of each device part (such as CPU

and FAN), part number, SKU and serial number.

7.2.3 Ports

The Ports page provides the following details on each device port.

Table 6: Device Port Details

Details Description

Device The device name

Port name The port name

Version 1.2 Application Events

32

Mellanox Technologies Confidential

Details Description

Protocol Shows the port’s used protocol. It can be either Ethernet or InfiniBand

Active speed (Mbps) The actual speed in which the port operates

MTU (Maximum

Transmission Unit)

The standard MTU is 576, however ISPs often suggest using 1500

Operational State Up/Down

Admin State ---

Health ---

Once a port is selected, the user can choose to view the following counters:

In Octets Rate – Received Data Rate in MBps

Out Octets Rate –Transmit Data Rate in MBps

Normalized Bandwidth – Percentage of Bandwidth utilization in %

Normalized Congested Bandwidth – Percentage of Dropped Bandwidth in %

The “Errors” tab includes the following counters:

In Discards

In Errors

Out Discards

Out Errors

Symbol Errors

Mellanox NEO™ User Manual Version 1.2

33

Mellanox Technologies Confidential

7.3 Reports

Reports may be used to monitor the success and faults of the network and its operations.

The initial view lists the saved reports. Administrators can view all saved reports, while

standard users can only view the reports they create. Right-click on a specific report opens a

menu with the options to load the report or delete it from the list. Multiple reports can be

selected and deleted at once.

To generate a report, click on the “New” button, select the type and the list of objects; define

the time frame, and check the checkboxes of the required counters. Reports can also be

generated for groups of devices, directly from the Groups tab. Go to Managed Elements

Groups, right-click on the group you wish to generate a report for, and select “Report”.

Available Objects:

Version 1.2 Application Events

34

Mellanox Technologies Confidential

1. Device

2. Port

Available Counters:

1. In Octets Rate – Received Data Rate in MBps

2. Out Octets Rate –Transmit Data Rate in MBps

3. Normalized Bandwidth – Percentage of Bandwidth utilization in %

4. Normalized Congested Bandwidth – Percentage of Dropped Bandwidth in %

Time Frame:

1. Last Hour

2. Last Day

3. Last Week

4. Last Month

7.3.1 Saving Reports

The generated reports can be saved or printed by clicking on the designated buttons.

Mellanox NEO™ User Manual Version 1.2

35

Mellanox Technologies Confidential

A Report Title can be composed of 4-20 alphanumeric characters, as well as “_”

(underscore) and “-“ (dash). See Appendix C: Mellanox NEO™ GUI Fields

Validations.

The Report Description field is optional, and can contain an unlimited number of

characters.

Users can save a report within 30 minutes from its creation time.

Once a report is saved, it can be exported to a CSV or a PDF file, by clicking on the

“Save” button, and selecting the desired format.

Version 1.2 Application Events

36

Mellanox Technologies Confidential

Removing temporary reports is done by a garbage collector mechanism that is

activated every 5 minutes.

By default, the maximum number of reports that can be saved is 200, while each

user can save up to 20 reports (the administrator can keep saving reports even after

reaching the 20 report limit, but once the system’s 200 report limit is met, no

additional reports could be saved, unless reconfiguration is performed).

To configure the maximum number of reports to save:

1. Open the /opt/neo/controller/conf /controller.cfg file.

2. Find the Report section.

3. Set the maximum allowed number of saved reports in the system by changing the

max_reports_per_system value (the default is 200).

4. Set the maximum allowed number of saved reports per user by changing the

max_reports_per_user value (the default is 20).

5. Restart Mellanox NEO-controller.

To configure the report’s garbage collector cycle interval:

1. Open the /opt/neo/controller/conf /controller.cfg file.

2. Find the Report section.

3. Set the garbage_collector_interval value to the desired number (the default is 5 minutes).

4. Restart Mellanox NEO-controller.

7.4 Jobs

The Jobs screen displays all Mellanox NEO™ running tasks which were defined by a user

and applied on one or more switches.

Mellanox NEO supports the following jobs:

Software upgrade

Reboot

Provisioning

Mellanox NEO users can monitor the progress of a running job, as well as the time it was

created, last update description and status.

When an action (software upgrade, reboot or provisioning) is started by the user, a new job is

created. The initial state of every job is “Created”. When the action is completed, the job

state value can be either ‘Completed’, to indicate a successful job, or

‘CompleteWithError’, if an error has occurred. In this case, the fault status will appear in

red.

If during a switch action the related service (provider) went down, all service (provider)

related jobs will be aborted and the related jobs state will change to “Aborted”

A Job can also be a task that was scheduled by the system. Mellanox NEO users can monitor

the progress of these jobs as well, but cannot control them.

Mellanox NEO™ User Manual Version 1.2

37

Mellanox Technologies Confidential

For each job, a detailed list with a Summary Information field is available. Choosing ‘view

Summary’ will display the errors that occurred upon failure.

7.5 Tasks

The Tasks panel displays the full Mellanox NEO™ task list.

A task is an action defined by a user to apply on one or more devices or groups. It can be

saved with no execution date, set to run immediately (in which case, it will turn into a job),

or scheduled to occur once or repeatedly in a predefined time.

To create a new task:

Step 1: In the “Tasks” panel, click on the “New” button. The Tasks Wizard will open and

allow you to select the desired operation: provisioning, SW upgrade or reboot.

You may associate the task to specific devices or groups by checking the

“Associate Objects” checkbox. If the checkbox is left unchecked, a template will

be generated, and you will be required to select objects only when running the task.

Version 1.2 Application Events

38

Mellanox Technologies Confidential

Step 2: Click on the “Next” button. In some cases, you will be requested to fill-in several

necessary parameters and provide additional information before the task can be

executed.

Step 3: The “Execution” tab allows you to save the generated task as a template, save and

run it immediately, or schedule a different running time. If you wish to generate a

recurring task, select “Schedule” as the Execution Type, and insert the desired start

time, interval units, interval value and end time. Click on the “Finish” button to

complete the process.

The task showed in the following example will occur once every 2 days, starting on

August 19th, 2015, at 3:30 PM, and ending on August 29, 2015, at 03:08 PM.

Mellanox NEO™ User Manual Version 1.2

39

Mellanox Technologies Confidential

If you choose to not run the task immediately, it will appear in the “Pending Tasks” table.

In case that the task’s execution has been scheduled for a later time, a small clock icon (

) will appear next to its listing.

To view the task’s properties, click on the small speech balloon icon ( ) in the

description column.

To run a pending task on all devices in the network, right click on it, and select “Run on

all”.

To clone a pending task, right click on it and select “Clone”. The original task you wish

to clone must not be associated to devices or groups. When generating the clone, you will

be requested to associate it to objects of your choice.

When clicking on a pending task, its clones, if there are any, appear in the “Cloned

Tasks” table below.

To remove a pending task, right click on it, and select “Remove”.

A new task can be generated through the Managed Elements panel as well. Go to

“Devices” or “Groups”, choose one of the available options, and click on the “Create

Task” button:

Version 1.2 Application Events

40

Mellanox Technologies Confidential

7.6 Events

Events information is accessible through the dashboard or through the main menu. This

view provides direct access to critical and recent events.

The events infrastructure allows for filtering events by criteria and defining them based on

various triggers (e.g. traps and threshold crossing), upon configurable ranges and severities.

A user may acknowledge one or more events by right-clicking on them. The acknowledged

events will be grayed-out.

Events can be also derived from SNMP traps sent by the switch.

7.6.1 Events Policy

The “Events Policy” view allows the user to activate and deactivate events, and define the

severity, condition-value and description of each event.

By clicking on an event name, a table with the following columns is displayed:

“Active” – check or uncheck the checkboxes in this column to activate or deactivate

events, respectively.

Mellanox NEO™ User Manual Version 1.2

41

Mellanox Technologies Confidential

“Email Notification” ( ) – set recipient lists to which alert emails will be sent when the

event occurs, by clicking on the plus sign adjacent to the relevant event. For instructions

on how to set a default email client, see Settings.

“Severity” – there are 5 severity types: Info, Notice, Warning, Error and Critical. You

may match each of the events to the appropriate severity type, as you see fit.

“Trigger”, “Operator” and “Value” – these 3 parameters are used to define the

circumstances which lead to the event’s generation. The “Value” is configurable, and

may be a single number, or a range of values, depending on the event type.

In the example shown below, a “Critical CPU Temperature” event will be generated in

case of a CPU temperature that exceeds (>) 90°C.

“Event Description” – a brief definition of the event. You may edit the event description

by clicking on it.

“Task” – associate an existing task to the selected condition.

“Filter” – select a specific group for which the conditional event will apply. If no filter is

set, the event will apply on all the devices in the network.

To create a new filtered condition, right click on the event you wish to clone, choose “Create

a new filtered condition”, and select the groups you wish to apply the new conditional event

on.

Further information on events can be found in Appendix A: Application Events and in

Appendix B: Device Events.

7.7 Logs

Log types:

console.log – contains the union of related component (controller or provider) logs

controller.log – contains logging information for Mellanox NEO’s central controller

component

events.log – contains logging information regarding events of a related component

Version 1.2 Application Events

42

Mellanox Technologies Confidential

jobs.log – contains logging information regarding related component jobs (currently

running actions)

repository.log - contains logging information on related component repository changes

zmq.log – contains logging information on related component ZMQ communication

rest.log - contains logging information on rest calls for a related component

web-info.log – contains logging information on web access of a related component

monitors.log – contains logging information on Graphite1 accessing via controller

monitoring API

Log files are located in the file system, according to the specific component (Controller or

Provider):

Controller logs are located at: /opt/neo/controller/log

Access Credentials Provider logs are located at: /opt/neo/providers/ac/log

IP Discovery Provider logs located at: /opt/neo/providers/discovery/log

Device Manager Provider logs located at: /opt/neo/providers/dm/log

Monitoring Provider logs located at: /opt/neo/providers/monitor/log

Provisioning Provider logs located at: /opt/neo/providers/provisioning/log

ETH Discovery Provider logs located at: eth discovery log /opt/neo/providers/ethdisc/log/

7.8 Providers

Providers are the building blocks of Mellanox NEO™. Each provider runs a specific service,

such as Managing Device access, Device Provisioning, IP Discovery, etc.

Providers are controlled by a controller and can either run together with it on the same

machine, or run separately on a different device or VM (or container, in the future).

In case of a disconnected provider, a small bell icon appears at the top right corner of the

screen. To identify the disconnected provider, click on the “Providers” tab, and in the

“Connected” column of the “Providers information” table, look for the red “thumbs down”

icon.

1 Graphite is a Scalable Realtime Graphing open source tool (http://graphite.wikidot.com/start) licensed by Creative Commons Attribution-

ShareAlike 3.0 License.

Mellanox NEO™ User Manual Version 1.2

43

Mellanox Technologies Confidential

Device Manager

Mellanox NEO™ will collect Chassis Discovery and information on Mellanox switches,

such as modules, traps, temperature, ports, OS, etc. For the device manager to receive SNMP

traps for all managed switches, all systems must be configured accordingly.

Device Access Manager

The Credentials Provider is responsible for managing the access credentials of all managed

systems and groups (defaults).

Devices access credential can be managed via Mellanox NEO at three levels:

5. Global level (global groups) – relevant for all devices that use a specific protocol (http,

ssh or snmp).

6. Group level – relevant for all devices which belong to a specific user-defined group.

7. Device level – relevant for a specific device for which credentials were set (once unique

device access credentials are set, they overwrite global or group credentials definitions.)

The credentials provider is agnostic to the stored attributes, in order to allow support for any

protocol in the future.

For more information about access credentials configuration, see Configuring Access

Credentials within Mellanox NEO.

Monitor Manager

Forwards samples of all switch port counters to an internal 3rd party software: Graphite.

The controller will sample the counters of all the switches in the fabric at a configurable

interval (default=5 minute). The results will be displayed by Graphite.

For more information, see Configuring SNMP on MLNX-OS® Switch (for Port Counters

Monitoring).

Version 1.2 Application Events

44

Mellanox Technologies Confidential

ETH Discovery

The role of the ETH Discovery Provider is to discover the Ethernet topology type according

to the LLDP protocol. In this phase, the LLDP information is collected using SNMP

protocol. The controller initiates the periodic discovery process by providing a list of start-

points and connection information. The provider sends the discovered data periodically,

when it is containing the CIM objects and relations. The controller aggregator integrates the

CIM objects and relations into the existing model and adds new devices as necessary.

For ETH discovery to work properly, the user must configure LLDP for all managed

devices. For more information, see Configuring MLNX-OS Switch for LLDP Discovery and

Configuring Host for LLDP Discovery.

NOTE: For LLDP Discovery to work properly on MLNX-OS systems, MLNX-OS version

3.4.1802 is a minimum requirement.

IP Discovery

IP Discovery provider is used for MLNX-OS switches discovery.

IP Discovery provider can operate in 2 optional modes:

8. Auto-Discovery mode (default mode) – automatic discovery using Mellanox NEO-

Agent. In this mode, Mellanox NEO controller discovers all MLNX-OS switches by

sending multicast messages. Every MLNX-OS switch responds to the controller with its

IP address. This information is stored in the controller repository.

9. File-Based Discovery – manual discovery using a specific file. In this mode the users

should list all the IP addresses in their fabric in a predefined file:

/opt/neo/providers/discovery/conf/ip_discovery.csv

10. When IP Discovery is loading, it reports the list of configured IP addresses to the

controller. The controller stores this information in its repository.

In both modes the user can configure a list of subnets to be excluded from the IP

Discovery by setting the “subnet_filters” field in the IP Discovery configuration file:

/opt/neo/providers/discovery/conf/netservice.cfg

Device Provisioning

The Device Provisioning function allows the users to play a list of switch CLI commands on

a list of Mellanox switches.

Mellanox NEO™ User Manual Version 1.2

45

Mellanox Technologies Confidential

To run a command or a series of commands on one device or more:

Step 4: Right-click on the desired devices, and select “Provisioning.

Step 5: In the dialog window, type the switch CLI commands or that you wish to run on

the selected devices, click on the “Apply” button, and then on the “Start” button.

You may save the command as a template by clicking on the “Save as template”

button. In this case, you will be requested to insert Template Name and

Description, and choose a Category.

Your category selection will determine the template’s availability according to the

device’s protocol type: a template categorized as “General” will be available for all

managed devices, a template categorized as “InfiniBand” will be available for

InfiniBand devices only, and a template categorized as “Ethernet” will be available

for Ethernet devices only.

New CLI templates can also be uploaded manually to the Mellanox NEO templates

folder (/opt/neo/controller/templates).

Version 1.2 Application Events

46

Mellanox Technologies Confidential

Step 6: Once the commands are initiated, Jobs and Sub-Jobs will be opened accordingly.

To view the commands’ outputs, click on the “View Summary” button.

7.8.1 Configuring Access Credentials within Mellanox NEO™

7.8.1.1 Using Mellanox NEO GUI

The default global access credentials are detailed in the following table. They can be

changed through the “Settings” tab by selecting the “Credentials” view and filling-in the

desired credentials for the relevant protocol.

Table 7: Access Credentials

HTTP SSH SNMP SNMP v2 SNMP v3 SNMP TRAP

Usename:

admin

Password:

admin

Username:

admin

Password:

admin

Read

Community:

public

Write

Community:

private

Port: 161

Timeout: 2 [s]

Retries: 2

Port: 162

Interface: eth0

Protocol: v2

Community:

public

--- Private

authentication

protocol

password:

adminauth123

Privacy

protocol

password:

adminpriv123

Mellanox NEO™ User Manual Version 1.2

47

Mellanox Technologies Confidential

It is possible to overwrite the defined credentials for a specific group or a specific system in

the fabric:

Unique Group Access Credentials

This option can be enabled when creating a new group by checking the “Create Unique

Credentials for this Group” checkbox. Once the group is created, its access credentials

changeability mode cannot be altered. In case the checkbox is checked, devices for which

unique access credentials are defined, will not appear as available for association with this

group.

NOTE: A device cannot be associated with more than one group that allows creating

unique access credentials.

Version 1.2 Application Events

48

Mellanox Technologies Confidential

In order to change the access credentials for a specific group, select the desired group, click

on the “Credentials” tab and edit the credentials for the relavnat protocol.

Unique Device Access Credentials

In order to change the access credentials for a specific device, click on the “Devices” sub-

menu, select the “Credentials” tab and edit the credentials for the relevant protocol.

NOTE: In case the selected device is associeted with a group for which unique group

access credentials are defined, the unique credentials defined for the group will be

overwritten by the unique device credentials, for the specific device.

Mellanox NEO™ User Manual Version 1.2

49

Mellanox Technologies Confidential

7.9 Settings

11. The “Users” view lists the system’s users and their roles, and allows adding new users by

clicking on the “New” button and filling-in the required credentials (see Mellanox

NEO™ GUI Fields Validations). Administrators can also remove users from the list,

upgrade users’ level to administrators and downgrade administrators’ level to users.

NOTE: The “admin” administrator is the only user that can not be removed or

downgraded.

NOTE: Unlike administrators, standard users cannot:

Change credentials

Access the “Notifications” tab

Access the “Logs” tab

Access the “Providers” tab

Version 1.2 Application Events

50

Mellanox Technologies Confidential

12. The “Credentials” view allows administrators to change the default global access

credentials for each protocol (HTTP, SSH, SNMP and SNMP v3). Such changes will

only apply to devices for which no unique access credentials are defined (either

exclusively or in association to a group).

13. The Email tab is divided to two sections:

NOTE: This view is visible to administrators only.

The SMTP section allows administrators to configure a default email client to be used by

Mellanox NEO for event notifications. Once the requested SMTP parameters are filled,

the user can select the type of events for which email notifications are generated. For

more information, see Events.

Mellanox NEO™ User Manual Version 1.2

51

Mellanox Technologies Confidential

The Recipient Lists section allows the user to add email addresses lists to be used to

distribute specific event alerts. To add a new list, click on the “New” button, insert a list

name and a list of the desired email addresses, separated by commas (with no spaces).

Version 1.2 Application Events

52

Mellanox Technologies Confidential

7.10 Notifications

The “Notifications” tab is Mellanox NEO’s incoming messages box, providing the

administrators network notifications of several types:

1. MTU mismatch in the network – Mellanox NEO is checking what is the maximum

transmission unit (MTU) configured in the network, and in which ports in the network a

different MTU is defined. Once a mismatch is found, a notification will be generated.

2. OS mismatch – Mellanox NEO verifies that the latest operation system (OS) version is

installed on all devices in the network. A notification is generated in case a device with an

older version is found.

NOTE: There are three OS types (IB, VPI and Ethernet), and therefore, three different

latest versions.

3. Configuration Diff – in case a configuration change has been performed on one of the

switches, Mellanox NEO will generate a notification of this type.

By clicking on a specific notification, a table with further information appears on the right

side of the screen. For each of the notifications, the table can be saved, copied or printed

by the user. In notifications of the “Configuration Diff” type, the user may also view the

changed content by clicking on “View Diff Summary”. The added text appears in green,

while the removed text is red and crossed-out.

Mellanox NEO™ User Manual Version 1.2

53

Mellanox Technologies Confidential

Mellanox NEO scans the network for mismatches and changes once every 24 hours. The

user can view the number of unread notifications at any time, as it is constantly displayed

next to the small envelope icon on the top right corner of the interface’s frame.

Unread notifications will appear in a bold font until they are read for the first time. To

remove notifications, right-click on the relevant notification and select “Remove”.

Version 1.2 Application Events

54

Mellanox Technologies Confidential

8 Managed Devices Configuration

In order for Mellanox NEO™ to retrieve information from managed MLNX-OS® switches

and hosts, some additional configuration on switches and hosts is required.

8.1 Configuring SNMP on MLNX-OS® Switch (for Port Counters Monitoring)

To configure all managed MLNX-OS® switches via Mellanox NEO GUI, perform the

following:

Step 1: Go to the “Managed Devices” table (Managed Elements Devices).

Step 2: Select the desired MLNX-OS switches to configure SNMP on (you can select

multiple switches).

Step 3: Right click on the selected switches and click on “Provisioning”

Step 4: In the “Provisioning” view, click on the “Templates” button and load the “Enable-

SNMP” template.

Step 5: Click on the “Apply” button.

Step 6: To send the configuration to the selected switches, click on the “Start” button. This

will redirect you to the “Jobs” table.

Step 7: Make sure that all sub-jobs (all switches) are completed successfully.

NOTE: To configure the SNMP-V3 protocol, refer to the MLNX-OS User Manual.

Mellanox NEO™ User Manual Version 1.2

55

Mellanox Technologies Confidential

NOTE: For the SNMP monitoring to work properly, the credentials on the switch must

match the Mellanox NEO switch settings.

8.2 Configuring MLNX-OS switch for Sending Traps to Mellanox NEO™

To configure all managed MLNX-OS switches via the Mellanox NEO GUI, perform

the following:

Step 1: Go to the “Managed Devices” table (Managed Elements Devices).

Step 2: Select the desired MLNX-OS switches to configure SNMP on (you can select

multiple switches).

Step 3: Right click on the selected switches and click on “Provisioning”

Step 4: In the “Provisioning” view, click on the “Templates” button and load the “Set-

SNMP-V2c-Traps” template

Step 5: Click on the “Apply” button.

Step 6: Set the “ip_address” field in the “Global Variables” panel to be your Mellanox

NEO IP address.

Step 7: Click on the “Start” button. This will redirect you to the “Jobs” table.

Step 8: Make sure that all sub-jobs (all switches) are completed successfully.

NOTE: To configure the SNMP-V3 protocol, refer to the MLNX-OS User Manual.

NOTE: For the SNMP monitoring to work properly, the credentials on the switch must

match the Mellanox NEO™ switch settings.

Version 1.2 Application Events

56

Mellanox Technologies Confidential

8.3 Configuring MLNX-OS Switch for LLDP Discovery

8.3.1 Option 2

To configure all managed MLNX-OS switches via the Mellanox NEO GUI, perform

the following:

Step 1: Go to the “Managed Devices” table (Managed Elements Devices).

Step 2: Select the desired MLNX-OS switches to configure SNMP on (you can select

multiple switches).

Step 3: Right click on the selected switches and click on “Provisioning”

Step 4: In the “Provisioning” view, click on the “Templates” button and load the “Enable-

LLDP” template.

Step 5: Click on the “Apply” button.

Step 6: Click on the “Start” button to send the configuration to the selected switches.

Step 7: Click on the “Start” button. This will redirect you to the “Jobs” table.

Step 8: Make sure all sub-jobs (all switches) are completed successfully.

8.4 Configuring Host for LLDP Discovery

In order to allow the LLDP to discover hosts, you must configure it accordingly. For

instructions, refer to the following community page: HowTo Enable LLDP on Linux Servers

for Link Discovery.

Mellanox NEO™ User Manual Version 1.2

57

Mellanox Technologies Confidential

Appendix A: Application Events

Table 8: Application Events

Event Triggers Permission

Level

Default

Severity

Category Sub

Category

Supported

Job completed

with errors

All sub jobs were

completed, but

some of them

failed

user error Application Jobs Yes

Job completed All sub jobs were

completed

successfully

user info Application Jobs Yes

Device

removed

Device removed admin Info Application General Yes

Version 1.2 Device Events

58

Mellanox Technologies Confidential

Appendix B: Device Events

Table 9: Device Events

Event Triggers Permission

Level

Default

Severity

Category Sub

Category

Comments

General

Fault

Internal Bus Error trap

Process Crash trap

Process Unexpected

Exit trap

Unexpected Shutdown

trap

Chip Down trap

Module is

unresponsive trap

admin warning Device General triggers

discovery

refresh –

modules

General

Fault

recovery

Module has been

restored to its normal

state trap

admin info Device General triggers

discovery

refresh

modules

Power fault Insufficient Power trap

Power Redundancy

Mismatch trap

Low Power trap

Power supply is

unresponsive trap

Unit voltage is out of

range trap

admin warning Device Power triggers

discovery

refresh

modules,

power

supplies

Power fault

recovery

Low Power Recover

trap

Unit voltage is in range

trap

Power supply has been

restored to its normal

state trap

admin Info

Device Power triggers

discovery

refresh –

power

supplies

Fans fault Insufficient Fans trap

Fan speed is below

minimal range trap

Fan is unresponsive

trap

Fan is not present trap

Insufficient number of

working fans in the

system trap

admin warning Device Fans triggers

discovery

refresh

modules,

fans

Fans fault

recovery

Insufficient Fans

Recover trap

Fan has been restored

to its normal state trap

The system currently

has sufficient number

admin Info Device Fans triggers

discovery

refresh

modules,

fans

Mellanox NEO™ User Manual Version 1.2

59

Mellanox Technologies Confidential

of working fans trap

Temperature

Fault

Power supply

temperature is too hot

trap

Chip Over

Temperature Reset trap

Chip Over

Temperature trap

Chip temperature is too

hot trap

Temperature Sensor

over threshold trap

admin warning Device Temperat

ure

triggers

discovery

refresh

temperatur

e sensors

Temperature

Fault

recovery

Power supply

temperature is back to

normal trap

Chip temperature is

back to normal trap

admin info Device Temperat

ure

triggers

discovery

refresh

temperatur

e sensors

High CPU

Utilization

CPU Utilization High

trap

admin warning Device CPU

Low Disk

Space

Disk Space Low trap admin warning Device Resource

s

IB SM state

changed

IB SM up trap

IB SM down trap

IB SM restart trap

admin info Device Networki

ng

Link up Link Up trap admin info Device Networki

ng

triggers

topology

refresh

Link down Link Down trap admin warning Device Networki

ng

triggers

topology

refresh

Authenticati

on Failure

Authentication

Failure trap

admin warning Device Security

Test trap

received

Test trap admin info Device General

Version 1.2 Mellanox NEO™ GUI Fields Validations

60

Mellanox Technologies Confidential

Appendix C: Mellanox NEO™ GUI Fields Validations

Table 10: Mellanox NEO GUI Fields Validations

Page Field Validation

Reports Title Alphanumeric + “_”, “-“ (4-20)

Users

UserName Alphanumeric + “_”, “-“, “.” (4-20)

Password All characters except space (4-20)

Groups Name Alphanumeric + “_”, “-“ (4-20)

Credentials (HTTP)

UserName Alphanumeric + “_”, “-“, “.” (1-20)

Password All characters except space (1-20)

The password field can be left blank.

Credentials (SSH)

UserName Alphanumeric + “_”, “-“, “.” (1-20)

Password All characters except space (1-20)

The password field can be left blank.

Credentials (SNMP)

Read Community All characters except space (1-20)

Write Community All characters except space (1-20)

Credentials (SNMPV3) UserName All characters (1-20)

SMTP

Sender Name Alphanumeric + “_”, “-“ , space allowed (4-20)

UserName Alphanumeric + “_”, “-“, “.” (4-20)

Password All characters except space (4-20)

The password field can be left blank.

Email A valid email address (exactly one “@” sign, and at

least one “.” in the section following the “@”)

Recipients Valid Emails, comma separated

Server Valid Server Name -

Valid Server IP

Port int 1-65535

Event Policy

Value int 0-65535

Description All characters (1-1024)

Mellanox NEO™ User Manual Version 1.2

61

Mellanox Technologies Confidential

Page Field Validation

SW Upgrade Protocol ‘scp’ or ‘ftp’

Server Valid Server Name Regex

Valid Server IP Regex

Path All characters (1-1024) must start with “/”

Image All characters (1-1024)

UserName Alphanumeric + “_”, “-“, “.” (1-20)

Password All characters except space (1-20)