Plugin Hook API Reference

The following table shows all known Cacti plugin hooks and a brief description of their function.

add_graph_template_to_host

Allows you to perform additional operations when adding a graph template to host. The parameters passed are host_id and graph_template_id.

api_device_new

This hooks allows you to perform additional operation at the end of api_device_save function. Unlike the api_device_save hook, the device ID is already defined here.

api_device_save

This hook allows you to perform additional operation at the end of api_device_save function. Unlike the api_device_new hook, the device ID is might not be defined here.

This hook allows you to alter the contents to the device table with custom fields. When used properly, it allows you to extend the host table with your plugins custom fields.

auth_alternate_realms

This hook allows you to handle user login check alternate plugin defined authentication realms.

auth_profile_reset

Allows you to reset plugins all user settings

auth_profile_reset_value

Allows you to reset plugins single user settings

auth_profile_run_action

Allows you to draw plugins user settings form

auth_profile_save

Allows you to save plugins all user settings

auth_profile_tabs

Allows you to draw plugins user setting tabs

auth_profile_update_data

Allows you to update plugins single user setting

boost_poller_bottom

bottom_footer

Allows you to override the rendering of the bottom_footer html snippet.

cacti_stats_update

change_password_title

clog_regex_array

Allows you to enhance the Logs display with additional information or links.

config_arrays

Allows your plug-in to define custom array elements to be used throughout cacti. Things like dropdown arrays and the like.

config_form

Allows you to define form object to represent data to be stored in your tables. In the case of MacTrack, there is a table called mac_track_sites and in order to drive the UI and allow for the user to provide input and save a site, you must provide the Cacti form engine a form array to allow for the form to be presented and contents to be saved.

config_insert

This is a general purpose hook used for connecting to other database, or sourcing common includes that would otherwise not be sourced.

config_settings

Allows you to extend the Cacti settings page to allow for custom tabs and global settings within them.

console_after

Allows you to add text after the default message on the console page

console_before

Allows you to add text before the default message on the console page. For instance, the Update plug-in will display a message here if there are new versions of plugins.

copy_user

Allows a plugin to take part in the Copy User actions. This is important a plugin maintains user settings.

create_complete_graph_from_template

Allows you to perform additional operations when adding new graph to device from graph template.

custom_denied

Allows you to override the rendering of the permission denied interface.

custom_login

Allows you to override the rendering of the auth_login.php page.

custom_logout_message

Allows you to override the rendering of the logout.php page.

custom_password

Allows you to override the rendering of the auth_changepassword.php page.

custom_version_info

Allows your plugin to display additional information on the cacti tech support page.

data_input_sql_where

data_source_action_array

Allows you to define custom dropdown actions from within the data sources page.

data_source_action_bottom

data_source_action_execute

Allows you to define custom actions to be taken upon you dropdown selection.

data_source_action_prepare

This is the final component to creating a custom action within the data sources. In Cacti's form engine, you must provide the dropdown action and then two follow-up actions to complete the cycle. This is were you actually save the data.

data_source_edit_bottom

Allows you to make minor change to the Data Sources page, like add a tabbed interface.

data_source_edit_top

Allows you to make minor changes to the Data Sources page, like add a tabbed interface.

data_source_remove

This hook is called when the data sources used by a graph are removed. The parameters are the graphs data sources.

data_source_to_poller_items

data_sources_table

Allows you to change the data displayed on the Data Sources table. THold uses this to create a link to that datasources threshold

device_action_array

Allows you to define custom dropdown actions from within the device/host page.

device_action_bottom

device_action_execute

Allows you to define custom actions to be taken upon you dropdown selection.

device_action_prepare

This is the final component to creating a custom action within the devices. In Cacti's form engine, you must provide the dropdown action and then two follow-up actions to complete the cycle. This is were you actually save the data.

device_display_text

This hook allows you to add custom columns header to the host list page

device_edit_pre_bottom

device_edit_top_links

This hook allows you to add custom actions to the host edit page, below the "Create graphs for this Host".

device_filter_end

This hook allows you to add custom filter fields before Cacti buildin filter to the host list page

device_filter_start

This hook allows you to add custom filter fields after Cacti buildin filter to the host list page

device_filters

device_remove

This hook allows you to perform additional actions on devices that have been selected for deletion. The parameter is an array of deleted device IDs. Note that at this point, the devices are already deleted from the host table.

device_sql_where

device_table_bottom

device_table_replace

Allows you to override the rendering of the host list page

device_template_edit

device_template_top

draw_navigation_text

Just below the Cacti "Console", and "Graphs" tabs, cacti provides a Navigation bar that allows you to move backward in a selection tree. Although it is not foolproof, this hook allows you to populate and navigate that tree.

export_action

fgc_contextoption

get_friendly_name

global_settings_update

graph

This hook is called at the top of graph.php page

graph_buttons

You know about the zoom button right? Well this allows you to add any additional custom button to the right of a graph.

graph_edit_after

graph_image

This hooks allows displaying of alternative graphics in place of a graph image. This hook can no output text, only modify the image, as it is only called when a graph is required to be outputted.

graph_items_remove

This hook is called when when the data source is deleted, and the option to remove all graph items tied to the data source is selected.

graph_tree_page_buttons

Allows you to add custom HTML to the graph tree view page, under the timespan presets and the graph search box.

graphs_action_array

Similar to the host actions and host, prepare and execute hooks. It allows you to have custom dropdown actions within the graph management interface.

graphs_action_bottom

graphs_action_execute

graphs_action_prepare

graphs_item_array

graphs_new_top_links

