Модуль fortinet.fortimanager.fmgr_firewall_explicitproxyaddress — настройка адреса явного веб-прокси.

Примечание

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

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

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

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

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_explicitproxyaddress dictionary	Набор параметров верхнего уровня.
case_sensitivity псевдонимы: case-sensitivity string	Учет регистра в шаблоне. Варианты: `"disable"` `"enable"`
category string	Идентификатор категории FortiGuard.
color integer	Цвет значка в графическом интерфейсе.
comment string	Комментарий.
header string	Регулярное выражение для заголовка HTTP.
header_group псевдонимы: header-group list / элементы=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	Регулярное выражение для узла.
method list / элементы=string	Методы HTTP. Варианты: `"delete"` `"get"` `"head"` `"options"` `"post"` `"put"` `"trace"` `"connect"`
name string / обязательный	Имя адреса.
path string	Регулярное выражение для пути URL.
tags string	Теги, примененные к объекту.
type string	Тип адреса. Варианты: `"host-regex"` `"url"` `"category"` `"method"` `"ua"` `"header"` `"src-advanced"` `"dst-advanced"`
ua list / элементы=string	Агент пользователя. Варианты: `"chrome"` `"ms"` `"firefox"` `"safari"` `"other"`
uuid string	Универсальный уникальный идентификатор.
visibility string	Включить/отключить отображение адреса. Варианты: `"disable"` `"enable"`
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"`
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другой ADOM, включая 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Explicit web proxy address configuration.
      fortinet.fortimanager.fmgr_firewall_explicitproxyaddress:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        firewall_explicitproxyaddress:
          name: "your value" # Required variable, string
          # case_sensitivity: <value in [disable, enable]>
          # category: <string>
          # color: <integer>
          # comment: <string>
          # header: <string>
          # header_group:
          #   - case_sensitivity: <value in [disable, enable]>
          #     header: <string>
          #     header_name: <string>
          #     id: <integer>
          # header_name: <string>
          # host: <string>
          # host_regex: <string>
          # method: ["delete", "get", "head", "options", "post", "put", "trace", "connect"]
          # path: <string>
          # tags: <string>
          # type: <value in [host-regex, url, category, ...]>
          # ua: ["chrome", "ms", "firefox", "safari", "other"]
          # uuid: <string>
          # visibility: <value in [disable, enable]>

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

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

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