fortinet.fortimanager.fmgr_vpnmgr_node 模块 – VPN 管理器的 VPN 节点。

注意

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

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

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

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_vpnmgr_node。

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"
vpnmgr_node 字典	设置的顶级参数。
add_route 别名：add-route 字符串	添加路由。 选项 "disable" "enable"
assign_ip 别名：assign-ip 字符串	分配 IP。 选项 "disable" "enable"
assign_ip_from 别名：assign-ip-from 字符串	从哪里分配 IP。 选项 "range" "usrgrp" "dhcp" "name"
authpasswd 任意	(列表) Authpasswd。
authusr 字符串	Authusr。
authusrgrp 字符串	Authusrgrp。
auto_configuration 别名：auto-configuration 字符串	自动配置。 选项 "disable" "enable"
auto_discovery_receiver 别名：auto-discovery-receiver 字符串	自动发现接收器。 选项 "disable" "enable"
auto_discovery_sender 别名：auto-discovery-sender 字符串	自动发现发送器。 选项 "disable" "enable"
automatic_routing 字符串	自动路由。 选项 "disable" "enable"
banner 字符串	横幅。
default_gateway 别名：default-gateway 字符串	默认网关。
dhcp_ra_giaddr 别名：dhcp-ra-giaddr 字符串	Dhcp ra giaddr。
dhcp_server 别名：dhcp-server 字符串	Dhcp 服务器。 选项 "disable" "enable"
dns_mode 别名：dns-mode 字符串	DNS 模式。 选项 "auto" "manual"
dns_service 别名：dns-service 字符串	DNS 服务。 选项 "default" "specify" "local"
domain 字符串	域名。
encapsulation 字符串	封装。 选项 "tunnel-mode" "transport-mode"
exchange_interface_ip 别名：exchange-interface-ip 字符串	交换接口 IP。 选项 "disable" "enable"
extgw 字符串	Extgw。
extgw_hubip 字符串	Extgw hubip。
extgw_p2_per_net 字符串	Extgw p2 per net。 选项 "disable" "enable"
extgwip 字符串	Extgwip。
hub_iface 任意	(列表或字符串) Hub 接口。
hub_public_ip 别名：hub-public-ip 字符串	Hub 公共 IP。
id 整数 / 必需	ID。
iface 任意	(列表或字符串) 接口。
ip_range 别名：ip-range 列表 / 元素=字典	IP 范围。
end_ip 别名：end-ip 字符串	结束 IP。
id 整数	ID。
start_ip 别名：start-ip 字符串	起始 IP。
ipsec_lease_hold 别名：ipsec-lease-hold 整数	IPsec 租期。
ipv4_dns_server1 别名：ipv4-dns-server1 字符串	IPv4 DNS 服务器 1。
ipv4_dns_server2 别名：ipv4-dns-server2 字符串	IPv4 DNS 服务器 2。
ipv4_dns_server3 别名：ipv4-dns-server3 字符串	IPv4 DNS 服务器 3。
ipv4_end_ip 别名：ipv4-end-ip 字符串	IPv4 结束 IP。
ipv4_exclude_range 别名：ipv4-exclude-range 列表 / 元素=字典	IPv4 排除范围。
end_ip 别名：end-ip 字符串	结束 IP。
id 整数	ID。
start_ip 别名：start-ip 字符串	起始 IP。
ipv4_name 别名：ipv4-name 字符串	IPv4 名称。
ipv4_netmask 别名：ipv4-netmask 字符串	IPv4 子网掩码。
ipv4_split_exclude 别名：ipv4-split-exclude 字符串	IPv4 分割排除。
ipv4_split_include 别名：ipv4-split-include 字符串	IPv4 分割包含。
ipv4_start_ip 别名：ipv4-start-ip 字符串	IPv4 开始 IP。
ipv4_wins_server1 别名：ipv4-wins-server1 字符串	IPv4 WINS 服务器 1。
ipv4_wins_server2 别名：ipv4-wins-server2 字符串	IPv4 WINS 服务器 2。
l2tp 字符串	L2TP。 选项 "disable" "enable"
local_gw 别名：local-gw 字符串	本地网关。
localid 字符串	本地 ID。
mode_cfg 别名：mode-cfg 字符串	模式配置。 选项 "disable" "enable"
mode_cfg_ip_version 别名：mode-cfg-ip-version 字符串	模式配置 IP 版本。 选项 "4" "6"
net_device 别名：net-device 字符串	网络设备。 选项 "disable" "enable"
network_id 别名：network-id 整数	网络 ID。
network_overlay 别名：network-overlay 字符串	网络覆盖。 选项 "enable" "disable"
peer 任意	(列表或字符串) 对等体。
peergrp 字符串	对等组。
peerid 字符串	对等体 ID。
peertype 字符串	对等体类型。 选项 "any" "one" "dialup" "peer" "peergrp"
protected_subnet 列表 / 元素=字典	受保护的子网。
addr 任意	(列表或字符串) 地址。
seq 整数	序列。
protocol 整数	协议。
public_ip 别名：public-ip 字符串	公网 IP。
role 字符串	角色。 选项 "hub" "spoke"
route_overlap 别名：route-overlap 字符串	路由重叠。 选项 "use-old" "use-new" "allow"
scope_member 别名：scope member 列表 / 元素=字典	范围成员。
name 字符串	名称。
vdom 字符串	VDOM。
spoke_zone 别名：spoke-zone 任意	(列表或字符串) spoke 区域。
summary_addr 列表 / 元素=字典	汇总地址。
addr 字符串	地址。
priority 整数	优先级。
seq 整数	序列。
tunnel_search 别名：tunnel-search 字符串	隧道搜索。 选项 "selectors" "nexthop"
unity_support 别名：unity-support 字符串	Unity 支持。 选项 "disable" "enable"
usrgrp 字符串	用户组。
vpn_interface_priority 别名：vpn-interface-priority 整数	VPN 接口优先级。
vpn_zone 别名：vpn-zone 任意	(列表或字符串) VPN 区域。
vpntable 任意	(列表或字符串) VPN 表。
xauthtype 字符串	XAUTH 类型。 选项 "disable" "client" "pap" "chap" "auto"
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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: VPN node for VPN Manager.
      fortinet.fortimanager.fmgr_vpnmgr_node:
        # 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: present # <value in [present, absent]>
        vpnmgr_node:
          add_route: <value in [disable, enable]>
          assign_ip: <value in [disable, enable]>
          assign_ip_from: <value in [range, usrgrp, dhcp, ...]>
          authpasswd: <list or string>
          authusr: <string>
          authusrgrp: <string>
          auto_configuration: <value in [disable, enable]>
          automatic_routing: <value in [disable, enable]>
          banner: <string>
          default_gateway: <string>
          dhcp_server: <value in [disable, enable]>
          dns_mode: <value in [auto, manual]>
          dns_service: <value in [default, specify, local]>
          domain: <string>
          extgw: <string>
          extgw_hubip: <string>
          extgw_p2_per_net: <value in [disable, enable]>
          extgwip: <string>
          hub_iface: <list or string>
          id: <integer>
          iface: <list or string>
          ip_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
          ipsec_lease_hold: <integer>
          ipv4_dns_server1: <string>
          ipv4_dns_server2: <string>
          ipv4_dns_server3: <string>
          ipv4_end_ip: <string>
          ipv4_exclude_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
          ipv4_netmask: <string>
          ipv4_split_include: <string>
          ipv4_start_ip: <string>
          ipv4_wins_server1: <string>
          ipv4_wins_server2: <string>
          local_gw: <string>
          localid: <string>
          mode_cfg: <value in [disable, enable]>
          mode_cfg_ip_version: <value in [4, 6]>
          net_device: <value in [disable, enable]>
          peer: <list or string>
          peergrp: <string>
          peerid: <string>
          peertype: <value in [any, one, dialup, ...]>
          protected_subnet:
            -
              addr: <list or string>
              seq: <integer>
          public_ip: <string>
          role: <value in [hub, spoke]>
          route_overlap: <value in [use-old, use-new, allow]>
          spoke_zone: <list or string>
          summary_addr:
            -
              addr: <string>
              priority: <integer>
              seq: <integer>
          tunnel_search: <value in [selectors, nexthop]>
          unity_support: <value in [disable, enable]>
          usrgrp: <string>
          vpn_interface_priority: <integer>
          vpn_zone: <list or string>
          vpntable: <list or string>
          xauthtype: <value in [disable, client, pap, ...]>
          exchange_interface_ip: <value in [disable, enable]>
          hub_public_ip: <string>
          ipv4_split_exclude: <string>
          scope_member:
            -
              name: <string>
              vdom: <string>
          dhcp_ra_giaddr: <string>
          encapsulation: <value in [tunnel-mode, transport-mode]>
          ipv4_name: <string>
          l2tp: <value in [disable, enable]>
          auto_discovery_receiver: <value in [disable, enable]>
          auto_discovery_sender: <value in [disable, enable]>
          network_id: <integer>
          network_overlay: <value in [enable, disable]>
          protocol: <integer>

返回值

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

键	描述
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 列表 / 元素=字符串	如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回： 复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李兴 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑凌 (@chillancezen)

• 沈方 (@fshen01)

• 陆洪斌 (@fgtdev-hblu)

收藏链接

• 问题跟踪器
• 主页
• 代码库 (源代码)