fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_replacemsggroup_mm1 Replacement message table entries. | "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 communityfortinet.fortimanager.fmgr_system_replacemsggroup_mm1 (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Replacement message table entries. fortinet.fortimanager.fmgr_system_replacemsggroup_mm1: # 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> replacemsg_group: <your own value> state: present # <value in [present, absent]> system_replacemsggroup_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: <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>
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 replacemsg-group: description: Deprecated, please use "replacemsg_group" type: str replacemsg_group: description: The parameter (replacemsg-group) in requested url. 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 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 system_replacemsggroup_mm1: description: The top level parameters set. required: false 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. required: true 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: dict
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