fmgr_system_replacemsggroup – Configure replacement message groups.¶
New in version 2.0.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 v6.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
|||||||||||
| True | |||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
||
| True | True | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
| True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
||||
| True | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
|||||||||
| True | True | True | |||||||||
7.4.0 |
|||||||||||
| True |
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
- adom - The parameter in requested url type: str required: true
- system_replacemsggroup - Configure replacement message groups. type: dict
- admin - Admin. type: array more...
- alertmail - Alertmail. type: array more...
- auth - Auth. type: array more...
- comment - Comment. type: str more...
- custom-message - Custom-Message. type: array more...
- device-detection-portal - Device-Detection-Portal. type: array more...
- ec - No description for the parameter type: array more...
- fortiguard-wf - Fortiguard-Wf. type: array more...
- ftp - Ftp. type: array more...
- group-type - Group type. type: str choices: [default, utm, auth, ec, captive-portal] more...
- http - Http. type: array more...
- icap - Icap. type: array more...
- mail - Mail. type: array more...
- mm1 - Mm1. type: array
more...
- 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 - 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: str more...
- message - message text type: str more...
- msg-type - Message type. type: str more...
- priority - message priority type: str choices: [low, normal, high, not-included] more...
- 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 - response text type: str more...
- sender-visibility - sender visibility type: str choices: [hide, show, not-specified] more...
- smil-part - message encapsulation text type: str more...
- subject - subject text string type: str more...
- mm3 - Mm3. type: array
more...
- 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 - notification message sent from recipient type: str choices: [disable, enable] more...
- header - Header flag. type: str choices: [none, http, 8bit] more...
- html-part - message encapsulation text type: str more...
- image - Message string. type: str more...
- message - message text type: str more...
- 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...
- mm4 - Mm4. type: array
more...
- 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 - 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: str more...
- message - message text type: str more...
- msg-type - Message type. type: str more...
- priority - message priority type: str choices: [low, normal, high, not-included] more...
- 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 - message encapsulation text type: str more...
- subject - subject text string type: str more...
- mm7 - Mm7. type: array
more...
- add-smil - add message encapsulation type: str choices: [disable, enable] more...
- addr-type - from address type type: str choices: [rfc2822-addr, number, short-code] more...
- 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 - 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: str more...
- message - message text type: str more...
- msg-type - Message type. type: str more...
- priority - message priority type: str choices: [low, normal, high, not-included] more...
- 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 - message encapsulation text type: str more...
- subject - subject text string type: str more...
- mms - Mms. type: array
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: str more...
- msg-type - Message type. type: str more...
- nac-quar - Nac-Quar. type: array more...
- name - Group name. type: str more...
- nntp - Nntp. type: array more...
- spam - Spam. type: array more...
- sslvpn - Sslvpn. type: array more...
- traffic-quota - Traffic-Quota. type: array more...
- utm - Utm. type: array more...
- webproxy - Webproxy. type: array more...
- automation - Automation. type: array 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: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the replacement message groups
fmgr_fact:
facts:
selector: 'system_replacemsggroup'
params:
adom: 'ansible'
replacemsg-group: 'your_value'
- hosts: fortimanager00
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
adom: ansible
state: present
system_replacemsggroup:
comment: ansible-comment
name: ansible-test
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 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0