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

Описание
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

Тестирует доступность с помощью 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		Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это требуется. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize булево добавлено в 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 целое число	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.).
	transport строка / обязательно	Варианты: cli ← nxapi	Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy булево добавлено в 2.5	Варианты: нет да ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl булево	Варианты: нет ← да	Настраивает transport для использования SSL, если установлено значение `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	validate_certs булево	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
source -			IP-адрес источника или имя хоста (разрешаемое коммутатором)
state -		Варианты: отсутствует присутствует ←	Определяет, ожидается успех или неудача.
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 list	всегда	Отображает отправленную команду Пример: ['ping 8.8.8.8 count 2 vrf management']
packet_loss string	всегда	Процент потерянных пакетов Пример: 0.00%
packets_rx integer	всегда	Успешно полученные пакеты Пример: 2
packets_tx integer	всегда	Успешно переданные пакеты Пример: 2
rtt dictionary	всегда	Отображает статистику RTT Пример: {'avg': 6.264, 'max': 6.564, 'min': 5.978}

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Данный модуль поддерживается сообществом Ansible. [community]

Авторы

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