Try SpotterConfigure replacement message groups.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure replacement message groups.
fortinet.fortimanager.fmgr_system_replacemsggroup:
bypass_validation: false
adom: ansible
state: present
system_replacemsggroup:
comment: ansible-comment
name: ansible-test
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the replacement message groups
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_replacemsggroup"
params:
adom: "ansible"
replacemsg-group: "your_value"
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
system_replacemsggroup:
description: The top level parameters set.
required: false
suboptions:
admin:
description: Admin.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
alertmail:
description: Alertmail.
elements: dict
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
id:
description: No description.
type: int
msg-type:
description: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
auth:
description: Auth.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
automation:
description: Automation.
elements: dict
suboptions:
buffer:
description: Message string.
type: str
format:
choices:
- none
- text
- html
description: Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description: Header flag.
type: str
msg-type:
description: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
comment:
description: Comment.
type: str
custom-message:
description: Deprecated, please rename it to custom_message. Custom-Message.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
device-detection-portal:
description: Deprecated, please rename it to device_detection_portal. Device-Detection-Portal.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
ec:
description: No description.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
fortiguard-wf:
description: Deprecated, please rename it to fortiguard_wf. Fortiguard-Wf.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
ftp:
description: Ftp.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
group-type:
choices:
- default
- utm
- auth
- ec
- captive-portal
description: Deprecated, please rename it to group_type. Group type.
type: str
http:
description: Http.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
icap:
description: Icap.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
mail:
description: Mail.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
mm1:
description: Mm1.
elements: dict
suboptions:
add-smil:
choices:
- disable
- enable
description: Deprecated, please rename it to add_smil. Add message encapsulation
type: str
charset:
choices:
- us-ascii
- utf-8
description: Character encoding used for replacement message
type: str
class:
choices:
- personal
- advertisement
- information
- automatic
- not-included
description: Message class
type: str
format:
choices:
- none
- text
- html
- wml
description: Format flag.
type: str
from:
description: From address
type: str
from-sender:
choices:
- disable
- enable
description: Deprecated, please rename it to from_sender. Notification message
sent from recipient
type: str
header:
choices:
- none
- http
- 8bit
description: Header flag.
type: str
image:
description: Message string.
type: str
message:
description: Deprecated, please rename it to fmgr_message. Message text
type: str
msg-type:
description: Deprecated, please rename it to msg_type. Message type.
type: str
priority:
choices:
- low
- normal
- high
- not-included
description: Message priority
type: str
rsp-status:
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
description: Deprecated, please rename it to rsp_status. Response status code
type: str
rsp-text:
description: Deprecated, please rename it to rsp_text. Response text
type: str
sender-visibility:
choices:
- hide
- show
- not-specified
description: Deprecated, please rename it to sender_visibility. Sender visibility
type: str
smil-part:
description: Deprecated, please rename it to smil_part. Message encapsulation
text
type: str
subject:
description: Subject text string
type: str
type: list
mm3:
description: Mm3.
elements: dict
suboptions:
add-html:
choices:
- disable
- enable
description: Deprecated, please rename it to add_html. Add message encapsulation
type: str
charset:
choices:
- us-ascii
- utf-8
description: Character encoding used for replacement message
type: str
format:
choices:
- none
- text
- html
- wml
description: Format flag.
type: str
from:
description: From address
type: str
from-sender:
choices:
- disable
- enable
description: Deprecated, please rename it to from_sender. Notification message
sent from recipient
type: str
header:
choices:
- none
- http
- 8bit
description: Header flag.
type: str
html-part:
description: Deprecated, please rename it to html_part. Message encapsulation
text
type: str
image:
description: Message string.
type: str
message:
description: Deprecated, please rename it to fmgr_message. Message text
type: str
msg-type:
description: Deprecated, please rename it to msg_type. Message type.
type: str
priority:
choices:
- low
- normal
- high
- not-included
description: Message priority
type: str
subject:
description: Subject text string
type: str
type: list
mm4:
description: Mm4.
elements: dict
suboptions:
add-smil:
choices:
- disable
- enable
description: Deprecated, please rename it to add_smil. Add message encapsulation
type: str
charset:
choices:
- us-ascii
- utf-8
description: Character encoding used for replacement message
type: str
class:
choices:
- personal
- advertisement
- informational
- auto
- not-included
description: Message class
type: str
domain:
description: From address domain
type: str
format:
choices:
- none
- text
- html
- wml
description: Format flag.
type: str
from:
description: From address
type: str
from-sender:
choices:
- disable
- enable
description: Deprecated, please rename it to from_sender. Notification message
sent from recipient
type: str
header:
choices:
- none
- http
- 8bit
description: Header flag.
type: str
image:
description: Message string.
type: str
message:
description: Deprecated, please rename it to fmgr_message. Message text
type: str
msg-type:
description: Deprecated, please rename it to msg_type. Message type.
type: str
priority:
choices:
- low
- normal
- high
- not-included
description: Message priority
type: str
rsp-status:
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
description: Deprecated, please rename it to rsp_status. Response status
type: str
smil-part:
description: Deprecated, please rename it to smil_part. Message encapsulation
text
type: str
subject:
description: Subject text string
type: str
type: list
mm7:
description: Mm7.
elements: dict
suboptions:
add-smil:
choices:
- disable
- enable
description: Deprecated, please rename it to add_smil. Add message encapsulation
type: str
addr-type:
choices:
- rfc2822-addr
- number
- short-code
description: Deprecated, please rename it to addr_type. From address type
type: str
allow-content-adaptation:
choices:
- disable
- enable
description: Deprecated, please rename it to allow_content_adaptation. Allow
content adaptations
type: str
charset:
choices:
- us-ascii
- utf-8
description: Character encoding used for replacement message
type: str
class:
choices:
- personal
- advertisement
- informational
- auto
- not-included
description: Message class
type: str
format:
choices:
- none
- text
- html
- wml
description: Format flag.
type: str
from:
description: From address
type: str
from-sender:
choices:
- disable
- enable
description: Deprecated, please rename it to from_sender. Notification message
sent from recipient
type: str
header:
choices:
- none
- http
- 8bit
description: Header flag.
type: str
image:
description: Message string.
type: str
message:
description: Deprecated, please rename it to fmgr_message. Message text
type: str
msg-type:
description: Deprecated, please rename it to msg_type. Message type.
type: str
priority:
choices:
- low
- normal
- high
- not-included
description: Message priority
type: str
rsp-status:
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
description: Deprecated, please rename it to rsp_status. Response status
type: str
smil-part:
description: Deprecated, please rename it to smil_part. Message encapsulation
text
type: str
subject:
description: Subject text string
type: str
type: list
mms:
description: Mms.
elements: dict
suboptions:
buffer:
description: Message string.
type: str
charset:
choices:
- us-ascii
- utf-8
description: Character encoding used for replacement message
type: str
format:
choices:
- none
- text
- html
- wml
description: Format flag.
type: str
header:
choices:
- none
- http
- 8bit
description: Header flag.
type: str
image:
description: Message string.
type: str
msg-type:
description: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
nac-quar:
description: Deprecated, please rename it to nac_quar. Nac-Quar.
elements: dict
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
id:
description: No description.
type: int
msg-type:
description: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
name:
description: Group name.
required: true
type: str
nntp:
description: Nntp.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
spam:
description: Spam.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
sslvpn:
description: Sslvpn.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
traffic-quota:
description: Deprecated, please rename it to traffic_quota. Traffic-Quota.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
utm:
description: Utm.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
webproxy:
description: Webproxy.
elements: dict
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: Deprecated, please rename it to msg_type. Message type.
type: str
type: list
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list