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

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要 

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

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。选项 `false` ← (默认) `true`
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ← (默认) `true`
forticloud_access_token 字符串	使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。
pm_pkg_global 字典	设置的顶层参数。
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"`
consolidated_firewall_mode 别名: consolidated-firewall-mode 字符串	对于基于流的策略包。禁用 - 启用 - 选项 `"disable"` `"enable"`
fwpolicy6_implicit_log 别名: fwpolicy6-implicit-log 字符串	禁用 - 启用 - 选项 `"disable"` `"enable"`
fwpolicy_implicit_log 别名: fwpolicy-implicit-log 字符串	禁用 - 启用 - 选项 `"disable"` `"enable"`
inspection_mode 别名: inspection-mode 字符串	代理 - 流 - 选项 `"proxy"` `"flow"`
ngfw_mode 别名: ngfw-mode 字符串	对于基于流的策略包。基于配置文件 - 基于策略 - 选项 `"profile-based"` `"policy-based"`
policy_offload_level 别名: policy-offload-level 字符串	禁用 - 默认 - dos-卸载 - 完全卸载 - 选项 `"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 列表 / 元素=整数	覆盖成功条件的返回码列表。
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)