iosxr_facts - Сбор фактов с удалённых устройств, работающих под IOS XR
Новое в версии 2.2.
Обзор
- Собирает базовый набор фактов устройства с удалённого устройства, работающего под IOS XR. Этот модуль добавляет ко всем основным ключам фактов сети префикс
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ncclient >= 0.5.3 при использовании netconf
- lxml >= 4.1.1 при использовании netconf
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_subset | Значение по умолчанию: !config | При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают all, hardware, config и interfaces. Можно указать список значений для включения более широкого подмножества. Значения также можно использовать с начальным ! для указания того, что определённое подмножество не должно собираться. | |
| provider | Значение по умолчанию: None | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации, пожалуйста, обратитесь к Руководству по сети. Объект словаря, содержащий детали подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | |
| password | Значение по умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| port | Значение по умолчанию: 22 | Указывает порт, используемый при построении подключения к удалённому устройству. | |
Примечания
Примечание
- Тестировалось на IOS XRv 6.1.2
- Этот модуль не поддерживает подключение netconf
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, обратитесь к Руководству по Ansible для сети
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco обратитесь к странице интеграции Cisco.
Примеры
# Collect all facts from the device
- iosxr_facts:
gather_subset: all
# Collect only the config and default facts
- iosxr_facts:
gather_subset:
- config
# Do not collect hardware facts
- iosxr_facts:
gather_subset:
- "!hardware"
Возвращаемые значения
Общие значения возврата документированы здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список | при настройке interfaces | Все IPv4-адреса, настроенные на устройстве |
| ansible_net_all_ipv6_addresses список | при настройке interfaces | Все IPv6-адреса, настроенные на устройстве |
| ansible_net_config строка | при настройке config | Текущая активная конфигурация с устройства |
| ansible_net_filesystems список | при настройке hardware | Все имена файловых систем, доступные на устройстве |
| ansible_net_gather_subset список | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_hostname строка | всегда | Настроенное имя хоста устройства |
| ansible_net_image строка | всегда | Файл образа, под которым работает устройство |
| ansible_net_interfaces словарь | при настройке interfaces | Хэш всех интерфейсов, работающих в системе |
| ansible_net_memfree_mb целое число | при настройке hardware | Доступная свободная память на удалённом устройстве в Мб |
| ansible_net_memtotal_mb целое число | при настройке hardware | Общая память на удалённом устройстве в Мб |
| ansible_net_neighbors словарь | при настройке interfaces | Список LLDP-соседей с удалённого устройства |
| ansible_net_version строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Поддержка
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, пожалуйста, обратитесь к этой статье базы знаний.
Автор
- Ricardo Carrillo Cruz (@rcarrillocruz)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете редактировать этот документ, чтобы улучшить его.
© 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/iosxr_facts_module.html
