Spec-Zone.ru › Ansible 2.10

junipernetworks.junos.junos_ping – Проверка доступности с помощью ping с устройств, работающих под управлением Juniper JUNOS

Примечание

Этот плагин является частью коллекции junipernetworks.junos (версия 1.2.1).

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

Для использования в книге задач укажите: junipernetworks.junos.junos_ping.

Новое в версии 1.0.0: of 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
строка
    Варианты:
  • cli
  • netconf ←
Конфигурирует транспортное соединение для использования при подключении к удалённому устройству.
username
строка
Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME.
size
целое число
Определяет размер (в байтах) пакета ping.
source
строка
IP-адрес для отправки пакета(ов) ping.
state
строка
    Варианты:
  • absent
  • present ←
Определяет, является ли ожидаемый результат успехом или неудачей.
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/junipernetworks/junos/junos_ping_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API