fortinet.fortimanager.fmgr_firewall_mmsprofile_notification module – Notification configuration.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

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

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

firewall_mmsprofile_notification

dictionary

The top level parameters set.

alert-int

integer

Deprecated, please rename it to alert_int. Alert notification send interval.

alert-int-mode

string

Deprecated, please rename it to alert_int_mode. Alert notification interval mode.

Choices:

  • "hours"

  • "minutes"

alert-src-msisdn

string

Deprecated, please rename it to alert_src_msisdn. Specify from address for alert messages.

alert-status

string

Deprecated, please rename it to alert_status. Alert notification status.

Choices:

  • "disable"

  • "enable"

bword-int

integer

Deprecated, please rename it to bword_int. Banned word notification send interval.

bword-int-mode

string

Deprecated, please rename it to bword_int_mode. Banned word notification interval mode.

Choices:

  • "hours"

  • "minutes"

bword-status

string

Deprecated, please rename it to bword_status. Banned word notification status.

Choices:

  • "disable"

  • "enable"

carrier-endpoint-bwl-int

integer

Deprecated, please rename it to carrier_endpoint_bwl_int. Carrier end point black/white list notification send interval.

carrier-endpoint-bwl-int-mode

string

Deprecated, please rename it to carrier_endpoint_bwl_int_mode. Carrier end point black/white list notification interval mode.

Choices:

  • "hours"

  • "minutes"

carrier-endpoint-bwl-status

string

Deprecated, please rename it to carrier_endpoint_bwl_status. Carrier end point black/white list notification status.

Choices:

  • "disable"

  • "enable"

days-allowed

list / elements=string

Deprecated, please rename it to days_allowed. Weekdays on which notification messages may be sent.

Choices:

  • "sunday"

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

detect-server

string

Deprecated, please rename it to detect_server. Enable/disable automatic server address determination.

Choices:

  • "disable"

  • "enable"

dupe-int

integer

Deprecated, please rename it to dupe_int. Duplicate notification send interval.

dupe-int-mode

string

Deprecated, please rename it to dupe_int_mode. Duplicate notification interval mode.

Choices:

  • "hours"

  • "minutes"

dupe-status

string

Deprecated, please rename it to dupe_status. Duplicate notification status.

Choices:

  • "disable"

  • "enable"

file-block-int

integer

Deprecated, please rename it to file_block_int. File block notification send interval.

file-block-int-mode

string

Deprecated, please rename it to file_block_int_mode. File block notification interval mode.

Choices:

  • "hours"

  • "minutes"

file-block-status

string

Deprecated, please rename it to file_block_status. File block notification status.

Choices:

  • "disable"

  • "enable"

flood-int

integer

Deprecated, please rename it to flood_int. Flood notification send interval.

flood-int-mode

string

Deprecated, please rename it to flood_int_mode. Flood notification interval mode.

Choices:

  • "hours"

  • "minutes"

flood-status

string

Deprecated, please rename it to flood_status. Flood notification status.

Choices:

  • "disable"

  • "enable"

from-in-header

string

Deprecated, please rename it to from_in_header. Enable/disable insertion of from address in HTTP header.

Choices:

  • "disable"

  • "enable"

mms-checksum-int

integer

Deprecated, please rename it to mms_checksum_int. MMS checksum notification send interval.

mms-checksum-int-mode

string

Deprecated, please rename it to mms_checksum_int_mode. MMS checksum notification interval mode.

Choices:

  • "hours"

  • "minutes"

mms-checksum-status

string

Deprecated, please rename it to mms_checksum_status. MMS checksum notification status.

Choices:

  • "disable"

  • "enable"

mmsc-hostname

string

Deprecated, please rename it to mmsc_hostname. Host name or IP address of the MMSC.

mmsc-password

any

(list) Deprecated, please rename it to mmsc_password. Password required for authentication with the MMSC.

mmsc-port

integer

Deprecated, please rename it to mmsc_port. Port used on the MMSC for sending MMS messages

mmsc-url

string

Deprecated, please rename it to mmsc_url. URL used on the MMSC for sending MMS messages.

mmsc-username

string

Deprecated, please rename it to mmsc_username. User name required for authentication with the MMSC.

msg-protocol

string

Deprecated, please rename it to msg_protocol. Protocol to use for sending notification messages.

Choices:

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

msg-type

string

Deprecated, please rename it to msg_type. MM7 message type.

Choices:

  • "submit-req"

  • "deliver-req"

protocol

string

Protocol.

rate-limit

integer

Deprecated, please rename it to rate_limit. Rate limit for sending notification messages

tod-window-duration

string

Deprecated, please rename it to tod_window_duration. Time of day window duration.

tod-window-end

string

Deprecated, please rename it to tod_window_end. Obsolete.

tod-window-start

string

Deprecated, please rename it to tod_window_start. Time of day window start.

user-domain

string

Deprecated, please rename it to user_domain. Domain name to which the user addresses belong.

vas-id

string

Deprecated, please rename it to vas_id. VAS identifier.

vasp-id

string

Deprecated, please rename it to vasp_id. VASP identifier.

virus-int

integer

Deprecated, please rename it to virus_int. Virus notification send interval.

virus-int-mode

string

Deprecated, please rename it to virus_int_mode. Virus notification interval mode.

Choices:

  • "hours"

  • "minutes"

virus-status

string

Deprecated, please rename it to virus_status. Virus notification status.

Choices:

  • "disable"

  • "enable"

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

mms-profile

string

Deprecated, please use “mms_profile”

mms_profile

string

The parameter (mms-profile) in requested url.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)