Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_endpoint_control_profile — настройка профилей управления конечными устройствами FortiClient в FortiOS и FortiGate от Fortinet.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля также необходимы дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_endpoint_control_profile.

Добавлено в fortinet.fortios 2.0.0

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию и категорию профилей endpoint_control. В примерах приведены все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных. Проверено на FOS v6.0.0

Требования

На узле, на котором выполняется этот модуль, необходимы следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.

enable_log

boolean

Включить/выключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_control_profile

dictionary

Настройка профилей управления конечными устройствами FortiClient.

description

string

Описание.

device_groups

list / elements=dictionary

Группы устройств.

name

string / required

Объект группы устройств из доступных вариантов. Источник: user.device-group.name user.device-category.name.

forticlient_android_settings

dictionary

Настройки FortiClient для платформы Android.

disable_wf_when_protected

string

Включить/выключить фильтрацию веб-категорий FortiClient при защите с помощью FortiGate.

Варианты:

  • "enable"
  • "disable"

forticlient_advanced_vpn

string

Включить/выключить расширенную настройку VPN FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_advanced_vpn_buffer

string

Расширенная настройка VPN FortiClient.

forticlient_vpn_provisioning

string

Включить/выключить подготовку конфигурации VPN FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_vpn_settings

list / elements=dictionary

Настройки VPN FortiClient.

auth_method

string

Метод аутентификации.

Варианты:

  • "psk"
  • "certificate"

name

string / required

Имя VPN.

preshared_key

string

Предварительно согласованный секрет для аутентификации PSK.

remote_gw

string

IP-адрес или FQDN удаленного VPN-шлюза.

sslvpn_access_port

integer

Порт доступа SSL VPN (1–65535).

sslvpn_require_certificate

string

Включить/выключить требование сертификата клиента SSL VPN.

Варианты:

  • "enable"
  • "disable"

type

string

Тип VPN (IPsec или SSL VPN).

Варианты:

  • "ipsec"
  • "ssl"

forticlient_wf

string

Включить/выключить веб-фильтрацию FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_wf_profile

string

Применяемый профиль веб-фильтрации FortiClient. Источник: webfilter.profile.name.

forticlient_ios_settings

dictionary

Настройки FortiClient для платформы iOS.

client_vpn_provisioning

string

Подготовка конфигурации VPN FortiClient.

Варианты:

  • "enable"
  • "disable"

client_vpn_settings

list / elements=dictionary

Настройки VPN FortiClient.

auth_method

string

Метод аутентификации.

Варианты:

  • "psk"
  • "certificate"

name

string / required

Имя VPN.

preshared_key

string

Предварительно согласованный секрет для аутентификации PSK.

remote_gw

string

IP-адрес или FQDN удаленного VPN-шлюза.

sslvpn_access_port

integer

Порт доступа SSL VPN (1–65535).

sslvpn_require_certificate

string

Включить/выключить требование сертификата клиента SSL VPN.

Варианты:

  • "enable"
  • "disable"

type

string

Тип VPN (IPsec или SSL VPN).

Варианты:

  • "ipsec"
  • "ssl"

vpn_configuration_content

string

Содержимое конфигурации VPN.

vpn_configuration_name

string

Имя конфигурации VPN.

configuration_content

string

Содержимое профиля конфигурации.

configuration_name

string

Имя профиля конфигурации.

disable_wf_when_protected

string

Включить/выключить фильтрацию веб-категорий FortiClient при защите с помощью FortiGate.

Варианты:

  • "enable"
  • "disable"

distribute_configuration_profile

string

Включить/выключить распространение профиля конфигурации (файла .mobileconfig).

Варианты:

  • "enable"
  • "disable"

forticlient_wf

string

Включить/выключить веб-фильтрацию FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_wf_profile

string

Применяемый профиль веб-фильтрации FortiClient. Источник: webfilter.profile.name.

forticlient_winmac_settings

