fortinet.fortios.fortios_system_pcp_server 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 PCP 服务器信息。

注意

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

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

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

fortinet.fortios 2.0.0 中的新增功能

概要 

此模块能够通过允许用户设置和修改系统功能和 pcp_server 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整到数据源。已在 FOS v6.0.0 上测试。

要求 

执行此模块的主机需要以下要求。

ansible>=2.15

参数 

参数	注释
access_token 字符串	基于令牌的身份验证。从 Fortigate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务的日志记录。选项 `false` ← (默认) `true`
member_path 字符串	要操作的成员属性路径。如果有多个属性，则用斜杠字符分隔。标有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。当指定 member_state 时，将忽略 state 选项。选项 `"present"` `"absent"`
system_pcp_server 字典	配置 PCP 服务器信息。
pools 列表 / 元素=字典	配置 PCP 池。
allow_opcode 列表 / 元素=字符串	允许的 PCP 操作码。选项 `"map"` `"peer"` `"announce"`
announcement_count 整数	多播公告的数量。
arp_reply 字符串	启用对外部 IP 的 ARP 请求的响应。选项 `"disable"` `"enable"`
client_mapping_limit 整数	每个客户端的映射限制 (0 - 65535)。
client_subnet 列表 / 元素=字典	接受 PCP 请求的子网。
subnet 字符串 / 必需	客户端子网。
description 字符串	描述。
ext_intf 字符串	外部接口名称。来源 system.interface.name。
extip 字符串	要映射到内部网络上的地址的外部接口上的 IP 地址或地址范围。
extport 字符串	要映射到内部网络上的端口号的传入端口号范围。
id 整数	ID。
intl_intf 列表 / 元素=字典	内部接口名称。
interface_name 字符串 / 必需	接口名称。来源 system.interface.name。
mapping_filter_limit 整数	每个映射的过滤器限制 (0 - 5)。
maximal_lifetime 整数	PCP 映射的最大生命周期（以秒为单位）(3600 - 604800)。
minimal_lifetime 整数	PCP 映射的最小生命周期（以秒为单位）(60 - 300)。
multicast_announcement 字符串	启用/禁用多播公告。选项 `"enable"` `"disable"`
name 字符串 / 必需	PCP 池名称。
recycle_delay 整数	PCP 服务器在回收已过期的映射之前将等待的最小延迟（以秒为单位）(0 - 3600)。
third_party 字符串	允许/不允许第三方选项。选项 `"allow"` `"disallow"`
third_party_subnet 列表 / 元素=字典	接受第三方请求的子网。
subnet 字符串 / 必需	第三方子网。
status 字符串	启用/禁用 PCP 服务器。选项 `"enable"` `"disable"`
vdom 字符串	虚拟域，在之前定义的那些域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。默认值： `"root"`

备注 

注意

旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方法。

示例 

- name: Configure PCP server information.
  fortinet.fortios.fortios_system_pcp_server:
      vdom: "{{ vdom }}"
      system_pcp_server:
          pools:
              -
                  allow_opcode: "map"
                  announcement_count: "3"
                  arp_reply: "disable"
                  client_mapping_limit: "0"
                  client_subnet:
                      -
                          subnet: "<your_own_value>"
                  description: "<your_own_value>"
                  ext_intf: "<your_own_value> (source system.interface.name)"
                  extip: "<your_own_value>"
                  extport: "<your_own_value>"
                  id: "14"
                  intl_intf:
                      -
                          interface_name: "<your_own_value> (source system.interface.name)"
                  mapping_filter_limit: "1"
                  maximal_lifetime: "86400"
                  minimal_lifetime: "120"
                  multicast_announcement: "enable"
                  name: "default_name_21"
                  recycle_delay: "0"
                  third_party: "allow"
                  third_party_subnet:
                      -
                          subnet: "<your_own_value>"
          status: "enable"

返回值 

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

键	描述
build 字符串	Fortigate 镜像的版本号返回值：始终示例： `"1547"`
http_method 字符串	上次用于将内容置备到 FortiGate 的方法返回值：始终示例： `"PUT"`
http_status 字符串	FortiGate 在上次应用的操作中给出的最后结果返回值：始终示例： `"200"`
mkey 字符串	上次调用 FortiGate 时使用的主密钥 (id) 返回值：成功示例： `"id"`
name 字符串	用于完成请求的表的名称返回值：始终示例： `"urlfilter"`
path 字符串	用于完成请求的表的路径返回值：始终示例： `"webfilter"`
revision 字符串	内部修订号返回值：始终示例： `"17.0.2.10658"`
serial 字符串	设备的序列号返回值：始终示例： `"FGVMEVYYQT3AB5352"`
status 字符串	操作结果的指示返回值：始终示例： `"success"`
vdom 字符串	使用的虚拟域返回值：始终示例： `"root"`
version 字符串	FortiGate 的版本返回值：始终示例： `"v5.6.3"`

作者

郑琳 (@chillancezen)
解雪 (@JieX19)
卢洪滨 (@fgtdev-hblu)
沈峰 (@frankshen01)
米格尔·安赫尔·穆诺兹 (@mamunozgonzalez)
尼古拉斯·托马斯 (@thomnico)