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

Примечание

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

Для его установки используйте: 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-адрес или имя хоста (разрешимый коммутатором) удаленного узла.
df_bit логический тип		Варианты: нет ← да	Установить бит DF.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в руководстве IOS Platform Options. Объект словаря, содержащий сведения о подключении.
	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`.
size целое число			Размер отправляемых пакетов.
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

- name: Test reachability to 10.50.50.50 using df-bit and size
  cisco.ios.ios_ping:
    dest: 10.50.50.50
    df_bit: true
    size: 1400

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/ios/ios_ping_module.html