vyos_ping – Тестирование доступности с помощью ping от устройств сети VyOS

Новая версия 2.8.

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

Обзор

Тестирует доступность с помощью ping от устройства VyOS до удаленного узла.
Проверено на VyOS 1.1.8 (helium)
Для модуля сети общего назначения см. модуль net_ping.
Для целей Windows используйте модуль win_ping.
Для целей Python используйте модуль ping.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
count целое число		По умолчанию: 5	Количество пакетов для отправки для проверки доступности.
dest - / обязательный			IP-адрес или имя хоста (разрешаемый устройством) удаленного узла.
interval целое число			Определяет интервал (в секундах) между последовательными ping.
provider словарь			Устаревшее Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий сведения о соединении.
	host строка / обязательный		Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу передачи. Значение host используется в качестве адреса назначения для протокола передачи.
	password строка		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число	По умолчанию: 22	Указывает порт для создания подключения к удаленному устройству.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	По умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
	username строка		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
size целое число			Определяет размер (в байтах) пакета ping.
source -			Источник интерфейса или IP-адрес для использования при отправке пакета ping.
state -		Варианты: отсутствует наличие ←	Определяет, является ожидаемый результат успехом или ошибкой.
ttl целое число			Значение времени жизни для ICMP-пакета.

Примечания

Примечание

Проверено на VyOS 1.1.8 (helium).
Для модуля сети общего назначения см. модуль net_ping.
Для целей Windows используйте модуль win_ping.
Для целей Python используйте модуль ping.
Этот модуль работает с подключением network_cli. См. Варианты платформы VyOS.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible.

Примеры

- name: Test reachability to 10.10.10.10
  vyos_ping:
    dest: 10.10.10.10

- name: Test reachability to 10.20.20.20 using source and ttl set
  vyos_ping:
    dest: 10.20.20.20
    source: eth0
    ttl: 128

- name: Test unreachability to 10.30.30.30 using interval
  vyos_ping:
    dest: 10.30.30.30
    interval: 3
    state: absent

- name: Test reachability to 10.40.40.40 setting count and source
  vyos_ping:
    dest: 10.40.40.40
    source: eth1
    count: 20
    size: 512

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

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

Ключ	Возвращаемое значение	Описание
commands список	всегда	Список отправленных команд. Пример: ['ping 10.8.38.44 count 10 interface eth0 ttl 128']
packet_loss строка	всегда	Процент потерянных пакетов. Пример: 0%
packets_rx целое число	всегда	Успешно полученные пакеты. Пример: 20
packets_tx целое число	всегда	Успешно отправленные пакеты. Пример: 20
rtt словарь	при успешном ping	Статистика времени прохождения (RTT). Пример: {'avg': 2, 'max': 8, 'min': 1, 'mdev': 24}

Статус

Для данного модуля не гарантируется обратная совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Nilashish Chakraborty (@NilashishC)

Подсказка

Если вы заметите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

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