fortios_system_replacemsg_group – Configure replacement message groups in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_system_replacemsg_group | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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...
- admin - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- alertmail - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- auth - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- automation - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- comment - Comment. type: str more...
- custom_message - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- device_detection_portal - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- ec - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- fortiguard_wf - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- ftp - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- group_type - Group type. type: str choices: default, utm, auth, ec more...
- http - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- icap - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- mail - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- mm1 - Replacement message table entries. type: list more...
- add_smil - add message encapsulation type: str choices: enable, disable more...
- charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...
- class - message class type: str choices: not-included, personal, advertisement, information, automatic more...
- format - Format flag. type: str choices: none, text, html, wml more...
- fos_message - message text type: str more...
- from - from address type: str more...
- from_sender - notification message sent from recipient type: str choices: enable, disable more...
- header - Header flag. type: str choices: none, http, 8bit more...
- image - Message string. Source system.replacemsg-image.name. type: str more...
- msg_type - Message type. type: str more...
- priority - message priority type: str choices: not-included, low, normal, high more...
- 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...
- rsp_text - response text type: str more...
- sender_visibility - sender visibility type: str choices: not-specified, show, hide more...
- smil_part - message encapsulation text type: str more...
- subject - subject text string type: str more...
- mm3 - Replacement message table entries. type: list more...
- add_html - add message encapsulation type: str choices: enable, disable more...
- charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...
- format - Format flag. type: str choices: none, text, html, wml more...
- fos_message - message text type: str more...
- from - from address type: str more...
- from_sender - notification message sent from recipient type: str choices: enable, disable more...
- header - Header flag. type: str choices: none, http, 8bit more...
- html_part - message encapsulation text type: str more...
- image - Message string. Source system.replacemsg-image.name. type: str more...
- msg_type - Message type. type: str more...
- priority - message priority type: str choices: not-included, low, normal, high more...
- subject - subject text string type: str more...
- mm4 - Replacement message table entries. type: list more...
- add_smil - add message encapsulation type: str choices: enable, disable more...
- charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...
- class - message class type: str choices: not-included, personal, informational, advertisement, auto more...
- domain - from address domain type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- fos_message - message text type: str more...
- from - from address type: str more...
- from_sender - notification message sent from recipient type: str choices: enable, disable more...
- header - Header flag. type: str choices: none, http, 8bit more...
- image - Message string. Source system.replacemsg-image.name. type: str more...
- msg_type - Message type. type: str more...
- priority - message priority type: str choices: not-included, low, normal, high more...
- 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...
- smil_part - message encapsulation text type: str more...
- subject - subject text string type: str more...
- mm7 - Replacement message table entries. type: list more...
- add_smil - add message encapsulation type: str choices: enable, disable more...
- addr_type - from address type type: str choices: rfc2822-addr, number, short-code more...
- allow_content_adaptation - allow content adaptations type: str choices: enable, disable more...
- charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...
- class - message class type: str choices: not-included, personal, informational, advertisement, auto more...
- format - Format flag. type: str choices: none, text, html, wml more...
- fos_message - message text type: str more...
- from - from address type: str more...
- from_sender - notification message sent from recipient type: str choices: enable, disable more...
- header - Header flag. type: str choices: none, http, 8bit more...
- image - Message string. Source system.replacemsg-image.name. type: str more...
- msg_type - Message type. type: str more...
- priority - message priority type: str choices: not-included, low, normal, high more...
- 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...
- smil_part - message encapsulation text type: str more...
- subject - subject text string type: str more...
- mms - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- charset - character encoding used for replacement message type: str choices: utf-8, us-ascii more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- image - Message string. Source system.replacemsg-image.name. type: str more...
- msg_type - Message type. type: str more...
- nac_quar - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- name - Group name. type: str required: true more...
- nntp - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- spam - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- sslvpn - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- traffic_quota - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- utm - Replacement message table entries. type: list more...
- buffer - Message string. type: str more...
- format - Format flag. type: str choices: none, text, html, wml more...
- header - Header flag. type: str choices: none, http, 8bit more...
- msg_type - Message type. type: str more...
- webproxy - Replacement message table entries. type: list more...
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"
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