модуль fortinet.fortios.fortios_system_sdn_connector — настройка подключения к SDN Connector в 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_sdn_connector.

Новое в fortinet.fortios 2.0.0

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

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

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя системные функции и категорию sdn_connector. Перед использованием необходимо настроить примеры, включая все параметры и значения, в соответствии с источниками данных. Проверено на 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"`
state string / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
system_sdn_connector dictionary	Настройка подключения к SDN Connector.
access_key string	Идентификатор ключа доступа AWS / ACS.
alt_resource_ip string	Включить/отключить альтернативный IP-адрес ресурса AWS. Варианты: `"disable"` `"enable"`
api_key string	Ключ API IBM Cloud или ключ API идентификатора службы.
azure_region string	Регион сервера Azure. Варианты: `"global"` `"china"` `"germany"` `"usgov"` `"local"`
client_id string	Идентификатор клиента Azure (идентификатор приложения).
client_secret string	Секрет клиента Azure (ключ приложения).
compartment_id string	Идентификатор раздела.
compartment_list list / elements=dictionary	Настройка списка разделов OCI.
compartment_id string / обязательный	Идентификатор раздела OCI.
compute_generation integer	Поколение вычислительных ресурсов для инфраструктуры IBM Cloud.
domain string	Имя домена.
external_account_list list / elements=dictionary	Настройка списка внешних учётных записей AWS.
external_id string	Внешний идентификатор AWS.
region_list list / elements=dictionary	Список названий регионов AWS.
region string / обязательный	Название региона AWS.
role_arn string / обязательный	ARN роли AWS, которую необходимо принять.
external_ip list / elements=dictionary	Настройка внешнего IP-адреса GCP.
name string / обязательный	Имя внешнего IP-адреса.
forwarding_rule list / elements=dictionary	Настройка правила переадресации GCP.
rule_name string / обязательный	Имя правила переадресации.
target string	Имя целевого экземпляра.
gcp_project string	Имя проекта GCP.
gcp_project_list list / elements=dictionary	Настройка списка проектов GCP.
gcp_zone_list list / elements=dictionary	Настройка списка зон GCP.
name string / обязательный	Имя зоны GCP.
id string / обязательный	Идентификатор проекта GCP.
group_name string	Полный путь к группе компьютеров.
ha_status string	Включить/отключить использование для службы высокой доступности FortiGate. Варианты: `"disable"` `"enable"`
ibm_region string	Название региона IBM Cloud. Варианты: `"dallas"` `"washington-dc"` `"london"` `"frankfurt"` `"sydney"` `"tokyo"` `"osaka"` `"toronto"` `"sao-paulo"` `"madrid"` `"us-south"` `"us-east"` `"germany"` `"great-britain"` `"japan"` `"australia"`
ibm_region_gen1 string	Название региона IBM Cloud с вычислительными ресурсами первого поколения. Варианты: `"us-south"` `"us-east"` `"germany"` `"great-britain"` `"japan"` `"australia"`
ibm_region_gen2 string	Название региона IBM Cloud с вычислительными ресурсами второго поколения. Варианты: `"us-south"` `"us-east"` `"great-britain"`
key_passwd string	Пароль закрытого ключа.
login_endpoint string	Конечная точка входа Azure Stack.
message_server_port integer	Номер HTTP-порта сервера сообщений SAP.
microsoft_365 string	Включить использование в качестве коннектора Microsoft 365. Варианты: `"disable"` `"enable"`
name string / обязательный	Имя коннектора SDN.
nic list / elements=dictionary	Настройка сетевого интерфейса Azure.
ip list / elements=dictionary	Настройка конфигурации IP.
name string / обязательный	Имя конфигурации IP.
private_ip string	Частный IP-адрес.
public_ip string	Имя публичного IP-адреса.
resource_group string	Группа ресурсов публичного IP-адреса Azure.
name string / обязательный	Имя сетевого интерфейса.
peer_nic string	Имя однорангового сетевого интерфейса.
oci_cert string	Сертификат OCI. Источник: certificate.local.name.
oci_fingerprint string	Отпечаток открытого ключа OCI.
oci_region string	Регион сервера OCI. Варианты: `"phoenix"` `"ashburn"` `"frankfurt"` `"london"`
oci_region_list list / elements=dictionary	Настройка списка регионов OCI.
region string / обязательный	Регион OCI.
oci_region_type string	Тип региона OCI. Варианты: `"commercial"` `"government"`
par_id string	Идентификатор диапазона публичных адресов.
password string	Пароль удалённого коннектора SDN для входа в систему.
private_key string	Закрытый ключ служебной учётной записи GCP.
proxy string	Прокси-сервер SDN. Источник: system.sdn-proxy.name.
region string	Название региона AWS / ACS.
resource_group string	Группа ресурсов Azure.
resource_url string	URL-адрес ресурса Azure Stack.

