модуль fortinet.fortimanager.fmgr_endpointcontrol_fctems – Настройка сервера управления FortiClient Enterprise

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_endpointcontrol_fctems.

Добавлено в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр	Описание
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True, только если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
endpointcontrol_fctems dictionary	Набор параметров верхнего уровня.
admin_password псевдонимы: admin-password any	(список) Пароль администратора FortiClient EMS.
admin_username псевдонимы: admin-username string	Имя пользователя администратора FortiClient EMS.
ca_cn_info псевдонимы: ca-cn-info string	Сведения о CN центра сертификации.
call_timeout псевдонимы: call-timeout integer	Время ожидания вызова FortiClient EMS в секундах
capabilities list / элементы=string	Список возможностей EMS. Варианты: `"fabric-auth"` `"silent-approval"` `"websocket"` `"websocket-malware"` `"push-ca-certs"` `"common-tags-api"` `"tenant-id"` `"single-vdom-connector"` `"client-avatars"` `"fgt-sysinfo-api"` `"ztna-server-info"` `"used-tags"`
certificate string	Сертификат FortiClient EMS.
certificate_fingerprint псевдонимы: certificate-fingerprint string	Отпечаток сертификата EMS.
cloud_authentication_access_key псевдонимы: cloud-authentication-access-key string	Ключ доступа к многопользовательской облачной среде FortiClient EMS
cloud_server_type псевдонимы: cloud-server-type string	Тип облачного сервера. Варианты: `"production"` `"alpha"` `"beta"`
dirty_reason псевдонимы: dirty-reason string	Причина состояния dirty для FortiClient EMS. Варианты: `"none"` `"mismatched-ems-sn"`
ems_id псевдонимы: ems-id integer	Порядковый номер EMS
fortinetone_cloud_authentication псевдонимы: fortinetone-cloud-authentication string	Включить или отключить аутентификацию FortiClient EMS Cloud через учетную запись FortiCloud. Варианты: `"disable"` `"enable"`
https_port псевдонимы: https-port integer	Номер порта HTTPS-доступа к FortiClient EMS.
interface string	Укажите исходящий интерфейс для подключения к серверу.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
name string / обязательный	Сервер управления FortiClient Enterprise
out_of_sync_threshold псевдонимы: out-of-sync-threshold integer	Порог устаревания ресурса в секундах
preserve_ssl_session псевдонимы: preserve-ssl-session string	Включить или отключить сохранение SSL-сеанса соединения EMS. Варианты: `"disable"` `"enable"`
pull_avatars псевдонимы: pull-avatars string	Включить или отключить получение аватаров из EMS. Варианты: `"disable"` `"enable"`
pull_malware_hash псевдонимы: pull-malware-hash string	Включить или отключить получение хешей вредоносных программ FortiClient из EMS. Варианты: `"disable"` `"enable"`
pull_sysinfo псевдонимы: pull-sysinfo string	Включить или отключить получение SysInfo из EMS. Варианты: `"disable"` `"enable"`
pull_tags псевдонимы: pull-tags string	Включить или отключить получение тегов пользователей FortiClient из EMS. Варианты: `"disable"` `"enable"`
pull_vulnerabilities псевдонимы: pull-vulnerabilities string	Включить или отключить получение сведений об уязвимостях из EMS. Варианты: `"disable"` `"enable"`
send_tags_to_all_vdoms псевдонимы: send-tags-to-all-vdoms string	Ослабить ограничения на теги, чтобы отправлять все теги EMS во все VDOM Варианты: `"disable"` `"enable"`
serial_number псевдонимы: serial-number string	Серийный номер FortiClient EMS.
server string	Полное доменное имя или IPv4-адрес FortiClient EMS.
source_ip псевдонимы: source-ip string	IP-адрес источника вызова REST API.
status string	Включить или отключить эту конфигурацию EMS. Варианты: `"disable"` `"enable"`
status_check_interval псевдонимы: status-check-interval integer	Время ожидания вызова FortiClient EMS в секундах
tenant_id псевдонимы: tenant-id string	Идентификатор клиента EMS.
trust_ca_cn псевдонимы: trust-ca-cn string	Доверенный CN центра сертификации. Варианты: `"disable"` `"enable"`
verified_cn псевдонимы: verified-cn string	CN сертификата EMS.
verifying_ca псевдонимы: verifying-ca string	Сертификат CA с самым низким уровнем в проверенной цепочке сертификатов EMS на FortiGate.
websocket_override псевдонимы: websocket-override string	Включить или отключить переопределение поведения при подключении этого устройства FortiGate к EMS через WebSocket. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, для которых переопределяются условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, для которых переопределяются условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который нужно заблокировать в FortiManager, работающем в режиме рабочей области. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure FortiClient Enterprise Management Server
      fortinet.fortimanager.fmgr_endpointcontrol_fctems:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        endpointcontrol_fctems:
          name: "your value" # Required variable, string
          # call_timeout: <integer>
          # capabilities: ["fabric-auth", "silent-approval", "websocket", "websocket-malware",
          #                "push-ca-certs", "common-tags-api", "tenant-id",
          #                "single-vdom-connector", "client-avatars", "fgt-sysinfo-api",
          #                "ztna-server-info", "used-tags"]
          # certificate_fingerprint: <string>
          # cloud_server_type: <value in [production, alpha, beta]>
          # fortinetone_cloud_authentication: <value in [disable, enable]>
          # https_port: <integer>
          # out_of_sync_threshold: <integer>
          # preserve_ssl_session: <value in [disable, enable]>
          # pull_avatars: <value in [disable, enable]>
          # pull_malware_hash: <value in [disable, enable]>
          # pull_sysinfo: <value in [disable, enable]>
          # pull_tags: <value in [disable, enable]>
          # pull_vulnerabilities: <value in [disable, enable]>
          # server: <string>
          # source_ip: <string>
          # websocket_override: <value in [disable, enable]>
          # status_check_interval: <integer>
          # certificate: <string>
          # admin_username: <string>
          # serial_number: <string>
          # admin_password: <list or string>
          # interface: <string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # dirty_reason: <value in [none, mismatched-ems-sn]>
          # ems_id: <integer>
          # status: <value in [disable, enable]>
          # ca_cn_info: <string>
          # trust_ca_cn: <value in [disable, enable]>
          # tenant_id: <string>
          # send_tags_to_all_vdoms: <value in [disable, enable]>
          # verified_cn: <string>
          # verifying_ca: <string>
          # cloud_authentication_access_key: <string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии условий

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortimanager/fmgr_endpointcontrol_fctems_module.html