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

注意

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

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

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

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

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 客户端。

pm_pkg_adom

字典

设置的顶级参数。

name

字符串

名称。

obj_ver

别名：obj ver

整数

Obj ver。

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。

type

字符串

类型。

选项

  • "pkg"

  • "folder"

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

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 帮助完成此工作。

  • 通常，当返回非零 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: Create a package in a adom
      fortinet.fortimanager.fmgr_pm_pkg_adom:
        adom: "ansible"
        pm_pkg_adom:
          name: "ansible"
          type: "pkg"

    - name: Create a package in global adom
      fortinet.fortimanager.fmgr_pm_pkg_global:
        pm_pkg_global:
          name: "ansible"
          type: "pkg"

返回值

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

键

描述

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

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)