fortios_system_replacemsg_group.rst

source:	fortios_system_replacemsg_group.py
orphan:

fortios_system_replacemsg_group -- Configure replacement message groups in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and replacemsg_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_system_replacemsg_group	v6.0.0 -> latest

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• system_replacemsg_group - Configure replacement message groups. type: dict more...

  	Supported Version Ranges
  system_replacemsg_group	v6.0.0 -> latest

• admin - Replacement message table entries. type: list member_path: admin:msg_type more...

  	Supported Version Ranges
  admin	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• alertmail - Replacement message table entries. type: list member_path: alertmail:msg_type more...

  	Supported Version Ranges
  alertmail	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• auth - Replacement message table entries. type: list member_path: auth:msg_type more...

  	Supported Version Ranges
  auth	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• automation - Replacement message table entries. type: list member_path: automation:msg_type more...

  	Supported Version Ranges
  automation	v7.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v7.0.0 -> latest

• format - Format flag. type: str choices: none, text, html more...

  	Supported Version Ranges
  format	v7.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v7.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v7.0.0 -> latest

• comment - Comment. type: str more...

  	Supported Version Ranges
  comment	v6.0.0 -> latest

• custom_message - Replacement message table entries. type: list member_path: custom_message:msg_type more...

  	Supported Version Ranges
  custom_message	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• device_detection_portal - Replacement message table entries. type: list member_path: device_detection_portal:msg_type more...

  	Supported Version Ranges
  device_detection_portal	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1

• ec - Replacement message table entries. type: list member_path: ec:msg_type more...

  	Supported Version Ranges
  ec	v6.0.0 -> v6.0.11

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> v6.0.11

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> v6.0.11
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> latest

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> v6.0.11
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> v6.0.11

• fortiguard_wf - Replacement message table entries. type: list member_path: fortiguard_wf:msg_type more...

  	Supported Version Ranges
  fortiguard_wf	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• ftp - Replacement message table entries. type: list member_path: ftp:msg_type more...

  	Supported Version Ranges
  ftp	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• group_type - Group type. type: str choices: default, utm, auth, ec more...

  	Supported Version Ranges
  group_type	v6.0.0 -> latest
  [default]	v6.0.0 -> latest
  [utm]	v6.0.0 -> latest
  [auth]	v6.0.0 -> latest
  [ec]	v6.0.0 -> v6.0.11

• http - Replacement message table entries. type: list member_path: http:msg_type more...

  	Supported Version Ranges
  http	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• icap - Replacement message table entries. type: list member_path: icap:msg_type more...

  	Supported Version Ranges
  icap	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• mail - Replacement message table entries. type: list member_path: mail:msg_type more...

  	Supported Version Ranges
  mail	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• mm1 - Replacement message table entries. type: list member_path: mm1:msg_type more...

  	Supported Version Ranges
  mm1	v6.0.0 -> v6.2.7

• add_smil - add message encapsulation type: str choices: enable, disable more...

  	Supported Version Ranges
  add_smil	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...

  	Supported Version Ranges
  charset	v6.0.0 -> v6.2.7
  [utf-8]	v6.0.0 -> latest
  [us-ascii]	v6.0.0 -> latest

• class - message class type: str choices: not-included, personal, advertisement, information, automatic more...

  	Supported Version Ranges
  class	v6.0.0 -> v6.2.7
  [not-included]	v6.0.0 -> latest
  [personal]	v6.0.0 -> latest
  [advertisement]	v6.0.0 -> latest
  [information]	v6.0.0 -> latest
  [automatic]	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> latest

• fos_message - message text type: str more...

  	Supported Version Ranges
  fos_message	v6.0.0 -> v6.2.7

• from - from address type: str more...

  	Supported Version Ranges
  from	v6.0.0 -> v6.2.7

• from_sender - notification message sent from recipient type: str choices: enable, disable more...

  	Supported Version Ranges
  from_sender	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• image - Message string. Source system.replacemsg-image.name. type: str more...

  	Supported Version Ranges
  image	v6.0.0 -> v6.2.7

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> v6.2.7

• priority - message priority type: str choices: not-included, low, normal, high more...

  	Supported Version Ranges
  priority	v6.0.0 -> v6.2.7
  [not-included]	v6.0.0 -> latest
  [low]	v6.0.0 -> latest
  [normal]	v6.0.0 -> latest
  [high]	v6.0.0 -> latest

• rsp_status - response status code type: str choices: 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 more...

  	Supported Version Ranges
  rsp_status	v6.0.0 -> v6.2.7
  [ok]	v6.0.0 -> latest
  [err-unspecified]	v6.0.0 -> latest
  [err-srv-denied]	v6.0.0 -> latest
  [err-msg-fmt-corrupt]	v6.0.0 -> latest
  [err-snd-addr-unresolv]	v6.0.0 -> latest
  [err-msg-not-found]	v6.0.0 -> latest
  [err-net-prob]	v6.0.0 -> latest
  [err-content-not-accept]	v6.0.0 -> latest
  [err-unsupp-msg]	v6.0.0 -> latest

