fortinet.fortimanager.fmgr_system_replacemsggroup – Configure replacement message groups.
fortinet.fortimanager.fmgr_system_replacemsggroup – Configure replacement message groups.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_replacemsggroup
.
New in version 2.10: of fortinet.fortimanager
Synopsis
- This module is able to configure a FortiManager device.
- Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
adom string / required |
the parameter (adom) in requested url | |||
bypass_validation boolean |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
rc_failed list / elements=string |
the rc codes list with which the conditions to fail will be overriden | |||
rc_succeeded list / elements=string |
the rc codes list with which the conditions to succeed will be overriden | |||
state string / required |
|
the directive to create, update or delete an object | ||
system_replacemsggroup dictionary |
the top level parameters set | |||
admin list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
alertmail list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
auth list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
comment string |
Comment. | |||
custom-message list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
device-detection-portal list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
ec list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
fortiguard-wf list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
ftp list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
group-type string |
|
Group type. | ||
http list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
icap list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
mm1 list / elements=string |
no description | |||
add-smil string |
|
add message encapsulation | ||
charset string |
|
character encoding used for replacement message | ||
class string |
|
message class | ||
format string |
|
Format flag. | ||
from string |
from address | |||
from-sender string |
|
notification message sent from recipient | ||
header string |
|
Header flag. | ||
image string |
Message string. | |||
message string |
message text | |||
msg-type string |
Message type. | |||
priority string |
|
message priority | ||
rsp-status string |
|
response status code | ||
rsp-text string |
response text | |||
sender-visibility string |
|
sender visibility | ||
smil-part string |
message encapsulation text | |||
subject string |
subject text string | |||
mm3 list / elements=string |
no description | |||
add-html string |
|
add message encapsulation | ||
charset string |
|
character encoding used for replacement message | ||
format string |
|
Format flag. | ||
from string |
from address | |||
from-sender string |
|
notification message sent from recipient | ||
header string |
|
Header flag. | ||
html-part string |
message encapsulation text | |||
image string |
Message string. | |||
message string |
message text | |||
msg-type string |
Message type. | |||
priority string |
|
message priority | ||
subject string |
subject text string | |||
mm4 list / elements=string |
no description | |||
add-smil string |
|
add message encapsulation | ||
charset string |
|
character encoding used for replacement message | ||
class string |
|
message class | ||
domain string |
from address domain | |||
format string |
|
Format flag. | ||
from string |
from address | |||
from-sender string |
|
notification message sent from recipient | ||
header string |
|
Header flag. | ||
image string |
Message string. | |||
message string |
message text | |||
msg-type string |
Message type. | |||
priority string |
|
message priority | ||
rsp-status string |
|
response status | ||
smil-part string |
message encapsulation text | |||
subject string |
subject text string | |||
mm7 list / elements=string |
no description | |||
add-smil string |
|
add message encapsulation | ||
addr-type string |
|
from address type | ||
allow-content-adaptation string |
|
allow content adaptations | ||
charset string |
|
character encoding used for replacement message | ||
class string |
|
message class | ||
format string |
|
Format flag. | ||
from string |
from address | |||
from-sender string |
|
notification message sent from recipient | ||
header string |
|
Header flag. | ||
image string |
Message string. | |||
message string |
message text | |||
msg-type string |
Message type. | |||
priority string |
|
message priority | ||
rsp-status string |
|
response status | ||
smil-part string |
message encapsulation text | |||
subject string |
subject text string | |||
mms list / elements=string |
no description | |||
buffer string |
Message string. | |||
charset string |
|
character encoding used for replacement message | ||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
image string |
Message string. | |||
msg-type string |
Message type. | |||
nac-quar list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
name string |
Group name. | |||
nntp list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
spam list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
sslvpn list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
traffic-quota list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
utm list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
webproxy list / elements=string |
no description | |||
buffer string |
Message string. | |||
format string |
|
Format flag. | ||
header string |
|
Header flag. | ||
msg-type string |
Message type. | |||
workspace_locking_adom string |
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | |||
workspace_locking_timeout integer |
Default: 300 |
the maximum time in seconds to wait for other user to release the workspace lock |
Notes
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state present directive.
- To delete an object, use state absent directive.
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure replacement message groups.
fmgr_system_replacemsggroup:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
system_replacemsggroup:
admin:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
alertmail:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
auth:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
comment: <value of string>
custom-message:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
device-detection-portal:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
ec:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
fortiguard-wf:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
ftp:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
group-type: <value in [default, utm, auth, ...]>
http:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
icap:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
mail:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
mm1:
-
add-smil: <value in [disable, enable]>
charset: <value in [us-ascii, utf-8]>
class: <value in [personal, advertisement, information, ...]>
format: <value in [none, text, html, ...]>
from: <value of string>
from-sender: <value in [disable, enable]>
header: <value in [none, http, 8bit]>
image: <value of string>
message: <value of string>
msg-type: <value of string>
priority: <value in [low, normal, high, ...]>
rsp-status: <value in [ok, err-unspecified, err-srv-denied, ...]>
rsp-text: <value of string>
sender-visibility: <value in [hide, show, not-specified]>
smil-part: <value of string>
subject: <value of string>
mm3:
-
add-html: <value in [disable, enable]>
charset: <value in [us-ascii, utf-8]>
format: <value in [none, text, html, ...]>
from: <value of string>
from-sender: <value in [disable, enable]>
header: <value in [none, http, 8bit]>
html-part: <value of string>
image: <value of string>
message: <value of string>
msg-type: <value of string>
priority: <value in [low, normal, high, ...]>
subject: <value of string>
mm4:
-
add-smil: <value in [disable, enable]>
charset: <value in [us-ascii, utf-8]>
class: <value in [personal, advertisement, informational, ...]>
domain: <value of string>
format: <value in [none, text, html, ...]>
from: <value of string>
from-sender: <value in [disable, enable]>
header: <value in [none, http, 8bit]>
image: <value of string>
message: <value of string>
msg-type: <value of string>
priority: <value in [low, normal, high, ...]>
rsp-status: <value in [ok, err-unspecified, err-srv-denied, ...]>
smil-part: <value of string>
subject: <value of string>
mm7:
-
add-smil: <value in [disable, enable]>
addr-type: <value in [rfc2822-addr, number, short-code]>
allow-content-adaptation: <value in [disable, enable]>
charset: <value in [us-ascii, utf-8]>
class: <value in [personal, advertisement, informational, ...]>
format: <value in [none, text, html, ...]>
from: <value of string>
from-sender: <value in [disable, enable]>
header: <value in [none, http, 8bit]>
image: <value of string>
message: <value of string>
msg-type: <value of string>
priority: <value in [low, normal, high, ...]>
rsp-status: <value in [success, partial-success, client-err, ...]>
smil-part: <value of string>
subject: <value of string>
mms:
-
buffer: <value of string>
charset: <value in [us-ascii, utf-8]>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
image: <value of string>
msg-type: <value of string>
nac-quar:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
name: <value of string>
nntp:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
spam:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
sslvpn:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
traffic-quota:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
utm:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
webproxy:
-
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
request_url string |
always |
The full url requested
Sample: /sys/login/user |
response_code integer |
always |
The status of api request
|
response_message string |
always |
The descriptive message of the api response
Sample: OK. |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_replacemsggroup_module.html