Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_waf_profile_method_methodpolicy — политика методов HTTP.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

profile

string / обязательный

Параметр (profile) в запрошенном URL.

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"

waf_profile_method_methodpolicy

dictionary

Набор параметров верхнего уровня.

address

string

Адрес узла.

allowed_methods

псевдонимы: allowed-methods

list / элементы=string

Разрешённые методы.

Варианты:

  • "delete"
  • "get"
  • "head"
  • "options"
  • "post"
  • "put"
  • "trace"
  • "others"
  • "connect"

id

integer / обязательный

Идентификатор политики методов HTTP.

pattern

string

Шаблон URL.

regex

string

Включить/отключить сопоставление с шаблоном на основе регулярного выражения.

Варианты:

  • "disable"
  • "enable"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие значения, включая 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: HTTP method policy.
      fortinet.fortimanager.fmgr_waf_profile_method_methodpolicy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile: <your own value>
        state: present # <value in [present, absent]>
        waf_profile_method_methodpolicy:
          id: 0 # Required variable, integer
          # address: <string>
          # allowed_methods: ["delete", "get", "head", "options", "post", "put", "trace",
          #                   "others", "connect"]
          # pattern: <string>
          # regex: <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_waf_profile_method_methodpolicy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API