• rsp_text - response text type: str more...

  	Supported Version Ranges
  rsp_text	v6.0.0 -> v6.2.7

• sender_visibility - sender visibility type: str choices: not-specified, show, hide more...

  	Supported Version Ranges
  sender_visibility	v6.0.0 -> v6.2.7
  [not-specified]	v6.0.0 -> latest
  [show]	v6.0.0 -> latest
  [hide]	v6.0.0 -> latest

• smil_part - message encapsulation text type: str more...

  	Supported Version Ranges
  smil_part	v6.0.0 -> v6.2.7

• subject - subject text string type: str more...

  	Supported Version Ranges
  subject	v6.0.0 -> v6.2.7

• mm3 - Replacement message table entries. type: list member_path: mm3:msg_type more...

  	Supported Version Ranges
  mm3	v6.0.0 -> v6.2.7

• add_html - add message encapsulation type: str choices: enable, disable more...

  	Supported Version Ranges
  add_html	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...

  	Supported Version Ranges
  charset	v6.0.0 -> v6.2.7
  [utf-8]	v6.0.0 -> latest
  [us-ascii]	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> latest

• fos_message - message text type: str more...

  	Supported Version Ranges
  fos_message	v6.0.0 -> v6.2.7

• from - from address type: str more...

  	Supported Version Ranges
  from	v6.0.0 -> v6.2.7

• from_sender - notification message sent from recipient type: str choices: enable, disable more...

  	Supported Version Ranges
  from_sender	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• html_part - message encapsulation text type: str more...

  	Supported Version Ranges
  html_part	v6.0.0 -> v6.2.7

• image - Message string. Source system.replacemsg-image.name. type: str more...

  	Supported Version Ranges
  image	v6.0.0 -> v6.2.7

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> v6.2.7

• priority - message priority type: str choices: not-included, low, normal, high more...

  	Supported Version Ranges
  priority	v6.0.0 -> v6.2.7
  [not-included]	v6.0.0 -> latest
  [low]	v6.0.0 -> latest
  [normal]	v6.0.0 -> latest
  [high]	v6.0.0 -> latest

• subject - subject text string type: str more...

  	Supported Version Ranges
  subject	v6.0.0 -> v6.2.7

• mm4 - Replacement message table entries. type: list member_path: mm4:msg_type more...

  	Supported Version Ranges
  mm4	v6.0.0 -> v6.2.7

• add_smil - add message encapsulation type: str choices: enable, disable more...

  	Supported Version Ranges
  add_smil	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...

  	Supported Version Ranges
  charset	v6.0.0 -> v6.2.7
  [utf-8]	v6.0.0 -> latest
  [us-ascii]	v6.0.0 -> latest

• class - message class type: str choices: not-included, personal, informational, advertisement, auto more...

  	Supported Version Ranges
  class	v6.0.0 -> v6.2.7
  [not-included]	v6.0.0 -> latest
  [personal]	v6.0.0 -> latest
  [informational]	v6.0.0 -> latest
  [advertisement]	v6.0.0 -> latest
  [auto]	v6.0.0 -> latest

• domain - from address domain type: str more...

  	Supported Version Ranges
  domain	v6.0.0 -> v6.2.7

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> latest

• fos_message - message text type: str more...

  	Supported Version Ranges
  fos_message	v6.0.0 -> v6.2.7

• from - from address type: str more...

  	Supported Version Ranges
  from	v6.0.0 -> v6.2.7

• from_sender - notification message sent from recipient type: str choices: enable, disable more...

  	Supported Version Ranges
  from_sender	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• image - Message string. Source system.replacemsg-image.name. type: str more...

  	Supported Version Ranges
  image	v6.0.0 -> v6.2.7

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> v6.2.7

• priority - message priority type: str choices: not-included, low, normal, high more...

  	Supported Version Ranges
  priority	v6.0.0 -> v6.2.7
  [not-included]	v6.0.0 -> latest
  [low]	v6.0.0 -> latest
  [normal]	v6.0.0 -> latest
  [high]	v6.0.0 -> latest

• rsp_status - response status type: str choices: ok, err-unspecified, err-srv-denied, err-msg-fmt-corrupt, err-snd-addr-unresolv, err-net-prob, err-content-not-accept, err-unsupp-msg more...

  	Supported Version Ranges
  rsp_status	v6.0.0 -> v6.2.7
  [ok]	v6.0.0 -> latest
  [err-unspecified]	v6.0.0 -> latest
  [err-srv-denied]	v6.0.0 -> latest
  [err-msg-fmt-corrupt]	v6.0.0 -> latest
  [err-snd-addr-unresolv]	v6.0.0 -> latest
  [err-net-prob]	v6.0.0 -> latest
  [err-content-not-accept]	v6.0.0 -> latest
  [err-unsupp-msg]	v6.0.0 -> latest

