fortinet.fortimanager.fmgr_system_replacemsggroup_mm7 – Replacement message table entries.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_replacemsggroup_mm7.

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

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.

Parameters

Parameter		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean		Choices: no ← yes	Enable/Disable logging for task
proposed_method string		Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
replacemsg-group string / required			the parameter (replacemsg-group) in requested url
state string / required		Choices: present absent	the directive to create, update or delete an object
system_replacemsggroup_mm7 dictionary			the top level parameters set
	add-smil string	Choices: disable enable	add message encapsulation
	addr-type string	Choices: rfc2822-addr number short-code	from address type
	allow-content-adaptation string	Choices: disable enable	allow content adaptations
	charset string	Choices: us-ascii utf-8	character encoding used for replacement message
	class string	Choices: personal advertisement informational auto not-included	message class
	format string	Choices: none text html wml	Format flag.
	from string		from address
	from-sender string	Choices: disable enable	notification message sent from recipient
	header string	Choices: none http 8bit	Header flag.
	image string		Message string.
	message string		message text
	msg-type string		Message type.
	priority string	Choices: low normal high not-included	message priority
	rsp-status string	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	response status
	smil-part string		message encapsulation text
	subject string		subject text string
workspace_locking_adom string			the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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: Replacement message table entries.
     fmgr_system_replacemsggroup_mm7:
        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_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>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_replacemsggroup_mm7_module.html