ios_ping – Проверка доступности с помощью пинга устройств сети Cisco IOS
Новая версия с 2.4.
Описание
- Проверка доступности с помощью пинга от коммутатора до удаленного узла.
- Для модуля сетевых операций общего назначения, см. модуль net_ping.
- Для целей Windows, используйте модуль win_ping.
- Для целей Python, используйте модуль ping.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass - | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Для получения дополнительной информации, обратитесь к руководству IOS Platform Options. Указывает пароль, используемый для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации, обратитесь к руководству IOS Platform Options. Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| count - | По умолчанию: 5 | Количество пакетов для отправки. | |
| dest - / обязательно | IP-адрес или имя хоста (разрешаемое коммутатором) удаленного узла. | ||
| provider - | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации, обратитесь к руководству IOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль, используемый для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password - | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port - | По умолчанию: 22 | Указывает порт для подключения к удаленному устройству. | |
| ssh_keyfile - | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль возвращает ошибку. | |
| username - | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| source - | Исходный IP-адрес. | ||
| state - |
| Определяет, является ли ожидаемый результат успехом или ошибкой. | |
| vrf - | По умолчанию: "default" | VRF для маршрутизации. | |
Примечания
Примечание
- Для модуля сети общего назначения см. модуль net_ping.
- Для целей Windows используйте модуль win_ping.
- Для целей Python используйте модуль ping.
- Дополнительную информацию об управлении сетевыми устройствами с помощью Ansible см. в Руководстве по сети Ansible.
- Дополнительную информацию об управлении устройствами Cisco с помощью Ansible см. на странице интеграции Cisco.
Примеры
- name: Test reachability to 10.10.10.10 using default vrf
ios_ping:
dest: 10.10.10.10
- name: Test reachability to 10.20.20.20 using prod vrf
ios_ping:
dest: 10.20.20.20
vrf: prod
- name: Test unreachability to 10.30.30.30 using default vrf
ios_ping:
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:
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. Пример: {'avg': 2, 'max': 8, 'min': 1} |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Jacob McGill (@jmcgill298)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ios_ping_module.html
