ansible.builtin.meta – Выполнение Ansible «действий»

Примечание

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

Новое в версии 1.2: of ansible.builtin

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

Описание

Задачи meta – это особый вид задач, которые могут влиять на внутреннее выполнение или состояние Ansible.
Задачи meta могут быть использованы в любом месте вашего плейбука.
Этот модуль также поддерживается для целевых платформ Windows.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
free_form строка / обязательно	Варианты: clear_facts clear_host_errors end_host end_play flush_handlers noop refresh_inventory reset_connection	Этот модуль принимает команду в свободном формате в виде строки. Нет фактического параметра "свободный формат". Смотрите примеры! `flush_handlers` заставляет Ansible выполнить все задачи обработчиков, которые были уведомлены до этого момента. Ansible вставляет эти задачи внутри в определённые моменты, чтобы неявно запускать выполнение обработчиков (после задач pre/post, после выполнения последнего роли, и в разделе основных задач вашего плейбука). `refresh_inventory` (добавлено в Ansible 2.0) принудительно перезагружает инвентаризацию, что в случае с динамическими скриптами инвентаризации означает, что они будут повторно выполнены. Если динамический скрипт инвентаризации использует кэш, Ansible об этом не знает и не может его обновить (вы можете отключить кэш или, если доступно для вашего конкретного источника инвентаризации (например, aws), вы можете использовать плагин инвентаризации вместо скрипта инвентаризации). Это полезно в основном в тех случаях, когда создаются дополнительные хосты, и пользователи хотят использовать их вместо использования модуля ansible.builtin.add_host. `noop` (добавлено в Ansible 2.0) Буквально ничего не делает. Используется в основном внутри и не рекомендуется для общего использования. `clear_facts` (добавлено в Ansible 2.1) очищает собранные факты для хостов, указанных в списке хостов плейбука, включая кэш фактов. `clear_host_errors` (добавлено в Ansible 2.1) очищает состояние ошибки (если таковое имеется) для хостов, указанных в списке хостов плейбука. `end_play` (добавлено в Ansible 2.2) завершает плейбук без завершения хоста(ов) с ошибкой. Обратите внимание, что это влияет на все хосты. `reset_connection` (добавлено в Ansible 2.3) прерывает постоянное соединение (например, ssh + сохранение соединения) `end_host` (добавлено в Ansible 2.8) – вариация по хостам для `end_play`. Завершает плейбук для текущего хоста без вывода ошибки.

Примечания

Примечание

meta фактически не является модулем или плагином action_plugin, и его нельзя перезаписать.
clear_facts удалит постоянные факты из ansible.builtin.set_fact с использованием cacheable=True, но не текущую переменную хоста, созданную для текущего выполнения.
Использование циклов на задачах meta не поддерживается.
Пропуск задач meta с тегами не поддерживается до Ansible 2.11.
Этот модуль также поддерживается для целевых платформ Windows.

См. также

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

Примеры

# Example showing flushing handlers on demand, not at end of play
- template:
    src: new.j2
    dest: /etc/config.txt
  notify: myhandler

- name: Force all notified handlers to run at this point, not waiting for normal sync points
  meta: flush_handlers

# Example showing how to refresh inventory during play
- name: Reload inventory, useful with dynamic inventories when play makes changes to the existing hosts
  cloud_guest:            # this is fake module
    name: newhost
    state: present

- name: Refresh inventory to ensure new instances exist in inventory
  meta: refresh_inventory

# Example showing how to clear all existing facts of targetted hosts
- name: Clear gathered facts from all currently targeted hosts
  meta: clear_facts

# Example showing how to continue using a failed target
- name: Bring host back to play after failure
  copy:
    src: file
    dest: /etc/file
  remote_user: imightnothavepermission

- meta: clear_host_errors

# Example showing how to reset an existing connection
- user:
    name: '{{ ansible_user }}'
    groups: input

- name: Reset ssh connection to allow user changes to affect 'current login user'
  meta: reset_connection

# Example showing how to end the play for specific targets
- name: End the play for hosts that run CentOS 6
  meta: end_host
  when:
  - ansible_distribution == 'CentOS'
  - ansible_distribution_major_version == '6'

Авторы

Команда Ansible Core

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