fortinet.fortimanager.fmgr_firewall_vip64_realservers 模块 – 真实服务器。

注意

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

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

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

要在 Playbook 中使用它，请指定： fortinet.fortimanager.fmgr_firewall_vip64_realservers。

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_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

整数

权重。

forticloud_access_token

字符串

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

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必填

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

选项

  • "present"

  • "absent"

vip64

字符串 / 必填

请求 URL 中的参数 (vip64)。

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 有助于完成此工作。

  • 要创建或更新对象，请使用状态 present 指令。

  • 要删除对象，请使用状态 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: Real servers.
      fortinet.fortimanager.fmgr_firewall_vip64_realservers:
        bypass_validation: false
        adom: ansible
        vip64: "ansible-test-vip64" # name
        state: present
        firewall_vip64_realservers:
          healthcheck: enable # <value in [disable, enable, vip]>
          id: 1
          status: active # <value in [active, standby, disable]>

- 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 real servers of IPv6 to IPv4 virtual IP
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_vip64_realservers"
          params:
            adom: "ansible"
            vip64: "ansible-test-vip64" # name
            realservers: "your_value"

返回值

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

键

描述

元数据

字典

请求的结果。

已返回： 总是

request_url

字符串

请求的完整 URL。

已返回： 总是

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

已返回： 总是

示例: 0

response_data

列表 / 元素=字符串

API 响应。

已返回： 总是

response_message

字符串

API 响应的描述性消息。

已返回： 总是

示例: "OK."

system_information

字典

目标系统的信息。

已返回： 总是

rc

整数

请求的状态。

已返回： 总是

示例: 0

version_check_warning

列表 / 元素=字符串

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

已返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)