ansible.builtin.ping – Попытка подключения к хосту, проверка работоспособности Python и возврат «pong» при успехе

Примечание

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

Описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Этот тривиальный модуль проверки всегда возвращает pong при успешном подключении. Он не имеет смысла в playbooks, но полезен для /usr/bin/ansible проверки возможности входа и работоспособности Python.
Это НЕ ICMP-пингование, а просто тривиальный модуль проверки, требующий Python на удалённом узле.
Для целевых систем Windows используйте модуль ansible.windows.win_ping вместо него.
Для сетевых целей используйте модуль ansible.netcommon.net_ping вместо него.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
data строка	Значение по умолчанию: "pong"	Данные, возвращаемые для значения возврата `ping`. Если этот параметр установлен на `crash`, модуль вызовет исключение.

Примечания

Примечание

Поддерживает check_mode.

См. также

ansible.netcommon.net_ping: Официальная документация по модулю ansible.netcommon.net_ping.
ansible.windows.win_ping: Официальная документация по модулю ansible.windows.win_ping.

Примеры

# Test we can logon to 'webservers' and execute python with json lib.
# ansible webservers -m ping

- name: Example from an Ansible Playbook
  ansible.builtin.ping:

- name: Induce an exception to see what happens
  ansible.builtin.ping:
    data: crash

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращённое значение	Описание
ping строка	success	Значение, предоставленное с параметром data. Пример: pong

Авторы

Команда Ansible Core
Michael DeHaan

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