Tp NMS UG

Tpnms Ug tpNMS_UG tpNMS_UG doc down res static.tp-link.com 3:

2016-08-01

: Tp-Link Tpnms Ug tpNMS_UG doc down_res

Open the PDF directly: View PDF .
Page Count: 123

Download
Open PDF In Browser	View PDF

tpNMS
Network Management System
User Manual

REV1.0.0
1910011672

Content
1 Quick Start.........................................................................................................................1
1.1

Prepare for Installation............................................................................................................... 2
Computer Requirements..............................................................................................................................2
Compatible Devices.......................................................................................................................................2
Installation Topology.....................................................................................................................................2

1.2

Download and Install tpNMS..................................................................................................... 5

1.3

Log in to the Application............................................................................................................ 5
Launch the tpNMS..........................................................................................................................................5
Fix the Launch Problems..............................................................................................................................6
Log in to tpNMS...............................................................................................................................................9

1.4

Change Your Password and Email.......................................................................................... 11

1.5

Set the Email Server for Alarm Notifications......................................................................... 11

2 Monitor Network........................................................................................................... 13
2.1

Customize the Widgets on the Home Screen....................................................................... 13

2.2

View the Widgets........................................................................................................................ 15

3 Discover and Manage Resources............................................................................... 18
3.1

Discover Devices on Your Network......................................................................................... 18
Schedule a Discovery Job.......................................................................................................................... 18
Manage Discovery Templates................................................................................................................. 23

3.2

View and Manage Devices........................................................................................................ 25
View the Device List.................................................................................................................................... 26
Remove a Device.......................................................................................................................................... 28
Synchronize a Device.................................................................................................................................. 28
Log in to a Device......................................................................................................................................... 29
Ping or Traceroute a Device..................................................................................................................... 30
Reboot a Device............................................................................................................................................ 31
Access Config................................................................................................................................................. 31

3.3

Import Devices............................................................................................................................ 33

3.4

Add Devices into Groups.......................................................................................................... 34
View Groups................................................................................................................................................... 34
Add Devices to Static Group.................................................................................................................... 35
Add Devices to Dynamic Group.............................................................................................................. 36
Delete Groups................................................................................................................................................ 36

3.5

View and Manage Links on Your Network............................................................................ 37
View Links on Your Network.................................................................................................................... 37
Discover Links on Your Network............................................................................................................. 38
Add a Link....................................................................................................................................................... 38

3.6

Manage Maps and Topologies................................................................................................. 39
View the Maps in the Map List................................................................................................................. 40
Add a Map....................................................................................................................................................... 40
Add a Device.................................................................................................................................................. 40
Add a Link....................................................................................................................................................... 41
Delete a Device, Link or Map.................................................................................................................... 42
Refresh the Topology.................................................................................................................................. 42
Auto-Refresh.................................................................................................................................................. 42

4 Monitor Devices and Network.................................................................................... 43
4.1

Monitor the Top 10 Devices..................................................................................................... 44

4.2

Monitor the Top 10 Interfaces................................................................................................. 45

4.3

Specify the Device Monitor...................................................................................................... 48

4.4

Manage and View Dashboard.................................................................................................. 53
Create or Modify a Dashboard View...................................................................................................... 53
Launch a Dashboard View........................................................................................................................ 56
Display the Dashboard View.................................................................................................................... 57

5 Manage Alarms and Traps........................................................................................... 58
5.1

View and Manage Traps Sent from Devices.......................................................................... 59

View the Traps............................................................................................................................................... 59
Delete the Traps............................................................................................................................................ 59
Export the Traps............................................................................................................................................ 59
5.2

View and Manage Alarm Configurations............................................................................... 59
View and Manage Current Alarm Configurations............................................................................ 61
Add a New Alarm Configuration............................................................................................................. 62
Modify Current Alarm Configurations.................................................................................................. 64

5.3

View and Manage Alarms......................................................................................................... 67
View and Manage Current Alarms......................................................................................................... 67
View and Manage History Alarms.......................................................................................................... 70

5.4

View and Manage Remote Notice Profiles............................................................................ 71
View and Manage the Recipients........................................................................................................... 71
View and Manage the Notice Rules....................................................................................................... 73

6 Manage the Configuration and Firmware Files...................................................... 79
6.1

Back Up Device Configurations............................................................................................... 80
Add or Modify a Backup Schedule......................................................................................................... 80
Execute a Backup Schedule...................................................................................................................... 82
View the Execution Result of a Backup Schedule............................................................................. 83
Remove a Backup Schedule..................................................................................................................... 84

6.2

Restore Device Configurations................................................................................................ 85
Import a Configuration File...................................................................................................................... 85
Modify a Configuration File...................................................................................................................... 86
Remove a Configuration File.................................................................................................................... 87
Add a Restore Schedule............................................................................................................................. 87

6.3

Upgrade Device Firmwares...................................................................................................... 89
Import a Firmware File............................................................................................................................... 89
Remove a Firmware File............................................................................................................................. 90
Add a Firmware Upgrade Schedule....................................................................................................... 91

6.4

View and Manage Schedules................................................................................................... 92

View the Execution Status of the Schedules...................................................................................... 93
Edit a Schedule.............................................................................................................................................. 93
Remove a Schedule..................................................................................................................................... 95
Execute a Schedule ..................................................................................................................................... 95
6.5

Example: Upgrade Firmware for Several Devices................................................................ 96

7 View and Manage Tasks.............................................................................................. 99
7.1

View and Manage the Tasks...................................................................................................100
View the Tasks.............................................................................................................................................100
Enable/Disable the Tasks.........................................................................................................................101
Delete the Tasks..........................................................................................................................................101

8 Manage Users.............................................................................................................. 102
8.1

View and Manage Roles..........................................................................................................103
View Roles.....................................................................................................................................................103
Add a Role.....................................................................................................................................................104
Modify a Role...............................................................................................................................................105
Delete a Role................................................................................................................................................106

8.2

View and Manage Users..........................................................................................................106
View Users.....................................................................................................................................................107
Add a User.....................................................................................................................................................107
Modify a User...............................................................................................................................................108
Delete a User................................................................................................................................................109

8.3

View and Log off Users............................................................................................................109

9 System and Global Settings...................................................................................... 111
9.1

Device Count.............................................................................................................................112

9.2

Configure Email Server............................................................................................................112

9.3

Configure Idle Timeout...........................................................................................................113

9.4

Configure Auto Refresh Interval............................................................................................114

9.5

Configure Data Retention.......................................................................................................114

9.6

Icons in the Upper-Right Region...........................................................................................115
Notification Messages..............................................................................................................................115
Current Alarms............................................................................................................................................116
System Information...................................................................................................................................116
Current Account.........................................................................................................................................117
Log out...........................................................................................................................................................117

Quick Start

The tpNMS (TP-LINK Network Management System) is a centralized management software
that allows you to discover, monitor and configure your TP-LINK Managed Switches using
a web browser. Follow the steps below to complete the basic settings of the tpNMS.
1. Prepare for Installation
2. Download and Install tpNMS
3. Log in to the Application
4. Change Your Password and Email
5. Set the Email Server for Alarm Notifications

1.1 Prepare for Installation
You can install the tpNMS to centrally manage the switches in the LAN or in different
network segments.
• Computer Requirements
• Compatible Devices
• Installation Topology

Computer Requirements
Hardwares:
Operating System: Microsoft Windows XP/Vista/7/8/10.
Web Browser: Mozilla Firefox 32 (or above), Google Chrome 37 (or above), Opera 24 (or
above), or Microsoft Internet Explorer 8-11.
// Not

We recommend you deploy the tpNMS on a 64-bit operating system to guarantee the
software stability.
Compatible Devices
TP-LINK 2/3/5/T series switches.
Installation Topology
You can deploy tpNMS to manage devices in three types of network topologies.
·In the Same LAN
If you want to manage the compatible switches in the same LAN with the tpNMS host,
refer to the following network topology.

Figure 1-1

Topology of the same LAN

Host A (tpNMS Host)
IP: 192.168.0.100
Switch

tpNMS

Router (Gateway)
LAN IP:192.168.0.1

Internet

Host B
IP: 192.168.0.200

2/3/5/T Series Switch

In the LAN, only one host needs to install tpNMS. The host is called as tpNMS Host. And
the other hosts in the same LAN can access the tpNMS Host to manage the network. In
this topology, you can visit tpNMS interface from Host B by entering “192.168.0.100: 8888”
in a web browser. It’s recommended to set a static IP address to the tpNMS Host for the
convenient login to the tpNMS interface.
// Not:

The tpNMS must be running all the time when you manage the network.
·In Different Network Segments
If the tpNMS Host needs to manage switches in different network segments, refer to the
following topology.

Figure 1-2

Topology with different subnets

Host A (tpNMS Host)
IP: 192.168.0.100

Router (Gateway)
LAN IP:192.168.0.1

L2+/L3 Switch

tpNMS

Internet

Host B
IP: 192.168.1.200

2/3/5/T Series Switch
IP: 192.168.2.200

2/3/5/T Series Switch
IP: 192.168.3.200

