fortinet.fortios.fortios_system_replacemsg_group module – Configure replacement message groups in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_replacemsg_group
.
New in fortinet.fortios 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
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure replacement message groups. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Comment. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Group type. Choices:
|
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
add message encapsulation Choices:
|
|
character encoding used for replacement message Choices:
|
|
message class Choices:
|
|
Format flag. Choices:
|
|
message text |
|
from address |
|
notification message sent from recipient Choices:
|
|
Header flag. Choices:
|
|
Message string. Source system.replacemsg-image.name. |
|
Message type. |
|
message priority Choices:
|
|
response status code Choices:
|
|
response text |
|
sender visibility Choices:
|
|
message encapsulation text |
|
subject text string |
|
Replacement message table entries. |
|
add message encapsulation Choices:
|
|
character encoding used for replacement message Choices:
|
|
Format flag. Choices:
|
|
message text |
|
from address |
|
notification message sent from recipient Choices:
|
|
Header flag. Choices:
|
|
message encapsulation text |
|
Message string. Source system.replacemsg-image.name. |
|
Message type. |
|
message priority Choices:
|
|
subject text string |
|
Replacement message table entries. |
|
add message encapsulation Choices:
|
|
character encoding used for replacement message Choices:
|
|
message class Choices:
|
|
from address domain |
|
Format flag. Choices:
|
|
message text |
|
from address |
|
notification message sent from recipient Choices:
|
|
Header flag. Choices:
|
|
Message string. Source system.replacemsg-image.name. |
|
Message type. |
|
message priority Choices:
|
|
response status Choices:
|
|
message encapsulation text |
|
subject text string |
|
Replacement message table entries. |
|
add message encapsulation Choices:
|
|
from address type Choices:
|
|
allow content adaptations Choices:
|
|
character encoding used for replacement message Choices:
|
|
message class Choices:
|
|
Format flag. Choices:
|
|
message text |
|
from address |
|
notification message sent from recipient Choices:
|
|
Header flag. Choices:
|
|
Message string. Source system.replacemsg-image.name. |
|
Message type. |
|
message priority Choices:
|
|
response status Choices:
|
|
message encapsulation text |
|
subject text string |
|
Replacement message table entries. |
|
Message string. |
|
character encoding used for replacement message Choices:
|
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message string. Source system.replacemsg-image.name. |
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Group name. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
Replacement message table entries. |
|
Message string. |
|
Format flag. Choices:
|
|
Header flag. Choices:
|
|
Message type. |
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
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 here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |