cisco.ios.ios_facts – Сбор фактов с удалённых устройств, работающих под управлением Cisco IOS
Примечание
Этот плагин входит в состав коллекции cisco.ios (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install cisco.ios
Для использования в плейбуке укажите: cisco.ios.ios_facts
Добавлен в версии 1.0.0: модуль cisco.ios
Обзор
- Сбор базового набора фактов устройства с удалённого устройства, работающего под управлением IOS. Данный модуль добавляет к ключам всех основных сетевых фактов префикс
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов устройства и может включать или отключать сбор дополнительных фактов.
Примечание
У данного модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_network_resources список / элементы=строка | Если указано, этот аргумент ограничит собираемые факты заданным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, VLANы и т. д. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным ! для указания того, что определённое подмножество не должно собираться. Допустимые подмножества: 'all', 'interfaces', 'l2_interfaces', 'vlans', 'lag_interfaces', 'lacp', 'lacp_interfaces', 'lldp_global', 'lldp_interfaces', 'l3_interfaces', 'acl_interfaces', 'static_routes', 'acls'. | ||
| 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 целое число | Указывает порт для создания соединения с удалённым устройством. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | ||
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
Примечания
Примечание
- Проверено на IOS 15.6
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сетям Ansible
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции 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_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 строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
Авторы
- Peter Sprygada (@privateip)
- Sumit Jaiswal (@justjais)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/ios/ios_facts_module.html
