Spec-Zone.ru › Ansible

ovirt.ovirt.ovirt inventory — источник инвентаризации oVirt

Примечание

Этот плагин инвентаризации входит в коллекцию ovirt.ovirt (версия 3.2.2).

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

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

Чтобы использовать плагин в плейбуке, укажите: ovirt.ovirt.ovirt.

Добавлено в ovirt.ovirt 1.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры

Краткое описание

  • Получение хостов инвентаризации из службы oVirt.
  • Требуется файл YAML с расширением ‘ovirt.yml’, ‘ovirt4.yml’, ‘ovirt.yaml’ или ‘ovirt4.yaml’.

Требования

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

  • ovirt-engine-sdk-python >= 4.2.4

Параметры

Параметр

Описание

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

ovirt_cafile

string

Путь к файлу CA ovirt-engine. Если параметр ovirt_cafile не задан и ovirt_insecure не равен True, используется общесистемное хранилище сертификатов CA.

ovirt_hostname_preference

list / elements=string

Список параметров, определяющих порядок назначения имён хостам.

Список доступных атрибутов см. на странице https://ovirt.github.io/ovirt-engine-api-model/master/#types/vm.

По умолчанию: ["fqdn", "name"]

ovirt_insecure

string

Логический флаг, указывающий, следует ли проверять TLS-сертификат сервера и имя хоста.

ovirt_password

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

Пароль для аутентификации в oVirt.

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

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

ovirt_query_filter

string

Словарь пар ключ-значение фильтра для запроса виртуальных машин. Параметры фильтра см. на странице https://ovirt.github.io/ovirt-engine-sdk/master/services.m.html#ovirtsdk4.services.VmsService.list.

ovirt_url

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

URL API ovirt-engine.

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

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

ovirt_username

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

Имя пользователя для аутентификации в oVirt.

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

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

plugin

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

Имя этого плагина. Чтобы плагин распознал конфигурацию как свою, здесь всегда должно быть указано ‘ovirt’.

Варианты:

  • "ovirt"
  • "ovirt.ovirt.ovirt"
  • "redhat.rhv.ovirt"

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

Примечание

Для записей конфигурации каждого типа (переменная Ansible, переменная среды и т. д.), перечисленных выше, порядок приоритета указан от низшего к высшему. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше. Типы записей также упорядочены по приоритету от низшего к высшему. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

  • На этом этапе формирование инвентаризации ещё не завершено, поэтому автоматически заполненные группы all и ungrouped будут содержать только то, что в них явно добавили предыдущие источники инвентаризации.
  • Во время построения инвентаризации среда выполнения ещё не предоставляет «магические переменные». Например, groups и hostvars ещё не существуют.

Примеры

# Ensure the CA is available:
# $ wget "https://engine/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA" -O /path/to/ca.pem
# Sample content of ovirt.yml:
plugin: ovirt.ovirt.ovirt
ovirt_url: https://engine/ovirt-engine/api
ovirt_cafile: /path/to/ca.pem
ovirt_username: ansible-tester
ovirt_password: secure
ovirt_query_filter:
  search: 'name=myvm AND cluster=mycluster'
  case_sensitive: false
  max: 15
keyed_groups:
  - key: cluster
    prefix: 'cluster'
groups:
  dev: "'dev' in tags"
compose:
  ansible_host: devices["eth0"][0]

Авторы

  • Разработчики oVirt (@oVirt)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/ovirt/ovirt/ovirt_inventory.html

Spec-Zone.ru

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