Модуль community.mongodb.mongodb_shard_zone — управление зонами шардирования.

Примечание

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

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

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

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

Добавлено в community.mongodb 1.3.0

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

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

Управление зонами шардирования.
Добавление и удаление зон шардирования.

Требования

Перечисленные ниже требования должны быть выполнены на узле, где выполняется этот модуль.

pymongo

Параметры

Параметр	Комментарии
atlas_auth boolean	Способ аутентификации для экземпляров MongoDB Atlas Варианты: `false` ← (по умолчанию) `true`
auth_mechanism string	Тип аутентификации. Варианты: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
connection_options list / elements=any	Дополнительные параметры подключения. Передавайте их в виде списка словарей или строк с парами «ключ=значение».
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.
mongos_process string	Укажите пользовательское имя процесса mongos. Большинству пользователей не нужно менять этот параметр. По умолчанию: `"mongos"`
name string / обязательный	Имя зоны.
namespace string	Пространство имен, назначенное зоне Указывается в формате database.collection.
ranges list / elements=list	Диапазоны, назначенные зоне.
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 или выше. Его можно установить с помощью pip или системного менеджера пакетов. См. http://api.mongodb.org/python/current/installation.html

Примеры

- 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 boolean	Значение True, если произошло изменение Возвращается: при успехе
failed boolean	Если произошла ошибка Возвращается: при ошибке
msg string	Краткое описание произошедшего. Возвращается: при ошибке

Авторы

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_shard_zone_module.html