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

Примечание

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

Добавлен в версии 1.2: модуля ansible.builtin

Обзор
Параметры
Примечания
См. также
Примеры

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
free_form строка / обязательно	Варианты: clear_facts clear_host_errors end_host end_play flush_handlers noop refresh_inventory reset_connection	Этот модуль принимает команду в свободном формате в виде строки. Нет фактического параметра "free form". Смотрите примеры! `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

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