Map configuration format description

General Information

The NagVis configuration file format is very similiar to the format used by Nagios(TM).

Configuration statements start with the keyword "define" followed by a type field and a left curly bracket ({). Every following line defines variable-value pairs, separated by a ( = ) until a right curly bracket (}) is found.

Hashes (#) are used to mark comments, note that a comment line MUST start with a hash not with other chars like whitespaces!

Object types

• Global
• Host
• Service
• Hostgroup
• Servicegroup
• Map
• Textbox
• Shape
• Line (New in 1.5)
• Template

Description of the object types

Global

The first definition in every config file should be of the special type "global". Options which are defined at this paragraph are valid for the whole map and are getting inherited to other types defined later.

Example with all options which have to be set:

define global {
 map_image=lan.png
}

Host

Example with all options which have to be set (note that options already defined in the global section are optional):

define host {
 host_name=localhost
 x=100
 y=200
}

Service

Example with all options which have to be set (note that option already defined in the global section are optional):

define service {
 host_name=localhost
 service_description=ping
 iconset=std_big
 x=100
 y=200
}

Hostgroup

Example with all options which have to be set (note that options already defined in the global section are optional):

define hostgroup {
 hostgroup_name=servers
 x=100
 y=200
}

Servicegroup

Example with all options which have to be set (note that options already defined in the global section are optional):

define servicegroup {
 servicegroup_name=servicegroup1
 x=100
 y=200
}

Map

Example with all options which have to be set (note that options already defined in the global section are optional):

define map {
 map_name=webserver
 x=77
 y=156
}

Textbox

Example with all possible options:

define textbox {
  text="This is an informational text which can be placed anywhere on the map, HTML can also be used for formatting purposes"
 x=200
 y=100
 w=200
}

Shape

Basicaly shapes are simple images which can be moved and positioned on the map. The shapes are meant to be layout elements. The shapes were added to give the users the option to create less static maps.

Example with all values which have to be set:

define shape {
 icon="test"
 x=200
 y=100
}

Line (New in 1.5)

The line is a stateless layout element to connect elements and visualize stateless connections between other objects. The objecttype has been created to make the design less static.

Example with all values which have to be set:

define line {
	line_type=1
	x=200
	y=100
}

Template

In NagVis 1.2 there is a new object type named template. With this object you have the ability to define all values except the must-have-attributes in one object for many others. You can set all attributes to the value you need and inherit them with the use attribute to each object.

At the moment the template objects have to be defined directly in the files, the WUI doesn't support it. Maybe it'll be added in following versions.

Example with all values which have to be set:

define template {
 name=generic-template
}