activemq_facts – Return activemq configuration as fact data

Note

This module is part of the middleware_automation.amq collection.

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 middleware_automation.amq. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: middleware_automation.amq.activemq_facts.

New in middleware_automation.amq 2.1.0

Synopsis

  • Return artemis activemq configuration and runtime information from the jolokia endpoint as fact data.

Requirements

The below requirements are needed on the host that executes this module.

  • A running instance of activemq with the jolokia port open

Parameters

Parameter

Comments

auth_password

aliases: password

string / required

Password to authenticate for API access with.

auth_username

aliases: username

string / required

Username to authenticate for API access with.

base_url

aliases: url

string

URL to the activemq instance.

Default: "http://localhost:8161"

broker_name

aliases: broker

string

Name of the broker instance

Default: "amq-broker"

connection_timeout

integer

Controls the HTTP connections timeout period in seconds to jolokia API.

Default: 10

validate_certs

boolean

Verify TLS certificates when using https.

Choices:

  • false

  • true ← (default)

web_origin

string

The value to use in the Origin header for the http request

Default: "http://0.0.0.0"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

facts

Support: full

Action returns an ansible_facts dictionary that will update existing host facts

platform

Platforms: all

Target OS/families that can be operated against

Examples

- name: Populate activemq facts
  middleware_automation.amq.activemq_facts:

- name: Print activemq service facts
  ansible.builtin.debug:
    var: ansible_facts.activemq

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key

Description

activemq

dictionary

The factual representation of an activemq instance configuration.

Returned: always

Authors

  • Guido Grazioli (@guidograzioli)