fortinet.fortimanager.fmgr_system_replacemsggroup 模块 – 配置替换消息组。

注意

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

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

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

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

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 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必填	创建、更新或删除对象的指令。选项 `"present"` `"absent"`
system_replacemsggroup 字典	设置的顶层参数。
admin 列表 / 元素=字典	管理员。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
alertmail 列表 / 元素=字典	警报邮件。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
id 整数	ID。
msg_type 别名：msg-type 字符串	消息类型。
auth 列表 / 元素=字典	身份验证。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
automation 列表 / 元素=字典	自动化。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
comment 字符串	注释。
custom_message 别名：custom-message 列表 / 元素=字典	自定义消息。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
device_detection_portal 别名：device-detection-portal 列表 / 元素=字典	设备检测门户。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
ec 列表 / 元素=字典	Ec。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
fortiguard_wf 别名：fortiguard-wf 列表 / 元素=字典	Fortiguard wf。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
ftp 列表 / 元素=字典	Ftp。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
group_type 别名：group-type 字符串	组类型。选项 `"default"` `"utm"` `"auth"` `"ec"` `"captive-portal"`
http 列表 / 元素=字典	Http。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
icap 列表 / 元素=字典	Icap。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
mail 列表 / 元素=字典	邮件。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
mm1 列表 / 元素=字典	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 字符串	消息类型。
优先级字符串	消息优先级选项 `"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（主题）字符串	主题文本字符串
mm3 列表 / 元素=字典	Mm3。
add_html 别名: add-html 字符串	添加消息封装选项 `"disable"` `"enable"`
charset 字符串	用于替换消息的字符编码选项 `"us-ascii"` `"utf-8"`
fmgr_message 字符串	消息文本
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
from 字符串	发件人地址
from_sender 别名：from-sender 字符串	从收件人发送的通知消息选项 `"disable"` `"enable"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
html_part 别名: html-part 字符串	消息封装文本
image 字符串	消息字符串。
msg_type 别名：msg-type 字符串	消息类型。
优先级字符串	消息优先级选项 `"low"（低）` `"normal"（正常）` `"high"（高）` `"not-included"`
subject（主题）字符串	主题文本字符串
mm4 列表 / 元素=字典	Mm4。
add_smil 别名：add-smil 字符串	添加消息封装选项 `"disable"` `"enable"`
charset 字符串	用于替换消息的字符编码选项 `"us-ascii"` `"utf-8"`
class 字符串	消息类选项 `"personal"` `"advertisement"` `"informational"（信息性）` `"auto"（自动）` `"not-included"`
domain（域）字符串	发件人地址域
fmgr_message 字符串	消息文本
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
from 字符串	发件人地址
from_sender 别名：from-sender 字符串	从收件人发送的通知消息选项 `"disable"` `"enable"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
image 字符串	消息字符串。
msg_type 别名：msg-type 字符串	消息类型。
优先级字符串	消息优先级选项 `"low"（低）` `"normal"（正常）` `"high"（高）` `"not-included"`
rsp_status 别名: rsp-status 字符串	响应状态选项 `"ok"（成功）` `"err-unspecified"（未指定错误）` `"err-srv-denied"（服务器拒绝）` `"err-msg-fmt-corrupt"（消息格式损坏）` `"err-snd-addr-unresolv"（发送地址无法解析）` `"err-net-prob"（网络问题）` `"err-content-not-accept"（内容不接受）` `"err-unsupp-msg"（不支持的消息）`
smil_part 别名: smil-part 字符串	消息封装文本
subject（主题）字符串	主题文本字符串
mm7 列表 / 元素=字典	Mm7。
add_smil 别名：add-smil 字符串	添加消息封装选项 `"disable"` `"enable"`
addr_type 别名: addr-type 字符串	发件人地址类型选项 `"rfc2822-addr"（RFC2822 地址）` `"number"（数字）` `"short-code"（短代码）`
allow_content_adaptation 别名: allow-content-adaptation 字符串	允许内容适配选项 `"disable"` `"enable"`
charset 字符串	用于替换消息的字符编码选项 `"us-ascii"` `"utf-8"`
class 字符串	消息类选项 `"personal"` `"advertisement"` `"informational"（信息性）` `"auto"（自动）` `"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 字符串	消息类型。
优先级字符串	消息优先级选项 `"low"（低）` `"normal"（正常）` `"high"（高）` `"not-included"`
rsp_status 别名: rsp-status 字符串	响应状态选项 `"success"（成功）` `"partial-success"（部分成功）` `"client-err"（客户端错误）` `"oper-restrict"（操作限制）` `"addr-err"（地址错误）` `"addr-not-found"（未找到地址）` `"content-refused"（内容被拒绝）` `"msg-id-not-found"（未找到消息 ID）` `"link-id-not-found"（未找到链接 ID）` `"msg-fmt-corrupt"（消息格式损坏）` `"app-id-not-found"（未找到应用 ID）` `"repl-app-id-not-found"（未找到替换应用 ID）` `"srv-err"（服务器错误）` `"not-possible"（不可能）` `"msg-rejected"（消息被拒绝）` `"multiple-addr-not-supp"（不支持多个地址）` `"app-addr-not-supp"（不支持应用地址）` `"gen-service-err"（通用服务错误）` `"improper-ident"（不正确的标识）` `"unsupp-ver"（不支持的版本）` `"unsupp-oper"（不支持的操作）` `"validation-err"（验证错误）` `"service-err"（服务错误）` `"service-unavail"（服务不可用）` `"service-denied"（服务被拒绝）` `"app-denied"（应用被拒绝）`
smil_part 别名: smil-part 字符串	消息封装文本
subject（主题）字符串	主题文本字符串
mms 列表 / 元素=字典	Mms。
buffer 字符串	消息字符串。
charset 字符串	用于替换消息的字符编码选项 `"us-ascii"` `"utf-8"`
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
image 字符串	消息字符串。
msg_type 别名：msg-type 字符串	消息类型。
nac_quar 别名: nac-quar 列表 / 元素=字典	Nac quar。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
id 整数	ID。
msg_type 别名：msg-type 字符串	消息类型。
name（名称）字符串 / 必填	组名称。
nntp 列表 / 元素=字典	Nntp。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
spam 列表 / 元素=字典	Spam。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
sslvpn 列表 / 元素=字典	Sslvpn。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
traffic_quota 别名: traffic-quota 列表 / 元素=字典	流量配额。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
utm 列表 / 元素=字典	Utm。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
webproxy 列表 / 元素=字典	Webproxy。
buffer 字符串	消息字符串。
format 字符串	格式标志。选项 `"none"` `"text"` `"html"` `"wml"`
header 字符串	标头标志。选项 `"none"` `"http"` `"8bit"`
msg_type 别名：msg-type 字符串	消息类型。
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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure replacement message groups.
      fortinet.fortimanager.fmgr_system_replacemsggroup:
        bypass_validation: false
        adom: ansible
        state: present
        system_replacemsggroup:
          comment: ansible-comment
          name: ansible-test

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the replacement message groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_replacemsggroup"
          params:
            adom: "ansible"
            replacemsg-group: "your_value"

返回值 

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

键	描述
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)