nxos_ping - Проверка доступности с помощью ping с коммутатора Nexus.
Новая версия 2.1.
Описание
- Проверяет доступность с помощью ping с коммутатора до удалённого узла.
Параметры
| параметр | обязательно | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| auth_pass (добавлен в 2.4.4)
| нет | нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлен в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| count | нет | 2 | Количество пакетов для отправки. | |
| dest | да | IP-адрес или имя хоста (разрешаемое коммутатором) удалённого узла. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту транспорта, если в задаче не указано иное. (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передать все аргументы nxos в виде объекта dict. Все ограничения (обязательность, допустимые значения и т. д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом dict. | ||
| source | нет | IP-адрес источника. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | present |
| Определяет, является ли ожидаемым результатом успех или неудача. |
| timeout (добавлен в 2.3)
| нет | 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает transport на использование SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на управляемых сайтах с использованием самозаверяющих сертификатов. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| vrf | нет | Выходящая VRF. |
Примеры
- 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 | всегда | словарь | {'max': 6.564, 'avg': 6.264, 'min': 5.978} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если вы захотите, пожалуйста, ознакомьтесь с Информацией и сотрудничеством сообщества, Тестированием Ansible и Разработкой модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_ping_module.html
