fortinet.fortimanager.fmgr_firewall_mmsprofile_dupe 模块 – 复制配置。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

firewall_mmsprofile_dupe

字典

设置的顶级参数。

action1

列表 / 元素=字符串

达到阈值时采取的操作。

选项

  • "log"

  • "archive"

  • "intercept"

  • "block"

  • "archive-first"

  • "alert-notif"

action2

列表 / 元素=字符串

达到阈值时采取的操作。

选项

  • "log"

  • "archive"

  • "intercept"

  • "block"

  • "archive-first"

  • "alert-notif"

action3

列表 / 元素=字符串

达到阈值时采取的操作。

选项

  • "log"

  • "archive"

  • "intercept"

  • "block"

  • "archive-first"

  • "alert-notif"

block_time1

别名：block-time1

整数

操作生效的持续时间

block_time2

别名：block-time2

整数

操作生效的持续时间

block_time3

别名：block-time3

整数

操作生效的持续时间

limit1

整数

允许的最大消息数。

limit2

整数

允许的最大消息数。

limit3

整数

允许的最大消息数。

protocol

字符串

协议。

status1

字符串

启用/禁用 status1 检测。

选项

  • "disable"

  • "enable"

status2

字符串

启用/禁用 status2 检测。

选项

  • "disable"

  • "enable"

status3

字符串

启用/禁用 status3 检测。

选项

  • "disable"

  • "enable"

window1

整数

计算消息的时间窗口

window2

整数

计算消息的时间窗口

window3

整数

计算消息的时间窗口

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

mms-profile

字符串

已弃用，请使用 “mms_profile”

mms_profile

字符串

请求的 URL 中的参数 (mms-profile)。

proposed_method

字符串

底层 Json RPC 请求的重写方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

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: Duplicate configuration.
      fortinet.fortimanager.fmgr_firewall_mmsprofile_dupe:
        # 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>
        mms_profile: <your own value>
        firewall_mmsprofile_dupe:
          action1:
            - "log"
            - "archive"
            - "intercept"
            - "block"
            - "archive-first"
            - "alert-notif"
          action2:
            - "log"
            - "archive"
            - "intercept"
            - "block"
            - "archive-first"
            - "alert-notif"
          action3:
            - "log"
            - "archive"
            - "intercept"
            - "block"
            - "archive-first"
            - "alert-notif"
          block_time1: <integer>
          block_time2: <integer>
          block_time3: <integer>
          limit1: <integer>
          limit2: <integer>
          limit3: <integer>
          protocol: <string>
          status1: <value in [disable, enable]>
          status2: <value in [disable, enable]>
          status3: <value in [disable, enable]>
          window1: <integer>
          window2: <integer>
          window3: <integer>

返回值

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

键

描述

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)