route list / elements=dictionary	Настройка маршрута GCP.
name string / обязательный	Имя маршрута.
route_table list / elements=dictionary	Настройка таблицы маршрутизации Azure.
name string / обязательный	Имя таблицы маршрутизации.
resource_group string	Группа ресурсов таблицы маршрутизации Azure.
route list / elements=dictionary	Настройка маршрута Azure.
name string / обязательный	Имя маршрута.
next_hop string	Адрес следующего узла.
subscription_id string	Идентификатор подписки таблицы маршрутизации Azure.
secret_key string	Секретный ключ доступа AWS / ACS.
secret_token string	Секретный токен сервисной учетной записи Kubernetes.
server string	Адрес сервера удаленного SDN-коннектора.
server_ca_cert string	Доверять только тем серверам, сертификат которых прямо или косвенно подписан этим сертификатом. Источник: certificate.remote.name certificate .ca.name.
server_cert string	Доверять только серверам, содержащим этот сертификат. Источник: certificate.remote.name.
server_list list / elements=dictionary	Список адресов серверов удаленного SDN-коннектора.
ip string / обязательный	Адрес IPv4.
server_port integer	Номер порта удаленного SDN-коннектора.
service_account string	Адрес электронной почты сервисной учетной записи GCP.
status string	Включить или отключить подключение к удаленному SDN-коннектору. Возможные значения: `"disable"` `"enable"`
subscription_id string	Идентификатор подписки Azure.
tenant_id string	Идентификатор арендатора (идентификатор каталога).
type string	Тип SDN-коннектора. Возможные значения: `"aci"` `"alicloud"` `"aws"` `"azure"` `"gcp"` `"nsx"` `"nuage"` `"oci"` `"openstack"` `"kubernetes"` `"vmware"` `"sepm"` `"aci-direct"` `"ibm"` `"nutanix"` `"sap"`
update_interval integer	Интервал обновления динамических объектов (30–3600 с).
use_metadata_iam string	Включить или отключить использование роли IAM из метаданных для вызова API. Возможные значения: `"disable"` `"enable"`
user_id string	Идентификатор пользователя.
username string	Имя пользователя удаленного SDN-коннектора, используемое для входа.
vcenter_password string	Пароль сервера vCenter для карантина NSX.
vcenter_server string	Адрес сервера vCenter для карантина NSX.
vcenter_username string	Имя пользователя сервера vCenter для карантина NSX.
vdom string	Имя виртуального домена удаленного SDN-коннектора. Источник: system.vdom.name.
verify_certificate string	Включить или отключить проверку сертификата сервера. Возможные значения: `"disable"` `"enable"`
vpc_id string	Идентификатор VPC AWS.
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure connection to SDN Connector.
  fortinet.fortios.fortios_system_sdn_connector:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_sdn_connector:
          access_key: "<your_own_value>"
          alt_resource_ip: "disable"
          api_key: "<your_own_value>"
          azure_region: "global"
          client_id: "<your_own_value>"
          client_secret: "<your_own_value>"
          compartment_id: "<your_own_value>"
          compartment_list:
              -
                  compartment_id: "<your_own_value>"
          compute_generation: "2"
          domain: "<your_own_value>"
          external_account_list:
              -
                  external_id: "<your_own_value>"
                  region_list:
                      -
                          region: "<your_own_value>"
                  role_arn: "<your_own_value>"
          external_ip:
              -
                  name: "default_name_20"
          forwarding_rule:
              -
                  rule_name: "<your_own_value>"
                  target: "<your_own_value>"
          gcp_project: "<your_own_value>"
          gcp_project_list:
              -
                  gcp_zone_list:
                      -
                          name: "default_name_27"
                  id: "28"
          group_name: "<your_own_value>"
          ha_status: "disable"
          ibm_region: "dallas"
          ibm_region_gen1: "us-south"
          ibm_region_gen2: "us-south"
          key_passwd: "<your_own_value>"
          login_endpoint: "<your_own_value>"
          message_server_port: "0"
          microsoft_365: "disable"
          name: "default_name_38"
          nic:
              -
                  ip:
                      -
                          name: "default_name_41"
                          private_ip: "<your_own_value>"
                          public_ip: "<your_own_value>"
                          resource_group: "<your_own_value>"
                  name: "default_name_45"
                  peer_nic: "<your_own_value>"
          oci_cert: "<your_own_value> (source certificate.local.name)"
          oci_fingerprint: "<your_own_value>"
          oci_region: "phoenix"
          oci_region_list:
              -
                  region: "<your_own_value>"
          oci_region_type: "commercial"
          par_id: "<your_own_value>"
          password: "<your_own_value>"
          private_key: "<your_own_value>"
          proxy: "<your_own_value> (source system.sdn-proxy.name)"
          region: "<your_own_value>"
          resource_group: "<your_own_value>"
          resource_url: "<your_own_value>"
          route:
              -
                  name: "default_name_61"
          route_table:
              -
                  name: "default_name_63"
                  resource_group: "<your_own_value>"
                  route:
                      -
                          name: "default_name_66"
                          next_hop: "<your_own_value>"
                  subscription_id: "<your_own_value>"
          secret_key: "<your_own_value>"
          secret_token: "<your_own_value>"
          server: "192.168.100.40"
          server_ca_cert: "<your_own_value> (source certificate.remote.name certificate.ca.name)"
          server_cert: "<your_own_value> (source certificate.remote.name)"
          server_list:
              -
                  ip: "<your_own_value>"
          server_port: "0"
          service_account: "<your_own_value>"
          status: "disable"
          subscription_id: "<your_own_value>"
          tenant_id: "<your_own_value>"
          type: "aci"
          update_interval: "60"
          use_metadata_iam: "disable"
          user_id: "<your_own_value>"
          username: "<your_own_value>"
          vcenter_password: "<your_own_value>"
          vcenter_server: "<your_own_value>"
          vcenter_username: "<your_own_value>"
          vdom: "<your_own_value> (source system.vdom.name)"
          verify_certificate: "disable"
          vpc_id: "<your_own_value>"

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

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

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