Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

логическое значение

Если значение равно ‘True’, будет предоставлен список сетевых ресурсов, для которых доступны модули ресурсов.

Варианты:

  • false ← (по умолчанию)
  • true

gather_network_resources

список / элементы=строка

Если этот аргумент указан, сбор фактов ограничивается заданным подмножеством. Возможные значения включают all и такие ресурсы, как interfaces, vlans и т. д. Можно указать список значений, чтобы включить большее подмножество. Перед значением также можно поставить !, чтобы указать, что конкретное подмножество собирать не следует. Допустимые подмножества: ‘hsrp_interfaces’, ‘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, настроенные на устройстве

Возвращается: если настроен 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_filesystems_info

словарь

Хеш всех файловых систем с информацией о каждой из них (например, о свободном и общем объёме)

Возвращается: если настроен hardware

ansible_net_gather_network_resources

список / элементы=строка

Список подмножеств фактов о сетевых ресурсах, собранных с устройства

Возвращается: если ресурс настроен

ansible_net_gather_subset

список / элементы=строка

Список подмножеств фактов, собранных с устройства

Возвращается: всегда

ansible_net_hostname

строка

Настроенное имя узла устройства

Возвращается: всегда

ansible_net_image

строка

Файл образа, запущенный на устройстве

Возвращается: всегда

ansible_net_interfaces

словарь

Хеш всех интерфейсов, работающих в системе

Возвращается: если настроен interfaces

ansible_net_iostype

строка

Тип операционной системы (IOS или IOS-XE), работающей на удалённом устройстве

Возвращается: всегда

ansible_net_memfree_mb

целое число

Доступная свободная память на удалённом устройстве в МиБ

Возвращается: если настроен hardware

ansible_net_memtotal_mb

целое число

Общий объём памяти на удалённом устройстве в МиБ

Возвращается: если настроен hardware

ansible_net_model

строка

Название модели, полученное от устройства

Возвращается: всегда

ansible_net_neighbors

словарь

Список соседних устройств CDP и LLDP, обнаруженных удалённым устройством. Если для одного порта доступны данные о соседях и CDP, и LLDP, предпочтение отдаётся CDP.

Возвращается: если настроен interfaces

ansible_net_python_version

строка

Версия Python, используемая контроллером Ansible

Возвращается: всегда

ansible_net_serialnum

строка

Серийный номер удалённого устройства

Возвращается: всегда

ansible_net_stacked_models

список / элементы=строка

Названия моделей всех устройств в стеке

Возвращается: если в стеке настроено несколько устройств

ansible_net_stacked_serialnums

список / элементы=строка

Серийные номера всех устройств в стеке

Возвращается: если в стеке настроено несколько устройств

ansible_net_version

строка

Версия операционной системы, работающей на удалённом устройстве

Возвращается: всегда

Авторы

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

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/ios/ios_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API