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. Объект словаря, содержащий данные подключения.
	auth_pass - добавлено в 2.5.3	Значение по умолчанию: "none"	Указывает пароль для использования при необходимости перехода в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлено в 2.5.3	Варианты: нет ← да	Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола.
	password -		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для протоколов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port -	Значение по умолчанию: "0 (использовать стандартный порт)"	Указывает порт для использования при создании подключения к удалённому устройству. Это значение относится к протоколам cli или nxapi. Значение порта будет по умолчанию соответствовать стандартному порту протокола, если он не предоставлен в задаче. (cli=22, http=80, https=443).
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для протокола cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout - добавлено в 2.3	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т.д.).
	transport - / обязательно	Значение по умолчанию: "cli"	Настраивает транспортное соединение для использования при подключении к удалённому устройству. Аргумент транспорт поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy boolean добавлено в 2.5	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: нет ← да	Настраивает transport для использования SSL, если значение равно true, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username -		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого протокола. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: нет да	Если `no`, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не 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 https://www.ansible.com/integrations/networks/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 Пример: {'avg': 6.264, 'max': 6.564, 'min': 5.978}

Статус

Данному модулю не гарантируется обратная совместимость. [превью]
Этот модуль поддерживается командой Ansible Network Team. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в этой статье базы знаний 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.7/modules/nxos_ping_module.html