fortios_system_replacemsg_group – Configure replacement message groups in Fortinet’s FortiOS and FortiGate
New in version 2.9.
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.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
host
string
|
FortiOS or FortiGate IP address.
|
|||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol.
|
||
password
string
|
Default:
""
|
FortiOS or FortiGate password.
|
||
ssl_verify
boolean
|
|
Ensures FortiGate certificate must be verified by a proper CA.
|
||
state
string /
required
|
|
Indicates whether to create or remove the object.
|
||
system_replacemsg_group
dictionary
|
Default:
null
|
Configure replacement message groups.
|
||
admin
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
alertmail
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
auth
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
comment
string
|
Comment.
|
|||
custom_message
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
device_detection_portal
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
ec
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
fortiguard_wf
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
ftp
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
group_type
string
|
|
Group type.
|
||
http
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
icap
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
mail
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
nac_quar
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
name
string /
required
|
Group name.
|
|||
nntp
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
spam
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
sslvpn
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
traffic_quota
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
utm
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
webproxy
list
|
Replacement message table entries.
|
|||
buffer
string
|
Message string.
|
|||
format
string
|
|
Format flag.
|
||
header
string
|
|
Header flag.
|
||
msg_type
string
|
Message type.
|
|||
username
string
|
FortiOS or FortiGate username.
|
|||
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
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- 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>"
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
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_system_replacemsg_group_module.html