fortinet.fortimanager.fmgr_firewall_proxyaddress 模块 – Web 代理地址配置。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块在不验证参数的情况下继续执行。

选项

  • false ←（默认）

  • true

enable_log

布尔值

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

选项

  • false ←（默认）

  • true

firewall_proxyaddress

字典

设置的顶层参数。

_image_base64

别名：_image-base64

字符串

图像 base64。

application

任何

（列表）SaaS 应用程序。

case_sensitivity

别名：case-sensitivity

字符串

启用以使模式区分大小写。

选项

  • "disable"

  • "enable"

category

任何

（列表或字符串）FortiGuard 类别 ID。

color

整数

用于确定 GUI 中图标颜色的整数值

comment

字符串

可选的注释。

header

字符串

作为正则表达式的 HTTP 标头名称。

header_group

别名：header-group

列表 / 元素=字典

标头组。

case_sensitivity

别名：case-sensitivity

字符串

模式中的区分大小写。

选项

  • "disable"

  • "enable"

header

字符串

HTTP 标头正则表达式。

header_name

别名：header-name

字符串

HTTP 标头。

id

整数

ID。

header_name

别名：header-name

字符串

HTTP 标头的名称。

host

字符串

主机的地址对象。

host_regex

别名：host-regex

字符串

作为正则表达式的主机名。

method

列表 / 元素=字符串

要使用的 HTTP 请求方法。

选项

  • "delete"

  • "get"

  • "head"

  • "options"

  • "post"

  • "put"

  • "trace"

  • "connect"

name

字符串 / 必需

地址名称。

path

字符串

作为正则表达式的 URL 路径。

query

字符串

将 URL 的查询部分作为正则表达式进行匹配。

referrer

字符串

启用/禁用在 HTTP 标头中使用引荐来源字段来匹配地址。

选项

  • "disable"

  • "enable"

tagging

列表 / 元素=字典

标记。

category

字符串

标签类别。

name

字符串

标记条目名称。

tags

任何

（列表）标签。

tags

字符串

对象标签的名称

type

字符串

代理地址类型。

选项

  • "host-regex"

  • "url"

  • "category"

  • "method"

  • "ua"

  • "header"

  • "src-advanced"

  • "dst-advanced"

  • "url-list"

  • "saas"

ua

列表 / 元素=字符串

要用作用户代理的浏览器名称。

选项

  • "chrome"

  • "ms"

  • "firefox"

  • "safari"

  • "other"

  • "ie"

  • "edge"

ua_max_ver

别名：ua-max-ver

字符串

以点分表示法指定的用户代理的最大版本。

ua_min_ver

别名：ua-min-ver

字符串

以点分表示法指定的用户代理的最小版本。

uuid

字符串

通用唯一标识符

visibility

字符串

启用/禁用对象在 GUI 中的可见性。

选项

  • "disable"

  • "enable"

forticloud_access_token

字符串

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

proposed_method

字符串

基础 Json RPC 请求的替代方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

用于覆盖失败条件的返回码列表。

rc_succeeded

列表 / 元素=整数

用于覆盖成功条件的返回码列表。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 ADOM，值可以是 global 以及包括 root 在内的其他 ADOM。

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: Web proxy address configuration.
      fortinet.fortimanager.fmgr_firewall_proxyaddress:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_proxyaddress:
          case-sensitivity: disable
          color: 1
          comment: "ansible-comment"
          name: "ansible-test"

- 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 proxy addresses
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_proxyaddress"
          params:
            adom: "ansible"
            proxy-address: "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

列表 / 元素=字符串

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

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)