dictionary

Настройки FortiClient для платформ Windows/Mac.

av_realtime_protection

string

Включить/выключить защиту FortiClient AntiVirus в реальном времени.

Варианты:

  • "enable"
  • "disable"

av_signature_up_to_date

string

Включить/выключить обновление сигнатур FortiClient AV.

Варианты:

  • "enable"
  • "disable"

forticlient_application_firewall

string

Включить/выключить межсетевой экран приложений FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_application_firewall_list

string

Список правил межсетевого экрана приложений FortiClient. Источник: application.list.name.

forticlient_av

string

Включить/выключить сканирование FortiClient AntiVirus.

Варианты:

  • "enable"
  • "disable"

forticlient_ems_compliance

string

Включить/выключить проверку соответствия требованиям FortiClient Enterprise Management Server (EMS).

Варианты:

  • "enable"
  • "disable"

forticlient_ems_compliance_action

string

Действие при несоответствии требованиям FortiClient EMS.

Варианты:

  • "block"
  • "warning"

forticlient_ems_entries

list / elements=dictionary

Записи FortiClient EMS.

name

string / required

Имя FortiClient EMS. Источник: endpoint-control.forticlient-ems.name.

forticlient_linux_ver

string

Минимальная версия FortiClient для Linux.

forticlient_log_upload

string

Включить/выключить загрузку журналов FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_log_upload_level

string

Выберите журналы FortiClient для загрузки.

Варианты:

  • "traffic"
  • "vulnerability"
  • "event"

forticlient_log_upload_server

string

IP-адрес или FQDN сервера, на который загружать журналы FortiClient.

forticlient_mac_ver

string

Минимальная версия FortiClient для Mac OS.

forticlient_minimum_software_version

string

Включить или отключить требование к минимальному номеру версии FortiClient, используемой клиентами.

Варианты:

  • "enable"
  • "disable"

forticlient_operating_system

list / elements=dictionary

Операционная система FortiClient.

id

integer / required

Идентификатор записи операционной системы. См. <a href=’#notes’>Примечания</a>.

os_name

string

Настраиваемое имя операционной системы или формат Mac OS: x.x.x

os_type

string

Тип операционной системы.

Варианты:

  • "custom"
  • "mac-os"
  • "win-7"
  • "win-80"
  • "win-81"
  • "win-10"
  • "win-2000"
  • "win-home-svr"
  • "win-svr-10"
  • "win-svr-2003"
  • "win-svr-2003-r2"
  • "win-svr-2008"
  • "win-svr-2008-r2"
  • "win-svr-2012"
  • "win-svr-2012-r2"
  • "win-sto-svr-2003"
  • "win-vista"
  • "win-xp"
  • "ubuntu-linux"
  • "centos-linux"
  • "redhat-linux"
  • "fedora-linux"

forticlient_own_file

list / elements=dictionary

Проверка пути и имени файла приложения FortiClient.

file

string

Путь и имя файла.

id

integer / required

Идентификатор файла. См. <a href=’#notes’>Примечания</a>.

forticlient_registration_compliance_action

string

Действие при несоответствии требованиям регистрации FortiClient.

Варианты:

  • "block"
  • "warning"

forticlient_registry_entry

list / elements=dictionary

Запись реестра FortiClient.

id

integer / required

Идентификатор записи реестра. См. <a href=’#notes’>Примечания</a>.

registry_entry

string

Запись реестра.

forticlient_running_app

list / elements=dictionary

Использовать FortiClient для проверки того, запущены ли на клиенте перечисленные приложения.

app_name

string

Имя приложения.

app_sha256_signature

string

Подпись SHA256 приложения.

app_sha256_signature2

string

Подпись SHA256 приложения.

app_sha256_signature3

string

Подпись SHA256 приложения.

app_sha256_signature4

string

Подпись SHA256 приложения.

application_check_rule

string

Правило проверки приложения.

