How-to get a local copy of a special agent

Owned by Anastasios Thomaidis
Last updated: Oct 28, 2024 by Matthew Hierholzer
It may be necessary to modify a special agent shipped with Checkmk. Please don't modify the original files. You will lose any modifications after an upgrade.

LAST TESTED ON CHECKMK 2.3.0P1

Table of Contents

Step-by-step guide

  1. Log on via SSH and become the siteuser

    root@linux# su mysite

    .

  2. Copy the agent to the local structure

    OMD[mysite]~$:cp ~/lib/python3/cmk/special_agents/<script>.py ~/local/share/check_mk/agents/special/

    .

    Please be aware that in order for the custom special agent to be executed by Checkmk instead of the default one, it needs to have the same name as the default special agent.

  3. Make the script executable

    OMD[mysite]~$:chmod +x ~/local/share/check_mk/agents/special/<script>.py

    .

  4. Append the following line to the end of the script using Vim.

    OMD[mysite]~$: vim ~/local/share/check_mk/agents/special/<script>.py
    if __name__ == "__main__":
    main()

    For more information, study this python article.