Try SpotterConfigure replacement message groups in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections:
- name: fortinet.fortios
version: 2.3.6This 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
- 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>"
vdom:
default: root
description:
- 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
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
system_replacemsg_group:
default: null
description:
- Configure replacement message groups.
suboptions:
admin:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
alertmail:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
auth:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
automation:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
comment:
description:
- Comment.
type: str
custom_message:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
device_detection_portal:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
ec:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
fortiguard_wf:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
ftp:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
group_type:
choices:
- default
- utm
- auth
- ec
description:
- Group type.
type: str
http:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
icap:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
mail:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
mm1:
description:
- Replacement message table entries.
elements: dict
suboptions:
add_smil:
choices:
- enable
- disable
description:
- add message encapsulation
type: str
charset:
choices:
- utf-8
- us-ascii
description:
- character encoding used for replacement message
type: str
class:
choices:
- not-included
- personal
- advertisement
- information
- automatic
description:
- message class
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
fos_message:
description:
- message text
type: str
from:
description:
- from address
type: str
from_sender:
choices:
- enable
- disable
description:
- notification message sent from recipient
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
image:
description:
- Message string. Source system.replacemsg-image.name.
type: str
msg_type:
description:
- Message type.
required: true
type: str
priority:
choices:
- not-included
- low
- normal
- high
description:
- message priority
type: str
rsp_status:
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
description:
- response status code
type: str
rsp_text:
description:
- response text
type: str
sender_visibility:
choices:
- not-specified
- show
- hide
description:
- sender visibility
type: str
smil_part:
description:
- message encapsulation text
type: str
subject:
description:
- subject text string
type: str
type: list
mm3:
description:
- Replacement message table entries.
elements: dict
suboptions:
add_html:
choices:
- enable
- disable
description:
- add message encapsulation
type: str
charset:
choices:
- utf-8
- us-ascii
description:
- character encoding used for replacement message
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
fos_message:
description:
- message text
type: str
from:
description:
- from address
type: str
from_sender:
choices:
- enable
- disable
description:
- notification message sent from recipient
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
html_part:
description:
- message encapsulation text
type: str
image:
description:
- Message string. Source system.replacemsg-image.name.
type: str
msg_type:
description:
- Message type.
required: true
type: str
priority:
choices:
- not-included
- low
- normal
- high
description:
- message priority
type: str
subject:
description:
- subject text string
type: str
type: list
mm4:
description:
- Replacement message table entries.
elements: dict
suboptions:
add_smil:
choices:
- enable
- disable
description:
- add message encapsulation
type: str
charset:
choices:
- utf-8
- us-ascii
description:
- character encoding used for replacement message
type: str
class:
choices:
- not-included
- personal
- informational
- advertisement
- auto
description:
- message class
type: str
domain:
description:
- from address domain
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
fos_message:
description:
- message text
type: str
from:
description:
- from address
type: str
from_sender:
choices:
- enable
- disable
description:
- notification message sent from recipient
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
image:
description:
- Message string. Source system.replacemsg-image.name.
type: str
msg_type:
description:
- Message type.
required: true
type: str
priority:
choices:
- not-included
- low
- normal
- high
description:
- message priority
type: str
rsp_status:
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
description:
- response status
type: str
smil_part:
description:
- message encapsulation text
type: str
subject:
description:
- subject text string
type: str
type: list
mm7:
description:
- Replacement message table entries.
elements: dict
suboptions:
add_smil:
choices:
- enable
- disable
description:
- add message encapsulation
type: str
addr_type:
choices:
- rfc2822-addr
- number
- short-code
description:
- from address type
type: str
allow_content_adaptation:
choices:
- enable
- disable
description:
- allow content adaptations
type: str
charset:
choices:
- utf-8
- us-ascii
description:
- character encoding used for replacement message
type: str
class:
choices:
- not-included
- personal
- informational
- advertisement
- auto
description:
- message class
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
fos_message:
description:
- message text
type: str
from:
description:
- from address
type: str
from_sender:
choices:
- enable
- disable
description:
- notification message sent from recipient
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
image:
description:
- Message string. Source system.replacemsg-image.name.
type: str
msg_type:
description:
- Message type.
required: true
type: str
priority:
choices:
- not-included
- low
- normal
- high
description:
- message priority
type: str
rsp_status:
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
description:
- response status
type: str
smil_part:
description:
- message encapsulation text
type: str
subject:
description:
- subject text string
type: str
type: list
mms:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
charset:
choices:
- utf-8
- us-ascii
description:
- character encoding used for replacement message
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
image:
description:
- Message string. Source system.replacemsg-image.name.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
nac_quar:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
name:
description:
- Group name.
required: true
type: str
nntp:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
spam:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
sslvpn:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
traffic_quota:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
utm:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
webproxy:
description:
- Replacement message table entries.
elements: dict
suboptions:
buffer:
description:
- Message string.
type: str
format:
choices:
- none
- text
- html
- wml
description:
- Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description:
- Header flag.
type: str
msg_type:
description:
- Message type.
required: true
type: str
type: list
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str