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

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包含所有需要在使用前调整为数据源的参数和值。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
addrgrp 字符串 / 必需	请求 URL 中的参数 (addrgrp)。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。选项 `false` ← (默认) `true`
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ← (默认) `true`
firewall_addrgrp_dynamicmapping 字典	设置的顶级参数。
_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 字符串	安全结构全局对象设置。选项 `"disable"` `"enable"`
global_object 别名：global-object 整数	全局对象。
member 任意	(列表或字符串) 成员。
tags 任意	(列表或字符串) 标签。
type 字符串	类型。选项 `"default"` `"array"` `"folder"`
uuid 字符串	Uuid。
visibility 字符串	可见性。选项 `"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，该值可以是全局的和其他值，包括 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 dynamic mappings of IPv4 address group
      fortinet.fortimanager.fmgr_firewall_addrgrp_dynamicmapping:
        bypass_validation: false
        adom: ansible
        addrgrp: "ansible" # name
        state: present
        firewall_addrgrp_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          allow-routing: disable
          color: 1
          member: "ansible-test1"
          visibility: enable

- 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 dynamic mappings of IPv4 address group
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_addrgrp_dynamicmapping"
          params:
            adom: "ansible"
            addrgrp: "ansible-addrgrp4" # name
            dynamic_mapping: "your_value"

返回值 

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

键	描述
元数据 (meta) 字典	请求的结果。返回值：始终返回
请求URL (request_url) 字符串	请求的完整URL。返回值：始终返回示例： `"/sys/login/user"`
响应代码 (response_code) 整数	API请求的状态。返回值：始终返回示例： `0`
响应数据 (response_data) 列表 / 元素=字符串	API响应。返回值：始终返回
响应消息 (response_message) 字符串	API响应的描述性消息。返回值：始终返回示例： `"OK."`
系统信息 (system_information) 字典	目标系统的信息。返回值：始终返回
rc 整数	请求的状态。返回值：始终返回示例： `0`
版本检查警告 (version_check_warning) 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。返回值：复杂类型

作者

杜欣伟 (@dux-fortinet)
李星 (@lix-fortinet)
薛杰 (@JieX19)
郑琳 (@chillancezen)
沈方 (@fshen01)
陆宏斌 (@fgtdev-hblu)