• smil_part - message encapsulation text type: str more...

  	Supported Version Ranges
  smil_part	v6.0.0 -> v6.2.7

• subject - subject text string type: str more...

  	Supported Version Ranges
  subject	v6.0.0 -> v6.2.7

• mm7 - Replacement message table entries. type: list member_path: mm7:msg_type more...

  	Supported Version Ranges
  mm7	v6.0.0 -> v6.2.7

• add_smil - add message encapsulation type: str choices: enable, disable more...

  	Supported Version Ranges
  add_smil	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• addr_type - from address type type: str choices: rfc2822-addr, number, short-code more...

  	Supported Version Ranges
  addr_type	v6.0.0 -> v6.2.7
  [rfc2822-addr]	v6.0.0 -> latest
  [number]	v6.0.0 -> latest
  [short-code]	v6.0.0 -> latest

• allow_content_adaptation - allow content adaptations type: str choices: enable, disable more...

  	Supported Version Ranges
  allow_content_adaptation	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...

  	Supported Version Ranges
  charset	v6.0.0 -> v6.2.7
  [utf-8]	v6.0.0 -> latest
  [us-ascii]	v6.0.0 -> latest

• class - message class type: str choices: not-included, personal, informational, advertisement, auto more...

  	Supported Version Ranges
  class	v6.0.0 -> v6.2.7
  [not-included]	v6.0.0 -> latest
  [personal]	v6.0.0 -> latest
  [informational]	v6.0.0 -> latest
  [advertisement]	v6.0.0 -> latest
  [auto]	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> latest

• fos_message - message text type: str more...

  	Supported Version Ranges
  fos_message	v6.0.0 -> v6.2.7

• from - from address type: str more...

  	Supported Version Ranges
  from	v6.0.0 -> v6.2.7

• from_sender - notification message sent from recipient type: str choices: enable, disable more...

  	Supported Version Ranges
  from_sender	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• image - Message string. Source system.replacemsg-image.name. type: str more...

  	Supported Version Ranges
  image	v6.0.0 -> v6.2.7

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> v6.2.7

• priority - message priority type: str choices: not-included, low, normal, high more...

  	Supported Version Ranges
  priority	v6.0.0 -> v6.2.7
  [not-included]	v6.0.0 -> latest
  [low]	v6.0.0 -> latest
  [normal]	v6.0.0 -> latest
  [high]	v6.0.0 -> latest

• rsp_status - response status type: str choices: 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 more...

  	Supported Version Ranges
  rsp_status	v6.0.0 -> v6.2.7
  [success]	v6.0.0 -> latest
  [partial-success]	v6.0.0 -> latest
  [client-err]	v6.0.0 -> latest
  [oper-restrict]	v6.0.0 -> latest
  [addr-err]	v6.0.0 -> latest
  [addr-not-found]	v6.0.0 -> latest
  [content-refused]	v6.0.0 -> latest
  [msg-id-not-found]	v6.0.0 -> latest
  [link-id-not-found]	v6.0.0 -> latest
  [msg-fmt-corrupt]	v6.0.0 -> latest
  [app-id-not-found]	v6.0.0 -> latest
  [repl-app-id-not-found]	v6.0.0 -> latest
  [srv-err]	v6.0.0 -> latest
  [not-possible]	v6.0.0 -> latest
  [msg-rejected]	v6.0.0 -> latest
  [multiple-addr-not-supp]	v6.0.0 -> latest
  [app-addr-not-supp]	v6.0.0 -> latest
  [gen-service-err]	v6.0.0 -> latest
  [improper-ident]	v6.0.0 -> latest
  [unsupp-ver]	v6.0.0 -> latest
  [unsupp-oper]	v6.0.0 -> latest
  [validation-err]	v6.0.0 -> latest
  [service-err]	v6.0.0 -> latest
  [service-unavail]	v6.0.0 -> latest
  [service-denied]	v6.0.0 -> latest
  [app-denied]	v6.0.0 -> latest

• smil_part - message encapsulation text type: str more...

  	Supported Version Ranges
  smil_part	v6.0.0 -> v6.2.7

• subject - subject text string type: str more...

  	Supported Version Ranges
  subject	v6.0.0 -> v6.2.7

• mms - Replacement message table entries. type: list member_path: mms:msg_type more...

  	Supported Version Ranges
  mms	v6.0.0 -> v6.2.7

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> v6.2.7

• charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...

  	Supported Version Ranges
  charset	v6.0.0 -> v6.2.7
  [utf-8]	v6.0.0 -> latest
  [us-ascii]	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> latest

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> v6.2.7
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• image - Message string. Source system.replacemsg-image.name. type: str more...

  	Supported Version Ranges
  image	v6.0.0 -> v6.2.7

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> v6.2.7

• nac_quar - Replacement message table entries. type: list member_path: nac_quar:msg_type more...

  	Supported Version Ranges
  nac_quar	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• name - Group name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• nntp - Replacement message table entries. type: list member_path: nntp:msg_type more...

  	Supported Version Ranges
  nntp	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> v6.2.7	v6.4.1 -> v6.4.1

• spam - Replacement message table entries. type: list member_path: spam:msg_type more...

  	Supported Version Ranges
  spam	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• sslvpn - Replacement message table entries. type: list member_path: sslvpn:msg_type more...

  	Supported Version Ranges
  sslvpn	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• traffic_quota - Replacement message table entries. type: list member_path: traffic_quota:msg_type more...

  	Supported Version Ranges
  traffic_quota	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• utm - Replacement message table entries. type: list member_path: utm:msg_type more...

  	Supported Version Ranges
  utm	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

• webproxy - Replacement message table entries. type: list member_path: webproxy:msg_type more...

  	Supported Version Ranges
  webproxy	v6.0.0 -> latest

• buffer - Message string. type: str more...

  	Supported Version Ranges
  buffer	v6.0.0 -> latest

• format - Format flag. type: str choices: none, text, html, wml more...

  	Supported Version Ranges
  format	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [text]	v6.0.0 -> latest
  [html]	v6.0.0 -> latest
  [wml]	v6.0.0 -> v6.2.7

• header - Header flag. type: str choices: none, http, 8bit more...

  	Supported Version Ranges
  header	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [http]	v6.0.0 -> latest
  [8bit]	v6.0.0 -> latest

• msg_type - Message type. type: str required: true more...

  	Supported Version Ranges
  msg_type	v6.0.0 -> latest

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure replacement message groups.
  fortinet.fortios.fortios_system_replacemsg_group:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_group:
          admin:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          alertmail:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          auth:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          automation:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          comment: "Comment."
          custom_message:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          device_detection_portal:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          ec:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          fortiguard_wf:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          ftp:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          group_type: "default"
          http:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          icap:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          mail:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          mm1:
              -
                  add_smil: "enable"
                  charset: "utf-8"
                  class: "not-included"
                  format: "none"
                  fos_message: "<your_own_value>"
                  from: "<your_own_value>"
                  from_sender: "enable"
                  header: "none"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
                  priority: "not-included"
                  rsp_status: "ok"
                  rsp_text: "<your_own_value>"
                  sender_visibility: "not-specified"
                  smil_part: "<your_own_value>"
                  subject: "<your_own_value>"
          mm3:
              -
                  add_html: "enable"
                  charset: "utf-8"
                  format: "none"
                  fos_message: "<your_own_value>"
                  from: "<your_own_value>"
                  from_sender: "enable"
                  header: "none"
                  html_part: "<your_own_value>"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
                  priority: "not-included"
                  subject: "<your_own_value>"
          mm4:
              -
                  add_smil: "enable"
                  charset: "utf-8"
                  class: "not-included"
                  domain: "<your_own_value>"
                  format: "none"
                  fos_message: "<your_own_value>"
                  from: "<your_own_value>"
                  from_sender: "enable"
                  header: "none"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
                  priority: "not-included"
                  rsp_status: "ok"
                  smil_part: "<your_own_value>"
                  subject: "<your_own_value>"
          mm7:
              -
                  add_smil: "enable"
                  addr_type: "rfc2822-addr"
                  allow_content_adaptation: "enable"
                  charset: "utf-8"
                  class: "not-included"
                  format: "none"
                  fos_message: "<your_own_value>"
                  from: "<your_own_value>"
                  from_sender: "enable"
                  header: "none"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
                  priority: "not-included"
                  rsp_status: "success"
                  smil_part: "<your_own_value>"
                  subject: "<your_own_value>"
          mms:
              -
                  buffer: "<your_own_value>"
                  charset: "utf-8"
                  format: "none"
                  header: "none"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
          nac_quar:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          name: "default_name_140"
          nntp:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          spam:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          sslvpn:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          traffic_quota:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          utm:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          webproxy:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

• build - Build number of the fortigate image returned: always type: str sample: 1547
• http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
• http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
• mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
• name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
• path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
• revision - Internal revision number returned: always type: str sample: 17.0.2.10658
• serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
• status - Indication of the operation's result returned: always type: str sample: success
• vdom - Virtual domain used returned: always type: str sample: root
• version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.