fortinet.fortimanager.fmgr_firewall_address6 模块 – 配置 IPv6 防火墙地址。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要

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

• 示例包含所有参数和值，在使用前需要将其调整到数据源。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构差异时设置为 True，模块将继续执行而不验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
firewall_address6 字典	设置的顶级参数。
_image_base64 别名：_image-base64 字符串	图像 base64。
cache_ttl 别名：cache-ttl 整数	FQDN 缓存中单个 IPv6 地址的最小 TTL。
color 整数	确定 GUI 中图标颜色的整数值
comment 字符串	注释。
country 字符串	与特定国家/地区关联的 IPv6 地址。
dynamic_mapping 列表 / 元素=字典	动态映射。
_image_base64 别名：_image-base64 字符串	图像 base64。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
cache_ttl 别名：cache-ttl 整数	缓存 ttl。
color 整数	颜色。
comment 字符串	注释。
country 字符串	国家/地区。
end_ip 别名：end-ip 字符串	结束 IP。
end_mac 别名：end-mac 字符串	结束 MAC。
epg_name 别名：epg-name 字符串	端点组名称。
fabric_object 别名：fabric-object 字符串	安全结构全局对象设置。 选项 "disable" "enable"
filter 字符串	匹配条件过滤器。
fqdn 字符串	FQDN。
global_object 别名：global-object 整数	全局对象。
host 字符串	主机。
host_type 别名：host-type 字符串	主机类型。 选项 "any" "specific"
ip6 字符串	Ip6。
macaddr any	(列表) 多个 MAC 地址范围。
obj_id 别名：obj-id 字符串	对象 ID。
route_tag 别名：route-tag 整数	路由标签地址。
sdn 字符串	SDN。 选项 "nsx"
sdn_addr_type 别名：sdn-addr-type 字符串	要收集的地址类型。 选项 "all" "private" "public"
sdn_tag 别名：sdn-tag 字符串	SDN 标签。
start_ip 别名：start-ip 字符串	起始 IP。
start_mac 别名：start-mac 字符串	起始 MAC。
subnet_segment 别名：subnet-segment 列表 / 元素=字典	子网段。
name 字符串	名称。
type 字符串	类型。 选项 "any" "specific"
value 字符串	值。
tags any	(列表或字符串) 标签。
template 字符串	模板。
tenant 字符串	租户。
type 字符串	类型。 选项 "ipprefix" "iprange" "nsx" "dynamic" "fqdn" "template" "mac" "geography" "route-tag"
uuid 字符串	Uuid。
visibility 字符串	可见性。 选项 "disable" "enable"
end_ip 别名：end-ip 字符串	最终 IP 地址
end_mac 别名：end-mac 字符串	范围内的最后一个 MAC 地址。
epg_name 别名：epg-name 字符串	端点组名称。
fabric_object 别名：fabric-object 字符串	安全结构全局对象设置。 选项 "disable" "enable"
filter 字符串	匹配条件过滤器。
fqdn 字符串	完全限定域名。
global_object 别名：global-object 整数	全局对象。
host 字符串	主机地址。
host_type 别名：host-type 字符串	主机类型。 选项 "any" "specific"
ip6 字符串	IPv6 地址前缀
list 列表 / 元素=字典	列表。
ip 字符串	IP。
net_id 别名：net-id 字符串	网络 ID。
obj_id 别名：obj-id 字符串	对象 ID。
macaddr any	(列表) 多个 MAC 地址范围。
name 字符串 / 必需	地址名称。
obj_id 别名：obj-id 字符串	NSX 的对象 ID。
profile_list 别名：profile-list 列表 / 元素=字典	配置文件列表。
profile_id 别名：profile-id 整数	NSX 服务配置文件 ID。
route_tag 别名：route-tag 整数	路由标签地址。
sdn 字符串	SDN。 选项 "nsx"
sdn_addr_type 别名：sdn-addr-type 字符串	要收集的地址类型。 选项 "all" "private" "public"
sdn_tag 别名：sdn-tag 字符串	SDN 标签。
start_ip 别名：start-ip 字符串	起始IP地址
start_mac 别名：start-mac 字符串	范围内的起始MAC地址。
subnet_segment 别名：subnet-segment 列表 / 元素=字典	子网段。
name 字符串	名称。
type 字符串	子网段类型。 选项 "any" "specific"
value 字符串	子网段值。
标签 列表 / 元素=字典	标签。
类别 字符串	标签类别。
name 字符串	标签条目名称。
tags any	(列表) 标签。
tags 字符串	应用于地址的对象标签名称。
template 字符串	IPv6 地址模板。
tenant 字符串	租户。
type 字符串	IPv6 地址对象的类型 选项 "ipprefix" "iprange" "nsx" "dynamic" "fqdn" "template" "mac" "geography" "route-tag"
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 IPv6 firewall addresses.
      fortinet.fortimanager.fmgr_firewall_address6:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_address6:
          host-type: any # <value in [any, specific]>
          ip6: "::/55"
          name: "ansible-test"
          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 IPv6 addresses
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_address6"
          params:
            adom: "ansible"
            address6: "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)

集合链接

• 问题追踪器
• 主页
• 代码库 (源代码)