Thruk - Custom Quick Action

Custom Quick Actions

new in release v3.24

Custom quick actions can be added to the quick action menu on host and service detail pages. This is done by creating a custom user template file called user_quick_commands.tt in your user template path.

Custom Quick Action

The template file can contain two blocks:

The init block is used to add new quick actions to the list of existing ones.
The form block can be used to add additional form fields to the quick action form.

The form fields will be available as POST variables in the script called by the quick action. All variables are available as environment variables prefixed with POST_.

There are two special variables containing the selected objects:

POST_SELECTED_SERVICES: A list of all selected services.
POST_SELECTED_HOSTS: A list of all selected hosts.

The format of the selected services is:

HOST;SERVICE;BACKEND~~HOST;SERVICE;BACKEND~~...

The format of the selected hosts is:

HOST;BACKEND~~HOST;BACKEND~~...

Examples

Add a custom quick action

This custom quick action will open a form to create an incident in an external system. The form contains a comment field, a team selection and an option to create one ticket for all selected objects.

If not already set, set the user template path in your thruk_local.conf:

thruk_local.conf

  user_template_path = ./my_templates

Then create the file user_quick_commands.tt in that directory and add the following content:

my_templates/user_quick_commands.tt

[%# the init block may adjust the list of 'quick_commands' #%]
[% IF block == "init" %]
  [%
    CALL quick_commands.push({
        val     => "server://testaction",
        icon    => "fa-solid fa-envelope",
        label   => "Create an incident",
        hide    => 0,
        cmd_chk => [],
        cls     => "",
        form    => [ 'row_comment', 'row_cust_teams', 'row_cust_options' ],
      });
  %]
[% END %]

[%# the form block can add required form blocks #%]
[% IF block == "form" %]
  <tr id="row_cust_teams" class="js-quick-command-form-options">
    <th class="align-top">Team</th>
    <td>
      <select name="team">
        <option value="team1">Team1</option>
        <option value="team2">Team2</option>
        <option value="team3">Team3</option>
      </select>
    </td>
  </tr>
  <tr id="row_cust_options" class="js-quick-command-form-options">
    <th class="align-top">Options</th>
    <td>
      <input type="checkbox" id="single"> <label for="single">One ticket for all</label>
    </td>
  </tr>
[% END %]

Add an entry for the script called if someone uses the quick action.

thruk_local.conf

  <action_menu_actions>
    testaction   = ./testaction.sh
  </action_menu_actions>

Finally the script testaction.sh could look like this:

#!/bin/bash

# acknowledge all selected services.

LOG=/tmp/actionmenu.log
exec >$LOG 2>&1
echo "[$(date)]" >> $LOG

IFS='~~' read -ra SERVICES <<< "$POST_SELECTED_SERVICES"
for SVC in "${SERVICES[@]}"; do
    if [ "x$SVC" = "x" ]; then
        continue;
    fi
    IFS=';' read -r HOST SERVICE BACKEND <<< "$SVC"
    thruk -A $REMOTE_USER r \
        -b "$BACKEND" \
        -d "comment_data=$POST_COM_DATA" \
        -d "cmd=acknowledge_svc_problem" \
        -d "host=$HOST" \
        -d "service=$SERVICE" \
        /cmd
done

exit 0