fortinet.fortimanager.fmgr_firewall_ippool6 模块 – 配置 IPv6 IP 池。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必填	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。选项 `false` ← (默认) `true`
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ← (默认) `true`
firewall_ippool6 字典	设置的顶级参数。
add_nat46_route 别名：add-nat46-route 字符串	启用/禁用添加 NAT46 路由。选项 `"disable"` `"enable"`
comments 字符串	注释。
dynamic_mapping 列表 / 元素=字典	动态映射。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
add_nat46_route 别名：add-nat46-route 字符串	启用/禁用添加 NAT46 路由。选项 `"disable"` `"enable"`
comments 字符串	注释。
endip 字符串	结束IP。
external_prefix 别名：external-prefix 字符串	支持元变量外部 NPTv6 前缀长度
internal_prefix 别名：internal-prefix 字符串	支持元变量内部 NPTv6 前缀长度
nat46 字符串	启用/禁用 NAT46。选项 `"disable"` `"enable"`
startip 字符串	起始IP。
type 字符串	配置 IPv6 池类型选项 `"overload"` `"nptv6"`
endip 字符串	最终 IPv6 地址
external_prefix 别名：external-prefix 字符串	支持元变量外部 NPTv6 前缀长度
internal_prefix 别名：internal-prefix 字符串	支持元变量内部 NPTv6 前缀长度
name 字符串 / 必填	IPv6 IP 池名称。
nat46 字符串	启用/禁用 NAT46。选项 `"disable"` `"enable"`
startip 字符串	第一个 IPv6 地址
type 字符串	配置 IPv6 池类型选项 `"overload"` `"nptv6"`
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 IP pools.
      fortinet.fortimanager.fmgr_firewall_ippool6:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_ippool6:
          comments: "ansible-comment"
          endip: "2001::101"
          name: "ansible-test"
          startip: "2001::0"

- 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 IP pools
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_ippool6"
          params:
            adom: "ansible"
            ippool6: "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版本支持，则会发出警告。返回： complex（复杂数据类型）

作者

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