Try SpotterNotification configuration.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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]>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
mms-profile:
description: Deprecated, please use "mms_profile"
type: str
mms_profile:
description: The parameter (mms-profile) in requested url.
type: str
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
firewall_mmsprofile_notification:
description: The top level parameters set.
required: false
suboptions:
alert-int:
description: Deprecated, please rename it to alert_int. Alert notification send
interval.
type: int
alert-int-mode:
choices:
- hours
- minutes
description: Deprecated, please rename it to alert_int_mode. Alert notification
interval mode.
type: str
alert-src-msisdn:
description: Deprecated, please rename it to alert_src_msisdn. Specify from address
for alert messages.
type: str
alert-status:
choices:
- disable
- enable
description: Deprecated, please rename it to alert_status. Alert notification
status.
type: str
bword-int:
description: Deprecated, please rename it to bword_int. Banned word notification
send interval.
type: int
bword-int-mode:
choices:
- hours
- minutes
description: Deprecated, please rename it to bword_int_mode. Banned word notification
interval mode.
type: str
bword-status:
choices:
- disable
- enable
description: Deprecated, please rename it to bword_status. Banned word notification
status.
type: str
carrier-endpoint-bwl-int:
description: Deprecated, please rename it to carrier_endpoint_bwl_int. Carrier
end point black/white list notification send interval.
type: int
carrier-endpoint-bwl-int-mode:
choices:
- hours
- minutes
description: Deprecated, please rename it to carrier_endpoint_bwl_int_mode. Carrier
end point black/white list notification interval mode.
type: str
carrier-endpoint-bwl-status:
choices:
- disable
- enable
description: Deprecated, please rename it to carrier_endpoint_bwl_status. Carrier
end point black/white list notification status.
type: str
days-allowed:
choices:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
description: Deprecated, please rename it to days_allowed.
elements: str
type: list
detect-server:
choices:
- disable
- enable
description: Deprecated, please rename it to detect_server. Enable/disable automatic
server address determination.
type: str
dupe-int:
description: Deprecated, please rename it to dupe_int. Duplicate notification
send interval.
type: int
dupe-int-mode:
choices:
- hours
- minutes
description: Deprecated, please rename it to dupe_int_mode. Duplicate notification
interval mode.
type: str
dupe-status:
choices:
- disable
- enable
description: Deprecated, please rename it to dupe_status. Duplicate notification
status.
type: str
file-block-int:
description: Deprecated, please rename it to file_block_int. File block notification
send interval.
type: int
file-block-int-mode:
choices:
- hours
- minutes
description: Deprecated, please rename it to file_block_int_mode. File block notification
interval mode.
type: str
file-block-status:
choices:
- disable
- enable
description: Deprecated, please rename it to file_block_status. File block notification
status.
type: str
flood-int:
description: Deprecated, please rename it to flood_int. Flood notification send
interval.
type: int
flood-int-mode:
choices:
- hours
- minutes
description: Deprecated, please rename it to flood_int_mode. Flood notification
interval mode.
type: str
flood-status:
choices:
- disable
- enable
description: Deprecated, please rename it to flood_status. Flood notification
status.
type: str
from-in-header:
choices:
- disable
- enable
description: Deprecated, please rename it to from_in_header. Enable/disable insertion
of from address in HTTP header.
type: str
mms-checksum-int:
description: Deprecated, please rename it to mms_checksum_int. MMS checksum notification
send interval.
type: int
mms-checksum-int-mode:
choices:
- hours
- minutes
description: Deprecated, please rename it to mms_checksum_int_mode. MMS checksum
notification interval mode.
type: str
mms-checksum-status:
choices:
- disable
- enable
description: Deprecated, please rename it to mms_checksum_status. MMS checksum
notification status.
type: str
mmsc-hostname:
description: Deprecated, please rename it to mmsc_hostname. Host name or IP address
of the MMSC.
type: str
mmsc-password:
description: (list) Deprecated, please rename it to mmsc_password.
type: raw
mmsc-port:
description: Deprecated, please rename it to mmsc_port. Port used on the MMSC
for sending MMS messages
type: int
mmsc-url:
description: Deprecated, please rename it to mmsc_url. URL used on the MMSC for
sending MMS messages.
type: str
mmsc-username:
description: Deprecated, please rename it to mmsc_username. User name required
for authentication with the MMSC.
type: str
msg-protocol:
choices:
- mm1
- mm3
- mm4
- mm7
description: Deprecated, please rename it to msg_protocol. Protocol to use for
sending notification messages.
type: str
msg-type:
choices:
- submit-req
- deliver-req
description: Deprecated, please rename it to msg_type. MM7 message type.
type: str
protocol:
description: Protocol.
type: str
rate-limit:
description: Deprecated, please rename it to rate_limit. Rate limit for sending
notification messages
type: int
tod-window-duration:
description: Deprecated, please rename it to tod_window_duration. Time of day
window duration.
type: str
tod-window-end:
description: Deprecated, please rename it to tod_window_end. Obsolete.
type: str
tod-window-start:
description: Deprecated, please rename it to tod_window_start. Time of day window
start.
type: str
user-domain:
description: Deprecated, please rename it to user_domain. Domain name to which
the user addresses belong.
type: str
vas-id:
description: Deprecated, please rename it to vas_id. VAS identifier.
type: str
vasp-id:
description: Deprecated, please rename it to vasp_id. VASP identifier.
type: str
virus-int:
description: Deprecated, please rename it to virus_int. Virus notification send
interval.
type: int
virus-int-mode:
choices:
- hours
- minutes
description: Deprecated, please rename it to virus_int_mode. Virus notification
interval mode.
type: str
virus-status:
choices:
- disable
- enable
description: Deprecated, please rename it to virus_status. Virus notification
status.
type: str
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list