fortinet.fortimanager.fmgr_pkg_firewall_dospolicy модуль – Настройка политик DoS для IPv4.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
pkg строка / обязательно | Параметр (pkg) в запрошенном URL. |
pkg_firewall_dospolicy словарь | Установленные параметры верхнего уровня. |
|
anomaly список / элементы=словарь |
Аномалия. |
|
action строка |
Действие, выполняемое при достижении порога. Варианты:
|
|
log строка |
Включить/выключить ведение журнала для этой аномалии. Варианты:
|
|
name строка |
Имя аномалии. |
|
quarantine строка |
Метод карантина. Варианты:
|
|
quarantine_expiry строка |
Срок действия карантина, от 1 минуты до 364 дней, 23 часов, ... |
|
quarantine_log строка |
Включить/выключить ведение журнала карантина. Варианты:
|
|
status строка |
Включить/выключить активный статус датчика аномалии. Варианты:
|
|
synproxy_tcp_mss строка |
Определить максимальный размер сегмента TCP Варианты:
|
|
synproxy_tcp_sack строка |
Включить/выключить выборочное подтверждение TCP Варианты:
|
|
synproxy_tcp_timestamp строка |
Включить/выключить опцию TCP-временной метки для пакетов, возвращаемых... Варианты:
|
|
synproxy_tcp_window строка |
Определить размер окна TCP для пакетов, возвращаемых прокси-сервером... Варианты:
|
|
synproxy-tcp-windowscale string |
Устарело, переименуйте в synproxy_tcp_windowscale. Определяет значение параметра масштабирования окна TCP для пакетов repl… Choices:
|
|
synproxy-tos string |
Устарело, переименуйте в synproxy_tos. Определяет значение кодовой точки дифференцированных служб TCP Choices:
|
|
synproxy-ttl string |
Устарело, переименуйте в synproxy_ttl. Определяет время существования Choices:
|
|
synproxy_tcp_mss string |
Определяет максимальный размер сегмента TCP Choices:
|
|
synproxy_tcp_sack string |
Включить/отключить селективное подтверждение TCP Choices:
|
|
synproxy_tcp_timestamp string |
Включить/отключить параметр метки времени TCP для пакетов, отвеченных модулем прокси SYN. Choices:
|
|
synproxy_tcp_window string |
Определяет размер окна TCP для пакетов, отвеченных модулем прокси SYN. Choices:
|
|
synproxy_tcp_windowscale string |
Определяет значение параметра масштабирования окна TCP для пакетов, отвеченных модулем прокси SYN. Choices:
|
|
synproxy_tos string |
Определяет значение кодовой точки дифференцированных служб TCP Choices:
|
|
synproxy_ttl string |
Определяет время существования Choices:
|
|
threshold integer |
Количество обнаруженных экземпляров в минуту, которое вызывает действие |
|
threshold(default) integer |
Устарело, переименуйте в threshold_default). Порог |
|
comments string |
Комментарий. |
|
dstaddr any |
(список или строка) Имя адреса назначения из доступных адресов. |
|
interface string |
Имя входящего интерфейса из доступных интерфейсов. |
|
name string |
Имя политики. |
|
policyid integer / required |
Идентификатор политики. |
|
service any |
(список или строка) Объект службы из доступных параметров. |
|
srcaddr any |
(список или строка) Имя адреса источника из доступных адресов. |
|
status строка |
Включить/отключить эту политику. Варианты:
|
|
uuid строка |
Универсальный уникальный идентификатор |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список rc-кодов, по которым условия будут переопределены для отказ. |
rc_succeeded список / элементы=целое | Список rc-кодов, по которым условия будут переопределены для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | ADOM для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая 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 помогают в этой работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно, выполнение одного модуля может завершиться неудачей, когда возвращается ненулевой rc. Вы также можете переопределить условия неудачи или успеха с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook
hosts: fortimanagers
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 словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на сборку
© 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_pkg_firewall_dospolicy_module.html