fortinet.fortimanager.fmgr_system_replacemsggroup – Configure replacement message groups.

Note

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

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.

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
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
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
system_replacemsggroup
dictionary
the top level parameters set
admin
list / elements=string
Admin.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
alertmail
list / elements=string
Alertmail.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
auth
list / elements=string
Auth.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
automation
list / elements=string
Automation.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
comment
string
Comment.
custom-message
list / elements=string
Custom-Message.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
device-detection-portal
list / elements=string
Device-Detection-Portal.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
ec
list / elements=string
no description
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
fortiguard-wf
list / elements=string
Fortiguard-Wf.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
ftp
list / elements=string
Ftp.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
group-type
string
    Choices:
  • default
  • utm
  • auth
  • ec
  • captive-portal
Group type.
http
list / elements=string
Http.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
icap
list / elements=string
Icap.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
mail
list / elements=string
Mail.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
mm1
list / elements=string
Mm1.
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
mm3
list / elements=string
Mm3.
add-html
string
    Choices:
  • disable
  • enable
add message encapsulation
charset
string
    Choices:
  • us-ascii
  • utf-8
character encoding used for replacement message
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.
html-part
string
message encapsulation text
image
string
Message string.
message
string
message text
msg-type
string
Message type.
priority
string
    Choices:
  • low
  • normal
  • high
  • not-included
message priority
subject
string
subject text string
mm4
list / elements=string
Mm4.
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
  • informational
  • auto
  • not-included
message class
domain
string
from address domain
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-net-prob
  • err-content-not-accept
  • err-unsupp-msg
response status
smil-part
string
message encapsulation text
subject
string
subject text string
mm7
list / elements=string
Mm7.
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
mms
list / elements=string
Mms.
buffer
string
Message string.
charset
string
    Choices:
  • us-ascii
  • utf-8
character encoding used for replacement message
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
image
string
Message string.
msg-type
string
Message type.
nac-quar
list / elements=string
Nac-Quar.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
name
string
Group name.
nntp
list / elements=string
Nntp.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
spam
list / elements=string
Spam.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
sslvpn
list / elements=string
Sslvpn.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
traffic-quota
list / elements=string
Traffic-Quota.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
utm
list / elements=string
Utm.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
webproxy
list / elements=string
Webproxy.
buffer
string
Message string.
format
string
    Choices:
  • none
  • text
  • html
  • wml
Format flag.
header
string
    Choices:
  • none
  • http
  • 8bit
Header flag.
msg-type
string
Message type.
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: fortimanager00
  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
        adom: ansible
        state: present
        system_replacemsggroup:
           comment: ansible-comment
           name: ansible-test

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the replacement message groups
     fmgr_fact:
       facts:
           selector: 'system_replacemsggroup'
           params:
               adom: 'ansible'
               replacemsg-group: ''

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)