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

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).

Для установки используйте: ansible-galaxy collection install cisco.nxos.

Чтобы использовать его в плейбуке, укажите: cisco.nxos.nxos_ping.

Введено в версии 1.0.0: cisco.nxos

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
count целое число		Значение по умолчанию: 5	Количество пакетов для отправки.
dest строка / обязательный			IP-адрес или имя хоста (разрешаемый свитчем) удаленного узла.
provider словарь			Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6, рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удален в выпуске после 2022-06-01. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент не работает. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя DNS-хоста или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для подключения к удаленному устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию устанавливается на соответствующий стандартный порт транспорта, если не указано в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.).
	transport строка	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy логическое значение	Варианты: нет да ←	Если `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 строка			Выходящая VRF.

Примечания

Примечание

Для модуля сетевых операций общего назначения, см. модуль ansible.netcommon.net_ping.
Для целевых систем Windows используйте модуль ansible.windows.win_ping.
Для целевых систем с Python используйте модуль ansible.builtin.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
  cisco.nxos.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
  cisco.nxos.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}

Авторы

Джейсон Эдельман (@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.10/collections/cisco/nxos/nxos_ping_module.html