fortinet.fortimanager.fmgr_system_sdnconnector – Настройка подключения к SDN-коннектору.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_sdnconnector.
Введено в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||||
| bypass_validation логический тип |
| устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |||
| rc_failed список / элементы=строка | список кодов rc, с которыми будут переопределены условия для отказа | ||||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми будут переопределены условия для успеха | ||||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |||
| system_sdnconnector словарь | установленные параметры верхнего уровня | ||||
| _local_cert строка | нет описания | ||||
| access-key строка | Идентификатор ключа доступа AWS. | ||||
| azure-region строка |
| Регион сервера Azure. | |||
| client-id строка | Идентификатор клиента Azure (идентификатор приложения). | ||||
| client-secret строка | нет описания | ||||
| compartment-id строка | Идентификатор отсека. | ||||
| external-ip список / элементы=строка | нет описания | ||||
| name строка | Имя внешнего IP-адреса. | ||||
| gcp-project строка | Название проекта GCP. | ||||
| key-passwd строка | нет описания | ||||
| login-endpoint строка | Логин-точку Azure Stack. | ||||
| name строка | Имя SDN-соединителя. | ||||
| nic список / элементы=строка | нет описания | ||||
| ip список / элементы=строка | нет описания | ||||
| name строка | Имя конфигурации IP. | ||||
| public-ip строка | Имя публичного IP. | ||||
| name строка | Имя сетевого интерфейса. | ||||
| nsx-cert-fingerprint строка | Отпечаток сертификата NSX. | ||||
| oci-cert строка | Сертификат OCI. | ||||
| oci-fingerprint строка | нет описания | ||||
| oci-region строка |
| Регион сервера OCI. | |||
| password строка | нет описания | ||||
| private-key строка | Приватный ключ учетной записи GCP сервиса. | ||||
| region строка | Имя региона AWS. | ||||
| resource-group строка | Группа ресурсов Azure. | ||||
| resource-url строка | URL ресурса Azure Stack. | ||||
| rest-interface строка |
| Имя интерфейса для прослушивания REST-сервиса. | |||
| rest-password строка | нет описания | ||||
| rest-sport целое число | Порт доступа к REST-сервису (от 1 до 65535). | ||||
| rest-ssl строка |
| нет описания | |||
| route список / элементы=строка | нет описания | ||||
| name строка | Имя маршрута. | ||||
| route-table список / элементы=строка | нет описания | ||||
| name строка | Название таблицы маршрутизации. | ||||
| route список / элементы=строка | нет описания | ||||
| name строка | Имя маршрута. | ||||
| next-hop строка | Адрес следующего узла. | ||||
| secret-key строка | нет описания | ||||
| server строка | Адрес сервера удалённого SDN-соединителя. | ||||
| server-port целое число | Номер порта удалённого SDN-соединителя. | ||||
| service-account строка | Электронный адрес учетной записи GCP сервиса. | ||||
| status строка |
| Включить/выключить подключение к удалённому SDN-соединителю. | |||
| subscription-id строка | Идентификатор подписки Azure. | ||||
| tenant-id строка | Идентификатор арендатора (идентификатор каталога). | ||||
| type строка |
| Тип SDN-соединителя. | |||
| update-interval целое число | Интервал обновления динамических объектов (0-3600 сек, 0 означает выключено, по умолчанию = 60). | ||||
| use-metadata-iam строка |
| Включить/выключить использование роли IAM из метаданных для вызова API. | |||
| user-id строка | Идентификатор пользователя. | ||||
| username строка | Имя пользователя удалённого SDN-соединителя в качестве учетных данных для входа. | ||||
| vmx-image-url строка | URL веб-хостированного образа VMX. | ||||
| vmx-service-name строка | Имя службы VMX. | ||||
| vpc-id string | AWS идентификатор VPC. | ||||
| workspace_locking_adom string | адoм для блокировки рабочего пространства для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой | ||||
| workspace_locking_timeout integer | По умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство | |||
Примечания
Примечание
- В этом модуле FortiManager поддерживается режим блокировки рабочего пространства; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой код возврата. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure connection to SDN Connector.
fmgr_system_sdnconnector:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
system_sdnconnector:
_local_cert: <value of string>
access-key: <value of string>
azure-region: <value in [global, china, germany, ...]>
client-id: <value of string>
client-secret: <value of string>
compartment-id: <value of string>
external-ip:
-
name: <value of string>
gcp-project: <value of string>
key-passwd: <value of string>
login-endpoint: <value of string>
name: <value of string>
nic:
-
ip:
-
name: <value of string>
public-ip: <value of string>
name: <value of string>
nsx-cert-fingerprint: <value of string>
oci-cert: <value of string>
oci-fingerprint: <value of string>
oci-region: <value in [phoenix, ashburn, frankfurt, ...]>
password: <value of string>
private-key: <value of string>
region: <value of string>
resource-group: <value of string>
resource-url: <value of string>
rest-interface: <value in [mgmt, sync]>
rest-password: <value of string>
rest-sport: <value of integer>
rest-ssl: <value in [disable, enable]>
route:
-
name: <value of string>
route-table:
-
name: <value of string>
route:
-
name: <value of string>
next-hop: <value of string>
secret-key: <value of string>
server: <value of string>
server-port: <value of integer>
service-account: <value of string>
status: <value in [disable, enable]>
subscription-id: <value of string>
tenant-id: <value of string>
type: <value in [aci, aws, nsx, ...]>
update-interval: <value of integer>
use-metadata-iam: <value in [disable, enable]>
user-id: <value of string>
username: <value of string>
vmx-image-url: <value of string>
vmx-service-name: <value of string>
vpc-id: <value of string>
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url string | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API |
| response_message string | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 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/fortimanager/fmgr_system_sdnconnector_module.html