fmgr_firewall_mmsprofile_notification – Notification configuration.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.

  • Tested with FortiManager v6.x and v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • mms-profile - The parameter in requested url type: str required: true
  • firewall_mmsprofile_notification - Notification configuration. type: dict
    • alert_int (Alias name: alert-int) Alert notification send interval. type: int more...
    • alert_int_mode (Alias name: alert-int-mode) Alert notification interval mode. type: str choices: [hours, minutes] more...
    • alert_src_msisdn (Alias name: alert-src-msisdn) Specify from address for alert messages. type: str more...
    • alert_status (Alias name: alert-status) Alert notification status. type: str choices: [disable, enable] more...
    • bword_int (Alias name: bword-int) Banned word notification send interval. type: int more...
    • bword_int_mode (Alias name: bword-int-mode) Banned word notification interval mode. type: str choices: [hours, minutes] more...
    • bword_status (Alias name: bword-status) Banned word notification status. type: str choices: [disable, enable] more...
    • carrier_endpoint_bwl_int (Alias name: carrier-endpoint-bwl-int) Carrier end point black/white list notification send interval. type: int more...
    • carrier_endpoint_bwl_int_mode (Alias name: carrier-endpoint-bwl-int-mode) Carrier end point black/white list notification interval mode. type: str choices: [hours, minutes] more...
    • carrier_endpoint_bwl_status (Alias name: carrier-endpoint-bwl-status) Carrier end point black/white list notification status. type: str choices: [disable, enable] more...
    • days_allowed (Alias name: days-allowed) type: list choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
    • detect_server (Alias name: detect-server) Enable/disable automatic server address determination. type: str choices: [disable, enable] more...
    • dupe_int (Alias name: dupe-int) Duplicate notification send interval. type: int more...
    • dupe_int_mode (Alias name: dupe-int-mode) Duplicate notification interval mode. type: str choices: [hours, minutes] more...
    • dupe_status (Alias name: dupe-status) Duplicate notification status. type: str choices: [disable, enable] more...
    • file_block_int (Alias name: file-block-int) File block notification send interval. type: int more...
    • file_block_int_mode (Alias name: file-block-int-mode) File block notification interval mode. type: str choices: [hours, minutes] more...
    • file_block_status (Alias name: file-block-status) File block notification status. type: str choices: [disable, enable] more...
    • flood_int (Alias name: flood-int) Flood notification send interval. type: int more...
    • flood_int_mode (Alias name: flood-int-mode) Flood notification interval mode. type: str choices: [hours, minutes] more...
    • flood_status (Alias name: flood-status) Flood notification status. type: str choices: [disable, enable] more...
    • from_in_header (Alias name: from-in-header) Enable/disable insertion of from address in http header. type: str choices: [disable, enable] more...
    • mms_checksum_int (Alias name: mms-checksum-int) Mms checksum notification send interval. type: int more...
    • mms_checksum_int_mode (Alias name: mms-checksum-int-mode) Mms checksum notification interval mode. type: str choices: [hours, minutes] more...
    • mms_checksum_status (Alias name: mms-checksum-status) Mms checksum notification status. type: str choices: [disable, enable] more...
    • mmsc_hostname (Alias name: mmsc-hostname) Host name or ip address of the mmsc. type: str more...
    • mmsc_password (Alias name: mmsc-password) type: list more...
    • mmsc_port (Alias name: mmsc-port) Port used on the mmsc for sending mms messages (1 - 65535). type: int more...
    • mmsc_url (Alias name: mmsc-url) Url used on the mmsc for sending mms messages. type: str more...
    • mmsc_username (Alias name: mmsc-username) User name required for authentication with the mmsc. type: str more...
    • msg_protocol (Alias name: msg-protocol) Protocol to use for sending notification messages. type: str choices: [mm1, mm3, mm4, mm7] more...
    • msg_type (Alias name: msg-type) Mm7 message type. type: str choices: [submit-req, deliver-req] more...
    • protocol Protocol. type: str more...
    • rate_limit (Alias name: rate-limit) Rate limit for sending notification messages (0 - 250). type: int more...
    • tod_window_duration (Alias name: tod-window-duration) Time of day window duration. type: str more...
    • tod_window_end (Alias name: tod-window-end) Obsolete. type: str more...
    • tod_window_start (Alias name: tod-window-start) Time of day window start. type: str more...
    • user_domain (Alias name: user-domain) Domain name to which the user addresses belong. type: str more...
    • vas_id (Alias name: vas-id) Vas identifier. type: str more...
    • vasp_id (Alias name: vasp-id) Vasp identifier. type: str more...
    • virus_int (Alias name: virus-int) Virus notification send interval. type: int more...
    • virus_int_mode (Alias name: virus-int-mode) Virus notification interval mode. type: str choices: [hours, minutes] more...
    • virus_status (Alias name: 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

- 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)