community.mongodb.mongodb_atlas_whitelist (1.7.3) — module

Install collection

Install with ansible-galaxy collection install community.mongodb:==1.7.3

Add to requirements.yml

  collections:
    - name: community.mongodb
      version: 1.7.3

Description

The mongodb_atlas_whitelist module manages a Atlas project's IP whitelist.

L(API Documentation,https://docs.atlas.mongodb.com/reference/api/whitelist/)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - 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"

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the ressource.
    type: str

comment:
    default: created by Ansible
    description:
    - Optional Comment associated with the whitelist entry.
    type: str

group_id:
    aliases:
    - groupId
    description:
    - Unique identifier for the Atlas project.
    required: true
    type: str

cidr_block:
    aliases:
    - cidrBlock
    description:
    - Whitelist entry in Classless Inter-Domain Routing (CIDR) notation.
    required: true
    type: str

api_password:
    aliases:
    - apiPassword
    description:
    - The password for use in authentication with the Atlas API.
    - Can use API users and tokens (private key is password)
    required: true
    type: str

api_username:
    aliases:
    - apiUsername
    description:
    - The username for use in authentication with the Atlas API.
    - Can use API users and tokens (public key is username)
    required: true
    type: str