Модуль cisco.iosxr.iosxr_facts — модуль для сбора сведений с удалённых устройств.

Примечание

Этот модуль входит в коллекцию cisco.iosxr (версия 12.3.1).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.iosxr.

Чтобы использовать её в плейбуке, укажите: cisco.iosxr.iosxr_facts.

Добавлено в cisco.iosxr 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Собирает сведения с сетевых устройств под управлением операционной системы iosxr. Этот модуль помещает собранные сведения в дерево фактов, используя соответствующее имя ресурса в качестве ключа. Модуль всегда собирает с устройства базовый набор сведений; сбор дополнительных сведений можно включить или отключить.

Примечание

Для этого модуля предусмотрен соответствующий модуль действия.

Псевдонимы: facts

Параметры

Параметр	Комментарии
available_network_resources логическое значение	Если задано значение ‘True’, будет предоставлен список сетевых ресурсов, для которых доступны модули ресурсов. Варианты: `false` ← (по умолчанию) `true`
gather_network_resources список / элементы=строка	Если этот аргумент указан, он ограничивает сбор сведений заданным подмножеством. Возможные значения этого аргумента включают all и такие ресурсы, как interfaces, lacp и т. д. Чтобы включить большее подмножество, можно указать список значений. Перед значениями также можно указать `!`, чтобы задать подмножество, которое не следует собирать. Допустимые подмножества: ‘all’, ‘lacp’, ‘lacp_interfaces’, ‘lldp_global’, ‘lldp_interfaces’, ‘interfaces’, ‘l2_interfaces’, ‘l3_interfaces’, ‘lag_interfaces’, ‘acls’, ‘acl_interfaces’, ‘static_routes’, ‘ospfv2’.
gather_subset список / элементы=строка	Если этот аргумент указан, он ограничивает сбор сведений заданным подмножеством. Возможные значения этого аргумента включают all, hardware, config и interfaces. Чтобы включить большее подмножество, можно указать список значений. Перед значениями также можно указать `!`, чтобы задать подмножество, которое не следует собирать. По умолчанию: `["min"]`

Примечания

Примечание

Этот модуль работает с подключением network_cli. См. параметры платформы IOS-XR.
Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по сетям Ansible <network_guide>`
Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/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-адреса, настроенные на устройстве Возвращается: если настроен interfaces
ansible_net_all_ipv6_addresses список / элементы=строка	Все IPv6-адреса, настроенные на устройстве Возвращается: если настроен interfaces
ansible_net_api строка	Название транспорта Возвращается: всегда
ansible_net_config строка	Текущая активная конфигурация устройства Возвращается: если настроен config
ansible_net_cpu_utilization словарь	Текущая загрузка ЦП устройства Возвращается: если настроен hardware
ansible_net_filesystems список / элементы=строка	Все имена файловых систем, доступных на устройстве Возвращается: если настроен hardware
ansible_net_gather_network_resources список / элементы=строка	Список подмножеств ресурсов, для которых собраны сведения с устройства Возвращается: всегда
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_model строка	Название модели, возвращённое устройством Возвращается: всегда
ansible_net_neighbors словарь	Список соседних устройств LLDP и CDP, обнаруженных удалённым устройством. Если для одного порта доступны сведения о соседях и CDP, и LLDP, предпочтение отдаётся CDP. Возвращается: если настроен interfaces
ansible_net_python_version строка	Версия Python, используемая контроллером Ansible Возвращается: всегда
ansible_net_version строка	Версия операционной системы, работающей на удалённом устройстве Возвращается: всегда

Авторы

Ricardo Carrillo Cruz (@rcarrillocruz)
Nilashish Chakraborty (@Nilashishc)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/iosxr/iosxr_facts_module.html