fmgr_firewall_mmsprofile_notification – Notification configuration.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5
firewall_mmsprofile_notification yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • adom - The parameter in requested url type: str required: true
  • mms-profile - The parameter in requested url type: str required: true
  • firewall_mmsprofile_notification - no description type: dict
    • alert-int - Alert notification send interval. type: int more...
    • alert-int-mode - Alert notification interval mode. type: str choices: [hours, minutes] more...
    • alert-src-msisdn - Specify from address for alert messages. type: str more...
    • alert-status - Alert notification status. type: str choices: [disable, enable] more...
    • bword-int - Banned word notification send interval. type: int more...
    • bword-int-mode - Banned word notification interval mode. type: str choices: [hours, minutes] more...
    • bword-status - Banned word notification status. type: str choices: [disable, enable] more...
    • carrier-endpoint-bwl-int - Carrier end point black/white list notification send interval. type: int more...
    • carrier-endpoint-bwl-int-mode - Carrier end point black/white list notification interval mode. type: str choices: [hours, minutes] more...
    • carrier-endpoint-bwl-status - Carrier end point black/white list notification status. type: str choices: [disable, enable] more...
    • days-allowed - No description for the parameter type: array choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
    • detect-server - Enable/disable automatic server address determination. type: str choices: [disable, enable] more...
    • dupe-int - Duplicate notification send interval. type: int more...
    • dupe-int-mode - Duplicate notification interval mode. type: str choices: [hours, minutes] more...
    • dupe-status - Duplicate notification status. type: str choices: [disable, enable] more...
    • file-block-int - File block notification send interval. type: int more...
    • file-block-int-mode - File block notification interval mode. type: str choices: [hours, minutes] more...
    • file-block-status - File block notification status. type: str choices: [disable, enable] more...
    • flood-int - Flood notification send interval. type: int more...
    • flood-int-mode - Flood notification interval mode. type: str choices: [hours, minutes] more...
    • flood-status - Flood notification status. type: str choices: [disable, enable] more...
    • from-in-header - Enable/disable insertion of from address in HTTP header. type: str choices: [disable, enable] more...
    • mms-checksum-int - MMS checksum notification send interval. type: int more...
    • mms-checksum-int-mode - MMS checksum notification interval mode. type: str choices: [hours, minutes] more...
    • mms-checksum-status - MMS checksum notification status. type: str choices: [disable, enable] more...
    • mmsc-hostname - Host name or IP address of the MMSC. type: str more...
    • mmsc-password - No description for the parameter type: str more...
    • mmsc-port - Port used on the MMSC for sending MMS messages (1 - 65535). type: int more...
    • mmsc-url - URL used on the MMSC for sending MMS messages. type: str more...
    • mmsc-username - User name required for authentication with the MMSC. type: str more...
    • msg-protocol - Protocol to use for sending notification messages. type: str choices: [mm1, mm3, mm4, mm7] more...
    • msg-type - MM7 message type. type: str choices: [submit-req, deliver-req] more...
    • protocol - Protocol. type: str more...
    • rate-limit - Rate limit for sending notification messages (0 - 250). type: int more...
    • tod-window-duration - Time of day window duration. type: str more...
    • tod-window-end - Obsolete. type: str more...
    • tod-window-start - Time of day window start. type: str more...
    • user-domain - Domain name to which the user addresses belong. type: str more...
    • vas-id - VAS identifier. type: str more...
    • vasp-id - VASP identifier. type: str more...
    • virus-int - Virus notification send interval. type: int more...
    • virus-int-mode - Virus notification interval mode. type: str choices: [hours, minutes] more...
    • virus-status - Virus notification status. type: str choices: [disable, enable] more...

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: no description
     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: <value of integer>
           alert-int-mode: <value in [hours, minutes]>
           alert-src-msisdn: <value of string>
           alert-status: <value in [disable, enable]>
           bword-int: <value of integer>
           bword-int-mode: <value in [hours, minutes]>
           bword-status: <value in [disable, enable]>
           carrier-endpoint-bwl-int: <value of 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: <value of integer>
           dupe-int-mode: <value in [hours, minutes]>
           dupe-status: <value in [disable, enable]>
           file-block-int: <value of integer>
           file-block-int-mode: <value in [hours, minutes]>
           file-block-status: <value in [disable, enable]>
           flood-int: <value of integer>
           flood-int-mode: <value in [hours, minutes]>
           flood-status: <value in [disable, enable]>
           from-in-header: <value in [disable, enable]>
           mms-checksum-int: <value of integer>
           mms-checksum-int-mode: <value in [hours, minutes]>
           mms-checksum-status: <value in [disable, enable]>
           mmsc-hostname: <value of string>
           mmsc-password: <value of string>
           mmsc-port: <value of integer>
           mmsc-url: <value of string>
           mmsc-username: <value of string>
           msg-protocol: <value in [mm1, mm3, mm4, ...]>
           msg-type: <value in [submit-req, deliver-req]>
           protocol: <value of string>
           rate-limit: <value of integer>
           tod-window-duration: <value of string>
           tod-window-end: <value of string>
           tod-window-start: <value of string>
           user-domain: <value of string>
           vas-id: <value of string>
           vasp-id: <value of string>
           virus-int: <value of integer>
           virus-int-mode: <value in [hours, minutes]>
           virus-status: <value in [disable, enable]>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.