PRTG Manual: Libraries Step by Step

IMPORTANT INFORMATION

This section was moved and is no longer kept up to date. For a detailed, up-to-date step-by-step guide, see the Paessler website: How to use libraries in PRTG in 4 steps.

z_i_round_blueThis documentation refers to an administrator that accesses the PRTG web interface on a master node. Other user accounts, interfaces, or failover nodes might not have all of the options in the way described here. In a cluster, note that failover nodes are read-only by default.

To create and review a new library, take the following steps:

Step 1: Add a Library

First, you need to create a new library.

Add Library Dialog

Add Library Dialog

  1. Click Libraries in the main menu bar to show an overview list of all libraries.
  2. Hover over z_b_add and select Add Library from the menu to open the Add Library dialog.
  3. Enter a meaningful Library Node Name.
  4. Optionally, define the Security Context, enter Tags, and set the User Group Access for the new library.
  5. Click Create.

z_i_square_cyanFor more information, see section Libraries and Node Settings.

z_i_round_blueWhen a user with administrative rights creates a new object, only other users with administrative rights can view or edit the new object by default. When a read/write user creates a new object, all members of the read/write user's primary group can view and edit the new object as well. This behavior applies to libraries, maps, reports, notification templates, and schedules. For more information, see section Access Rights Management.

Step 2: Add Library Nodes

Because the new library is empty in the beginning, you need to add library nodes to fill the library with content.

  1. Click the new library in the Libraries list. The library's Overview tab opens.
  2. Click the Management tab. You see a split screen:
    • On the left side, you can see your library. If you create a new library, it is empty in the beginning.
    • On the right side, you see your device tree.
Bandwidth Library in Management Mode 

Bandwidth Library in Management Mode 

  1. From the device tree on the right side, drag objects and drop them on the library on the left side. Each dropped object is immediately added as a new library node. Repeat this procedure as often as you wish until you have added all desired items to the library.

z_i_round_blueLibrary nodes can contain up to 1,000 sensors. However, if you add single sensors to the library via the Management tab, there can only be one sensor in one library node.

  1. Click Add Library Node or Add Group in the bottom-left corner of the split screen to create nested library nodes.
  2. Drag and drop library nodes to change their position. If you want to change the monitoring object that is associated with a library node, you can change the Linked Object in the library node's settings.

z_i_square_cyanFor more information, see section Libraries and Node Settings.

Step 3: Set Library Node Display Settings

After you set up your library and filled it with content, you can edit the library nodes' display settings.

Right-click the name of a library node and select Edit | Settings from the context menu to change the Library Node Display Settings. In the dialog that appears, you can change the name of the library and its tags, as well as the linked object, the library node view, and filters. These settings are available for each library node.

Edit Library Node Display Settings

Edit Library Node Display Settings

You can either show the Linked Object as a subtree of your device tree including probes, groups, and devices, or you can view all sensors underneath the Linked Object.

  • When you select Show a subtree of the device tree, the library node called My Sub Tree, for example, looks like a branch in your device tree.
     
Library with One Node that Shows a Branch of the Device Tree

Library with One Node that Shows a Branch of the Device Tree

  • When you select Show a collection of filtered sensors, PRTG only shows the sensors that are underneath the Linked Object in the device tree without probes, groups, and devices. You can additionally filter for certain sensor types, states, and tags. PRTG then only shows matching sensors. In the example screenshot, you can see the library node My Sub Tree where only bandwidth sensors are shown.
     
Library with One Node that Only Shows a Collection of Bandwidth Sensors

Library with One Node that Only Shows a Collection of Bandwidth Sensors

z_i_square_cyanFor more information, see section Libraries and Node Settings.

Step 4: View the Library

Click the Overview tab to see the final appearance of your library.

z_i_round_blueIt depends on the group access rights defined for the library and the logged in user account if the library is visible to users other than administrators.

View Library

View Library

You can take the following actions:

  • Hover over an object to view a hover popup with recent monitoring and object status data.
  • Use the sensor status bar to select which sensors you want to display in the library. You can hide sensors that are in a certain status by clicking the respective status icon. To show the sensors again, click the status icon again.
    z_i_round_blueThis setting is reset the next time you open the library.
  • Use the different viewing options to change the size of the library display.
  • Use the search box to search the library for a string in object names. PRTG shows matching objects in full color and grays out all other objects while the filter is active.
  • Click an object in the library, for example, a sensor, to show more detailed information about the object.
    z_i_round_blueIf a user does not have enough permissions to view the detailed information, for example, because they are a member of a user group that does not have the respective group access rights, they get an error message.
  • Right-click a library or a library node to open its context menu where further options are available.

More

z_i_playVideo Tutorial

Libraries in PRTG

Libraries