Spec-Zone.ru › Ansible

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.

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

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

  • Переменная среды: ANSIBLE_XO_HOST

cache

boolean

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

Варианты:

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

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

  • Запись INI:

    [inventory]
    cache = false
    
  • Переменная среды: ANSIBLE_INVENTORY_CACHE

cache_connection

string

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

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

  • Записи INI:

    [defaults]
    fact_caching_connection = VALUE
    
    [inventory]
    cache_connection = VALUE
    
  • Переменная среды: ANSIBLE_CACHE_PLUGIN_CONNECTION
  • Переменная среды: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

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

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

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

  • Записи INI:

    [defaults]
    fact_caching = memory
    
    [inventory]
    cache_plugin = memory
    
  • Переменная среды: ANSIBLE_CACHE_PLUGIN
  • Переменная среды: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

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

По умолчанию: "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

integer

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

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

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

  • Записи INI:

    [defaults]
    fact_caching_timeout = 3600
    
    [inventory]
    cache_timeout = 3600
    
  • Переменная среды: ANSIBLE_CACHE_PLUGIN_TIMEOUT
  • Переменная среды: ANSIBLE_INVENTORY_CACHE_TIMEOUT

compose

dictionary

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

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

groups

dictionary

Добавляет узлы в группы на основе условий Jinja2.

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

keyed_groups

list / элементы=dictionary

Добавляет узлы в группы на основе значений переменной.

По умолчанию: []

default_value

string

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

Значение по умолчанию, если значение переменной узла равно None или является пустой строкой.

Этот параметр несовместим с keyed_groups[].trailing_separator.

key

string

Ключ входного словаря, используемый для создания групп.

parent_group

string

Родительская группа для группы, созданной по ключу.

prefix

string

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

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

separator

string

Разделитель, используемый при формировании имени группы, созданной по ключу.

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

trailing_separator

boolean

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

Установите этот параметр в false, чтобы не добавлять keyed_groups[].separator после переменной узла, если ее значение равно None или является пустой строкой.

Этот параметр несовместим с keyed_groups[].default_value.

Варианты:

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

leading_separator

boolean

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

Используется совместно с keyed_groups.

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

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

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

Если имя группы сформировано из отображения, разделитель по-прежнему используется для объединения элементов.

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

Варианты:

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

password

string / обязательный

Пароль Xen Orchestra.

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

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

  • Переменная среды: ANSIBLE_XO_PASSWORD

plugin

string / обязательный

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

Варианты:

  • "community.general.xen_orchestra"

strict

boolean

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

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

Варианты:

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

use_extra_vars

boolean

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

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

Варианты:

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

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

  • Запись INI:

    [inventory_plugins]
    use_extra_vars = false
    
  • Переменная среды: ANSIBLE_INVENTORY_USE_EXTRA_VARS

use_host_uuid

boolean

добавлено в community.general 10.4.0

Импортирует узлы Xen в инвентаризацию, используя UUID в качестве имени записи узла.

Если установлено значение false, вместо UUID используются метки имен узлов.

Варианты:

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

use_ssl

boolean

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

Варианты:

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

use_vm_uuid

boolean

добавлено в community.general 10.4.0

Импортирует виртуальные машины Xen в инвентаризацию, используя UUID в качестве имени записи виртуальной машины.

Если установлено значение false, вместо UUID используются метки имен виртуальных машин.

Варианты:

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

user

string / обязательный

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

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

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

  • Переменная среды: ANSIBLE_XO_USER

validate_certs

boolean

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

Варианты:

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

Примечание

Записи конфигурации, перечисленные выше для каждого типа записей (переменная 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

Авторы

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

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

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

© 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

Spec-Zone.ru

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