ios_facts – Сбор фактов с удалённых устройств на базе Cisco IOS

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_pass строка			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes` с `become_pass`. Для получения дополнительной информации обратитесь к руководству IOS Platform Options. Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize имеет значение false, этот аргумент не оказывает никакого влияния. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
authorize логическое значение		Варианты: нет ← да	Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` и `become: yes`. Для получения дополнительной информации обратитесь к руководству IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
gather_network_resources - добавлен в 2.9			При указании этот аргумент ограничит собираемые факты заданным подмножеством. Возможные значения для этого аргумента включают all и ресурсы, такие как интерфейсы, VLAN и т.д. Можно указать список значений для включения большего подмножества. Значения также могут быть использованы с начальным `!`, чтобы указать, что определённое подмножество не должно собираться. Допустимые подмножества: 'all', 'interfaces', 'l2_interfaces', 'vlans', 'lag_interfaces', 'lacp', 'lacp_interfaces', 'lldp_global', 'lldp_interfaces', 'l3_interfaces'.
gather_subset -		Значение по умолчанию: "!config"	При указании этот аргумент ограничивает собираемые факты заданным подмножеством. Возможные значения для этого аргумента включают `all`, `min`, `hardware`, `config`, и `interfaces`. Укажите список значений для включения большего подмножества. Используйте значение с начальным `!`, чтобы собрать все факты, за исключением этого подмножества.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации обратитесь к руководству IOS Platform Options. Объект словаря, содержащий сведения о соединении.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize имеет значение false, этот аргумент не оказывает никакого влияния. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу передачи. Значение host используется в качестве адреса назначения для протокола передачи.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число	Значение по умолчанию: 22	Указывает порт для подключения к удалённому устройству.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение является путём к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	Значение по умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
	username строка		Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.

Примечания

Примечание

Тестировалось на IOS 15.6
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сетям Ansible
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.

Примеры

- name: Gather all legacy facts
  ios_facts:
    gather_subset: all

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

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

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

- name: Gather only the interfaces resource facts and no legacy facts
  ios_facts:
    gather_subset:
      - '!all'
      - '!min'
    gather_network_resources:
      - interfaces

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

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

- name: Gather L3 interfaces resource and minimal legacy facts
  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_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 список	при конфигурации нескольких устройств в стеке	Имена моделей каждого устройства в стеке
ansible_net_stacked_serialnums список	при конфигурации нескольких устройств в стеке	Серийные номера каждого устройства в стеке
ansible_net_version строка	всегда	Версия операционной системы, работающей на удалённом устройстве

Статус

Данный модуль не гарантирует обратной совместимости. [превью]
Данный модуль поддерживается командой Ansible по работе с сетями. [сеть]

Поддержка Red Hat

Дополнительная информация о поддержке данного модуля компанией Red Hat доступна в этой статье базы знаний Red Hat.

Авторы

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

Подсказка

Если вы заметите какие-либо проблемы в данной документации, вы можете отредактировать данный документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ios_facts_module.html