community.mongodb.mongodb_parameter – Change an administrative parameter on a MongoDB server
Note
This plugin is part of the community.mongodb collection (version 1.1.1).
To install it use: ansible-galaxy collection install community.mongodb.
To use it in a playbook, specify: community.mongodb.mongodb_parameter.
New in version 1.0.0: of community.mongodb
Synopsis
- Change an administrative parameter on a MongoDB server.
Requirements
The below requirements are needed on the host that executes this module.
- pymongo
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| auth_mechanism
string
|
|
Authentication type.
|
| connection_options
list / elements=raw
|
Additional connection options.
Supply as a list of dicts or strings containing key value pairs seperated with '='.
|
|
| login_database
string
|
Default:
"admin"
|
The database where login credentials are stored.
|
| login_host
string
|
Default:
"localhost"
|
The host running MongoDB instance to login to.
|
| login_password
string
|
The password used to authenticate with.
Required when login_user is specified.
|
|
| login_port
integer
|
Default:
27017
|
The MongoDB server port to login to.
|
| login_user
string
|
The MongoDB user to login with.
Required when login_password is specified.
|
|
| param
string / required
|
MongoDB administrative parameter to modify.
|
|
| param_type
string
|
|
Define the type of parameter value.
|
| replica_set
string
|
Replica set to connect to (automatically connects to primary for writes).
|
|
| ssl
boolean
|
|
Whether to use an SSL connection when connecting to the database.
|
| ssl_ca_certs
string
|
The ssl_ca_certs option takes a path to a CA file.
|
|
| ssl_cert_reqs
string
|
|
Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided.
|
| ssl_certfile
string
|
Present a client certificate using the ssl_certfile option.
|
|
| ssl_crlfile
string
|
The ssl_crlfile option takes a path to a CRL file.
|
|
| ssl_keyfile
string
|
Private key for the client certificate.
|
|
| ssl_pem_passphrase
string
|
Passphrase to decrypt encrypted private keys.
|
|
| value
string / required
|
MongoDB administrative parameter value to set.
|
Notes
Note
- 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 also http://api.mongodb.org/python/current/installation.html
Examples
- name: Set MongoDB syncdelay to 60 (this is an int)
community.mongodb.mongodb_parameter:
param: syncdelay
value: 60
param_type: int
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| after
string
|
success |
value after modification
|
| before
string
|
success |
value before modification
|
Authors
- Loic Blot (@nerzhul)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/mongodb/mongodb_parameter_module.html