модуль fortinet.fortimanager.fmgr_system_log_ratelimit — Ограничение частоты ведения журнала.

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в fortinet.fortimanager 2.1.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо скорректировать с учетом источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
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 / elements=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
system_log_ratelimit dictionary	Набор параметров верхнего уровня.
device list / elements=dictionary	Устройство.
device string	Устройство
filter_type псевдонимы: filter-type string	Тип фильтра устройства. devid — идентификатор устройства. Варианты: `"devid"`
id integer	Идентификатор фильтра устройства.
ratelimit integer	Максимальное ограничение частоты журналов устройства.
device_ratelimit_default псевдонимы: device-ratelimit-default integer	Максимальное ограничение частоты журналов устройства по умолчанию.
mode string	Режим ограничения частоты ведения журнала. disable — функция ограничения частоты ведения журнала отключена. manual — ограничения частоты для системы и устройства настраиваются независимо; если ограничение не настроено, оно отсутствует. Варианты: `"disable"` `"manual"`
ratelimits list / elements=dictionary	Ограничения частоты.
filter string	Фильтр устройства или ADOM в соответствии с параметром filter-type; поддерживаются шаблонные выражения.
filter_type псевдонимы: filter-type string	Тип фильтра устройства. devid — идентификатор устройства. adom — имя ADOM. Варианты: `"devid"` `"adom"`
id integer	Идентификатор фильтра.
ratelimit integer	Максимальное ограничение частоты журналов.
system_ratelimit псевдонимы: system-ratelimit integer	Максимальное ограничение частоты системных журналов.
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: Logging rate limit.
      fortinet.fortimanager.fmgr_system_log_ratelimit:
        # workspace_locking_adom: <global or your adom name>
        system_log_ratelimit:
          # device:
          #   - device: <string>
          #     filter_type: <value in [devid]>
          #     id: <integer>
          #     ratelimit: <integer>
          # device_ratelimit_default: <integer>
          # mode: <value in [disable, manual]>
          # system_ratelimit: <integer>
          # ratelimits:
          #   - filter: <string>
          #     filter_type: <value in [devid, adom]>
          #     id: <integer>
          #     ratelimit: <integer>

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

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

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