telekom_mms.icinga_director.icinga_job module – Manage director jobs 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_job.

New in telekom_mms.icinga_director 2.0.0

Synopsis

  • Add or remove a director job in Icinga2 Director through the director API.

  • Director jobs allow scheduling automatic import and sync runs as well as other recurring tasks.

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

disabled

boolean

Whether this job is disabled and should not be run automatically.

Choices:

  • false ← (default)

  • true

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"

job_class

string

The fully-qualified PHP class name of the job implementation.

Examples are Icinga\Module\Director\Job\ImportRunJob to run an import source or Icinga\Module\Director\Job\SyncRunJob to run a sync rule.

Required when creating a new job.

job_name

aliases: name

string / required

Name of the director job.

This must be unique across all jobs in Icinga Director.

run_interval

integer

How often the job should run, in seconds.

Required when creating a new job.

settings

dictionary

A dict of job-class-specific settings stored as key-value pairs in the Director director_job_setting table.

For Icinga\Module\Director\Job\ImportJob use source_name to reference the import source by name and run_import set to "y" to actually run the import (default "n" only checks for changes).

For Icinga\Module\Director\Job\SyncJob use rule_name to reference the sync rule by name and apply_changes set to "y" to actually apply changes (default "n" only checks).

state

string

Apply feature state.

Choices:

  • "present" ← (default)

  • "absent"

timeperiod

string

The name of a time period which restricts when this job may run.

If not set the job may run at any time.

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.

  • Uses the standard /director/jobs bulk endpoint (GET/POST/DELETE). Requires Director with upstream PR adding POST and DELETE support to JobsController and unserializeJobs in ImportExport.

Examples

- name: Create a director job to run an import source
  telekom_mms.icinga_director.icinga_job:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    job_name: "Run CMDB Import"
    job_class: "Icinga\\Module\\Director\\Job\\ImportRunJob"
    run_interval: 3600
    disabled: false

- name: Create a director job to run a sync rule during business hours
  telekom_mms.icinga_director.icinga_job:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    job_name: "Run Host Sync"
    job_class: "Icinga\\Module\\Director\\Job\\SyncRunJob"
    run_interval: 900
    timeperiod: "business-hours"

- name: Disable a director job
  telekom_mms.icinga_director.icinga_job:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    job_name: "Run CMDB Import"
    disabled: true
    append: true

- name: Delete a director job
  telekom_mms.icinga_director.icinga_job:
    state: absent
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    job_name: "Run CMDB Import"

Authors

  • Michaela Mattes (@mikaEz)