модуль fortinet.fortimanager.fmgr_firewall_proxyaddress – настройка адреса веб-прокси.

Примечание

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

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

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

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

Добавлено в 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`
firewall_proxyaddress dictionary	Набор параметров верхнего уровня.
_image_base64 псевдонимы: _image-base64 string	Изображение в формате Base64.
application any	(список) SaaS-приложение.
case_sensitivity псевдонимы: case-sensitivity string	Включить проверку с учетом регистра для шаблона. Варианты: `"disable"` `"enable"`
category any	(список или строка) Идентификатор категории FortiGuard.
color integer	Целочисленное значение, определяющее цвет значка в графическом интерфейсе пользователя.
comment string	Необязательные комментарии.
header string	Имя заголовка HTTP в виде регулярного выражения.
header_group псевдонимы: header-group list / elements=dictionary	Группа заголовков.
case_sensitivity псевдонимы: case-sensitivity string	Учет регистра в шаблоне. Варианты: `"disable"` `"enable"`
header string	Регулярное выражение для заголовка HTTP.
header_name псевдонимы: header-name string	Заголовок HTTP.
id integer	Идентификатор.
header_name псевдонимы: header-name string	Имя заголовка HTTP.
host string	Объект адреса для узла.
host_regex псевдонимы: host-regex string	Имя узла в виде регулярного выражения.
llm_servers псевдонимы: llm-servers any	(список) Серверы LLM.
method list / elements=string	Используемые методы HTTP-запросов. Варианты: `"delete"` `"get"` `"head"` `"options"` `"post"` `"put"` `"trace"` `"connect"` `"other"` `"patch"` `"update"`
name string / обязательный	Имя адреса.
path string	Путь URL в виде регулярного выражения.
post_arg псевдонимы: post-arg string	Аргумент POST. Варианты: `"disable"` `"enable"`
query string	Сопоставить часть запроса в URL с помощью регулярного выражения.
referrer string	Включить или отключить использование поля referrer в заголовке HTTP для сопоставления адреса. Варианты: `"disable"` `"enable"`
tagging list / elements=dictionary	Маркировка тегами.
category string	Категория тегов.
name string	Имя записи маркировки тегами.
tags any	(список) Теги.
tags string	Имена тегов объектов.
type string	Тип адреса прокси. Варианты: `"host-regex"` `"url"` `"category"` `"method"` `"ua"` `"header"` `"src-advanced"` `"dst-advanced"` `"url-list"` `"saas"` `"response-header"` `"llm-server"`
ua list / elements=string	Названия браузеров, используемых в качестве User-Agent. Варианты: `"chrome"` `"ms"` `"firefox"` `"safari"` `"other"` `"ie"` `"edge"`
ua_max_ver псевдонимы: ua-max-ver string	Максимальная версия User-Agent, заданная в точечной нотации.
ua_min_ver псевдонимы: ua-min-ver string	Минимальная версия User-Agent, заданная в точечной нотации.
url_list псевдонимы: url-list any	(список) Список URL.
uuid string	Универсальный уникальный идентификатор.
visibility string	Включить или отключить отображение объекта в графическом интерфейсе пользователя. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается неуспешным.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
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: Web proxy address configuration.
      fortinet.fortimanager.fmgr_firewall_proxyaddress:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_proxyaddress:
          case_sensitivity: disable
          color: 1
          comment: "ansible-comment"
          name: "ansible-test"

- 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 proxy addresses
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_proxyaddress"
          params:
            adom: "ansible"
            proxy_address: "your_value"

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL-адрес запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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_firewall_proxyaddress_module.html