fortinet.fortimanager.fmgr_firewall_mmsprofile_notification – Notification configuration.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr firewall mmsprofile notification module


fortinet.fortimanager.fmgr_firewall_mmsprofile_notification – Notification configuration.

Note

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

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 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

  • no ←

  • yes

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

firewall_mmsprofile_notification

dictionary

the top level parameters set

alert-int

integer

Alert notification send interval.

alert-int-mode

string

  • hours
  • minutes

Alert notification interval mode.

alert-src-msisdn

string

Specify from address for alert messages.

alert-status

string

  • disable
  • enable

Alert notification status.

bword-int

integer

Banned word notification send interval.

bword-int-mode

string

  • hours
  • minutes

Banned word notification interval mode.

bword-status

string

  • disable
  • enable

Banned word notification status.

carrier-endpoint-bwl-int

integer

Carrier end point black/white list notification send interval.

carrier-endpoint-bwl-int-mode

string

  • hours
  • minutes

Carrier end point black/white list notification interval mode.

carrier-endpoint-bwl-status

string

  • disable
  • enable

Carrier end point black/white list notification status.

days-allowed

list / elements=string

  • sunday
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday

no description

detect-server

string

  • disable
  • enable

Enable/disable automatic server address determination.

dupe-int

integer

Duplicate notification send interval.

dupe-int-mode

string

  • hours
  • minutes

Duplicate notification interval mode.

dupe-status

string

  • disable
  • enable

Duplicate notification status.

file-block-int

integer

File block notification send interval.

file-block-int-mode

string

  • hours
  • minutes

File block notification interval mode.

file-block-status

string

  • disable
  • enable

File block notification status.

flood-int

integer

Flood notification send interval.

flood-int-mode

string

  • hours
  • minutes

Flood notification interval mode.

flood-status

string

  • disable
  • enable

Flood notification status.

from-in-header

string

  • disable
  • enable

Enable/disable insertion of from address in HTTP header.

mms-checksum-int

integer

MMS checksum notification send interval.

mms-checksum-int-mode

string

  • hours
  • minutes

MMS checksum notification interval mode.

mms-checksum-status

string

  • disable
  • enable

MMS checksum notification status.

mmsc-hostname

string

Host name or IP address of the MMSC.

mmsc-password

string

no description

mmsc-port

integer

Port used on the MMSC for sending MMS messages (1 - 65535).

mmsc-url

string

URL used on the MMSC for sending MMS messages.

mmsc-username

string

User name required for authentication with the MMSC.

msg-protocol

string

  • mm1
  • mm3
  • mm4
  • mm7

Protocol to use for sending notification messages.

msg-type

string

  • submit-req
  • deliver-req

MM7 message type.

protocol

string

Protocol.

rate-limit

integer

Rate limit for sending notification messages (0 - 250).

tod-window-duration

string

Time of day window duration.

tod-window-end

string

Obsolete.

tod-window-start

string

Time of day window start.

user-domain

string

Domain name to which the user addresses belong.

vas-id

string

VAS identifier.

vasp-id

string

VASP identifier.

virus-int

integer

Virus notification send interval.

virus-int-mode

string

  • hours
  • minutes

Virus notification interval mode.

virus-status

string

  • disable
  • enable

Virus notification status.

mms-profile

string / required

the parameter (mms-profile) in requested url

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

  • present
  • absent

the directive to create, update or delete an object

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: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Notification configuration.
     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 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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_mmsprofile_notification_module.html


Retrieved from "https://getdocs.org/index.php?title=Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr_firewall_mmsprofile_notification_module&oldid=63522"
Powered by MediaWiki