ios_ping - Тестирование доступности с помощью ping от сетевых устройств Cisco IOS
Новое в версии 2.4.
Описание
- Тестирует доступность с помощью ping от коммутатора до удаленного узла назначения.
- Для модуля общего назначения по работе с сетью см. модуль 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 |
| Устарело Начиная с 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. Объект словаря, содержащий данные подключения. | |
| 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 |
| Определяет, ожидается успех или неудача. | |
| vrf | По умолчанию: default | VRF для переадресации. | |
Примечания
Примечание
- Для модуля общего назначения по работе с сетью см. модуль net_ping.
- Для целей Windows используйте модуль win_ping.
- Для целей Python используйте модуль ping.
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible по сетям
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции 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. Пример: {'max': 8, 'avg': 2, 'min': 1} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/ios_ping_module.html
