How-to get a local copy of a special agent

Owned by Anastasios Thomaidis
Last updated: Dec 11, 2023 by Matthew Hierholzer
1 min read
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.1.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/

    .

  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()

    https://realpython.com/python-main-function/#use-if-__name__-__main__-to-control-the-execution-of-your-code