Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_pkg_firewall_dospolicy – настройка политик DoS для IPv4.

Примечание

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

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

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

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

Добавлено в 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.

pkg

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

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

pkg_firewall_dospolicy

dictionary

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

anomaly

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

Аномалия.

action

string

Действие, выполняемое при достижении порогового значения.

Варианты:

  • "pass"
  • "block"
  • "proxy"

log

string

Включить или отключить ведение журнала для этой аномалии.

Варианты:

  • "disable"
  • "enable"

name

string

Имя аномалии.

quarantine

string

Метод помещения в карантин.

Варианты:

  • "none"
  • "attacker"
  • "both"
  • "interface"

quarantine_expiry

псевдонимы: quarantine-expiry

string

Длительность карантина — от 1 минуты до 364 дней, 23 часов и 59 минут с текущего момента.

quarantine_log

псевдонимы: quarantine-log

string

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

Варианты:

  • "disable"
  • "enable"

status

string

Включить или отключить активное состояние этого датчика аномалий.

Варианты:

  • "disable"
  • "enable"

synproxy-tcp-mss

string

Устарело, переименуйте параметр в synproxy_tcp_mss. Определяет максимальный размер сегмента TCP

Варианты:

  • "0"
  • "256"
  • "512"
  • "1024"
  • "1300"
  • "1360"
  • "1460"
  • "1500"

synproxy-tcp-sack

string

Устарело, переименуйте параметр в synproxy_tcp_sack. Включить или отключить выборочные подтверждения TCP

Варианты:

  • "disable"
  • "enable"

synproxy-tcp-timestamp

string

Устарело, переименуйте параметр в synproxy_tcp_timestamp. Включить или отключить параметр временной метки TCP для пакетов, на которые отвечает…

Варианты:

  • "disable"
  • "enable"

synproxy-tcp-window

string

Устарело, переименуйте параметр в synproxy_tcp_window. Определяет размер окна TCP для пакетов, на которые отвечает модуль syn proxy…

Варианты:

  • "4096"
  • "8192"
  • "16384"
  • "32768"

synproxy-tcp-windowscale

string

Устарело, переименуйте параметр в synproxy_tcp_windowscale. Определяет значение параметра масштабирования окна TCP для пакетов, на которые отвечает…

Варианты:

  • "0"
  • "1"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"
  • "7"
  • "8"
  • "9"
  • "10"
  • "11"
  • "12"
  • "13"
  • "14"

synproxy-tos

string

Устарело, переименуйте параметр в synproxy_tos. Определяет значение кода дифференцированных услуг TCP (DSCP)

Варианты:

  • "0"
  • "10"
  • "12"
  • "14"
  • "18"
  • "20"
  • "22"
  • "26"
  • "28"
  • "30"
  • "34"
  • "36"
  • "38"
  • "40"
  • "46"
  • "255"

synproxy-ttl

string

Устарело, переименуйте параметр в synproxy_ttl. Определяет время жизни

Варианты:

  • "32"
  • "64"
  • "128"
  • "255"

synproxy_tcp_mss

string

Определяет максимальный размер сегмента TCP

Варианты:

  • "0"
  • "256"
  • "512"
  • "1024"
  • "1300"
  • "1360"
  • "1460"
  • "1500"

synproxy_tcp_sack

string

Включить или отключить выборочные подтверждения TCP

Варианты:

  • "disable"
  • "enable"

synproxy_tcp_timestamp

string

Включить или отключить параметр временной метки TCP для пакетов, на которые отвечает модуль syn proxy.

Варианты:

  • "disable"
  • "enable"

synproxy_tcp_window

string

Определяет размер окна TCP для пакетов, на которые отвечает модуль syn proxy.

Варианты:

  • "4096"
  • "8192"
  • "16384"
  • "32768"

synproxy_tcp_windowscale

string

Определяет значение параметра масштабирования окна TCP для пакетов, на которые отвечает модуль syn proxy.

Варианты:

  • "0"
  • "1"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"
  • "7"
  • "8"
  • "9"
  • "10"
  • "11"
  • "12"
  • "13"
  • "14"

synproxy_tos

string

Определяет значение кода дифференцированных услуг TCP (DSCP)

Варианты:

  • "0"
  • "10"
  • "12"
  • "14"
  • "18"
  • "20"
  • "22"
  • "26"
  • "28"
  • "30"
  • "34"
  • "36"
  • "38"
  • "40"
  • "46"
  • "255"

synproxy_ttl

string

Определяет время жизни

Варианты:

  • "32"
  • "64"
  • "128"
  • "255"

threshold

integer

Количество обнаруженных экземпляров в минуту, при котором запускается действие

threshold_default

псевдонимы: threshold(default)

integer

Пороговое значение

comments

string

Комментарий.

dstaddr

any

(список или строка) Имя адреса назначения из доступных адресов.

interface

string

Имя входящего интерфейса из доступных интерфейсов.

name

string

Имя политики.

policyid

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

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

service

any

(список или строка) Объект службы из доступных вариантов.

srcaddr

any

(список или строка) Имя адреса источника из доступных адресов.

status

string

Включить или отключить эту политику.

Варианты:

  • "disable"
  • "enable"

uuid

string

Универсальный уникальный идентификатор

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"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие ADOM, включая 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
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 DoS policies.
      fortinet.fortimanager.fmgr_pkg_firewall_dospolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_dospolicy:
          comments: "ansible-comment1"
          interface: "sslvpn_tun_intf"
          policyid: 1
          status: enable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPv4 DoS policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_dospolicy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            DoS_policy: "your_value"

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Текстовое описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=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_pkg_firewall_dospolicy_module.html

Spec-Zone.ru

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