Модуль fortinet.fortimanager.fmgr_waf_profile_signature_customsignature — Пользовательская сигнатура.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_waf_profile_signature_customsignature.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учетом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation логический | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log логический | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
profile строка / обязательный | Параметр (profile) в запрошенном URL. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, переопределяющий условия неудачного выполнения. |
rc_succeeded список / элементы=целое число | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note строка | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state строка / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
waf_profile_signature_customsignature словарь | Параметры верхнего уровня. |
|
action строка |
Действие. Варианты:
|
|
case_sensitivity псевдонимы: case-sensitivity строка |
Учет регистра символов в шаблоне. Варианты:
|
|
direction строка |
Направление трафика. Варианты:
|
|
log строка |
Включение или отключение ведения журнала. Варианты:
|
|
name строка / обязательный |
Имя сигнатуры. |
|
pattern строка |
Шаблон сопоставления. |
|
severity строка |
Степень серьезности. Варианты:
|
|
status строка |
Состояние. Варианты:
|
|
target список / элементы=строка |
Цель сопоставления HTTP. Варианты:
|
workspace_locking_adom строка | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие ADOM, включая root. |
workspace_locking_timeout целое число | Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Custom signature.
fortinet.fortimanager.fmgr_waf_profile_signature_customsignature:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
profile: <your own value>
state: present # <value in [present, absent]>
waf_profile_signature_customsignature:
name: "your value" # Required variable, string
# action: <value in [allow, block, erase]>
# case_sensitivity: <value in [disable, enable]>
# direction: <value in [request, response]>
# log: <value in [disable, enable]>
# pattern: <string>
# severity: <value in [low, medium, high]>
# status: <value in [disable, enable]>
# target: ["arg", "arg-name", "req-body", "req-cookie", "req-cookie-name",
# "req-filename", "req-header", "req-header-name", "req-raw-uri", "req-uri",
# "resp-body", "resp-hdr", "resp-status"]
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Сведения о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложном условии |
Ссылки на коллекцию
© 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_signature_customsignature_module.html
