Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.iosxr.iosxr_facts.

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

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

Обзор

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

Псевдонимы: факты

Параметры

Параметр

Комментарии

available_network_resources

boolean

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

Варианты:

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

gather_network_resources

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

При указании этого аргумента, сбор фактов будет ограничен определенным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, lacp и т. д. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным ! для указания, что определенное подмножество не должно собираться. Действительными подмножествами являются ‘all’, ‘lacp’, ‘lacp_interfaces’, ‘lldp_global’, ‘lldp_interfaces’, ‘interfaces’, ‘l2_interfaces’, ‘l3_interfaces’, ‘lag_interfaces’, ‘acls’, ‘acl_interfaces’, ‘static_routes’, ‘ospfv2’.

gather_subset

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

При указании этого аргумента, сбор фактов будет ограничен определенным подмножеством. Возможные значения для этого аргумента включают все, оборудование, конфигурацию и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным ! для указания, что определенное подмножество не должно собираться.

По умолчанию: ["min"]

Примечания

Примечание

  • Этот модуль работает с подключением network_cli. См. параметры платформы IOS-XR.
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве по сети 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
END_OF_DOCUMENT_MARKER

Возвращаемые значения

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

Ключ

Описание

ansible_net_all_ipv4_addresses

list / elements=string

Все IPv4-адреса, настроенные на устройстве

Возвращается: когда интерфейсы настроены

ansible_net_all_ipv6_addresses

list / elements=string

Все IPv6-адреса, настроенные на устройстве

Возвращается: когда интерфейсы настроены

ansible_net_api

string

Имя транспортного средства

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

ansible_net_config

string

Текущая активная конфигурация с устройства

Возвращается: когда конфигурация настроена

ansible_net_cpu_utilization

dictionary

Текущая загрузка процессора устройства

Возвращается: когда аппаратное обеспечение настроено

ansible_net_filesystems

list / elements=string

Все имена файловых систем, доступные на устройстве

Возвращается: когда аппаратное обеспечение настроено

ansible_net_gather_network_resources

list / elements=string

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

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

ansible_net_gather_subset

list / elements=string

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

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

ansible_net_hostname

string

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

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

ansible_net_image

string

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

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

ansible_net_interfaces

dictionary

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

Возвращается: когда интерфейсы настроены

ansible_net_memfree_mb

integer

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

Возвращается: когда аппаратное обеспечение настроено

ansible_net_memtotal_mb

integer

Общая память на удаленном устройстве в Мб

Возвращается: когда аппаратное обеспечение настроено

ansible_net_model

string

Имя модели, возвращаемое устройством

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

ansible_net_neighbors

dictionary

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

Возвращается: когда интерфейсы настроены

ansible_net_python_version

string

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

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

ansible_net_version

string

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

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

Авторы

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

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

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

© 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/iosxr/iosxr_facts_module.html

Spec-Zone.ru

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