community.vmware.vmware_host_inventory инвентаризация – источник инвентаризации хостов VMware ESXi

Примечание

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

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

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

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

Описание
Требования
Параметры
Примеры

Описание

Получение хостов VMware ESXi из среды VMware в качестве хостов инвентаризации.
Использует любой файл, оканчивающийся на vmware.yml, vmware.yaml, vmware_host_inventory.yml или vmware_host_inventory.yaml, в качестве файла конфигурации YAML.

Требования

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

vSphere Automation SDK — для функции тегов

Параметры

Параметр	Комментарии
cache boolean	Включить/отключить кэширование данных источника инвентаризации. Требуется настройка плагина кэша. Выбоpы: `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. По умолчанию: `{}`
filters list / elements=string	Этот параметр позволяет фильтровать хосты на клиенте с помощью шаблонирования Jinja. При появлении серверного фильтра, следует предпочесть его. По умолчанию: `[]`
groups dictionary	Добавить хосты в группу на основе условных выражений Jinja2. По умолчанию: `{}`
hostname string / обязательно	Имя сервера vCenter или ESXi. Настройка: Переменная среды: `VMWARE_HOST` Переменная среды: `VMWARE_SERVER`
hostnames list / elements=string	Список шаблонов в порядке приоритета для составления inventory_hostname. Игнорирует шаблон, если результат пустая строка или значение None. В шаблоне можно использовать свойства, указанные в `properties` как переменные. По умолчанию: `["name"]`
keyed_groups list / elements=dictionary	Добавление хостов в группы на основе значений переменной. По умолчанию: `[{"key": "summary.runtime.powerState", "separator": ""}]`
default_value string добавлено в ansible-core 2.12	Значение по умолчанию, когда значение переменной хоста пустая строка. Этот параметр несовместим с `keyed_groups[].trailing_separator`.
key string	Ключ из входного словаря, используемый для создания групп.
parent_group string	Родительская группа для ключевой группы.
prefix string	Имя ключа группы начинается с этого префикса. По умолчанию: `""`

разделитель строка	разделитель, используемый для построения имени ключа группы По умолчанию: `"_"`
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` ← (по умолчанию)
пароль строка / обязательно	Пароль пользователя vSphere. Поддерживает зашифрованные переменные vault. Поддерживает Jinja для шаблонизации значения Настройка: Переменная среды: `VMWARE_PASSWORD`
порт целое число	Номер порта, используемый для подключения к vCenter или ESXi-серверу. По умолчанию: `443` Настройка: Переменная среды: `VMWARE_PORT`
свойства список / элементы=строка	Укажите список свойств схемы VMware, связанных с ESXi-узлом. Эти свойства будут заполнены в hostvars данного ESXi-узла. Каждое значение в списке может быть путем к определенному свойству в объекте hostsystem или путем к набору объектов hostsystem. `summary.runtime.powerState` необходимы, если `keyed_groups` установлено по умолчанию. Убедитесь, что все свойства, используемые в других параметрах, включены в этот параметр. В дополнение к свойствам ESXi-узла доступны следующие специальные значения Используйте `customValue`, чтобы заполнить пользовательские атрибуты ESXi-узла. `customValue` поддерживается только vCenter, а не ESXi. Используйте `all`, чтобы заполнить все свойства виртуальной машины. Значение `all` является трудоемкой операцией, не используйте, если это не абсолютно необходимо. По умолчанию: `["name", "customValue", "summary.runtime.powerState"]`
proxy_host строка	Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Настройка: Переменная среды: `VMWARE_PROXY_HOST`
proxy_port целое число	Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Настройка: Переменная среды: `VMWARE_PROXY_PORT`
resources список / элементы=словарь	Список ресурсов для ограничения области поиска. Каждый элемент ресурса представлен ровно одной парой `'vim_type_snake_case`:`list of resource names` и необязательными вложенными resources Имя ключа основано на именовании vim с использованием нижнего подчеркивания; например, `host_system` соответствует `vim.HostSystem` По умолчанию: `[]`
строго булево	Если `yes`, то неверные записи будут считаться ошибкой, в противном случае они будут пропущены. Так как фактические данные могут использоваться в выражениях, они могут не всегда быть доступны, и мы пропускаем такие ошибки по умолчанию. Варианты: `false` ← (по умолчанию) `true`
использовать_дополнительные_переменные булево добавлен в ansible-core 2.11	Объединить дополнительные переменные в доступные переменные для композиции (наивысший приоритет). Варианты: `false` ← (по умолчанию) `true` Настройка: Запись INI: [inventory_plugins] use_extra_vars = false Переменная среды: `ANSIBLE_INVENTORY_USE_EXTRA_VARS`
имя_пользователя строка / обязательно	Имя пользователя vSphere. Поддерживает зашифрованные переменные vault. Поддерживает Jinja для шаблонизации значения Настройка: Переменная среды: `VMWARE_USER` Переменная среды: `VMWARE_USERNAME`

validate_certs boolean	Разрешает подключение, когда сертификаты SSL недействительны. Установите значение `false`, когда сертификаты не доверяются. Варианты: `false` `true` ← (по умолчанию) Настройка: Переменная среды: `VMWARE_VALIDATE_CERTS`
with_nested_properties boolean	Этот параметр преобразует имена плоских свойств во вложенные словари. Варианты: `false` `true` ← (по умолчанию)
with_path boolean	Включить путь к хосту ESXi. Установите этот параметр в строковое значение, чтобы заменить корневое имя ‘Центры данных’. Варианты: `false` ← (по умолчанию) `true`
with_sanitized_property_name boolean	Этот параметр позволяет очистить имена свойств, чтобы создать безопасные имена свойств для использования в Ansible. Также преобразует имя свойства в нижний регистр со знаками подчёркивания. Варианты: `false` ← (по умолчанию) `true`
with_tags boolean	Включить метки и связанные хосты. Требуется установка библиотеки ‘vSphere Automation SDK’ на указанной управляющей машине. См. следующие URL-адреса для шагов установки https://code.vmware.com/web/sdk/7.0/vsphere-automation-python Варианты: `false` ← (по умолчанию) `true`

Примеры

# Sample configuration file for VMware Host dynamic inventory
    plugin: community.vmware.vmware_host_inventory
    strict: false
    hostname: 10.65.223.31
    username: administrator@vsphere.local
    password: Esxi@123$%
    validate_certs: false
    with_tags: true

# Sample configuration file for VMware Guest dynamic inventory using Jinja to template the username and password.
    plugin: community.vmware.vmware_host_inventory
    strict: false
    hostname: 10.65.223.31
    username: '{{ (lookup("file","~/.config/vmware.yaml") | from_yaml).username }}'
    password: '{{ (lookup("file","~/.config/vmware.yaml") | from_yaml).password }}'
    validate_certs: false
    with_tags: true

# Using compose
    plugin: community.vmware.vmware_host_inventory
    hostname: 10.65.223.31
    username: administrator@vsphere.local
    password: Esxi@123$%
    validate_certs: false
    properties:
    - name
    - summary
    - config.lockdownMode
    compose:
        ansible_user: "'root'"
        ansible_connection: "'ssh'"

Авторы

Abhijeet Kasurde (@Akasurde)

Подсказка

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

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

© 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/vmware/vmware_host_inventory_inventory.html