community.mongodb.mongodb – Use MongoDB for caching

Note

This plugin is part of the community.mongodb collection (version 1.3.2).

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

To use it in a playbook, specify: community.mongodb.mongodb.

New in version 1.0.0: of community.mongodb

Synopsis

  • This cache uses per host records saved in MongoDB.

Requirements

The below requirements are needed on the local controller node that executes this cache.

  • pymongo>=3

Parameters

Parameter Choices/Defaults Configuration Comments
_prefix
string
Default:
"ansible_facts"
ini entries:

[defaults]
fact_caching_prefix = ansible_facts

env:ANSIBLE_CACHE_PLUGIN_PREFIX
User defined prefix to use when creating the DB entries
_timeout
integer
Default:
86400
ini entries:

[defaults]
fact_caching_timeout = 86400

env:ANSIBLE_CACHE_PLUGIN_TIMEOUT
Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
_uri
string
ini entries:

[defaults]
fact_caching_connection = None

env:ANSIBLE_CACHE_PLUGIN_CONNECTION
MongoDB Connection String URI

Authors

  • Matt Martz