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`. Для получения дополнительной информации см. Руководство по сети. Объект dict, содержащий данные подключения.
	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 -		Варианты: absent present ←	Определяет, ожидается ли успешный или неудачный результат.
ttl целое число			Значение времени жизни для пакета ICMP.

Примечания

Примечание

Для модуля сети общего назначения см. модуль net_ping.
Для целевых систем Windows используйте модуль win_ping.
Для целевых систем с Python используйте модуль ping.
Для получения дополнительной информации об использовании 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.8/modules/vyos_ping_module.html