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 ложно, то этот аргумент не имеет эффекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
authorize bool		Варианты: нет ← да	Устарело Начиная с 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. Объект словаря, содержащий сведения о подключении.
	host обязательно		Указывает имя DNS-хоста или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	port	Значение по умолчанию: 22	Указывает порт для использования при построении соединения с удалённым устройством.
	username		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	timeout	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут будет превышен до завершения операции, модуль выдаст ошибку.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	authorize bool	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	auth_pass		Указывает пароль для использования, если требуется ввод привилегированного режима на удалённом устройстве. Если authorize ложно, то этот аргумент не имеет эффекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
source			Исходный IP-адрес.
state		Варианты: отсутствует присутствует ←	Определяет, является ли ожидаемый результат успехом или ошибкой.
vrf		Значение по умолчанию: "default"	VRF для переадресации.

Примечания

Примечание

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

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, которые также поддерживаются сообществом 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.6/modules/ios_ping_module.html