community.mongodb.mongodb_parameter 模块 – 更改 MongoDB 服务器上的管理参数

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.mongodb。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

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

community.mongodb 1.0.0 中的新增功能

概要 

更改 MongoDB 服务器上的管理参数。

要求 

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

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 时，此参数为必填项。
param 字符串 / 必填	要修改的 MongoDB 管理参数。
param_type 字符串	定义参数值的类型。选项 `"int"` `"str"` ← (默认)
replica_set 字符串	要连接到的副本集（自动连接到主节点进行写入）。
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 字符串	解密加密私钥的密码。
strict_compatibility 布尔值	强制执行 pymongo 和 MongoDB 软件版本的严格要求选项 `false` `true` ← (默认)
value 字符串 / 必填	要设置的 MongoDB 管理参数值。

备注 

注意

远程主机上需要 pymongo Python 包，版本 4+。
可以使用 pip 或操作系统包管理器安装它。
另见 https://mongodb.ac.cn/docs/languages/python/pymongo-driver/current/get-started/download-and-install/

示例 

- name: Set MongoDB syncdelay to 60 (this is an int)
  community.mongodb.mongodb_parameter:
    param: syncdelay
    value: 60
    param_type: int

返回值 

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

键	描述
after 字符串	修改后的值返回：成功
之前字符串	修改前的值返回：成功

作者

Loic Blot (@nerzhul)