2/3/5/T Series Switch
IP: 192.168.4.200

The tpNMS Host and the switches are connected to different ports on the L2+/L3 switch.
The tpNMS Host and the switches can access each other via the routing interfaces
configured on the L2+/L3 switch. To ensure the switches can be discovered by the tpNMS
Host and be managed, configure the switches to send SNMP traps to the IP address of the
tpNMS host.
·Over VPN Tunnel
The tpNMS Host can manage the switches over the VPN tunnel, referring to the following
topology.
Figure 1-3

Topology over VPN tunnel

Host A (tpNMS Host)
IP: 192.168.0.100

2/3/5/T Series Switch
IP: 192.168.3.200

L2+/L3 Switch

VPN Tunnel

2/3/5/T Series Switch

L2+/L3 Switch

Host B
IP: 192.168.1.200

IP: 192.168.2.200

tpNMS

After the VPN tunnel is established, the tpNMS can manage the switches on the other side
of the tunnel remotely.

1.2 Download and Install tpNMS
Get the installation file of tpNMS from our website www.tplink.com/en in this directory
For Business > Switches > Accessories, or click this link. Then follow the on-screen
instructions to properly install the tpNMS software. After successful installation, a shortcut
icon of the tpNMS will be created on the tpNMS host’s desktop.

1.3 Log in to the Application
Launch the software on the tpNMS Host and follow the instructions to complete the basic
configurations, and then you can log in to the management interface.
• Launch the tpNMS
• Fix the Launch Problems
• Log in to tpNMS

Launch the tpNMS
Launch the tpNMS and the following window will pop up. You can click Hide to hide this
window but do not close it. After a while, your web browser will automatically open.
Figure 1-4

Launch Window

// Not:
··If your browser does not open, please click Launch a Browser to Manage Network.
··If

it opens but prompts a problem with the website's security certificate, please click
Continue to this website.
··If the port 69, 162 and 1099 are already used by other processes, tpNMS will fail to
initialize. Please kill the tasks occupying these ports and click Retry to launch tpNMS
again.
Fix the Launch Problems
tpNMS will use several ports in its launch process, which include but are not limited to: 69,
162 and 1099. If any of these ports is occupied by the other processes, tpNMS will fail to
initialize. The conflicting port and the PID of the process using this port will be displayed
in the launch window. Please kill the process with this PID and click Retry to launch the
tpNMS again.
1. For example, the tpNMS encounters with a port conflict in initialization.
Figure 1-5

Initializing error

We can see that the conflict port is 162 and the process with PID 2108 is occupying this
port.

2. Open the Processes tab in the Windows Task Manager.
Figure 1-6

Windows Task Manager

3. Click View and select Select Columns....
Figure 1-7

Select Columns

In the pop-up window, select the PID (Process Identification) and click OK.
Figure 1-8

Show the PID column

4. Kill the process that occupying the conflict port. Click the process with the specified PID
and click the End Process.
Figure 1-9

Kill the conflicting process

5. Click Retry to launch tpNMS again.
Figure 1-10

Launch tpNMS again

Log in to tpNMS
tpNMS uses a browser-server architecture. Administrators and other types of users can
access tpNMS from any accessible host in the network. Before you log in to tpNMS, please
make sure that tpNMS host has a static IP address.

// Not:

Since tpNMS supports multiple users’ operations at the same time, we recommend that
different users coordinate their application activities. Thus the modifications on the screen
made by one user are not inadvertently changed by another user.
1. Open a browser and connect to tpNMS through the static IP address of the tpNMS host
and the port 8843.
·To connect to tpNMS from the tpNMS host, enter the URL https://127.0.0.1:8843/.
·To connect to tpNMS from a remote computer, replace 127.0.0.1 with the IP address
of the tpNMS host. For example, enter https://1.1.1.100:8843/, in which 1.1.1.100 is
the IP address of the tpNMS host and 8843 is the port number for the tpNMS server.
2. After you connect to tpNMS, enter the default account and password (both are admin)
in the Login screen to sign in.
Figure 1-11

3. The Home screen displays as below.
Figure 1-12

Home Page

1.4 Change Your Password and Email
It is suggested to change the admin user’s default password for safety considerations.
tpNMS defines three types of roles: administrator, operator and observer. Only
administrators have the authority to modify the user’s user name, password and email.
Following the steps below to modify your password and email address.
1. Click
in the top right corner of the page and the following My Account window
will pop up.
Figure 1-13

Modify account information

2. Modify the Email address of the admin user.
3. Select the Change Password check box . Enter the new password and re-enter to
confirm.
4. Click Apply to save your changes.

1.5 Set the Email Server for Alarm Notifications
Before tpNMS can send alarm notifications, you should configure the email server settings.
Only an administrator role user can configure the alarm email server settings.

1. Go to System > System Settings > Email Server.
Figure 1-14

Configure Email server settings

2. Enter your SMTP server address in the SMTP Server field. For example: smtp.gmail.com.
3. Enter your email address in the Sender Address field. For example: jerry@gmail.com.
4. If you want to encrypt the communications between the server and the recipient, select
the Use Secure Connect (SSL) check box.
5. Enter your SMTP server port in the Server Port field.
6. If your SMTP server requires authentication, select the Need Check Authority check
box and enter your user name and password for your email account.
7. Click the Test button to verify your email server settings. A test mail will be sent from
the sender to itself, to verify the settings of the email server and the user credentials are
correct.
8. Click the Save button to save your email server settings.

Monitor Network

With tpNMS you can monitor the summary information about the network, devices and
interfaces. You can monitor the device status, the network topology, the latest alarms and
the top 10 widgets for devices and interfaces by certain criteria. You can customize these
widgets on the Home screen. This chapter includes the following sections:
• Customize the Widgets on the Home Screen
• View the Widgets

2.1 Customize the Widgets on the Home Screen
You can add, delete or re-sort the widgets displayed on the Home screen.
1. Go to Home screen.

2. Click Customize Portal in the upper right corner of the Home screen.
Figure 2-1

Home screen customize

3. Select a checkbox to add the widget. Deselect a checkbox to delete the widget.
Figure 2-2

Add or delete the widgets

4. The right part is a thumbnail of the Home page. Drag the widgets to re-sort their display
order. When you move the cursor onto the title bar of a widget, the cursor will turn into

a four-head arrow. Click and hold the title bar to drag the widget to the place you want,
and release the left button of your mouse to complete the operation.
Figure 2-3

Re-sort the widgets

5. Click Apply to save your changes.

2.2 View the Widgets
You can view the widgets displayed on the Home page.
Figure 2-4

Home Page view

You can click the device name or interface name in the tables to view their detailed
information.
The widgets and the elements they contain are introduced below.
Widget Label

Description

Default Items Displayed
The percentage of the online devices

Device Status

The number and percentage of the
managed devices online and offline.

The percentage of the offline devices
The number of the online devices
The number of the offline devices
Alarm Name

Latest 10 Alarms

The latest 10 alarms of the entire network.

Severity
Device IP
Alarm Time

Top 10 Devices
By Average CPU
(Today)

Top 10 devices by the average CPU
utilization today. Click device name to show
device detail view.

Top 10 Devices By
Average Memory
(Today)

Top 10 devices by the average memory
utilization today. Click device name to show
device detail view.

Device Name
Device Type
CPU Utilization (%)
Device Name
Device Type
Memory Utilization (%)
Device Name

Top 10 Interfaces
By Traffic (Today)

Top 10 devices by the traffic received and
transmitted today. Click device name to
show device detail view. Click interface
name to show interface detail view.

Interface Name
Rx
Tx
Total
Device Name

Top 10 Interfaces
By Traffic Rate
(Today)

Top 10 devices by the average rate of
traffic received and transmitted today. Click
device name to show device detail view.
Click interface name to show interface
detail view.

Interface Name
Rx (bps)
Tx (bps)
Total (bps)
Device Name

Top 10 Interfaces
By Utilization
(Today)

Top 10 interfaces by the average utilization
on both receiving and transmitting today.
Click device name to show device detail
view. Click interface name to show interface
detail view.

Interface Name
Rx Utilization
Tx Utilization
Total

Widget Label

Description

Default Items Displayed
Device Name

Top 10 Interfaces
By Errors (Today)

Top 10 devices by errors on both receiving
and transmitting today. Click device name
to show device detail view. Click interface
name to show interface detail view.

Interface Name
Rx Errors
Tx Errors
Total
Device Name

Top 10 Interfaces
By Discard
(Today)

Top 10 devices by discards on both
receiving and transmitting today. Click
device name to show device detail view.
Click interface name to show interface
detail view.

Interface Name
Rx Discards
Tx Discards
Total

Network
Topology Map

The network topology of the managed
devices. Double click the node in the map
to jump to the Network Topology tab and
see the detailed map information.

Discover and Manage Resources

With tpNMS you can manage the resources in the network, including devices, interfaces
and Topology. This chapter includes the following sections:
• Discover Devices on Your Network
• View and Manage Devices
• Import Devices
• Add Devices into Groups
• View and Manage Links on Your Network
• Manage Maps and Topologies

3.1 Discover Devices on Your Network
• Schedule a Discovery Job
• Manage Discovery Templates

