community.mongodb.mongodb_atlas_whitelist 模块 – 在 Atlas 中管理 IP 白名单

注意

此模块是 community.mongodb 集合 (版本 1.7.8) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.mongodb。

要在 playbook 中使用它，请指定：community.mongodb.mongodb_atlas_whitelist。

概要

  • mongodb_atlas_whitelist 模块管理 Atlas 项目的 IP 白名单。

  • API 文档

参数

参数

注释

api_password

别名：apiPassword

字符串 / 必需

用于与 Atlas API 进行身份验证的密码。

可以使用 API 用户和令牌（私钥为密码）

api_username

别名：apiUsername

字符串 / 必需

用于与 Atlas API 进行身份验证的用户名。

可以使用 API 用户和令牌（公钥为用户名）

cidr_block

别名：cidrBlock

字符串 / 必需

以无类别域间路由 (CIDR) 表示法表示的白名单条目。

comment

字符串

与白名单条目关联的可选注释。

默认值： "created by Ansible"

group_id

别名：groupId

字符串 / 必需

Atlas 项目的唯一标识符。

state

字符串

资源的状态。

选项

  • "present" ← (默认)

  • "absent"

示例

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

作者

  • Martin Schurz (@schurzi)