community.mongodb.mongodb_stepdown – Step down the MongoDB node from a PRIMARY state.
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
It is not included in
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:
New in version 1.0.0: of community.mongodb
Step down the MongoDB node from the PRIMARY state if it has that status. Returns OK immediately if the member is already in the SECONDARY or ARBITER states. Will wait until a timeout for the member state to reach SECONDARY or PRIMARY, if the member state is currently STARTUP, RECOVERING, STARTUP2 or ROLLBACK, before taking any needed action.
Requires the pymongo Python package on the remote host, version 2.4.2+. This can be installed using pip or the OS package manager. @see http://api.mongodb.org/python/current/installation.html
- name: Step down the current MongoDB member community.mongodb.mongodb_stepdown: login_user: admin login_password: secret - name: Step down the current MongoDB member, poll a maximum of 5 times if member state is recovering community.mongodb.mongodb_stepdown: login_user: admin login_password: secret poll: 5 interval: 10
Common return values are documented here, the following are the fields unique to this module:
If the module had failed or not.
Number of times the module has queried the replicaset status.