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

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

• 示例包含所有参数和值，在使用前需要根据数据源进行调整。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
address 字符串 / 必需	请求 URL 中的参数 (address)。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
firewall_address_dynamicmapping 字典	设置的顶级参数。
_image_base64 别名：_image-base64 字符串	图像 base64。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
allow_routing 别名：allow-routing 字符串	允许路由。 选项 "disable" "enable"
associated_interface 别名：associated-interface 字符串	关联接口。
cache_ttl 别名：cache-ttl 整数	缓存 ttl。
clearpass_spt 别名：clearpass-spt 字符串	Clearpass spt。 选项 "unknown" "healthy" "quarantine" "checkup" "transition" "infected" "transient"
color 整数	颜色。
comment 任意	(字典或字符串) 注释。
country 字符串	国家。
dirty 字符串	要删除的地址。 选项 "dirty" "clean"
end_ip 别名：end-ip 字符串	结束 IP。
end_mac 别名：end-mac 字符串	结束 MAC。
epg_name 别名：epg-name 字符串	EPG 名称。
fabric_object 别名：fabric-object 字符串	安全结构全局对象设置。 选项 "disable" "enable"
filter 字符串	过滤器。
fqdn 字符串	FQDN。
fsso_group 别名：fsso-group 任意	(列表或字符串) FSSO 组。
global_object 别名：global-object 整数	全局对象。
hw_model 别名：hw-model 字符串	动态地址匹配硬件型号。
hw_vendor 别名：hw-vendor 字符串	动态地址匹配硬件厂商。
interface 字符串	接口。
macaddr 任意	(列表) 多个 MAC 地址范围。
node_ip_only 别名：node-ip-only 字符串	启用/禁用仅在 Kubernetes 中收集节点地址。 选项 "disable" "enable"
obj_id 别名：obj-id 字符串	对象 ID。
obj_tag 别名：obj-tag 字符串	对象标签。
obj_type 别名：obj-type 字符串	对象类型。 选项 "ip" "mac"
organization 字符串	组织。
os 字符串	动态地址匹配操作系统。
pattern_end 别名：pattern-end 整数	模式结束。
pattern_start 别名：pattern-start 整数	模式开始。
policy_group 别名：policy-group 字符串	策略组。
route_tag 别名：route-tag 整数	路由标签地址。
sdn 字符串	SDN。 选项 "aci" "aws" "nsx" "nuage" "azure" "gcp" "oci" "openstack"
sdn_addr_type 别名：sdn-addr-type 字符串	SDN 地址类型。 选项 “private” “public” “all”
sdn_tag 别名：sdn-tag 字符串	SDN 标签。
start_ip 别名：start-ip 字符串	起始IP地址。
start_mac 别名：start-mac 字符串	起始MAC地址。
sub_type 别名：sub-type 字符串	子类型。 选项 “sdn” “clearpass-spt” “fsso” “ems-tag” “swc-tag” “fortivoice-tag” “fortinac-tag” “fortipolicy-tag” “device-identification”
subnet 字符串	子网。
subnet_name 别名：subnet-name 字符串	子网名称。
sw_version 别名：sw-version 字符串	动态地址匹配软件版本。
tag_detection_level 别名：tag-detection-level 字符串	动态地址对象的标签检测级别。
tag_type 别名：tag-type 字符串	动态地址对象的标签类型。
tags 任意	(列表或字符串) 标签。
tenant 字符串	租户。
type 字符串	类型。 选项 “ipmask” “iprange” “fqdn” “wildcard” “geography” “url” “wildcard-fqdn” "nsx" "aws" “dynamic” “interface-subnet” "mac" “fqdn-group” “route-tag”
url 字符串	URL。
uuid 字符串	UUID。
visibility 字符串	可见性。 选项 "disable" "enable"
wildcard 字符串	通配符。
wildcard_fqdn 别名：wildcard-fqdn 字符串	通配符FQDN。
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
      fortinet.fortimanager.fmgr_firewall_address_dynamicmapping:
        bypass_validation: true
        adom: ansible
        address: "ansible-test1" # name
        state: present
        firewall_address_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          allow-routing: disable # <value in [disable, enable]>
          cache-ttl: 0
          color: 1
          comment: "ansible-comment"
          subnet: "222.222.222.101/32"
          subnet-name: "ansible-test"
          type: ipmask # <value in [ipmask, iprange, fqdn, ...]>
          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
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_address_dynamicmapping"
          params:
            adom: "ansible"
            address: "ansible-test1" # name
            dynamic_mapping: "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 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回：复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑林 (@chillancezen)

• 沈方 (@fshen01)

• 陆洪斌 (@fgtdev-hblu)

集合链接

• 问题跟踪器
• 主页
• 代码库（源代码）