fortinet.fortimanager.fmgr_firewall_ippool 模块 – 配置 IPv4 IP 池。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包括所有需要在使用前调整为数据源的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
firewall_ippool 字典	设置的顶级参数。
add_nat64_route 别名：add-nat64-route 字符串	启用/禁用添加 NAT64 路由。 选项 "disable" "enable"
arp_intf 别名：arp-intf 字符串	从可用的选项中选择一个接口，该接口将回复 ARP 请求。
arp_reply 别名：arp-reply 字符串	在将 IP 池添加到策略时，启用/禁用回复 ARP 请求 选项 "disable" "enable"
associated_interface 别名：associated-interface 字符串	关联的接口名称。
block_size 别名：block-size 整数	块中的地址数量
cgn_block_size 别名：cgn-block-size 整数	块中的端口数量
cgn_client_endip 别名：cgn-client-endip 字符串	最终客户端 IPv4 地址
cgn_client_ipv6shift 别名：cgn-client-ipv6shift 整数	固定分配的 IPv6 移位。
cgn_client_startip 别名：cgn-client-startip 字符串	第一个客户端 IPv4 地址
cgn_fixedalloc 别名：cgn-fixedalloc 字符串	启用/禁用固定分配模式。 选项 "disable" "enable"
cgn_overload 别名：cgn-overload 字符串	启用/禁用过载模式。 选项 "disable" "enable"
cgn_port_end 别名：cgn-port-end 整数	可以分配的结束公共端口。
cgn_port_start 别名：cgn-port-start 整数	可以分配的起始公共端口。
cgn_spa 别名：cgn-spa 字符串	启用/禁用单端口分配模式。 选项 "disable" "enable"
client_prefix_length 别名：client-prefix-length 整数	单个确定性 NAT64 客户端的子网长度
comments 字符串	注释。
dynamic_mapping 列表 / 元素=字典	动态映射。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
add_nat64_route 别名：add-nat64-route 字符串	启用/禁用添加 NAT64 路由。 选项 "disable" "enable"
arp_intf 别名：arp-intf 字符串	ARP 接口。
arp_reply 别名：arp-reply 字符串	ARP 回复。 选项 "disable" "enable"
associated_interface 别名：associated-interface 字符串	关联接口。
block_size 别名：block-size 整数	块大小。
cgn_block_size 别名：cgn-block-size 整数	CGN 块大小。
cgn_client_endip 别名：cgn-client-endip 字符串	CGN 客户端结束IP。
cgn_client_ipv6shift 别名：cgn-client-ipv6shift 整数	固定分配的 IPv6 移位。
cgn_client_startip 别名：cgn-client-startip 字符串	CGN 客户端起始IP。
cgn_fixedalloc 别名：cgn-fixedalloc 字符串	CGN 固定分配。 选项 "disable" "enable"
cgn_overload 别名：cgn-overload 字符串	CGN 过载。 选项 "disable" "enable"
cgn_port_end 别名：cgn-port-end 整数	CGN 端口结束。
cgn_port_start 别名：cgn-port-start 整数	CGN 端口起始。
cgn_spa 别名：cgn-spa 字符串	CGN SPA。 选项 "disable" "enable"
client_prefix_length 别名：client-prefix-length 整数	单个确定性 NAT64 客户端的子网长度
comments 字符串	注释。
endip 字符串	结束IP。
endport 整数	最终端口号。
exclude_ip 别名：exclude-ip any	(列表) 排除的IP地址。
icmp_session_quota 别名：icmp-session-quota 整数	每个客户端允许的最大并发ICMP会话数。
nat64 字符串	启用/禁用NAT64。 选项 "disable" "enable"
num_blocks_per_user 别名：num-blocks-per-user 整数	每个用户允许的地址块数。
pba_interim_log 别名：pba-interim-log 整数	端口块分配中间日志记录间隔。
pba_timeout 别名：pba-timeout 整数	PBA 超时。
permit_any_host 别名：permit-any-host 字符串	允许任何主机。 选项 "disable" "enable"
port_per_user 别名：port-per-user 整数	每个用户的端口数量。
privileged_port_use_pba 别名：privileged-port-use-pba 字符串	启用/禁用从端口块分配中选择外部端口以进行特权端口NAT。 选项 "disable" "enable"
source_endip 别名：source-endip 字符串	源结束IP。
source_prefix6 别名：source-prefix6 字符串	要转换的源IPv6网络。
source_startip 别名：source-startip 字符串	源起始IP。
startip 字符串	起始IP。
startport 整数	起始端口号。
subnet_broadcast_in_ippool 别名：subnet-broadcast-in-ippool 字符串	启用/禁用在NAT64 IP池中包含子网地址和广播IP地址。 选项 "disable" "enable"
tcp_session_quota 别名：tcp-session-quota 整数	每个客户端允许的最大并发TCP会话数。
type 字符串	类型。 选项 "overload" "one-to-one" "fixed-port-range" "port-block-allocation" "cgn-resource-allocation"
udp_session_quota 别名：udp-session-quota 整数	每个客户端允许的最大并发UDP会话数。
utilization_alarm_clear 别名：utilization-alarm-clear 整数	利用率报警清除。
utilization_alarm_raise 别名：utilization-alarm-raise 整数	利用率报警触发。
endip 字符串	最终IPv4地址。
endport 整数	最终端口号。
exclude_ip 别名：exclude-ip any	(列表) 排除的IP地址。
icmp_session_quota 别名：icmp-session-quota 整数	每个客户端允许的最大并发ICMP会话数。
name 字符串 / 必需	IP池名称。
nat64 字符串	启用/禁用NAT64。 选项 "disable" "enable"
num_blocks_per_user 别名：num-blocks-per-user 整数	用户可用的地址块数量。
pba_interim_log 别名：pba-interim-log 整数	端口块分配中间日志记录间隔。
pba_timeout 别名：pba-timeout 整数	端口块分配超时。
permit_any_host 别名：permit-any-host 字符串	启用/禁用全锥NAT。 选项 "disable" "enable"
port_per_user 别名：port-per-user 整数	每个用户的端口数量。
privileged_port_use_pba 别名：privileged-port-use-pba 字符串	启用/禁用从端口块分配中选择外部端口以进行特权端口NAT。 选项 "disable" "enable"
source_endip 别名：source-endip 字符串	最终IPv4地址。
source_prefix6 别名：source-prefix6 字符串	要转换的源IPv6网络。
source_startip 别名：source-startip 字符串	起始IPv4地址。
startip 字符串	起始IPv4地址。
startport 整数	起始端口号。
subnet_broadcast_in_ippool 别名：subnet-broadcast-in-ippool 字符串	启用/禁用在NAT64 IP池中包含子网地址和广播IP地址。 选项 "disable" "enable"
tcp_session_quota 别名：tcp-session-quota 整数	每个客户端允许的最大并发TCP会话数。
type 字符串	IP池类型。 选项 "overload" "one-to-one" "fixed-port-range" "port-block-allocation" "cgn-resource-allocation"
udp_session_quota 别名：udp-session-quota 整数	每个客户端允许的最大并发UDP会话数。
utilization_alarm_clear 别名：utilization-alarm-clear 整数	池利用率报警清除阈值。
utilization_alarm_raise 别名：utilization-alarm-raise 整数	池利用率报警触发阈值。
forticloud_access_token 字符串	使用FortiCloud API访问令牌验证Ansible客户端。
proposed_method 字符串	底层Json RPC请求的覆盖方法。 选项 "update" "set" "add"
rc_failed 列表 / 元素=整数	将覆盖失败条件的RC代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的RC代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。 选项 "present" "absent"
workspace_locking_adom 字符串	在工作区模式下运行FortiManager时要锁定的ADOM，值可以是全局的和其他值，包括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 IPv4 IP pools.
      fortinet.fortimanager.fmgr_firewall_ippool:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_ippool:
          comments: "ansible-comment"
          endip: "222.222.222.254"
          name: "ansible-test"
          startip: "222.222.222.0"
          type: overload # <value in [overload, one-to-one, fixed-port-range, ...]>

- 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 IPv4 IP pools
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_ippool"
          params:
            adom: "ansible"
            ippool: "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 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回值：复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑链 (@chillancezen)

• 沈方 (@fshen01)

• 卢洪斌 (@fgtdev-hblu)

集合链接

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