community.mongodb.mongodb_atlas_whitelist module – Manage IP whitelists in Atlas
Note
This module is part of the community.mongodb collection (version 1.7.8).
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
.
To use it in a playbook, specify: community.mongodb.mongodb_atlas_whitelist
.
Synopsis
The mongodb_atlas_whitelist module manages a Atlas project’s IP whitelist.
Parameters
Parameter |
Comments |
---|---|
The password for use in authentication with the Atlas API. Can use API users and tokens (private key is password) |
|
The username for use in authentication with the Atlas API. Can use API users and tokens (public key is username) |
|
Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. |
|
Optional Comment associated with the whitelist entry. Default: |
|
Unique identifier for the Atlas project. |
|
State of the ressource. Choices:
|
Examples
- name: test whitelist
community.mongodb.mongodb_atlas_whitelist:
api_username: "API_user"
api_password: "API_passwort_or_token"
group_id: "GROUP_ID"
cidr_block: "192.168.0.0/24"
comment: "test"