ansible.builtin.yaml inventory – использует определённый файл YAML в качестве источника инвентаризации.

Примечание

Этот плагин инвентаризации входит в состав ansible-core и включён во все установки Ansible. В большинстве случаев можно использовать короткое имя плагина yaml. Однако для удобного перехода к документации плагина и во избежание конфликтов с другими коллекциями, в которых может быть плагин инвентаризации с таким же именем, рекомендуем использовать полное имя коллекции (FQCN) ansible.builtin.yaml.

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

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

Инвентаризация на основе YAML должна начинаться с группы all и содержать записи hosts/vars/children.
Записи хостов могут содержать вложенные записи, которые будут рассматриваться как переменные.
Записи vars — это обычные переменные группы.
Children — это «дочерние группы», которые также могут содержать собственные vars/hosts/children и так далее.
Файл ДОЛЖЕН иметь допустимое расширение, указанное в конфигурации.

Параметры

Параметр	Комментарии
yaml_extensions list / elements=string	список «допустимых» расширений для файлов, содержащих YAML По умолчанию: `[".yaml", ".yml", ".json"]` Конфигурация: Записи INI: [defaults] yaml_valid_extensions = .yaml, .yml, .json [inventory_plugin_yaml] yaml_valid_extensions = .yaml, .yml, .json Переменная окружения: `ANSIBLE_YAML_FILENAME_EXT` Переменная окружения: `ANSIBLE_INVENTORY_PLUGIN_EXTS`

Параметр

Комментарии

yaml_extensions

list / elements=string

список «допустимых» расширений для файлов, содержащих YAML

По умолчанию: [".yaml", ".yml", ".json"]

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

Записи INI:

[defaults]
yaml_valid_extensions = .yaml, .yml, .json

[inventory_plugin_yaml]
yaml_valid_extensions = .yaml, .yml, .json

Переменная окружения: ANSIBLE_YAML_FILENAME_EXT
Переменная окружения: ANSIBLE_INVENTORY_PLUGIN_EXTS

Примечание

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

Примечания

Примечание

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

Примеры

all: # keys must be unique, i.e. only one 'hosts' per group
    hosts:
        test1:
        test2:
            host_var: value
    vars:
        group_all_var: value
    children:   # key order does not matter, indentation does
        other_group:
            children:
                group_x:
                    hosts:
                        test5   # Note that one machine will work without a colon
                #group_x:
                #    hosts:
                #        test5  # But this won't
                #        test7  #
                group_y:
                    hosts:
                        test6:  # So always use a colon
            vars:
                g2_var2: value3
            hosts:
                test4:
                    ansible_host: 127.0.0.1
        last_group:
            hosts:
                test1 # same host as above, additional group membership
            vars:
                group_last_var: value

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

© 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/ansible/builtin/yaml_inventory.html