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 | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: 22 | Указывает порт, который следует использовать при построении подключения к удалённому устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
Примечания
Примечание
- Тестировалось с 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 строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется как обратной совместимый.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по сетям. Дополнительная информация см. в Поддержка и техническое обслуживание модулей.
Список других модулей, также поддерживаемых командой Ansible по сетям, см. здесь.
Поддержка
Для получения дополнительной информации о поддержке данного модуля компанией 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.6/modules/iosxr_facts_module.html
