ios_ping – Проверка доступности с помощью пинга устройств сети Cisco IOS

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_pass строка			Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes` с `become_pass`. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
authorize логическое значение		Варианты: no ← yes	Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes`. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
count -		По умолчанию: 5	Количество пакетов для отправки.
dest - / обязательно			IP-адрес или имя хоста (разрешаемое коммутатором) удалённого узла.
provider словарь			Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в руководстве IOS Platform Options. Объект словаря, содержащий детали подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	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`.
source -			IP-адрес источника.
state -		Варианты: отсутствует присутствует ←	Определяет, ожидаемый результат — успех или неудача.
vrf -		По умолчанию: "default"	VRF для переадресации.

Примечания

Примечание

Для модуля сетевых операций общего назначения, см. модуль net_ping.
Для целей Windows, используйте модуль win_ping вместо него.
Для целей с Python, используйте модуль ping вместо него.
Для получения дополнительной информации об управлении сетевыми устройствами с помощью Ansible, см. Руководство по Ansible Network.
Для получения дополнительной информации об управлении устройствами Cisco с помощью Ansible, см. страницу интеграции Cisco.

Примеры

- name: Test reachability to 10.10.10.10 using default vrf
  ios_ping:
    dest: 10.10.10.10

- name: Test reachability to 10.20.20.20 using prod vrf
  ios_ping:
    dest: 10.20.20.20
    vrf: prod

- name: Test unreachability to 10.30.30.30 using default vrf
  ios_ping:
    dest: 10.30.30.30
    state: absent

- name: Test reachability to 10.40.40.40 using prod vrf and setting count and source
  ios_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}

Статус

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

Авторы

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.8/modules/ios_ping_module.html