fortinet.fortimanager.fmgr_securityconsole_reinstall_package 模块 – 重新安装先前已安装的策略包。

注意

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

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

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

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

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

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

securityconsole_reinstall_package

字典

设置的顶级参数。

adom

字符串

源 ADOM 名称。

flags

列表 / 元素=字符串

cp_all_objs - 在全局策略分配期间分配所有对象。

preview - 仅生成预览缓存。

generate_rev - 安装前生成新的 ADOM 版本。

copy_assigned_pkg - 对于全局策略分配 - 将分配的包从 ADOM 复制到设备。

unassign - 从 ADOM 中移除全局策略。

ifpolicy_only - 仅安装接口策略。

no_ifpolicy - 仅安装常规策略 - 不安装接口策略。

objs_only - 安装对象

auto_lock_ws - 在执行安全控制台任务时自动锁定和解锁工作区。

copy_only - 只复制到设备数据库。

选项

  • "none"

  • "cp_all_objs"

  • "preview"

  • "generate_rev"

  • "copy_assigned_pkg"

  • "unassign"

  • "ifpolicy_only"

  • "no_ifpolicy"

  • "objs_only"

  • "auto_lock_ws"

  • "check_pkg_st"

  • "copy_only"

target

列表 / 元素=字典

目标。

pkg

字符串

源包路径和名称。

scope

列表 / 元素=字典

范围。

name

字符串

名称。

vdom

字符串

Vdom。

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 有助于完成工作。

  • 通常，当返回非零 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: Re-install a policy package that had been previously installed.
      fortinet.fortimanager.fmgr_securityconsole_reinstall_package:
        # 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, ...]
        securityconsole_reinstall_package:
          adom: <string>
          flags:
            - "none"
            - "cp_all_objs"
            - "preview"
            - "generate_rev"
            - "copy_assigned_pkg"
            - "unassign"
            - "ifpolicy_only"
            - "no_ifpolicy"
            - "objs_only"
            - "auto_lock_ws"
            - "check_pkg_st"
            - "copy_only"
          target:
            -
              pkg: <string>
              scope:
                -
                  name: <string>
                  vdom: <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

列表 / 元素=字符串

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

返回：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑林 (@chillancezen)

  • 沈芳 (@fshen01)

  • 陆宏斌 (@fgtdev-hblu)