Try SpotterConfigure replacement message groups in Fortinet's FortiOS and FortiGate.
| "added in version" 2.9 of ansible.builtin"
Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
pipInstall with pip install ansible==2.9.27
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.5
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure replacement message groups.
fortios_system_replacemsg_group:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
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>"
host:
description:
- FortiOS or FortiGate IP address.
required: false
type: str
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
https:
default: true
description:
- Indicates if the requests towards FortiGate must use HTTPS protocol.
type: bool
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
password:
default: ''
description:
- FortiOS or FortiGate password.
type: str
username:
description:
- FortiOS or FortiGate username.
required: false
type: str
ssl_verify:
default: true
description:
- Ensures FortiGate certificate must be verified by a proper CA.
type: bool
system_replacemsg_group:
default: null
description:
- Configure replacement message groups.
suboptions:
admin:
description:
- Replacement message table entries.
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.
type: str
type: list
alertmail:
description:
- Replacement message table entries.
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.
type: str
type: list
auth:
description:
- Replacement message table entries.
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.
type: str
type: list
comment:
description:
- Comment.
type: str
custom_message:
description:
- Replacement message table entries.
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.
type: str
type: list
device_detection_portal:
description:
- Replacement message table entries.
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.
type: str
type: list
ec:
description:
- Replacement message table entries.
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.
type: str
type: list
fortiguard_wf:
description:
- Replacement message table entries.
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.
type: str
type: list
ftp:
description:
- Replacement message table entries.
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.
type: str
type: list
group_type:
choices:
- default
- utm
- auth
- ec
description:
- Group type.
type: str
http:
description:
- Replacement message table entries.
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.
type: str
type: list
icap:
description:
- Replacement message table entries.
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.
type: str
type: list
mail:
description:
- Replacement message table entries.
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.
type: str
type: list
nac_quar:
description:
- Replacement message table entries.
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.
type: str
type: list
name:
description:
- Group name.
required: true
type: str
nntp:
description:
- Replacement message table entries.
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.
type: str
type: list
spam:
description:
- Replacement message table entries.
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.
type: str
type: list
sslvpn:
description:
- Replacement message table entries.
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.
type: str
type: list
traffic_quota:
description:
- Replacement message table entries.
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.
type: str
type: list
utm:
description:
- Replacement message table entries.
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.
type: str
type: list
webproxy:
description:
- Replacement message table entries.
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.
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