модуль fortinet.fortios.fortios_system_external_resource — Настройка внешнего ресурса в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_system_external_resource.
Добавлен в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции system и категории external_resource. Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0
Требования
На узле, выполняющем этот модуль, необходимы следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с отметкой member_path можно использовать для операций над элементами. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Определяет, нужно ли создать или удалить объект. Варианты:
|
system_external_resource dictionary | Настройка внешнего ресурса. |
|
address_comment_field string |
Путь JSON к описанию адреса в записи универсального адреса. |
|
address_data_field string |
Путь JSON к данным адреса в записи универсального адреса. |
|
address_name_field string |
Путь JSON к имени адреса в записи универсального адреса. |
|
category integer |
Категория пользовательского ресурса. |
|
client_cert string |
Имя сертификата клиента. Источник: vpn.certificate.local.name. |
|
client_cert_auth string |
Включить или отключить использование сертификата клиента для аутентификации TLS. Варианты:
|
|
comments string |
Комментарий. |
|
interface string |
Укажите исходящий интерфейс для связи с сервером. Источник: system.interface.name. |
|
interface_select_method string |
Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты:
|
|
name string / обязательный |
Имя внешнего ресурса. |
|
namespace string |
Пространство имён адреса универсального внешнего коннектора. |
|
object_array_path string |
Путь JSON к массиву универсальных адресов в ресурсе. |
|
password string |
Пароль для базовой HTTP-аутентификации. |
|
refresh_rate integer |
Интервал обновления внешнего ресурса (1–43200 мин). |
|
resource string |
URL внешнего ресурса. |
|
server_identity_check string |
Параметр проверки сертификата. Варианты:
|
|
source_ip string |
Исходный IPv4-адрес для связи с сервером. |
|
source_ip_interface string |
Исходный интерфейс IPv4 для связи с сервером. Источник: system.interface.name. |
|
status string |
Включить или отключить пользовательский ресурс. Варианты:
|
|
type string |
Тип пользовательского ресурса. Варианты:
|
|
update_method string |
Способ обновления внешнего ресурса. Варианты:
|
|
user_agent string |
Заголовок HTTP User-Agent. |
|
username string |
Имя пользователя для базовой HTTP-аутентификации. |
|
uuid string |
Универсальный уникальный идентификатор (UUID; назначается автоматически, но может быть сброшен вручную). |
|
vrf_select integer |
Идентификатор VRF для подключения к серверу. |
vdom string | Виртуальный домен из числа предварительно определённых. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure external resource.
fortinet.fortios.fortios_system_external_resource:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_external_resource:
address_comment_field: "<your_own_value>"
address_data_field: "<your_own_value>"
address_name_field: "<your_own_value>"
category: "0"
client_cert: "<your_own_value> (source vpn.certificate.local.name)"
client_cert_auth: "enable"
comments: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
name: "default_name_12"
namespace: "<your_own_value>"
object_array_path: "<your_own_value>"
password: "<your_own_value>"
refresh_rate: "5"
resource: "<your_own_value>"
server_identity_check: "none"
source_ip: "84.230.14.43"
source_ip_interface: "<your_own_value> (source system.interface.name)"
status: "enable"
type: "category"
update_method: "feed"
user_agent: "<your_own_value>"
username: "<your_own_value>"
uuid: "<your_own_value>"
vrf_select: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortinet/fortios/fortios_system_external_resource_module.html