Zabbix Documentation 3.0

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


manual:config:visualisation:maps:map

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:config:visualisation:maps:map [2015/12/22 10:08]
martins-v updating content
manual:config:visualisation:maps:map [2018/08/30 05:54] (current)
martins-v adding link to map viewing information
Line 1: Line 1:
-==== - #1 Configuring a network map ====+==== 1 Configuring a network map ====
  
 === Overview === === Overview ===
Line 8: Line 8:
  
 Icons are used to represent map elements. You can define the information that will be displayed with the icons and set that recent problems are displayed in a special way. You can link the icons and define information to be displayed on the links. Icons are used to represent map elements. You can define the information that will be displayed with the icons and set that recent problems are displayed in a special way. You can link the icons and define information to be displayed on the links.
- 
-Maps are managed in //​Monitoring//​ -> //​[[manual:​web_interface:​frontend_sections:​monitoring:​maps|Maps]]//,​ where they can be configured, managed and viewed. In the monitoring view you can click on the icons and take advantage of the links to some scripts and URLs. 
  
 You can add custom URLs to be accessible by clicking on the icons. Thus you may link a host icon to host properties or a map icon to another map. You can add custom URLs to be accessible by clicking on the icons. Thus you may link a host icon to host properties or a map icon to another map.
 +
 +Maps are managed in //​Monitoring//​ -> //​[[manual:​web_interface:​frontend_sections:​monitoring:​maps|Maps]]//,​ where they can be configured, managed and viewed. In the monitoring view you can click on the icons and take advantage of the links to some scripts and URLs. 
 +
 +All users in Zabbix (including non-admin users) can create network maps. Maps have an owner - the user who created them.
 +
 +Maps can be made public or private. Public maps are visible to all users, however, they must have at least read permissions to all map elements to see it. To add an element to the map the user must also have at least read permission to it.
 +
 +Private maps are visible only to their owner. Private maps can be shared by the owner to other users and user groups. Regular (non-Super admin) users can only share with the groups and users they are member of. Private maps will be visible to their owner and the users the map is shared with as long as they have read permissions to all map elements. Admin level users, as long as they have read permissions to all map elements, can see and edit private maps regardless of being the owner or belonging to the shared user list.
  
 === Creating a map === === Creating a map ===
Line 33: Line 39:
 |//​Background image// ​ |Use background image:\\ **No image** - no background image (white background)\\ **Image** - selected image to be used as a background image. No scaling is performed. You may use a geographical map or any other image to enhance your map.| |//​Background image// ​ |Use background image:\\ **No image** - no background image (white background)\\ **Image** - selected image to be used as a background image. No scaling is performed. You may use a geographical map or any other image to enhance your map.|
 |//​Automatic icon mapping// ​ |You can set to use an automatic icon mapping, configured in //​Administration -> General -> Icon mapping//. Icon mapping allows to map certain icons against certain host inventory fields. ​ | |//​Automatic icon mapping// ​ |You can set to use an automatic icon mapping, configured in //​Administration -> General -> Icon mapping//. Icon mapping allows to map certain icons against certain host inventory fields. ​ |
-|//Icon highlighting// ​ |If you check this box, icons will receive highlighting.\\ Elements with an active trigger will receive a round background, in the same colour as the highest severity trigger. Moreover, a thick green line will be displayed around the circle, if all problems are acknowledged.\\ Elements with "​disabled"​ or "in maintenance"​ status will get a square background, gray and orange respectively. ​ |+|//Icon highlighting// ​ |If you check this box, icons will receive highlighting.\\ Elements with an active trigger will receive a round background, in the same colour as the highest severity trigger. Moreover, a thick green line will be displayed around the circle, if all problems are acknowledged.\\ Elements with "​disabled"​ or "in maintenance"​ status will get a square background, gray and orange respectively.\\ See also: [[:​manual/​web_interface/​frontend_sections/​monitoring/​maps#​viewing_maps|Viewing maps]] ​ |
 |//Mark elements on trigger status change// ​ |A recent change of trigger status (recent problem or resolution) will be highlighted with markers (inward-pointing red triangles) on the three sides of the element icon that are free of the label. Markers are displayed for 30 minutes.| |//Mark elements on trigger status change// ​ |A recent change of trigger status (recent problem or resolution) will be highlighted with markers (inward-pointing red triangles) on the three sides of the element icon that are free of the label. Markers are displayed for 30 minutes.|
 |//Expand single problem// ​ | If a map element (host, host group or another map) has one single problem, this option controls whether the problem (trigger) name is displayed, or problem count. If marked, problem name is used. | |//Expand single problem// ​ | If a map element (host, host group or another map) has one single problem, this option controls whether the problem (trigger) name is displayed, or problem count. If marked, problem name is used. |
