community.mongodb.mongodb cache – Use MongoDB for caching
Note
This cache plugin is part of the community.mongodb collection (version 1.7.12).
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. You need further requirements to be able to use this cache plugin, see Requirements for details.
To use it in a playbook, specify: community.mongodb.mongodb.
New in community.mongodb 1.0.0
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 | Comments |
|---|---|
_prefix string | User defined prefix to use when creating the DB entries Default: Configuration:
|
_timeout integer | Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire Default: Configuration:
|
_uri string | MongoDB Connection String URI Configuration:
|
Note
Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. The entry types are also ordered by precedence from low to high priority order. For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/mongodb/mongodb_cache.html
