ansible.netcommon.net_ping – Тестирование доступности с помощью пинга с сетевого устройства

Примечание

Этот плагин входит в состав коллекции ansible.netcommon (версия 1.4.1).

Для его установки используйте: ansible-galaxy collection install ansible.netcommon.

Чтобы использовать его в книге задач, укажите: ansible.netcommon.net_ping.

Новое в версии 1.0.0: of ansible.netcommon

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Тестирует доступность с помощью пинга с сетевого устройства до удалённого узла.
Для целевых систем Windows используйте модуль ansible.windows.win_ping вместо этого.
Для целевых систем с Python используйте модуль ansible.builtin.ping вместо этого.

Примечание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
count строка	Значение по умолчанию: 5	Количество пакетов для отправки.
dest строка / обязательный		IP-адрес или имя хоста (разрешаемого коммутатором) удалённого узла.
source строка		IP-адрес источника.
state строка	Варианты: absent present ←	Определяет, является ли ожидаемый результат успехом или неудачей.
vrf строка	Значение по умолчанию: "default"	VRF для использования при пересылке.

Примечания

Примечание

Для целевых систем Windows используйте модуль ansible.windows.win_ping вместо этого.
Для целевых систем с Python используйте модуль ansible.builtin.ping вместо этого.
Этот модуль поддерживается на ansible_network_os сетевых платформах. Подробности см. в разделе Варианты сетевых платформ.

Примеры

- name: Test reachability to 10.10.10.10 using default vrf
  ansible.netcommon.net_ping:
    dest: 10.10.10.10

- name: Test reachability to 10.20.20.20 using prod vrf
  ansible.netcommon.net_ping:
    dest: 10.20.20.20
    vrf: prod

- name: Test unreachability to 10.30.30.30 using default vrf
  ansible.netcommon.net_ping:
    dest: 10.30.30.30
    state: absent

- name: Test reachability to 10.40.40.40 using prod vrf and setting count and source
  ansible.netcommon.net_ping:
    dest: 10.40.40.40
    source: loopback0
    vrf: prod
    count: 20

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

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

Ключ	Возвращаемое значение	Описание
commands список / элементы=строка	всегда	Показать отправленный командный запрос. Пример: ['ping vrf prod 10.40.40.40 count 20 source loopback0']
packet_loss строка	всегда	Процент потерянных пакетов. Пример: 0%
packets_rx целое число	всегда	Успешно полученные пакеты. Пример: 20
packets_tx целое число	всегда	Успешно отправленные пакеты. Пример: 20
rtt словарь	всегда	Показать статистику RTT. Пример: {'avg': 2, 'max': 8, 'min': 1}

Авторы

Jacob McGill (@jmcgill298)

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