fortinet.fortios.fortios_system_sdn_connector 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置与 SDN 连接器的连接。
注意
此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_sdn_connector。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改系统功能和 sdn_connector 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值，都需要在使用前调整为数据源。使用 FOS v6.0.0 测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选项
|
|
要操作的成员属性路径。 如果存在多个属性，则用斜杠字符分隔。 标记有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时，state 选项将被忽略。 选项
|
|
指示是创建还是删除对象。 选项
|
|
配置与 SDN 连接器的连接。 |
|
AWS / ACS 访问密钥 ID。 |
|
启用/禁用 AWS 备用资源 IP。 选项
|
|
IBM 云 API 密钥或服务 ID API 密钥。 |
|
Azure 服务器区域。 选项
|
|
Azure 客户端 ID（应用程序 ID）。 |
|
Azure 客户端密钥（应用程序密钥）。 |
|
区间 ID。 |
|
配置 OCI 区间列表。 |
|
OCI 区间 ID。 |
|
用于 IBM 云基础设施的计算世代。 |
|
域名。 |
|
配置 AWS 外部帐户列表。 |
|
AWS 外部 ID。 |
|
AWS 区域名称列表。 |
|
AWS 区域名称。 |
|
要承担的 AWS 角色 ARN。 |
|
配置 GCP 外部 IP。 |
|
外部 IP 名称。 |
|
配置 GCP 转发规则。 |
|
转发规则名称。 |
|
目标实例名称。 |
|
GCP 项目名称。 |
|
配置 GCP 项目列表。 |
|
配置 GCP 区域列表。 |
|
GCP 区域名称。 |
|
GCP 项目 ID。 |
|
计算机的完整路径组名称。 |
|
启用/禁用 FortiGate HA 服务的使用。 选项
|
|
IBM 云区域名称。 选项
|
|
IBM 云计算第一代区域名称。 选项
|
|
IBM 云计算第二代区域名称。 选项
|
|
私钥密码。 |
|
Azure Stack 登录端点。 |
|
SDN 连接器名称。 |
|
配置 Azure 网络接口。 |
|
配置 IP 配置。 |
|
IP 配置名称。 |
|
公共 IP 名称。 |
|
Azure 公共 IP 的资源组。 |
|
网络接口名称。 |
|
OCI 证书。源 certificate.local.name。 |
|
OCI 公钥指纹。 |
|
OCI 服务器区域。 选项
|
|
配置 OCI 区域列表。 |
|
OCI 区域。 |
|
OCI 区域类型。 选项
|
|
远程 SDN 连接器的密码作为登录凭据。 |
|
GCP 服务帐户的私钥。 |
|
SDN 代理。源 system.sdn-proxy.name。 |
|
AWS / ACS 区域名称。 |
|
Azure 资源组。 |
|
Azure Stack 资源 URL。 |
|
配置 GCP 路由。 |
|
路由名称。 |
|
配置 Azure 路由表。 |
|
路由表名称。 |
|
Azure 路由表的资源组。 |
|
配置 Azure 路由。 |
|
路由名称。 |
|
下一跳地址。 |
|
Azure 路由表的订阅 ID。 |
|
AWS / ACS 秘密访问密钥。 |
|
Kubernetes 服务帐户的秘密令牌。 |
|
远程 SDN 连接器的服务器地址。 |
|
仅信任那些其证书由该证书直接/间接签名的服务器。源 certificate.remote.name certificate .ca.name。 |
|
仅信任包含此证书的服务器。源 certificate.remote.name。 |
|
远程 SDN 连接器的服务器地址列表。 |
|
IPv4 地址。 |
|
远程 SDN 连接器的端口号。 |
|
GCP 服务帐户电子邮件。 |
|
启用/禁用与远程 SDN 连接器的连接。 选项
|
|
Azure 订阅 ID。 |
|
租户 ID（目录 ID）。 |
|
SDN 连接器的类型。 选项
|
|
动态对象更新间隔（30 - 3600 秒）。 |
|
启用/禁用使用元数据中的 IAM 角色来调用 API。 选项
|
|
用户 ID。 |
|
远程 SDN 连接器的用户名，作为登录凭据。 |
|
用于 NSX 隔离的 vCenter 服务器密码。 |
|
用于 NSX 隔离的 vCenter 服务器地址。 |
|
用于 NSX 隔离的 vCenter 服务器用户名。 |
|
启用/禁用服务器证书验证。 选项
|
|
AWS VPC ID。 |
|
虚拟域，在之前定义的域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。 默认值: |
说明
注意
旧的 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>"
返回值
通用返回值记录在这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
FortiGate 镜像的构建号 返回值: 始终 示例: |
|
上次用于将内容配置到 FortiGate 的方法 返回值: 始终 示例: |
|
上次操作应用于 FortiGate 时给出的上次结果 返回值: 始终 示例: |
|
上次调用 FortiGate 时使用的主键 (id) 返回值: 成功 示例: |
|
用于满足请求的表名 返回值: 始终 示例: |
|
用于满足请求的表的路径 返回值: 始终 示例: |
|
内部修订号 返回值: 始终 示例: |
|
设备的序列号 返回值: 始终 示例: |
|
操作结果的指示 返回值: 始终 示例: |
|
使用的虚拟域 返回值: 始终 示例: |
|
FortiGate 的版本 返回值: 始终 示例: |