fortinet.fortimanager.fmgr_pkg_firewall_localinpolicy6 模块 – 配置用户定义的 IPv6 本地入站策略。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必填	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。
pkg 字符串 / 必填	请求 URL 中的参数 (pkg)。
pkg_firewall_localinpolicy6 字典	设置的顶级参数。
action 字符串	对匹配策略的流量执行的操作 选项 "deny" "accept"
comments 字符串	注释。
dstaddr any	(列表或字符串) 可用选项中的目标地址对象。
dstaddr_negate 别名：dstaddr-negate 字符串	启用时，dstaddr 指定目标地址不能是什么。 选项 "disable" "enable"
internet_service6_src 别名：internet-service6-src 字符串	启用/禁用在此本地入站策略中对源使用 IPv6 Internet 服务。 选项 "disable" "enable"
internet_service6_src_custom 别名：internet-service6-src-custom any	(列表) 自定义 IPv6 Internet 服务源名称。
internet_service6_src_custom_group 别名：internet-service6-src-custom-group any	(列表) 自定义 Internet 服务 6 源组名称。
internet_service6_src_group 别名：internet-service6-src-group any	(列表) Internet 服务 6 源组名称。
internet_service6_src_name 别名：internet-service6-src-name any	(列表) IPv6 Internet 服务源名称。
internet_service6_src_negate 别名：internet-service6-src-negate 字符串	启用时，internet-service6-src 指定服务不能是什么。 选项 "disable" "enable"
intf 字符串	可用选项中的传入接口名称。
logtraffic 字符串	启用/禁用本地入站流量日志记录。 选项 "disable" "enable"
policyid 整数 / 必填	用户定义的本地入站策略 ID。
schedule 字符串	可用选项中的计划对象。
service any	(列表或字符串) 可用选项中的服务对象。
service_negate 别名：service-negate 字符串	启用时，service 指定服务不能是什么。 选项 "disable" "enable"
srcaddr any	(列表或字符串) 可用选项中的源地址对象。
srcaddr_negate 别名：srcaddr-negate 字符串	启用时，srcaddr 指定源地址不能是什么。 选项 "disable" "enable"
status 字符串	启用/禁用此本地入站策略。 选项 "disable" "enable"
uuid 字符串	通用唯一标识符
virtual_patch 别名：virtual-patch 字符串	启用/禁用虚拟修补功能。 选项 "disable" "enable"
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 user defined IPv6 local-in policies.
      fortinet.fortimanager.fmgr_pkg_firewall_localinpolicy6:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_localinpolicy6:
          action: deny # <value in [deny, accept]>
          dstaddr: all
          intf: any
          policyid: 1
          schedule: always
          service: ALL
          srcaddr: all
          status: 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 user defined IPv6 local-in policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_localinpolicy6"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            local-in-policy6: "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)

收藏链接

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