community.general.a_module test – Test whether a given string refers to an existing module or action plugin
Note
This test plugin is part of the community.general collection (version 10.1.0).
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 community.general
.
To use it in a playbook, specify: community.general.a_module
.
New in community.general 4.0.0
Synopsis
Test whether a given string refers to an existing module or action plugin.
This can be useful in roles, which can use this to ensure that required modules are present ahead of time.
Input
This describes the input of the test, the value before is community.general.a_module
or is not community.general.a_module
.
Parameter |
Comments |
---|---|
A string denoting a fully qualified collection name (FQCN) of a module or action plugin. |
Examples
- name: Make sure that community.aws.route53 is available
ansible.builtin.assert:
that:
- >
'community.aws.route53' is community.general.a_module
- name: Make sure that community.general.does_not_exist is not a module or action plugin
ansible.builtin.assert:
that:
- "'community.general.does_not_exist' is not community.general.a_module"
Return Value
Key |
Description |
---|---|
Whether the module or action plugin denoted by the input exists. Returned: success |