fortinet.fortimanager.fmgr_system_sdnconnector 模块 – 配置与 SDN 连接器的连接。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_system_sdnconnector。

fortinet.fortimanager 2.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包括在使用前需要根据数据源调整的所有参数和值。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块架构与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。选项 `false` ←（默认） `true`
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ←（默认） `true`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的重写方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。选项 `"present"` `"absent"`
system_sdnconnector 字典	顶层参数集。
_local_cert 字符串	本地证书。
access_key 别名：access-key 字符串	AWS 访问密钥 ID。
alt_resource_ip 别名：alt-resource-ip 字符串	启用/禁用 AWS 替代资源 IP。选项 `"disable"` `"enable"`
api_key 别名：api-key 任意	（列表）IBM 云 API 密钥或服务 ID API 密钥。
azure_region 别名：azure-region 字符串	Azure 服务器区域。选项 `"global"` `"china"` `"germany"` `"usgov"` `"local"`
client_id 别名：client-id 字符串	Azure 客户端 ID
client_secret 别名：client-secret 任意	（列表）Azure 客户端密钥
compartment_id 别名：compartment-id 字符串	隔间 ID。
compartment_list 别名：compartment-list 列表 / 元素=字典	隔间列表。
compartment_id 别名：compartment-id 字符串	OCI 隔间 ID。
compute_generation 别名：compute-generation 整数	IBM 云基础设施的计算代数。
domain 字符串	Openstack 域。
external_account_list 别名：external-account-list 列表 / 元素=字典	外部帐户列表。
external_id 别名：external-id 字符串	AWS 外部 ID。
region_list 别名：region-list 任意	（列表）AWS 区域名称列表。
role_arn 别名：role-arn 字符串	要承担的 AWS 角色 ARN。
external_ip 别名：external-ip 列表 / 元素=字典	外部 IP。
name 字符串	外部 IP 名称。
forwarding_rule 别名：forwarding-rule 列表 / 元素=字典	转发规则。
rule_name 别名：rule-name 字符串	转发规则名称。
target 字符串	目标实例名称。
gcp_project 别名：gcp-project 字符串	GCP 项目名称。
gcp_project_list 别名：gcp-project-list 列表 / 元素=字典	Gcp 项目列表。
gcp_zone_list 别名：gcp-zone-list 任意	（列表）配置 GCP 区域列表。
id 字符串	GCP 项目 ID。
group_name 别名：group-name 字符串	计算机的组名称。
ha_status 别名：ha-status 字符串	启用/禁用 FortiGate HA 服务的用法。选项 `"disable"` `"enable"`
ibm_region 别名：ibm-region 字符串	IBM 云区域名称。选项 `"us-south"` `"us-east"` `"germany"` `"great-britain"` `"japan"` `"australia"` `"dallas"` `"washington-dc"` `"london"` `"frankfurt"` `"sydney"` `"tokyo"` `"osaka"` `"toronto"` `"sao-paulo"` `"达拉斯-私有"` `"华盛顿特区-私有"` `"伦敦-私有"` `"法兰克福-私有"` `"悉尼-私有"` `"东京-私有"` `"大阪-私有"` `"多伦多-私有"` `"圣保罗-私有"`
ibm_region_gen1 别名: ibm-region-gen1 字符串	Ibm region gen1。选项 `"us-south"` `"us-east"` `"germany"` `"great-britain"` `"japan"` `"australia"`
ibm_region_gen2 别名: ibm-region-gen2 字符串	Ibm region gen2。选项 `"us-south"` `"us-east"` `"great-britain"`
key_passwd 别名: key-passwd 任意	（列表）私钥密码。
last_update 别名: last-update 整数	上次更新。
login_endpoint 别名: login-endpoint 字符串	Azure Stack 登录端点。
名称字符串 / 必需	SDN 连接器名称。
网卡列表 / 元素=字典	网卡。
IP 列表 / 元素=字典	IP。
名称字符串	IP 配置名称。
private_ip 别名: private-ip 字符串	私有 IP 地址。
public_ip 别名: public-ip 字符串	公有 IP 名称。
resource_group 别名: resource-group 字符串	Azure 公有 IP 的资源组。
名称字符串	网络接口名称。
peer_nic 别名: peer-nic 字符串	对等网络接口名称。
nsx_cert_fingerprint 别名: nsx-cert-fingerprint 字符串	NSX 证书指纹。
oci_cert 别名: oci-cert 字符串	OCI 证书。
oci_fingerprint 别名: oci-fingerprint 字符串	Oci 指纹。
oci_region 别名: oci-region 字符串	OCI 服务器区域。选项 `"凤凰城"` `"阿什本"` `"frankfurt"` `"london"` `"toronto"`
oci_region_list 别名: oci-region-list 列表 / 元素=字典	Oci 区域列表。
region 字符串	OCI 区域。
oci_region_type 别名: oci-region-type 字符串	OCI 区域类型。选项 `"商业"` `"政府"`
密码任意	（列表）远程 SDN 连接器的密码作为登录凭据。
private_key 别名: private-key 字符串	GCP 服务帐户的私钥。
代理字符串	SDN 代理。
区域字符串	AWS 区域名称。
resource_group 别名: resource-group 字符串	Azure 资源组。
resource_url 别名: resource-url 字符串	Azure Stack 资源 URL。
rest_interface 别名: rest-interface 字符串	REST 服务监听的接口名称。选项 `"mgmt"` `"同步"`
rest_password 别名: rest-password 任意	（列表）REST 服务的密码。
rest_sport 别名: rest-sport 整数	REST 服务访问端口
rest_ssl 别名: rest-ssl 字符串	Rest ssl。选项 `"disable"` `"enable"`
路由列表 / 元素=字典	路由。
名称字符串	路由名称。
route_table 别名: route-table 列表 / 元素=字典	路由表。
name 字符串	路由表名称。
resource_group 别名: resource-group 字符串	Azure 路由表的资源组。
route 列表 / 元素=字典	路由。
name 字符串	路由名称。
next_hop 别名: next-hop 字符串	下一跳地址。
subscription_id 别名: subscription-id 字符串	Azure 路由表的订阅 ID。
secret_key 别名: secret-key 任意	（列表）AWS 秘密访问密钥。
secret_token 别名: secret-token 字符串	Kubernetes 服务帐户的秘密令牌。
服务器字符串	远程 SDN 连接器的服务器地址。
server_ca_cert 别名: server-ca-cert 字符串	仅信任那些证书由该证书直接/间接签名的服务器。
server_cert 别名: server-cert 字符串	仅信任包含此证书的服务器。
server_ip 别名: server-ip 字符串	远程 SDN 连接器的 IP 地址。
server_list 别名: server-list 任意	（列表）远程 SDN 连接器的服务器地址列表。
server_port 别名: server-port 整数	远程 SDN 连接器的端口号。
service_account 别名: service-account 字符串	GCP 服务帐户电子邮件。
状态字符串	启用/禁用与远程 SDN 连接器的连接。选项 `"disable"` `"enable"`
subscription_id 别名: subscription-id 字符串	Azure 订阅 ID。
tenant_id 别名: tenant-id 字符串	租户 ID
类型字符串	SDN 连接器的类型。选项 `"aci"` `"aws"` `"nsx"` `"nuage"` `"azure"` `"gcp"` `"oci"` `"openstack"` `"kubernetes"` `"vmware"` `"acs"` `"alicloud"` `"sepm"` `"aci-direct"` `"ibm"` `"nutanix"` `"sap"`
update_interval 别名: update-interval 整数	动态对象更新间隔
正在更新整数	正在更新。
use_metadata_iam 别名: use-metadata-iam 字符串	启用/禁用使用元数据中的 IAM 角色来调用 API。选项 `"disable"` `"enable"`
user_id 别名: user-id 字符串	用户 ID。
用户名字符串	远程 SDN 连接器的用户名作为登录凭据。
vcenter_password 别名: vcenter-password 任意	（列表）用于 NSX 隔离的 VCenter 服务器密码。
vcenter_server 别名: vcenter-server 字符串	用于 NSX 隔离的 VCenter 服务器地址。
vcenter_username 别名: vcenter-username 字符串	用于 NSX 隔离的 VCenter 服务器用户名。
verify_certificate 别名: verify-certificate 字符串	启用/禁用服务器证书验证。选项 `"disable"` `"enable"`
vmx_image_url 别名: vmx-image-url 字符串	Web 托管的 VMX 镜像的 URL。
vmx_service_name 别名: vmx-service-name 字符串	VMX 服务名称。
vpc_id 别名: vpc-id 字符串	AWS VPC ID。
workspace_locking_adom 字符串	在工作区模式下运行的 FortiManager 要锁定的 ADOM，值可以是 global 和其他包括 root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁定的最大时间（秒）。默认值： `300`

备注 

注意

从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例 

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure connection to SDN Connector.
      fortinet.fortimanager.fmgr_system_sdnconnector:
        bypass_validation: false
        adom: ansible
        state: present
        system_sdnconnector:
          azure-region: global # <value in [global, china, germany, ...]>
          # compartment-id: 1
          name: ansible-test-sdn
          password: fortinet
          server: ALL
          status: disable
          type: aws # <value in [aci, aws, nsx, ...]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the connections to SDN Connector
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_sdnconnector"
          params:
            adom: "ansible"
            sdn-connector: "your_value"

返回值 

常见的返回值已记录在此处，以下是此模块特有的字段

键	描述
meta 字典	请求的结果。返回: 始终
request_url 字符串	请求的完整 URL。返回: 始终示例: `"/sys/login/user"`
response_code 整数	API 请求的状态。返回: 始终示例: `0`
response_data 列表 / 元素=字符串	API 响应。返回: 始终
response_message 字符串	API 响应的描述性消息。返回: 始终示例: `"OK."`
system_information 字典	目标系统的信息。返回: 始终
rc 整数	请求的状态。返回: 始终示例: `0`
version_check_warning 列表 / 元素=字符串	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。返回: 复杂

作者

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)