Модуль fortinet.fortimanager.fmgr_system_externalresource — настройка внешнего ресурса.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_externalresource.

Добавлено в fortinet.fortimanager 2.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

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

Этот модуль позволяет настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
system_externalresource dictionary	Набор параметров верхнего уровня.
address_comment_field псевдонимы: address-comment-field string	Путь JSON к описанию адреса в записи универсального адреса.
address_data_field псевдонимы: address-data-field string	Путь JSON к данным адреса в записи универсального адреса.
address_name_field псевдонимы: address-name-field string	Путь JSON к имени адреса в записи универсального адреса.
category integer	Категория пользовательского ресурса.
client_cert псевдонимы: client-cert any	(список) Имя сертификата клиента.
client_cert_auth псевдонимы: client-cert-auth string	Включить или отключить использование сертификата клиента для аутентификации TLS. Варианты: `"disable"` `"enable"`
comments string	Комментарий.
dynamic_mapping list / элементы=dictionary	Динамическое сопоставление.
_scope list / элементы=dictionary	Область действия.
name string	Имя.
vdom string	VDOM.
source_ip псевдонимы: source-ip string	IP-адрес источника.
interface string	Укажите исходящий интерфейс для подключения к серверу.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
name string / обязательный	Имя внешнего ресурса.
namespace string	Пространство имён адреса универсального внешнего коннектора.
object_array_path псевдонимы: object-array-path string	Путь JSON к массиву универсальных адресов в ресурсе.
password any	(список) Пароль для базовой HTTP-аутентификации.
proxy string	Прокси-сервер.
proxy_password псевдонимы: proxy-password any	(список) Пароль прокси-сервера.
proxy_port псевдонимы: proxy-port integer	Порт прокси-сервера.
proxy_username псевдонимы: proxy-username string	Имя пользователя прокси-сервера.
refresh_rate псевдонимы: refresh-rate integer	Интервал обновления внешнего ресурса
resource string	URI внешнего ресурса.
server_identity_check псевдонимы: server-identity-check string	Параметр проверки сертификата. Варианты: `"none"` `"basic"` `"full"`
source_ip псевдонимы: source-ip string	Исходный адрес IPv4, используемый для связи с сервером.
source_ip_interface псевдонимы: source-ip-interface any	(список) Исходный интерфейс IPv4 для связи с сервером.
status string	Включить или отключить пользовательский ресурс. Варианты: `"disable"` `"enable"`
type string	Тип пользовательского ресурса. Варианты: `"category"` `"address"` `"domain"` `"malware"` `"url"` `"mac-address"` `"data"` `"generic-address"`
update_method псевдонимы: update-method string	Метод обновления внешнего ресурса. Варианты: `"feed"` `"push"`
user_agent псевдонимы: user-agent string	Переопределить заголовок HTTP User-Agent, используемый при получении этого внешнего ресурса.
username string	Имя пользователя для базовой HTTP-аутентификации.
uuid string	Универсальный уникальный идентификатор
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие области, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы, например «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, но для них будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, указав deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают управлять этим режимом.
Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого значения rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure external resource.
      fortinet.fortimanager.fmgr_system_externalresource:
        bypass_validation: false
        adom: ansible
        state: present
        system_externalresource:
          category: 0
          comments: string
          name: string
          refresh_rate: 1
          resource: string
          status: disable
          type: category # <value in [category, address, domain, ...]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the external resources
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_externalresource"
          params:
            adom: "ansible"
            external_resource: "your_value"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

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