Schedule a Discovery Job
The discovery profile can filter the devices that tpNMS can detect. tpNMS can discover
devices by a single IP or in an IP range, device name, SNMP template and Telnet template.
• Add or modify a discovery profile
• Delete a discovery profile

·· Add or modify a discovery profile

1. Go to Resource > Device Management > Device Discovery.
2. Click Add to create a new discovery profile, or click the schedule name in the table to
modify the schedule.
Figure 3-1

Schedule modify

To add or delete columns displayed in the device list table, click the

and specify

the columns by selecting or deselecting the corresponding checkboxes.
To filter the schedules in the list, click the
Filter.
Figure 3-2

Schedule filter

. Enter the Schedule Name and click

3. Edit the discovery schedule's information.
Figure 3-3

Edit schedule's basic information

Basic Information
Schedule Name

Enter the name of the schedule.

Discovery IP

Specify the target IP type as Single IP or IP Range.

Device IP

Enter the target device's IP address or IP address range.

Device Label

Assign a device label to the device discovered if you select Single IP.

SNMP Template
Click Choose Template or edit the SNMP Template manually.
SNMP Version

Select the SNMP version.

SNMP Port

Enter the SNMP port, which is 161 by default.

Timeout

Enter the timeout value, which is 4 seconds by default. The target device will be
assumed as unaccessible if it doesn’t respond within the timeout value.

Retries

Enter the number of SNMP query messages that tpNMS sends, which is 3 by default.

Read Community
(v1/v2c only)

Enter the read community strings to match the target device for authentication.

Write Community
(v1/v2c only)

Enter the write community strings to match the target device for authentication.

Security Name (v3
only)

Enter the user name to log in the switch.

Context Name (v3
only)

Enter the SNMP context.

Authentication
Mode (v3 only)

Select the Authentication Mode for the SNMP v3 User.

··None: No authentication method is used.
··MD5: The port authentication is performed via HMAC-MD5 algorithm.
··SHA: The port authentication is performed via SHA (Secure Hash Algorithm). This
authentication mode has a higher security than MD5 mode.

Authentication
Key (v3 only)

Enter the password for authentication.

Privacy Mode (v3
only)

Select the Privacy Mode for the SNMP v3 User.

··None: No privacy method is used.
··DES: DES encryption method is used.

Privacy Key (v3
only)

Enter the Privacy Password.

Telnet Template
Click Choose Template or edit the Telnet Template manually.
Authentication
Mode

Select the authentication mode to telnet the target device.

Port

Enter the port for telnet connection, which is 23 by default.

Timeout

Enter the timeout value, which is 4 seconds by default.

Retries

Enter the number of retries, which is 3 by default.

Username

Enter the username for the telnet connection.

Password

Enter the password for the telnet connection.

Discovery Schedule Config
Figure 3-4

Choose Schedule's Execute Circle

Unscheduled

Select Unscheduled and the discovery job will not be executed.

Recurrent

Select Recurrent and the discovery job will be executed periodically.

Schedule Mode

Select the recurrent mode as Hourly, Daily, Weekly or Monthly.
Configure the exact time of the discovery schedule according to the schedule mode
you choose.

4. Click Apply to save this profile. Click Execute to run this schedule immediately.
Figure 3-5

Save or execute a schedule

5. An example of discovery result is displayed below.
Figure 3-6

Discovery result

·· Delete a discovery profile

Click Delete to remove the selected discovery schedule from the table.
Figure 3-7

Delete a discovery schedule

Manage Discovery Templates
• Add or modify an SNMP Template
• Add or modify a Telnet Template
·· Add or modify an SNMP Template

You can manage SNMP Templates on the Resource > Template Management> SNMP
Template screen.

Figure 3-8

Manage SNMP templates

Click Add or click the template name in the table to edit the template.
Figure 3-9

Add or edit an SNMP template

·· Add or modify a Telnet Template

You can manage Telnet Templates on the Resource > Template Management > Telnet
Template screen.
Figure 3-10

Manage Telnet Templates

Click Add or click the template name in the table to edit the template.

Figure 3-11

Add or Edit an SNMP Template

3.2 View and Manage Devices
This section describes the following tasks that you can perform:
• View the Device List
• Remove a Device
• Synchronize a Device
• Log in to a Device
• Ping or Traceroute a Device
• Reboot a Device
• Access Config

You can manage devices on the Resource > Device Management > Device Table screen.

View the Device List
1. Go to Resource > Device Management > Device Table. The screen displays all the
devices that the application has discovered.
Figure 3-12

Device List

2. To add or delete columns displayed in the device list table, click the
the columns by selecting or deselecting the corresponding checkboxes.

and specify

3. To filter the devices in the list, click the
Figure 3-13

. Enter the filter conditions and click Filter.

An example of filtering the TL-SG series switches

You can filter the listed devices through one or more of the following conditions:
Device Label, Device IP, Device MAC and Device Status.
Click Clear to display all the discovered devices.

Remove a Device
Go to Resource > Device Management > Device Table.
Click Delete to remove the selected devices from the device table.
Figure 3-14

Remove a device

Synchronize a Device
Go to Resource > Device Management > Device Table.
Click Synchronize to synchronize the selected devices in the device table. The
synchronization result pops up as below.
Figure 3-15

Synchronization result

Your successful synchronization operation will synchronize the device’s information to
tpNMS immediately. By default the devices‘ information in this list is synchronized every 2
minutes.
Log in to a Device
Go to Resource > Device Management > Device Table.
Select a device and click Web Management to log into the device's web interface. The
login interface opens in a new tab. This connection uses the TCP port 80, which cannot be
changed.
Figure 3-16

Enter the username and password to log in to the device. For TP-LINK switches, the default
User Name is admin and the default Password is admin.

Figure 3-17

Ping or Traceroute a Device
Go to Resource > Device Management > Device Table.
Click Ping or Traceroute to ping or traceroute the selected device in the device table. The
result displays in the pop-up window.
Figure 3-18

Ping result

Figure 3-19

Traceroute result

Reboot a Device
Go to Resource > Device Management > Device Table. Click Reboot to reboot the
selected devices in the device table.
Access Config
Go to Resource > Device Management > Device Table. Click Access Config to configure
the credentials that pertain to the devices you are trying to access.
Figure 3-20

Access configurations

SNMP Template
Configure the SNMP template to match the SNMP configurations on the target switches.
SNMP Version

Select the SNMP version as v1,v2c or v3.

SNMP Port

Enter the SNMP port, which is 161 by default.

Timeout

Enter the timeout value, which is 4 seconds by default. The target device will be
assumed as unaccessible if it doesn’t respond within the timeout value.

Retries

Enter the number of SNMP query messages that tpNMS sends, which is 3 by default.

Read Community
(v1/v2c only)

Enter the read community strings to match the target device for authentication.

Write Community
(v1/v2c only)

Enter the write community strings to match the target device for authentication.

Security Name (v3
only)

Enter the user name to log in the switch.

Context Name (v3
only)

Enter the SNMP context.

Authentication
Mode (v3 only)

Select the Authentication Mode for the SNMP v3 User.

Authentication
Key (v3 only)

Enter the password for authentication.

Privacy Mode (v3
only)

Select the Privacy Mode for the SNMP v3 User.

··None: No privacy method is used.
··DES: DES encryption method is used.

Privacy Key (v3
only)

Enter the Privacy Password.

Telnet Template
Authentication
Mode

Select the authentication mode to telnet the target device.

Port

Enter the port for telnet connection.

Timeout

Enter the timeout value, which is 4 seconds by default.

Retries

Enter the number of retries, which is 3 by default.

Username

Enter the username for the telnet connection.

Password

Enter the password for the telnet connection.

3.3 Import Devices
You can customize a template file and use the file as a criteria to search for devices in the
network. Only the devices that match the customized conditions will be discovered. The
Import Devices function gives you more control over the discovery process because the
conditions you set are a bit more complicated.
1. Go to Resource > Device Management > Device Import.
2. Click template.xls to download the excel file Config Template.
Figure 3-21

Download Config Template

3. Edit the parameters in the downloaded template.xls.
Figure 3-22

Edit Template

4. Upload customized template file to import devices that match the criteria.
Figure 3-23

Upload Config Template and Import Devices

Click Choose to select your customized template file and click Import to search for
devices that match the conditions.

Figure 3-24

Import Result

3.4 Add Devices into Groups
Once the devices are discovered, you can group them by model, category, location or
other criteria. You can create static and dynamic device groups. Device group offers a
convenient way for the batch backup, restore and update actions.
• View Groups
• Add Devices to Static Group
• Add Devices to Dynamic Group
• Delete Groups

View Groups
Go to Resource > Device Management > Device Groups. The device groups are displayed
below.
Figure 3-25

Device groups

Add Devices to Static Group
1. Go to Resource > Device Management > Device Groups.
2. Click Add Static Group to create a static device group. Enter the group name and
description.
Figure 3-26

Create a static group

3. Click Add to add devices into the group.
Figure 3-27

Add Devices to a static group

