Spec-Zone.ru › Ansible

community.general.xen_orchestra инвентаризация – Источник инвентаризации Xen Orchestra

Примечание

Этот плагин инвентаризации входит в состав коллекции community.general (версия 9.5.0).

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

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

Для использования в книге задач укажите: community.general.xen_orchestra.

Новое в community.general 4.1.0

  • Обзор
  • Требования
  • Параметры
  • Примеры

Обзор

  • Получение узлов инвентаризации из развертывания Xen Orchestra.
  • Использует конфигурационный файл в качестве источника инвентаризации, он должен заканчиваться на .xen_orchestra.yml или .xen_orchestra.yaml.

Требования

Ниже перечислены требования к локальному контроллеру, на котором выполняется эта инвентаризация.

  • websocket-client >= 1.0.0

Параметры

Параметр

Комментарии

api_host

строка

Хост API для XOA API.

Если значение не указано в конфигурации инвентаризации, будет использовано значение переменной окружения ANSIBLE_XO_HOST.

Конфигурация:

  • Переменная окружения: ANSIBLE_XO_HOST

cache

булево

Включить/отключить кэширование данных источника инвентаризации; для работы требуется настройка плагина кэша.

Варианты:

  • false ← (по умолчанию)
  • true

Конфигурация:

  • Запись в INI:

    [inventory]
    cache = false
    
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE

cache_connection

строка

Данные или путь к подключению к кэшу, см. документацию по плагинам кэша для получения подробностей.

Конфигурация:

  • Записи в INI:

    [defaults]
    fact_caching_connection = VALUE
    
    [inventory]
    cache_connection = VALUE
    
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN_CONNECTION
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

строка

Плагин кэша для использования с данными источника инвентаризации.

По умолчанию: "memory"

Конфигурация:

  • Записи в INI:

    [defaults]
    fact_caching = memory
    
    [inventory]
    cache_plugin = memory
    
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

строка

Префикс для использования с файлами/таблицами плагина кэша

По умолчанию: "ansible_inventory_"

Конфигурация:

  • Записи в INI:

    [defaults]
    fact_caching_prefix = ansible_inventory_
    
    [inventory]
    cache_prefix = ansible_inventory_
    
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN_PREFIX
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

целое число

Время жизни кэша в секундах

По умолчанию: 3600

Конфигурация:

  • Записи в INI:

    [defaults]
    fact_caching_timeout = 3600
    
    [inventory]
    cache_timeout = 3600
    
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN_TIMEOUT
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_TIMEOUT

compose

словарь

Создать переменные из выражений Jinja2.

По умолчанию: {}

groups

словарь

Добавить хосты в группу на основе условных выражений Jinja2.

По умолчанию: {}

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 ← (по умолчанию)
END_OF_DOCUMENT_MARKER

разделитель_в_начале

булево

добавлен в ansible-core 2.11

Используется в сочетании с keyed_groups.

По умолчанию, группа с ключом, у которой не указано префикс или разделитель, будет иметь имя, начинающееся с подчёркивания.

Это связано с тем, что по умолчанию префикс — пустая строка, а разделитель — «_».

Установите этот параметр в значение False, чтобы опустить начальное подчёркивание (или другой разделитель), если префикс не указан.

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

Чтобы вообще не использовать разделитель в имени группы, установите разделитель для группы с ключом в пустую строку.

Варианты:

  • false
  • true ← (по умолчанию)

пароль

строка / обязательно

Пароль Xen Orchestra.

Если значение не указано в конфигурации инвентаризации, будет использовано значение переменной окружения ANSIBLE_XO_PASSWORD.

Конфигурация:

  • Переменная окружения: ANSIBLE_XO_PASSWORD

плагин

строка / обязательно

Имя этого плагина, оно всегда должно быть установлено в значение community.general.xen_orchestra для того, чтобы плагин распознал его как свой собственный.

Варианты:

  • "community.general.xen_orchestra"

строгий

булево

Если yes сделать неверные записи ошибкой, иначе пропустить и продолжить.

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

Варианты:

  • false ← (по умолчанию)
  • true

использовать_дополнительные_переменные

булево

добавлен в ansible-core 2.11

Объединить дополнительные переменные с доступными переменными для композиции (самый высокий приоритет).

Варианты:

  • false ← (по умолчанию)
  • true

Конфигурация:

  • Запись INI:

    [inventory_plugins]
    use_extra_vars = false
    
  • Переменная окружения: ANSIBLE_INVENTORY_USE_EXTRA_VARS

использовать_ssl

булево

Использовать wss при подключении к API Xen Orchestra

Варианты:

  • false
  • true ← (по умолчанию)

пользователь

строка / обязательно

Пользователь Xen Orchestra.

Если значение не указано в конфигурации инвентаризации, будет использовано значение переменной окружения ANSIBLE_XO_USER.

Конфигурация:

  • Переменная окружения: ANSIBLE_XO_USER

проверять_сертификаты

булево

Проверять сертификаты TLS при использовании HTTPS.

Варианты:

  • false
  • true ← (по умолчанию)

Примеры

# file must be named xen_orchestra.yaml or xen_orchestra.yml
plugin: community.general.xen_orchestra
api_host: 192.168.1.255
user: xo
password: xo_pwd
validate_certs: true
use_ssl: true
groups:
    kube_nodes: "'kube_node' in tags"
compose:
    ansible_port: 2222

Авторы

  • Dom Del Nano (@ddelnano)
  • Samori Gorse (@shinuza)

Подсказка

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

Ссылки на сборку

  • Отслеживание проблем
  • Репозиторий (источники)
  • Задать вопрос
  • Отправить отчет об ошибке
  • Запросить функцию
  • Связь

© 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/general/xen_orchestra_inventory.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API