fortinet.fortimanager.fmgr_firewall_vip64 模块 – 配置 IPv6 到 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_vip64。

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

• 示例包含所有参数和值，在使用前需要将其调整为数据源。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
firewall_vip64 字典	设置的顶级参数。
arp_reply 别名：arp-reply 字符串	启用 ARP 回复。 选项 "disable" "enable"
color 整数	GUI 上图标的颜色。
comment 字符串	注释。
dynamic_mapping 列表 / 元素=字典	动态映射。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
arp_reply 别名：arp-reply 字符串	ARP 回复。 选项 "disable" "enable"
color 整数	颜色。
comment 字符串	注释。
extip 字符串	外部IP。
extport 字符串	外部端口。
id 整数	ID。
ldb_method 别名：ldb-method 字符串	负载均衡方法。 选项 "static" "round-robin" "weighted" "least-session" "least-rtt" "first-alive"
mappedip 字符串	映射IP。
mappedport 字符串	映射端口。
monitor 任意	(列表或字符串) 监控。
portforward 字符串	端口转发。 选项 "disable" "enable"
protocol 字符串	协议。 选项 "tcp" "udp"
server_type 别名：server-type 字符串	服务器类型。 选项 "http" "tcp" "udp" "ip"
src_filter 别名：src-filter 任意	(列表) 源过滤器。
type 字符串	类型。 选项 "static-nat" "server-load-balance"
uuid 字符串	UUID。
extip 字符串	起始外部IP [-结束外部IP]。
extport 字符串	外部服务端口。
id 整数	自定义ID。
ldb_method 别名：ldb-method 字符串	负载均衡方法。 选项 "static" "round-robin" "weighted" "least-session" "least-rtt" "first-alive"
mappedip 字符串	起始映射IP [-结束映射IP]。
mappedport 字符串	映射服务端口。
monitor 任意	(列表或字符串) 健康检查监控。
name 字符串 / 必需	VIP64 名称。
portforward 字符串	启用端口转发。 选项 "disable" "enable"
protocol 字符串	映射端口协议。 选项 "tcp" "udp"
realservers 列表 / 元素=字典	真实服务器。
client_ip 别名：client-ip 字符串	将服务器限制在此范围内的客户端 IP。
healthcheck 字符串	每个服务器的健康检查。 选项 "disable" "enable" "vip"
holddown_interval 别名：holddown-interval 整数	保持时间间隔。
id 整数	真实服务器ID。
ip 字符串	映射服务器IP。
max_connections 别名：max-connections 整数	允许连接到服务器的最大连接数。
monitor 任意	(列表或字符串) 健康检查监控。
port 整数	映射服务器端口。
status 字符串	服务器管理状态。 选项 "active" "standby" "disable"
weight 整数	权重。
server_type 别名：server-type 字符串	服务器类型。 选项 "http" "tcp" "udp" "ip"
src_filter 别名：src-filter 任意	(列表) 源IP6过滤器
type 字符串	VIP类型 选项 "static-nat" "server-load-balance"
uuid 字符串	通用唯一标识符
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，该值可以是 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 IPv6 to IPv4 virtual IPs.
      fortinet.fortimanager.fmgr_firewall_vip64:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_vip64:
          arp-reply: enable
          color: 1
          comment: "anisble-comment"
          id: 1
          name: "ansible-test-vip64"

- 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 IPv6 to IPv4 virtual IPs
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_vip64"
          params:
            adom: "ansible"
            vip64: "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)

集合链接

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