You can select devices manually in the device list, or use the filter function to filter the
specified devices. In this example all the TL-SG3 switches are filtered out.
Select the devices and click Apply to add these devices to the group.

4. Click Apply to save the static group.
Add Devices to Dynamic Group
Go to Resource > Device Management > Device Groups. Click Add Dynamic Group to
add the devices that match the specified criteria to a dynamic group.
Figure 3-28

Add devices to a dynamic group

Delete Groups
Go to Resource > Device Management > Device Groups. Click Delete to remove the
selected device groups from the group table.
Figure 3-29

Remove device groups

3.5 View and Manage Links on Your Network
• View Links on Your Network
• Discover Links on Your Network
• Add a Link

View Links on Your Network
Go to Resource > Link Management > Link Table. The links are displayed below.
Figure 3-30

View links

Link Status

Displays whether the link is up or down.

Link Name

Displays the link name. There are two types of link names. 'auto-discovery' means the link
is established by LLDP automatically, while links with the other names are created by users
manually.

Link Type

Displays the link type. Cable means it's a physical link. Link layer link means it's a link in layer 2.

Source Device

Displays the source device of the link.

Source Port

Displays the source port of the link.

Destination
Device

Displays the destination device of the link.

Destination port

Displays the destination port of the link.

Link Speed

Displays the speed of the link.

Discover Links on Your Network
Go to Resource > Link Management > Link Discovery.
Click Start Discovery to discover all the links between the devices with LLDP enabled. For
devices that do not support LLDP, you can manage links manually.
Figure 3-31

Link discovery

Add a Link
Go to Resource > Link Management > Link Addition.
You can add a link on this page manually. You can also draw these links manually on the
map in Discovery and Manage Resources > Manage Maps and Topologies > Add a Link.
Figure 3-32

Add a link

Link Name

Enter the link's name.

Link Type

Select the link's type.

Source Device

Select source device from the device list.

Source Port

Select the port on source device as source port.

Destination
Device

Select destination device from the device list.

Destination Port

Select the port on destination device as destination port.

Click Apply to save the configuration.

3.6 Manage Maps and Topologies
tpNMS provides a world map as the default map. The world map is the root map for any
child map that you add. You can locate devices and links onto the maps manually, thus
establishing visual topologies.
This section introduces the following tasks:
• View the Maps in the Map List
• Add a Map
• Add a Device
• Add a Link
• Delete a Device, Link or Map
• Refresh the Topology
• Auto-Refresh

Go to Resource > Topology Management > Network Topology. The default map displays
below.
Figure 3-33

Network topology

View the Maps in the Map List
The map list contains the world map as the Root map by default. The map list is a
hierarchical directory structure.
Add a Map
Click the icon
Figure 3-34

to upload a new child map to your selected map.

Add a map

Enter the map name and upload a map with .png or .jpg extension from your computer.
Add a Device
Click the icon
Figure 3-35

to add a device to the current map.

Add a device

Select the target device and click Apply. The device will appear on the map.
40

Figure 3-36

Device on the map

Add a Link
Click the icon
Figure 3-37

to add a new link between devices.

Add a link

Draw a line between the two target devices and complete the link information, which
includes link name, link type and the connecting interfaces on both ends.
Delete a Device, Link or Map
Select a device, link or map and click

to remove your selected object.

Refresh the Topology
Click

to refresh the current topology manually.

Auto-Refresh
Click

and the topology will refresh every 2 minutes automatically.

Click this icon again to cancel the auto refresh.

Monitor Devices and Network

You can view summary and detailed information of the devices, interfaces and the
network statistics.
This chapter includes the following sections:
• Monitor the Top 10 Devices
• Monitor the Top 10 Interfaces
• Specify the Device Monitor
• Manage and View Dashboard

Please note that only T-series models’ CPU and Memory utilization can be monitored in
tpNMS. For other models’ utilization status, you can log in their web or CLI interface to
view.

4.1 Monitor the Top 10 Devices
You can monitor today’s top 10 devices by average CPU and by average memory. Go to
Monitor > TopN > TopN Devices.
·Top 10 Devices by Average CPU (Today)
Figure 4-1

Top 10 devices by average CPU

Device Name

Displays the name of the device.

Device Type

Displays the type of the device.

CPU Utilization (%)

Displays the CPU utilization of the device.

Click the device name to view its detailed information.
Figure 4-2

Device information

·Top 10 Devices by Average Memory (Today)
Figure 4-3

Top 10 devices by average memory

Device Name

Displays the name of the device.

Device type

Displays the type of the device.

Memory
Utilization (%)

Displays the memory utilization of the device.

Click the device name to view its detailed information.

4.2 Monitor the Top 10 Interfaces
You can monitor today’s top 10 interfaces by traffic, traffic rate, bandwidth utilization,
error packets and discard packets.
Go to Monitor > TopN > TopN Interfaces.
·Top 10 Interfaces by Traffic (Today)
Figure 4-4

Top 10 interfaces by traffic

Device Name

The name of the device.

Interface Name

The name of the interface.

The received traffic on this interface.

The sent traffic on this interface.

Total

The total traffic forwarded on this interface.

Click the device name to view detailed information about the device. Click the interface
name to view detailed information about the interface.
Figure 4-5

Interface information

·Top 10 Devices by Traffic Rate (Today)
Figure 4-6

Top 10 interfaces by traffic rate

Device Name

The name of the device.

Interface Name

The name of the interface.

Rx (bps)

The received traffic rate on this interface.

Tx (bps)

The sent traffic rate on this interface.

Total (bps)

The total traffic rate forwarded on this interface.

Click the device name to view detailed information about the device. Click the interface
name to view detailed information about the interface.
·Top 10 Interfaces by Utilization (Today)
Figure 4-7

Top 10 interfaces by utilization

Device Name

The name of the device.

Interface Name

The name of the interface.

Rx Utilization

The interface's utilization on receiving bandwidth.

Tx Utilization

The interface's utilization on sending bandwidth.

Total

The total utilization of the interface.

Click the device name to view detailed information about the device. Click the interface
name to view detailed information about the interface.
·Top 10 Interfaces by Errors (Today)
Figure 4-8

Top 10 interfaces by errors

Device Name

The name of the device.

Interface Name

The name of the interface.

Rx Errors

The error packets received on the interface.

Tx Errors

The error packets sent on the interface.

Total

The total error packets forwarded on the interface.

Click the device name to view detailed information about the device. Click the interface
name to view detailed information about the interface.
·Top 10 Devices by Discard (Today)
Figure 4-9

Top 10 interfaces by discard

Device Name

The name of the device.

Interface Name

The name of the interface.

Rx Discards

The discarded packets in the interface's received packets.

Tx Discards

The discarded packets in the interface's sent packets.

Total

The total discarded packets on the interface.

Click the device name to view detailed information about the device. Click the interface
name to view detailed information about the interface.

4.3 Specify the Device Monitor
tpNMS provides monitors for the following device metrics:
·IP Traffic
·ICMP Traffic
·TCP Traffic
·UDP Traffic
·SNMP Traffic

·Interface Traffic
·CPU
·Memory
By default all the monitors are enabled. You can enable/disable and specify these monitors
on the page Monitor > Monitor Management > Device Monitor.
For information about how to configure alarms basing on these monitors, please refer to
View and Manage Alarm Configurations.

Go to Monitor > Monitor Management > Device Monitor.
Figure 4-10

Device Monitor

Monitor Name

The name of the monitor.

Status

The status of the monitor.

Monitor Type

The monitor type.

Interval

The interval of the monitor obtains the parameters from the target devices.

Description

The description for this monitor.

·· Enable/Disable the Monitors

Click Enable/Disable to enable/disable the selected monitors.

·· Specify the information of the Monitors

Click the monitor name to modify its detailed information.
1. Click General Information to edit the monitor's basic information.
Figure 4-11

General Settings

Monitor Name

The name of the monitor.

Enable

Enable or disable this monitor.

Interval

Select the interval of the monitor obtains the parameters from the target devices.

Description

Description for this monitor.

2. Click Monitor Devices to specify the devices or device groups that are monitored.
Figure 4-12

Add monitor devices

Monitor Devices

Specify the devices that are monitored. The options are All Applicable Devices, Select
Devices and Select Device Groups. Use the Add and Delete button to edit the target
devices or device groups, and click Save to save the changes.

The Select Devices window displays as below.
Figure 4-13

Add devices

The Select Device Groups window displays as below.
Figure 4-14

Add device groups

3. Click Monitor Indicators to specify the parameters that are monitored by this monitor.
Figure 4-15

Add indicators

Edit the parameters that are monitored. By default all the parameters are selected. Click
Save to save the changes.

4.4 Manage and View Dashboard
You can create and customize network information to be displayed on the tpNMS
dashboard.
• Create or Modify a Dashboard View
• Launch a Dashboard View
• Display the Dashboard View

Create or Modify a Dashboard View
Go to Monitor > Dash Board > Dash Board Setting.
Figure 4-16

Dash Board View

1. Click Add to create a new dashboard view, or click the view name in the table to edit
the existed dashboard view.
2. Click General Info to edit the basic information of the dashboard view.
Figure 4-17

Dashboard general information

