fortinet.fortimanager.fmgr_system_replacemsggroup_mm1 – Replacement message table entries.

Note

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

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

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

New in version 2.10: of fortinet.fortimanager

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
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_mm1 dictionary			the top level parameters set
	add-smil string	Choices: disable enable	add message encapsulation
	charset string	Choices: us-ascii utf-8	character encoding used for replacement message
	class string	Choices: personal advertisement information automatic 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: 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	response status code
	rsp-text string		response text
	sender-visibility string	Choices: hide show not-specified	sender visibility
	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_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>

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)