Модуль fortinet.fortios.fortios_system_csf – Добавление FortiGate в Security Fabric или настройка нового Security Fabric на этом FortiGate в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook укажите: fortinet.fortios.fortios_system_csf.

Новое в fortinet.fortios 2.0.0

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

Описание

Этот модуль способен настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные функции и категорию CSF. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ansible>=2.15

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токенов. Сгенерировано из графического интерфейса Fortigate.
enable_log булево	Включить/выключить ведение журнала для задачи. Выбираемые значения: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется символом косой черты, если атрибутов более одного. Параметр, помеченный member_path, является допустимым для выполнения операций с членами.
member_state строка	Добавить или удалить члена по указанному пути атрибута. Если member_state указан, параметр state игнорируется. Выбираемые значения: `"present"` `"absent"`
system_csf словарь	Добавить этот FortiGate в Security Fabric или настроить новую Security Fabric на этом FortiGate.
accept_auth_by_cert строка	Принимать подключения с неизвестными сертификатами и просить администратора одобрения. Выбираемые значения: `"disable"` `"enable"`
authorization_request_type строка	Тип запроса авторизации. Выбираемые значения: `"serial"` `"certificate"`
certificate строка	Сертификат. Источник сертификата.local.name.
configuration_sync строка	Режим синхронизации конфигурации. Выбираемые значения: `"default"` `"local"`
downstream_access строка	Включить/выключить доступ к конфигурации и данным устройства с помощью подсистемных устройств. Выбираемые значения: `"enable"` `"disable"`
downstream_accprofile строка	Профили доступа по умолчанию для запросов с подсистемных устройств. Источник system.accprofile.name.
fabric_connector список / элементы=словарь	Настройка Fabric Connector.
accprofile строка	Замена профиля доступа. Источник system.accprofile.name.
configuration_write_access строка	Включить/выключить доступ к конфигурации подсистемных устройств. Выбираемые значения: `"enable"` `"disable"`
serial строка / обязательно	Серийный номер.
vdom список / элементы=словарь	Виртуальные домены, к которым имеет доступ соединитель. Если не указано, соединитель будет иметь доступ только к VDOM, через который он подключился к Security Fabric.
name строка / обязательно	Имя виртуального домена. Источник system.vdom.name.
fabric_device список / элементы=словарь	Настройка устройства Fabric.
access_token строка	Токен доступа к устройству.
device_ip строка	IP-адрес устройства.
device_type строка	Тип устройства. Выбираемые значения: `"fortimail"`

END_OF_DOCUMENT_MARKER

https_port integer	Порт HTTPS для устройства Fabric.
login string	Имя для входа на устройство.
name string / required	Имя устройства.
password string	Пароль для входа на устройство.
fabric_object_unification string	Унификация объектов Fabric CMDB. Choices: `"default"` `"local"`
fabric_workers integer	Количество рабочих процессов для демона Security Fabric.
file_mgmt string	Включить/отключить управление файлами демона Security Fabric. Choices: `"enable"` `"disable"`
file_quota integer	Максимальный объем памяти, который может использоваться файлами демона (в байтах).
file_quota_warning integer	Выдать предупреждение, когда используется заданный процент квоты.
fixed_key string	Автоматически генерируемый фиксированный ключ, используемый, когда это устройство является корневым. (Будет автоматически сгенерирован, если не задан.)
forticloud_account_enforcement string	Унификация учетных записей FortiCloud в Fabric. Choices: `"enable"` `"disable"`
group_name string	Имя группы Security Fabric. Все FortiGate в Security Fabric должны иметь одно и то же имя группы.
group_password string	Пароль группы Security Fabric. Все FortiGate в Security Fabric должны иметь один и тот же групповой пароль.
log_unification string	Включить/отключить широковещательную рассылку сообщений обнаружения для унификации журналов. Choices: `"disable"` `"enable"`
management_ip string	IP-адрес управления этим FortiGate. Используется для входа на этот FortiGate с другого FortiGate в Security Fabric.
management_port integer	Переопределение порта для управляющего соединения (переопределяет административный порт).
saml_configuration_sync string	Синхронизация конфигурации параметров SAML. Choices: `"default"` `"local"`
source_ip string	Исходный IP-адрес для связи с вышестоящим FortiGate.
status string	Включить/отключить Security Fabric. Choices: `"enable"` `"disable"`
trusted_list list / elements=dictionary	Предварительно авторизованные и заблокированные узлы Security Fabric.
action string	Действие авторизации Security Fabric. Choices: `"accept"` `"deny"`
authorization_type string	Тип авторизации. Choices: `"serial"` `"certificate"`

