drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_system_replacemsggroup_mm1 Replacement message table entries. | "added in version" 2.0.0 of drmofu.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 communitydrmofu.fortimanager.fmgr_system_replacemsggroup_mm1 (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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: Replacement message table entries. 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: <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: <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>
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 required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str replacemsg-group: description: the parameter (replacemsg-group) in requested url required: true 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. required: false 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. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int system_replacemsggroup_mm1: description: the top level parameters set required: false suboptions: add-smil: choices: - disable - enable description: 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: 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: message text type: str msg-type: description: 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: response status code type: str rsp-text: description: response text type: str sender-visibility: choices: - hide - show - not-specified description: sender visibility type: str smil-part: description: 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