fortinet.fortimanager.fmgr_system_replacemsggroup_mm1 模块 – 替换消息表条目。

注意

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

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

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

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

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

proposed_method

字符串

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

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=integer

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

rc_succeeded

列表 / elements=integer

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

replacemsg-group

字符串

已弃用，请使用“replacemsg_group”

replacemsg_group

字符串

请求的 URL 中的参数 (replacemsg-group)。

state

字符串 / 必需

用于创建、更新或删除对象的指令。

选择

  • "present"

  • "absent"

system_replacemsggroup_mm1

字典

顶层参数集。

add_smil

别名：add-smil

字符串

添加消息封装

选择

  • "disable"

  • "enable"

charset

字符串

用于替换消息的字符编码

选择

  • "us-ascii"

  • "utf-8"

class

字符串

消息类

选择

  • "personal"

  • "advertisement"

  • "information"

  • "automatic"

  • "not-included"

fmgr_message

字符串

消息文本

format

字符串

格式标志。

选择

  • "none"

  • "text"

  • "html"

  • "wml"

from

字符串

发件人地址

from_sender

别名：from-sender

字符串

从接收者发送的通知消息

选择

  • "disable"

  • "enable"

header

字符串

标头标志。

选择

  • "none"

  • "http"

  • "8bit"

image

字符串

消息字符串。

msg_type

别名：msg-type

字符串 / 必需

消息类型。

priority

字符串

消息优先级

选择

  • "low"

  • "normal"

  • "high"

  • "not-included"

rsp_status

别名：rsp-status

字符串

响应状态码

选择

  • "ok"

  • "err-unspecified"

  • "err-srv-denied"

  • "err-msg-fmt-corrupt"

  • "err-snd-addr-unresolv"

  • "err-msg-not-found"

  • "err-net-prob"

  • "err-content-not-accept"

  • "err-unsupp-msg"

rsp_text

别名：rsp-text

字符串

响应文本

sender_visibility

别名：sender-visibility

字符串

发件人可见性

选择

  • "hide"

  • "show"

  • "not-specified"

smil_part

别名：smil-part

字符串

消息封装文本

subject

字符串

主题文本字符串

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 可以帮助完成这项工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 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: Replacement message table entries.
      fortinet.fortimanager.fmgr_system_replacemsggroup_mm1:
        # 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>
        replacemsg_group: <your own value>
        state: present # <value in [present, absent]>
        system_replacemsggroup_mm1:
          add_smil: <value in [disable, enable]>
          charset: <value in [us-ascii, utf-8]>
          class: <value in [personal, advertisement, information, ...]>
          format: <value in [none, text, html, ...]>
          from: <string>
          from_sender: <value in [disable, enable]>
          header: <value in [none, http, 8bit]>
          image: <string>
          fmgr_message: <string>
          msg_type: <string>
          priority: <value in [low, normal, high, ...]>
          rsp_status: <value in [ok, err-unspecified, err-srv-denied, ...]>
          rsp_text: <string>
          sender_visibility: <value in [hide, show, not-specified]>
          smil_part: <string>
          subject: <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 版本支持，则会发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)