Модуль community.routeros.api_info — получение информации из API
Примечание
Этот модуль входит в коллекцию community.routeros (версия 3.20.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.routeros. Для использования этого модуля необходимы дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.routeros.api_info.
Добавлено в community.routeros 2.2.0
Краткое описание
- Позволяет получать информацию о пути с помощью API.
- Это можно использовать для резервного копирования пути, чтобы восстановить его с помощью модуля community.routeros.api_modify.
- Записи нормализуются; динамические и встроенные записи не возвращаются. Используйте параметры
handle_disabledиhide_defaultsдля управления нормализацией, параметрыinclude_dynamicиinclude_builtin— чтобы также возвращать соответственно динамические и встроенные записи, а параметрunfiltered— чтобы возвращать все поля, включая счётчики. - Обратите внимание: этот модуль всё ещё активно разрабатывается и поддерживает только некоторые пути. Если вы хотите добавить поддержку новых путей или считаете, что обнаружили проблемы с существующими путями, сначала создайте задачу в трекере ошибок community.routeros.
Требования
На узле, где выполняется этот модуль, необходимы следующие компоненты.
- librouteros
- Python >= 3.6 (для librouteros)
Параметры
Параметр | Комментарии |
|---|---|
ca_path path добавлено в community.routeros 1.2.0 | Файл в формате PEM, содержащий сертификат CA, который будет использоваться для проверки сертификата. См. также |
encoding string добавлено в community.routeros 2.1.0 | Использовать указанную кодировку при взаимодействии с устройством RouterOS. Значение по умолчанию — По умолчанию: |
force_no_cert boolean добавлено в community.routeros 2.4.0 | Установите значение См. также Примечание: это принудительно включает использование анонимных шифров Диффи — Хеллмана (ADH). Протокол уязвим для атак «человек посередине», поскольку ключи, используемые при обмене, не проходят аутентификацию. Вместо того чтобы просто подключаться без сертификата, чтобы «заставить всё работать», ознакомьтесь с Варианты:
|
handle_disabled string | Способ обработки неустановленных значений.
Варианты:
|
hide_defaults boolean | Следует ли скрывать значения по умолчанию. Варианты:
|
hostname string / обязательный | Имя узла RouterOS API. |
include_builtin boolean добавлено в community.routeros 2.4.0 | Следует ли включать встроенные значения. По умолчанию они не возвращаются, а ключи Если задано значение Варианты:
|
include_dynamic boolean | Следует ли включать динамические значения. По умолчанию они не возвращаются, а ключи Если задано значение Варианты:
|
include_read_only boolean добавлено в community.routeros 2.10.0 | Следует ли включать поля только для чтения. По умолчанию они не возвращаются. Варианты:
|
password string / обязательный | Пароль пользователя RouterOS. |
path string / обязательный | Путь для запроса. Пример значения: Варианты:
|
port integer | Порт RouterOS API. Если задано По умолчанию используется |
restrict list / elements=dictionary добавлено в community.routeros 2.18.0 | Ограничить вывод записями, соответствующими следующим критериям. |
|
field string / обязательный |
Поле, значения которого нужно ограничить. |
|
invert boolean |
Инвертировать условие. Это влияет на Варианты:
|
|
match_disabled boolean |
Следует ли считать совпадением отключённые значения или значения, которые не были указаны. Варианты:
|
|
regex string |
Регулярное выражение, которому должны соответствовать значения поля, чтобы попасть в результат. Обратите внимание, что перед проверкой все значения преобразуются в строки. Сопоставить отключённые значения с помощью регулярных выражений невозможно. Задайте |
|
values list / elements=any |
Значения поля, которые нужно включить в результат. Обратите внимание, что типы значений имеют значение. Если вы укажете строку |
timeout integer добавлено в community.routeros 2.3.0 | Время ожидания ответа на запрос. По умолчанию: |
tls псевдонимы: ssl boolean | Если параметр задан, для подключения к RouterOS API будет использоваться TLS. Варианты:
|
unfiltered boolean | Выводить ли все поля, а не только те, которые поддерживаются в качестве входных данных для community.routeros.api_modify. Нефильтрованный вывод может содержать счётчики и другую информацию о состоянии. Варианты:
|
username string / обязательный | Имя пользователя для входа в RouterOS. |
validate_cert_hostname boolean добавлено в community.routeros 1.2.0 | Задайте См. также Варианты:
|
validate_certs boolean добавлено в community.routeros 1.2.0 | Задайте См. также Примечание: вместо того чтобы просто отключать проверку сертификатов, чтобы «заставить всё работать», рассмотрите возможность создания собственного сертификата УЦ и использования его для подписи сертификатов, применяемых вашим маршрутизатором. Чтобы сообщить модулю о сертификате УЦ, используйте параметр Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группа действий: community.routeros.api | Используйте |
check_mode | Поддержка: полная Это действие не изменяет состояние. | Может выполняться в |
diff_mode | Поддержка: Н/Д Это действие не изменяет состояние. | В режиме различий будут возвращены сведения об изменениях (или о возможных изменениях в |
idempotent | Поддержка: полная Это действие не изменяет состояние. | При повторном запуске с теми же аргументами вне режима проверки действие сообщает об отсутствии изменений. Это предполагает, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом. |
platform | Платформа: RouterOS | Целевая ОС или семейства ОС, с которыми можно работать. |
См. также
См. также
- community.routeros.api
-
Модуль Ansible для RouterOS API.
- community.routeros.api_facts
-
Сбор фактов с удалённых устройств под управлением MikroTik RouterOS с помощью API.
- community.routeros.api_find_and_modify
-
Поиск и изменение информации с помощью API.
- community.routeros.api_modify
-
Изменение данных по путям с помощью API.
- Как подключаться к устройствам RouterOS с помощью RouterOS API
-
Как подключаться к устройствам RouterOS с помощью RouterOS API.
Примеры
---
- name: Get IP addresses
community.routeros.api_info:
hostname: "{{ hostname }}"
password: "{{ password }}"
username: "{{ username }}"
path: ip address
register: ip_addresses
- name: Print data for IP addresses
ansible.builtin.debug:
var: ip_addresses.result
- name: Get IP addresses
community.routeros.api_info:
hostname: "{{ hostname }}"
password: "{{ password }}"
username: "{{ username }}"
path: ip address
register: ip_addresses
- name: Print data for IP addresses
ansible.builtin.debug:
var: ip_addresses.result
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
result list / элементы=dictionary | Список всех элементов для текущего пути. Возвращается: всегда Пример: |
Ссылки коллекции
© 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_info_module.html
