fortinet.fortimanager.fmgr_system_log_ratelimit модуль — Ограничение скорости протоколирования.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation логическое | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включение/выключение ведения журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, при которых будут переопределены условия сбоя. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых будут переопределены условия успеха. |
system_log_ratelimit словарь | Настройки параметров верхнего уровня. |
|
device список / элементы=словарь |
Устройство. |
|
device строка |
Устройство |
|
filter_type строка |
Устарело, используйте filter_type. Тип фильтра устройства. devid - ID устройства. Варианты:
|
|
id целое число |
ID фильтра устройства. |
|
ratelimit целое число |
Максимальная скорость регистрации журнала устройства. |
|
device_ratelimit_default целое число |
Устарело, используйте device_ratelimit_default. Максимальная скорость регистрации журнала устройства по умолчанию. |
|
mode строка |
Режим ограничения скорости регистрации журнала. disable - Функция ограничения скорости регистрации журнала отключена. manual - Система и устройства могут настраивать ограничения скорости, если не настроено, ограничений нет. Варианты:
|
|
ratelimits список / элементы=словарь |
Ограничения скорости. |
|
filter строка |
Фильтр устройства или ADOM в соответствии с настройкой filter_type, поддерживаются шаблоны. |
|
filter_type строка |
Устарело, используйте filter_type. Тип фильтра устройства. devid - ID устройства. adom - Имя ADOM. Варианты:
|
|
id целое число |
ID фильтра. |
|
ratelimit целое число |
Максимальная скорость регистрации журнала. |
|
system_ratelimit целое число |
Устарело, используйте system_ratelimit. Максимальная скорость регистрации системного журнала. |
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 помогают в этом.
- Обычно запуск одного модуля может завершиться ошибкой, если возвращен ненулевой rc. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров 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: Logging rate limit.
fortinet.fortimanager.fmgr_system_log_ratelimit:
# 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, ...]
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 словарь | Результат запроса. Возвращается: всегда |
|
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_system_log_ratelimit_module.html
