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

Примечание

Этот плагин входит в состав коллекции cisco.ios (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install cisco.ios

Для использования в книге задач, укажите: cisco.ios.ios_ping

Новый в версии 1.0.0: модуля cisco.ios

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

Обзор

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
count целое число			Количество пакетов для отправки.
dest строка / обязательно			IP-адрес или имя хоста (разрешаемое коммутатором) удалённого узла.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` Для получения дополнительной информации, пожалуйста, обратитесь к руководству по параметрам платформы IOS IOS Platform Options guide. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для использования, если требуется ввод привилегированного режима на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`
	authorize логическое значение	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`
	port целое число		Указывает порт для создания подключения к удалённому устройству.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`
	timeout целое число		Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль выдаст ошибку.
	username строка		Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`
source строка			IP-адрес источника.
state строка		Варианты: отсутствует наличие ←	Определяет, является ли ожидаемый результат успехом или ошибкой.
vrf строка			VRF для переадресации.

Примечания

Примечание

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

Примеры

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

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

- name: Test unreachability to 10.30.30.30 using default vrf
  cisco.ios.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
  cisco.ios.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}

Авторы

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.10/collections/cisco/ios/ios_ping_module.html