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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия завершения будут переопределены.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия успешного завершения будут переопределены.
system_csf словарь	Настройка параметров верхнего уровня.
accept_auth_by_cert строка	Устарело, пожалуйста, переименуйте на accept_auth_by_cert. Принимать соединения с неизвестными сертификатами и запросить одобрение у администратора. disable - Не принимать SSL-соединения с неизвестными сертификатами. enable - Принимать SSL-соединения без автоматической проверки сертификата. Варианты: `"disable"` `"enable"`
authorization_request_type строка	Устарело, пожалуйста, переименуйте на authorization_request_type. Тип запроса авторизации. certificate - Запросить проверку по сертификату. serial - Запросить проверку по серийному номеру. Варианты: `"certificate"` `"serial"`
certificate строка	Сертификат.
configuration_sync строка	Устарело, пожалуйста, переименуйте на configuration_sync. Режим синхронизации конфигурации. default - Синхронизировать конфигурацию IPAM, FortiAnalyzer, FortiSandbox и Централизованного управления с узлом корня. local - Не синхронизировать конфигурацию с узлом корня. Варианты: `"default"` `"local"`
downstream_access строка	Устарело, пожалуйста, переименуйте на downstream_access. Включить/выключить доступ устройств по нисходящей линии к конфигурации и данным этого устройства. disable - Отключить доступ устройств по нисходящей линии к конфигурации и данным этого устройства. enable - Включить доступ устройств по нисходящей линии к конфигурации и данным этого устройства. Варианты: `"disable"` `"enable"`
downstream_accprofile строка	Устарело, пожалуйста, переименуйте на downstream_accprofile. Профили доступа по умолчанию для запросов от устройств по нисходящей линии.
fabric_connector список / элементы=словарь	Устарело, пожалуйста, переименуйте на fabric_connector. Коннектор к системе.
accprofile строка	Переопределить профиль доступа.
configuration_write_access строка	Устарело, пожалуйста, переименуйте на configuration_write_access. Включить/выключить доступ устройств по нисходящей линии к записи конфигурации. disable - Отключить доступ устройств по нисходящей линии к записи конфигурации. enable - Включить доступ устройств по нисходящей линии к записи конфигурации. Варианты: `"disable"` `"enable"`
serial строка	Серийный номер.

END_OF_DOCUMENT_MARKER

fabric-object-unification string	Устарело, пожалуйста, переименуйте на fabric_object_unification. Объединение объектов CMDB ткани. local - Объекты глобальной CMDB не будут синхронизироваться с этим устройством и из него. default - Объекты глобальной CMDB будут синхронизированы в Security Fabric. Варианты: `"local"` `"default"`
fabric-workers integer	Устарело, пожалуйста, переименуйте на fabric_workers. Количество рабочих процессов для демона Security Fabric.
file-mgmt string	Устарело, пожалуйста, переименуйте на file_mgmt. Включить/выключить управление файлами демона Security Fabric. disable - Выключить управление файлами демона. enable - Включить управление файлами демона. Варианты: `"disable"` `"enable"`
file-quota integer	Устарело, пожалуйста, переименуйте на file_quota. Максимальный объем памяти, который могут использовать файлы демона.
file-quota-warning integer	Устарело, пожалуйста, переименуйте на file_quota_warning. Выводить предупреждение, когда заданный процент квоты использован.
fixed-key list / elements=string	Устарело, пожалуйста, переименуйте на fixed_key. Автоматически сгенерированный фиксированный ключ, используемый, когда это устройство является корневым.
... (rest of the translated table)

END_OF_DOCUMENT_MARKER

индекс целое число	Индекс дочернего элемента в дереве.
имя строка	Имя.
серийный номер строка	Серийный номер.
upstream строка	IP/FQDN устройства FortiGate, являющегося upstream для данного устройства FortiGate в Security Fabric.
upstream-confirm строка	Устарело, пожалуйста, переименуйте на upstream_confirm. Подтверждение авторизации upstream. discover - Получить информацию об устройстве upstream. confirm - Подтвердить доступ к устройству upstream. Варианты: `"discover"` `"confirm"`
upstream-port целое число	Устарело, пожалуйста, переименуйте на upstream_port. Номер порта для связи с устройством FortiGate, являющимся upstream для данного…
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 помогают в этой работе.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой 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: Add this device to a Security Fabric or set up a new Security Fabric on this device.
      fortinet.fortimanager.fmgr_system_csf:
        # 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, ...]
        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]>

Значения возврата

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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_system_csf_module.html