Варианты:

  • "present"
  • "absent"

id

integer / required

Идентификатор приложения. См. <a href=’#notes’>Примечания</a>.

process_name

string

Имя процесса.

process_name2

string

Имя процесса.

process_name3

string

Имя процесса.

process_name4

string

Имя процесса.

forticlient_security_posture

string

Включить или отключить параметры проверки состояния безопасности FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_security_posture_compliance_action

string

Действие при несоответствии требованиям состояния безопасности FortiClient.

Варианты:

  • "block"
  • "warning"

forticlient_system_compliance

string

Включить или отключить обеспечение соответствия системы требованиям FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_system_compliance_action

string

Блокировать клиентов, не соответствующих требованиям FortiClient, или предупреждать их.

Варианты:

  • "block"
  • "warning"

forticlient_vuln_scan

string

Включить или отключить сканирование уязвимостей FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_vuln_scan_compliance_action

string

Действие при несоответствии требованиям по уязвимостям FortiClient.

Варианты:

  • "block"
  • "warning"

forticlient_vuln_scan_enforce

string

Настроить уровень обнаруженной уязвимости, при котором выполняется действие в связи с несоответствием требованиям по уязвимостям FortiClient.

Варианты:

  • "critical"
  • "high"
  • "medium"
  • "low"
  • "info"

forticlient_vuln_scan_enforce_grace

integer

Льготный период применения результатов сканирования уязвимостей FortiClient (0–30 дней).

forticlient_vuln_scan_exempt

string

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

Варианты:

  • "enable"
  • "disable"

forticlient_wf

string

Включить или отключить веб-фильтрацию FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_wf_profile

string

Профиль веб-фильтра FortiClient для применения. Источник: webfilter.profile.name.

forticlient_win_ver

string

Минимальная версия FortiClient для Windows.

os_av_software_installed

string

Включить или отключить проверку наличия антивирусного программного обеспечения, распознаваемого операционной системой.

Варианты:

  • "enable"
  • "disable"

sandbox_address

string

Адрес FortiSandbox.

sandbox_analysis

string

Включить или отключить отправку файлов в FortiSandbox для анализа.

Варианты:

  • "enable"
  • "disable"

on_net_addr

list / elements=dictionary

Адреса для обнаружения подключения к локальной сети.

name

string / required

Объект адреса из доступных вариантов. Источник: firewall.address.name firewall.addrgrp.name.

profile_name

string / required

Имя профиля.

replacemsg_override_group

string

Выберите группу переопределения сообщения замены для управления конечными устройствами из доступных вариантов. Источник: system.replacemsg-group.name.

src_addr

list / elements=dictionary

Адреса источника.

name

string / required

Объект адреса из доступных вариантов. Источник: firewall.address.name firewall.addrgrp.name.

user_groups

list / elements=dictionary

Группы пользователей.

name

string / required

Имя группы пользователей. Источник: user.group.name.

users

list / elements=dictionary

Пользователи.

name

string / required

