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		Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если 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 целое число добавлено в 2.3	По умолчанию: 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 -		Варианты: 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 Пример: {'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.8/modules/nxos_ping_module.html