fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping 模块 – 配置 IPv4 的虚拟 IP。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构存在差异时设置为 True，模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

firewall_vip_dynamicmapping

字典

设置的顶层参数。

_scope

列表 / 元素=字典

范围。

name

字符串

名称。

vdom

字符串

Vdom。

add_nat46_route

别名: add-nat46-route

字符串

启用/禁用添加 NAT46 路由。

选项

  • "disable"

  • "enable"

arp_reply

别名: arp-reply

字符串

Arp 回复。

选项

  • "disable"

  • "enable"

color

整数

颜色。

comment

字符串

注释。

dns_mapping_ttl

别名: dns-mapping-ttl

整数

Dns 映射 ttl。

extaddr

任意

（列表或字符串）Extaddr。

extintf

字符串

Extintf。

extip

字符串

Extip。

extport

字符串

Extport。

gratuitous_arp_interval

别名: gratuitous-arp-interval

整数

Gratuitous arp 间隔。

gslb_domain_name

别名: gslb-domain-name

字符串

与 FortiGSLB 集成时使用的域。

gslb_hostname

别名: gslb-hostname

字符串

在配置的 FortiGSLB 域中使用的主机名。

h2_support

别名: h2-support

字符串

启用/禁用 HTTP2 支持

选项

  • "disable"

  • "enable"

h3_support

别名: h3-support

字符串

启用/禁用 HTTP3/QUIC 支持

选项

  • "disable"

  • "enable"

http_cookie_age

别名: http-cookie-age

整数

Http cookie age。

http_cookie_domain

别名: http-cookie-domain

字符串

Http cookie domain。

http_cookie_domain_from_host

别名: http-cookie-domain-from-host

字符串

Http cookie domain from host。

选项

  • "disable"

  • "enable"

http_cookie_generation

别名: http-cookie-generation

整数

Http cookie generation。

http_cookie_path

别名: http-cookie-path

字符串

Http cookie path。

http_cookie_share

别名: http-cookie-share

字符串

Http cookie share。

选项

  • "disable"

  • "same-ip"

http_ip_header

别名: http-ip-header

字符串

Http ip header。

选项

  • "disable"

  • "enable"

http_ip_header_name

别名: http-ip-header-name

字符串

Http ip header name。

http_multiplex

别名: http-multiplex

字符串

Http multiplex。

选项

  • "disable"

  • "enable"

http_multiplex_max_concurrent_request

别名: http-multiplex-max-concurrent-request

整数

多路复用服务器可以处理的最大并发请求数

http_multiplex_max_request

别名: http-multiplex-max-request

整数

多路复用服务器在断开会话之前可以处理的最大请求数

http_multiplex_ttl

别名: http-multiplex-ttl

整数

与服务器的空闲连接的生存时间。

http_redirect

别名: http-redirect

字符串

Http redirect。

选项

  • "disable"

  • "enable"

http_supported_max_version

别名: http-supported-max-version

字符串

支持的最大 HTTP 版本。

选项

  • "http1"

  • "http2"

https_cookie_secure

别名: https-cookie-secure

字符串

Https cookie secure。

选项

  • "disable"

  • "enable"

id

整数

Id。

ipv6_mappedip

别名: ipv6-mappedip

字符串

映射的 IPv6 地址范围。

ipv6_mappedport

别名: ipv6-mappedport

字符串

目标网络上映射外部端口号范围的 IPv6 端口号范围。

ldb_method

别名: ldb-method

字符串

Ldb 方法。

选项

  • "static"

  • "round-robin"

  • "weighted"

  • "least-session"

  • "least-rtt"

  • "first-alive"

  • "http-host"

mapped_addr

别名: mapped-addr

字符串

映射的地址。

mappedip

任意

（列表）映射的 IP。

mappedport

字符串

映射的端口。

max_embryonic_connections

别名: max-embryonic-connections

整数

最大半连接数。

monitor

任意

(列表或字符串) 监视器。

nat44

字符串

启用/禁用 NAT44。

选项

  • "disable"

  • "enable"

nat46

字符串

启用/禁用 NAT46。

选项

  • "disable"

  • "enable"

nat_source_vip

别名: nat-source-vip

字符串

源 NAT VIP。

