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

Примечание

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

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

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

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

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

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

Описание

Сбор базового набора фактов устройства с удалённого устройства, работающего под управлением RouterOS. Этот модуль добавляет ко всем ключам базовых сетевых фактов префикс ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
В отличие от модуля community.routeros.facts, он использует RouterOS API, аналогично модулю 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`. Примечание: это принудительно использует анонимные шифры Diffie-Hellman (ADH). Протокол уязвим для атак «человек посередине», так как ключи, используемые в обмене, не аутентифицированы. Вместо того, чтобы просто подключиться без сертификата, чтобы «сделать все работающим», посмотрите на `validate_certs` и `ca_path`. Выбором: `false` ← (по умолчанию) `true`
gather_subset список / элементы=строка	При указании этого аргумента фактический сбор будет ограничен заданным подмножеством. Возможные значения этого аргумента включают `all`, `hardware`, `interfaces`, и `routing`. Можно указать список значений для включения более крупного подмножества. Значения также могут использоваться с начальным `!` для указания, что определённое подмножество не должно собираться. По умолчанию: `["all"]`
hostname строка / обязательно	Имя хоста RouterOS API.
password строка / обязательно	Пароль пользователя RouterOS.
port целое число	Порт api RouterOS. Если `tls` установлен, порт будет применяться к TLS/SSL соединению. Значения по умолчанию `8728` для HTTP API и `8729` для HTTPS API.
timeout целое число добавлен в community.routeros 2.3.0	Таймаут запроса. По умолчанию: `10`
tls псевдонимы: ssl логическое значение	Если установлен, будет использоваться TLS для подключения к API RouterOS. Выбором: `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	Поддержка: Нет Это действие не изменяет состояние.	В режиме сравнения будет возвращена информация о том, что изменилось (или, возможно, необходимо изменить в `check_mode`).
facts	Поддержка: полная	Действие возвращает `ansible_facts` словарь, который обновит существующие факта узла.
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	Доступная свободная память на удаленном устройстве в 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 dictionary	Словарь для маршрутов во всех таблицах маршрутизации. Возвращено: `gather_subset` содержит `routing`
ansible_net_serialnum string	Серийный номер удаленного устройства. Возвращено: `gather_subset` содержит `default`
ansible_net_spacefree_mb dictionary	Доступное дисковое пространство на удаленном устройстве в MiB. Возвращено: `gather_subset` содержит `hardware`

ansible_net_spacetotal_mb dictionary	Общий объем дискового пространства на удалённом устройстве в МБ. Возвращаемое значение: `gather_subset` содержит `hardware`
ansible_net_uptime строка	Время работы устройства. Возвращаемое значение: `gather_subset` содержит `default`
ansible_net_version строка	Версия операционной системы, работающей на удалённом устройстве. Возвращаемое значение: `gather_subset` содержит `default`

Авторы

Егор Зайцев (@heuels)
Николай Дачев (@NikolayDachev)
Феликс Фонтейн (@felixfontein)

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

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