Модуль fortinet.fortios.fortios_system_sdn_connector — Настройка подключения к SDN-коннектору в FortiOS и FortiGate Fortinet.

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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.15

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерирована в веб-интерфейсе Fortigate.
enable_log логический	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется символом слеша, если атрибутов несколько. Параметр, помеченный member_path, допустим для выполнения операций с членами.
member_state строка	Добавить или удалить члена по указанному пути атрибута. При указании member_state опция state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательно	Указывает, создавать или удалять объект. Варианты: `"present"` `"absent"`
system_sdn_connector словарь	Настройка подключения к SDN-соединителю.
access_key строка	Идентификатор ключа доступа AWS/ACS.
alt_resource_ip строка	Включить/выключить альтернативный IP-адрес ресурса AWS. Варианты: `"disable"` `"enable"`
api_key строка	Ключ API IBM cloud или ключ API идентификатора службы.
azure_region строка	Регион сервера Azure. Варианты: `"global"` `"china"` `"germany"` `"usgov"` `"local"`
client_id строка	Идентификатор клиента Azure (идентификатор приложения).
client_secret строка	Секретный ключ клиента Azure (ключ приложения).
compartment_id строка	Идентификатор компартмента.
compartment_list список / элементы=словарь	Настройка списка компартментов OCI.
compartment_id строка / обязательно	Идентификатор компартмента OCI.
compute_generation целое число	Поколение вычислительных ресурсов для инфраструктуры IBM cloud.
domain строка	Имя домена.
external_account_list список / элементы=словарь	Настройка списка внешних учетных записей AWS.
external_id строка	Внешний идентификатор AWS.
region_list список / элементы=словарь	Список имен регионов AWS.
region строка / обязательно	Имя региона AWS.
role_arn строка / обязательно	ARN роли AWS, которую нужно принять.

END_OF_DOCUMENT_MARKER

external_ip list / elements=dictionary	Настроить внешний IP GCP.
name string / required	Имя внешнего IP.
forwarding_rule list / elements=dictionary	Настроить правило переадресации GCP.
rule_name string / required	Имя правила переадресации.
target string	Имя целевого экземпляра.
gcp_project string	Имя проекта GCP.
gcp_project_list list / elements=dictionary	Настроить список проектов GCP.
gcp_zone_list list / elements=dictionary	Настроить список зон GCP.
name string / required	Имя зоны GCP.
id string / required	Идентификатор проекта GCP.
group_name string	Полное имя группы компьютеров.
ha_status string	Включить/отключить использование для службы FortiGate HA. Варианты: `"disable"` `"enable"`
ibm_region string	Имя региона облака IBM. Варианты: `"dallas"` `"washington-dc"` `"london"` `"frankfurt"` `"sydney"` `"tokyo"` `"osaka"` `"toronto"` `"sao-paulo"` `"us-south"` `"us-east"` `"germany"` `"great-britain"` `"japan"` `"australia"`
ibm_region_gen1 string	Имя региона облачных вычислений IBM 1-го поколения. Варианты: `"us-south"` `"us-east"` `"germany"` `"great-britain"` `"japan"` `"australia"`
ibm_region_gen2 string	Имя региона облачных вычислений IBM 2-го поколения. Варианты: `"us-south"` `"us-east"` `"great-britain"`
key_passwd string	Пароль от закрытого ключа.
login_endpoint string	Конечная точка входа в Azure Stack.
name string / required	Имя SDN-коннектора.
nic list / elements=dictionary	Настроить сетевой интерфейс Azure.
ip list / elements=dictionary	Настроить конфигурацию IP.
name string / required	Имя конфигурации IP.
public_ip string	Имя публичного IP.

resource_group string	Группа ресурсов общедоступного IP-адреса Azure.
name string / required	Имя сетевого интерфейса.
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 / required	Регион OCI.
oci_region_type string	Тип региона OCI. Варианты: `"commercial"` `"government"`
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 / required	Имя маршрута.
route_table list / elements=dictionary	Настройка таблицы маршрутизации Azure.
name string / required	Имя таблицы маршрутизации.
resource_group string	Группа ресурсов таблицы маршрутизации Azure.
route list / elements=dictionary	Настройка маршрута Azure.
name string / required	Имя маршрута.
next_hop string	Адрес следующего перехода.
subscription_id string	ID подписки таблицы маршрутизации 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 / required	IPv4-адрес.
server_port integer	Номер порта удалённого SDN-коннектора.
service_account string	Email учётной записи сервиса GCP.
status string	Включить/отключить соединение с удалённым SDN-коннектором. Варианты: `"disable"` `"enable"`
subscription_id string	ID подписки Azure.
tenant_id string	ID клиента (ID каталога).
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	ID пользователя.
username string	Имя пользователя удалённого SDN-коннектора в качестве учетных данных для входа.
vcenter_password string	Пароль сервера vCenter для карантина NSX.
vcenter_server string	Адрес сервера vCenter для карантина NSX.
vcenter_username string	Имя пользователя сервера vCenter для карантина NSX.
verify_certificate string	Включить/отключить проверку серверного сертификата. Варианты: `"disable"` `"enable"`
vpc_id string	ID VPC AWS.
vdom string	Виртуальный домен, среди ранее определённых. vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. Значение по умолчанию: `"root"`

Примечания

Примечание

Устаревшее fortiosapi было объявлено устаревшим, httpapi является предпочтительным способом запуска playbook'ов
Модуль поддерживает 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>"
          name: "default_name_36"
          nic:
              -
                  ip:
                      -
                          name: "default_name_39"
                          public_ip: "<your_own_value>"
                          resource_group: "<your_own_value>"
                  name: "default_name_42"
          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"
          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_56"
          route_table:
              -
                  name: "default_name_58"
                  resource_group: "<your_own_value>"
                  route:
                      -
                          name: "default_name_61"
                          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>"
          verify_certificate: "disable"
          vpc_id: "<your_own_value>"

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

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

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