модуль fortinet.fortimanager.fmgr_system_csf — Добавление этого устройства в Security Fabric или настройка новой Security Fabric на этом устройстве.

Примечание

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

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

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

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

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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
system_csf dictionary	Параметры верхнего уровня.
accept_auth_by_cert псевдонимы: accept-auth-by-cert string	Принимать подключения с неизвестными сертификатами и запрашивать подтверждение администратора. disable — не принимать SSL-подключения с неизвестными сертификатами. enable — принимать SSL-подключения без автоматической проверки сертификата. Варианты: `"disable"` `"enable"`
authorization_request_type псевдонимы: authorization-request-type string	Тип запроса на авторизацию. certificate — запрос проверки по сертификату. serial — запрос проверки по серийному номеру. Варианты: `"certificate"` `"serial"`
certificate string	Сертификат.
configuration_sync псевдонимы: configuration-sync string	Режим синхронизации конфигурации. default — синхронизировать конфигурацию IPAM, FortiAnalyzer, FortiSandbox и централизованного управления с корневым узлом. local — не синхронизировать конфигурацию с корневым узлом. Варианты: `"default"` `"local"`
downstream_access псевдонимы: downstream-access string	Включить или отключить для нижестоящего устройства доступ к конфигурации и данным этого устройства. disable — запретить нижестоящему устройству доступ к конфигурации и данным этого устройства. enable — разрешить нижестоящему устройству доступ к конфигурации и данным этого устройства. Варианты: `"disable"` `"enable"`
downstream_accprofile псевдонимы: downstream-accprofile string	Профиль доступа по умолчанию для запросов от нижестоящих устройств.
fabric_connector псевдонимы: fabric-connector list / elements=dictionary	Коннектор Fabric.
accprofile string	Переопределить профиль доступа.
configuration_write_access псевдонимы: configuration-write-access string	Включить или отключить для нижестоящего устройства доступ на запись к конфигурации. disable — запретить нижестоящему устройству доступ на запись к конфигурации. enable — разрешить нижестоящему устройству доступ на запись к конфигурации. Варианты: `"disable"` `"enable"`
serial string	Серийный номер.
fabric_object_unification псевдонимы: fabric-object-unification string	Унификация объектов CMDB в Fabric. local — глобальные объекты CMDB не будут синхронизироваться с этим устройством и с него. default — глобальные объекты CMDB будут синхронизироваться в Security Fabric. Варианты: `"local"` `"default"`
fabric_workers псевдонимы: fabric-workers integer	Количество рабочих процессов демона Security Fabric.
file_mgmt псевдонимы: file-mgmt string	Включить или отключить управление файлами демона Security Fabric. disable — отключить управление файлами демона. enable — включить управление файлами демона. Варианты: `"disable"` `"enable"`
file_quota псевдонимы: file-quota integer	Максимальный объём памяти, который могут занимать файлы демона.
file_quota_warning псевдонимы: file-quota-warning integer	Выводить предупреждение при использовании заданного процента квоты.
fixed_key псевдонимы: fixed-key list / elements=string	Автоматически сгенерированный фиксированный ключ, используемый, когда это устройство является корневым.
forticloud_account_enforcement псевдонимы: forticloud-account-enforcement string	Унификация учётных записей FortiCloud в Fabric. disable — отключить сопоставление идентификаторов учётных записей FortiCloud для Security Fabric. enable — включить сопоставление идентификаторов учётных записей FortiCloud для Security Fabric. Варианты: `"disable"` `"enable"`
group_name псевдонимы: group-name string	Имя группы Security Fabric.
group_password псевдонимы: group-password list / elements=string	Пароль группы Security Fabric.
log_unification псевдонимы: log-unification string	Включить или отключить широковещательную передачу сообщений обнаружения для унификации журналов. disable — отключить широковещательную передачу сообщений обнаружения для унификации журналов. enable — включить широковещательную передачу сообщений обнаружения для унификации журналов. Варианты: `"disable"` `"enable"`
saml_configuration_sync псевдонимы: saml-configuration-sync string	Синхронизация настроек SAML. local — не применять конфигурацию SAML, созданную корневым узлом. default — настройки SAML для участников Fabric создаются корневым узлом Fabric. Варианты: `"local"` `"default"`
ssl_protocol псевдонимы: ssl-protocol string	Задать минимальную версию протокола SSL для входящих и исходящих подключений. follow-global-ssl-protocol — следовать системной настройке. sslv3 — установить SSLv3 в качестве минимальной версии. tlsv1. tlsv1. tlsv1. tlsv1. Варианты: `"follow-global-ssl-protocol"` `"sslv3"` `"tlsv1.0"` `"tlsv1.1"` `"tlsv1.2"` `"tlsv1.3"`
status string	Включить или отключить Security Fabric. disable — отключить Security Fabric. enable — включить Security Fabric. Варианты: `"disable"` `"enable"`
trusted_list псевдонимы: trusted-list list / elements=dictionary	Список доверенных устройств.
action string	Действие по авторизации в Security Fabric. accept — принять запрос на авторизацию. deny — отклонить запрос на авторизацию. Варианты: `"accept"` `"deny"`
authorization_type псевдонимы: authorization-type string	Тип авторизации. serial — проверять нижестоящее устройство по серийному номеру. certificate — проверять нижестоящее устройство по сертификату. Варианты: `"serial"` `"certificate"`
certificate string	Сертификат.
downstream_authorization псевдонимы: downstream-authorization string	Доверять авторизациям администратора этого узла. disable — отключить авторизацию нижестоящих устройств. enable — включить авторизацию нижестоящих устройств. Варианты: `"disable"` `"enable"`
ha_members псевдонимы: ha-members string	Участники HA.
index integer	Индекс нижестоящего устройства в иерархии.
name string	Имя.
serial string	Серийный номер.
upstream string	IP-адрес/FQDN вышестоящего по отношению к этому FortiGate устройства FortiGate в Security Fabric.
upstream_confirm псевдонимы: upstream-confirm string	Подтверждение авторизации вышестоящего устройства. discover — обнаружить сведения о вышестоящем устройстве. confirm — подтвердить доступ вышестоящего устройства. Варианты: `"discover"` `"confirm"`
upstream_port псевдонимы: upstream-port integer	Номер порта для связи с вышестоящим по отношению к этому FortiGate устройством FortiGate в Security Fabric.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое имя, включая 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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Add this device to a Security Fabric or set up a new Security Fabric on this device.
      fortinet.fortimanager.fmgr_system_csf:
        # workspace_locking_adom: <global or your adom name>
        system_csf:
          # accept_auth_by_cert: <value in [disable, enable]>
          # authorization_request_type: <value in [certificate, serial]>
          # certificate: <string>
          # configuration_sync: <value in [default, local]>
          # downstream_access: <value in [disable, enable]>
          # downstream_accprofile: <string>
          # fabric_connector:
          #   - accprofile: <string>
          #     configuration_write_access: <value in [disable, enable]>
          #     serial: <string>
          # fabric_object_unification: <value in [local, default]>
          # fabric_workers: <integer>
          # file_mgmt: <value in [disable, enable]>
          # file_quota: <integer>
          # file_quota_warning: <integer>
          # fixed_key: <list or string>
          # forticloud_account_enforcement: <value in [disable, enable]>
          # group_name: <string>
          # group_password: <list or string>
          # log_unification: <value in [disable, enable]>
          # saml_configuration_sync: <value in [local, default]>
          # status: <value in [disable, enable]>
          # trusted_list:
          #   - action: <value in [accept, deny]>
          #     authorization_type: <value in [serial, certificate]>
          #     certificate: <string>
          #     downstream_authorization: <value in [disable, enable]>
          #     ha_members: <string>
          #     index: <integer>
          #     name: <string>
          #     serial: <string>
          # upstream: <string>
          # upstream_port: <integer>
          # upstream_confirm: <value in [discover, confirm]>
          # ssl_protocol: <value in [follow-global-ssl-protocol, sslv3, tlsv1.0, ...]>

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

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

Ключ	Описание
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_system_csf_module.html