cloudscale_ch.cloud.inventory инвентаризация – источник инвентаризации cloudscale.ch

Примечание

Этот плагин инвентаризации является частью коллекции cloudscale_ch.cloud (версия 2.4.0).

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

Для установки используйте: ansible-galaxy collection install cloudscale_ch.cloud.

Чтобы использовать её в книге задач, укажите: cloudscale_ch.cloud.inventory.

Описание
Параметры
Примеры

Описание

Получение хостов инвентаризации из API cloudscale.ch
Использует файл конфигурации YAML, заканчивающийся либо cloudscale.yml, либо cloudscale.yaml, для установки значений параметров (также см. примеры).

Псевдонимы: cloudscale

Параметры

Параметр	Комментарии
ansible_host строка	Какой IP-адрес зарегистрировать как ansible_host. Если запрошенное значение не существует или установлено в ‘none’, ansible_host не будет задан. Выбор: `"public_v4"` ← (по умолчанию) `"public_v6"` `"private"` `"none"`
api_token строка	Токен API cloudscale.ch. Также может быть передан в переменной окружения `CLOUDSCALE_API_TOKEN`.
compose словарь	Создать переменные из выражений jinja2. По умолчанию: `{}`
groups словарь	Добавить хосты в группу на основе условных выражений Jinja2. По умолчанию: `{}`
inventory_hostname строка	Что зарегистрировать как имя хоста инвентаризации. Если установлено в ‘uuid’, будет использоваться uuid сервера, и будет создана группа для имени сервера. Если установлено в ‘name’, будет использоваться имя сервера, если только нет более одного сервера с одинаковым именем, в этом случае будет использована логика ‘uuid’. Выбор: `"name"` ← (по умолчанию) `"uuid"`
keyed_groups список / элементы=словарь	Добавить хосты в группу на основе значений переменной. По умолчанию: `[]`
default_value строка добавлено в ansible-core 2.12	Значение по умолчанию, когда значение переменной хоста пустая строка. Этот параметр взаимоисключающий с `keyed_groups[].trailing_separator`.
key строка	Ключ из входного словаря, используемый для генерации групп
parent_group строка	родительская группа для ключевой группы
prefix строка	Имя ключевой группы будет начинаться с этого префикса По умолчанию: `""`
separator строка	Разделитель, используемый для построения имени ключевой группы По умолчанию: `"_"`
trailing_separator логическое добавлено в ansible-core 2.12	Установите этот параметр в `False` чтобы опустить `keyed_groups[].separator` после переменной хоста, когда значение является пустой строкой. Этот параметр взаимоисключающий с `keyed_groups[].default_value`. Выбор: `false` `true` ← (по умолчанию)
leading_separator логическое добавлено в ansible-core 2.11	Используется в сочетании с keyed_groups. По умолчанию, ключевая группа, у которой нет префикса или разделителя, будет иметь имя, начинающееся с нижнего подчеркивания. Это потому, что префикс по умолчанию пустой, а разделитель по умолчанию “_”. Установите этот параметр в False, чтобы опустить ведущий символ подчеркивания (или другой разделитель), если префикс не указан. Если имя группы получено из сопоставления, разделитель все равно используется для конкатенации элементов. Чтобы вообще не использовать разделитель в имени группы, установите разделитель для ключевой группы в пустую строку. Выбор: `false` `true` ← (по умолчанию)
plugin строка / обязательно	Токен, гарантирующий, что это файл источника для плагина ‘cloudscale’. Выбор: `"cloudscale"`
strict логическое	Если `yes` считать недопустимые записи фатальной ошибкой, в противном случае пропустить и продолжить. Поскольку фактически возможно использовать факты в выражениях, они могут не всегда быть доступны, и мы по умолчанию игнорируем эти ошибки. Выбор: `false` ← (по умолчанию) `true`
use_extra_vars логическое добавлено в ansible-core 2.11	Объединить дополнительные переменные в доступные переменные для композиции (высший приоритет). Выбор: `false` ← (по умолчанию) `true` Настройка: Запись INI: [inventory_plugins] use_extra_vars = false Переменная окружения: `ANSIBLE_INVENTORY_USE_EXTRA_VARS`

END_OF_DOCUMENT_MARKER

Примеры

# cloudscale.yml name ending file in YAML format
# Example command line: ansible-inventory --list -i inventory_cloudscale.yml

plugin: cloudscale_ch.cloud.inventory

# Example grouping by tag key "project"
plugin: cloudscale_ch.cloud.inventory
keyed_groups:
  - prefix: project
    key: cloudscale.tags.project

# Example grouping by key "operating_system" lowercased and prefixed with "os"
plugin: cloudscale_ch.cloud.inventory
keyed_groups:
  - prefix: os
    key: cloudscale.image.operating_system | lower

Авторы

Gaudenz Steinlin (@gaudenz)

Подсказка

Записи конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

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

© 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/cloudscale_ch/cloud/inventory_inventory.html