Модуль community.mongodb.mongodb_schema – Управляет валидаторами схем документов MongoDB.

Примечание

Этот модуль входит в коллекцию community.mongodb (версия 1.7.12).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля требуются дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: community.mongodb.mongodb_schema.

Новая версия community.mongodb 1.3.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управляет валидаторами схем документов MongoDB.
Создает, обновляет и удаляет валидаторы коллекции.
Поддерживает весь набор ключевых слов jsonSchema.
Подробности см. в разделе [Доступные ключевые слова jsonSchema](https://docs.mongodb.com/manual/reference/operator/query/jsonSchema/#available-keywords).

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

pymongo

Параметры

Параметр	Комментарии
action string	Действие проверки, которое MongoDB должна выполнять при обработке недопустимых документов. Варианты: `"error"` ← (по умолчанию) `"warn"`
atlas_auth boolean	Способ аутентификации, предназначенный для экземпляров MongoDB Atlas Варианты: `false` ← (по умолчанию) `true`
auth_mechanism string	Тип аутентификации. Варианты: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
collection string / обязательный	Коллекция, с которой нужно работать.
connection_options list / elements=any	Дополнительные параметры подключения. Укажите список словарей или строк с парами ключ-значение, разделенными символом «=».
db string / обязательный	База данных, с которой нужно работать.
debug boolean	Включить дополнительный отладочный вывод. Варианты: `false` ← (по умолчанию) `true`
level string	Уровень проверки, который MongoDB должна применять при обновлении существующих документов. Варианты: `"strict"` ← (по умолчанию) `"moderate"`
login_database string	База данных, в которой хранятся учетные данные для входа. По умолчанию: `"admin"`
login_host string	Узел с экземпляром MongoDB, к которому выполняется подключение. По умолчанию: `"localhost"`
login_password string	Пароль для аутентификации. Обязателен, если указан login_user.
login_port integer	Порт сервера MongoDB, к которому выполняется подключение. По умолчанию: `27017`
login_user string	Пользователь MongoDB для входа. Обязателен, если указан login_password.
properties dictionary	Описание отдельных свойств. По умолчанию: `{}`
replica_set string	Имя набора реплик.
required list / elements=string	Список обязательных полей.
ssl псевдонимы: tls boolean	Использовать ли SSL-подключение при соединении с базой данных. Варианты: `false` ← (по умолчанию) `true`
ssl_ca_certs псевдонимы: tlsCAFile string	Параметр ssl_ca_certs принимает путь к файлу CA.
ssl_cert_reqs псевдонимы: tlsAllowInvalidCertificates string	Указывает, требуется ли сертификат от другой стороны соединения и следует ли проверять его, если он предоставлен. Варианты: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (по умолчанию)
ssl_certfile псевдонимы: tlsCertificateKeyFile string	Предоставьте сертификат клиента с помощью параметра ssl_certfile.
ssl_crlfile string	Параметр ssl_crlfile принимает путь к файлу CRL.
ssl_keyfile string	Закрытый ключ сертификата клиента.
ssl_pem_passphrase псевдонимы: tlsCertificateKeyFilePassword string	Парольная фраза для расшифровки зашифрованных закрытых ключей.
state string	Состояние валидатора. Варианты: `"present"` ← (по умолчанию) `"absent"`
strict_compatibility boolean	Строго соблюдать требования к версиям pymongo и MongoDB Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

На удаленном узле требуется пакет Python pymongo версии 4 или новее.

Примеры

---
- name: Require that an email address field is in every document
  community.mongodb.mongodb_schema:
    collection: contacts
    db: rhys
    required:
      - email

- name: Remove a schema rule
  community.mongodb.mongodb_schema:
    collection: contacts
    db: rhys
    state: absent


- name: More advanced example using properties
  community.mongodb.mongodb_schema:
    collection: contacts
    db: rhys
    properties:
      email:
        maxLength: 150
        minLength: 5
      options:
        bsonType: array
        maxItems: 10
        minItems: 5
        uniqueItems: true
      status:
        bsonType: string
        description: "can only be ACTIVE or DISABLED"
        enum:
          - ACTIVE
          - DISABLED
      year:
        bsonType: int
        description: "must be an integer from 2021 to 3020"
        exclusiveMaximum: false
        maximum: 3020
        minimum: 2021
    required:
      - email
      - first_name
      - last_name

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
changed boolean	Указывает, внес ли модуль изменения. Возвращается: при успешном выполнении
module_config dictionary	Документ валидатора, заданный при вызове модуля. Возвращается: если debug имеет значение true
msg string	Сообщение о состоянии. Возвращается: всегда
validator dictionary	Документ валидатора, считанный из экземпляра. Возвращается: если debug имеет значение true

Авторы

Rhys Campbell (@rhysmeister)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/mongodb/mongodb_schema_module.html