Spec-Zone.ru › Ansible 2.4

ios_ping - Тестирование доступности с помощью пинга с коммутатора IOS

Новое в версии 2.4.

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

Обзор

  • Тестирует доступность с помощью пинга с коммутатора до удаленного назначения.

Параметры

параметр обязательный по умолчанию варианты комментарии
auth_pass
нет нет
Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
count
нет 5
Количество пакетов для отправки.
dest
да
IP-адрес или имя хоста (разрешаемый коммутатором) удаленного узла.
provider
нет
Объект словаря, содержащий данные подключения.
Объект словаря provider
параметр обязательный по умолчанию варианты комментарии
username
нет
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
auth_pass
нет нет
Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
host
да
Указывает имя DNS-хоста или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
timeout
нет 10
Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
password
нет
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт для подключения к удаленному устройству.
source
нет
Исходный IP-адрес.
state
нет present
  • absent
  • present
Определяет, является ли ожидаемый результат успешным или неуспешным.
vrf
нет default
VRF для переадресации.

Примеры

- provider:
    host: "{{ ansible_host }}"
    username: "{{ username }}"
    password: "{{ password }}"

- name: Test reachability to 10.10.10.10 using default vrf
  ios_ping:
    provider: "{{ provider }}"
    dest: 10.10.10.10

- name: Test reachability to 10.20.20.20 using prod vrf
  ios_ping:
    provider: "{{ provider }}"
    dest: 10.20.20.20
    vrf: prod

- name: Test unreachability to 10.30.30.30 using default vrf
  ios_ping:
    provider: "{{ provider }}"
    dest: 10.30.30.30
    state: absent

- name: Test reachability to 10.40.40.40 using prod vrf and setting count and source
  ios_ping:
    provider: "{{ provider }}"
    dest: 10.40.40.40
    source: loopback0
    vrf: prod
    count: 20

Возвращаемые значения

Общие значения, возвращаемые модулем, описаны здесь Возвращаемые значения. Следующие поля уникальны для этого модуля:

имя описание возвращается тип пример
commands
Отображает отправленные команды.
всегда список ['ping vrf prod 10.40.40.40 count 20 source loopback0']
packet_loss
Процент потерянных пакетов.
всегда строка 0%
packets_rx
Успешно полученные пакеты.
всегда целое число 20
packets_tx
Успешно отправленные пакеты.
всегда целое число 20
rtt
Отображение статистики RTT.
всегда словарь {'max': 8, 'avg': 2, 'min': 1}

Статус

Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратимый.

Для получения помощи в разработке модулей ознакомьтесь со статьей Информация о сообществе и участие, Тестирование 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/ios_ping_module.html

Spec-Zone.ru

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