Модуль fortinet.fortios.fortios_endpoint_control_fctems — настройка записей FortiClient Enterprise Management Server (EMS) в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создаётся в графическом интерфейсе Fortigate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
endpoint_control_fctems dictionary | Настройка записей FortiClient Enterprise Management Server (EMS). |
|
admin_password string |
Пароль администратора FortiClient EMS. |
|
admin_username string |
Имя пользователя администратора FortiClient EMS. |
|
call_timeout integer |
Тайм-аут вызова FortiClient EMS в секундах (1–180 секунд). |
|
capabilities list / elements=string |
Список возможностей EMS. Варианты:
|
|
certificate string |
Сертификат FortiClient EMS. Источник: certificate.remote.name. |
|
cloud_authentication_access_key string |
Ключ доступа к многопользовательской облачной среде FortiClient EMS Cloud |
|
cloud_server_type string |
Тип облачного сервера. Варианты:
|
|
dirty_reason string |
Причина пометки FortiClient EMS как изменённого. Варианты:
|
|
ems_id integer / обязательный |
Идентификатор EMS по порядку (1–7). См. <a href=’#notes’>Примечания</a>. |
|
fortinetone_cloud_authentication string |
Включить или отключить аутентификацию FortiClient EMS Cloud через учётную запись FortiCloud. Варианты:
|
|
https_port integer |
Номер порта HTTPS-доступа FortiClient EMS (1–65535). |
|
interface string |
Укажите исходящий интерфейс для подключения к серверу. Источник: system.interface.name. |
|
interface_select_method string |
Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты:
|
|
name string |
Имя FortiClient Enterprise Management Server (EMS). |
|
out_of_sync_threshold integer |
Порог устаревания ресурса в секундах (10–3600). |
|
preserve_ssl_session string |
Включить или отключить сохранение SSL-сеанса соединения EMS. Внимание: большинству пользователей не следует изменять этот параметр. Варианты:
|
|
pull_avatars string |
Включить или отключить получение аватаров из EMS. Варианты:
|
|
pull_malware_hash string |
Включить или отключить получение хешей вредоносного ПО FortiClient из EMS. Варианты:
|
|
pull_sysinfo string |
Включить или отключить получение SysInfo из EMS. Варианты:
|
|
pull_tags string |
Включить или отключить получение пользовательских тегов FortiClient из EMS. Варианты:
|
|
pull_vulnerabilities string |
Включить или отключить получение сведений об уязвимостях из EMS. Варианты:
|
|
send_tags_to_all_vdoms string |
Снять ограничения на теги, чтобы отправлять все теги EMS во все VDOM. Варианты:
|
|
serial_number string |
Серийный номер EMS. |
|
server string |
Полное доменное имя или IPv4-адрес FortiClient EMS. |
|
source_ip string |
IP-адрес источника вызова REST API. |
|
status string |
Включить или отключить эту конфигурацию EMS. Варианты:
|
|
status_check_interval integer |
Тайм-аут вызова FortiClient EMS в секундах (1–120 секунд). |
|
tenant_id string |
Идентификатор арендатора EMS. |
|
trust_ca_cn string |
Включить или отключить доверие к издателю сертификата EMS (CA) и общему имени (CN) для автоматического продления сертификата. Варианты:
|
|
verifying_ca string |
Сертификат CA нижнего уровня на Fortigate в проверенной цепочке сертификатов EMS. Источник: certificate.ca.name vpn.certificate.ca.name. |
|
websocket_override string |
Включить или отключить переопределение способа подключения этого устройства FortiGate к EMS через WebSocket. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанным member_path можно использовать для выполнения операции с элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Настоятельно рекомендуем использовать собственное значение ems_id вместо 0. Значение «0» — это специальный заполнитель, позволяющий серверной части назначить объекту последний доступный номер, однако у него есть ограничения. Дополнительные сведения см. в разделе «Вопросы и ответы».
- Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi.
- Модуль поддерживает 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 Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_fctems_module.html