fortinet.fortios.fortios_system_replacemsg_group – Configure replacement message groups in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_system_replacemsg_group.

New in version 2.10: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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.9.0

Parameters

Parameter			Choices/Defaults	Comments
access_token string				Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean			Choices: no ← yes	Enable/Disable logging for task.
state string / required			Choices: present absent	Indicates whether to create or remove the object.
system_replacemsg_group dictionary				Configure replacement message groups.
	admin list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	alertmail list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	auth list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	automation list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	comment string			Comment.
	custom_message list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	device_detection_portal list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	ec list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	fortiguard_wf list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	ftp list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	group_type string		Choices: default utm auth ec	Group type.
	http list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	icap list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	mail list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	mm1 list / elements=string			Replacement message table entries.
		add_smil string	Choices: enable disable	add message encapsulation
		charset string	Choices: utf-8 us-ascii	character encoding used for replacement message
		class string	Choices: not-included personal advertisement information automatic	message class
		format string	Choices: none text html wml	Format flag.
		from string		from address
		from_sender string	Choices: enable disable	notification message sent from recipient
		header string	Choices: none http 8bit	Header flag.
		image string		Message string. Source system.replacemsg-image.name.
		message string		message text
		msg_type string		Message type.
		priority string	Choices: not-included low normal high	message priority
		rsp_status string	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	response status code
		rsp_text string		response text
		sender_visibility string	Choices: not-specified show hide	sender visibility
		smil_part string		message encapsulation text
		subject string		subject text string
	mm3 list / elements=string			Replacement message table entries.
		add_html string	Choices: enable disable	add message encapsulation
		charset string	Choices: utf-8 us-ascii	character encoding used for replacement message
		format string	Choices: none text html wml	Format flag.
		from string		from address
		from_sender string	Choices: enable disable	notification message sent from recipient
		header string	Choices: none http 8bit	Header flag.
		html_part string		message encapsulation text
		image string		Message string. Source system.replacemsg-image.name.
		message string		message text
		msg_type string		Message type.
		priority string	Choices: not-included low normal high	message priority
		subject string		subject text string
	mm4 list / elements=string			Replacement message table entries.
		add_smil string	Choices: enable disable	add message encapsulation
		charset string	Choices: utf-8 us-ascii	character encoding used for replacement message
		class string	Choices: not-included personal informational advertisement auto	message class
		domain string		from address domain
		format string	Choices: none text html wml	Format flag.
		from string		from address
		from_sender string	Choices: enable disable	notification message sent from recipient
		header string	Choices: none http 8bit	Header flag.
		image string		Message string. Source system.replacemsg-image.name.
		message string		message text
		msg_type string		Message type.
		priority string	Choices: not-included low normal high	message priority
		rsp_status string	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	response status
		smil_part string		message encapsulation text
		subject string		subject text string
	mm7 list / elements=string			Replacement message table entries.
		add_smil string	Choices: enable disable	add message encapsulation
		addr_type string	Choices: rfc2822-addr number short-code	from address type
		allow_content_adaptation string	Choices: enable disable	allow content adaptations
		charset string	Choices: utf-8 us-ascii	character encoding used for replacement message
		class string	Choices: not-included personal informational advertisement auto	message class
		format string	Choices: none text html wml	Format flag.
		from string		from address
		from_sender string	Choices: enable disable	notification message sent from recipient
		header string	Choices: none http 8bit	Header flag.
		image string		Message string. Source system.replacemsg-image.name.
		message string		message text
		msg_type string		Message type.
		priority string	Choices: not-included low normal high	message priority
		rsp_status string	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	response status
		smil_part string		message encapsulation text
		subject string		subject text string
	mms list / elements=string			Replacement message table entries.
		buffer string		Message string.
		charset string	Choices: utf-8 us-ascii	character encoding used for replacement message
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		image string		Message string. Source system.replacemsg-image.name.
		msg_type string		Message type.
	nac_quar list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	name string / required			Group name.
	nntp list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	spam list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	sslvpn list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	traffic_quota list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	utm list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
	webproxy list / elements=string			Replacement message table entries.
		buffer string		Message string.
		format string	Choices: none text html wml	Format flag.
		header string	Choices: none http 8bit	Header flag.
		msg_type string		Message type.
vdom string			Default: "root"	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.

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure replacement message groups.
    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"
            from: "<your_own_value>"
            from_sender: "enable"
            header: "none"
            image: "<your_own_value> (source system.replacemsg-image.name)"
            message: "<your_own_value>"
            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"
            from: "<your_own_value>"
            from_sender: "enable"
            header: "none"
            html_part: "<your_own_value>"
            image: "<your_own_value> (source system.replacemsg-image.name)"
            message: "<your_own_value>"
            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"
            from: "<your_own_value>"
            from_sender: "enable"
            header: "none"
            image: "<your_own_value> (source system.replacemsg-image.name)"
            message: "<your_own_value>"
            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"
            from: "<your_own_value>"
            from_sender: "enable"
            header: "none"
            image: "<your_own_value> (source system.replacemsg-image.name)"
            message: "<your_own_value>"
            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 here, the following are the fields unique to this module:

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

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_replacemsg_group_module.html