Add a link at the top of the "Create New Graphs" page.

graphs_remove

This hook is called after one or more graphs are removed. The parameters are the removed graph IDs.

graphs_sql_where

This hooks allows you to add additional where clauses to the select statement used to display graphs on the graphs.php page.

hmib_get_cpu

hmib_get_cpu_indexes

hmib_get_disk

host_edit_bottom

Allows you to make minor changes to the Devices page, like add a tabbed interface.

host_edit_top

Allows you to make minor changes to the Devices page, like add a tabbed interface.

host_save

import_action

is_console_page

login_after

This allows you to display text or html after the login form.

login_before

This allows you to display text or html before the login form. Combined with the above hook, you could draw a box, etc around the form, change its background color, etc to slightly customize the login page.

login_options_navigate

Used to support alternate login realm types.

login_process

Used to authenticate the user logging in to a custom plugin defined realm.

login_realms

Used to defined additional custom plugin defined authentication realms. The parameter passed is an array of existing authentication realms.

login_title

Allows the plugin to set/modify that page title.

logout_post_session_destroy

This pair of hooks (logout_pre_session_destroy and logout_post_session_destroy) allows you to preserve some session variables that would otherwise get unset, when session_destroy() is called.

logout_pre_session_destroy

This pair of hooks (logout_pre_session_destroy and logout_post_session_destroy) allows you to preserve some session variables that would otherwise get unset, when session_destroy() is called.

nav_login_after

This pair of hooks (nav_login_before and nav_login_after) allows you to add custom HTML to the navigation bar, before and after the "Logged in as " text.

nav_login_before

This pair of hooks (nav_login_before and nav_login_after) allows you to add custom HTML to the navigation bar, before and after the "Logged in as " text.

page_bottom

This hook allows you to add custom HTML to the bottom of the page, after the main layout table.

page_buttons

Allows you to add custom buttons and HTML to the top of the graph.php page, above the "Viewing graph" row.

page_head

This hook allows you to add custom HTML tags to the page tag.

page_title

Allows the plugin to set/modify the page title

poller_bottom

This hook allows you to launch other polling activities once Cacti has complete it's polling activities. Things like MacTrack, Boost, THold, and others use this hook to launch their respective poller.

poller_command_args

Using this hook, your plugin can pass additional command line arguments to the poller.

poller_exiting

poller_finishing

poller_output

This hook was designed specifically for the boost plug-in. However, it has found new life in many plugins making them much faster now. What this hook allows you to do is intercept the contents of the poller_output table before the data is deleted. This allows for things like threshold checking and other interesting actions such as checking for up/down events and the like. Previously, plugins were reliant on using things like rrdtool fetch to perform these actions. Now they can leverage the pollers output directly.

poller_remote_maint

This hook will fire for plugins that need to perform remote maintenance. It will only fire on the Remote Data Collectors.

poller_top

This hook allows you to launch processes concurrently with the Cacti poller for things like THolds fast poller for example.

remote_agent

replicate_in

replicate_out

resolve_dependencies

rrd_graph_graph_options

This hook allows you to specify additional options or change parameters regarding graph image rendering. Some of the parameters will be passed to RRDtool.

run_data_query

This hook allows your plugin to perform additional operations after a data query update was triggered.

snmpagent_cache_install

substitute_host_data

This allows you to add to the substitution variables that cacti can parse.

top_graph_header

Allows you to override the rendering of the top_graph_header.php include.

top_graph_header_tabs

This hook is used to add tab's to Cacti's user interface.

top_graph_jquery_function

top_graph_refresh

This allows you to change the refresh on the graph (and any plug-in page that calls the graph header)

top_header

This hooks enables you to output custom HTML on top the the graph view page, if navigation tabs are not rendered. Allows you to override the rendering of the top_header.php include.

tree_after

This hook allows you to add additional HTML at the bottom of the graph tree view page. The HTML is rendered only if a valid graph tree leaf is selected.

tree_view_page_end

This hook allows you to add additional HTML at the bottom of the graph tree view page, irrespective of the leaf selection.

ugroup_tabs

update_data_source_title_cache

This hook is called after the data source title cache is updated.

user_admin_action

This hook is part of a series of hooks that allow you to add custom user settings. Consider a plug-in called "abc". In that plug-in, you want to save custom settings on a per user basis. Therefore, following our unpublished ? table naming standards, you would create a table called "abc_settings". When you tab over to the "abc" plug-in, you are provided an "abc settings" on the right similar to "Graphs". The next series of hooks allow you to present those settings to the user, enable or disable the users access to that specific "abc settings" tab and allow an administrator to define customer values for that plug-in on a per user basis.

user_admin_edit

See the explanation on user_admin_action

user_admin_run_action

See the explanation on user_admin_action

user_admin_setup_sql_save

See the explanation on user_admin_action

user_admin_tab

See the explanation on user_admin_action

user_admin_user_save

See the explanation on user_admin_action

user_group_admin_action

user_group_admin_edit

user_group_admin_save

user_group_admin_setup_sql_save

user_remove

Allows the plugin to take part in the user removal process. Important when the plugin maintains user settings.

utilities_action

This hook set's up the function to be executed from within Cacti's utilities section.

utilities_array

utilities_list

This hook allows you to add a custom utilities pick under Cacti's "Utilities" page.

utilities_tab

This hook allows you to add a custom utilities tab under Cacti's "Utilities" page.

valid_host_fields

Allows your plugin to define additional variables that will be used in substitute_host_data.

Pretty sure that this hook allows you to define custom replacement values in graphs.

Copyright (c) 2004-2023 The Cacti Group