Имя пользователя. Источник: user.local.name.

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с пометкой member_path можно использовать для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / required

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен устаревшим; предпочтительный способ запуска плейбуков — httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure FortiClient endpoint control profiles.
  fortinet.fortios.fortios_endpoint_control_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      endpoint_control_profile:
          description: "<your_own_value>"
          device_groups:
              -
                  name: "default_name_5 (source user.device-group.name user.device-category.name)"
          forticlient_android_settings:
              disable_wf_when_protected: "enable"
              forticlient_advanced_vpn: "enable"
              forticlient_advanced_vpn_buffer: "<your_own_value>"
              forticlient_vpn_provisioning: "enable"
              forticlient_vpn_settings:
                  -
                      auth_method: "psk"
                      name: "default_name_13"
                      preshared_key: "<your_own_value>"
                      remote_gw: "<your_own_value>"
                      sslvpn_access_port: "32767"
                      sslvpn_require_certificate: "enable"
                      type: "ipsec"
              forticlient_wf: "enable"
              forticlient_wf_profile: "<your_own_value> (source webfilter.profile.name)"
          forticlient_ios_settings:
              client_vpn_provisioning: "enable"
              client_vpn_settings:
                  -
                      auth_method: "psk"
                      name: "default_name_25"
                      preshared_key: "<your_own_value>"
                      remote_gw: "<your_own_value>"
                      sslvpn_access_port: "32767"
                      sslvpn_require_certificate: "enable"
                      type: "ipsec"
                      vpn_configuration_content: "<your_own_value>"
                      vpn_configuration_name: "<your_own_value>"
              configuration_content: "<your_own_value>"
              configuration_name: "<your_own_value>"
              disable_wf_when_protected: "enable"
              distribute_configuration_profile: "enable"
              forticlient_wf: "enable"
              forticlient_wf_profile: "<your_own_value> (source webfilter.profile.name)"
          forticlient_winmac_settings:
              av_realtime_protection: "enable"
              av_signature_up_to_date: "enable"
              forticlient_application_firewall: "enable"
              forticlient_application_firewall_list: "<your_own_value> (source application.list.name)"
              forticlient_av: "enable"
              forticlient_ems_compliance: "enable"
              forticlient_ems_compliance_action: "block"
              forticlient_ems_entries:
                  -
                      name: "default_name_48 (source endpoint-control.forticlient-ems.name)"
              forticlient_linux_ver: "<your_own_value>"
              forticlient_log_upload: "enable"
              forticlient_log_upload_level: "traffic"
              forticlient_log_upload_server: "<your_own_value>"
              forticlient_mac_ver: "<your_own_value>"
              forticlient_minimum_software_version: "enable"
              forticlient_operating_system:
                  -
                      id: "56"
                      os_name: "<your_own_value>"
                      os_type: "custom"
              forticlient_own_file:
                  -
                      file: "<your_own_value>"
                      id: "61"
              forticlient_registration_compliance_action: "block"
              forticlient_registry_entry:
                  -
                      id: "64"
                      registry_entry: "<your_own_value>"
              forticlient_running_app:
                  -
                      app_name: "<your_own_value>"
                      app_sha256_signature: "<your_own_value>"
                      app_sha256_signature2: "<your_own_value>"
                      app_sha256_signature3: "<your_own_value>"
                      app_sha256_signature4: "<your_own_value>"
                      application_check_rule: "present"
                      id: "73"
                      process_name: "<your_own_value>"
                      process_name2: "<your_own_value>"
                      process_name3: "<your_own_value>"
                      process_name4: "<your_own_value>"
              forticlient_security_posture: "enable"
              forticlient_security_posture_compliance_action: "block"
              forticlient_system_compliance: "enable"
              forticlient_system_compliance_action: "block"
              forticlient_vuln_scan: "enable"
              forticlient_vuln_scan_compliance_action: "block"
              forticlient_vuln_scan_enforce: "critical"
              forticlient_vuln_scan_enforce_grace: "15"
              forticlient_vuln_scan_exempt: "enable"
              forticlient_wf: "enable"
              forticlient_wf_profile: "<your_own_value> (source webfilter.profile.name)"
              forticlient_win_ver: "<your_own_value>"
              os_av_software_installed: "enable"
              sandbox_address: "<your_own_value>"
              sandbox_analysis: "enable"
          on_net_addr:
              -
                  name: "default_name_94 (source firewall.address.name firewall.addrgrp.name)"
          profile_name: "<your_own_value>"
          replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
          src_addr:
              -
                  name: "default_name_98 (source firewall.address.name firewall.addrgrp.name)"
          user_groups:
              -
                  name: "default_name_100 (source user.group.name)"
          users:
              -
                  name: "default_name_102 (source user.local.name)"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, полученный от FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_endpoint_control_profile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API