Skip to content

agent_role.rst

Latest commit

 

History

History
1448 lines (682 loc) · 30.2 KB

agent_role.rst

File metadata and controls

1448 lines (682 loc) · 30.2 KB
Raw
orphan:

checkmk.general.agent role -- Install Checkmk agents

Note

This role is part of the checkmk.general collection (version 7.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible\-galaxy collection install checkmk.general.

To use it in a playbook, specify: checkmk.general.agent.

Entry point main -- Install Checkmk agents

Synopsis

  • This role installs Checkmk agents.

Parameters

.. tabularcolumns:: \X{1}{3}\X{2}{3}
Parameter Comments 
.. rst-class:: ansible-option-title

checkmk_agent_add_host

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_auto_activate

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_configure_firewall

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_configure_firewall_zone

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"public"`

 
.. rst-class:: ansible-option-title

checkmk_agent_delegate_api_calls

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"localhost"`

 
.. rst-class:: ansible-option-title

checkmk_agent_delegate_download

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"{{ inventory\_hostname }}"`

 
.. rst-class:: ansible-option-title

checkmk_agent_discover

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_discover_max_parallel_tasks

.. ansible-option-type-line::

  :ansible-option-type:`integer`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`0`

 
.. rst-class:: ansible-option-title

checkmk_agent_edition

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"community"`

 
.. rst-class:: ansible-option-title

checkmk_agent_folder

.. ansible-option-type-line::

  :ansible-option-type:`string`





.. rst-class:: ansible-option-title

checkmk_agent_force_foreign_changes

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_force_install

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_host_attributes

.. ansible-option-type-line::

  :ansible-option-type:`dictionary`





.. rst-class:: ansible-option-title

checkmk_agent_host_name

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"{{ inventory\_hostname }}"`

 
.. rst-class:: ansible-option-title

checkmk_agent_mode

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"pull"`

 
.. rst-class:: ansible-option-title

checkmk_agent_no_log

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_pass

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details. This is mutually exclusive with 'checkmk_agent_secret'.

 
.. rst-class:: ansible-option-title

checkmk_agent_port

.. ansible-option-type-line::

  :ansible-option-type:`integer`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`6556`

 
.. rst-class:: ansible-option-title

checkmk_agent_prep_legacy

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_registration_server

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"localhost"`

 
.. rst-class:: ansible-option-title

checkmk_agent_registration_server_protocol

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"http"`

 
.. rst-class:: ansible-option-title

checkmk_agent_registration_site

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"mysite"`

 
.. rst-class:: ansible-option-title

checkmk_agent_secret

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details. This is mutually exclusive with 'checkmk_agent_pass'.

 
.. rst-class:: ansible-option-title

checkmk_agent_server

.. ansible-option-type-line::

  :ansible-option-type:`string` / :ansible-option-required:`required`

Refer to the README for details.

 
.. rst-class:: ansible-option-title

checkmk_agent_server_port

.. ansible-option-type-line::

  :ansible-option-type:`string`





.. rst-class:: ansible-option-title

checkmk_agent_server_protocol

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"http"`

 
.. rst-class:: ansible-option-title

checkmk_agent_server_validate_certs

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_site

.. ansible-option-type-line::

  :ansible-option-type:`string` / :ansible-option-required:`required`

Refer to the README for details.

 
.. rst-class:: ansible-option-title

checkmk_agent_tls

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_update

.. ansible-option-type-line::

  :ansible-option-type:`boolean`





.. rst-class:: ansible-option-title

checkmk_agent_user

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"automation"`

 
.. rst-class:: ansible-option-title

checkmk_agent_version

.. ansible-option-type-line::

  :ansible-option-type:`string`

Refer to the README for details.

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"2.5.0p3"`

Authors

  • Robin Gierse
Collection links
.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/Checkmk/ansible-collection-checkmk.general/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/Checkmk/ansible-collection-checkmk.general"
    external: true