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

Примечание

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

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

Для использования в плейбуке укажите: cisco.nxos.nxos_ping.

Новое в версии 1.0.0: of cisco.nxos

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

Обзор

Тестирует доступность с помощью ping от коммутатора до удаленного узла назначения.
Для общего сетевого модуля см. модуль 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 равно false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения `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 строка		Варианты: absent present ←	Определяет, является ли ожидаемый результат успешным или неудачным.
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_ping_module.html