fortinet.fortimanager.fmgr_firewall_addrgrp 模块 – 配置 IPv4 地址组。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必填

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选择

  • false ← (默认)

  • true

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

firewall_addrgrp

字典

设置的顶层参数。

_image_base64

别名：_image-base64

字符串

图像 base64。

allow_routing

别名：allow-routing

字符串

启用/禁用在静态路由配置中使用此组。

选择

  • "disable"

  • "enable"

category

字符串

地址组类别。

选择

  • "default"

  • "ztna-ems-tag"

  • "ztna-geo-tag"

color

整数

GUI 上图标的颜色。

comment

任何

（字典或字符串）注释。

dynamic_mapping

列表 / 元素=字典

动态映射。

_image_base64

别名：_image-base64

字符串

图像 base64。

_scope

列表 / 元素=字典

范围。

name

字符串

名称。

vdom

字符串

Vdom。

allow_routing

别名：allow-routing

字符串

允许路由。

选择

  • "disable"

  • "enable"

category

字符串

地址组类别。

选择

  • "default"

  • "ztna-ems-tag"

  • "ztna-geo-tag"

color

整数

颜色。

comment

任何

（字典或字符串）注释。

exclude

字符串

排除。

选择

  • "disable"

  • "enable"

exclude_member

别名：exclude-member

任何

（列表或字符串）排除成员。

fabric_object

别名：fabric-object

字符串

安全 Fabric 全局对象设置。

选择

  • "disable"

  • "enable"

global_object

别名：global-object

整数

全局对象。

member

列表 / 元素=字符串

成员。

tags

任何

（列表或字符串）标签。

type

字符串

类型。

选择

  • "default"

  • "array"

  • "folder"

uuid

字符串

Uuid。

visibility

字符串

可见性。

选择

  • "disable"

  • "enable"

exclude

字符串

启用/禁用地址排除。

选择

  • "disable"

  • "enable"

exclude_member

别名：exclude-member

任何

（列表或字符串）地址排除成员。

fabric_object

别名：fabric-object

字符串

安全 Fabric 全局对象设置。

选择

  • "disable"

  • "enable"

global_object

别名：global-object

整数

全局对象。

member

列表 / 元素=字符串

组中包含的地址对象。

name

字符串 / 必填

地址组名称。

tagging

列表 / 元素=字典

标记。

category

字符串

标签类别。

name

字符串

标记条目名称。

tags

任何

（列表）标签。

tags

字符串

名称

type

字符串

地址组类型。

选择

  • "default"

  • "array"

  • "folder"

uuid

字符串

通用唯一标识符

visibility

字符串

启用/禁用 GUI 中的地址可见性。

选择

  • "disable"

  • "enable"

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 IPv4 address groups.
      fortinet.fortimanager.fmgr_firewall_addrgrp:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_addrgrp:
          allow-routing: disable
          color: 0
          member: "ansible-test1" # IPv4 address name
          name: "ansible-addrgrp4" # could not the same with other group, adress name, including IPv6 group and address
          visibility: 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 IPv4 address groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_addrgrp"
          params:
            adom: "ansible"
            addrgrp: "your_value"

返回值

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

键

描述

元数据

字典

请求的结果。

返回： 总是

请求网址

字符串

请求的完整网址。

返回： 总是

示例： "/sys/login/user"

响应代码

整数

API 请求的状态。

返回： 总是

示例： 0

响应数据

列表 / 元素=字符串

API 响应。

返回： 总是

响应消息

字符串

API 响应的描述性消息。

返回： 总是

示例： "OK."

系统信息

字典

目标系统的信息。

返回： 总是

rc

整数

请求的状态。

返回： 总是

示例： 0

版本检查警告

列表 / 元素=字符串

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

返回： 复合

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)