fortios_system_sdn_connector – Настройка подключения к SDN-соединителю в Fortinet’s FortiOS и FortiGate
Новая версия с 2.8.
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные параметры и категорию sdn_connector. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировано на FOS v6.0.5
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| host строка | IP-адрес FortiOS или FortiGate. | ||||
| https логическое значение |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | |||
| password строка | Значение по умолчанию: "" | Пароль FortiOS или FortiGate. | |||
| ssl_verify логическое значение добавлен в версии 2.9 |
| Обеспечивает проверку сертификата FortiGate надёжным центром сертификации. | |||
| state строка добавлен в версии 2.9 |
| Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был перемещен на этот внешний уровень. | |||
| system_sdn_connector словарь | Значение по умолчанию: null | Настройка подключения к SDN Connector. | |||
| access_key строка | ID ключа доступа AWS. | ||||
| azure_region строка |
| Регион сервера Azure. | |||
| client_id строка | ID клиента Azure (ID приложения). | ||||
| client_secret строка | Секретный ключ клиента Azure (ключ приложения). | ||||
| compartment_id строка | ID отделения. | ||||
| external_ip список | Настройка внешнего IP-адреса GCP. | ||||
| name строка / обязательно | Имя внешнего IP-адреса. | ||||
| gcp_project строка | Название проекта GCP. | ||||
| key_passwd строка | Пароль к закрытому ключу. | ||||
| login_endpoint строка | Входной конечный пункт Azure Stack. | ||||
| name строка / обязательно | Имя SDN-коннектора. | ||||
| nic список | Настройка сетевого интерфейса Azure. | ||||
| ip список | Настройка конфигурации IP. | ||||
| name строка / обязательно | Имя конфигурации IP. | ||||
| public_ip строка | Имя публичного IP-адреса. | ||||
| name строка / обязательно | Имя сетевого интерфейса. | ||||
| oci_cert строка | Сертификат OCI. Исходный сертификат.local.name. | ||||
| oci_fingerprint строка | Отпечаток открытого ключа OCI. | ||||
| oci_region строка |
| Регион сервера OCI. | |||
| password строка | Пароль удаленного SDN-коннектора в качестве учетных данных для входа. | ||||
| private_key строка | Закрытый ключ учётной записи службы GCP. | ||||
| region строка | Имя региона AWS. | ||||
| resource_group строка | Группа ресурсов Azure. | ||||
| resource_url строка | URL ресурса Azure Stack. | ||||
| route список | Настройка маршрута GCP. | ||||
| name строка / обязательно | Имя маршрута. | ||||
| route_table список | Настройка таблицы маршрутизации Azure. | ||||
| name строка / обязательно | Имя таблицы маршрутизации. | ||||
| route список | Настройка маршрута Azure. | ||||
| name строка / обязательно | Имя маршрута. | ||||
| next_hop строка | Адрес следующего узла. | ||||
| secret_key строка | Секретный ключ доступа AWS. | ||||
| server строка | Адрес сервера удаленного SDN-коннектора. | ||||
| server_port целое число | Номер порта удаленного SDN-коннектора. | ||||
| service_account строка | Электронный адрес учетной записи службы GCP. | ||||
| state строка |
| Устаревший Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' верхнего уровня. Указывает, нужно ли создать или удалить объект. | |||
| status строка |
| Включить/отключить подключение к удаленному SDN-коннектору. | |||
| subscription_id string | Идентификатор подписки Azure. | ||||
| tenant_id string | Идентификатор клиента (идентификатор каталога). | ||||
| type string |
| Тип соединителя SDN. | |||
| update_interval integer | Интервал обновления динамического объекта (0—3600 сек, 0 означает отключение). | ||||
| use_metadata_iam string |
| Включение/выключение использования роли IAM из метаданных для вызова API. | |||
| user_id string | Идентификатор пользователя. | ||||
| username string | Имя пользователя удаленного соединителя SDN в качестве учетных данных входа. | ||||
| vpc_id string | Идентификатор VPC AWS. | ||||
| username string | Имя пользователя FortiOS или FortiGate. | ||||
| vdom string | По умолчанию: "root" | Виртуальная область (vdom) из предварительно определенных. Vdom — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. | |||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Запуск как local_action в вашей книге задач
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure connection to SDN Connector.
fortios_system_sdn_connector:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
system_sdn_connector:
access_key: "<your_own_value>"
azure_region: "global"
client_id: "<your_own_value>"
client_secret: "<your_own_value>"
compartment_id: "<your_own_value>"
external_ip:
-
name: "default_name_9"
gcp_project: "<your_own_value>"
key_passwd: "<your_own_value>"
login_endpoint: "<your_own_value>"
name: "default_name_13"
nic:
-
ip:
-
name: "default_name_16"
public_ip: "<your_own_value>"
name: "default_name_18"
oci_cert: "<your_own_value> (source certificate.local.name)"
oci_fingerprint: "<your_own_value>"
oci_region: "phoenix"
password: "<your_own_value>"
private_key: "<your_own_value>"
region: "<your_own_value>"
resource_group: "<your_own_value>"
resource_url: "<your_own_value>"
route:
-
name: "default_name_28"
route_table:
-
name: "default_name_30"
route:
-
name: "default_name_32"
next_hop: "<your_own_value>"
secret_key: "<your_own_value>"
server: "192.168.100.40"
server_port: "36"
service_account: "<your_own_value>"
status: "disable"
subscription_id: "<your_own_value>"
tenant_id: "<your_own_value>"
type: "aci"
update_interval: "42"
use_metadata_iam: "disable"
user_id: "<your_own_value>"
username: "<your_own_value>"
vpc_id: "<your_own_value>"
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| build string | всегда | Номер сборки образа fortigate Пример: 1547 |
| http_method string | всегда | Последний метод, используемый для подготовки контента в FortiGate Пример: PUT |
| http_status string | всегда | Последний результат, полученный от FortiGate при последней операции Пример: 200 |
| mkey string | успех | Главный ключ (id), используемый при последнем вызове FortiGate Пример: id |
| name string | всегда | Название таблицы, используемой для выполнения запроса Пример: urlfilter |
| path string | всегда | Путь таблицы, используемой для выполнения запроса Пример: webfilter |
| revision string | всегда | Внутренний номер ревизии Пример: 17.0.2.10658 |
| serial string | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status string | всегда | Указание результата операции Пример: успешно |
| vdom string | всегда | Используемая виртуальная область Пример: root |
| version string | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Данный модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_system_sdn_connector_module.html