Line 41: Line 47:
 |//Problem display// ​ |Display problem count as:\\ **All** - full problem count will be displayed\\ **Separated** - unacknowledged problem count will be displayed separated as a number of the total problem count\\ **Unacknowledged only** - only the unacknowledged problem count will be displayed| |//Problem display// ​ |Display problem count as:\\ **All** - full problem count will be displayed\\ **Separated** - unacknowledged problem count will be displayed separated as a number of the total problem count\\ **Unacknowledged only** - only the unacknowledged problem count will be displayed|
 |//Minimum trigger severity// ​ |Problems below the selected minimum severity level will not be displayed in the map.\\ For example, with //Warning// selected, changes with //​Information//​ and //Not classified//​ level triggers will not be reflected in the map.\\ This parameter is supported starting with Zabbix 2.2.  | |//Minimum trigger severity// ​ |Problems below the selected minimum severity level will not be displayed in the map.\\ For example, with //Warning// selected, changes with //​Information//​ and //Not classified//​ level triggers will not be reflected in the map.\\ This parameter is supported starting with Zabbix 2.2.  |
-|//​URLs// ​ |URLs for each element type can be defined (with a label). These will be displayed as links when a user clicks on the element in the monitoring section.\\ [[manual:​config:​macros|Macros]] that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID},​ {HOST.ID}, {TRIGGER.ID}|+|//​URLs// ​ |URLs for each element type can be defined (with a label). These will be displayed as links when a user clicks on the element in the map viewing mode.\\ [[manual:​config:​macros|Macros]] that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID},​ {HOST.ID}, {TRIGGER.ID}|
  
 The **Sharing** tab contains the map type as well as sharing options (user groups, users) for private maps: The **Sharing** tab contains the map type as well as sharing options (user groups, users) for private maps:
Line 62: Line 68:
 Now that you have some elements in place, you may want to start differentiating them by giving names etc. By clicking on the element, a form is displayed and you can set the element type, give a name, choose a different icon etc. Now that you have some elements in place, you may want to start differentiating them by giving names etc. By clicking on the element, a form is displayed and you can set the element type, give a name, choose a different icon etc.
  
-{{manual:​config:​visualisation:​map_element.png|}}+{{manual:​config:​visualisation:​map_element.png?600|}}
  
 Map element attributes: Map element attributes:
  
 ^Parameter^Description^ ^Parameter^Description^
-|//​Type// ​ |Type of the element:\\ **Host** - icon representing status of all triggers of the selected host\\ **Map** - icon representing status of all elements of a map\\ **Trigger** - icon representing status of a single trigger\\ **Host group** - icon representing status of all triggers of all hosts belonging to the selected group\\ **Image** - an icon, not linked to any resource ​ |+|//​Type// ​ |Type of the element:\\ **Host** - icon representing status of all triggers of the selected host\\ **Map** - icon representing status of all elements of a map\\ **Trigger** - icon representing status of a single trigger\\ **[[manual:​config:​visualisation:​maps:​host_groups|Host group]]** - icon representing status of all triggers of all hosts belonging to the selected group\\ **Image** - an icon, not linked to any resource ​ |
 |//​Label// ​ |Icon label, any string.\\ [[manual:​config:​macros|Macros]] and multi-line strings can be used in labels. ​ | |//​Label// ​ |Icon label, any string.\\ [[manual:​config:​macros|Macros]] and multi-line strings can be used in labels. ​ |
 |//Label location// ​ |Label location in relation to the icon:\\ **Default** - map's default label location\\ **Bottom** - beneath the icon\\ **Left** - to the left\\ **Right** - to the right\\ **Top** - above the icon  | |//Label location// ​ |Label location in relation to the icon:\\ **Default** - map's default label location\\ **Bottom** - beneath the icon\\ **Left** - to the left\\ **Right** - to the right\\ **Top** - above the icon  |