View Name

Enter or modify the name for the dashboard view.

Interval Type

Specify the time period over which you want to view the performance.
•

Real Time: View the performance in real time.

•

Last 1 Hour: View the performance over the last 1 hour.

•

Last 24 Hours: View the performance over the last 24 hours.

•

Last 7 Days: View the performance over the last 7 days.

•

Last 30 Days: View the performance over the last 30 days.

Interval

If you select Real Time, select the refresh frequency of the view here. The information
of this dashboard refreshes in the interval you set.

Data Source

Specify the data source as Device or Interface.

3. Click Monitor Type to configure the monitors of the dashboard view.
Figure 4-18

Dashboard monitor type

Monitor Type

Select the monitor type. There are a series of monitors for devices and a series of
monitors for interfaces.

Monitor
Indicators

Specify the monitor sources.

4. Click Add Devices/Add Interfaces to configure the target devices/interfaces of the
monitor.
The following screenshots use Devices as an example.
Figure 4-19

Dashboard target devices

Click Add to add devices in the device table. Click OK to save your selections.
Figure 4-20

Add target devices

5. Click Apply to save your configurations on the dashboard.
Launch a Dashboard View
Go to Monitor > Dash Board > Dash Board Setting. Select a dashboard view in the table
and click Launch.
Figure 4-21

Launch a dashboard

The dashboard view will be displayed in a new tab of the browser. The following tab is the
dashboard monitoring the CPU utilization of several T-series switches.
Figure 4-22

Display a dashboard

Display the Dashboard View
Go to Monitor > Dash Board > Dash Board View. Click Select Dashboard and select one
dashboard name for display.

The dashboard will be displayed on current page.

Manage Alarms and Traps

tpNMS can manage the traps sent from the devices.
tpNMS can define alarms basing on traps, monitor and the tpNMS system.
tpNMS can define the recipients to receive the notification emails when the specific alarms
are triggered.
This chapter includes the following contents:
• View and Manage Traps Sent from Devices
• View and Manage Alarm Configurations
• View and Manage Alarms
• View and Manage Remote Notice Profiles

5.1 View and Manage Traps Sent from Devices
Go to Alarms > Trap Management > Traps.
The Trap table displays the traps sent from devices. On this screen, you can view details of
the traps, remove the traps and export the traps.
Figure 5-1

Trap list

View the Traps
Click the trap OID to view the trap’s detail information.
Delete the Traps
Select the traps and click Delete to remove them from the Trap table.
Export the Traps
Select the traps and click Export to PDF or Export to Excel to save the traps to your
computer.

5.2 View and Manage Alarm Configurations
tpNMS provides three types of alarms depending on their sources: Trap Alarms, Monitor
Alarms and System Alarms. Trap alarms, system alarms and some of the monitor alarms are
system built-in alarms which cannot be deleted. Users can add new monitor-type alarms.
tpNMS provides the following four severity levels for alarms. Four shortcut icons
representing the four level alarms are placed in the upper-right region of the main page.
The color represents the severity, while red represents the highest level severity and blue

represents the lowest severity. The numbers beside these icons represent each alarm’s
current quantity.

•

Urgent (Red)

•

Serious (Orange)

•

Normal (Yellow)

•

Hint (Blue)

Click on the alarm icon to view the alarm’s detail information.
Figure 5-2

Urgent Alarm Details

The following sections describe the alarm-related tasks:
• View and Manage Current Alarm Configurations
• Add a New Alarm Configuration
• Modify Current Alarm Configurations

View and Manage Current Alarm Configurations
Go to Alarms > Alarm Management > Alarm Configuration.
You can view, enable, disable, delete and export alarm configurations on this page.
Figure 5-3

Alarm configuration list

·· View the alarms

To add or delete columns displayed in the alarm list table, click the
columns by selecting or deselecting the corresponding checkboxes.

and specify the

. Enter the filter conditions and click Filter.

To filter the alarms in the list, click the
Alarm Name

The name of the alarm. Click it to view the alarm's detailed configurations.

Status

The status displays whether this alarm is valid.

Severity

Four levels of severity: Urgent, Serious, Normal and Hint.

Alarm Type

Three types of alarms: Trap, Monitor and System.

Description

Displays the trigger conditions of the alarm.

Trap OID

Displays the trap OID if this is a trap-type alarm.

Click the alarm name to view and edit the alarm's configuration.
·· Enable/Disable the alarms

Select alarms and click the Enable/Disable button to enable/disable the corresponding
alarm configurations.

·· Delete the alarms

Click the Delete button to remove the selected alarm configurations. The system built-in
alarms cannot be deleted.
·· Export the alarms

Select alarms and click the Export to PDF/Export to Excel button to export the
corresponding alarm configurations to your computer.
Add a New Alarm Configuration
Go to Alarms > Alarm Management > Alarm Configuration.
You can define new alarms for the monitors. The monitors can be configured on the
following page: Monitor > Monitor Management > Device Monitor.
The alarm you add is based on an existing monitor and includes a threshold.
Click Add to add a monitor-type alarm.

Figure 5-4

Add an alarm configuration

Monitor Information
Monitor Name

Select a monitor.

Enable

Displays whether this monitor is valid.

Description

Displays the detailed information of this monitor.

General Information
Alarm Name

Enter a name for the alarm.

Description

Enter a description for the alarm.

Enable

Select whether to make this alarm configuration effective.

Severity

Select the alarm's severity. tpNMS supports four levels of severity: Urgent, Serious,
Normal and Hint.

Indicator

Select one indicator in the monitor you chose.

Alarm Type

You can only create monitor-type alarms.

Calculate Type

Select a consecutive or average calculation type.

Count

Select a number of times that a particular event must occur before the threshold is
met.

Note

Enter a note for this alarm.

Threshold Information
Threshold Type

Select an upper or lower threshold.

Threshold

Enter. If this threshold is exceeded, the alarm will be triggered.

Click Apply to save your alarm configurations.
Modify Current Alarm Configurations
Go to Alarms > Alarm Management > Alarm Configuration.
You can modify the current alarm configurations on this page.
·· Modify a trap-type alarm

Click the trap-type alarm name to modify this alarm.

Figure 5-5

Modify a trap-type alarm configuration

Enable

Enable or disable this alarm configuration.

Severity

Modify the alarm's severity. tpNMS supports four levels of severity: Urgent, Serious,
Normal and Hint.

Note

Add a note to this alarm.

·· Modify a monitor-type alarm

Click the monitor-type alarm name to modify this alarm.
Figure 5-6

Modify a monitor-type alarm configuration

Enable

Enable or disable this alarm configuration.

Severity

Modify the alarm's severity. tpNMS supports four levels of severity: Urgent, Serious,
Normal and Hint.

Count

Specify the number of times that a particular event must occur before the threshold is
met.

Note

Add a note to this alarm.

Threshold

Modify the threshold. If this threshold is exceeded, the alarm will be triggered.

·· Modify a system-type alarm

Click the system-type alarm name to modify this alarm.
Figure 5-7

Modify a system-type alarm configuration

Enable

Enable or disable this alarm configuration.

Severity

Modify the alarm's severity. tpNMS supports four levels of severity: Urgent, Serious,
Normal and Hint.

Note

Add a note to this alarm.

5.3 View and Manage Alarms
You can view and manage the current alarms and history alarms.
• View and Manage Current Alarms
• View and Manage History Alarms

View and Manage Current Alarms
Go to Alarms > Browse Alarm > Current Alarms.
The alarm list on this page displays the current active alarms of the network. You can
acknowledge, clear and export alarms.

Figure 5-8

Current alarm list

·· View the current alarms

To add or delete columns displayed in the alarm list table, click the
columns by selecting or deselecting the corresponding checkboxes.

and specify the

. Enter the filter conditions and click Filter.

To filter the alarms in the list, click the
Alarm Name

The name of the alarm. Click it to view the alarm's detailed configurations.

Alarm Status

Whether this alarm is valid.

Alarm Type

Three types of alarms: Trap, Monitor and System.

Severity

Four levels of severity: Urgent, Serious, Normal and Hint.

Device IP

The device IP on which the alarm occurred.

Alarm Source

The source of the alarm.

Last Arrived Time

Displays the last time the alarm arrived at tpNMS.

Acked User

User who confirmed the alarm.

Description

The description of this alarm.

Click the alarm name to view the detailed information of the alarm.

·· Acknowledge the current alarms

Select your desired alarms and click Acknowledge to confirm the alarms. Acknowledging
an alarm means that you are in charge of this alarm.
Figure 5-9

Confirm an alarm

When an alarm is confirmed, the confirmed user's name will be filled in the Acked User
column.
Figure 5-10

Confirmed alarm

·· Remove the current alarms

Select your desired alarms and click Clear to remove the alarms from this table. The alarms
you cleared here will be displayed in the History Alarms list.
·· Export the current alarms

Select your desired alarms and click Export to PDF or Export to Excel to save the alarms to
your computer.

View and Manage History Alarms
Go to Alarms > Browse Alarm > History Alarms.
You can remove and export history alarms on this page.
Figure 5-11

History alarm list

·· View the history alarms

