fmgr_system_replacemsggroup – Configure replacement message groups.¶

New in version 2.10.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status
Authors

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.0.0.

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

Parameters ¶

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
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
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
adom - The parameter in requested url type: str required: true
system_replacemsggroup - Configure replacement message groups. type: dict

admin - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
alertmail - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
auth - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
comment - Comment. type: str
custom-message - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
device-detection-portal - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
ec - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
fortiguard-wf - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
ftp - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
group-type - Group type. type: str choices: [default, utm, auth, ec, captive-portal]
http - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
icap - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
mail - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
mm1 - No description for the parameter type: array
- add-smil - add message encapsulation type: str choices: [disable, enable]
- charset - character encoding used for replacement message type: str choices: [us-ascii, utf-8]
- class - message class type: str choices: [personal, advertisement, information, automatic, not-included]
- format - Format flag. type: str choices: [none, text, html, wml]
- from - from address type: str
- from-sender - notification message sent from recipient type: str choices: [disable, enable]
- header - Header flag. type: str choices: [none, http, 8bit]
- image - Message string. type: str
- message - message text type: str
- msg-type - Message type. type: str
- priority - message priority type: str choices: [low, normal, high, not-included]
- 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]
- rsp-text - response text type: str
- sender-visibility - sender visibility type: str choices: [hide, show, not-specified]
- smil-part - message encapsulation text type: str
- subject - subject text string type: str
mm3 - No description for the parameter type: array
- add-html - add message encapsulation type: str choices: [disable, enable]
- charset - character encoding used for replacement message type: str choices: [us-ascii, utf-8]
- format - Format flag. type: str choices: [none, text, html, wml]
- from - from address type: str
- from-sender - notification message sent from recipient type: str choices: [disable, enable]
- header - Header flag. type: str choices: [none, http, 8bit]
- html-part - message encapsulation text type: str
- image - Message string. type: str
- message - message text type: str
- msg-type - Message type. type: str
- priority - message priority type: str choices: [low, normal, high, not-included]
- subject - subject text string type: str
mm4 - No description for the parameter type: array
- add-smil - add message encapsulation type: str choices: [disable, enable]
- charset - character encoding used for replacement message type: str choices: [us-ascii, utf-8]
- class - message class type: str choices: [personal, advertisement, informational, auto, not-included]
- domain - from address domain type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- from - from address type: str
- from-sender - notification message sent from recipient type: str choices: [disable, enable]
- header - Header flag. type: str choices: [none, http, 8bit]
- image - Message string. type: str
- message - message text type: str
- msg-type - Message type. type: str
- priority - message priority type: str choices: [low, normal, high, not-included]
- 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]
- smil-part - message encapsulation text type: str
- subject - subject text string type: str
mm7 - No description for the parameter type: array
- add-smil - add message encapsulation type: str choices: [disable, enable]
- addr-type - from address type type: str choices: [rfc2822-addr, number, short-code]
- allow-content-adaptation - allow content adaptations type: str choices: [disable, enable]
- charset - character encoding used for replacement message type: str choices: [us-ascii, utf-8]
- class - message class type: str choices: [personal, advertisement, informational, auto, not-included]
- format - Format flag. type: str choices: [none, text, html, wml]
- from - from address type: str
- from-sender - notification message sent from recipient type: str choices: [disable, enable]
- header - Header flag. type: str choices: [none, http, 8bit]
- image - Message string. type: str
- message - message text type: str
- msg-type - Message type. type: str
- priority - message priority type: str choices: [low, normal, high, not-included]
- 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]
- smil-part - message encapsulation text type: str
- subject - subject text string type: str
mms - No description for the parameter type: array
- buffer - Message string. type: str
- charset - character encoding used for replacement message type: str choices: [us-ascii, utf-8]
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- image - Message string. type: str
- msg-type - Message type. type: str
nac-quar - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
name - Group name. type: str
nntp - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
spam - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
sslvpn - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
traffic-quota - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
utm - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str
webproxy - No description for the parameter type: array
- buffer - Message string. type: str
- format - Format flag. type: str choices: [none, text, html, wml]
- header - Header flag. type: str choices: [none, http, 8bit]
- msg-type - Message type. type: str

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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.