fortinet.fortimanager.fmgr_fmupdate_fdssetting модуль — Настройка параметров FortiGuard.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation булево | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
fmupdate_fdssetting словарь | Настройка параметров верхнего уровня. |
|
fds-clt-ssl-protocol строка |
Устаревшее, пожалуйста, переименуйте на fds_clt_ssl_protocol. Версия протоколов SSL для подключения к серверу fds sslv3 - установить SSLv3 в качестве версии клиента. tlsv1. tlsv1. tlsv1. Варианты:
|
|
fds-ssl-protocol строка |
Устаревшее, пожалуйста, переименуйте на fds_ssl_protocol. Версия протоколов SSL для приема подключений fgt sslv3 - установить SSLv3 в качестве минимальной версии. tlsv1. tlsv1. tlsv1. Варианты:
|
|
fmtr-log строка |
Устаревшее, пожалуйста, переименуйте на fmtr_log. Уровень ведения журнала fmtr emergency - Уровень журнала - emergency alert - Уровень журнала - alert critical - Уровень журнала - critical error - Уровень журнала - error warn - Уровень журнала - warn notice - Уровень журнала - notice info - Уровень журнала - info debug - Уровень журнала - debug disable - Выключить журнал linkd Варианты:
|
|
fortiguard-anycast строка |
Устаревшее, пожалуйста, переименуйте на fortiguard_anycast. Включение/выключение использования сети Anycast FortiGuard disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
fortiguard-anycast-source строка |
Устаревшее, пожалуйста, переименуйте на fortiguard_anycast_source. Настройка серверов Fortinet для предоставления услуг FortiGuard в сети Anycast FortiGuard. fortinet - Использовать серверы Fortinet для предоставления услуг FortiGuard в сети Anycast FortiGuard. aws - Использовать серверы Fortinet AWS для предоставления услуг FortiGuard в сети Anycast FortiGuard. Варианты:
|
|
linkd-log строка |
Устаревшее, пожалуйста, переименуйте на linkd_log. Уровень ведения журнала linkd emergency - Уровень журнала - emergency alert - Уровень журнала - alert critical - Уровень журнала - critical error - Уровень журнала - error warn - Уровень журнала - warn notice - Уровень журнала - notice info - Уровень журнала - info debug - Уровень журнала - debug disable - Выключить журнал linkd Варианты:
|
|
max-av-ips-version целое число |
Устаревшее, пожалуйста, переименуйте на max_av_ips_version. Максимальное количество загружаемых полных пакетов AV/IPS |
|
max-work целое число |
Устаревшее, пожалуйста, переименуйте на max_work. Максимальное количество рабочих процессов обработки запросов загрузки |
|
push-override словарь |
Устаревшее, пожалуйста, переименуйте на push_override. Переопределение push. |
|
ip строка |
Внешний или виртуальный IP-адрес устройства NAT, которое будет пересылать сообщения push на устройство FortiManager. |
|
port целое число |
Номер порта приема на устройстве NAT |
|
status строка |
Включение/выключение push-обновлений для клиентов disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
push-override-to-client dictionary |
Устарело, переименуйте в push_override_to_client. Отправить переопределение клиенту. |
|
announce-ip list / elements=dictionary |
Устарело, переименуйте в announce_ip. Объявить IP. |
|
id integer |
ID объявленного IP-адреса |
|
ip string |
Объявить IPv4-адрес. |
|
port integer |
Порт объявленного IP |
|
status string |
Включить/выключить отправку обновлений disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
send_report string |
Отправить отчет/fssi на сервер FDS. disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
send_setup string |
Переслать настройку на сервер FDS. disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
server-override dictionary |
Устарело, переименуйте в server_override. Переопределение сервера. |
|
servlist list / elements=dictionary |
Список серверов. |
|
id integer |
ID переопределяемого сервера |
|
ip string |
IPv4-адрес переопределяемого сервера. |
|
ip6 string |
IPv6-адрес переопределяемого сервера. |
|
port integer |
Номер порта, используемый при обращении к FortiGuard |
|
service-type any |
(список или строка) Устарело, переименуйте в service_type. Переопределить тип сервиса. fds - Конфигурация переопределения сервера для fds fct - Конфигурация переопределения сервера для fct Варианты:
|
|
status string |
Статус переопределения. disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
system-support-fai list / elements=string |
Устарело, переименуйте в system_support_fai. Поддерживаемые версии FortiNDR. Варианты:
|
|
system-support-faz list / elements=string |
Устарело, переименуйте в system_support_faz. Поддерживаемые версии FortiAnalyzer. Варианты:
|
|
system-support-fct list / elements=string |
Устарело, переименуйте в system_support_fct. Поддерживаемые версии FortiClient. Варианты:
|
|
system-support-fdc list / elements=string |
Устарело, переименуйте в system_support_fdc. Поддерживаемые версии FortiDeceptor. Варианты:
|
|
system-support-fgt list / elements=string |
Устарело, переименуйте в system_support_fgt. Поддерживаемые версии FortiOS. Варианты:
|
|
system-support-fis list / elements=string |
Устарело, переименуйте в system_support_fis. Поддерживаемые версии FortiIsolator. Варианты:
|
|
system-support-fml list / elements=string |
Устарело, переименуйте в system_support_fml. Поддерживаемые версии FortiMail. Варианты:
|
|
system-support-fsa list / elements=string |
Устарело, переименуйте в system_support_fsa. Поддерживаемые версии FortiSandbox. Варианты:
|
|
system-support-fsw list / elements=string |
Устарело, переименуйте в system_support_fsw. Поддерживаемые версии FortiSwitch. Варианты:
|
|
system-support-fts list / elements=string |
Устарело, переименуйте в system_support_fts. Поддерживаемые версии FortiTester. Варианты:
|
|
umsvc-log string |
Устарело, переименуйте в 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 string |
Устарело, переименуйте в unreg_dev_option. Установите параметр для отключения устройств ignore - Игнорировать все незарегистрированные устройства. svc-only - Разрешить запросы на обновление без добавления устройства. add-service - Добавить незарегистрированные устройства и разрешить запрос на обновление. Варианты:
|
|
update-schedule dictionary |
Устарело, переименуйте в update_schedule. Расписание обновлений. |
|
day string |
Настройте день, когда будет выполняться обновление, если частота — еженедельно Sunday - Обновление каждое воскресенье. Monday - Обновление каждый понедельник. Tuesday - Обновление каждый вторник. Wednesday - Обновление каждую среду. Thursday - Обновление каждый четверг. Friday - Обновление каждую пятницу. Saturday - Обновление каждую субботу. Варианты:
|
|
frequency string |
Настройте частоту обновлений every - Временной интервал. daily - Каждый день. weekly - Каждую неделю. Варианты:
|
|
status string |
Включить/выключить запланированные обновления. disable - Выключить настройку. enable - Включить настройку. Варианты:
|
|
time any |
(список) Интервал времени между обновлениями или час и минута, когда происходит обновление |
|
User-Agent string |
Устаревший, переименуйте на User_Agent. Настройте строку пользователя агента. |
|
wanip-query-mode string |
Устаревший, переименуйте на wanip_query_mode. Режим запроса общедоступного IP-адреса disable - Не запрашивать общедоступный IP-адрес ipify - Получить общедоступный IP-адрес через https Варианты:
|
forticloud_access_token string | Авторизуйте клиента Ansible с помощью маркера доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список rc-кодов, с которыми будут переопределены условия для отказа. |
rc_succeeded list / elements=integer | Список rc-кодов, с которыми будут переопределены условия для успеха. |
workspace_locking_adom string | Область, которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 FortiGuard settings.
fortinet.fortimanager.fmgr_fmupdate_fdssetting:
# 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, ...]
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: # <list or string>
- 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
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
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
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_fmupdate_fdssetting_module.html