To add or delete columns displayed in the alarm list table, click the
columns by selecting or deselecting the corresponding checkboxes.

and specify the

. Enter the filter conditions and click Filter.

To filter the alarms in the list, click the
Alarm Name

The name of the alarm. Click it to view the alarm's detailed configurations.

Alarm Status

Whether this alarm is valid.

Alarm Type

Three types of alarms: Trap, Monitor and System.

Severity

Four levels of severity: Urgent, Serious, Normal and Hint.

Device IP

The device IP on which the alarm occurred.

Alarm Source

The source of the alarm.

Alarm Time

Displays the time the alarm arrived at tpNMS.

Acked User

User who confirmed the alarm.

Description

The description of this alarm.

Click the alarm name to view the detailed information of the alarm.
·· Remove the history alarms

Select your desired alarms and click Clear to remove the alarms from this table.

·· Export the history alarms

Select your desired alarms and click Export to PDF or Export to Excel to save the alarms to
your computer.

5.4 View and Manage Remote Notice Profiles
A remote notice profile defines certain criteria basing on the alarms. tpNMS will generate
and send alarm notice emails when specified alarm occurs. The recipients can be
customized.
Before the application can send notice emails, you should provide the email addresses of
the recipients.
• View and Manage the Recipients
• View and Manage the Notice Rules

View and Manage the Recipients
Go to Alarms > Remote Notice > User Groups.
Figure 5-12

Notification recipients

·· Add or modify a user

· To add a user, click the Add button.
·To modify an existing user, click the username.

Figure 5-13

Add or modify a user

Username

Enter the username.

Enter the email address of the user. The alarm notice emails will be sent to this email
address.

Phone

Optional. Enter the phone number of the user.

Description

Optional. Enter the description for this user.

·· Add or modify a user group

· To add a user group, click the Add button.
·To modify an existing user group, click the group name.
Figure 5-14

Add or modify a user group

Basic Information
User Group

Enter the user group name.

Description

Optional. Enter the description for this group.

User List
Click Add or Delete to manage users in this user group.
·· View the current users and user groups

To add or delete columns displayed in the alarm list table, click the
columns by selecting or deselecting the corresponding checkboxes.
To filter the notice rules in the list, click the
Filter.

and specify the

. Enter the filter conditions and click

Click the user/user group name to view the detailed information of the users/user groups.
View and Manage the Notice Rules
Go to Alarms > Remote Notice > Notice Rules.
Figure 5-15

Notice rule list

·· Add or Modify the notice rules

· To add a notice rule, click the Add button.
·To modify an existing notice rule, click the rule name.

Figure 5-16

Add or modify a notice rule (general information)

General Information
Configure the basic information of the remote rule.
Rule Name

Enter the rule name.

Enable

Enable or disable this notice rule.

Severity

Select which level alarms will trigger this notice.

Send when the
alarm is cleared.

A notice mail will be sent when the alarm is cleared if you check this box.

Description

Enter the description for this notice rule.

Alarm Configuration Information
Configure the alarms in this notice rule.
Figure 5-17

Add or modify a notice rule (alarm configuration)

Target Alarms

Select All Applicable Alarm Configuration, or select Select Alarm Configuration to
add the alarm configurations manually.

Add

Click Add to add the existing alarm configurations. It is multi-optional.

Delete

Delete the alarm configurations in the Alarm table below.

Device Information
Configure the target devices that the alarms are monitoring.
Figure 5-18

Add or modify a notice rule (device information)

Target Devices

Select all the applicable devices or select devices by model, by group or separately.

Add

Click Add to add devices according to their model, group or separately.

Delete

Delete the devices in the device table below.

The Device Add page displays as below.
Figure 5-19

Add or modify a notice rule (add device)

Recipient Information
Configure the recipients of the notice, and the alarm’s time-range restriction.
Figure 5-20

Time

Add or modify a notice rule (recipient information)

Select the time-range restriction on the alarms.
All Day: Alarms that occurs at any time of the day will trigger the notice mail.
Specified Time: Specify a time-range. tpNMS will send notice mail only when the alarms
occurs in this specified time-range.

Add

Click Add to add user groups who will receive the notice email.

Delete

Delete the user groups in the recipient list table below.

Click Save to save your modifications.
·· View the current notice rules

To add or delete columns displayed in the alarm list table, click the
columns by selecting or deselecting the corresponding checkboxes.
To filter the notice rules in the list, click the
Filter.

and specify the

. Enter the filter conditions and click

Click the rule name to view the detailed information of the notice rules.
Rule Name

The name of the notice rule. Click it to view and edit the rule's configurations.

Status

The status displays whether this rule is valid.

User Groups

Displays the recipients of the notification email.

Time

The sending time period of the notification email.

Severity

Displays the filtering criteria of the alarms. Only the alarms of the severity levels
displayed will be sent in the email.

Description

Displays the description on this notice rule.

Manage the Configuration and
Firmware Files

This chapter mainly introduces how to manage the device’s configuration files and
firmware files.
• Back Up Device Configurations
• Restore Device Configurations
• Upgrade Device Firmwares
• View and Manage Schedules
• Example: Upgrade Firmware for Several Devices

6.1 Back Up Device Configurations
You can schedule a backup task to back up the configurations of the devices on your
network.
The backup configuration files will be saved in the \data\tftpDir in the tpNMS’s installation
directory.
• Add or Modify a Backup Schedule
• Execute a Backup Schedule
• View the Execution Result of a Backup Schedule
• Remove a Backup Schedule

Add or Modify a Backup Schedule
1. Go to Config > Backup Management > Backup Schedule.
Figure 6-1

Backup schedule list

2. Add a backup schedule or modify an existing backup schedule.
·To add a backup schedule, click the Add button.
·To modify an existing backup schedule, select your desired schedule entry and click
Edit.

The following screen displays.
Figure 6-2

Add or modify a backup schedule

Basic Information
Name

Enter the name of the backup schedule.

Enable CLI
Password

Check this box and enter the device's privilege-mode password if necessary.

Description

Enter the description for this schedule.

Device Config
Select Device By

Select the target device by device or by device group.

Selected Devices
Add

Add a device/device group whose configuration files will be backed up.

Delete

Remove the selected device/device group from the table below.

Schedule Config
Unscheduled

The unscheduled backup task will be displayed in the schedule list, but will not be
executed automatically. You can manually perform the backup task on the screen Config
> Backup Management > Backup Schedule with the Execute button.

One Time

Select One Time and enter the Execution Time, the schedule task will be executed
automatically at the time you set.

Recurrent

Select Recurrent and complete the schedule mode and frequency below, the schedule
task will be executed recurrently.

Click Apply to save your configurations.
Execute a Backup Schedule
You can execute a backup task in the schedule table immediately, either the task is
unscheduled or recurred.
1. Go to Config > Backup Management > Backup Schedule.
Figure 6-3

Backup schedule list

Schedule Name

Displays the name of the backup schedule.

Schedule Mode

Displays the mode of the backup schedule.

Last Execution
Time

Displays the last execution time of this backup time.

Next Execution
Time

Displays the next execution time of this backup time.

Last Execution
Result

Click the link to view the detailed information of this backup task's last execution result.

2. Click the Execute button to execute your selected backup schedule immediately. A
window will pop up to display the execution result.
Figure 6-4

Backup process

Click the
in the upper-right corner to close this pop-up window. You can close this
window and perform some other operations with tpNMS during the backup process.
The backup process will run in the background. You can view the backup's progress on
the screen Tasks > Task Management > Tasks.
View the Execution Result of a Backup Schedule
You can view the execution status of your desired backup job to ensure that the device's
configuration is backed up as scheduled.
1. Go to Config > Backup Management > Backup Schedule.
Figure 6-5

Backup schedule list

Schedule Name

Displays the name of the backup schedule.

Schedule Mode

Displays the mode of the backup schedule.

Last Execution
Time

Displays the last execution time of this backup time.

Next Execution
Time

Displays the next execution time of this backup time.

Last Execution
Result

Click the link to view the detailed information of this backup task's last execution result.

2. Click the link in the last row of the schedule table to view the detailed execution result.
Figure 6-6

Backup result

Schedule Name

Displays the label of the device.

Device IP

Displays the IP address of the device.

Device MAC

Displays the MAC address of the device.

Result (You can
close this window
while backing up)

Displays the backing up result.

Backup Time

Displays the time of the backup operation.

Remove a Backup Schedule
You can remove your selected backup schedule task in the schedule Table.
1. Go to Config > Backup Management > Backup Schedule.
Figure 6-7

Backup schedule list

Schedule Name

Displays the name of the backup schedule.

Schedule Mode

Displays the mode of the backup schedule.

Last Execution
Time

Displays the last execution time of this backup time.

Next Execution
Time

Displays the next execution time of this backup time.

Last Execution
Result

Click the link to view the detailed information of this backup task's last execution result.

2. Select the backup profile and click Delete to remove the profile from this table.

6.2 Restore Device Configurations
You can upload the configuration files of the devices to tpNMS, and restore the
configuration files to corresponding device(s) on your network.
• Import a Configuration File
• Modify a Configuration File
• Remove a Configuration File
• Add a Restore Schedule

