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

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Поддержка
- Автор

Описание

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

Параметры

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

Примечания

Примечание

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

Примеры

- 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 Пример: {'max': 6.564, 'avg': 6.264, 'min': 5.978}

Статус

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

Поддержка

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

Автор

Джейсон Эдельман (@jedelman8)
Габриэле Гербино (@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.5/modules/nxos_ping_module.html