telekom_mms.icinga_director.icinga_importsource module – Manage import sources in Icinga2 Director

Note

This module is part of the telekom_mms.icinga_director collection (version 2.6.1).

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_importsource.

New in telekom_mms.icinga_director 2.6.0

Synopsis

  • Add or remove an import source in Icinga2 Director through the director API.

Parameters

Parameter

Comments

api_timeout

integer

Default timeout to wait for transaction to finish in seconds.

Default: 10

append

boolean

added in telekom_mms.icinga_director 2.6.0

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:

  • false

  • true

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.

description

string

An optional description for this import source.

force

boolean

If yes do not get a cached copy.

Choices:

  • false ← (default)

  • true

force_basic_auth

boolean

Credentials specified with url_username and url_password should be passed in HTTP Header.

Choices:

  • false ← (default)

  • true

http_agent

string

Header to identify as, generally appears in web server logs.

Default: "ansible-httpget"

key_column

string

The column name to use as the unique key for imported rows.

This column must be present in every imported row and must be unique.

Required when creating a new import source.

modifiers

list / elements=dictionary

A list of row modifier objects to apply to imported rows.

Each modifier is a dict with keys property_name, target_property, provider_class and settings.

For a regex modifier that extracts an IP address, set provider_class to Icinga\Module\Director\PropertyModifier\PropertyModifierRegexReplace.

provider_class

string

The fully-qualified PHP class name of the import source provider.

Examples are Icinga\Module\Director\Import\RestApiImportSource, Icinga\Module\Director\Import\LdapImportSource or Icinga\Module\Director\Import\DbImportSource.

Required when creating a new import source.

settings

dictionary

A dict of provider-specific settings that are stored as key-value pairs in the Director import_source_setting table.

The available keys depend on the chosen provider_class.

Example for the OTC provider: iam_url, username, password, domain, project, service_type, resource_path.

source_name

aliases: name

string / required

Name of the import source.

This must be unique across all import sources in Icinga Director.

state

string

Apply feature state.

Choices:

  • "present" ← (default)

  • "absent"

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 ansible-core 2.11

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.

Choices:

  • false ← (default)

  • true

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

  • This module supports check mode.

Examples

- name: Create an import source in icinga
  telekom_mms.icinga_director.icinga_importsource:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    source_name: "My Import Source"
    key_column: "hostname"
    provider_class: "Icinga\\Module\\Director\\Import\\RestApiImportSource"
    description: "Import hosts from REST API"

- name: Update the description of an import source
  telekom_mms.icinga_director.icinga_importsource:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    source_name: "My Import Source"
    description: "Updated description"
    append: true

- name: Delete an import source in icinga
  telekom_mms.icinga_director.icinga_importsource:
    state: absent
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    source_name: "My Import Source"

Authors

  • Michaela Mattes (@mikaEz)