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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для завершения с ошибкой.
rc_succeeded список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для успешного завершения.
system_npu_hpe словарь	Настройка параметров верхнего уровня.
all_protocol целое	Устаревшее, пожалуйста, переименуйте на all_protocol. Максимальная скорость пакетов каждой очереди хоста, за исключением трафика высокой приоритетности.
arp_max целое	Устаревшее, пожалуйста, переименуйте на arp_max. Максимальная скорость пакетов ARP.
enable_queue_shaper строка	Устаревшее, пожалуйста, переименуйте на enable_queue_shaper. Включение/выключение модуля защиты хоста NPU. Варианты: `"disable"` `"enable"`
enable_shaper строка	Устаревшее, пожалуйста, переименуйте на enable_shaper. Включение/выключение модуля защиты хоста NPU. Варианты: `"disable"` `"enable"`
esp_max целое	Устаревшее, пожалуйста, переименуйте на esp_max. Максимальная скорость пакетов ESP.
exception_code целое	Устаревшее, пожалуйста, переименуйте на exception_code. Максимальная скорость исключительных кодов трафика.
fragment_with_sess целое	Устаревшее, пожалуйста, переименуйте на fragment_with_sess. Максимальная скорость фрагментированного трафика с сессией.
fragment_without_session целое	Устаревшее, пожалуйста, переименуйте на fragment_without_session. Максимальная скорость фрагментированного трафика без сессии.
high_priority целое	Устаревшее, пожалуйста, переименуйте на high_priority. Максимальная скорость пакетов высокой приоритетности.
icmp_max целое	Устаревшее, пожалуйста, переименуйте на icmp_max. Максимальная скорость пакетов ICMP.
ip_frag_max целое	Устаревшее, пожалуйста, переименуйте на ip_frag_max. Максимальная скорость фрагментированных пакетов IP.
ip_others_max целое	Устаревшее, пожалуйста, переименуйте на ip_others_max. Максимальная скорость пакетов IP (прочие).
l2_others_max целое	Устаревшее, пожалуйста, переименуйте на l2_others_max. Максимальная скорость пакетов L2 (кроме пакетов ARP).

END_OF_DOCUMENT_MARKER

pri-type-max integer	Устаревшее, пожалуйста, переименуйте на pri_type_max. Максимальная скорость переполнения трафика приоритетного типа
queue-shaper-max integer	Устаревшее, пожалуйста, переименуйте на queue_shaper_max. Максимальная скорость потока в байтах на очередь
sctp-max integer	Устаревшее, пожалуйста, переименуйте на sctp_max. Максимальная скорость пакетов SCTP
tcp-max integer	Устаревшее, пожалуйста, переименуйте на tcp_max. Максимальная скорость пакетов TCP
tcpfin-rst-max integer	Устаревшее, пожалуйста, переименуйте на tcpfin_rst_max. Максимальная скорость пакетов TCP с флагами FIN или RST
tcpsyn-ack-max integer	Устаревшее, пожалуйста, переименуйте на tcpsyn_ack_max. Максимальная скорость пакетов TCP с флагами SYN и ACK
tcpsyn-max integer	Устаревшее, пожалуйста, переименуйте на tcpsyn_max. Максимальная скорость пакетов TCP SYN
udp-max integer	Устаревшее, пожалуйста, переименуйте на udp_max. Максимальная скорость пакетов UDP
workspace_locking_adom string	Область ADOM для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой.
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_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Host protection engine configuration.
      fortinet.fortimanager.fmgr_system_npu_hpe:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        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 словарь	Результат запроса. Возвращаемое значение: всегда
request_url строка	Полный URL запроса. Возвращаемое значение: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращаемое значение: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращаемое значение: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращаемое значение: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращаемое значение: всегда
rc целое число	Статус запроса. Возвращаемое значение: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_npu_hpe_module.html