Модуль community.mongodb.mongodb_shard_zone — Управление зонами фрагментации.

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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 / элементы=любой	Дополнительные параметры подключения. Указывайте в виде списка словарей или строк, содержащих пары ключ-значение, разделенные символом ‘=’.
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	Пространство имен, к которому присвоена зона Должно быть указано в формате база_данных.коллекция.
ranges 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 ← (по умолчанию)

Примечания

Примечание

Требуется пакет pymongo Python на удалённом хосте, версия 4+. Его можно установить с помощью pip или менеджера пакетов операционной системы. @see 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	Истина, если произошли изменения Возвращается при: успехе
failed boolean	Если что-то пошло не так Возвращается при: ошибке
msg string	Краткое описание произошедшего. Возвращается при: ошибке

Авторы

Rhys Campbell (@rhysmeister)

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

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