diff --git a/modules/monitoring/doc/01-About.md b/modules/monitoring/doc/01-About.md index 286ca2010..deb47bfe0 100644 --- a/modules/monitoring/doc/01-About.md +++ b/modules/monitoring/doc/01-About.md @@ -7,3 +7,4 @@ Please read the following chapters for more insights on this module: * [Security](06-Security.md#monitoring-module-security) * [Restrict Custom Variables](10-Restrict-Custom-Variables.md#monitoring-module-restrict-access-custom-variables) * [Hooks](20-Hooks.md#monitoring-module-hooks) +* [Add Columns to List Views](11-Add-Columns-List-Views.md#monitoring-module-add-columns-list-views) diff --git a/modules/monitoring/doc/11-Add-Columns-List-Views.md b/modules/monitoring/doc/11-Add-Columns-List-Views.md new file mode 100644 index 000000000..2567ead74 --- /dev/null +++ b/modules/monitoring/doc/11-Add-Columns-List-Views.md @@ -0,0 +1,32 @@ +# Add Columns to List Views + +The monitoring module provides list views for hosts and services. +These lists only provide the most common columns to reduce the backend +query load. + +If you want to add more columns to the list view e.g. in order to use the URL in +your dashboards or as external iframe integration, you need the `addColumns` URL +parameter. + + + +Example for adding the host `address` attribute in a host list: + +``` +http://localhost/icingaweb2/monitoring/list/hosts?addColumns=host_address +``` + +![Screenshot](img/list_hosts_add_columns.png) + + + + +Example for multiple columns as comma separated parameter string. This +includes a reference to the Icinga 2 host object custom attribute `os` using +`_host_` as custom variable identifier. + +``` +http://localhost/icingaweb2/monitoring/list/services?addColumns=host_address,_host_os +``` + +![Screenshot](img/list_services_add_columns.png) diff --git a/modules/monitoring/doc/img/list_hosts_add_columns.png b/modules/monitoring/doc/img/list_hosts_add_columns.png new file mode 100644 index 000000000..874a8f1fe Binary files /dev/null and b/modules/monitoring/doc/img/list_hosts_add_columns.png differ diff --git a/modules/monitoring/doc/img/list_services_add_columns.png b/modules/monitoring/doc/img/list_services_add_columns.png new file mode 100644 index 000000000..dd0db820a Binary files /dev/null and b/modules/monitoring/doc/img/list_services_add_columns.png differ