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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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.
Примеры включают все параметры и значения, которые необходимо настроить перед использованием.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_proxyaddress словарь	Установленные параметры верхнего уровня.
_image-base64 строка	Устарело, пожалуйста, переименуйте на _image_base64. Изображение в base64.
application любой	(список) SaaS-приложение.
case_sensitivity строка	Устарело, пожалуйста, переименуйте на case_sensitivity. Включить регистрозависимое сравнение. Варианты: `"disable"` `"enable"`
category любой	(список или строка) Идентификатор категории FortiGuard.
color целое число	Целочисленное значение для определения цвета значка в интерфейсе пользователя.
comment строка	Дополнительные комментарии.
header строка	Имя HTTP-заголовка в виде регулярного выражения.
header_group список / элементы=словарь	Устарело, пожалуйста, переименуйте на header_group. Группа заголовков.
case_sensitivity строка	Устарело, пожалуйста, переименуйте на case_sensitivity. Регистрозависимость в шаблоне. Варианты: `"disable"` `"enable"`
header строка	Регулярное выражение HTTP-заголовка.
header_name строка	Устарело, пожалуйста, переименуйте на header_name. HTTP-заголовок.
id целое число	Идентификатор.
header_name строка	Устарело, пожалуйста, переименуйте на header_name. Название HTTP-заголовка.
host строка	Адрес объекта хоста.
host_regex строка	Устарело, пожалуйста, переименуйте на host_regex. Имя хоста в виде регулярного выражения.
method список / элементы=строка	Методы HTTP-запросов, которые будут использоваться. Варианты: `"delete"` `"get"` `"head"` `"options"` `"post"` `"put"` `"trace"` `"connect"`
name строка / обязательно	Имя адреса.

path string	Путь URL в виде регулярного выражения.
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"`
ua list / elements=string	Имена браузеров, используемых в качестве пользовательского агента. Варианты: `"chrome"` `"ms"` `"firefox"` `"safari"` `"other"` `"ie"` `"edge"`
ua-max-ver string	Устарело, замените на ua_max_ver. Максимальная версия пользовательского агента, указанная в точечной нотации.
ua-min-ver string	Устарело, замените на ua_min_ver. Минимальная версия пользовательского агента, указанная в точечной нотации.
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-кодов, при которых условия будут считаться выполненными успешно.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	Область, которая будет заблокирована для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая 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 помогают выполнить эту работу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачно, если возвращён ненулевой rc. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_proxyaddress_module.html