telekom_mms.icinga_director.icinga_deploy_info (2.1.0) — module

Install collection

Install with ansible-galaxy collection install telekom_mms.icinga_director:==2.1.0

Add to requirements.yml

  collections:
    - name: telekom_mms.icinga_director
      version: 2.1.0

Description

Get deployment information through the director API.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Query the current deployment info in icinga
  telekom_mms.icinga_director.icinga_deploy_info:
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"

Inputs

    
url:
    description:
    - HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
    required: true
    type: str

force:
    default: false
    description:
    - If V(yes) do not get a cached copy.
    type: bool

configs:
    description:
    - A list of checksums of configs to query information for
    elements: str
    type: list

use_proxy:
    default: true
    description:
    - If V(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

activities:
    description:
    - A list of checksums of activities to query information for
    elements: str
    type: list

client_key:
    description:
    - PEM formatted file that contains your private key to be used for SSL client authentication.
    - If O(client_cert) contains both the certificate and key, this option is not required.
    type: path

http_agent:
    default: ansible-httpget
    description:
    - Header to identify as, generally appears in web server logs.
    type: str

use_gssapi:
    default: false
    description:
    - Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos
      through Negotiate authentication.
    - Requires the Python library L(gssapi,https://github.com/pythongssapi/python-gssapi)
      to be installed.
    - Credentials for GSSAPI can be specified with O(url_username)/O(url_password) or
      with the GSSAPI env var C(KRB5CCNAME) that specified a custom Kerberos credential
      cache.
    - NTLM authentication is B(not) supported even if the GSSAPI mech for NTLM has been
      installed.
    type: bool
    version_added: '2.11'
    version_added_collection: ansible.builtin

client_cert:
    description:
    - 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, O(client_key)
      is not required.
    type: path

url_password:
    description:
    - The password for use in HTTP basic authentication.
    - If the O(url_username) parameter is not specified, the O(url_password) parameter
      will not be used.
    type: str

url_username:
    description:
    - The username for use in HTTP basic authentication.
    - This parameter can be used without O(url_password) for sites that allow empty passwords
    type: str

validate_certs:
    default: true
    description:
    - If V(no), SSL certificates will not be validated.
    - This should only be used on personally controlled sites using self-signed certificates.
    type: bool

force_basic_auth:
    default: false
    description:
    - Credentials specified with O(url_username) and O(url_password) should be passed
      in HTTP Header.
    type: bool

Outputs

active_configuration:
  description:
  - Checksums of the active configuration
  - Contains current activity checksum, config checksum
  - and a checksum for the stage_name
  returned: if active configuration exists
  sample:
    active_configuration:
      activity: 3557598829f2a2fc4acc7b565fb54bae24754c67
      config: 299d9d49e03435c6de562c4b22a26e63990d30a9
      stage_name: 902cb282-e702-43ce-bb3c-962f850a1694
  type: dict
activities:
  description:
  - checksum of the requested activities and its state
  returned: only if requested
  sample:
    activities:
      3557598829f2a2fc4acc7b565fb54bae24754c67: active
      a4c955364bc7b77efd0323fc87d95307f827e30c: deployed
  type: list
configs:
  description:
  - Checksum of the requested config and its state
  returned: only if requested
  sample:
    configs:
      b175ca0562434deeb4fb1fc03fd80cd7361b56de: active
      b175ca0562434deeb4fb1fc03fd80cd7361b56df: deployed
  type: list