Configuration Reference

Configuration Reference

Global Configuration Variables

zabbix_user

SET zabbix_user username

• username : Zabbix username you want to connect with.

zabbix_password

SET zabbix_password password

• password : Zabbix password for the given user, you can connect with a guest account by omitting this parameter.

zabbix_url

SET zabbix_url url

• url : the Zabbix API URL used to make requests.

post_zabbix_graphs

SET post_zabbix_graphs enabled

• enabled : set to 1 to enable the Zabbix integration for overlib graphs, using a specific OVERLIBGRAPH syntax.

post_zabbix_graph_link

SET post_zabbix_graph_link enabled

• enabled : set to 1 to enable the links to the graph page in Zabbix, overriding the INFOURL links with link to a Zabbix graph.

post_zabbix_graph_base_url

SET post_zabbix_graph_base_url url

• url : the URL to the Zabbix frontend used to generate the graphs links.

post_zabbix_graph_width

SET post_zabbix_graph_width width

• width : the graphs width in pixels, use OVERLIBWIDTH to improve the positioning of the pop-up image. This is the width of the actual graph, and the image will be larger.

post_zabbix_graph_height

SET post_zabbix_graph_height height

• height : the graph height in pixels, use OVERLIBHEIGHT to improve the positioning of the pop-up image. This is the height of the actual graph, and the image will be larger.

post_zabbix_graph_period

SET post_zabbix_graph_period period

• period : the graph period in seconds.

Node and Link Configuration Directives

TARGET

To configure a link, use the following TARGET syntax:

TARGET zabbix:keyname:hostname:input_item_name:output_item_name

with:

• keyname: the attribute you want to use to select items in the configuration, possible values:
  • name refers to the item name configured in Zabbix
  • key_ refers to the key configured in Zabbix
  • itemid refers to the item id used by Zabbix
• hostname: the hostname of the host you want to use
• input_item_name: the input item identifier (according to what you put as keyname)
• output_item_name: the output item identifier (according to what you put as keyname)

For example:

TARGET zabbix:name:switch-01:GigabitEthernet3/8-IN:GigabitEthernet3/8-OUT

OVERLIBGRAPH

To configure a graph, use the following OVERLIBGRAPH syntax, for nodes and links:

OVERLIBGRAPH zabbix:keyname:hostname:graph_name

with:

• keyname: the attribute you want to use to select items in the configuration, possible values:
  • name refers to the graph name configured in Zabbix
  • graphid refers to the graph is used by Zabbix
• hostname: the hostname of the host you want to use
• graph_name: the graph identifier (according to what you put as keyname)

For example:

OVERLIBGRAPH zabbix:name:switch-01:GigabitEthernet3/8

You can also specify multiple graphs (keep in mind this may go off the screen):

OVERLIBGRAPH zabbix:keyname:hostname:graph_name_1 zabbix:keyname:hostname:graph_name_2

It can also be used with INOVERLIBGRAPH and OUTOVERLIBGRAPH (for links only):

INOVERLIBGRAPH zabbix:name:switch-01:GigabitEthernet3/8-IN
OUTOVERLIBGRAPH zabbix:name:switch-01:GigabitEthernet3/8-OUT

The generated INFOURL will be a link to the configured graph in your Zabbix frontend.

INOVERLIBGRAPH

Same as OVERLIBGRAPH, but only for links.

OUTOVERLIBGRAPH

Same as OVERLIBGRAPH, but only for links.

INFOURL

Can be overridden to be a link to the Zabbix graph configured with OVERLIBGRAPH if post_zabbix_graph_link is set to 1.