community.general.xen_orchestra inventory – источник инвентаризации Xen Orchestra
Примечание
Этот плагин инвентаризации входит в коллекцию community.general (версия 12.6.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Узел API для API XOA. Если значение не указано в конфигурации инвентаризации, вместо него используется значение переменной среды Конфигурация:
|
cache boolean | Включает или отключает кэширование исходных данных инвентаризации; для работы требуется настроенный плагин кэширования. Варианты:
Конфигурация:
|
cache_connection string | Данные подключения к кэшу или путь к нему; подробности см. в документации плагина кэширования. Конфигурация:
|
cache_plugin string | Плагин кэширования исходных данных инвентаризации. По умолчанию: Конфигурация:
|
cache_prefix string | Префикс для файлов или таблиц плагина кэширования. По умолчанию: Конфигурация:
|
cache_timeout integer | Время хранения кэша в секундах. По умолчанию: Конфигурация:
|
compose dictionary | Создает переменные из выражений Jinja2. По умолчанию: |
groups dictionary | Добавляет узлы в группы на основе условий Jinja2. По умолчанию: |
keyed_groups list / элементы=dictionary | Добавляет узлы в группы на основе значений переменной. По умолчанию: |
|
default_value string добавлено в ansible-core 2.12 |
Значение по умолчанию, если значение переменной узла равно Этот параметр несовместим с |
|
key string |
Ключ входного словаря, используемый для создания групп. |
|
parent_group string |
Родительская группа для группы, созданной по ключу. |
|
prefix string |
Имя группы, созданной по ключу, будет начинаться с этого префикса. По умолчанию: |
|
separator string |
Разделитель, используемый при формировании имени группы, созданной по ключу. По умолчанию: |
|
trailing_separator boolean добавлено в ansible-core 2.12 |
Установите этот параметр в Этот параметр несовместим с Варианты:
|
leading_separator boolean добавлено в ansible-core 2.11 | Используется совместно с По умолчанию имя группы, созданной по ключу, для которой не задан префикс или разделитель, начинается с символа подчеркивания. Это происходит потому, что префикс по умолчанию — Установите этот параметр в Если имя группы сформировано из отображения, разделитель по-прежнему используется для объединения элементов. Чтобы вообще не использовать разделитель в имени группы, задайте для группы, созданной по ключу, пустую строку в качестве разделителя. Варианты:
|
password string / обязательный | Пароль Xen Orchestra. Если значение не указано в конфигурации инвентаризации, вместо него используется значение переменной среды Конфигурация:
|
plugin string / обязательный | Название этого плагина. Для распознавания плагином собственного файла здесь всегда должно быть указано Варианты:
|
strict boolean | Если Поскольку в выражениях можно использовать факты, они могут быть доступны не всегда; по умолчанию такие ошибки игнорируются. Варианты:
|
use_extra_vars boolean добавлено в ansible-core 2.11 | Объединяет дополнительные переменные с доступными переменными для композиции (наивысший приоритет). Варианты:
Конфигурация:
|
use_host_uuid boolean добавлено в community.general 10.4.0 | Импортирует узлы Xen в инвентаризацию, используя UUID в качестве имени записи узла. Если установлено значение Варианты:
|
use_ssl boolean | Использует wss при подключении к API Xen Orchestra. Варианты:
|
use_vm_uuid boolean добавлено в community.general 10.4.0 | Импортирует виртуальные машины Xen в инвентаризацию, используя UUID в качестве имени записи виртуальной машины. Если установлено значение Варианты:
|
user string / обязательный | Пользователь Xen Orchestra. Если значение не указано в конфигурации инвентаризации, вместо него используется значение переменной среды Конфигурация:
|
validate_certs boolean | Проверяет сертификат TLS при использовании HTTPS. Варианты:
|
Примечание
Записи конфигурации, перечисленные выше для каждого типа записей (переменная Ansible, переменная среды и т. д.), имеют приоритет от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).
Примечания
Примечание
- На этом этапе формирование инвентаризации еще не завершено, поэтому автоматически заполненные группы
allиungroupedбудут отражать только то, что в них явно добавили предыдущие источники инвентаризации. - Во время формирования инвентаризации «магические переменные» времени выполнения недоступны. Например,
groupsиhostvarsеще не существуют.
Примеры
--- # 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 use_vm_uuid: false use_host_uuid: true
Ссылки на коллекцию
© 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/general/xen_orchestra_inventory.html