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

Примечание

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

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

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

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

Новое в community.general 12.0.0

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

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

Получение хостов инвентаризации из менеджера контейнеров и виртуальных машин Incus.

Требования

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

Интерфейс командной строки Incus (incus)

Параметры

Параметр	Комментарии
compose словарь	Создание переменных на основе выражений Jinja2. По умолчанию: `{}`
default_groups логический	Определяет, создавать ли группы по умолчанию на основе удалённого сервера и проекта. Варианты: `false` `true` ← (по умолчанию)
filters список / элементы=строка	Выражение фильтрации в формате, поддерживаемом `incus list`. По умолчанию: `[]`
groups словарь	Добавление хостов в группы на основе условий Jinja2. По умолчанию: `{}`
host_domain строка	Домен, добавляемый к имени хоста. Также используется, если `host_fqdn` не задан, начиная с community.general 12.5.0.
host_fqdn логический	Определяет, создавать ли полное доменное имя для имени хоста. Будет использоваться синтаксис INSTANCE.PROJECT.REMOTE. Варианты: `false` `true` ← (по умолчанию)
keyed_groups список / элементы=словарь	Добавление хостов в группы на основе значений переменной. По умолчанию: `[]`
default_value строка добавлено в ansible-core 2.12	Значение по умолчанию, если значение переменной хоста равно `None` или является пустой строкой. Этот параметр нельзя использовать одновременно с `keyed_groups[].trailing_separator`.
key строка	Ключ входного словаря, используемый для создания групп.
parent_group строка	Родительская группа для группы, созданной по ключу.
prefix строка	Имя группы, созданной по ключу, будет начинаться с этого префикса. По умолчанию: `""`
separator строка	Разделитель, используемый для формирования имени группы, созданной по ключу. По умолчанию: `"_"`
trailing_separator логический добавлено в ansible-core 2.12	Установите для этого параметра значение `false`, чтобы опустить `keyed_groups[].separator` после переменной хоста, если её значение равно `None` или является пустой строкой. Этот параметр нельзя использовать одновременно с `keyed_groups[].default_value`. Варианты: `false` `true` ← (по умолчанию)
leading_separator логический добавлено в ansible-core 2.11	Используйте вместе с `keyed_groups`. По умолчанию имя группы, созданной по ключу, для которой не задан префикс или разделитель, начинается с символа подчёркивания. Это происходит потому, что префикс по умолчанию — `""`, а разделитель по умолчанию — `"_"`. Установите для этого параметра значение `false`, чтобы опустить начальный символ подчёркивания (или другой разделитель), если префикс не задан. Если имя группы формируется на основе отображения, разделитель по-прежнему используется для объединения элементов. Чтобы вообще не использовать разделитель в имени группы, задайте для группы, созданной по ключу, пустую строку в качестве разделителя. Варианты: `false` `true` ← (по умолчанию)
plugin строка / обязательный	Имя этого плагина. Для работы плагина здесь всегда должно быть указано community.general.incus. Варианты: `"community.general.incus"`
remotes список / элементы=строка	Имена удалённых серверов Incus, которые будут использоваться (для каждого `incus remote list`). Удалённые серверы позволяют обращаться к нескольким серверам с одного клиента. По умолчанию инвентаризация охватывает все проекты на каждом удалённом сервере. Можно указать конкретный проект с помощью `remote:project`. По умолчанию: `["local"]`
strict логический	Если `yes`, считать недопустимые записи критической ошибкой; в противном случае пропускать их и продолжать выполнение. Поскольку в выражениях можно использовать факты, они могут быть доступны не всегда; по умолчанию такие ошибки игнорируются. Варианты: `false` ← (по умолчанию) `true`
use_extra_vars логический добавлено в 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 ещё не существуют.

Примеры

---
# Pull instances from all projects on the local remote.
plugin: community.general.incus

---
# Pull running VMs from all projects on the local remote.
plugin: community.general.incus
filters:
  - type=virtual-machine
  - status=running

---
# Pull instances from two different remotes
plugin: community.general.incus
remotes:
  - remote-1
  - remote-2

---
# Pull instances from two different remotes
# Limiting the second to the default project
plugin: community.general.incus
remotes:
  - remote-1
  - remote-2:default

Авторы

Stéphane Graber (@stgraber)

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

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