Модуль cisco.ios.ios_facts – Модуль для сбора фактов с удаленных устройств.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.ios.

Для использования в книге задач укажите: cisco.ios.ios_facts.

Новая функция в cisco.ios 1.0.0

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

Описание

Сбор базового набора фактов устройства с удаленного устройства, на котором запущен IOS. Данный модуль добавляет ко всем базовым ключам сетевых фактов префикс ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включить или выключить сбор дополнительных фактов.

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

Параметры

Параметр	Комментарии
available_network_resources boolean	При значении ‘True’ будет предоставлен список сетевых ресурсов, для которых доступны модули ресурсов. Выбоы: `false` ← (по умолчанию) `true`
gather_network_resources список / элементы=строка	При указании данного аргумента сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, VLAN и т. д. Можно указать список значений для включения более обширного подмножества. Значения также могут использоваться с начальным префиксом `!` для указания, что определенное подмножество не должно собираться. Действительные подмножества – ‘bgp_global’, ‘l3_interfaces’, ‘lag_interfaces’, ‘ntp_global’, ‘acls’, ‘hostname’, ‘interfaces’, ‘lldp_interfaces’, ‘logging_global’, ‘ospf_interfaces’, ‘ospfv2’, ‘prefix_lists’, ‘static_routes’, ‘acl_interfaces’, ‘all’, ‘bgp_address_family’, ‘l2_interfaces’, ‘lacp’, ‘lacp_interfaces’, ‘lldp_global’, ‘ospfv3’, ‘snmp_server’, ‘vlans’, ‘service’.
gather_subset список / элементы=строка	При указании этого аргумента сбор фактов ограничивается определенным подмножеством. Возможные значения для этого аргумента включают `all`, `min`, `default`, `hardware`, `config`, и `interfaces`. Укажите список значений для включения более обширного подмножества. Используйте значение с начальным префиксом `!` для сбора всех фактов, кроме этого подмножества. По умолчанию: `["min"]`

Примечания

Примечание

Проверено на Cisco IOSXE версии 17.3 на CML и IOS 15.6 для ресурсов L2.
Сбор фактов для устройств L3 должен выдавать пустой вывод для неподдерживаемых ресурсов, таких как vlan.
Этот модуль работает с подключением network_cli. См. https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в разделе :ref:`Руководство по Ansible по сетям <network_guide>`
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco: `<https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

- name: Gather all legacy facts
  cisco.ios.ios_facts:
    gather_subset: all

- name: Gather only the config and default facts
  cisco.ios.ios_facts:
    gather_subset:
      - config

- name: Do not gather hardware facts
  cisco.ios.ios_facts:
    gather_subset:
      - "!hardware"

- name: Gather legacy and resource facts
  cisco.ios.ios_facts:
    gather_subset: all
    gather_network_resources: all

- name: Gather only the interfaces resource facts and no legacy facts
  cisco.ios.ios_facts:
    gather_subset:
      - "!all"
      - "!min"
    gather_network_resources:
      - interfaces

- name: Gather interfaces resource and minimal legacy facts
  cisco.ios.ios_facts:
    gather_subset: min
    gather_network_resources: interfaces

- name: Gather L2 interfaces resource and minimal legacy facts
  cisco.ios.ios_facts:
    gather_subset: min
    gather_network_resources: l2_interfaces

- name: Gather L3 interfaces resource and minimal legacy facts
  cisco.ios.ios_facts:
    gather_subset: min
    gather_network_resources: l3_interfaces

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
ansible_net_all_ipv4_addresses список / элементы=строка	Все настроенные IPv4-адреса устройства Возвращается: при настройке интерфейсов
ansible_net_all_ipv6_addresses список / элементы=строка	Все настроенные IPv6-адреса устройства Возвращается: при настройке интерфейсов
ansible_net_api строка	Имя транспортного средства Возвращается: всегда
ansible_net_config строка	Текущая активная конфигурация с устройства Возвращается: при настройке конфигурации
ansible_net_cpu_utilization словарь	Текущая загрузка процессора устройства Возвращается: при настройке оборудования
ansible_net_filesystems список / элементы=строка	Все имена файловых систем, доступные на устройстве Возвращается: при настройке оборудования
ansible_net_filesystems_info словарь	Хэш всех файловых систем, содержащий информацию о каждой файловой системе (например, свободное и общее пространство) Возвращается: при настройке оборудования
ansible_net_gather_network_resources список / элементы=строка	Список фактов для подмножеств сетевых ресурсов, собранных с устройства Возвращается: при настройке ресурса
ansible_net_gather_subset список / элементы=строка	Список подмножеств фактов, собранных с устройства Возвращается: всегда
ansible_net_hostname строка	Настроенное имя хоста устройства Возвращается: всегда
ansible_net_image строка	Файл образа, используемый устройством Возвращается: всегда
ansible_net_interfaces словарь	Хэш всех работающих интерфейсов системы Возвращается: при настройке интерфейсов
ansible_net_iostype строка	Тип операционной системы (IOS или IOS-XE), работающей на удалённом устройстве Возвращается: всегда
ansible_net_memfree_mb целое число	Доступная оперативная память на удалённом устройстве в Мб Возвращается: при настройке оборудования
ansible_net_memtotal_mb целое число	Общий объём оперативной памяти на удалённом устройстве в Мб Возвращается: при настройке оборудования
ansible_net_model строка	Название модели, возвращённое устройством Возвращается: всегда
ansible_net_neighbors словарь	Список соседей CDP и LLDP с удалённого устройства. Если данные о соседях CDP и LLDP присутствуют на одном порту, предпочитается CDP. Возвращается: при настройке интерфейсов
ansible_net_python_version строка	Версия Python, используемая контроллером Ansible Возвращается: всегда
ansible_net_serialnum строка	Серийный номер удалённого устройства Возвращается: всегда
ansible_net_stacked_models список / элементы=строка	Названия моделей каждого устройства в стеке Возвращается: при настройке нескольких устройств в стеке

END_OF_DOCUMENT_MARKER

ansible_net_stacked_serialnums list / elements=string	Серийные номера каждого устройства в стеке Возвращается: при конфигурации нескольких устройств в стеке
ansible_net_version string	Версия операционной системы, работающая на удалённом устройстве Возвращается: всегда

Авторы

Peter Sprygada (@privateip)
Sumit Jaiswal (@justjais)

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

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