选项

  • "disable"

  • "enable"

one_click_gslb_server

别名: one-click-gslb-server

字符串

启用/禁用与 FortiGSLB 的一键 GSLB 服务器集成。

选项

  • "disable"

  • "enable"

outlook_web_access

别名: outlook-web-access

字符串

Outlook Web Access。

选项

  • "disable"

  • "enable"

persistence

字符串

持久性。

选项

  • "none"

  • "http-cookie"

  • "ssl-session-id"

portforward

字符串

端口转发。

选项

  • "disable"

  • "enable"

portmapping_type

别名: portmapping-type

字符串

端口映射类型。

选项

  • "1-to-1"

  • "m-to-n"

protocol

字符串

协议。

选项

  • "tcp"

  • "udp"

  • "sctp"

  • "icmp"

realservers

列表 / 元素=字典

真实服务器。

address

字符串

地址。

client_ip

别名: client-ip

任意

(列表) 客户端 IP。

health_check_proto

别名: health-check-proto

字符串

健康检查协议。

选项

  • "ping"

  • "http"

healthcheck

字符串

健康检查。

选项

  • "disable"

  • "enable"

  • "vip"

holddown_interval

别名: holddown-interval

整数

保持间隔。

http_host

别名: http-host

字符串

HTTP 主机。

id

整数

Id。

ip

字符串

IP。

max_connections

别名: max-connections

整数

最大连接数。

monitor

任意

(列表或字符串) 监视器。

port

整数

端口。

seq

整数

序号。

status

字符串

状态。

选项

  • "active"

  • "standby"

  • "disable"

translate_host

别名: translate-host

字符串

启用/禁用从虚拟服务器到真实服务器的主机名/IP转换。

选项

  • "disable"

  • "enable"

type

字符串

类型。

选项

  • "ip"

  • "address"

weight

整数

权重。

server_type

别名: server-type

字符串

服务器类型。

选项

  • "http"

  • "https"

  • "ssl"

  • "tcp"

  • "udp"

  • "ip"

  • "imaps"

  • "pop3s"

  • "smtps"

  • "ssh"

service

任意

(列表或字符串) 服务。

src_filter

别名: src-filter

任意

(列表) 源过滤器。

src_vip_filter

别名: src-vip-filter

字符串

启用/禁用使用 src-filter 来匹配反向 SNAT 规则的目标。

选项

  • "disable"

  • "enable"

srcintf_filter

别名: srcintf-filter

任意

(列表) 源接口过滤器。

ssl_accept_ffdhe_groups

别名: ssl-accept-ffdhe-groups

字符串

为 SSL 密钥交换启用/禁用 FFDHE 密码套件。

选项

  • "disable"

  • "enable"

ssl_algorithm

别名: ssl-algorithm

字符串

SSL 算法。

选项

  • "high"

  • "medium"

  • "low"

  • "custom"

ssl_certificate

别名: ssl-certificate

字符串

SSL 证书。

ssl_cipher_suites

别名: ssl-cipher-suites

列表 / 元素=字典

SSL 密码套件。

cipher

字符串

密码。

