nxos_ping - Тестирует доступность с помощью ping с коммутатора Nexus.

Новое в версии 2.1.

Обзор
Параметры
Примечания
Примеры
Значения возврата
Статус
Техническое обслуживание
- Поддержка
- Автор

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
count		Значение по умолчанию: 5	Количество пакетов для отправки.
dest обязательно			IP-адрес или имя хоста (разрешаемое коммутатором) удаленного узла.
provider			Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	host обязательно		Указывает имя DNS-хоста или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	port	Значение по умолчанию: "0 (использовать общий порт)"	Указывает порт для использования при построении соединения с удаленным устройством. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует соответствующему общему порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443).
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	authorize bool (добавлен в 2.5.3)	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	auth_pass (добавлен в 2.5.3)	Значение по умолчанию: "none"	Указывает пароль для использования, если требуется войти в привилегированный режим на удаленном устройстве. Если authorize false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	timeout (добавлен в 2.3)	Значение по умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечет до завершения операции, модуль выдаст ошибку. NX-API может быть медленным при возврате на длительных командах (sh mac, sh bgp и т. д.).
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	Значение по умолчанию: "cli"	Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_ssl bool	Варианты: no ← yes	Настраивает transport на использование SSL, если установлено значение true только в том случае, если `transport=nxapi`, в противном случае это значение игнорируется.
	validate_certs bool	Варианты: no yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не является nxapi, это значение игнорируется.
	use_proxy bool (добавлен в 2.5)	Варианты: no yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
source			Исходный IP-адрес или имя хоста (разрешаемое коммутатором)
state		Варианты: absent present ←	Определяет, является ли ожидаемый результат успешным или неудачным.
vrf			Выходящая ВРФ.

Примечания

Примечание

Для модуля сетевого назначения общего назначения см. модуль net_ping.
Для целей Windows используйте модуль win_ping.
Для целей, на которых работает Python, используйте модуль ping.
Дополнительная информация о работе с CLI и NX-API находится в руководстве NXOS Platform Options.
Дополнительная информация об использовании Ansible для управления сетевыми устройствами находится в руководстве Ansible Network Guide.
Дополнительная информация об использовании Ansible для управления устройствами Cisco находится на странице интеграции Cisco Cisco integration page.

Примеры

- name: Test reachability to 8.8.8.8 using mgmt vrf
  nxos_ping:
    dest: 8.8.8.8
    vrf: management
    host: 68.170.147.165

- name: Test reachability to a few different public IPs using mgmt vrf
  nxos_ping:
    dest: nxos_ping
    vrf: management
    host: 68.170.147.165
  with_items:
    - 8.8.8.8
    - 4.4.4.4
    - 198.6.1.4

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

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

Ключ	Возвращаемое значение	Описание
commands список	всегда	Отображает отправленную команду Пример: ['ping 8.8.8.8 count 2 vrf management']
packet_loss строка	всегда	Процент потерянных пакетов Пример: 0.00%
packets_rx целое число	всегда	Успешно полученные пакеты Пример: 2
packets_tx целое число	всегда	Успешно переданные пакеты Пример: 2
rtt словарь	всегда	Отображение статистики RTT Пример: {'avg': 6.264, 'max': 6.564, 'min': 5.978}

Состояние

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

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

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

Список других модулей, которые также поддерживаются командой Ansible Network Team, см. в разделе здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний

Автор

Jason Edelman (@jedelman8)
Gabriele Gerbino (@GGabriele)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/nxos_ping_module.html