Line 75: Line 81:
 |//Host group// ​ |Enter the host group, if the element type is 'Host group'​. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups. Scroll down to select. Click on '​x'​ to remove the selected. ​ | |//Host group// ​ |Enter the host group, if the element type is 'Host group'​. This field is auto-complete so starting to type the name of a group will offer a dropdown of matching groups. Scroll down to select. Click on '​x'​ to remove the selected. ​ |
 |//​Application// ​ |You can select an application,​ allowing to only display problems of triggers that belong to the given application.\\ This field is available for host and host group element types, and supported since Zabbix **2.4.0**. ​ | |//​Application// ​ |You can select an application,​ allowing to only display problems of triggers that belong to the given application.\\ This field is available for host and host group element types, and supported since Zabbix **2.4.0**. ​ |
-|//Icon (default)// ​ |Icon to be used.  | 
 |//​Automatic icon selection// ​ |In this case an icon mapping will be used to determine which icon to display. ​ | |//​Automatic icon selection// ​ |In this case an icon mapping will be used to determine which icon to display. ​ |
 |//​Icons// ​ |You can choose to display different icons for the element in these cases: default, problem, maintenance,​ disabled. ​ | |//​Icons// ​ |You can choose to display different icons for the element in these cases: default, problem, maintenance,​ disabled. ​ |
 |//​Coordinate X//  |X coordinate of the map element. ​ | |//​Coordinate X//  |X coordinate of the map element. ​ |
 |//​Coordinate Y//  |Y coordinate of the map element. ​ | |//​Coordinate Y//  |Y coordinate of the map element. ​ |
-|//​URLs// ​ |Element-specific URLs can be set for the element. These will be displayed as links when a user clicks on the element in the monitoring section. If the element has its own URLs and there are map level URLs for its type defined, they will be combined in the same menu.\\ [[manual:​config:​macros|Macros]] that can be used in map URLs: {MAP.ID}, {HOSTGROUP.ID},​ {HOST.ID}, {TRIGGER.ID} ​ |+|//​URLs// ​ |Element-specific URLs can be set for the element. These will be displayed as links when a user clicks on the element in the map viewing mode. If the element has its own URLs and there are map level URLs for its type defined, they will be combined in the same menu.\\ [[manual:​config:​macros|Macros]] that can be used in map element ​URLs: {MAP.ID}, {HOSTGROUP.ID},​ {HOST.ID}, {TRIGGER.ID} ​ |
  
 <note important>​Added elements are not automatically saved. If you navigate away from the page, all changes may be lost. <note important>​Added elements are not automatically saved. If you navigate away from the page, all changes may be lost.
Line 109: Line 114:
  
 ^Parameter^Description^ ^Parameter^Description^
-|//​Label// ​ |Label that will be rendered on top of the link. You can use [[manual:config:macros|macros]] here.  |+|//​Label// ​ |Label that will be rendered on top of the link.\\ The [[:manual/appendix/macros/​supported_by_location|{host:​key.func(param)}]] macro is supported in this field, but only with ''​avg'',​ ''​last'',​ ''​min''​ and ''​max''​ trigger functions, with seconds as parameter.  |
 |//Connect to//  |The element that the link connects to.  | |//Connect to//  |The element that the link connects to.  |
 |//Type (OK)// ​ |Default link style:\\ **Line** - single line\\ **Bold line** - bold line\\ **Dot** - dots\\ **Dashed line** - dashed line  | |//Type (OK)// ​ |Default link style:\\ **Line** - single line\\ **Bold line** - bold line\\ **Dot** - dots\\ **Dashed line** - dashed line  |