Main configuration format description

General Information

The Main Configuration file is designed in plain text "ini"-like format. There are sections which are marked by the surrounding brackets [] and variables which have an assigned value. The variables have to be in the correct section so you have to ensure to have uncommented the section too. Semicolons (;) are used to mark comments. Sections and variables with a leading semicolon are commented out and won't be recognized by NagVis.

In a fresh NagVis installation there is no file with the default configuration. The default configuration is stored in the PHP-Code of NagVis. If there is a file etc/nagvis.ini.php which has stored configuration information it will override the default configurations. There is a file etc/nagvis.ini.php-sample with sample configuration values. All values are commented out.

Section overview

Description of the sections in detail

global

All values which are used througout NagVis are stored in the global section.

Value Default Description
dateformat Y-m-d H:i:s The format of date and time shown in NagVis. Available options like in date() function of php
displayheader 1 Show header menu in maps. (Deprecated in 1.4. Moved as option "headermenu" to default and index section.)
language en_US Select language to use in NagVis by default. There are four language files delivered by default: en_US (English), de_DE (German), fr_FR (French) and pt_BR (Brazilian Portuguese; since 1.4.4). Since NagVis 1.4 you have to select the languages in a new format ("en_US" instead of "english") (New in 1.4)
refreshtime 60 Refresh time of maps or reloading the next map in map rotation

paths

In this section all needed path variables are defined.
Value Default Description
base /usr/local/nagios/share/nagvis/ Absolute physical NagVis path
htmlbase /nagios/nagvis Absolute html NagVis path
htmlcgi /nagios/cgi-bin Absolute html NagVis cgi path

defaults

Default values which are applied to the maps you use. If there is no value set in the map or an element on the map the default value is used.
Value Default Description
backend ndomy_1 Default backend (ID of the backend - copy the text from which <backend-id> stands for in [backend_<backend-id>] )
backgroundcolor #fff Default background color of maps
contextmenu0Enable/Disable the context menu on your map objects. (New in 1.4)
contexttemplatedefaultDefault context template. (New in 1.4)
eventbackground 0 Enable/Disable changing background color on state changes (Configured color is shown when summary state is PENDING, OK or UP) (New in 1.4)
eventhighlight 1 Enable/Disable highlighting of the state changing object by adding a flashing border (New in 1.4)
eventhighlightduration 10000 Duration of the highlighting in miliseconds (New in 1.4.1)
eventhighlightinterval 500 Interval of the highlighting in miliseconds (New in 1.4.1)
eventlog 0 Enable/Disable the eventlog in the new javascript frontend. The eventlog keeps track of important actions and information (New in 1.4)
eventloglevel info Loglevel of the eventlog (Available: debug, info, warning, critical) (New in 1.4)
eventlogheight100Height of the javascript eventlog in px (New in 1.4)
eventloghidden1Hide/Show the eventlog on map loading (New in 1.4)
eventscroll 1 Enable/Disable scrolling to the icon which changed the state when the icon is out of the visible scope (New in 1.4)
eventsound 1 Enable/Disable sound signals on state changes (New in 1.4)
headermenu 1 Enable/Disable the header menu
headertemplate default Default header template
hovermenu 1 Enable/Disable the hover menu
hovertemplate default Default hover template
hovertimeout 5 Default hover menu ajax request timeout in seconds (Deprecated in 1.4)
hoverdelay 0 Delay of hover menu appearance in seconds
hoverchildsshow 1 Enable/Disable the child objects in hover menu
hoverchildslimit 10 Limit hover child objects to this maximum value
hoverchildsorder asc Order of the child objects (Available: asc/desc)
hoverchildssort a Sort method of the child objects (Available: "s": State, "a": Alphabet )
icons std_medium Default iconset
onlyhardstates 0 Recognize only hard states (not soft)
recognizeservices 1 Recognize service states in host/hostgroup objects
showinlists 1 Show the maps in lists (dropdowns,index page,...)
urltarget _self Target of the Icon link, this option adapts <a target=""> (_self is same window)
usegdlibs 1 Use gdlibs (if set to 0, lines will not work, all other types should work fine) (Deprecated in 1.4)

index

Options to configure the Overview page of NagVis (New in 1.4)
Value Default Description
backgroundcolor #fff Configure the background color of the overview page
cellsperrow 4 Maps per row in map listing
headermenu 1 Enable/Disable the header menu
headertemplate default Default header template
showrotations 1 Enable/Disable the listing of defined rotations

automap

Sets the automap options.
Value Default Description
defaultparams &maxLayers=2 These are the parameters for the automap views and links in the lists (map index page, dropdown menus in header)
defaultroot localhost Default value for the root object. For details see Automap documentation
graphvizpath /usr/local/bin If the graphviz binaries (dot,neato,twopi,...) could not be found in the PATH the path has to be set here
showinlists 1 Enable/Disable the automap in map lists (map index page, dropdown menus in header)

wui

These are the options for the WUI.
Value Default Description
allowedforconfig EVERYONE Users who are allowed to change the NagVis configuration (comma separated list) or EVERYONE
autoupdatefreq 25 In this interval the map gets backuped by the WUI.
maplocktime 5 Time in minutes a map is locked by an editing user.

worker

Options for the new worker in the javascript frontend of NagVis. (New in 1.4)
Value Default Description
interval 5 The interval in seconds in which the worker will check for objects which need to be updated.
requestmaxparams0The maximum number of parameters used in ajax http requests Some intrusion detection/prevention systems have a problem with too many parameters in the url. Give 0 for no limit.
requestmaxlength1900The maxium length of http request urls during ajax http requests. Some intrusion detection/prevention systems have a problem with too long queries.
updateobjectstates 15 The retention time of the states in seconds in the frontend. The state information will be refreshed after this time is over on next worker interval.

backend_*

The backend sections to define the backends are all named [backend_<backend-id>]. In the example the backend_id is ndomy_1. Depending on the value in backendtype the valid values for the backends have to be set. In this example it is the ndomy backend. 
[backend_ndomy_1]
backendtype="ndomy"
htmlcgi="/nagios/cgi-bin"
; the following options depend on the selected backendtype, in this case it is ndomy
dbhost="localhost"
dbport=3306
dbname="db_nagios"
dbuser="root"
dbpass="xxx"
dbprefix="nagios_"
dbinstancename="default"
maxtimewithoutupdate=181
Value Default Description
backendtype ndomy type of backend - MUST be set
htmlcgi /nagios/cgi-bin Path to the cgi-bin directory of this backend (interesting for multiple NDO backends)

For the backendtype specific options see the backends documentation.

rotation_*

Defines several map rotation pools. In this example the browser switches between the maps demo and demo2 every 15 seconds. The rotation is enabled by url: index.php?rotation= in this case the rotation id is: "demo" 
[rotation_demo]
maps="demo,demo2"
interval=15
Value Default Description
interval 15 Map rotation interval in seconds
maps

Comma separated list of maps to rotate in this pool. You can also add external URLs surrounded by [ and ] (e.g. maps="demo1,[http://localhost/test.php]". The URL has to be reachable and accessable by the server which NagVis is running on.

New in 1.4: You can add labels in the following format <label>:<map> and <label>:<[url]>. The labels are displayed in the rotation list.