модуль fortinet.fortimanager.fmgr_system_npu_hpe — настройка механизма защиты узла.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.2.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.
proposed_method string	Переопределение метода для базового запроса Json RPC. Допустимые значения: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, с помощью которого можно переопределить условия ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, с помощью которого можно переопределить условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
system_npu_hpe dictionary	Параметры верхнего уровня.
all_protocol псевдонимы: all-protocol integer	Максимальная частота пакетов для каждой очереди узла, кроме трафика с высоким приоритетом
arp_max псевдонимы: arp-max integer	Максимальная частота пакетов ARP
enable_queue_shaper псевдонимы: enable-queue-shaper string	Включить/отключить механизм защиты узла NPU Допустимые значения: `"disable"` `"enable"`
enable_shaper псевдонимы: enable-shaper string	Включить/отключить механизм защиты узла NPU Допустимые значения: `"disable"` `"enable"`
esp_max псевдонимы: esp-max integer	Максимальная частота пакетов ESP
exception_code псевдонимы: exception-code integer	Максимальная частота трафика с кодом исключения
fragment_with_sess псевдонимы: fragment-with-sess integer	Максимальная частота фрагментированного трафика с сеансом
fragment_without_session псевдонимы: fragment-without-session integer	Максимальная частота фрагментированного трафика без сеанса
high_priority псевдонимы: high-priority integer	Максимальная частота пакетов трафика с высоким приоритетом
icmp_max псевдонимы: icmp-max integer	Максимальная частота пакетов ICMP
ip_frag_max псевдонимы: ip-frag-max integer	Максимальная частота фрагментированных IP-пакетов
ip_others_max псевдонимы: ip-others-max integer	Максимальная частота прочих IP-пакетов
l2_others_max псевдонимы: l2-others-max integer	Максимальная частота пакетов L2, не являющихся пакетами ARP
pri_type_max псевдонимы: pri-type-max integer	Максимальная частота переполнения трафика типа priority
queue_shaper_max псевдонимы: queue-shaper-max integer	Максимальная скорость передачи трафика в байтах для каждой очереди
sctp_max псевдонимы: sctp-max integer	Максимальная частота пакетов SCTP
tcp_max псевдонимы: tcp-max integer	Максимальная частота пакетов TCP
tcpfin_rst_max псевдонимы: tcpfin-rst-max integer	Максимальная частота пакетов TCP с флагом FIN или RST
tcpsyn_ack_max псевдонимы: tcpsyn-ack-max integer	Максимальная частота пакетов TCP с флагами SYN и ACK
tcpsyn_max псевдонимы: tcpsyn-max integer	Максимальная частота TCP-пакетов SYN
udp_max псевдонимы: udp-max integer	Максимальная частота пакетов UDP
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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Host protection engine configuration.
      fortinet.fortimanager.fmgr_system_npu_hpe:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        system_npu_hpe:
          # all_protocol: <integer>
          # arp_max: <integer>
          # enable_shaper: <value in [disable, enable]>
          # esp_max: <integer>
          # high_priority: <integer>
          # icmp_max: <integer>
          # ip_frag_max: <integer>
          # ip_others_max: <integer>
          # l2_others_max: <integer>
          # pri_type_max: <integer>
          # sctp_max: <integer>
          # tcp_max: <integer>
          # tcpfin_rst_max: <integer>
          # tcpsyn_ack_max: <integer>
          # tcpsyn_max: <integer>
          # udp_max: <integer>
          # enable_queue_shaper: <value in [disable, enable]>
          # exception_code: <integer>
          # fragment_with_sess: <integer>
          # fragment_without_session: <integer>
          # queue_shaper_max: <integer>

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

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

Ключ	Описание
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_system_npu_hpe_module.html