skip to main content
The GUI
  
The GUI
Navigation
The new generation GUI in op5 Monitor is made to be as simple as possible to use. Even if the GUI has a new look and feel it works in many ways as the old one. You will recognize most of the features from the CGIs.
In-line help
A manual is great but many times you only need to get a fast answer about a special part of op5 Monitor.
To get information from the in-line help
1 Click the help icon
This gives you a small frame with the help text included in.
2 Click anywhere outside the help text to hide it.
 
Login and logout
To login to op5 Monitor
First of all you need to login before you can start use op5 Monitor. To login to the op5 Monitor GUI:
1 Point your browser to the portal page of your op5 Monitor server
( https://youserver/ )
2 Click op5 Monitor:
3 Enter login and password.
 
The default username is: monitor
The default password is: monitor
4 Click Login
To logout from op5 Monitor
To logout from op5 Monitor just click Log out in the upper right corner of the GUI.
Main menu
The navigation in op5 Monitor is simple and can be found in the top of the GUI. There are four main sections, seen from the left.
Information
Monitoring
Reports
Configuration
There are also five quickbar buttons.
Refresh
Page settings
Unhandled problems
Tactical Overview
Manage quickbar
Hide and show page header
In many views in op5 Monitor you can hide the page header. This will give you a bit more space to show the ''important`` things on the page.
Note: This is not persistent. This means that if you navigate away from the current view and back again the header is visible again.
If you take the Unhandled problems as an example the normal page header looks like the picture below. Under the page header the list of monitored objects is shown.
Hiding the page header
To hide the page header
1 Click Settings in the top right corner of the gui:
2 Click Hide page header check box and the page header will disappear at once.
Showing the page header
To show the page header again you just need do one of the following
Either click on the same menu choice in the main menu.
or follow the two steps below:
Add custom quickbar link
To add a custom link to the quickbar menu select the small manage quickbar menu icon to right of the quickbar.
Add the URL, name and icon for your custom link
Pop up graphs and comments
In every view where you find the icons for
graphs
comments
You can over the mouse pointer over the icon and get a pop up looking like this
Changing behaviour of the pop ups
You might not want to have those pop ups every time you hover with the mouse over one of the graph or comment icons. Then you can change that behaviour in My account.
To change the behaviour of the pop ups
1 Open up My account
2 Set either a delay or turn the pop ups of completely. The delay time is in ms.
3 Click Save.
Mouse over host
To quickly show the host address of a host, hold the mouse on the host. A pop-up will appear with the host address.
Keyboard commands
The keyboard commands are shortcuts to some of the features in the op5 Monitor GUI. The following keyboards commands are available:
search
pause
paging to the left
paging to the right
Table 1 Default keyboards commands
Function
Default command
Description
Search
Alt+Shift+f
Set focus to the search field of the GUI.
Pause
Alt+Shift+p
Pause or activate the refresh of the current view in the GUI.
Paging to the left
Alt+Shift+left
Takes you to the left in a view that have more than one page.
Paging to the right
Alt+Shift+right
Takes you to the right in a view that have more than one page.
By default the keyboard commands are disabled. To enable the keyboard commands and change their settings take a look at Keyboard commands used in the GUI on page 119.
 
Multiple host and service commands
Multiple commands is used to apply a single command to one or more host or services.
In almost every view in the monitoring section you may perform commands on the objects displayed in the view. This is very useful if you for instance have a bigger problem with one or many services you may then acknowledge all of them at once.
Multiple host commands list
Schedule downtime
Cancel Scheduled downtime
Acknowledge
Remove problem acknowledgement
Disable host notifications
Enable host notifications
Disable notifications for all services
Disable Active checks
Enable Active checks
Reschedule host check
Add host comment
Delete host
Multiple service commands list
Schedule downtime
Cancel Scheduled downtime
Acknowledge
Remove problem acknowledgement
Disable service notifications
Enable service notifications
Disable Active checks
Enable Active checks
Reschedule service check
Add service comment
Delete Service(s)
Example
In this example we will send acknowledgements to a larger number of services.
To execute multiple commands
1 Open up Unhandled problems view.
2 Click Select Multiple Items
(It is located on top of the list.)
3 Select the services problems you like to acknowledge.
4 Chose Acknowledge in Select Action drop down list just below the list and click Submit.
5 Type in a comment and click Submit.

Quick Action Menu
For quick access some host and service commands you can access the Quick action menu.
The menu can be accessed thru right clicking on the status icon in front of a host or service.
This menu will only appear if you are ‘Authorized for system commands’ under Access Rights in the configuration.
Information about the different actions can be found in the Monitoring chapter, Introduction on page 32
Host Actions
The actions that are available on a host are:
The actions accessible from the host quick access menu are:
Schedule Downtime
Disable host notifications
Disable notifications for all services
Disable active checks
Reschedule host check
Reschedule a check for all services on this host
Add host comment
Service Actions
The actions that are available on a service are:
Schedule Downtime
Disable service notifications
Disable active checks
Reschedule service check
Add service comment
Searching
op5 Monitor has got a search functionality that makes it easy to find:
Hosts
Services
Host groups
Service groups.
Notes
Status information
Note: The search is case insensitive.
The result is limited to maximum 10 result rows per object type.
In the upper right corner of the gui you find the search input field:
Simple search
To perform a simple search
1 Enter the search string in the input field shown in Searching on page 16 and press Enter.
2 While you are typing your search string op5 Monitor will show you a list of hosts matching the string.
3 If you click on a host in the drop down list you will be redirected to the Service Status Details For Host page for the host you clicked on. The same happens if the search found only one object matching your search string.
op5 Monitor will now search for hosts, services, service groups, host groups and notes matching the search string you entered.
The table below shows a list of in what parts of the object types is used in the search.
Object type
Variable
Host
host_name
host_alias
host_address
display_name
Service
service_description
display_name
Host group
hostgroup_name
alias
Service group
servicegroup_name
alias
Notes
Host notes
Service notes
Status Information
 
Advanced search
To make your search more specific you should use the advanced search features.
The following table describes the search parameters that can be used in the search function:
Short parameter
Long parameter
Description
h:
host:
Search for hosts
s:
service:
Search for services
hg:
hostgroup:
Search for host groups
sg:
servicegroup:
Search for service groups
si:
statusinformation:
Search for Status information using the output from the latest service / host check.
AND
 
The AND operator is used to filter records based on more than one condition
OR
 
The OR operator is used to filter records based on more than one condition
Note: Remember to not use any space between the : and the search string
Advanced search examples
Example 1 Search for hosts containing a certain string in the host name.
If you want to search for hosts only containing “server” in the host name
just enter the following in the search field:
h:server
or
host:server
Press enter to perform the search.
 
Example 2 Perform a search combining both hosts and services in the query.
In this example we want to find all services called either ping or http running on hosts called something like win or linux.
The query would then be:
h:win OR linux AND s:ping OR http
 
Example 3 Search for Status Information
To search for hosts and services having a certain string in their status output you shall write a query like this:
si:Connection refused
By using the si: search term and you will search the output from the latest check.
 
Example 4 Show all hosts or services
You may also get a list of all services and all hosts from the search function.
To get a list showing all services and host you should write the search query like this:
s:% OR h:%
Example 5 Show all hosts, services, host groups and service groups
To get a complete list of all hosts, services, host groups and service groups you only need to write a query like this:
%
This will give you a result with all object types grouped in one page.
 
Notes search
The search function can search on notes that is set in the configuration on both in hosts and services.
By default the search function will not search in notes. To enable this go to ‘My Account’ in the menu
and set ‘Show Notes’ to ‘Yes’
Limiting the number of result objects
The default search result will is limited to 100 rows. This can be changed in the search query.
To change the limitation you only need to add limit with the number of lines to your query like this:
limit=10
The line above will give you max 10 rows in the search result.
To return all rows set:
limit=0
 
Search result
No matter if you use the simple or the advanced way to do your search you will end up with the same type of result list.
As you can see in the search result example below the search will be shown with one part for each type of object.
Just like in the normal views you can sort all columns in the search result.
Refresh time
Every view is automatically refreshed after a certain time. You can easily pause or edit the global refresh time in the GUI.
The default Global refresh time is: 90 seconds.
The Global refresh time is valid for all views that uses auto refresh. So it does not matter in what view you are pausing or editing.
Pausing the page refresh
To pause the page refresh
1 Click Settings in the quickbar of the menu:
2 Click in the Pause refresh check box and the Global refresh time is paused.
Editing the refresh time
To edit the Global refresh time
1 Click on the Settings icon in the quickbar menu:
2 Pull the slider to increase or decrease the refresh time.
Once you have edited the Global refresh time a little notice will show up in the GUI. It tells you that the new Global refresh time is saved and look like the picture below.
Widgets
Widgets are used to give the user a ability to personalize the Tactical Overview display status data for their needs.
The first thing you will see when you login to op5 Monitor is the Tactical overview and it looks like this:
In the Tactical Overview you may:
move around the widgets to different places
close the widgets
set individual refresh time for each widget
collapse and expand all individual widgets.
create another instance of the widget
scale the widgets over multiple columns
 
Note: All changes you make with the widgets are saved per user.
Widget list
op5 Monitor comes with a number of available widgets used to display data in Tactical Overview:
Unacknowledged Service Problems
Scheduled Downtime
Acknowledged Service Problems
Nagvis
Disabled Checks
Services
Host Performance
Merlin Node Status
Acknowledged Problems
Monitoring Performance
Hosts
Network Health
Monitoring Features
Unhandled Problems
Business Processes
Network Outages
Geomap
Beside this wide range of widgets you can find additional widgets on www.op5.org, or create a own widget that fits your needs. This is described in“op5 Monitor Administrators Manual”.
Widget parts
Below you see an example of what a widget can look like:
 
The following table describes the parts of a widget shown in the picture above.
Nr
Description
1
Widget header
2
Copy Widget
3
Collapse and Expand icon
4
Widget settings icon
5
Widget content
6
Hide widget
Renaming the widget header
The widget header displays the name of the widget.
To change the name in the widget header
1 Double click on the name in the widget header.
2 Type the new name in the text field.
3 Click OK to save the new name.
Collapse and expand
If you like to hide the content of a widget but still keep it on the Tactical overview page just click on the Collapse icon.
To show the widget again
Click on the Expand icon.
Widget settings
In this version of op5 Monitor the only setting you can change on a widget settings is:
Refresh time
To set the refresh time on an individual widget follow the instructions below:
1 Click Widget settings icon
2 Move the slider to increase or decrease the refresh time.
Extended widget settings
As described in “Multiple instances on page 28” it is possible to create multiple copies of a widget.
This can be useful with some of the widgets we ship with op5 Monitor such as “Unacknowledged Service problems”. This widget displays the content of “Unhandled Problems” as default, but can be configured to use filters to display status information from servicegroups, and it is also possible to filter on the following statuses:
Warning
Critical
Unknown
Hard
Backlog
Besides the standard Status filters: “Warning, Critical, Unknown”, Hard and Backlog are present.
With “Hard” you can select to only filter on Hard status and discard all SOFT states. This is the default setting when op5 Monitor sends notifications.
Backlog is a little more complicated. This setting can be useful if Tactical overview is displayed on a screen as a NOC-dashboard to monitor the status of hosts and services.
When the Backlog setting is used the widget will display all the problems that has been reported since your last login, even if these problems has been resolved.
To remove a problem when the backlog setting is activated you must either acknowledge the problem, or click the “X” button to remove it form the list.
Note: The backlog setting is global and affects all users
 
In the following example we will choose to display all the critical problems in HARD-state from the servicegroup “Web Services”:
 
1 Click settings button and select a servicegroup:
2 Select the servicegroup you want to monitor with the widget:
3 When you have applied your settings a notification will be displayed in the top right corner showing that the settings are saved.
4 The widget displays the current CRITICAL services for the selected servicegroup.
 
Closing widgets 1
You may close one or more widgets from the Tactical overview.
Just click on the Close widget icon to close the widget completely from the Tactical overview.
Closing widgets 2
Another way to close the widgets from the Tactical overview is to click on the Page settings icon.
And then you just uncheck the widget, you like to hide, from the list.
Note: The widget will only be visually removed from the Tactical overview. It will not be removed from the software. See Moving widgets on page 29 about how to show the widget again.
Multiple instances
It is possible to create multiple instances of a widgets, this can be useful to use to display different datasources in widgets, such as status of a servicegroup or critical unacknowledged problems.
To create another instance of a widget: Click the copy button on a widget .
This will create an identical copy of the widget.
 
Moving widgets
You may move around the widgets shown in the Tactical overview as you like.
To move a widget from one section an other
1 Grab the widget and move it to the section you like to place it in.
2 When you hover a section where you can drop the widget, a gray area will show where the widget will be placed.:
Restoring to factory settings
To restore the Tactical overview to factory (default) settings
1 Click Widget settings icon.
2 Click on the Restore to factory settings button and all widget have
been placed back to their original places
got their default refresh time set
been made visible again
been expanded.
Create you own widgets
You may build your own widgets but this is not a subject for this user manual.
You can read more about how to build your own widget in the op5 Monitor Administrator manual.