community.general.iocage inventory – источник инвентаризации iocage

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.

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

env

dictionary

Окружение user на host.

Включите sudo_preserve_env, если включен sudo.

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

get_properties

boolean

Получать свойства jail. Для каждого добавленного узла создается словарь iocage_properties.

Варианты:

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

groups

dictionary

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

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

hooks_results

list / elements=path

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

Список путей к файлам в jail.

Содержимое файлов хранится в элементах списка iocage_hooks.

Если файл недоступен, вместо него остается символ тире -.

Переменная iocage_hooks не создается, если hooks_results пуст.

host

string

IP-адрес/имя узла iocage.

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

inventory_hostname_required

boolean

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

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

Варианты:

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

inventory_hostname_tag

string

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

Имя тега в iocage properties notes, содержащего псевдоним jail.

По умолчанию для имени jail используется столбец NAME из iocage list -l.

Для этого параметра требуется формат заметок "t1=v1 t2=v2 ...".

Параметр get_properties должен быть включен.

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

plugin

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

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

Варианты:

• "community.general.iocage"

strict

boolean

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

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

Варианты:

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

sudo

boolean

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

Включает выполнение от имени root.

Для этого требуется возможность выполнять команду iocage list* через sudo без пароля.

Варианты:

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

sudo_preserve_env

boolean

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

Сохраняет окружение, если включен sudo.

Для этого требуется тег sudoers SETENV.

Варианты:

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

use_extra_vars

boolean

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

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

Варианты:

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

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

• Запись INI:

  [inventory_plugins]
  use_extra_vars = false
  

• Переменная окружения: ANSIBLE_INVENTORY_USE_EXTRA_VARS

user

string

Пользователь iocage. Предполагается, что user может подключиться к host по SSH и выполнить команду iocage list. Этот параметр не требуется, если host=localhost.