Модуль community.routeros.api_facts — сбор фактов с удалённых устройств под управлением MikroTik RouterOS с помощью API

Примечание

Этот модуль входит в коллекцию community.routeros (версия 3.20.0).

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

Для установки используйте: ansible-galaxy collection install community.routeros. Для работы с этим модулем потребуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.routeros.api_facts.

Добавлено в community.routeros 2.1.0

Краткое описание
Требования
Параметры
Атрибуты
См. также
Примеры
Возвращаемые факты

Краткое описание

Собирает базовый набор фактов об устройстве с удалённого устройства под управлением RouterOS. Модуль добавляет префикс ansible_net_<fact> ко всем ключам базовых сетевых фактов. Модуль фактов всегда собирает с устройства базовый набор фактов; сбор дополнительных фактов можно включить или отключить.
В отличие от модуля community.routeros.facts, он использует API RouterOS, как и модуль community.routeros.api.

Требования

На узле, на котором выполняется этот модуль, необходимы следующие компоненты.

librouteros
Python >= 3.6 (для librouteros)

Параметры

Параметр	Комментарии
ca_path путь добавлено в community.routeros 1.2.0	Файл в формате PEM, содержащий сертификат CA, который будет использоваться для проверки сертификатов. См. также `validate_cert_hostname`. Используется только при условии `tls=true` и `validate_certs=true`.
encoding строка добавлено в community.routeros 2.1.0	Использовать указанную кодировку при обмене данными с устройством RouterOS. По умолчанию используется `ASCII`. Обратите внимание, что для `UTF-8` требуется librouteros версии 3.2.1 или новее. По умолчанию: `"ASCII"`
force_no_cert логический добавлено в community.routeros 2.4.0	Установите значение `true`, чтобы подключиться без сертификата, если задано `tls=true`. См. также `validate_certs`. Примечание: это принудительно включает шифры анонимного Диффи — Хеллмана (ADH). Протокол уязвим для атак типа «человек посередине», поскольку ключи, используемые при обмене, не проходят аутентификацию. Вместо простого подключения без сертификата, чтобы «заставить всё работать», ознакомьтесь с `validate_certs` и `ca_path`. Варианты: `false` ← (по умолчанию) `true`
gather_subset список / элементы=строка	Если задан этот аргумент, сбор фактов ограничивается указанным подмножеством. Возможные значения аргумента: `all`, `hardware`, `interfaces` и `routing`. Можно указать список значений, чтобы включить большее подмножество. Перед значением также можно указать `!`, чтобы исключить сбор конкретного подмножества. По умолчанию: `["all"]`
hostname строка / обязательный	Имя узла API RouterOS.
password строка / обязательный	Пароль пользователя RouterOS.
port целое число	Порт API RouterOS. Если задано `tls`, порт будет использоваться для TLS/SSL-подключения. Порты по умолчанию: `8728` для HTTP API и `8729` для HTTPS API.
timeout целое число добавлено в community.routeros 2.3.0	Тайм-аут запроса. По умолчанию: `10`
tls псевдонимы: ssl логический	Если параметр задан, для подключения к API RouterOS будет использоваться TLS. Варианты: `false` ← (по умолчанию) `true`
username строка / обязательный	Имя пользователя для входа в RouterOS.
validate_cert_hostname логический добавлено в community.routeros 1.2.0	Установите значение `true`, чтобы проверять имена узлов в сертификатах. См. также `validate_certs`. Используется только при условии `tls=true` и `validate_certs=true`. Варианты: `false` ← (по умолчанию) `true`
validate_certs логический добавлено в community.routeros 1.2.0	Установите значение `false`, чтобы пропустить проверку TLS-сертификатов. См. также `validate_cert_hostname`. Используется только при условии `tls=true`. Примечание: вместо простого отключения проверки сертификатов, чтобы «заставить всё работать», рассмотрите возможность создания собственного сертификата CA и использования его для подписи сертификатов маршрутизатора. Сообщить модулю о сертификате CA можно с помощью параметра `ca_path`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.routeros.api	Используйте `group/community.routeros.api` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевую систему.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).
facts	Поддержка: полная	Действие возвращает словарь `ansible_facts`, который обновляет существующие факты об узле.
idempotent	Поддержка: полная Это действие не изменяет состояние.	При повторном запуске с теми же аргументами вне режима проверки второй запуск сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или к которой он обращается, не претерпела значимых изменений.
platform	Платформа: RouterOS	Целевая ОС или семейства ОС, с которыми можно работать.

