Инвентаризация community.proxmox.proxmox – источник инвентаризации Proxmox

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.

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

exclude_nodes

boolean

Исключить узлы Proxmox и группу узлов из вывода инвентаризации.

Варианты:

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

facts_prefix

string

Префикс для фактов конфигурации LXC/QEMU.

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

filters

list / elements=string

Список шаблонов Jinja для фильтрации узлов.

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

В фильтрах можно использовать факты, собранные при значении want_facts, равном true.

Если значение want_facts равно false, полные факты недоступны, и в фильтрах можно использовать только ограниченный набор фактов: proxmox_vmid, proxmox_name, proxmox_status, proxmox_vmtype, proxmox_tags.

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

group_prefix

string

Префикс для групп Proxmox.

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

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

password

string

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

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

Для указания значения password можно использовать шаблонизацию.

Если пароль не указан, необходимо задать token_id и token_secret.

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

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

plugin

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

Имя этого плагина; для распознавания плагином самого себя здесь всегда должно быть указано community.proxmox.proxmox.

Варианты:

• "community.proxmox.proxmox"

qemu_extended_statuses

boolean

Для работы требуется установить для want_facts значение true. Это позволит различать состояния paused и prelaunch виртуальных машин QEMU.

Будет создано несколько групп [с префиксом group_prefix] prelaunch и paused.

Варианты:

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

strict

boolean

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

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

Варианты:

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

token_id

string

Идентификатор токена для аутентификации в Proxmox.

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

Для аутентификации с помощью токена также необходимо указать token_secret. Если не указаны token_id и token_secret, вместо них необходимо задать пароль.

Обязательно предоставьте токену явные разрешения pve или отключите «разделение привилегий», чтобы использовать привилегии пользователя.

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

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

token_secret

string

Секрет токена для аутентификации в Proxmox.

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

Для аутентификации с помощью токена также необходимо указать token_id. Если не указаны token_id и token_secret, вместо них необходимо задать пароль.

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

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

url

string

URL-адрес кластера Proxmox.

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

Для указания значения url можно использовать шаблонизацию.

По умолчанию: "http://localhost:8006"

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

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

use_extra_vars

boolean

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

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

Варианты:

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

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

• Запись INI:

  [inventory_plugins]
  use_extra_vars = false
  

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

user

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

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

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

Для указания значения user можно использовать шаблонизацию.

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

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

validate_certs

boolean

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

Варианты:

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

want_facts

boolean

Собирать факты конфигурации LXC/QEMU.

Если для want_facts задано значение true, для виртуальных машин QEMU можно получить более подробные сведения о состоянии, помимо состояний «запущена» и «остановлена». Сейчас, если виртуальная машина запущена и приостановлена, её состояние будет «запущена», а сама машина попадёт в группу running, однако её фактическое состояние будет «приостановлена». О том, как получить реальное состояние, см. qemu_extended_statuses.

Варианты:

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

want_post_filter_facts

boolean

Определяет, собирать ли факты после фильтрации узлов (в отличие от сбора всех фактов всех узлов до фильтрации, когда для want_facts задано значение true).

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

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

Варианты:

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

want_proxmox_nodes_ansible_host

boolean

Определяет, задавать ли ansible_host для узлов Proxmox.

Если установлено значение true (по умолчанию), будет использоваться первый доступный интерфейс. Он может отличаться от ожидаемого.

Варианты:

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