fortinet.fortimanager.fmgr_pm_pkg 模块 –策略包或文件夹。

注意

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

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

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

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

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_path

字符串 / 必需

请求 URL 中的参数 (pkg_path)。

pm_pkg

字典

设置的顶级参数。

name

字符串 / 必需

名称。

obj_ver

别名：obj ver

整数

Obj 版本。

oid

整数

Oid。

package_setting

别名：package setting

字典

包设置。

central_nat

别名：central-nat

字符串

中央 NAT。

选项

  • "disable"

  • "enable"

consolidated_firewall_mode

别名：consolidated-firewall-mode

字符串

合并防火墙模式。

选项

  • "disable"

  • "enable"

fwpolicy6_implicit_log

别名：fwpolicy6-implicit-log

字符串

Fwpolicy6 隐式日志。

选项

  • "disable"

  • "enable"

fwpolicy_implicit_log

别名：fwpolicy-implicit-log

字符串

Fwpolicy 隐式日志。

选项

  • "disable"

  • "enable"

inspection_mode

别名：inspection-mode

字符串

检测模式。

选项

  • "proxy"

  • "flow"

ngfw_mode

别名：ngfw-mode

字符串

NGFW 模式。

选项

  • "profile-based"

  • "policy-based"

ssl_ssh_profile

别名：ssl-ssh-profile

字符串

SSL SSH 配置文件。

package_settings

别名：package settings

字典

包设置。

central_nat

别名：central-nat

字符串

disable -

enable -

选项

  • "disable"

  • "enable"

consolidated_firewall_mode

别名：consolidated-firewall-mode

字符串

用于基于流的策略包。

disable -

enable -

选项

  • "disable"

  • "enable"

fwpolicy6_implicit_log

别名：fwpolicy6-implicit-log

字符串

disable -

enable -

选项

  • "disable"

  • "enable"

fwpolicy_implicit_log

别名：fwpolicy-implicit-log

字符串

disable -

enable -

选项

  • "disable"

  • "enable"

inspection_mode

别名：inspection-mode

字符串

proxy -

flow -

选项

  • "proxy"

  • "flow"

ngfw_mode

别名：ngfw-mode

字符串

用于基于流的策略包。

profile-based -

policy-based -

选项

  • "profile-based"

  • "policy-based"

policy_offload_level

别名：policy-offload-level

字符串

disable -

default -

dos-offload -

full-offload -

选项

  • "disable"

  • "default"

  • "dos-offload"

  • "full-offload"

ssl_ssh_profile

别名：ssl-ssh-profile

字符串

NGFW 模式策略包所需的 SSL-SSH 配置文件。

scope_member

别名：scope member

列表 / 元素=字典

范围成员。

name

字符串

名称。

vdom

字符串

虚拟域 (Vdom)。

类型

字符串

类型。

选项

  • "pkg"

  • "folder"

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将被覆盖的失败条件对应的RC代码列表。

rc_succeeded

列表 / 元素=整数

将被覆盖的成功条件对应的RC代码列表。

状态

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Policy package or folder.
      fortinet.fortimanager.fmgr_pm_pkg:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        pkg_path: <your own value>
        state: present # <value in [present, absent]>
        pm_pkg:
          name: <string>
          obj_ver: <integer>
          oid: <integer>
          package_setting:
            central_nat: <value in [disable, enable]>
            consolidated_firewall_mode: <value in [disable, enable]>
            fwpolicy_implicit_log: <value in [disable, enable]>
            fwpolicy6_implicit_log: <value in [disable, enable]>
            inspection_mode: <value in [proxy, flow]>
            ngfw_mode: <value in [profile-based, policy-based]>
            ssl_ssh_profile: <string>
          scope_member:
            -
              name: <string>
              vdom: <string>
          type: <value in [pkg, folder]>
          package_settings:
            central_nat: <value in [disable, enable]>
            consolidated_firewall_mode: <value in [disable, enable]>
            fwpolicy_implicit_log: <value in [disable, enable]>
            fwpolicy6_implicit_log: <value in [disable, enable]>
            inspection_mode: <value in [proxy, flow]>
            ngfw_mode: <value in [profile-based, policy-based]>
            policy_offload_level: <value in [disable, default, dos-offload, ...]>
            ssl_ssh_profile: <string>

返回值

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

键

描述

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)