选项

  • "TLS-RSA-WITH-RC4-128-MD5"

  • "TLS-RSA-WITH-RC4-128-SHA"

  • "TLS-RSA-WITH-DES-CBC-SHA"

  • "TLS-RSA-WITH-3DES-EDE-CBC-SHA"

  • "TLS-RSA-WITH-AES-128-CBC-SHA"

  • "TLS-RSA-WITH-AES-256-CBC-SHA"

  • "TLS-RSA-WITH-AES-128-CBC-SHA256"

  • "TLS-RSA-WITH-AES-256-CBC-SHA256"

  • "TLS-RSA-WITH-CAMELLIA-128-CBC-SHA"

  • "TLS-RSA-WITH-CAMELLIA-256-CBC-SHA"

  • "TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256"

  • "TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256"

  • "TLS-RSA-WITH-SEED-CBC-SHA"

  • "TLS-RSA-WITH-ARIA-128-CBC-SHA256"

  • "TLS-RSA-WITH-ARIA-256-CBC-SHA384"

  • "TLS-DHE-RSA-WITH-DES-CBC-SHA"

  • "TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA"

  • "TLS-DHE-RSA-WITH-AES-128-CBC-SHA"

  • "TLS-DHE-RSA-WITH-AES-256-CBC-SHA"

  • "TLS-DHE-RSA-WITH-AES-128-CBC-SHA256"

  • "TLS-DHE-RSA-WITH-AES-256-CBC-SHA256"

  • "TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA"

  • "TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA"

  • "TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256"

  • "TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256"

  • "TLS-DHE-RSA-WITH-SEED-CBC-SHA"

  • "TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256"

  • "TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384"

  • "TLS-ECDHE-RSA-WITH-RC4-128-SHA"

  • "TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA"

  • "TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA"

  • "TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA"

  • "TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256"

  • "TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256"

  • "TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256"

  • "TLS-DHE-RSA-WITH-AES-128-GCM-SHA256"

  • "TLS-DHE-RSA-WITH-AES-256-GCM-SHA384"

  • "TLS-DHE-DSS-WITH-AES-128-CBC-SHA"

  • "TLS-DHE-DSS-WITH-AES-256-CBC-SHA"

  • "TLS-DHE-DSS-WITH-AES-128-CBC-SHA256"

  • "TLS-DHE-DSS-WITH-AES-128-GCM-SHA256"

  • "TLS-DHE-DSS-WITH-AES-256-CBC-SHA256"

  • "TLS-DHE-DSS-WITH-AES-256-GCM-SHA384"

  • "TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256"

  • "TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256"

  • "TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384"

  • "TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384"

  • "TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA"

  • "TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256"

  • "TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256"

  • "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384"

  • "TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384"

  • "TLS-RSA-WITH-AES-128-GCM-SHA256"

  • "TLS-RSA-WITH-AES-256-GCM-SHA384"

  • "TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA"

  • "TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA"

  • "TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256"

  • "TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256"

  • "TLS-DHE-DSS-WITH-SEED-CBC-SHA"

  • "TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256"

  • "TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384"

  • "TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256"

  • "TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384"

  • "TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256"

  • "TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384"

  • "TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA"

  • "TLS-DHE-DSS-WITH-DES-CBC-SHA"

  • "TLS-AES-128-GCM-SHA256"

  • "TLS-AES-256-GCM-SHA384"

  • "TLS-CHACHA20-POLY1305-SHA256"

  • "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA"

id

整数

Id。

priority

整数

优先级。

versions

list / elements=string

版本。

选项

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl_client_fallback

别名: ssl-client-fallback

字符串

SSL 客户端回退。

选项

  • "disable"

  • "enable"

ssl_client_rekey_count

别名: ssl-client-rekey-count

整数

SSL 客户端重新密钥计数。

ssl_client_renegotiation

别名: ssl-client-renegotiation

字符串

SSL 客户端重新协商。

选项

  • "deny"

  • "allow"

  • "secure"

ssl_client_session_state_max

别名: ssl-client-session-state-max

整数

SSL 客户端会话状态最大值。

ssl_client_session_state_timeout

别名: ssl-client-session-state-timeout

整数

SSL 客户端会话状态超时。

ssl_client_session_state_type

别名: ssl-client-session-state-type

字符串

SSL 客户端会话状态类型。

选项

  • "disable"

  • "time"

  • "count"

  • "both"

ssl_dh_bits

别名: ssl-dh-bits

字符串

SSL DH 位数。

选项

  • "768"

  • "1024"

  • "1536"

  • "2048"

  • "3072"

  • "4096"

ssl_hpkp

别名: ssl-hpkp

字符串

SSL HPKP。

选项

  • "disable"

  • "enable"

  • "report-only"

ssl_hpkp_age

别名: ssl-hpkp-age

整数

SSL HPKP 年龄。

ssl_hpkp_backup

别名: ssl-hpkp-backup

字符串

SSL HPKP 备份。

ssl_hpkp_include_subdomains

别名: ssl-hpkp-include-subdomains

字符串

SSL HPKP 包含子域。

选项

  • "disable"

  • "enable"

ssl_hpkp_primary

别名: ssl-hpkp-primary

字符串

SSL HPKP 主密钥。

ssl_hpkp_report_uri

别名: ssl-hpkp-report-uri

字符串

SSL HPKP 报告 URI。

