community.mongodb.mongodb_info 模块 – 收集有关 MongoDB 实例的信息。

注意

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

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

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

要在剧本中使用它，请指定：community.mongodb.mongodb_info。

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

列表 / 元素=任意

其他连接选项。

以字典或字符串列表的形式提供，键值对用 ‘=’ 分隔。

filter

列表 / 元素=字符串

通过逗号分隔的字符串或 YAML 列表限制收集的信息。

允许的值为 general、databases、total_size、parameters、users、roles。

默认情况下，收集所有子集。

您可以在值前使用 ‘!’（例如，!users）将其从信息中排除。

如果您向过滤器传递包含和排除的值，例如，_filter=!general,users_，则将忽略排除的值，在本例中为 !general。

login_database

字符串

存储登录凭据的数据库。

默认值： "admin"

login_host

字符串

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

默认值： "localhost"

login_password

字符串

用于身份验证的密码。

当指定 _login_user_ 时需要。

login_port

整数

要登录的 MongoDB 服务器端口。

默认值： 27017

login_user

字符串

要登录的 MongoDB 用户。

当指定 _login_password_ 时需要。

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

注释

注意

  • 远程主机上需要 pymongo Python 包，版本 4+。

示例

- name: Gather all supported information
  community.mongodb.mongodb_info:
    login_user: admin
    login_password: secret
  register: result

- name: Show gathered info
  debug:
    msg: '{{ result }}'

- name: Gather only information about databases and their total size
  community.mongodb.mongodb_info:
    login_user: admin
    login_password: secret
    filter: databases, total_size

- name: Gather all information except parameters
  community.mongodb.mongodb_info:
    login_user: admin
    login_password: secret
    filter: '!parameters'

返回值

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

键

描述

数据库

字典

数据库信息。

返回： 始终

示例： {"admin": {"empty": false, "sizeOnDisk": 245760}, "config": {"empty": false, "sizeOnDisk": 110592}}

常规

字典

常规实例信息。

返回： 始终

示例： {"allocator": "tcmalloc", "bits": 64, "maxBsonObjectSize": 16777216, "storageEngines": ["biggie"], "version": "4.2.3"}

参数

字典

服务器参数信息。

返回： 始终

示例： {"maxOplogTruncationPointsAfterStartup": 100, "maxOplogTruncationPointsDuringStartup": 100, "maxSessions": 1000000}

角色

字典

角色信息。

返回： 始终

示例： {"db": {"restore": {"inheritedRoles": [], "isBuiltin": true, "roles": []}}}

总大小

整数

所有数据库的总大小（以字节为单位）。

返回： 始终

示例： 397312

用户

字典

用户信息。

返回： 始终

示例： {"db": {"new_user": {"_id": "config.new_user", "mechanisms": ["SCRAM-SHA-1", "SCRAM-SHA-256"], "roles": []}}}

作者

  • Andrew Klychkov (@Andersson007)