fortinet.fortios.fortios_system_sdn_connector – Настройка подключения к SDN-коннектору в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в playbook укажите: fortinet.fortios.fortios_system_sdn_connector.
Новое в версии 2.8: модуля fortinet.fortios
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные параметры и категорию sdn_connector. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| access_token строка | Аутентификация на основе токенов. Генерируется в интерфейсе Fortigate. | ||||
| state строка добавлено в 2.9 от fortinet.fortios |
| Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был перемещен на внешний уровень. | |||
| system_sdn_connector словарь | Настройка подключения к SDN-коннектору. | ||||
| access_key строка | Идентификатор ключа доступа AWS. | ||||
| azure_region строка |
| Регион Azure (Global/China). | |||
| client_id строка | Идентификатор клиента Azure (идентификатор приложения). | ||||
| client_secret строка | Секретный ключ клиента Azure (ключ приложения). | ||||
| external_ip список / элементы=строка | Настройка внешнего IP-адреса GCP. | ||||
| name строка / обязательно | Имя внешнего IP-адреса. | ||||
| name строка / обязательно | Имя SDN-коннектора. | ||||
| nic список / элементы=строка | Настройка сетевого интерфейса Azure. | ||||
| ip список / элементы=строка | Настройка конфигурации IP. | ||||
| name строка / обязательно | Имя конфигурации IP. | ||||
| public_ip строка | Имя публичного IP-адреса. | ||||
| name строка / обязательно | Имя сетевого интерфейса. | ||||
| password строка | Пароль удаленного SDN-коннектора в качестве учетных данных для входа. | ||||
| region строка | Имя региона AWS. | ||||
| resource_group строка | Группа ресурсов Azure. | ||||
| route список / элементы=строка | Настройка маршрута GCP. | ||||
| name строка / обязательно | Имя маршрута. | ||||
| route_table список / элементы=строка | Настройка таблицы маршрутизации Azure. | ||||
| name строка / обязательно | Имя таблицы маршрутизации. | ||||
| route список / элементы=строка | Настройка маршрута Azure. | ||||
| name строка / обязательно | Имя маршрута. | ||||
| next_hop строка | Адрес следующего узла. | ||||
| secret_key строка | Секретный ключ доступа AWS. | ||||
| server строка | Адрес сервера удаленного SDN-коннектора. | ||||
| server_port целое число | Номер порта удаленного SDN-коннектора. | ||||
| state строка |
| Устаревший Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' верхнего уровня. Указывает, нужно ли создать или удалить объект. | |||
| status строка |
| Включить/выключить подключение к удаленному SDN-коннектору. | |||
| subscription_id строка | Идентификатор подписки Azure. | ||||
| tenant_id строка | Идентификатор арендатора Azure (идентификатор каталога). | ||||
| type строка |
| Тип SDN-коннектора. | |||
| update_interval целое число | Интервал обновления динамического объекта (0 – 3600 сек, 0 означает отключено). | ||||
| username строка | Имя пользователя удаленного SDN-коннектора в качестве учетных данных для входа. | ||||
| vpc_id строка | Идентификатор VPC AWS. | ||||
| vdom строка | По умолчанию: "root" | Виртуальная область, среди ранее определённых. Vdom - это виртуальная инстанция FortiGate, которая может настраиваться и использоваться как отдельное устройство. | |||
Примечания
Примечание
- Устаревший модуль fortiosapi устарел, httpapi является предпочтительным способом запуска playbooks.
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure connection to SDN Connector.
fortios_system_sdn_connector:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_sdn_connector:
access_key: "<your_own_value>"
azure_region: "global"
client_id: "<your_own_value>"
client_secret: "<your_own_value>"
external_ip:
-
name: "default_name_8"
name: "default_name_9"
nic:
-
ip:
-
name: "default_name_12"
public_ip: "<your_own_value>"
name: "default_name_14"
password: "<your_own_value>"
region: "<your_own_value>"
resource_group: "<your_own_value>"
route:
-
name: "default_name_19"
route_table:
-
name: "default_name_21"
route:
-
name: "default_name_23"
next_hop: "<your_own_value>"
secret_key: "<your_own_value>"
server: "192.168.100.40"
server_port: "27"
status: "disable"
subscription_id: "<your_own_value>"
tenant_id: "<your_own_value>"
type: "aci"
update_interval: "32"
username: "<your_own_value>"
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 строка | всегда | Указание результата операции Пример: успех |
| 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_system_sdn_connector_module.html
