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" "英国" "日本" "澳大利亚" "达拉斯" "华盛顿特区" "伦敦" "法兰克福" "悉尼" "东京" "大阪" "多伦多" "圣保罗" "达拉斯-专用" "华盛顿特区-专用" "伦敦-专用" "法兰克福-专用" "悉尼-专用" "东京-专用" "大阪-专用" "多伦多-专用" "圣保罗-专用"
ibm_region_gen1 别名：ibm-region-gen1 字符串	IBM区域Gen1。 选项 "us-south" "us-east" "germany" "英国" "日本" "澳大利亚"
ibm_region_gen2 别名：ibm-region-gen2 字符串	IBM区域Gen2。 选项 "us-south" "us-east" "英国"
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服务器区域。 选项 "凤凰" "阿什本" "法兰克福" "伦敦" "多伦多"
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" "sync"
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" "阿里云" "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) 字典	请求的结果。 返回值：始终返回
请求URL (request_url) 字符串	请求的完整URL。 返回值：始终返回 示例： "/sys/login/user"
响应代码 (response_code) 整数	API请求的状态。 返回值：始终返回 示例： 0
响应数据 (response_data) 列表 / 元素=字符串	API响应。 返回值：始终返回
响应消息 (response_message) 字符串	API响应的描述性消息。 返回值：始终返回 示例： "OK."
系统信息 (system_information) 字典	目标系统的信息。 返回值：始终返回
返回代码 (rc) 整数	请求的状态。 返回值：始终返回 示例： 0
版本检查警告 (version_check_warning) 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回值：复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑琳 (@chillancezen)

• 沈方 (@fshen01)

• 陆宏斌 (@fgtdev-hblu)

资源链接

• 问题追踪
• 主页
• 代码仓库