Модуль community.routeros.facts – Сбор фактов с удаленных устройств, работающих на MikroTik RouterOS

Примечание

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

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

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

Для использования в playbook укажите: community.routeros.facts.

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

Описание

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

Параметры

Параметр	Комментарии
gather_subset список / элементы=строка	При указании этого аргумента факта собираются только в заданном подмножестве. Возможные значения этого аргумента включают `all`, `hardware`, `config`, `interfaces`, и `routing`. Можно указать список значений, чтобы включить большее подмножество. Значения также могут использоваться с начальным `!` для указания, что определенное подмножество не должно собираться. По умолчанию: `["!config"]`

Параметр

Комментарии

gather_subset

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

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

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

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз изменённого состояния без изменения целевого объекта.
diff_mode	Поддержка: нет Это действие не изменяет состояние.	Возвращает подробности об изменениях (или, возможно, о необходимости изменений в `check_mode`), когда используется режим diff.
facts	Поддержка: полная	Действие возвращает словарь `ansible_facts`, который будет обновлять существующие факты хоста.
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"

END_OF_DOCUMENT_MARKER

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

Факты, возвращаемые этим модулем, добавляются/обновляются в фактах хоста 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	Текущая активная конфигурация устройства в минимальном виде. Это значение является идемпотентным в том смысле, что если модуль фактов запускается дважды, и конфигурация устройства не изменялась между запусками, значение идентично. Это достигается путем запуска `/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	Доступная свободная память на удаленном устройстве в MiB. Возвращено: `gather_subset` содержит `hardware`
ansible_net_memtotal_mb integer	Общая память на удаленном устройстве в MiB. Возвращено: `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 словарь	Словарь маршрутов во всех таблицах маршрутизации. Возвращено: `gather_subset` содержит `routing`
ansible_net_serialnum строка	Серийный номер удалённого устройства. Возвращено: `gather_subset` содержит `default`
ansible_net_spacefree_mb словарь	Доступное дисковое пространство на удалённом устройстве в МБ. Возвращено: `gather_subset` содержит `hardware`
ansible_net_spacetotal_mb словарь	Общее дисковое пространство на удалённом устройстве в МБ. Возвращено: `gather_subset` содержит `hardware`
ansible_net_uptime строка	Время работы устройства. Возвращено: `gather_subset` содержит `default`
ansible_net_version строка	Версия операционной системы, работающей на удалённом устройстве. Возвращено: `gather_subset` содержит `default`

Авторы

Егор Зайцев (@heuels)

Ссылки на сборку

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