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

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

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

Обзор

Проверка доступности с помощью ping от коммутатора до удаленного назначения.
Для модуля сетевых операций общего назначения, см. модуль 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 -		Варианты: absent present ←	Определяет, является ли ожидаемым результатом успех или неудача.
vrf -		Значение по умолчанию: "default"	VRF для переадресации.

Примечания

Примечание

Для модуля сетевых операций общего назначения, см. модуль net_ping.
Для целей Windows, используйте модуль win_ping.
Для целей Python, используйте модуль ping.
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, см. Руководство по Ansible для сети
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco, см. страницу интеграции 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}

Статус

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

Авторы

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