telekom_mms.icinga_director.icinga_user module – Manage users in Icinga2
Note
This module is part of the telekom_mms.icinga_director collection (version 2.1.2).
You might already have this collection installed if you are using the ansible
package.
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 telekom_mms.icinga_director
.
To use it in a playbook, specify: telekom_mms.icinga_director.icinga_user
.
New in telekom_mms.icinga_director 1.0.0
Synopsis
Add or remove a user to Icinga2 through the director API.
Parameters
Parameter |
Comments |
---|---|
Do not overwrite the whole object but instead append the defined properties. Note - Appending to existing vars, imports or any other list/dict is not possible. You have to overwrite the complete list/dict. Note - Variables that are set by default will also be applied, even if not set. Choices:
|
|
PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, |
|
PEM formatted file that contains your private key to be used for SSL client authentication. If |
|
Disabled objects will not be deployed. Choices:
|
|
Alternative name for this user. In case your object name is a username, this could be the full name of the corresponding person. |
|
The Email address of the user. |
|
If Choices:
|
|
Credentials specified with Choices:
|
|
User groups that should be directly assigned to this user. Groups can be useful for various reasons. You might prefer to send notifications to groups instead of single users. |
|
Header to identify as, generally appears in web server logs. Default: |
|
Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. |
|
Name of the user. |
|
The pager address of the user. |
|
The name of a time period which determines when notifications to this User should be triggered. Not set by default. |
|
Apply feature state. Choices:
|
|
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
|
The password for use in HTTP basic authentication. If the |
|
The username for use in HTTP basic authentication. This parameter can be used without |
|
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library gssapi to be installed. Credentials for GSSAPI can be specified with NTLM authentication is not supported even if the GSSAPI mech for NTLM has been installed. Choices:
|
|
If Choices:
|
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
Notes
Note
This module supports check mode.
Examples
- name: Create user
telekom_mms.icinga_director.icinga_user:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "rb"
pager: 'SIP/emergency'
period: '24/7'
email: "[email protected]"
imports:
- foousertemplate
groups:
- onCall
- name: Update user
telekom_mms.icinga_director.icinga_user:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
object_name: "rb"
display_name: "Rufbereitschaft"
append: true