Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: community.routeros.facts.

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

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

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

Параметры

Параметр

Комментарии

gather_subset

list / elements=string

Если задан этот аргумент, он ограничивает сбор фактов указанным подмножеством. Возможные значения этого аргумента: all, hardware, config, interfaces и routing.

Можно указать список значений, чтобы включить большее подмножество. Перед значением также можно поставить !, чтобы указать, что определённое подмножество собирать не следует.

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Это действие не изменяет состояние.

Модуль может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: Н/Д

Это действие не изменяет состояние.

В режиме diff модуль возвращает сведения об изменениях (или о том, что, возможно, требуется изменить в check_mode).

facts

Поддержка: полная

Действие возвращает словарь ansible_facts, который обновляет существующие факты узла.

idempotent

Поддержка: полная

Это действие не изменяет состояние.

При повторном запуске вне режима проверки с теми же аргументами модуль сообщает, что изменений нет.

Это предполагает, что система, управляемая или опрашиваемая модулем, не изменилась значимым образом.

platform

Платформа: RouterOS

Целевые ОС и семейства ОС, с которыми может работать модуль.

См. также

См. также

Подключение к устройствам RouterOS по SSH

Подключение к устройствам RouterOS по SSH.

Примеры

---
- name: Collect all facts from the device
  community.routeros.facts:
    gather_subset: all

- name: Collect only the config and default facts
  community.routeros.facts:
    gather_subset:
      - config

- name: Do not collect hardware facts
  community.routeros.facts:
    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_config

string

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

Возвращается: gather_subset содержит config

ansible_net_config_nonverbose

string

добавлено в community.routeros 1.2.0

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

Это значение идемпотентно: если запустить модуль facts дважды и конфигурация устройства между запусками не изменится, значение будет одинаковым. Для этого выполняется /export, а временная метка удаляется из комментария в первой строке.

Возвращается: gather_subset содержит config

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)

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

  • Отслеживание ошибок
  • Репозиторий (исходный код)
  • Запросить помощь (RouterOS)
  • Сообщить об ошибке
  • Предложить новую функцию
  • Связь

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

Spec-Zone.ru

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