Note
This plugin is part of the t_systems_mms.icinga_director collection (version 1.13.0).
To install it use: ansible-galaxy collection install t_systems_mms.icinga_director.
To use it in a playbook, specify: t_systems_mms.icinga_director.icinga_command.
New in version 1.0.0: of t_systems_mms.icinga_director
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| arguments dictionary | Arguments of the command. | |
| client_cert path | 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, client_key is not required. | |
| client_key path | PEM formatted file that contains your private key to be used for SSL client authentication. If client_cert contains both the certificate and key, this option is not required. | |
| command string | The command Icinga should run. Required when state is present.Absolute paths are accepted as provided, relative paths are prefixed with "PluginDir + ", similar Constant prefixes are allowed. Spaces will lead to separation of command path and standalone arguments. Please note that this means that we do not support spaces in plugin names and paths right now. | |
| command_type string |
| Plugin Check commands are what you need when running checks against your infrastructure. Notification commands will be used when it comes to notify your users. Event commands allow you to trigger specific actions when problems occur. Some people use them for auto-healing mechanisms, like restarting services or rebooting systems at specific thresholds. |
| disabled boolean |
| Disabled objects will not be deployed. |
| force boolean |
| If yes do not get a cached copy.Alias thirsty has been deprecated and will be removed in 2.13.aliases: thirsty |
| force_basic_auth boolean |
| Credentials specified with url_username and url_password should be passed in HTTP Header. |
| http_agent string | Default: "ansible-httpget" | Header to identify as, generally appears in web server logs. |
| imports list / elements=string | Importable templates, add as many as you want. Please note that order matters when importing properties from multiple templates - last one wins. | |
| object_name string / required | Name of the command. aliases: name | |
| state string |
| Apply feature state. |
| timeout string | Optional command timeout. Allowed values are seconds or durations postfixed with a specific unit (for example 1m or also 3m 30s). | |
| url string / required | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path | |
| url_password string | The password for use in HTTP basic authentication. If the url_username parameter is not specified, the url_password parameter will not be used. | |
| url_username string | The username for use in HTTP basic authentication. This parameter can be used without url_password for sites that allow empty passwords | |
| use_gssapi boolean added in 2.11 of ansible.builtin |
| 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 url_username/url_password or with the GSSAPI env var KRB5CCNAME that specified a custom Kerberos credential cache.NTLM authentication is not supported even if the GSSAPI mech for NTLM has been installed. |
| use_proxy boolean |
| If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| validate_certs boolean |
| If no, SSL certificates will not be validated.This should only be used on personally controlled sites using self-signed certificates. |
| vars dictionary | Custom properties of the command. | |
| zone string | Icinga cluster zone. Allows to manually override Directors decisions of where to deploy your config to. You should consider not doing so unless you gained deep understanding of how an Icinga Cluster stack works. |
Note
- name: Create command
t_systems_mms.icinga_director.icinga_command:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
arguments:
'--authpassphrase':
value: $snmpv3_priv_key$
'--authprotocol':
value: $snmpv3_auth_protocol$
'--critical':
value: $centreon_critical$
'--filter':
value: $centreon_filter$
'--hostname':
value: $snmp_address$
'--maxrepetitions':
value: $centreon_maxrepetitions$
'--mode':
value: $centreon_mode$
'--plugin':
value: $centreon_plugin$
'--privpassphrase':
value: $snmpv3_auth_key$
'--privprotocol':
value: $snmpv3_priv_protocol$
'--snmp-community':
value: $snmp_community$
'--snmp-timeout':
value: $snmp_timeout$
'--snmp-username':
value: $snmpv3_user$
'--snmp-version':
value: $snmp_version$
'--subsetleef':
value: $centreon_subsetleef$
'--verbose':
set_if: $centreon_verbose$
'--warning':
value: $centreon_warning$
command: "/opt/centreon-plugins/centreon_plugins.pl"
command_type: "PluginCheck"
disabled: false
object_name: centreon-plugins
imports:
- centreon-plugins-template
timeout: "1m"
vars:
centreon_maxrepetitions: 20
centreon_subsetleef: 20
centreon_verbose: false
snmp_address: $address$
snmp_timeout: 60
snmp_version: '2'
snmpv3_auth_key: authkey
snmpv3_priv_key: privkey
snmpv3_user: user
- name: Create command
t_systems_mms.icinga_director.icinga_command:
state: present
url: "{{ icinga_url }}"
url_username: "{{ icinga_user }}"
url_password: "{{ icinga_pass }}"
command: "/opt/centreon-plugins/centreon_plugins_2.pl"
object_name: centreon-plugins_2
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/t_systems_mms/icinga_director/icinga_command_module.html