Модуль fortinet.fortios.fortios_endpoint_control_fctems – Настройка записей сервера управления FortiClient Enterprise Management Server (EMS) в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortios.fortios_endpoint_control_fctems.

Новая в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

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

ansible>=2.15

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано из графического интерфейса Fortigate.
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
endpoint_control_fctems словарь	Настройка записей сервера управления FortiClient Enterprise Management (EMS).
admin_password строка	Пароль администратора EMS FortiClient.
admin_username строка	Имя пользователя администратора EMS FortiClient.
call_timeout целое число	Таймаут вызова EMS FortiClient в секундах (1 - 180 секунд).
capabilities список / элементы=строка	Список возможностей EMS. Варианты: `"fabric-auth"` `"silent-approval"` `"websocket"` `"websocket-malware"` `"push-ca-certs"` `"common-tags-api"` `"tenant-id"` `"client-avatars"` `"single-vdom-connector"` `"fgt-sysinfo-api"` `"ztna-server-info"`
certificate строка	Сертификат EMS FortiClient. Исходный сертификат.remote.name.
cloud_authentication_access_key строка	Ключ доступа к облачной многопользовательской системе EMS FortiClient.
cloud_server_type строка	Тип облачного сервера. Варианты: `"production"` `"alpha"` `"beta"`
dirty_reason строка	Причина несоответствия для EMS FortiClient. Варианты: `"none"` `"mismatched-ems-sn"`
ems_id целое число / обязательно	Идентификатор EMS в порядке (1 - 7). См. <a href=’#notes’>Примечания</a>.
fortinetone_cloud_authentication строка	Включить/выключить аутентификацию EMS FortiClient Cloud через учетную запись FortiCloud. Варианты: `"enable"` `"disable"`
https_port целое число	Номер порта HTTPS доступа к EMS FortiClient. (1 - 65535).
interface строка	Укажите интерфейс для выхода на сервер. Имя интерфейса исходной системы.
interface_select_method строка	Укажите, как выбрать интерфейс для выхода на сервер. Варианты: `"auto"` `"sdwan"` `"specify"`
name строка	Имя сервера управления FortiClient Enterprise Management (EMS).
out_of_sync_threshold целое число	Пороговое значение устаревших ресурсов в секундах (10 - 3600).
preserve_ssl_session строка	Включить/выключить сохранение подключения сессии EMS SSL. Предупреждение, большинство пользователей не должны трогать эту настройку. Варианты: `"enable"` `"disable"`
pull_avatars строка	Включить/выключить получение аватаров из EMS. Варианты: `"enable"` `"disable"`

END_OF_DOCUMENT_MARKER

pull_malware_hash string	Включить/отключить извлечение хэша вредоносного ПО FortiClient из EMS. Choices: `"enable"` `"disable"`
pull_sysinfo string	Включить/отключить извлечение системной информации из EMS. Choices: `"enable"` `"disable"`
pull_tags string	Включить/отключить извлечение тегов пользователей FortiClient из EMS. Choices: `"enable"` `"disable"`
pull_vulnerabilities string	Включить/отключить извлечение информации об уязвимостях из EMS. Choices: `"enable"` `"disable"`
send_tags_to_all_vdoms string	Смягчить ограничения на теги, чтобы отправлять все теги EMS во все VDOM. Choices: `"enable"` `"disable"`
serial_number string	Серийный номер EMS.
server string	FQDN или IPv4-адрес FortiClient EMS.
source_ip string	Исходный IP-адрес вызова REST API.
status string	Включить или отключить эту конфигурацию EMS. Choices: `"enable"` `"disable"`
status_check_interval integer	Тайм-аут вызова FortiClient EMS в секундах (1–120 секунд).
tenant_id string	Идентификатор клиента EMS.
trust_ca_cn string	Включить/отключить доверие к центру сертификации (CA) и общему имени (CN) сертификата EMS для автоматического обновления сертификата. Choices: `"enable"` `"disable"`
verifying_ca string	Самый низкий корневой сертификат на Fortigate в проверенной цепочке сертификатов EMS. Исходный сертификат.ca.name vpn.certificate.ca.name.
websocket_override string	Включить/отключить поведение переопределения для способа подключения этого устройства FortiGate к EMS с использованием WebSocket-соединения. Choices: `"enable"` `"disable"`
member_path string	Путь к атрибуту элемента, над которым нужно выполнить операцию. Разделяется символом слэша, если атрибутов более одного. Параметр, помеченный как member_path, является допустимым для выполнения операции с элементом.
member_state string	Добавить или удалить элемент под указанным путем к атрибуту. При указании member_state параметр state игнорируется. Choices: `"present"` `"absent"`
state string / required	Указывает, нужно ли создать или удалить объект. Choices: `"present"` `"absent"`
vdom string	Виртуальный домен среди ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. Default: `"root"`

Примечания

Примечание

Мы настоятельно рекомендуем использовать собственное значение в качестве ems_id вместо 0, хотя «0» — это специальный заполнитель, который позволяет бэкенду назначать последний доступный номер для объекта, он имеет ограничения. Более подробную информацию см. в разделе «Вопросы и ответы».
Устаревший fortiosapi был удален, httpapi — предпочтительный способ запуска playbooks.
Модуль поддерживает check_mode.

Примеры

- name: Configure FortiClient Enterprise Management Server (EMS) entries.
  fortinet.fortios.fortios_endpoint_control_fctems:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      endpoint_control_fctems:
          admin_password: "<your_own_value>"
          admin_username: "<your_own_value>"
          call_timeout: "30"
          capabilities: "fabric-auth"
          certificate: "<your_own_value> (source certificate.remote.name)"
          cloud_authentication_access_key: "<your_own_value>"
          cloud_server_type: "production"
          dirty_reason: "none"
          ems_id: "<you_own_value>"
          fortinetone_cloud_authentication: "enable"
          https_port: "443"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          name: "default_name_16"
          out_of_sync_threshold: "180"
          preserve_ssl_session: "enable"
          pull_avatars: "enable"
          pull_malware_hash: "enable"
          pull_sysinfo: "enable"
          pull_tags: "enable"
          pull_vulnerabilities: "enable"
          send_tags_to_all_vdoms: "enable"
          serial_number: "<your_own_value>"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          status: "enable"
          status_check_interval: "90"
          tenant_id: "<your_own_value>"
          trust_ca_cn: "enable"
          verifying_ca: "<your_own_value> (source certificate.ca.name vpn.certificate.ca.name)"
          websocket_override: "enable"

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

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

Ключ	Описание
build string	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (id), использованный в последнем вызове 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_endpoint_control_fctems_module.html