fmgd_system_replacemsggroup – Configure replacement message groups.
Added in version 1.1.0.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- system_replacemsggroup - Configure replacement message groups. type: dict
- admin Admin. type: list more...
- alertmail Alertmail. type: list more...
- auth Auth. type: list more...
- automation Automation. type: list more...
- comment Comment. type: str more...
- custom_message (Alias name: custom-message) Custom message. type: list more...
- fortiguard_wf (Alias name: fortiguard-wf) Fortiguard wf. type: list more...
- ftp Ftp. type: list more...
- group_type (Alias name: group-type) Group type. type: str choices: [default, utm, auth, ec] more...
- http Http. type: list more...
- icap Icap. type: list more...
- mail Mail. type: list more...
- nac_quar (Alias name: nac-quar) Nac quar. type: list more...
- name Group name. type: str more...
- spam Spam. type: list more...
- traffic_quota (Alias name: traffic-quota) Traffic quota. type: list more...
- utm Utm. type: list more...
- webproxy Webproxy. type: list more...
- sslvpn Sslvpn. type: list more...
- device_detection_portal (Alias name: device-detection-portal) Device detection portal. type: list more...
- nntp Nntp. type: list more...
- mms Mms. type: list
more...
- buffer Message string. type: str more...
- charset Character encoding used for replacement message type: str choices: [us-ascii, utf-8] more...
- format Format flag. type: str choices: [none, text, html, wml] more...
- header Header flag. type: str choices: [none, http, 8bit] more...
- image Message string. type: list more...
- msg_type (Alias name: msg-type) Message type. type: str more...
- mm1 Mm1. type: list
more...
- add_smil (Alias name: add-smil) Add message encapsulation type: str choices: [disable, enable] more...
- charset Character encoding used for replacement message type: str choices: [us-ascii, utf-8] more...
- class Message class type: str choices: [personal, advertisement, information, automatic, not-included] more...
- format Format flag. type: str choices: [none, text, html, wml] more...
- from From address type: str more...
- from_sender (Alias name: from-sender) Notification message sent from recipient type: str choices: [disable, enable] more...
- header Header flag. type: str choices: [none, http, 8bit] more...
- image Message string. type: list more...
- fmgr_message Message text type: str more...
- msg_type (Alias name: msg-type) Message type. type: str more...
- priority Message priority type: str choices: [low, normal, high, not-included] more...
- rsp_status (Alias name: rsp-status) Response status code type: str 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] more...
- rsp_text (Alias name: rsp-text) Response text type: str more...
- sender_visibility (Alias name: sender-visibility) Sender visibility type: str choices: [hide, show, not-specified] more...
- smil_part (Alias name: smil-part) Message encapsulation text type: str more...
- subject Subject text string type: str more...
- mm7 Mm7. type: list
more...
- add_smil (Alias name: add-smil) Add message encapsulation type: str choices: [disable, enable] more...
- addr_type (Alias name: addr-type) From address type type: str choices: [rfc2822-addr, number, short-code] more...
- allow_content_adaptation (Alias name: allow-content-adaptation) Allow content adaptations type: str choices: [disable, enable] more...
- charset Character encoding used for replacement message type: str choices: [us-ascii, utf-8] more...
- class Message class type: str choices: [personal, advertisement, informational, auto, not-included] more...
- format Format flag. type: str choices: [none, text, html, wml] more...
- from From address type: str more...
- from_sender (Alias name: from-sender) Notification message sent from recipient type: str choices: [disable, enable] more...
- header Header flag. type: str choices: [none, http, 8bit] more...
- image Message string. type: list more...
- fmgr_message Message text type: str more...
- msg_type (Alias name: msg-type) Message type. type: str more...
- priority Message priority type: str choices: [low, normal, high, not-included] more...
- rsp_status (Alias name: rsp-status) Response status type: str 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] more...
- smil_part (Alias name: smil-part) Message encapsulation text type: str more...
- subject Subject text string type: str more...
- mm4 Mm4. type: list
more...
- add_smil (Alias name: add-smil) Add message encapsulation type: str choices: [disable, enable] more...
- charset Character encoding used for replacement message type: str choices: [us-ascii, utf-8] more...
- class Message class type: str choices: [personal, advertisement, informational, auto, not-included] more...
- domain From address domain type: str more...
- format Format flag. type: str choices: [none, text, html, wml] more...
- from From address type: str more...
- from_sender (Alias name: from-sender) Notification message sent from recipient type: str choices: [disable, enable] more...
- header Header flag. type: str choices: [none, http, 8bit] more...
- image Message string. type: list more...
- fmgr_message Message text type: str more...
- msg_type (Alias name: msg-type) Message type. type: str more...
- priority Message priority type: str choices: [low, normal, high, not-included] more...
- rsp_status (Alias name: rsp-status) Response status type: str 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] more...
- smil_part (Alias name: smil-part) Message encapsulation text type: str more...
- subject Subject text string type: str more...
- mm3 Mm3. type: list
more...
- add_html (Alias name: add-html) Add message encapsulation type: str choices: [disable, enable] more...
- charset Character encoding used for replacement message type: str choices: [us-ascii, utf-8] more...
- format Format flag. type: str choices: [none, text, html, wml] more...
- from From address type: str more...
- from_sender (Alias name: from-sender) Notification message sent from recipient type: str choices: [disable, enable] more...
- header Header flag. type: str choices: [none, http, 8bit] more...
- html_part (Alias name: html-part) Message encapsulation text type: str more...
- image Message string. type: list more...
- fmgr_message Message text type: str more...
- msg_type (Alias name: msg-type) Message type. type: str more...
- priority Message priority type: str choices: [low, normal, high, not-included] more...
- subject Subject text string type: str more...
- ec Ec. type: list more...
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure replacement message groups.
fortinet.fmgdevice.fmgd_system_replacemsggroup:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
state: present # <value in [present, absent]>
system_replacemsggroup:
name: "your value" # Required variable, string
# admin:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# alertmail:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# id: <integer>
# auth:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# automation:
# - buffer: <string>
# format: <value in [none, text, html]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# comment: <string>
# custom_message:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# fortiguard_wf:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# ftp:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# group_type: <value in [default, utm, auth, ...]>
# http:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# icap:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# mail:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# nac_quar:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# id: <integer>
# spam:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# traffic_quota:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# utm:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# webproxy:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# sslvpn:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# device_detection_portal:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# nntp:
# - buffer: <string>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
# mms:
# - buffer: <string>
# charset: <value in [us-ascii, utf-8]>
# format: <value in [none, text, html, ...]>
# header: <value in [none, http, 8bit]>
# image: <list or string>
# msg_type: <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: <string>
# from_sender: <value in [disable, enable]>
# header: <value in [none, http, 8bit]>
# image: <list or string>
# fmgr_message: <string>
# msg_type: <string>
# priority: <value in [low, normal, high, ...]>
# rsp_status: <value in [ok, err-unspecified, err-srv-denied, ...]>
# rsp_text: <string>
# sender_visibility: <value in [hide, show, not-specified]>
# smil_part: <string>
# subject: <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: <string>
# from_sender: <value in [disable, enable]>
# header: <value in [none, http, 8bit]>
# image: <list or string>
# fmgr_message: <string>
# msg_type: <string>
# priority: <value in [low, normal, high, ...]>
# rsp_status: <value in [success, partial-success, client-err, ...]>
# smil_part: <string>
# subject: <string>
# mm4:
# - add_smil: <value in [disable, enable]>
# charset: <value in [us-ascii, utf-8]>
# class: <value in [personal, advertisement, informational, ...]>
# domain: <string>
# format: <value in [none, text, html, ...]>
# from: <string>
# from_sender: <value in [disable, enable]>
# header: <value in [none, http, 8bit]>
# image: <list or string>
# fmgr_message: <string>
# msg_type: <string>
# priority: <value in [low, normal, high, ...]>
# rsp_status: <value in [ok, err-unspecified, err-srv-denied, ...]>
# smil_part: <string>
# subject: <string>
# mm3:
# - add_html: <value in [disable, enable]>
# charset: <value in [us-ascii, utf-8]>
# format: <value in [none, text, html, ...]>
# from: <string>
# from_sender: <value in [disable, enable]>
# header: <value in [none, http, 8bit]>
# html_part: <string>
# image: <list or string>
# fmgr_message: <string>
# msg_type: <string>
# priority: <value in [low, normal, high, ...]>
# subject: <string>
# ec:
# - buffer: <string>
# format: <value in [none, text, html]>
# header: <value in [none, http, 8bit]>
# msg_type: <string>
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.