Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_csf.

Добавлено в fortinet.fortios 2.0.0

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

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

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, с которым нужно выполнить операцию.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с указанным member_path можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

system_csf

dictionary

Добавить этот FortiGate в Security Fabric или настроить новую Security Fabric на этом FortiGate.

accept_auth_by_cert

string

Принимать подключения с неизвестными сертификатами и запрашивать у администратора разрешение.

Варианты:

  • "disable"
  • "enable"

authorization_request_type

string

Тип запроса на авторизацию.

Варианты:

  • "serial"
  • "certificate"

certificate

string

Сертификат. Источник: certificate.local.name.

configuration_sync

string

Режим синхронизации конфигурации.

Варианты:

  • "default"
  • "local"

downstream_access

string

Включить или отключить для нижестоящих устройств доступ к конфигурации и данным этого устройства.

Варианты:

  • "enable"
  • "disable"

downstream_accprofile

string

Профиль доступа по умолчанию для запросов от нижестоящих устройств. Источник: system.accprofile.name.

fabric_connector

list / elements=dictionary

Конфигурация коннектора Fabric.

accprofile

string

Переопределить профиль доступа. Источник: system.accprofile.name.

configuration_write_access

string

Включить или отключить для нижестоящих устройств доступ на запись к конфигурации.

Варианты:

  • "enable"
  • "disable"

serial

string / обязательный

Серийный номер.

vdom

list / elements=dictionary

Виртуальные домены, к которым имеет доступ коннектор. Если ни один домен не задан, коннектор получит доступ только к тому VDOM, через который он подключается к Security Fabric.

name

string / обязательный

Имя виртуального домена. Источник: system.vdom.name.

fabric_device

list / elements=dictionary

Конфигурация устройства Fabric.

access_token

string

Токен доступа к устройству.

device_ip

string

IP-адрес устройства.

device_type

string

Тип устройства.

Варианты:

  • "fortimail"

https_port

integer

Порт HTTPS устройства Fabric.

login

string

Имя учетной записи для входа на устройство.

name

string / обязательный

Имя устройства.

password

string

Пароль для входа на устройство.

fabric_object_unification

string

Унификация объектов CMDB в Fabric.

Варианты:

  • "default"
  • "local"

fabric_workers

integer

Количество рабочих процессов демона Security Fabric.

file_mgmt

string

Включить или отключить управление файлами демона Security Fabric.

Варианты:

  • "enable"
  • "disable"

file_quota

integer

Максимальный объем памяти в байтах, который могут занимать файлы демона.

file_quota_warning

integer

Выдать предупреждение, когда будет использован заданный процент квоты.

fixed_key

string

Автоматически создаваемый фиксированный ключ, используемый, когда это устройство является корневым. (Если ключ не задан, он будет создан автоматически.)

forticloud_account_enforcement

string

Унификация учетных записей FortiCloud в Fabric.

Варианты:

  • "enable"
  • "disable"

group_name

string

Имя группы Security Fabric. Все FortiGate в Security Fabric должны иметь одинаковое имя группы.

group_password

string

Пароль группы Security Fabric. При использовании устаревшей аутентификации у участников Fabric должен быть одинаковый пароль группы.

legacy_authentication

string

Включить или отключить устаревшую аутентификацию.

Варианты:

  • "disable"
  • "enable"

log_unification

string

Включить или отключить широковещательную рассылку сообщений обнаружения для унификации журналов.

Варианты:

  • "disable"
  • "enable"

management_ip

string

IP-адрес управления этим FortiGate. Используется для входа на этот FortiGate с другого FortiGate в Security Fabric.

management_port

integer

Переопределение порта для подключения управления (переопределяет порт администратора).

saml_configuration_sync

string

Синхронизация конфигурации параметров SAML.

Варианты:

  • "default"
  • "local"

source_ip

string

IP-адрес источника для связи с вышестоящим FortiGate.

status

string

Включить или отключить Security Fabric.

Варианты:

  • "enable"
  • "disable"

trusted_list

list / elements=dictionary

Предварительно авторизованные и заблокированные узлы Security Fabric.

action

string

Действие авторизации Security Fabric.

Варианты:

  • "accept"
  • "deny"

authorization_type

string

Тип авторизации.

Варианты:

  • "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 устройства в Security Fabric.

upstream_interface

string

Укажите исходящий интерфейс для подключения к серверу. Источник: system.interface.name.

upstream_interface_select_method

string

Укажите способ выбора исходящего интерфейса для подключения к серверу.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

upstream_ip

string

IP-адрес вышестоящего по отношению к этому FortiGate устройства в Security Fabric.

upstream_port

integer

Номер порта для связи с вышестоящим по отношению к этому FortiGate устройством в Security Fabric.

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревшая библиотека fortiosapi больше не поддерживается; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- 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>"
          legacy_authentication: "disable"
          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_46"
                  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

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_csf_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API