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

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

  • 示例包括所有需要在使用前调整到数据源的参数和值。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选择

  • false ←（默认）

  • true

enable_log

布尔值

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

选择

  • false ←（默认）

  • true

firewall_proxyaddrgrp

字典

设置的顶层参数。

_image_base64

别名：_image-base64

字符串

图像 base64。

color

整数

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

comment

字符串

可选注释。

member

任意

（列表或字符串）地址组的成员。

name

字符串 / 必需

地址组名称。

tagging

列表 / elements=字典

标签。

category

字符串

标签类别。

name

字符串

标签条目名称。

tags

任意

（列表）标签。

tags

字符串

对象标签的名称

type

字符串

源或目标地址组类型。

选择

  • "src"

  • "dst"

uuid

字符串

通用唯一标识符

visibility

字符串

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

选择

  • "disable"

  • "enable"

forticloud_access_token

字符串

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

proposed_method

字符串

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

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=整数

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

rc_succeeded

列表 / elements=整数

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

state

字符串 / 必需

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

选择

  • "present"

  • "absent"

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

  • 要创建或更新对象，请使用 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 group configuration.
      fortinet.fortimanager.fmgr_firewall_proxyaddrgrp:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_proxyaddrgrp:
          color: 1
          comment: "ansible-comment"
          member: "ansible-test" # need a valid proxy address name
          name: "ansible-test2"

- 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 address groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_proxyaddrgrp"
          params:
            adom: "ansible"
            proxy-addrgrp: "your_value"

返回值

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

键

描述

meta

字典

请求的结果。

返回：总是

request_url

字符串

请求的完整 URL。

返回：总是

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回：总是

示例： 0

response_data

列表 / elements=字符串

API 响应。

返回：总是

response_message

字符串

API 响应的描述性消息。

返回：总是

示例： "OK."

system_information

字典

目标系统的信息。

返回：总是

rc

整数

请求的状态。

返回：总是

示例： 0

version_check_warning

列表 / elements=字符串

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

返回：复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)