fortinet.fortimanager.fmgr_system_autodelete_dlpfilesautodeletion 模块 – DLP 存档的自动删除策略。

注意

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

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

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

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

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

proposed_method

字符串

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

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=integer

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

rc_succeeded

列表 / elements=integer

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

system_autodelete_dlpfilesautodeletion

字典

设置的顶层参数。

retention

字符串

以天、周或月为单位的自动删除。

days - 自动删除早于的数据

weeks - 自动删除早于的数据

months - 自动删除早于的数据

选择

  • "days"

  • "weeks"

  • "months"

runat

整数

自动删除运行时间

status

字符串

启用/禁用自动删除。

disable - 禁用自动删除。

enable - 启用自动删除。

选择

  • "disable"

  • "enable"

value

整数

以 x 天、周或月为单位的自动删除。

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 adom，该值可以是全局的以及包括根在内的其他值。

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: Automatic deletion policy for DLP archives.
      fortinet.fortimanager.fmgr_system_autodelete_dlpfilesautodeletion:
        # 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, ...]
        system_autodelete_dlpfilesautodeletion:
          retention: <value in [days, weeks, months]>
          runat: <integer>
          status: <value in [disable, enable]>
          value: <integer>

返回值

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

键

描述

meta

字典

请求的结果。

已返回：总是

request_url

字符串

请求的完整 URL。

已返回：总是

示例： "/sys/login/user"

response_code

整数

api 请求的状态。

已返回：总是

示例： 0

response_data

列表 / elements=string

api 响应。

已返回：总是

response_message

字符串

api 响应的描述性消息。

已返回：总是

示例： "OK."

system_information

字典

目标系统的信息。

已返回：总是

rc

整数

请求的状态。

已返回：总是

示例： 0

version_check_warning

列表 / elements=string

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

已返回：复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)