community / community.mongodb / 1.6.1 / module / mongodb_stepdown Step down the MongoDB node from a PRIMARY state. | "added in version" 1.0.0 of community.mongodb" Authors: Rhys Campbell (@rhysmeister)community.mongodb.mongodb_stepdown (1.6.1) — module
Install with ansible-galaxy collection install community.mongodb:==1.6.1
collections: - name: community.mongodb version: 1.6.1
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.
- 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
ssl: aliases: - tls default: false description: - Whether to use an SSL connection when connecting to the database. required: false type: bool poll: default: 1 description: - The maximum number of times query for the member status. type: int force: default: false description: - Optional. A boolean that determines whether the primary steps down if no electable and up-to-date secondary exists within the wait period. type: bool interval: default: 30 description: - The number of seconds to wait between poll executions. type: int atlas_auth: default: false description: - Authentication path intended for MongoDB Atlas Instances type: bool login_host: default: localhost description: - The host running MongoDB instance to login to. required: false type: str login_port: default: 27017 description: - The MongoDB server port to login to. required: false type: int login_user: description: - The MongoDB user to login with. - Required when I(login_password) is specified. required: false type: str ssl_crlfile: description: - The ssl_crlfile option takes a path to a CRL file. required: false type: str ssl_keyfile: description: - Private key for the client certificate. required: false type: str ssl_ca_certs: aliases: - tlsCAFile description: - The ssl_ca_certs option takes a path to a CA file. required: false type: str ssl_certfile: aliases: - tlsCertificateKeyFile description: - Present a client certificate using the ssl_certfile option. required: false type: str ssl_cert_reqs: aliases: - tlsAllowInvalidCertificates choices: - CERT_NONE - CERT_OPTIONAL - CERT_REQUIRED default: CERT_REQUIRED description: - Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. required: false type: str auth_mechanism: choices: - SCRAM-SHA-256 - SCRAM-SHA-1 - MONGODB-X509 - GSSAPI - PLAIN description: - Authentication type. required: false type: str login_database: default: admin description: - The database where login credentials are stored. required: false type: str login_password: description: - The password used to authenticate with. - Required when I(login_user) is specified. required: false type: str stepdown_seconds: default: 60 description: - The number of seconds to step down the primary, during which time the stepdown member is ineligible for becoming primary. type: int connection_options: description: - Additional connection options. - Supply as a list of dicts or strings containing key value pairs seperated with '='. elements: raw required: false type: list secondary_catch_up: default: 10 description: - The secondaryCatchUpPeriodSecs parameter for the stepDown command. - The number of seconds that mongod will wait for an electable secondary to catch up to the primary. type: int ssl_pem_passphrase: aliases: - tlsCertificateKeyFilePassword description: - Passphrase to decrypt encrypted private keys. required: false type: str strict_compatibility: default: true description: - Enforce strict requirements for pymongo and MongoDB software versions type: bool
failed: description: If the module had failed or not. returned: always type: bool iteration: description: Number of times the module has queried the replicaset status. returned: always type: int msg: description: Status message. returned: always type: str