cisco.iosxr.iosxr_facts – Получение фактов об устройствах iosxr.
Примечание
Этот плагин входит в коллекцию cisco.iosxr (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install cisco.iosxr.
Чтобы использовать его в книге задач, укажите: cisco.iosxr.iosxr_facts.
Новое в версии 1.0.0: cisco.iosxr
Обзор
- Сбор фактов с сетевых устройств, работающих под управлением операционной системы iosxr. Этот модуль помещает собранные факты в дерево фактов, используя в качестве ключа имя соответствующего ресурса. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Примечание
У данного модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_network_resources список / элементы=строка | При указании данного аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, lacp и т.д. Можно указать список значений для включения большего подмножества. Значения также могут быть использованы с начальным ! для указания того, что определенное подмножество не должно быть собрано. Допустимые подмножества: 'все', 'lacp', 'lacp_interfaces', 'lldp_global', 'lldp_interfaces', 'interfaces', 'l2_interfaces', 'l3_interfaces', 'lag_interfaces', 'acls', 'acl_interfaces', 'static_routes', 'ospfv2'. | ||
| gather_subset список / элементы=строка | По умолчанию: "!config" | При указании данного аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все, аппаратные средства, конфигурацию и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут быть использованы с начальным ! для указания того, что определенное подмножество не должно быть собрано. | |
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий сведения о подключении. | ||
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для создания подключения к удаленному устройству. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение - путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Указывает тип подключения по транспорту. | |
| username строка | Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_USERNAME. | ||
Примечания
Примечание
- Тестировано на IOS-XR 6.1.3.
- Этот модуль работает с подключением
network_cli. Смотрите варианты платформы IOS-XR. - Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible.
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.
Примеры
# Gather all facts
- cisco.iosxr.iosxr_facts:
gather_subset: all
gather_network_resources: all
# Collect only the config and default facts
- cisco.iosxr.iosxr_facts:
gather_subset:
- config
# Do not collect hardware facts
- cisco.iosxr.iosxr_facts:
gather_subset:
- '!hardware'
# Collect only the lacp facts
- cisco.iosxr.iosxr_facts:
gather_subset:
- '!all'
- '!min'
gather_network_resources:
- lacp
# Do not collect lacp_interfaces facts
- cisco.iosxr.iosxr_facts:
gather_network_resources:
- '!lacp_interfaces'
# Collect lacp and minimal default facts
- cisco.iosxr.iosxr_facts:
gather_subset: min
gather_network_resources: lacp
# Collect only the interfaces facts
- cisco.iosxr.iosxr_facts:
gather_subset:
- '!all'
- '!min'
gather_network_resources:
- interfaces
- l2_interfaces
Возвращаемые значения
Общие возвращаемые значения описаны в документации, ниже указаны поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список / элементы=строка | при конфигурации интерфейсов | Все настроенные IPv4-адреса на устройстве |
| ansible_net_all_ipv6_addresses список / элементы=строка | при конфигурации интерфейсов | Все настроенные IPv6-адреса на устройстве |
| ansible_net_api строка | всегда | Имя транспорта |
| ansible_net_config строка | при конфигурации config | Текущая активная конфигурация с устройства |
| ansible_net_filesystems список / элементы=строка | при конфигурации аппаратных средств | Все имена файловых систем, доступные на устройстве |
| ansible_net_gather_network_resources список / элементы=строка | всегда | Список подмножеств ресурсов фактов, собранных с устройства |
| ansible_net_gather_subset список / элементы=строка | всегда | Список собранных подмножеств фактов с устройства |
| ansible_net_hostname строка | всегда | Настроенное имя хоста устройства |
| ansible_net_image строка | всегда | Файл образа, который использует устройство |
| ansible_net_interfaces словарь | при конфигурации интерфейсов | Хэш всех интерфейсов, работающих на системе |
| ansible_net_memfree_mb целое число | при конфигурации аппаратных средств | Доступная свободная память на удаленном устройстве в Мб |
| ansible_net_memtotal_mb целое число | при конфигурации аппаратных средств | Общая память на удаленном устройстве в Мб |
| ansible_net_model строка | всегда | Имя модели, возвращаемое устройством |
| ansible_net_neighbors словарь | при конфигурации интерфейсов | Список соседей LLDP с удаленного устройства |
| ansible_net_python_version строка | всегда | Версия Python, используемая контроллером Ansible |
| ansible_net_version строка | всегда | Версия операционной системы, работающей на удаленном устройстве |
Авторы
- Ricardo Carrillo Cruz (@rcarrillocruz)
- Nilashish Chakraborty (@Nilashishc)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/iosxr/iosxr_facts_module.html