ssl_hsts

别名: ssl-hsts

字符串

SSL HSTS。

选项

  • "disable"

  • "enable"

ssl_hsts_age

别名: ssl-hsts-age

整数

SSL HSTS 年龄。

ssl_hsts_include_subdomains

别名: ssl-hsts-include-subdomains

字符串

SSL HSTS 包含子域。

选项

  • "disable"

  • "enable"

ssl_http_location_conversion

别名: ssl-http-location-conversion

字符串

SSL HTTP 位置转换。

选项

  • "disable"

  • "enable"

ssl_http_match_host

别名: ssl-http-match-host

字符串

SSL HTTP 匹配主机。

选项

  • "disable"

  • "enable"

ssl_max_version

别名: ssl-max-version

字符串

Ssl 最大版本。

选项

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl_min_version

别名: ssl-min-version

字符串

Ssl 最小版本。

选项

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl_mode

别名: ssl-mode

字符串

Ssl 模式。

选项

  • "half"

  • "full"

ssl_pfs

别名: ssl-pfs

字符串

Ssl pfs。

选项

  • "require"

  • "deny"

  • "allow"

ssl_send_empty_frags

别名: ssl-send-empty-frags

字符串

Ssl 发送空分片。

选项

  • "disable"

  • "enable"

ssl_server_algorithm

别名: ssl-server-algorithm

字符串

Ssl 服务器算法。

选项

  • "high"

  • "low"

  • "medium"

  • "custom"

  • "client"

ssl_server_max_version

别名: ssl-server-max-version

字符串

Ssl 服务器最大版本。

选项

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "client"

  • "tls-1.3"

ssl_server_min_version

别名: ssl-server-min-version

字符串

Ssl 服务器最小版本。

选项

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "client"

  • "tls-1.3"

ssl_server_renegotiation

别名: ssl-server-renegotiation

字符串

启用/禁用安全重新协商以符合 RFC 5746。

选项

  • "disable"

  • "enable"

ssl_server_session_state_max

别名: ssl-server-session-state-max

整数

Ssl 服务器会话状态最大值。

ssl_server_session_state_timeout

别名: ssl-server-session-state-timeout

整数

Ssl 服务器会话状态超时时间。

ssl_server_session_state_type

别名: ssl-server-session-state-type

字符串

Ssl 服务器会话状态类型。

选项

  • "disable"

  • "time"

  • "count"

  • "both"

status

字符串

启用/禁用 VIP。

选项

  • "disable"

  • "enable"

type

字符串

类型。

选项

  • "static-nat"

  • "load-balance"

  • "server-load-balance"

  • "dns-translation"

  • "fqdn"

  • "access-proxy"

uuid

字符串

Uuid。

weblogic_server

别名: weblogic-server

字符串

Weblogic 服务器。

选项

  • "disable"

  • "enable"

websphere_server

别名: websphere-server

字符串

Websphere 服务器。

选项

  • "disable"

  • "enable"

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的重写方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

将覆盖失败条件的 rc 代码列表。

rc_succeeded

list / elements=integer

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

vip

字符串 / 必需

请求 URL 中的参数 (vip)。

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 dynamic mappings of virtual IP for IPv4
      fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping:
        bypass_validation: false
        adom: ansible
        vip: "ansible-test-vip" # name
        state: present
        firewall_vip_dynamicmapping:
          _scope: # Required
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          arp-reply: enable
          color: 2
          comment: "ansible-comment"
          id: 1

- 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 dynamic mappings of virtual IP for IPv4
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_vip_dynamicmapping"
          params:
            adom: "ansible"
            vip: "ansible-test-vip" # name
            dynamic_mapping: "your_value"

返回值

通用返回值记录在此处 这里，以下是此模块独有的字段

键

描述

meta

字典

请求的结果。

返回: 总是

request_url

字符串

请求的完整 URL。

返回: 总是

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 总是

示例: 0

response_data

list / elements=string

API 响应。

返回: 总是

response_message

字符串

API 响应的描述性消息。

返回: 总是

示例: "OK."

system_information

字典

目标系统的信息。

返回: 总是

rc

整数

请求的状态。

返回: 总是

示例: 0

version_check_warning

list / elements=string

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)