Модуль fortinet.fortimanager.fmgr_fmupdate_fdssetting — настройка параметров FortiGuard.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_fmupdate_fdssetting.
Добавлено в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
fmupdate_fdssetting dictionary | Набор параметров верхнего уровня. |
|
fds_clt_ssl_protocol псевдонимы: fds-clt-ssl-protocol string |
Версия протокола SSL для подключения к серверу FDS sslv3 — установить SSLv3 в качестве версии клиента. tlsv1. tlsv1. tlsv1. Варианты:
|
|
fds_ssl_protocol псевдонимы: fds-ssl-protocol string |
Версия протокола SSL для приема подключений FGT sslv3 — установить SSLv3 в качестве самой младшей версии. tlsv1. tlsv1. tlsv1. Варианты:
|
|
fmtr_log псевдонимы: fmtr-log string |
Уровень ведения журнала fmtr emergency — уровень журнала: критическая ситуация alert — уровень журнала: тревога critical — уровень журнала: критический error — уровень журнала: ошибка warn — уровень журнала: предупреждение notice — уровень журнала: уведомление info — уровень журнала: информация debug — уровень журнала: отладка disable — отключить журнал linkd Варианты:
|
|
fortiguard_anycast псевдонимы: fortiguard-anycast string |
Включить или отключить использование сети anycast FortiGuard disable — отключить параметр. enable — включить параметр. Варианты:
|
|
fortiguard_anycast_source псевдонимы: fortiguard-anycast-source string |
Настройка серверов Fortinet, которые предоставляют службы FortiGuard в сети anycast FortiGuard. fortinet — использовать серверы Fortinet для предоставления служб FortiGuard в сети anycast FortiGuard. aws — использовать серверы AWS компании Fortinet для предоставления служб FortiGuard в сети anycast FortiGuard. Варианты:
|
|
linkd_log псевдонимы: linkd-log string |
Уровень ведения журнала linkd emergency — уровень журнала: критическая ситуация alert — уровень журнала: тревога critical — уровень журнала: критический error — уровень журнала: ошибка warn — уровень журнала: предупреждение notice — уровень журнала: уведомление info — уровень журнала: информация debug — уровень журнала: отладка disable — отключить журнал linkd Варианты:
|
|
max_av_ips_version псевдонимы: max-av-ips-version integer |
Максимальное количество загружаемых полных версий пакетов AV/IPS |
|
max_work псевдонимы: max-work integer |
Максимальное количество рабочих процессов для обработки запросов на загрузку |
|
push_override псевдонимы: push-override dictionary |
Переопределение push-обновлений. |
|
ip string |
Внешний или виртуальный IP-адрес устройства NAT, которое будет перенаправлять push-сообщения на устройство FortiManager. |
|
port integer |
Номер принимающего порта на устройстве NAT |
|
status string |
Включить или отключить push-обновления для клиентов disable — отключить параметр. enable — включить параметр. Варианты:
|
|
push_override_to_client псевдонимы: push-override-to-client dictionary |
Переопределение push-обновлений для клиента. |
|
announce_ip псевдонимы: announce-ip list / элементы=dictionary |
Объявляемый IP-адрес. |
|
id integer |
Идентификатор объявляемого IP-адреса |
|
ip string |
Объявляемый IPv4-адрес. |
|
port integer |
Порт объявляемого IP-адреса |
|
status string |
Включить или отключить push-обновления disable — отключить параметр. enable — включить параметр. Варианты:
|
|
send_report string |
Отправлять отчеты/FSSI на сервер FDS. disable — отключить параметр. enable — включить параметр. Варианты:
|
|
send_setup string |
Пересылать сведения о настройке на сервер FDS. disable — отключить параметр. enable — включить параметр. Варианты:
|
|
server_override псевдонимы: server-override dictionary |
Переопределение сервера. |
|
servlist list / элементы=dictionary |
Список серверов. |
|
id integer |
Идентификатор переопределяемого сервера |
|
ip string |
IPv4-адрес переопределяемого сервера. |
|
ip6 string |
IPv6-адрес переопределяемого сервера. |
|
port integer |
Номер порта для подключения к FortiGuard |
|
service_type псевдонимы: service-type any |
(список или строка) Переопределяемый тип службы. fds — конфигурация переопределения сервера для fds fct — конфигурация переопределения сервера для fct Варианты:
|
|
status string |
Статус переопределения. disable — отключить параметр. enable — включить параметр. Варианты:
|
|
system_support_fai псевдонимы: system-support-fai list / элементы=string |
Поддерживаемые версии FortiNDR. Варианты:
|
|
system_support_faz псевдонимы: system-support-faz list / элементы=string |
Поддерживаемые версии FortiAnalyzer. Варианты:
|
|
system_support_fct псевдонимы: system-support-fct list / элементы=string |
Поддерживаемые версии FortiClient. Варианты:
|
|
system_support_fdc псевдонимы: system-support-fdc list / элементы=string |
Поддерживаемые версии FortiDeceptor. Варианты:
|
|
system_support_fgt псевдонимы: system-support-fgt list / элементы=string |
Поддерживаемые версии FortiOS. Варианты:
|
|
system_support_fis псевдонимы: system-support-fis list / элементы=string |
Поддерживаемые версии FortiIsolator. Варианты:
|
|
system_support_fml псевдонимы: system-support-fml list / элементы=string |
Поддерживаемые версии FortiMail. Варианты:
|
|
system_support_fsa псевдонимы: system-support-fsa list / элементы=string |
Поддерживаемые версии FortiSandbox. Варианты:
|
|
system_support_fsw псевдонимы: system-support-fsw list / элементы=string |
Поддерживаемые версии FortiSwitch. Варианты:
|
|
system_support_fts псевдонимы: system-support-fts list / элементы=string |
Поддерживаемые версии FortiTester. Варианты:
|
|
umsvc_log псевдонимы: umsvc-log строка |
Уровень ведения журнала um_service emergency — уровень ведения журнала — emergency alert — уровень ведения журнала — alert critical — уровень ведения журнала — critical error — уровень ведения журнала — error warn — уровень ведения журнала — warn notice — уровень ведения журнала — notice info — уровень ведения журнала — info debug — уровень ведения журнала — debug disable — отключить журнал linkd Допустимые значения:
|
|
unreg_dev_option псевдонимы: unreg-dev-option строка |
Задать параметр для незарегистрированных устройств ignore — игнорировать все незарегистрированные устройства. svc-only — разрешить запросы на обновление без добавления устройства. add-service — добавить незарегистрированные устройства и разрешить запрос на обновление. Допустимые значения:
|
|
update_schedule псевдонимы: update-schedule словарь |
Расписание обновлений. |
|
day строка |
Укажите день обновления, если частота задана как еженедельная Sunday — обновлять каждое воскресенье. Monday — обновлять каждый понедельник. Tuesday — обновлять каждый вторник. Wednesday — обновлять каждую среду. Thursday — обновлять каждый четверг. Friday — обновлять каждую пятницу. Saturday — обновлять каждую субботу. Допустимые значения:
|
|
frequency строка |
Настроить частоту обновлений every — интервал времени. daily — каждый день. weekly — каждую неделю. Допустимые значения:
|
|
status строка |
Включить или отключить запланированные обновления. disable — отключить настройку. enable — включить настройку. Допустимые значения:
|
|
time любой |
(список) Интервал времени между обновлениями или час и минута запуска обновления |
|
User_Agent псевдонимы: User-Agent строка |
Настроить строку user agent. |
|
wanip_query_mode псевдонимы: wanip-query-mode строка |
Режим запроса публичного IP-адреса disable — не запрашивать публичный IP-адрес ipify — получать публичный IP-адрес через HTTPS Допустимые значения:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Метод, переопределяющий базовый запрос Json RPC. Допустимые значения:
|
rc_failed список / элементы=целое число | Список кодов rc, для которых переопределяются условия сбоя. |
rc_succeeded список / элементы=целое число | Список кодов rc, для которых переопределяются условия успешного выполнения. |
workspace_locking_adom строка | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; в качестве значения можно указать global или другие значения, включая 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
gather_facts: false
tasks:
- name: Configure FortiGuard settings.
fortinet.fortimanager.fmgr_fmupdate_fdssetting:
# workspace_locking_adom: <global or your adom name>
fmupdate_fdssetting:
# User_Agent: <string>
# fds_clt_ssl_protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
# fds_ssl_protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
# fmtr_log: <value in [emergency, alert, critical, ...]>
# linkd_log: <value in [emergency, alert, critical, ...]>
# max_av_ips_version: <integer>
# max_work: <integer>
# push_override:
# ip: <string>
# port: <integer>
# status: <value in [disable, enable]>
# push_override_to_client:
# announce_ip:
# - id: <integer>
# ip: <string>
# port: <integer>
# status: <value in [disable, enable]>
# send_report: <value in [disable, enable]>
# send_setup: <value in [disable, enable]>
# server_override:
# servlist:
# - id: <integer>
# ip: <string>
# ip6: <string>
# port: <integer>
# service_type: ["fds", "fct", "fai"]
# status: <value in [disable, enable]>
# system_support_fct: ["4.x", "5.0", "5.2", "5.4", "5.6", "6.0", "6.2", "6.4", "7.0",
# "7.2", "7.4"]
# system_support_fgt: ["5.4", "5.6", "6.0", "6.2", "6.4", "7.0", "7.2", "7.4", "7.6"]
# system_support_fml: ["4.x", "5.x", "6.x", "6.0", "6.2", "6.4", "7.0", "7.2", "7.x"]
# system_support_fsa: ["1.x", "2.x", "3.x", "4.x", "3.0", "3.1", "3.2", "5.x"]
# system_support_fsw: ["5.4", "5.6", "6.0", "6.2", "4.x", "5.0", "5.2", "6.4"]
# umsvc_log: <value in [emergency, alert, critical, ...]>
# unreg_dev_option: <value in [ignore, svc-only, add-service]>
# update_schedule:
# day: <value in [Sunday, Monday, Tuesday, ...]>
# frequency: <value in [every, daily, weekly]>
# status: <value in [disable, enable]>
# time: <list or string>
# wanip_query_mode: <value in [disable, ipify]>
# fortiguard_anycast: <value in [disable, enable]>
# fortiguard_anycast_source: <value in [fortinet, aws]>
# system_support_fdc: ["3.x", "4.x", "5.x", "6.x"]
# system_support_fts: ["3.x", "4.x", "7.x"]
# system_support_faz: ["6.x", "7.x"]
# system_support_fis: ["1.x", "2.x"]
# system_support_fai: ["7.x"]
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_fmupdate_fdssetting_module.html