ngine_io.vultr.vultr – Источник инвентаризации Vultr
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Чтобы использовать его в playbook, укажите: ngine_io.vultr.vultr.
Обзор
- Получение хостов инвентаризации из публичного облака Vultr.
- Использует файл конфигурации YAML, заканчивающийся vultr.yml или vultr.yaml для задания значений параметров (также см. примеры).
- Использует api_config, ~/.vultr.ini, ./vultr.ini или
VULTR_API_CONFIG, указывающие на файл INI с учетными данными Vultr (см. https://docs.ansible.com/ansible/latest/scenario_guides/guide_vultr.html).
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| api_account строка | Значение по умолчанию: "default" | Укажите используемый аккаунт. | |
| api_config путь | env:VULTR_API_CONFIG | Путь к файлу конфигурации vultr. Если не указан, берется из стандартной конфигурации Vultr. | |
| api_key строка | env:VULTR_API_KEY | Ключ API Vultr. Если не указан, берется из стандартной конфигурации Vultr. | |
| compose словарь | Значение по умолчанию: {} | Создать переменные из выражений jinja2. | |
| filter_by_tag строка | Возвращать только серверы, отфильтрованные по этому тегу. | ||
| groups словарь | Значение по умолчанию: {} | Добавить хосты в группу на основе условных выражений Jinja2. | |
| hostname строка |
| Поле для сопоставления имени хоста. Обратите внимание, что v4_main_ip соответствует полю main_ip, возвращаемому API, а имя - метке. | |
| keyed_groups список / элементы=строка | Значение по умолчанию: [] | Добавить хосты в группу на основе значений переменной. | |
| leading_separator булево добавлен в 2.11 ansible.builtin |
| Использовать совместно с keyed_groups. По умолчанию, у группы keyed, не имеющей префикса или разделителя, будет имя, начинающееся с подчеркивания. Это потому, что по умолчанию префикс равен "", а разделитель равен "_". Установите этот параметр в значение False, чтобы опустить ведущее подчеркивание (или другой разделитель), если префикс не задан. Если имя группы получено из отображения, разделитель все равно используется для конкатенации элементов. Чтобы вообще не использовать разделитель в имени группы, установите разделитель для группы keyed на пустую строку. | |
| plugin строка / обязательный |
| Токен, гарантирующий, что это исходный файл для плагина 'vultr'. | |
| strict булево |
| Если yes делать невалидные записи ошибкой, иначе пропустить и продолжить.Поскольку в выражениях можно использовать факты, они могут быть недоступны, и мы по умолчанию игнорируем такие ошибки. | |
| use_extra_vars булево добавлен в 2.11 ansible.builtin |
| записи в ini: [inventory_plugins] env:ANSIBLE_INVENTORY_USE_EXTRA_VARS | Объединить дополнительные переменные с доступными переменными для композиции (высший приоритет). |
Примеры
# inventory_vultr.yml file in YAML format
# Example command line: ansible-inventory --list -i inventory_vultr.yml
# Group by a region as lower case and with prefix e.g. "vultr_region_amsterdam" and by OS without prefix e.g. "CentOS_7_x64"
plugin: vultr
keyed_groups:
- prefix: vultr_region
key: region | lower
- separator: ""
key: os
# Pass a tag filter to the API
plugin: vultr
filter_by_tag: Cache
Авторы
- Yanis Guenane (@Spredzy)
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_inventory.html
