junipernetworks.junos.junos_ping – Тестирование доступности с помощью ping с устройств, работающих под управлением Juniper JUNOS
Примечание
Этот плагин является частью коллекции junipernetworks.junos (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install junipernetworks.junos.
Для использования в книге задач укажите: junipernetworks.junos.junos_ping.
Новый в версии 1.0.0: коллекции junipernetworks.junos
Описание
- Тестирует доступность с помощью ping с устройств, работающих под управлением Juniper JUNOS, до удаленного узла.
- Тестируется на Junos (17.3R1.10)
- Для модуля общей сети см. модуль ansible.netcommon.net_ping.
- Для целевых платформ Windows используйте модуль ansible.windows.win_ping.
- Для целей, работающих на Python, используйте модуль ansible.builtin.ping.
Примечание
Этот модуль имеет соответствующий плагин действия.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| count целое число | Значение по умолчанию: 5 | Количество пакетов для отправки, чтобы проверить доступность. | |
| dest строка / обязательный | IP-адрес или имя хоста (разрешаемый устройством) удаленного узла. | ||
| interface строка | Интерфейс источника для отправки пакета(ов) ping. | ||
| interval целое число | Определяет интервал (в секундах) между последовательными ping-запросами. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli или connection: netconf.Дополнительную информацию см. в руководстве Junos OS Platform Options. Объект словаря, содержащий данные подключения. | ||
| host строка | Указывает имя или адрес хоста DNS для подключения к удаленному устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для подключения к удаленному устройству. Значение порта по умолчанию равно общеизвестному SSH-порту 22 (для transport=cli) или порту 830 (для transport=netconf) устройства. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернет ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| size целое число | Определяет размер (в байтах) пакета(ов) ping. | ||
| source строка | IP-адрес, используемый для отправки пакета(ов) ping. | ||
| state строка |
| Определяет, является ли ожидаемый результат успехом или ошибкой. | |
| ttl целое число | Значение time-to-live для пакета(ов) ICMP. | ||
Примечания
Примечание
- Для модуля общей сети см. модуль ansible.netcommon..net_ping.
- Для целевых платформ Windows используйте модуль ansible.windows.win_ping.
- Для целей, работающих на Python, используйте модуль ansible.builtin.ping.
- Этот модуль работает только с подключением
network_cli. - Дополнительную информацию об использовании CLI и netconf см. в руководстве Junos OS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами сети Juniper см. в https://www.ansible.com/ansible-juniper.
Примеры
- name: Test reachability to 10.10.10.10
junipernetworks.junos.junos_ping:
dest: 10.10.10.10
- name: Test reachability to 10.20.20.20 using source and size set
junipernetworks.junos.junos_ping:
dest: 10.20.20.20
size: 1024
ttl: 128
- name: Test unreachability to 10.30.30.30 using interval
junipernetworks.junos.junos_ping:
dest: 10.30.30.30
interval: 3
state: absent
- name: Test reachability to 10.40.40.40 setting count and interface
junipernetworks.junos.junos_ping:
dest: 10.40.40.40
interface: fxp0
count: 20
size: 512
Возвращаемые значения
Общие возвращаемые значения описаны в документации, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Список отправленных команд. Пример: ['ping 10.8.38.44 count 10 source 10.8.38.38 ttl 128'] |
| packet_loss строка | всегда | Процент потерянных пакетов. Пример: 0% |
| packets_rx целое число | всегда | Успешно полученные пакеты. Пример: 20 |
| packets_tx целое число | всегда | Успешно отправленные пакеты. Пример: 20 |
| rtt словарь | при успешном ping | Статистика времени туда и обратно (RTT). Пример: {'avg': 2, 'max': 8, 'min': 1, 'stddev': 24} |
Авторы
- Nilashish Chakraborty (@NilashishC)
© 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/junipernetworks/junos/junos_ping_module.html