fortinet.fortimanager.fmgr_webproxy_profile_obj – Настройка профилей веб-прокси.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 1.0.5).

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_webproxy_profile_obj.

В версии 2.10: модуля fortinet.fortimanager

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

Обзор

Этот модуль позволяет настроить устройство FortiManager, позволяя пользователю [ клонировать, удалить, получить, установить, обновить ] следующие API:
/pm/config/adom/{adom}/obj/web-proxy/profile/{profile}
/pm/config/global/obj/web-proxy/profile/{profile}
Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Верификация параметров выполняется в свободном режиме
method строка / обязательно	Варианты: clone delete get set update	Метод запроса
params список / элементы=строка		Параметры для каждого метода Полный список параметров см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params словарь		Параметры для каждого URL запроса API Полный список параметров URL см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom строка		Имя домена для блокировки в случае работы FortiManager в режиме рабочей области. Может быть глобальным или любым другим именем настраиваемого домена.
workspace_locking_timeout целое число	По умолчанию: 300	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область.

Примечания

Примечание

Есть только три параметра верхнего уровня, где ‘method’ всегда обязателен, а другие два ‘params’ и ‘url_params’ могут быть необязательными.
Из-за сложности схемы API fortimanager, валидация выполняется вне процедуры проверки параметров Ansible.
Синтаксис OPTIONS не соответствует стандартному указанию аргументов Ansible, но в соответствии со структурой схемы API fortimanager, нам требуется тривиальное преобразование при заполнении плейбука ansible.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:

   - name: REQUESTING /PM/CONFIG/OBJ/WEB-PROXY/PROFILE/{PROFILE}
     fmgr_webproxy_profile_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [clone, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           profile: <value of string>
        params:
           -
              data:
                 header-client-ip: <value in [pass, add, remove]>
                 header-front-end-https: <value in [pass, add, remove]>
                 header-via-request: <value in [pass, add, remove]>
                 header-via-response: <value in [pass, add, remove]>
                 header-x-authenticated-groups: <value in [pass, add, remove]>
                 header-x-authenticated-user: <value in [pass, add, remove]>
                 header-x-forwarded-for: <value in [pass, add, remove]>
                 headers:
                   -
                       action: <value in [add-to-request, add-to-response, remove-from-request, ...]>
                       content: <value of string>
                       id: <value of integer>
                       name: <value of string>
                 log-header-change: <value in [disable, enable]>
                 name: <value of string>
                 strip-encoding: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/OBJ/WEB-PROXY/PROFILE/{PROFILE}
     fmgr_webproxy_profile_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        url_params:
           adom: <value in [none, global, custom dom]>
           profile: <value of string>
        params:
           -
              option: <value in [object member, chksum, datasrc]>

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

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

Ключ	Возвращаемое значение	Описание
data словарь	всегда	Полезная нагрузка, возвращенная в запросе
status словарь	всегда	Статус запроса API
url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user

Авторы

Frank Shen (@fshen01)
Link Zheng (@zhengl)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortimanager/fmgr_webproxy_profile_obj_module.html