Import a Configuration File
1. Go to Config > Deploy Management > Config File.
Figure 6-8

Configuration file list

2. Click Import to upload the configuration file with .cfg extension from your computer.
Figure 6-9

Upload a configuration file

3. Click Apply and the configuration file is listed in the Config File table.
Modify a Configuration File
1. Go to Config > Deploy Management > Config File.
Figure 6-10

Configuration file list

2. Select the desired configuration file in the table and click Edit File to modify this file.
Figure 6-11

Edit a configuration file

3. Click Apply to save your modifications to the configuration file.
Remove a Configuration File
1. Go to Config > Deploy Management > Config File.
Figure 6-12

Configuration file list

2. Select the desired configuration file and click Delete to remove this file from the table.
3. Click OK in the pop-up confirm window to complete the deletion.
Add a Restore Schedule
1. Go to Config > Deploy Management > Config File.
Figure 6-13

Configuration file list

2. Select the configuration file in the table and click Restore.
3. In the Deploy Config List > Deploy Schedule window, edit the schedule’s information.
Figure 6-14

Edit a restore schedule

Basic Info
Name

Enter the name of the restore schedule.

Restore File

Display the name of the configuration file.

Enable password

Click the checkbox to enter the device's privileged password if necessary.

Description

Enter the description of the restore schedule.

Target Devices
Select Device By

Select the target devices by devices or by device groups.

Selected Devices
Add/Delete

Edit the target devices or device groups.

Schedule
Unscheduled

The unscheduled restore task will be displayed in the schedule list, but will not be
executed automatically. You can manually perform the restore task on the screen Config
> Deploy Management > Deploy Schedule with the Execute button.

One Time

Select One Time and enter the Execution Time, the schedule task will be executed
automatically at the time you set.

Recurrent

Select Recurrent and complete the schedule mode and frequency below. The schedule
task will be executed recurrently.

Click Apply to save the restore schedule information.

6.3 Upgrade Device Firmwares
You can upload the firmware files of the devices to tpNMS, and upgrade corresponding
device(s) on your network with the configuration files.
• Import a Firmware File
• Remove a Firmware File
• Add a Firmware Upgrade Schedule

Import a Firmware File
1. Go to Config > Deploy Management > Firmware.
Figure 6-15

Firmware file list

2. Click Import to upload the firmware file from your computer.
Figure 6-16

Import a firmware file

Import File

Click Choose to select the firmware file from your computer.

Name

Enter the name of this firmware file.

Vendor

Select the vendor of the device corresponding to this firmware.

Version

Enter the firmware version.

Description

Enter the description of this firmware file.

3. Click Apply and the firmware file is listed in the Firmware File table.
Remove a Firmware File
1. Go to Config > Deploy Management > Firmware.
Figure 6-17

Firmware file list

2. Select the desired firmware file and click Delete to remove this file from the table.
3. Click OK on the pop-up confirm window to complete the deletion.
Add a Firmware Upgrade Schedule
1. Go to Config > Deploy Management > Firmware.
Figure 6-18

Firmware file list

2. Select the firmware file in the table and click Upgrade.
3. In the Deploy Config List > Deploy Schedule window, edit the schedule’s information.
Figure 6-19

Edit a upgrade schedule

Basic Info
Name

Enter the name of the upgrade schedule.

Firmware

Display the name of the firmware file.

Enable password

Click the checkbox to enter the device's privileged password if necessary.

Description

Enter the name of the upgrade schedule.

Target Devices
Select Device By

Select the target devices by devices or by device groups.

Selected Devices
Add/Delete

Edit the target devices or device groups.

Schedule
Unscheduled

The unscheduled upgrade task will be displayed in the schedule list, but will not be
executed automatically. You can manually perform the upgrade task on the screen
Config > Deploy Management > Deploy Schedule with the Execute button.

One Time

Select One Time and enter the Execution Time. The schedule task will be executed
automatically at the time you set.

Recurrent

Select Recurrent and complete the schedule mode and frequency below, the schedule
task will be executed recurrently.

Click Apply to save the upgrade schedule information.

6.4 View and Manage Schedules
Go to Config > Deploy Management > Deploy Schedule.
Your configuration-restore schedules and firmware-upgrade schedules can be viewed and
managed on this page.
Figure 6-20

Schedule list

• View the Execution Status of the Schedules
• Edit a Schedule

• Remove a Schedule
• Execute a Schedule

View the Execution Status of the Schedules
Go to Config > Deploy Management > Deploy Schedule.
The schedule table displays the following items:
Schedule Name

Displays the name of the schedule.

Schedule Mode

Displays the schedule mode.

Deploy Type

Displays the detail type of the schedule task.

Last Execution
Time

Displays the last time when the schedule task was executed.

Next Execution
Time

Displays the next time when the schedule task will be executed.

Last Execution
Result

Displays the general result of the schedule's last execution.

Click the link in the Last Execution Result Row to view the detailed execution result.
Edit a Schedule
Go to Config > Deploy Management > Deploy Schedule.
Select a schedule and click Edit to modify the detailed configuration of the schedule task.

Figure 6-21

Edit a schedule

Basic Info
Name

Enter the name for the schedule.

Restore File/
Firmware

Display the name of the restore file/firmware file.

Enable password

Click the checkbox to enter the device's privileged password if necessary.

Description

Enter the name for the schedule.

Target Devices
Select Device By

Select the target devices by devices or by device groups.

Selected Devices
Add/Delete

Edit the target devices or device groups.

Schedule
Unscheduled

The unscheduled task will be displayed in the schedule list, but will not be executed
automatically. You can manually perform the task on the screen Config > Deploy
Management > Deploy Schedule with the Execute button.

One Time

Select One Time and enter the Execution Time, the schedule task will be executed
automatically at the time you set.

Recurrent

Select Recurrent and complete the schedule mode and frequency below, the schedule task
will be executed recurrently.

Click Apply to save the schedule’s configuration.
Remove a Schedule
Go to Config > Deploy Management > Deploy Schedule.
Select a schedule and click Delete to remove the schedule from the table.
Execute a Schedule
Go to Config > Deploy Management > Deploy Schedule.
Click the Execute button to execute your selected restore schedule/upgrade schedule
immediately. A window will pop up to display the execution result.
Figure 6-22

Schedule’s running status

You can close this window and perform some other operations with tpNMS during the
backup process. The restore/upgrade process will run in the background. You can view the
execution progress on the screen Tasks > Task Management > Tasks.
// Not:

If the switch you want to upgrade is a dual-image switch, the upgrade schedule will only
upgrade the switch’s backup image. You should configure the switch to reboot with the
backup image after the upgrade schedule is finished.

6.5 Example: Upgrade Firmware for Several Devices
The following example shows how to upgrade two TP-LINK T1700G-28TQ switches at the
same time.
1. Go to Config > Deploy Management > Firmware. Click Import Firmware to upload the
firmware file for T1700G-28TQ.
Figure 6-23

Import a firmware file

Name the firmware as T1700, enter the version information and select the vendor as
TP-LINK.

2. Select the firmware T1700 and click Upgrade to configure the deploy schedule.
Figure 6-24

Edit T1700_UP upgrade schedule

Basic Info
Name

Enter the name T1700-Up.

Firmware

Display the name of the firmware file.

Enable password

Click the checkbox to enter the device's privileged password.

CLI Password

Enter the default password admin.

Target Devices
Select Device By

Select the target devices by devices or by device groups. You can choose Devices to add
the two T1700G-28TQ, or choose Device Groups and add the group containing the two
T1700G-28TQ. Here we take Device Groups as an example.

Selected Device Groups
Add

Click Add to add the group T1700G-Series which contains the two T1700G-28TQ. The
device group is configured on page Resource > Device Management > Device Groups.

Schedule
Unscheduled

Select Unscheduled.

Click Apply to save the upgrade schedule information.
3. Go to Config > Deploy Management > Deploy Schedule. Select the upgrade schedule
T1700-Up and click Execute to upgrade the two T1700G-28TQ switches.
Figure 6-25

Execute T1700-Up upgrade schedule

4. Check the result in the result window.
Figure 6-26

Execute T1700-Up result

View and Manage Tasks

View and Manage the discovery, backup, restore and upgrade tasks on this page.
This chapter covers the following topics.
·Enable/Disable the Tasks
·Remove the Tasks
·View Task Execution Results

7.1 View and Manage the Tasks
You can view task details and execution results. You can also enable, disable and remove
tasks on this page.
The task types include Discovery, Configuration Backup, Configuration Restore and
Firmware Upgrade.
Go to Tasks > Task Management > Tasks.
Figure 7-1

Task list

View the Tasks
Executed and to-be-executed tasks are displayed in this table.
Enable

Displays the status of the task.

Task Name

Displays the task name.

Task Type

The task type includes: Discovery, Config Backup, Config Restore and Firmware Upgrade.

Recurrent Type

The task recurrent type includes: Not Recurrent, Hourly, Daily, Weekly and monthly.

Status

The execution status of the task, including Succeeded, Failed and Wait to run.

Last Execution
Time

Displays the last time when the task was executed.

