ansible.builtin.add_host – Добавление узла (и, альтернативно, группы) в кэш-инвентарь ansible-playbook

Примечание

Этот модуль является частью ansible-base и включён во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля add_host даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать полное имя (FQCN) для лёгкой ссылки на документацию модуля и для избежания конфликтов с другими коллекциями, которые могут иметь такое же имя модуля.

Новое в версии 0.9: из ansible.builtin

Описание
Параметры
Примечания
См. также
Примеры

Описание

Используйте переменные для создания новых узлов и групп в инвентаре для использования в последующих задачах одного и того же playbook.
Принимает переменные, позволяющие более полно определить новые узлы.
Этот модуль также поддерживает целевые узлы Windows.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
groups список / элементы=строка		Группы, к которым добавляется имя хоста. псевдонимы: group, groupname
name строка / обязательно		Имя хоста/IP узла для добавления в инвентарь, может содержать двоеточие и номер порта. псевдонимы: host, hostname

Примечания

Примечание

Этот модуль обходит цикл хостов в задаче и выполняется только один раз для всех хостов в задаче. Если вам нужно выполнить итерацию, используйте конструкцию loop. Если вам нужно динамически добавлять все узлы, на которые нацелен playbook, для последующего использования, модуль group_by может быть лучшим выбором.
Псевдоним host параметра name доступен только в Ansible 2.4 и более поздних версиях.
Начиная с Ansible 2.4, переменная inventory_dir теперь установлена в None, а не в «глобальном источнике инвентаря», потому что теперь вы можете иметь несколько источников. В примере показано, как частично восстановить предыдущее поведение.
Этот модуль поддерживает целевые узлы Windows.

См. также

ansible.builtin.group_by: Официальная документация модуля ansible.builtin.group_by.

Примеры

- name: Add host to group 'just_created' with variable foo=42
  add_host:
    name: '{{ ip_from_ec2 }}'
    groups: just_created
    foo: 42

- name: Add host to multiple groups
  add_host:
    hostname: '{{ new_ip }}'
    groups:
    - group1
    - group2

- name: Add a host with a non-standard port local to your machines
  add_host:
    name: '{{ new_ip }}:{{ new_port }}'

- name: Add a host alias that we reach through a tunnel (Ansible 1.9 and older)
  add_host:
    hostname: '{{ new_ip }}'
    ansible_ssh_host: '{{ inventory_hostname }}'
    ansible_ssh_port: '{{ new_port }}'

- name: Add a host alias that we reach through a tunnel (Ansible 2.0 and newer)
  add_host:
    hostname: '{{ new_ip }}'
    ansible_host: '{{ inventory_hostname }}'
    ansible_port: '{{ new_port }}'

- name: Ensure inventory vars are set to the same value as the inventory_hostname has (close to pre Ansible 2.4 behaviour)
  add_host:
    hostname: charlie
    inventory_dir: '{{ inventory_dir }}'

- name: Add all hosts running this playbook to the done group
  add_host:
    name: '{{ item }}'
    groups: done
  loop: "{{ ansible_play_hosts }}"

Авторы

Команда Ansible Core
Seth Vidal (@skvidal)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/add_host_module.html