Модуль fortinet.fortios.fortios_endpoint_control_fctems_override – Настройка записей сервера управления 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_override.
Добавлена в fortinet.fortios 2.0.0
Описание
- Этот модуль способен настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять функцию endpoint_control и категорию fctems_override. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано в интерфейсе Fortigate. |
enable_log логический | Включить/выключить ведение журнала для задачи. Варианты:
|
endpoint_control_fctems_override словарь | Настройка записей сервера управления FortiClient Enterprise Management Server (EMS). |
|
call_timeout целое число |
Таймаут вызова FortiClient EMS в секундах (1 - 180 секунд). |
|
capabilities список / элементы=строка |
Список возможностей EMS. Варианты:
|
|
cloud_authentication_access_key строка |
Ключ доступа к многопользовательской облачной системе FortiClient EMS. |
|
cloud_server_type строка |
Тип облачного сервера. Варианты:
|
|
dirty_reason строка |
Причина изменения состояния для FortiClient EMS. Варианты:
|
|
ems_id целое число / обязательно |
Идентификатор EMS в порядке (1 - 7). См. <a href=’#notes’>Примечания</a>. |
|
fortinetone_cloud_authentication строка |
Включить/выключить аутентификацию FortiClient EMS Cloud через учетную запись FortiCloud. Варианты:
|
|
https_port целое число |
Номер порта HTTPS доступа FortiClient EMS. (1 - 65535). |
|
interface строка |
Укажите исходящий интерфейс для доступа к серверу. Имя интерфейса источника. |
|
interface_select_method строка |
Укажите, как выбрать исходящий интерфейс для доступа к серверу. Варианты:
|
|
name строка |
Имя сервера управления FortiClient Enterprise Management Server (EMS). |
|
out_of_sync_threshold целое число |
Пороговое значение устаревших ресурсов в секундах (10 - 3600). |
|
preserve_ssl_session строка |
Включить/выключить сохранение соединения сессии SSL EMS. Предупреждение, большинство пользователей не должны изменять эту настройку. Варианты:
|
|
pull_avatars строка |
Включить/выключить загрузку аватаров из EMS. Варианты:
|
|
pull_malware_hash строка |
Включить/выключить загрузку хэша вредоносных программ FortiClient из EMS. Варианты:
|
|
pull_sysinfo строка |
Включить/выключить загрузку 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 |
FQDN или IPv4 адрес FortiClient EMS. |
|
source_ip string |
IP-адрес источника вызова REST API. |
|
status string |
Включить или отключить эту конфигурацию EMS. Варианты:
|
|
tenant_id string |
Идентификатор арендатора EMS. |
|
trust_ca_cn string |
Включить/выключить доверие к издателю сертификата EMS (CA) и общему имени (CN) для автоматического продления сертификата. Варианты:
|
|
verifying_ca string |
Самый низкий сертификат CA на Fortigate в проверенной цепочке сертификатов EMS. Исходный сертификат.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 — предпочтительный способ выполнения playbooks.
Примеры
- name: Configure FortiClient Enterprise Management Server (EMS) entries.
fortinet.fortios.fortios_endpoint_control_fctems_override:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
endpoint_control_fctems_override:
call_timeout: "30"
capabilities: "fabric-auth"
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_13"
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"
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 строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate при последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успешно Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_override_module.html