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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/Выключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
firewall_explicitproxyaddress dictionary	Набор параметров верхнего уровня.
case-sensitivity string	Устарело, переименуйте в case_sensitivity. Регистрозависимость в шаблоне. Варианты: `"disable"` `"enable"`
category string	ID категории FortiGuard.
color integer	Цвет значка GUI.
comment string	Комментарий.
header string	Регулярное выражение для HTTP-заголовка.
header-group list / elements=dictionary	Устарело, переименуйте в header_group. Группа заголовков.
case-sensitivity string	Устарело, переименуйте в case_sensitivity. Регистрозависимость в шаблоне. Варианты: `"disable"` `"enable"`
header string	Регулярное выражение для HTTP-заголовка.
header-name string	Устарело, переименуйте в header_name. HTTP-заголовок.
id integer	ID.
header-name string	Устарело, переименуйте в header_name. HTTP-заголовок.
host string	Адрес хоста
host-regex string	Устарело, переименуйте в host_regex. Регулярное выражение для хоста.
method list / elements=string	HTTP-методы. Варианты: `"delete"` `"get"` `"head"` `"options"` `"post"` `"put"` `"trace"` `"connect"`
name string / required	Имя адреса.
path string	Регулярное выражение для пути URL.
tags string	Применённые теги объекта.

тип строка	Тип адреса. Варианты: `"host-regex"` `"url"` `"category"` `"method"` `"ua"` `"header"` `"src-advanced"` `"dst-advanced"`
ua список / элементы=строка	Имя пользователя агента. Варианты: `"chrome"` `"ms"` `"firefox"` `"safari"` `"other"`
uuid строка	Универсальный уникальный идентификатор.
видимость строка	Включить/выключить видимость адреса. Варианты: `"disable"` `"enable"`
токен_доступа_forticloud строка	Авторизовать Ansible-клиент с токеном доступа к API forticloud.
предложенный_метод строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_ошибка список / элементы=целое	Список rc-кодов, при которых условия будут считаться ошибкой.
rc_успех список / элементы=целое	Список rc-кодов, при которых условия будут считаться успехом.
состояние строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
блокировка_рабочего_пространства_adom строка	ADOM для блокировки FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая root.
таймаут_блокировки_рабочего_пространства целое	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Explicit web proxy address configuration.
      fortinet.fortimanager.fmgr_firewall_explicitproxyaddress:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        firewall_explicitproxyaddress:
          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
          name: <string>
          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 словарь	Результат запроса. Возвращается: всегда
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_explicitproxyaddress_module.html