Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Next »

For the purpose of registering agents, both for agent updates and for TLS encryption, it might be desirable to have a dedicated user and role at hand.
This article outlines, how that can be achieved.

The UI way

The easiest way to build an agent registration role is using the GUI and following these steps:

  1. Create a copy of the guest role and name it meaningfully.
  2. Ensure the role has the following permissions:
    1. "Use the GUI at all"
    2. "Register Host & download monitoring agents of your hosts",
    3. "Register all hosts & download all monitoring agents"
  3. Optionally you can disable all other permissions.
  4. Create a user with a meaningful name
    1. Configure the following things:
      1. Authentication: Automation Secret
      2. Assign the agent registration role created before

The config file way

We always recommend using the GUI instead of modifying .mk files. For any issue or broken config we do not provide any support.

On exceptional circumstances you might want to adjust configuration files with caution. Please do a backup before adjusting the files.

  1. Pretty print the configuration for a better overview: Pretty-print the configuration files

  2. Add the following section to the config file: ~/etc/check_mk/multisite.d/wato/roles.mk.

    'agent': {'alias': 'agents registration and download',
          'basedon': None,
          'builtin': True,
          'permissions': {'general.see_all': True,
                          'general.use': True,
                          'wato.download_all_agents': True}}

    In order to put it to the right place, please add a comma "," before the "})". 

    At the end the whole file should look like this:

    # Written by Checkmk store

roles.update({
 'admin': {'alias': 'Administrator',
           'builtin': True,
           'permissions': {}},
 'guest': {'alias': 'Guest user',
           'builtin': True,
           'permissions': {}},
 'user': {'alias': 'Normal monitoring user',
          'builtin': True,
          'permissions': {}},
 'agent_updater': {'alias': 'agents registration and download',
                   'basedon': None,
                   'builtin': True,
                   'permissions': {'general.see_all': True,
                                   'general.use': True,
                                   'wato.download_all_agents': True}},  
 'agent_ctl': {'alias': 'Agent Controller', 
               'basedon': None, 
               'builtin': True, 
               'permissions': {'general.agent_pairing': True,
                               'general.use': True,
                               'wato.edit_hosts': True}}
})
~

Agent Pairing for TLS Encryption

For a user to be able to do the cmk-agent-ctl register, which is needed to enable the TLS encryption (available from 2.1.0 onwards), you have to add the following rights (internal name "general.agent_pairing") to his/her role.

  • Agent pairing
  • Read access to all hosts and folders
  • Write access to all hosts and folders

  • No labels