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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
endpointcontrol_fctems словарь	Параметры верхнего уровня.
admin_password любой	(список) Устарело, пожалуйста, переименуйте на admin_password. Пароль администратора FortiClient EMS.
admin_username строка	Устарело, пожалуйста, переименуйте на admin_username. Имя пользователя администратора FortiClient EMS.
ca_cn_info строка	Устарело, пожалуйста, переименуйте на ca_cn_info. Сведения о CN сертификата.
call_timeout целое	Устарело, пожалуйста, переименуйте на call_timeout. Время ожидания вызова FortiClient EMS в секундах.
capabilities список / элементы=строка	Список возможностей 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"`
certificate строка	Сертификат FortiClient EMS.
certificate_fingerprint строка	Устарело, пожалуйста, переименуйте на certificate_fingerprint. Отпечаток сертификата EMS.
cloud_authentication_access_key строка	Устарело, пожалуйста, переименуйте на cloud_authentication_access_key. Ключ доступа к облачной многопользовательской среде FortiClient EMS.
cloud_server_type строка	Устарело, пожалуйста, переименуйте на cloud_server_type. Тип облачного сервера. Варианты: `"production"` `"alpha"` `"beta"`
dirty_reason строка	Устарело, пожалуйста, переименуйте на dirty_reason. Причина изменения состояния FortiClient EMS. Варианты: `"none"` `"mismatched-ems-sn"`
ems_id целое	Устарело, пожалуйста, переименуйте на ems_id. Идентификатор EMS в порядке.
fortinetone_cloud_authentication строка	Устарело, пожалуйста, переименуйте на fortinetone_cloud_authentication. Включить/выключить аутентификацию облачного сервиса FortiClient EMS. Варианты: `"disable"` `"enable"`
https_port целое	Устарело, пожалуйста, переименуйте на https_port. Номер порта HTTPS-доступа к FortiClient EMS.
interface строка	Укажите исходящий интерфейс для связи с сервером.
interface_select_method строка	Устарело, пожалуйста, переименуйте на interface_select_method. Укажите, как выбрать исходящий интерфейс для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`

name string / обязательно	Сервер управления FortiClient Enterprise
out-of-sync-threshold целое число	Устарело, пожалуйста, переименуйте на out_of_sync_threshold. Пороговое значение устаревших ресурсов в секундах
preserve-ssl-session строка	Устарело, пожалуйста, переименуйте на preserve_ssl_session. Включить/выключить сохранение подключения сессии SSL EMS. Варианты: `"disable"` `"enable"`
pull-avatars строка	Устарело, пожалуйста, переименуйте на pull_avatars. Включить/выключить извлечение аватаров из EMS. Варианты: `"disable"` `"enable"`
pull-malware-hash строка	Устарело, пожалуйста, переименуйте на pull_malware_hash. Включить/выключить извлечение хэша вредоносного ПО FortiClient из EMS. Варианты: `"disable"` `"enable"`
pull-sysinfo строка	Устарело, пожалуйста, переименуйте на pull_sysinfo. Включить/выключить извлечение SysInfo из EMS. Варианты: `"disable"` `"enable"`
pull-tags строка	Устарело, пожалуйста, переименуйте на pull_tags. Включить/выключить извлечение пользовательских тегов FortiClient из EMS. Варианты: `"disable"` `"enable"`
pull-vulnerabilities строка	Устарело, пожалуйста, переименуйте на pull_vulnerabilities. Включить/выключить извлечение уязвимостей из EMS. Варианты: `"disable"` `"enable"`
send-tags-to-all-vdoms строка	Устарело, пожалуйста, переименуйте на send_tags_to_all_vdoms. Снять ограничения на теги, чтобы отправлять все теги EMS во все VDOMы Варианты: `"disable"` `"enable"`
serial-number строка	Устарело, пожалуйста, переименуйте на serial_number. Серийный номер EMS FortiClient.
server строка	FQDN или IPv4-адрес EMS FortiClient.
source-ip строка	Устарело, пожалуйста, переименуйте на source_ip. IP-адрес источника вызова REST API.
status строка	Включить или выключить эту конфигурацию EMS. Варианты: `"disable"` `"enable"`
status-check-interval целое число	Устарело, пожалуйста, переименуйте на status_check_interval. Время ожидания вызова FortiClient EMS в секундах
tenant-id строка	Устарело, пожалуйста, переименуйте на tenant_id. Идентификатор арендатора EMS.
trust-ca-cn строка	Устарело, пожалуйста, переименуйте на trust_ca_cn. CN доверенного сертификата CA. Варианты: `"disable"` `"enable"`
verified-cn строка	Устарело, пожалуйста, переименуйте на verified_cn. CN сертификата EMS.
verifying-ca строка	Устарело, пожалуйста, переименуйте на verifying_ca. Самый нижний сертификат CA на Fortigate в цепочке проверенных сертификатов EMS.
websocket-override строка	Устарело, пожалуйста, переименуйте на websocket_override. Включить/выключить переопределение поведения подключения этого устройства FortiGate... Варианты: `"disable"` `"enable"`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.

proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия завершения с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия успешного завершения.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки в режиме работы с рабочей областью FortiManager. Значение может быть глобальным и другими, включая корень.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как "var-name", на "var_name". Старые имена аргументов по-прежнему доступны, но вы получите предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращён код rc, отличный от нуля. Также можно переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiClient Enterprise Management Server
      fortinet.fortimanager.fmgr_endpointcontrol_fctems:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        endpointcontrol_fctems:
          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
          certificate_fingerprint: <string>
          cloud_server_type: <value in [production, alpha, beta]>
          fortinetone_cloud_authentication: <value in [disable, enable]>
          https_port: <integer>
          name: <string>
          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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Детальное сообщение об ответе API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_endpointcontrol_fctems_module.html