fortinet.fortimanager.fmgr_waf_profile_method модуль – Ограничение метода.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Впервые в 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`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
profile строка / обязательно	Параметр (profile) в запрошенном URL.
proposed_method строка	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для успеха.
waf_profile_method словарь	Установленные параметры верхнего уровня.
default-allowed-methods список / элементы=строка	Устаревшее, пожалуйста, переименуйте на default_allowed_methods. Методы. Варианты: `"delete"` `"get"` `"head"` `"options"` `"post"` `"put"` `"trace"` `"others"` `"connect"`
log строка	Включить/отключить ведение журнала. Варианты: `"disable"` `"enable"`
method-policy список / элементы=словарь	Устаревшее, пожалуйста, переименуйте на method_policy. Политика методов.
address строка	Адрес хоста.
allowed-methods список / элементы=строка	Устаревшее, пожалуйста, переименуйте на allowed_methods. Разрешённые методы. Варианты: `"delete"` `"get"` `"head"` `"options"` `"post"` `"put"` `"trace"` `"others"` `"connect"`
id целое число	Идентификатор политики метода HTTP.
pattern строка	Шаблон URL.
regex строка	Включить/выключить сопоставление шаблона на основе регулярных выражений. Варианты: `"disable"` `"enable"`
severity строка	Уровень серьёзности. Варианты: `"low"` `"medium"` `"high"`
status строка	Статус. Варианты: `"disable"` `"enable"`

workspace_locking_adom string	ADOM для блокировки в режиме работы в рабочей области 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 помогают в этом.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой 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: Method restriction.
      fortinet.fortimanager.fmgr_waf_profile_method:
        # 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>
        profile: <your own value>
        waf_profile_method:
          default_allowed_methods:
            - delete
            - get
            - head
            - options
            - post
            - put
            - trace
            - others
            - connect
          log: <value in [disable, enable]>
          method_policy:
            -
              address: <string>
              allowed_methods:
                - delete
                - get
                - head
                - options
                - post
                - put
                - trace
                - others
                - connect
              id: <integer>
              pattern: <string>
              regex: <value in [disable, enable]>
          severity: <value in [low, medium, high]>
          status: <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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_waf_profile_method_module.html