Модуль fortinet.fortimanager.fmgr_system_npu_backgroundssescan – Настройка фонового сканирования драйвера для SSE.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_system_npu_backgroundssescan.
Новое в fortinet.fortimanager 2.2.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием в источниках данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список кодов rc, при которых будут отменены условия завершения с ошибкой. |
rc_succeeded список / элементы=целое | Список кодов rc, при которых будут отменены условия успешного завершения. |
system_npu_backgroundssescan словарь | Настройка параметров верхнего уровня. |
|
scan строка |
Включить/выключить фоновый скан SSE драйвером. Варианты:
|
|
scan_stale целое |
Устарело, пожалуйста, переименуйте в scan_stale. Настройка сканирования активных или устаревших сессий. |
|
scan_vt целое |
Устарело, пожалуйста, переименуйте в scan_vt. Выбор версии/типа для сканирования. |
|
stats_qual_access целое |
Устарело, пожалуйста, переименуйте в stats_qual_access. Квалификация доступа к обновлению статистики в секундах. |
|
stats_qual_duration целое |
Устарело, пожалуйста, переименуйте в stats_qual_duration. Квалификация времени обновления статистики в секундах. |
|
stats_update_interval целое |
Устарело, пожалуйста, переименуйте в stats_update_interval. Интервал обновления статистики. |
|
udp_keepalive_interval целое |
Устарело, пожалуйста, переименуйте в udp_keepalive_interval. Интервал ожидания UDP. |
|
udp_qual_access целое |
Устарело, пожалуйста, переименуйте в udp_qual_access. Квалификация доступа UDP ожидания в секундах. |
|
udp_qual_duration целое |
Устарело, пожалуйста, переименуйте в udp_qual_duration. Квалификация времени ожидания UDP в секундах. |
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: Configure driver background scan for SSE.
fortinet.fortimanager.fmgr_system_npu_backgroundssescan:
# 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_backgroundssescan:
scan: <value in [disable, enable]>
stats_update_interval: <integer>
udp_keepalive_interval: <integer>
scan_stale: <integer>
scan_vt: <integer>
stats_qual_access: <integer>
stats_qual_duration: <integer>
udp_qual_access: <integer>
udp_qual_duration: <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_npu_backgroundssescan_module.html
