Configuration variables for multisite.mk

This article shows all configuration variable possible in multisite.mk. We apologize for the fact that it is currently not complete and the variables explained in other articles are not listed here yet.

Note: If you do not set a variable in your multisite.mk, then a default value will be used, which is documented for each setting. If your have once set a variable in multisite.mk and later remove that value, you need a restart of Apache in order to make sure that the default value is restored. This is due to Pythons module cache. If you do not like to restart Apache, then better explicitely set the variable to its default value in multisite.mk in such situations.

Basic settings

hidden_views

This variable allows you to globally hide certain views from the sidebar snapin "Views". They are still available if you'd enter their URL directly. Default is None, which hides nothing. Example: Hide two views:

hidden_views = [ "hosttiles", "allhosts_mini" ]

visible_views

This variable is an alternative to hidden_views and gives you more control. You define a positive list of all views to be displayed. The default is None which means that this feature is disabled. Please note that using this variable also affects custom views created by users. Example:

visible_views = [ "allhosts", "searchsvc", "searchhost", "hostproblems" ]

custom_style_sheet

By setting this variable to a string (a filename), you can make Multisite load a custom style sheet. In that you can override styles which are defined in check_mk.css. The default value is None. Example:

custom_style_sheets = "foobar.css"

Now create a CSS file in web/htdocs/foobar.css, usually located in /usr/share/check_mk.

start_url

1.1.8b1 When you point your browser to the Multisite GUI, you'll get a frame set with the sidebar (sidebar.py) on the left side and a welcome page (main.py) on the right side. You can replace the welcome page with another URL by setting start_url. The default value is main.py. Example 1 uses a relative URL and sets a hostgroup view as start page:

start_url = 'view.py?view_name=hostgroups"

Example 2 uses an absolute URL:

start_url = 'http://mathias-kettner.de'

Various settings

reschedule_timeout

1.1.9i1 Since version 1.1.9i1 hosts and services have a new icon for an immediate reschedule of that host or service check. Multisite waits for the check to be actually executed before redisplaying the view. If the check has not been executed within 10 seconds, then no reload of the page takes happen and an error is diplayed. This timeout can be changed with this variable, e.g.:

reschedule_timeout = 20.0

buffered_http_stream

New in 1.2.0: Since version 1.2.0 the HTML response is created with an internal buffer. This greatly decreases the number of TCP needed for a response - greatly speeding up HTTPS connections. The behaviour is now default but you can set it back with:

buffered_http_stream = False

In that case TCP segments will always be sent as soon as new HTML code has been created.

filter_columns

1.1.11i1 Usually Multisite displays the drop down form for filtering items within a view in two columns. If you want you can switch this to 1 column (which avoids wrapping on smaller screens). The default value is 2.

filter_columns = 1

enable_sounds

1.1.13i3 Alarm sounds are now enabled per default. If a Multisite view with alarms enabled shows a shost or service in a non-OK state, an alarm sound is being played. You can disable sounds globally by setting enable_sounds to False:

enable_sounds = False

default_ts_format

1.1.2b2 This option can be used to change the default timestamp format in multisite. This option is pre-set to mixed which tells multisite to use relative times below 48h time ranges and absolute time formating for larger time ranges. This value can be set to e.g. abs to have absolute stamps in all cases.

default_ts_format = "abs"

Snapins

The following variables affect the behaviour of various sidebar snapins:

sitestatus_link_view

1.1.9i1 The name of the view the links in the snapin Site status link to. The default is "sitehosts", which shows a very condensed summary of the site. An alternative is:

sitestatus_link_view = "sitesvcs"

This makes the links point to a view showing all services of the site grouped by the host names.