community.mongodb.mongodb_shard_zone 模块 – 管理分片区域。

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.mongodb。 您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

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

community.mongodb 1.3.0 中的新增功能

概要

  • 管理分片区域。

  • 添加和删除分片区域。

要求

在执行此模块的主机上需要以下要求。

  • pymongo

参数

参数

注释

atlas_auth

布尔值

用于 MongoDB Atlas 实例的身份验证路径

选择

  • false ← (默认)

  • true

auth_mechanism

字符串

身份验证类型。

选择

  • "SCRAM-SHA-256"

  • "SCRAM-SHA-1"

  • "MONGODB-X509"

  • "GSSAPI"

  • "PLAIN"

connection_options

列表 / 元素=任意

其他连接选项。

以字典列表或包含键值对（用“=”分隔）的字符串的形式提供。

login_database

字符串

存储登录凭据的数据库。

默认值: "admin"

login_host

字符串

运行要登录的 MongoDB 实例的主机。

默认值: "localhost"

login_password

字符串

用于身份验证的密码。

当指定 login_user 时为必需。

login_port

整数

要登录的 MongoDB 服务器端口。

默认值: 27017

login_user

字符串

用于登录的 MongoDB 用户。

当指定 login_password 时为必需。

mongos_process

字符串

为 mongos 进程提供自定义名称。

大多数用户可以忽略此设置。

默认值: "mongos"

name

字符串 / 必需

区域的名称。

namespace

字符串

区域分配到的命名空间

应以 database.collection 的形式给出。

ranges

列表 / 元素=列表

分配给区域的范围。

ssl

别名: tls

布尔值

连接到数据库时是否使用 SSL 连接。

选择

  • false ← (默认)

  • true

ssl_ca_certs

别名: tlsCAFile

字符串

ssl_ca_certs 选项采用 CA 文件的路径。

ssl_cert_reqs

别名: tlsAllowInvalidCertificates

字符串

指定是否需要来自连接另一端的证书，以及在提供证书时是否会对其进行验证。

选择

  • "CERT_NONE"

  • "CERT_OPTIONAL"

  • "CERT_REQUIRED" ← (默认)

ssl_certfile

别名: tlsCertificateKeyFile

字符串

使用 ssl_certfile 选项提供客户端证书。

ssl_crlfile

字符串

ssl_crlfile 选项采用 CRL 文件的路径。

ssl_keyfile

字符串

客户端证书的私钥。

ssl_pem_passphrase

别名: tlsCertificateKeyFilePassword

字符串

用于解密加密私钥的密码。

state

字符串

区域的状态。

选择

  • "present" ← (默认)

  • "absent"

strict_compatibility

布尔值

对 pymongo 和 MongoDB 软件版本强制执行严格的要求

选择

  • false

  • true ← (默认)

备注

注意

示例

- name: Add a shard zone for NYC
  community.mongodb.mongodb_shard_zone:
    name: "NYC"
    namespace: "records.users"
    ranges:
      - [{ zipcode: "10001" }, { zipcode: "10281" }]
      - [{ zipcode: "11201" }, { zipcode: "11240" }]
    state: "present"

- name: Remove all zone ranges
  community.mongodb.mongodb_shard_zone:
    name: "NYC"
    namespace: "records.users"
    state: "absent"

- name: Remove a specific zone range
  community.mongodb.mongodb_shard_zone:
    name: "NYC"
    namespace: "records.users"
    ranges:
      - [{ zipcode: "11201" }, { zipcode: "11240" }]
    state: "absent"

返回值

常见的返回值已在此处记录 此处，以下是此模块独有的字段

键

描述

changed

布尔值

发生更改时为 True

返回: 成功

failed

布尔值

如果发生错误

返回: 失败

msg

字符串

对发生的事情的简短描述。

返回: 失败

作者

  • Rhys Campbell (@rhysmeister)