См. также

community.routeros.facts: Сбор фактов с удалённых устройств под управлением MikroTik RouterOS.
community.routeros.api: Модуль Ansible для API RouterOS.
community.routeros.api_find_and_modify: Поиск и изменение данных с помощью API.
community.routeros.api_info: Получение сведений через API.
community.routeros.api_modify: Изменение данных по путям с помощью API.
Подключение к устройствам RouterOS с помощью API RouterOS: Подключение к устройствам RouterOS с помощью API RouterOS.

Примеры

---
- name: Collect all facts from the device
  community.routeros.api_facts:
    hostname: 192.168.88.1
    username: admin
    password: password
    gather_subset: all

- name: Do not collect hardware facts
  community.routeros.api_facts:
    hostname: 192.168.88.1
    username: admin
    password: password
    gather_subset:
      - "!hardware"

Возвращаемые факты

Факты, возвращаемые этим модулем, добавляются в факты узла hostvars или обновляются в них; на них можно ссылаться по имени так же, как на любые другие факты узла. Чтобы использовать их, регистрировать их не нужно.

Ключ	Описание
ansible_net_all_ipv4_addresses list / elements=string	Все IPv4-адреса, настроенные на устройстве. Возвращается: `gather_subset` содержит `interfaces`
ansible_net_all_ipv6_addresses list / elements=string	Все IPv6-адреса, настроенные на устройстве. Возвращается: `gather_subset` содержит `interfaces`
ansible_net_arch string	Архитектура процессора устройства. Возвращается: `gather_subset` содержит `default`
ansible_net_bgp_instance dictionary	Словарь с информацией об экземпляре BGP. Возвращается: `gather_subset` содержит `routing`
ansible_net_bgp_peer dictionary	Словарь с информацией о BGP-пире. Возвращается: `gather_subset` содержит `routing`
ansible_net_bgp_vpnv4_route dictionary	Словарь с информацией о маршрутах BGP vpnv4. Возвращается: `gather_subset` содержит `routing`
ansible_net_cpu_load string	Текущая загрузка процессора. Возвращается: `gather_subset` содержит `default`
ansible_net_gather_subset list / elements=string	Список подмножеств фактов, собранных с устройства. Возвращается: всегда
ansible_net_hostname string	Имя узла, настроенное на устройстве. Возвращается: `gather_subset` содержит `default`
ansible_net_interfaces dictionary	Словарь всех интерфейсов, работающих в системе. Возвращается: `gather_subset` содержит `interfaces`
ansible_net_memfree_mb integer	Объём доступной свободной памяти на удалённом устройстве в МиБ. Возвращается: `gather_subset` содержит `hardware`
ansible_net_memtotal_mb integer	Общий объём памяти на удалённом устройстве в МиБ. Возвращается: `gather_subset` содержит `hardware`
ansible_net_model string	Название модели, полученное от устройства. Возвращается: `gather_subset` содержит `default`
ansible_net_neighbors dictionary	Список соседних устройств, обнаруженных удалённым устройством. Возвращается: `gather_subset` содержит `interfaces`
ansible_net_ospf_instance dictionary	Словарь с экземплярами OSPF. Возвращается: `gather_subset` содержит `routing`
ansible_net_ospf_neighbor dictionary	Словарь с соседями OSPF. Возвращается: `gather_subset` содержит `routing`
ansible_net_route dictionary	Словарь маршрутов во всех таблицах маршрутизации. Возвращается: `gather_subset` содержит `routing`
ansible_net_serialnum string	Серийный номер удалённого устройства. Возвращается: `gather_subset` содержит `default`
ansible_net_spacefree_mb dictionary	Объём свободного дискового пространства на удалённом устройстве в МиБ. Возвращается: `gather_subset` содержит `hardware`
ansible_net_spacetotal_mb dictionary	Общий объём дискового пространства на удалённом устройстве в МиБ. Возвращается: `gather_subset` содержит `hardware`
ansible_net_uptime string	Время непрерывной работы устройства. Возвращается: `gather_subset` содержит `default`
ansible_net_version string	Версия операционной системы, работающей на удалённом устройстве. Возвращается: `gather_subset` содержит `default`

Авторы

Egor Zaitsev (@heuels)
Nikolay Dachev (@NikolayDachev)
Felix Fontein (@felixfontein)

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

© 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/community/routeros/api_facts_module.html