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 列表 / 元素=字典	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 字符串	消息类型。
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 字符串	主题文本字符串
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 字符串	消息类型。
priority 字符串	消息优先级 选项 "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 字符串	消息类型。
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-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" "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 字符串	消息类型。
priority 字符串	消息优先级 选项 "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" "link-id-not-found" "msg-fmt-corrupt" "app-id-not-found" "repl-app-id-not-found" "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 列表 / 元素=字符串	如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回：复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李兴 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑林 (@chillancezen)

• 沈芳 (@fshen01)

• 陆宏斌 (@fgtdev-hblu)

集合链接

• 问题跟踪器
• 主页
• 代码库 (源代码)