ansible.builtin.mongodb_parameter (v2.5.11) — module

Change an administrative parameter on a MongoDB server.

| "added in version" 2.1 of ansible.builtin"

Authors: Loic Blot (@nerzhul)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.5.11

Description

Change an administrative parameter on a MongoDB server.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Set MongoDB syncdelay to 60 (this is an int)
- mongodb_parameter:
    param: syncdelay
    value: 60
    param_type: int

Inputs

    
ssl:
    default: false
    description:
    - Whether to use an SSL connection when connecting to the database
    required: false

param:
    description:
    - MongoDB administrative parameter to modify
    required: true

value:
    description:
    - MongoDB administrative parameter value to set
    required: true

database:
    description:
    - The name of the database to add/remove the user from
    required: true

login_host:
    default: localhost
    description:
    - The host running the database
    required: false

login_port:
    default: 27017
    description:
    - The port to connect to
    required: false

login_user:
    default: null
    description:
    - The username used to authenticate with
    required: false

param_type:
    default: str
    description:
    - Define the parameter value (str, int)
    required: false

replica_set:
    default: null
    description:
    - Replica set to connect to (automatically connects to primary for writes)
    required: false

login_database:
    default: null
    description:
    - The database where login credentials are stored
    required: false

login_password:
    default: null
    description:
    - The password used to authenticate with
    required: false

Outputs

after:
  description: value after modification
  returned: success
  type: string
before:
  description: value before modification
  returned: success
  type: string