Next Execution
Time

Displays the next time when the task will be executed.

Result

Click Show Results to view the detailed running result of the task.

Click the Detail button to view the detailed configuration of the selected tasks.

100

Enable/Disable the Tasks
Click the Enable/Disable button to enable/disable the selected tasks. Only tasks in Wait to
run status can be enabled or disabled.
Delete the Tasks
Click the Delete button to remove the selected tasks from the table.

101

Manage Users

You can manage the users and roles on this section.
• View and Manage Roles
• View and Manage Users
• View and Log off Users

102

8.1 View and Manage Roles
The role is the permission attribute of the user. Uses with different roles have different
access permissions to each configuration module of tpNMS (Resource, Monitor, Alarm,
Config, Task and System).
tpNMS provides the following default roles:
·Administrator. The administrator user can view and modify all the modules of tpNMS.
·Operator. The operator user can view all the modules, and can modify all the modules
except the System Module.
·Observer. The observer user can only view all the modules.
Go to System > User Management > Roles.
Figure 8-1

View roles

• View Roles
• Add a Role
• Modify a Role
• Delete a Role

View Roles
Go to System > User Management > Roles.
The default 3 roles are displayed in the role table.

103

Role

Displays the name of the role.

Default

Whether the role is a system default role.

Created By

The Creator of the role.

Created Time

The created time of the role.

Click the role name to view its detailed privilege to each module.
Figure 8-2

Role privilege

Add a Role
Go to System > User Management > Roles.
Click Add to create a new role with customized privileges.

104

Figure 8-3

Create a role

Enter the role name and select the checkboxes to specify the role’s access privilege to each
module.
Click Apply to save the role’s configuration.
Modify a Role
Go to System > User Management > Roles.
Click Edit to customize the role's privileges.

105

Figure 8-4

Modify a role

Select or deselect the checkboxes to specify the role’s access privilege to each module.
// Not

The system default roles cannot be edited.
Delete a Role
Go to System > User Management > Roles.
Click Delete to remove the selected roles.
// Not

The system default roles cannot be deleted.

8.2 View and Manage Users
You can view and manage the users of tpNMS on this page.
Go to System > User Management > Users.

106

Figure 8-5

User list

• View Users
• Add a User
• Modify a User
• Delete a User

View Users
Go to System > User Management > Users.
View the users in the user table.
User Name

Displays the name of the user.

Status

Displays the status of the user.

Role

Displays the role of the user. The role defines the privilege of the user.

Displays the user's email address.

Created Time

The created time of the user.

Add a User
Go to System > User Management > Users.
Click Add to add a user to the user table. Enter the user’s basic information and click
Apply.

107

Figure 8-6

Add a user

User Name

Enter the name of the user. The user name is case-sensitive.

Enter the user's email address.

Role

Select the role of the user. The role defines the privilege of the user.

Status

Specify the status of the user as active or inactive.

Password

Enter the password for this user.

Confirm Password

Enter the password again to confirm.

Modify a User
Go to System > User Management > Users.
Select a user and click Edit to modify a user’s configuration and click Apply.
Figure 8-7

Modify a user

108

User Name

Enter the name of the user. The user name is case-sensitive.

Enter the user's email address.

Role

Select the role of the user. The role defines the privilege of the user.

Status

Specify the status of the user as active or inactive.

Change Password

Select the checkbox to modify the user's password.

Password

Enter the password for this user.

Confirm Password

Enter the password again to confirm.

Delete a User
Go to System > User Management > Users.
Click Delete to remove the selected users.
// Not

The system default users cannot be deleted.

8.3 View and Log off Users
You can view the users who are currently online and log them off. Only the administratorrole user have the privilege to log off the other online users.
Go to System > User Management > Online Users.
Figure 8-8

Online user list

The currently online users are displayed in this table.

109

1. Select one or more users and click Force Logout.
2. Click OK in the pop-up confirm window. The selected user will be forced to log off.
Figure 8-9

Log out a user

110

System and Global Settings

You can configure tpNMS system and global settings in this section.
• Device Count
• Configure Email Server
• Configure Idle Timeout
• Configure Auto Refresh Interval
• Configure Data Retention
• Icons in the Upper-Right Region

111

9.1 Device Count
You can view the number of devices being managed currently. tpNMS can manage up to
200 devices simultaneously.
Go to System > Device Count > Device Count to view the managed device count.
Figure 9-1

View device count

Current Managed

Displayed the number of devices currently managed by tpNMS.

Maximum
Allowed

The maximum devices tpNMS can managed simultaneously. By default it’s 200.

Percentage

The ratio of managed devices to total allowed device.

9.2 Configure Email Server
Configure the sender email information for sending notification emails when the
configured alarms are triggered.

112

1. Go to System > System Settings > Email Server.
Figure 9-2

Configure email server settings

2. Enter your SMTP server address in the SMTP Server field. For example: smtp.gmail.com.
3. Enter your email address in the Sender Address field. For example: jerry@gmail.com.
4. If you want to encrypt the data sent from the server, select the Use Secure Connect (SSL)
check box.
5. Enter your SMTP server port in the Server Port field.
6. If your SMTP server requires authentication, select the Need Check Authority check
box and enter your user name and password for your email account.
7. Click the Test button to verify your email server settings.
8. Click the Save button to save your email server settings.

9.3 Configure Idle Timeout
Configure the idle timeout on this page. If the user has no operations on tpNMS within
the timeout period, the application will log the user out automatically. The default idle
timeout is 5 minutes.
Go to System > System Settings > Idle Timeout.

113

Figure 9-3

Configure the idle timeout

Select the idle timeout and click Apply to save your configuration.

9.4 Configure Auto Refresh Interval
Configure the frequency that tpNMS refreshes the browser screen for the web
management interface. By default the web refreshes every 30 seconds.
Go to System > System Settings > Auto Refresh.
Figure 9-4

Configure the refresh interval

Select the auto refresh interval and click Apply to save your configuration.

9.5 Configure Data Retention
Configure how long tpNMS retains your network data. The longer the data are retained,
the more disk space is required on the tpNMS server. Different types of information can be
specified with different data retention periods.
Go to System > System Settings > Data Retention.

114

Figure 9-5

Configure the data retention period

Enter the data retention period for these types of data and click Apply to save your
configuration.

9.6 Icons in the Upper-Right Region
The following introduces the shortcut icons on the upper-right area of tpNMS.

• Notification Messages
• Current Alarms
• System Information
• Current Account
• Log out

Notification Messages
Click the envelope icon
to view the system notifications. The application generates a
notification when a backup/restore/upgrade task is completed. The number in the redcolored circle on the top of the envelope icon
generated notifications.

115

indicates the number of the newly

Figure 9-6

System notifications

Current Alarms
Four shortcut icons represent the current four level alarms. The color represents the
severity, while red represents the highest level severity and blue represents the lowest
severity. The numbers beside these icons represent each alarm’s current quantity.

•

Urgent (Red)

•

Serious (Orange)

•

Normal (Yellow)

•

Hint (Blue)

Click the alarm icon to view the alarm’s detail information.
System Information
Click the icon

to view tpNMS's version and copyright information.

116

Figure 9-7

Version and Copyright

Current Account
Click the user name to view and edit the information of the current user.
Figure 9-8

Current user

Log out
Click the icon

to log out tpNMS.

117

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.7
Linearized                      : No
Tagged PDF                      : Yes
XMP Toolkit                     : Adobe XMP Core 5.4-c005 78.147326, 2012/08/23-13:03:03
Create Date                     : 2016:06:12 10:58:26+08:00
Metadata Date                   : 2016:06:13 10:02:41+08:00
Modify Date                     : 2016:06:13 10:02:41+08:00
Creator Tool                    : Adobe InDesign CC (Windows)
Instance ID                     : uuid:9b843930-0543-4ba6-af7a-52bb561a584c
Original Document ID            : xmp.did:065405c0-55dc-eb4f-b42b-bfb41f8e0dcd
Document ID                     : xmp.id:11518e8a-991b-3f47-a11c-c2118f5fe440
Rendition Class                 : proof:pdf
Derived From Instance ID        : xmp.iid:8ccc8e0f-5609-8243-a36f-a5564ec4ab87
Derived From Document ID        : xmp.did:1a3776a8-b5c1-9344-be19-8a9faf0017e6
Derived From Original Document ID: xmp.did:065405c0-55dc-eb4f-b42b-bfb41f8e0dcd
Derived From Rendition Class    : default
History Action                  : converted
History Parameters              : from application/x-indesign to application/pdf
History Software Agent          : Adobe InDesign CC (Windows)
History Changed                 : /
History When                    : 2016:06:12 10:58:26+08:00
Format                          : application/pdf
Producer                        : Adobe PDF Library 11.0
Trapped                         : False
Page Mode                       : UseOutlines
Page Count                      : 123
Creator                         : Adobe InDesign CC (Windows)

EXIF Metadata provided by EXIF.tools

Tp NMS UG

Tpnms Ug tpNMS_UG tpNMS_UG doc down res static.tp-link.com 3:

Navigation menu

Versions of this User Manual:

Views

Navigation