fortinet.fortimanager.fmgr_firewall_proxyaddress_headergroup 模块 – HTTP 标头组。

注意

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

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

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

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

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_headergroup

字典

设置的顶级参数。

case_sensitivity

别名：case-sensitivity

字符串

模式中的大小写敏感性。

选项

  • "disable"

  • "enable"

header

字符串

HTTP 标头正则表达式。

header_name

别名：header-name

字符串

HTTP 标头。

id

整数 / 必选

ID。

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

proxy-address

字符串

已弃用，请使用“proxy_address”

proxy_address

字符串

请求 URL 中的参数 (proxy-address)。

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必选

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

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 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: HTTP header group.
      fortinet.fortimanager.fmgr_firewall_proxyaddress_headergroup:
        bypass_validation: false
        adom: ansible
        proxy-address: "ansible-test" # name
        state: present
        firewall_proxyaddress_headergroup: # available only when type is set to "Advanced(Source)" in prox-address
          case-sensitivity: disable
          header: ansible-test-header
          header-name: ansible-test-header
          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 HTTP header groups of proxy address
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_proxyaddress_headergroup" # available only when type is set to "Advanced(Source)" in prox-address
          params:
            adom: "ansible"
            proxy-address: "ansible-test" # name
            header-group: "your_value"

返回值

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

键

描述

meta

字典

请求的结果。

返回值： 始终

request_url

字符串

请求的完整 URL。

返回值： 始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回值： 始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回值： 始终

response_message

字符串

API 响应的描述性消息。

返回值： 始终

示例： "OK."

系统信息

字典

目标系统的信息。

返回值： 始终

返回码

整数

请求的状态。

返回值： 始终

示例： 0

版本检查警告

列表 / 元素=字符串

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

返回: 复杂数据类型

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)