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 1.1.8).

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.9: 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.
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.
	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.
	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>"
        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>"
        nac_quar:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        name: "default_name_65"
        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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_replacemsg_group_module.html