certificate string	Сертификат.
downstream_authorization string	Доверие авторизациям администратора этого узла. Варианты: `"enable"` `"disable"`
ha_members list / elements=string	Члены HA.
index integer	Индекс дочернего элемента в дереве.
name string / обязательно	Имя.
serial string	Серийный номер.
uid string	Уникальный идентификатор текущего узла CSF
upstream string	IP/FQDN FortiGate, подключенного выше по потоку к данному FortiGate в Security Fabric.
upstream_interface string	Укажите исходящий интерфейс для достижения сервера. Имя интерфейса системы-источника.
upstream_interface_select_method string	Укажите, как выбрать исходящий интерфейс для достижения сервера. Варианты: `"auto"` `"sdwan"` `"specify"`
upstream_ip string	IP-адрес FortiGate, подключенного выше по потоку к данному FortiGate в Security Fabric.
upstream_port integer	Номер порта для связи с FortiGate, подключенным выше по потоку к данному FortiGate в Security Fabric.
vdom string	Виртуальная область, определённая ранее. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использоваться как отдельный блок. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, предпочтительным способом выполнения playbooks является httpapi.

Примеры

- name: Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate.
  fortinet.fortios.fortios_system_csf:
      vdom: "{{ vdom }}"
      system_csf:
          accept_auth_by_cert: "disable"
          authorization_request_type: "serial"
          certificate: "<your_own_value> (source certificate.local.name)"
          configuration_sync: "default"
          downstream_access: "enable"
          downstream_accprofile: "<your_own_value> (source system.accprofile.name)"
          fabric_connector:
              -
                  accprofile: "<your_own_value> (source system.accprofile.name)"
                  configuration_write_access: "enable"
                  serial: "<your_own_value>"
                  vdom:
                      -
                          name: "default_name_14 (source system.vdom.name)"
          fabric_device:
              -
                  access_token: "<your_own_value>"
                  device_ip: "<your_own_value>"
                  device_type: "fortimail"
                  https_port: "443"
                  login: "<your_own_value>"
                  name: "default_name_21"
                  password: "<your_own_value>"
          fabric_object_unification: "default"
          fabric_workers: "2"
          file_mgmt: "enable"
          file_quota: "0"
          file_quota_warning: "90"
          fixed_key: "<your_own_value>"
          forticloud_account_enforcement: "enable"
          group_name: "<your_own_value>"
          group_password: "<your_own_value>"
          log_unification: "disable"
          management_ip: "<your_own_value>"
          management_port: "32767"
          saml_configuration_sync: "default"
          source_ip: "84.230.14.43"
          status: "enable"
          trusted_list:
              -
                  action: "accept"
                  authorization_type: "serial"
                  certificate: "<your_own_value>"
                  downstream_authorization: "enable"
                  ha_members: "<your_own_value>"
                  index: "0"
                  name: "default_name_45"
                  serial: "<your_own_value>"
          uid: "<your_own_value>"
          upstream: "<your_own_value>"
          upstream_interface: "<your_own_value> (source system.interface.name)"
          upstream_interface_select_method: "auto"
          upstream_ip: "<your_own_value>"
          upstream_port: "8013"

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

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

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для предоставления контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, предоставленный FortiGate после последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый в последнем запросе к FortiGate Возвращается: успех Пример: `"id"`
name строка	Имя таблицы, использованной для обработки запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для обработки запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

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

© 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_system_csf_module.html