fortinet.fortimanager.fmgr_firewall_mmsprofile_notification module – Notification configuration.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
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_firewall_mmsprofile_notification.
New in fortinet.fortimanager 2.0.0
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 |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Alert notification send interval. |
|
Alert notification interval mode. Choices:
|
|
Specify from address for alert messages. |
|
Alert notification status. Choices:
|
|
Banned word notification send interval. |
|
Banned word notification interval mode. Choices:
|
|
Banned word notification status. Choices:
|
|
Carrier end point black/white list notification send interval. |
|
Carrier end point black/white list notification interval mode. Choices:
|
|
Carrier end point black/white list notification status. Choices:
|
|
Weekdays on which notification messages may be sent. Choices:
|
|
Enable/disable automatic server address determination. Choices:
|
|
Duplicate notification send interval. |
|
Duplicate notification interval mode. Choices:
|
|
Duplicate notification status. Choices:
|
|
File block notification send interval. |
|
File block notification interval mode. Choices:
|
|
File block notification status. Choices:
|
|
Flood notification send interval. |
|
Flood notification interval mode. Choices:
|
|
Flood notification status. Choices:
|
|
Enable/disable insertion of from address in HTTP header. Choices:
|
|
MMS checksum notification send interval. |
|
MMS checksum notification interval mode. Choices:
|
|
MMS checksum notification status. Choices:
|
|
Host name or IP address of the MMSC. |
|
(list) Password required for authentication with the MMSC. |
|
Port used on the MMSC for sending MMS messages |
|
URL used on the MMSC for sending MMS messages. |
|
User name required for authentication with the MMSC. |
|
Protocol to use for sending notification messages. Choices:
|
|
MM7 message type. Choices:
|
|
Protocol. |
|
Rate limit for sending notification messages |
|
Time of day window duration. |
|
Obsolete. |
|
Time of day window start. |
|
Domain name to which the user addresses belong. |
|
VAS identifier. |
|
VASP identifier. |
|
Virus notification send interval. |
|
Virus notification interval mode. Choices:
|
|
Virus notification status. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
Deprecated, please use “mms_profile” |
|
The parameter (mms-profile) in requested url. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
- 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: Notification configuration.
fortinet.fortimanager.fmgr_firewall_mmsprofile_notification:
# 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>
mms_profile: <your own value>
firewall_mmsprofile_notification:
alert_int: <integer>
alert_int_mode: <value in [hours, minutes]>
alert_src_msisdn: <string>
alert_status: <value in [disable, enable]>
bword_int: <integer>
bword_int_mode: <value in [hours, minutes]>
bword_status: <value in [disable, enable]>
carrier_endpoint_bwl_int: <integer>
carrier_endpoint_bwl_int_mode: <value in [hours, minutes]>
carrier_endpoint_bwl_status: <value in [disable, enable]>
days_allowed:
- "sunday"
- "monday"
- "tuesday"
- "wednesday"
- "thursday"
- "friday"
- "saturday"
detect_server: <value in [disable, enable]>
dupe_int: <integer>
dupe_int_mode: <value in [hours, minutes]>
dupe_status: <value in [disable, enable]>
file_block_int: <integer>
file_block_int_mode: <value in [hours, minutes]>
file_block_status: <value in [disable, enable]>
flood_int: <integer>
flood_int_mode: <value in [hours, minutes]>
flood_status: <value in [disable, enable]>
from_in_header: <value in [disable, enable]>
mms_checksum_int: <integer>
mms_checksum_int_mode: <value in [hours, minutes]>
mms_checksum_status: <value in [disable, enable]>
mmsc_hostname: <string>
mmsc_password: <list or string>
mmsc_port: <integer>
mmsc_url: <string>
mmsc_username: <string>
msg_protocol: <value in [mm1, mm3, mm4, ...]>
msg_type: <value in [submit-req, deliver-req]>
protocol: <string>
rate_limit: <integer>
tod_window_duration: <string>
tod_window_end: <string>
tod_window_start: <string>
user_domain: <string>
vas_id: <string>
vasp_id: <string>
virus_int: <integer>
virus_int_mode: <value in [hours, minutes]>
virus_status: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |