community.mongodb.mongodb_maintenance 模块 – 启用或禁用辅助成员的维护模式。

注意

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

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

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

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

community.mongodb 1.0.0 中的新增功能

概要

  • 启用或禁用辅助成员的维护模式。

  • 围绕 replSetMaintenance 命令的包装器。

  • 对 PRIMARY 成员不执行任何操作。

  • 启用后，SECONDARY 成员将不会服务读取操作。

需求

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

  • 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 时，这是必需的。

maintenance

布尔值

启用或禁用维护模式。

选项

  • false ← (默认)

  • true

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 ← (默认)

备注

注意

示例

- name: Enable maintenance mode
  community.mongodb.mongodb_maintenance:
    maintenance: true

- name: Disable maintenance mode
  community.mongodb.mongodb_maintenance:
    maintenance: false

返回值

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

键

描述

changed

布尔值

成员是否被置于维护模式。

返回： success

failed

布尔值

如果出现错误

返回： failed

msg

字符串

简短描述发生了什么。

返回： success

作者

  • Rhys Campbell (@rhysmeister)